debug_traceBlockByHash - Ethereum

The debug_traceBlockByHash method is part of the Ethereum JSON RPC Core API, designed for advanced debugging.

Returns full trace of all invoked opcodes of all transactions includedin the block.

The debug_traceBlockByHash method is part of the Ethereum JSON RPC Core API and is intended for advanced debugging purposes. This method provides a full trace of all invoked opcodes of all transactions included in a specified block by its hash. It is particularly useful for developers analyzing low-level transaction execution details within a block.

Supported Networks

The debug_traceBlockByHash RPC Ethereum method supports all Ethereum network types, including:

• Mainnet

• Testnets: Sepolia, Holesky

Parameters

The debug_traceBlockByHash method accepts the following parameters:

• Block hash: (data) The hash of the block to be traced.

• Object: (None) Request options. These are optional and default to false.

Request

URL (API Endpoints) https://go.getblock.io/<ACCESS-TOKEN>/

To make a request, send a JSON object with the jsonrpc, method, and params fields. Below is an example of how to make a request using curl:

curl

curl --location --request POST 'https://go.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "debug_traceBlockByHash",
    "params": [
        "0x2dfcd01e308905d7a46187745f5e07606e31682c8443a171bb47ce3d399b5049",
        null
    ],
    "id": "getblock.io"
}'

ws

wscat -c wss://eth.getblock.io/YOUR-API-KEY/ 
# wait for connection and send the request body 
{"jsonrpc": "2.0",
"method": "debug_traceBlockByHash",
"params": ["0x2dfcd01e308905d7a46187745f5e07606e31682c8443a171bb47ce3d399b5049", null],
"id": "getblock.io"}

Response

The server responds with a JSON object. Below is an example response for the debug_traceBlockByHash method:

{
    "result": "null",
    "id": "getblock.io",
    "status_code": 405,
    "message": "Method not allowed"
}

Response Description

• result: null if the method is not allowed or unavailable.

• status_code: The HTTP status code for the request.

• message: A descriptive message explaining the response, e.g., "Method not allowed."

Returns

If successful, the method provides a detailed trace of all transactions in the block, including:

• block: The block details, including its hash and transactions.

• transaction: A detailed trace of each transaction in the block.

• parameters: Opcode-level execution details and associated data.

• value: The values used or modified during the transaction execution.

Use Case

The debug_traceBlockByHash method is valuable for developers needing detailed debugging of Ethereum transactions at the opcode level. This includes analyzing gas consumption, investigating failed transactions, and diagnosing issues in smart contract execution. If a debug_traceBlockByHash error occurs, ensure the provided block hash is correct and that your node supports this method. The provided debug_traceBlockByHash example demonstrates how to construct a proper request. The Web3 debug_traceBlockByHash method can also be used through Web3 libraries for Ethereum, supporting complex debugging scenarios and transaction analysis.

Example Code

Here is an example of how to call the debug_traceBlockByHash method programmatically using Python:

Python

import requests
import json


# Define the API URL and access token
url = 'https://go.getblock.io/<ACCESS-TOKEN>/'
headers = {'Content-Type': 'application/json'}


# Prepare the request data
data = {
    "jsonrpc": "2.0",
    "method": "debug_traceBlockByHash",
    "params": [
        "0x2dfcd01e308905d7a46187745f5e07606e31682c8443a171bb47ce3d399b5049",
        null
    ],
    "id": "getblock.io"
}


# Send the POST request
response = requests.post(url, headers=headers, data=json.dumps(data))


# Parse the JSON response
response_data = response.json()


# Print the result
print(json.dumps(response_data, indent=4))

JavaScript

const axios = require('axios');

const url = 'https://go.getblock.io/<ACCESS-TOKEN>/';
const headers = {
    'Content-Type': 'application/json'
};
const data = {
    jsonrpc: "2.0",
    method: "debug_traceBlockByHash",
    params: [
        "0x2dfcd01e308905d7a46187745f5e07606e31682c8443a171bb47ce3d399b5049",
        null
    ],
    id: "getblock.io"
};

axios.post(url, data, { headers })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error('Error:', error);
    });

This Python script demonstrates how to interact with the debug_traceBlockByHash method programmatically. Replace <ACCESS-TOKEN> with your actual API key.

\