Debug module

debug.config

Invocation
debug.config(category, name)
Parameter
Type
Description
category
String
name
String
Returned type
Description
String
Example request of debug.config
debug.config(category, name)

debug.getBlockRlp

Retrieves a block in the RLP-serialized form.
Invocation
debug.getBlockRlp(number)
Parameter
Type
Description
number
Quantity
Returned type
Description
Data
Example request of debug.getBlockRlp
debug.getBlockRlp(number)

debug.getBlockRlpByHash

Retrieves a block in the RLP-serialized form.
Invocation
debug.getBlockRlpByHash(hash)
Parameter
Type
Description
hash
Hash
Returned type
Description
Data
Example request of debug.getBlockRlpByHash
debug.getBlockRlpByHash(hash)

debug.getChainLevel

Retrieves a representation of tree branches on a given chain level (Nethermind specific).
Invocation
debug.getChainLevel(number)
Parameter
Type
Description
number
Quantity
Returned type
Description
ChainLevelForRpc object
Example request of debug.getChainLevel
Objects in debug_getChainLevel
debug.getChainLevel(number)
ChainLevelForRpc
Field name
Type
BlockInfos
BlockInfoForRpc[] object
HasBlockOnMainChain
Boolean
BlockInfoForRpc[]
Field name
Type
BlockHash
Hash
TotalDifficulty
Quantity
WasProcessed
Boolean
IsFinalized
Boolean

debug.migrateReceipts

Sets the block number up to which receipts will be migrated to (Nethermind specific).
Invocation
debug.migrateReceipts(blockNumber)
Parameter
Type
Description
blockNumber
Quantity
Returned type
Description
Boolean
Example request of debug.migrateReceipts
debug.migrateReceipts(blockNumber)

debug.traceBlock

Returns the full stack trace of all invoked opcodes of all transactions that were included in the block specified. The parent of the block must be present or it will fail.
Invocation
debug.traceBlock(blockRlp, options)
Parameter
Type
Description
blockRlp
Data
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug.traceBlock
Objects in debug_traceBlock
debug.traceBlock(blockRlp, options)
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

Similar to debug_traceBlock, this method accepts a block hash and replays the block that is already present in the database.
Invocation
debug.traceBlockByHash(blockHash, options)
Parameter
Type
Description
blockHash
Hash
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug.traceBlockByHash
Objects in debug_traceBlockByHash
debug.traceBlockByHash(blockHash, options)
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

Similar to debug_traceBlock, this method accepts a block number as well as "latest" or "finalized" and replays the block that is already present in the database.
Invocation
debug.traceBlockByNumber(blockParameter, options)
Parameter
Type
Description
blockParameter
BlockParameter object
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug.traceBlockByNumber
Objects in debug_traceBlockByNumber
debug.traceBlockByNumber(blockParameter, options)
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.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
debug.traceTransaction(transactionHash, options)
Parameter
Type
Description
transactionHash
Hash
options
GethTraceOptions object
Returned type
Description
GethLikeTxTrace object
Example request of debug.traceTransaction
Objects in debug_traceTransaction
debug.traceTransaction(transactionHash, options)
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
debug.traceTransactionByBlockAndIndex(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
debug.traceTransactionByBlockAndIndex(blockParameter, txIndex, options)
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
debug.traceTransactionByBlockhashAndIndex(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
debug.traceTransactionByBlockhashAndIndex(blockHash, txIndex, options)
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
debug.traceTransactionInBlockByHash(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
debug.traceTransactionInBlockByHash(blockRlp, transactionHash, options)
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
debug.traceTransactionInBlockByIndex(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
debug.traceTransactionInBlockByIndex(blockRlp, txIndex, options)
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
Copy link
On this page
debug.config
debug.getBlockRlp
debug.getBlockRlpByHash
debug.getChainLevel
debug.migrateReceipts
debug.traceBlock
debug.traceBlockByHash
debug.traceBlockByNumber
debug.traceTransaction
debug.traceTransactionByBlockAndIndex
debug.traceTransactionByBlockhashAndIndex
debug.traceTransactionInBlockByHash
debug.traceTransactionInBlockByIndex