Skip to content

[website] renaming debug getters #26849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
holiman merged 1 commit into from
Mar 13, 2023
Merged

[website] renaming debug getters #26849

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions docs/interacting-with-geth/rpc/ns-debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If `incompletes` is false, then accounts for which the key preimage (i.e: the `a
| Client | Method invocation |
| :------ | ---------------------------------------------------------------------------------------------------------------- |
| Console | `debug.accountRange(blockNrOrHash, start, maxResults, nocode, nostorage, incompletes)` |
| RPC | `{"method": "debug_getHeaderRlp", "params": [blockNrOrHash, start, maxResults, nocode, nostorage, incompletes]}` |
| RPC | `{"method": "debug_accountRange", "params": [blockNrOrHash, start, maxResults, nocode, nostorage, incompletes]}` |

### debug_backtraceAt

Expand Down Expand Up @@ -189,26 +189,35 @@ Returns a list of the last 'bad blocks' that the client has seen on the network
| Console | `debug.getBadBlocks()` |
| RPC | `{"method": "debug_getBadBlocks", "params": []}` |

### debug_getBlockRlp
### debug_getRawBlock

Retrieves and returns the RLP encoded block by number.

| Client | Method invocation |
| :------ | ----------------------------------------------------- |
| Go | `debug.GetBlockRlp(number uint64) (string, error)` |
| Console | `debug.getBlockRlp(number, [options])` |
| RPC | `{"method": "debug_getBlockRlp", "params": [number]}` |
| Go | `debug.getRawBlock(blockNrOrHash) (string, error)` |
| Console | `debug.getBlockRlp(blockNrOrHash)` |
| RPC | `{"method": "debug_getRawBlock", "params": [blockNrOrHash]}` |

References: [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/)

### debug_getHeaderRlp
### debug_getRawHeader

Returns an RLP-encoded header.

| Client | Method invocation |
| :------ | --------------------------------------------------- |
| Console | `debug.getHeaderRlp(blockNum)` |
| RPC | `{"method": "debug_getHeaderRlp", "params": [num]}` |
| Console | `debug.getRawHeader(blockNrOrHash)` |
| RPC | `{"method": "debug_getRawHeader", "params": [blockNrOrHash]}` |

### debug_getRawTransaction

Returns the bytes of the transaction.

| Client | Method invocation |
| :------ | --------------------------------------------------- |
| Console | `debug.getRawTransaction(blockNrOrHash)` |
| RPC | `{"method": "debug_getRawTransaction", "params": [transactionHash]}` |

### debug_getModifiedAccountsByHash

Expand Down