Debug module

debug_deleteChainSlice

Deletes a slice of a chain from the tree on all branches (Nethermind specific).
Invocation
{"method":"debug_deleteChainSlice","params":[startNumber]}
Parameter
Type
Description
startNumber
Quantity
Returned type
Description
Quantity
Example request of debug_deleteChainSlice
1
curl --data '{"method":"debug_deleteChainSlice","params":[startNumber],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!

debug_getBlockRlp

Retrieves a block in the RLP-serialized form.
Invocation
{"method":"debug_getBlockRlp","params":[number]}
Parameter
Type
Description
number
Quantity
Returned type
Description
Data
Example request of debug_getBlockRlp
1
curl --data '{"method":"debug_getBlockRlp","params":[number],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!

debug_getBlockRlpByHash

Retrieves a block in the RLP-serialized form.
Invocation
{"method":"debug_getBlockRlpByHash","params":[hash]}
Parameter
Type
Description
hash
Hash
Returned type
Description
Data
Example request of debug_getBlockRlpByHash
1
curl --data '{"method":"debug_getBlockRlpByHash","params":[hash],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!

debug_getChainLevel

Retrieves a representation of tree branches on a given chain level (Nethermind specific).
Invocation
{"method":"debug_getChainLevel","params":[number]}
Parameter
Type
Description
number
Quantity
Returned type
Description
ChainLevelForRpc object
Example request of debug_getChainLevel
Objects in debug_getChainLevel
1
curl --data '{"method":"debug_getChainLevel","params":[number],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
ChainLevelForRpc
Field name
Type
BlockInfos
BlockInfoForRpc[] object
HasBlockOnMainChain
Boolean
BlockInfoForRpc[]
Field name
Type
BlockHash
Hash
TotalDifficulty
Quantity
WasProcessed
Boolean
IsFinalized
Boolean

debug_getConfigValue

Retrieves the Nethermind configuration value, e.g. JsonRpc.Enabled
Invocation
{"method":"debug_getConfigValue","params":[category, name]}
Parameter
Type
Description
category
String
name
String
Returned type
Description
Object
Example request of debug_getConfigValue
1
curl --data '{"method":"debug_getConfigValue","params":[category, name],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!

debug_insertReceipts

Insert receipts for the block after verifying receipts root correctness.
Invocation
{"method":"debug_insertReceipts","params":[blockParameter, receiptForRpc]}
Parameter
Type
Description
blockParameter
BlockParameter object
receiptForRpc
ReceiptForRpc[] object
Returned type
Description
Boolean
Example request of debug_insertReceipts
Objects in debug_insertReceipts
1
curl --data '{"method":"debug_insertReceipts","params":[blockParameter, receiptForRpc],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
BlockParameter
Field name
Type
Type
BlockParameterType object
BlockNumber
Quantity
BlockHash
Hash
RequireCanonical
Boolean
BlockParameterType
  • Quantity or String (latest, earliest, pending)
ReceiptForRpc[]
Field name
Type
TransactionHash
Hash
TransactionIndex
Quantity
BlockHash
Hash
BlockNumber
Quantity
CumulativeGasUsed
Quantity
GasUsed
Quantity
EffectiveGasPrice
Quantity
From
Address
To
Address
ContractAddress
Address
Logs
LogEntryForRpc[] object
LogsBloom
Bloom Object
Root
Hash
Status
Quantity
Error
String
Type
TxType object

debug_migrateReceipts

Sets the block number up to which receipts will be migrated to (Nethermind specific).
Invocation
{"method":"debug_migrateReceipts","params":[blockNumber]}
Parameter
Type
Description
blockNumber
Quantity
Returned type
Description
Boolean
Example request of debug_migrateReceipts
1
curl --data '{"method":"debug_migrateReceipts","params":[blockNumber],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!

debug_resetHead

Updates / resets head block - use only when the node got stuck due to DB / memory corruption (Nethermind specific).
Invocation
{"method":"debug_resetHead","params":[blockHash]}
Parameter
Type
Description
blockHash
Hash
Returned type
Description
Boolean
Example request of debug_resetHead
1
curl --data '{"method":"debug_resetHead","params":[blockHash],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!

debug_traceBlock

Returns a full stack trace of all invoked opcodes of all transaction that were included included in this block. The parent of this block must be present or it will fail.
Invocation
{"method":"debug_traceBlock","params":[blockRlp, options]}
Parameter
Type
Description
blockRlp
Data
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceBlock
Objects in debug_traceBlock
1
curl --data '{"method":"debug_traceBlock","params":[blockRlp, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceBlockByHash

Invocation
{"method":"debug_traceBlockByHash","params":[blockHash, options]}
Parameter
Type
Description
blockHash
Hash
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceBlockByHash
Objects in debug_traceBlockByHash
1
curl --data '{"method":"debug_traceBlockByHash","params":[blockHash, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceBlockByNumber

Invocation
{"method":"debug_traceBlockByNumber","params":[number, options]}
Parameter
Type
Description
number
Quantity
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceBlockByNumber
Objects in debug_traceBlockByNumber
1
curl --data '{"method":"debug_traceBlockByNumber","params":[number, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceTransaction

This method will attempt to run the transaction in the exact same manner as it was executed on the network. It will replay any transaction that may have been executed prior to this one before it will finally attempt to execute the transaction that corresponds to the given hash.
Invocation
{"method":"debug_traceTransaction","params":[transactionHash, options]}
Parameter
Type
Description
transactionHash
Hash
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceTransaction
Objects in debug_traceTransaction
1
curl --data '{"method":"debug_traceTransaction","params":[transactionHash, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceTransactionByBlockAndIndex

Invocation
{"method":"debug_traceTransactionByBlockAndIndex","params":[blockParameter, txIndex, options]}
Parameter
Type
Description
blockParameter
BlockParameter object
txIndex
Quantity
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceTransactionByBlockAndIndex
Objects in debug_traceTransactionByBlockAndIndex
1
curl --data '{"method":"debug_traceTransactionByBlockAndIndex","params":[blockParameter, txIndex, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
BlockParameter
Field name
Type
Type
BlockParameterType object
BlockNumber
Quantity
BlockHash
Hash
RequireCanonical
Boolean
BlockParameterType
  • Quantity or String (latest, earliest, pending)
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceTransactionByBlockhashAndIndex

Invocation
{"method":"debug_traceTransactionByBlockhashAndIndex","params":[blockHash, txIndex, options]}
Parameter
Type
Description
blockHash
Hash
txIndex
Quantity
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceTransactionByBlockhashAndIndex
Objects in debug_traceTransactionByBlockhashAndIndex
1
curl --data '{"method":"debug_traceTransactionByBlockhashAndIndex","params":[blockHash, txIndex, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceTransactionInBlockByHash

Invocation
{"method":"debug_traceTransactionInBlockByHash","params":[blockRlp, transactionHash, options]}
Parameter
Type
Description
blockRlp
Data
transactionHash
Hash
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceTransactionInBlockByHash
Objects in debug_traceTransactionInBlockByHash
1
curl --data '{"method":"debug_traceTransactionInBlockByHash","params":[blockRlp, transactionHash, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array

debug_traceTransactionInBlockByIndex

Invocation
{"method":"debug_traceTransactionInBlockByIndex","params":[blockRlp, txIndex, options]}
Parameter
Type
Description
blockRlp
Data
txIndex
Quantity
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug_traceTransactionInBlockByIndex
Objects in debug_traceTransactionInBlockByIndex
1
curl --data '{"method":"debug_traceTransactionInBlockByIndex","params":[blockRlp, txIndex, options],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545
Copied!
GethTraceOptions
Field name
Type
DisableStorage
Boolean
DisableMemory
Boolean
DisableStack
Boolean
Tracer
String
Timeout
String
GethLikeTxTrace
Field name
Type
StoragesByDepth
Array
Gas
Quantity
Failed
Boolean
ReturnValue
Data
Entries
Array
Last modified 1mo ago