debug namespace

debug_deleteChainSlice

Deletes a slice of a chain from the tree on all branches (Nethermind specific).

Parameters

1. startNumber: string (hex integer)

2. force: boolean

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_deleteChainSlice",
      "params": [startNumber, force]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (hex integer)

debug_getBadBlocks

Return list of invalid blocks.

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getBadBlocks",
      "params": []
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of object

• block: object
  • author: string (address)
  • baseFeePerGas: string (hex integer)
  • blobGasUsed: string (hex integer)
  • difficulty: string (hex integer)
  • excessBlobGas: string (hex integer)
  • extraData: string (hex data)
  • gasLimit: string (hex integer)
  • gasUsed: string (hex integer)
  • hash: string (hash)
  • logsBloom: string (hex data)
  • miner: string (address)
  • mixHash: string (hash)
  • nonce: string (hex data)
  • number: string (hex integer)
  • parentBeaconBlockRoot: string (hash)
  • parentHash: string (hash)
  • receiptsRoot: string (hash)
  • sha3Uncles: string (hash)
  • signature: string (hex data)
  • size: string (hex integer)
  • stateRoot: string (hash)
  • step: string (hex integer)
  • timestamp: string (hex integer)
  • totalDifficulty: string (hex integer)
  • transactions: array of object
  • transactionsRoot: string (hash)
  • uncles: array of string (hash)
  • withdrawals: array of object
    • address: string (address)
    • amountInGwei: string (hex integer)
    • amountInWei: string (hex integer)
    • index: string (hex integer)
    • validatorIndex: string (hex integer)
  • withdrawalsRoot: string (hash)
• hash: string (hash)
• rlp: string (hex data)

debug_getBlockRlp

Retrieves a block in the RLP-serialized form.

Parameters

1. number: string (hex integer)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getBlockRlp",
      "params": [number]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (hex data)

debug_getBlockRlpByHash

Retrieves a block in the RLP-serialized form.

Parameters

1. hash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getBlockRlpByHash",
      "params": [hash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (hex data)

debug_getChainLevel

Retrieves a representation of tree branches on a given chain level (Nethermind specific).

Parameters

1. number: string (hex integer)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getChainLevel",
      "params": [number]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• blockInfos: array of object
  • blockHash: string (hash)
  • isFinalized: boolean
  • totalDifficulty: string (hex integer)
  • wasProcessed: boolean
• hasBlockOnMainChain: boolean

debug_getConfigValue

Retrieves the Nethermind configuration value, e.g. JsonRpc.Enabled

Parameters

1. category: string

2. name: string

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getConfigValue",
      "params": [category, name]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

debug_getRawBlock

Get Raw Block format.

Parameters

1. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getRawBlock",
      "params": [blockParameter]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (hex data)

debug_getRawHeader

Get Raw Header format.

Parameters

1. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getRawHeader",
      "params": [blockParameter]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (hex data)

debug_getRawReceipts

Get Raw Receipt format.

Parameters

1. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getRawReceipts",
      "params": [blockParameter]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string (hex data)

debug_getRawTransaction

Get Raw Transaction format.

Parameters

1. transactionHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getRawTransaction",
      "params": [transactionHash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (hex data)

debug_getSyncStage

Retrives Nethermind Sync Stage, With extra Metadata

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_getSyncStage",
      "params": []
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• currentStage: string

debug_insertReceipts

Insert receipts for the block after verifying receipts root correctness.

Parameters

1. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

2. receiptForRpc: array of object

• blobGasPrice: string (hex integer)
• blobGasUsed: string (hex integer)
• blockHash: string (hash)
• blockNumber: string (hex integer)
• contractAddress: string (address)
• cumulativeGasUsed: string (hex integer)
• effectiveGasPrice: string (hex integer)
• error: string
• from: string (address)
• gasUsed: string (hex integer)
• logs: array of object
  • address: string (address)
  • blockHash: string (hash)
  • blockNumber: string (hex integer)
  • data: string (hex data)
  • logIndex: string (hex integer)
  • removed: boolean
  • topics: array of string (hash)
  • transactionHash: string (hash)
  • transactionIndex: string (hex integer)
• logsBloom: string (hex data)
• root: string (hash)
• status: string (hex integer)
• to: string (address)
• transactionHash: string (hash)
• transactionIndex: string (hex integer)
• type: integer

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_insertReceipts",
      "params": [blockParameter, receiptForRpc]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: boolean

debug_migrateReceipts

Sets the block number up to which receipts will be migrated to (Nethermind specific).

Parameters

1. blockNumber: string (hex integer)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_migrateReceipts",
      "params": [blockNumber]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: boolean

debug_resetHead

Updates / resets head block - use only when the node got stuck due to DB / memory corruption (Nethermind specific).

Parameters

1. blockHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_resetHead",
      "params": [blockHash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: boolean

debug_standardTraceBlockToFile

Writes to a file the full stack trace of all invoked opcodes of the transaction specified (or all transactions if not specified) that was included in the block specified. The parent of the block must be present or it will fail.

Parameters

1. blockHash: string (hash)

2. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_standardTraceBlockToFile",
      "params": [blockHash, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string

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.

Parameters

1. blockRlp: string (hex data)

2. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceBlock",
      "params": [blockRlp, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

debug_traceBlockByHash

Similar to debug_traceBlock, this method accepts a block hash and replays the block that is already present in the database.

Parameters

1. blockHash: string (hash)

2. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceBlockByHash",
      "params": [blockHash, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

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.

Parameters

1. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

2. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceBlockByNumber",
      "params": [blockParameter, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

debug_traceCall

This method lets you run an eth_call within the context of the given block execution using the final state of parent block as the base. The block can be specified either by hash or by number. It takes the same input object as a eth_call. It returns the same output as debug_traceTransaction.

Parameters

1. call: object

   • accessList: array of object
     • address: string (address)
     • storageKeys: array of string (hex integer)
   • blobVersionedHashes: array of string (hex data)
   • blockHash: string (hash)
   • blockNumber: string (hex integer)
   • chainId: string (hex integer)
   • data: string (hex data)
   • from: string (address)
   • gas: string (hex integer)
   • gasPrice: string (hex integer)
   • hash: string (hash)
   • input: string (hex data)
   • isSystemTx: boolean
   • maxFeePerBlobGas: string (hex integer)
   • maxFeePerGas: string (hex integer)
   • maxPriorityFeePerGas: string (hex integer)
   • mint: string (hex integer)
   • nonce: string (hex integer)
   • r: string (hex integer)
   • s: string (hex integer)
   • sourceHash: string (hash)
   • to: string (address)
   • transactionIndex: string (hex integer)
   • type: integer
   • v: string (hex integer)
   • value: string (hex integer)
   • yParity: string (hex integer)

2. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

3. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceCall",
      "params": [call, blockParameter, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

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.

Parameters

1. transactionHash: string (hash)

2. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceTransaction",
      "params": [transactionHash, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

debug_traceTransactionByBlockAndIndex

Parameters

1. blockParameter: string (block number or hash or either of earliest, finalized, latest, pending, or safe)

2. txIndex: string (hex integer)

3. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceTransactionByBlockAndIndex",
      "params": [blockParameter, txIndex, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

debug_traceTransactionByBlockhashAndIndex

Parameters

1. blockHash: string (hash)

2. txIndex: string (hex integer)

3. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceTransactionByBlockhashAndIndex",
      "params": [blockHash, txIndex, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

debug_traceTransactionInBlockByHash

Parameters

1. blockRlp: string (hex data)

2. transactionHash: string (hash)

3. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceTransactionInBlockByHash",
      "params": [blockRlp, transactionHash, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string

debug_traceTransactionInBlockByIndex

Parameters

1. blockRlp: string (hex data)

2. txIndex: string (hex integer)

3. options: object

   • disableMemory: boolean
   • disableStack: boolean
   • disableStorage: boolean
   • enableMemory: boolean
   • timeout: string
   • tracer: string
   • tracerConfig: object
     • hasValue: boolean
     • value: object
       • item: object
       • valueKind: integer
   • txHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "debug_traceTransactionInBlockByIndex",
      "params": [blockRlp, txIndex, options]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• customTracerResult: object
  • value: object
• entries: array of object
  • depth: string (hex integer)
  • error: string
  • gas: string (hex integer)
  • gasCost: string (hex integer)
  • memory: array of string
  • opcode: string
  • programCounter: string (hex integer)
  • stack: array of string
  • storage: map of string
• failed: boolean
• gas: string (hex integer)
• returnValue: string (hex data)
• storagesByDepth: array of map of string