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
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
Example request of debug.getBlockRlp
debug.getBlockRlp(number)

See also JSON RPC debug_getBlockRlp

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
Example request of debug.getBlockRlpByHash
debug.getBlockRlpByHash(hash)

See also JSON RPC debug_getBlockRlpByHash

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
Example request of debug.getChainLevel
debug.getChainLevel(number)
Objects in debug_getChainLevel

ChainLevelForRpc

Field name

Type

BlockInfos

BlockInfoForRpc[] object

HasBlockOnMainChain

Boolean

BlockInfoForRpc[]

Field name

Type

BlockHash

Hash

TotalDifficulty

Quantity

WasProcessed

Boolean

IsFinalized

Boolean

See also JSON RPC debug_getChainLevel

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
Example request of debug.migrateReceipts
debug.migrateReceipts(blockNumber)

See also JSON RPC debug_migrateReceipts

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

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
Example request of debug.traceBlock
debug.traceBlock(blockRlp, options)
Objects in debug_traceBlock

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

See also JSON RPC debug_traceBlock

debug.traceBlockByHash

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
Example request of debug.traceBlockByHash
debug.traceBlockByHash(blockHash, options)
Objects in debug_traceBlockByHash

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

See also JSON RPC debug_traceBlockByHash

debug.traceBlockByNumber

Invocation

debug.traceBlockByNumber(number, options)

Parameter

Type

Description

number

Quantity

options

GethTraceOptions object

Returned type

Description

GethLikeTxTrace object

Example request of debug.traceBlockByNumber
Objects in debug_traceBlockByNumber
Example request of debug.traceBlockByNumber
debug.traceBlockByNumber(number, options)
Objects in debug_traceBlockByNumber

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

See also JSON RPC debug_traceBlockByNumber

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
Example request of debug.traceTransaction
debug.traceTransaction(transactionHash, options)
Objects in debug_traceTransaction

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

See also JSON RPC debug_traceTransaction

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
Example request of debug.traceTransactionByBlockAndIndex
debug.traceTransactionByBlockAndIndex(blockParameter, txIndex, options)
Objects in debug_traceTransactionByBlockAndIndex

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

See also JSON RPC debug_traceTransactionByBlockAndIndex

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
Example request of debug.traceTransactionByBlockhashAndIndex
debug.traceTransactionByBlockhashAndIndex(blockHash, txIndex, options)
Objects in debug_traceTransactionByBlockhashAndIndex

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

See also JSON RPC debug_traceTransactionByBlockhashAndIndex

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
Example request of debug.traceTransactionInBlockByHash
debug.traceTransactionInBlockByHash(blockRlp, transactionHash, options)
Objects in debug_traceTransactionInBlockByHash

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

See also JSON RPC debug_traceTransactionInBlockByHash

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
Example request of debug.traceTransactionInBlockByIndex
debug.traceTransactionInBlockByIndex(blockRlp, txIndex, options)
Objects in debug_traceTransactionInBlockByIndex

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

See also JSON RPC debug_traceTransactionInBlockByIndex