eth namespace

eth_blobBaseFee

Returns the base fee per blob gas in wei

Request

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

Response

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

result: string (hex integer)

eth_blockNumber

Returns current block number

Request

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

Response

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

result: string (hex integer)

eth_call

Executes a tx call (does not create a transaction)

Parameters

1. transactionCall: object

   • blockHash: string (hash)
   • blockNumber: string (hex integer)
   • gas: string (hex integer)
   • hash: string (hash)
   • transactionIndex: string (hex integer)
   • type: integer

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

3. stateOverride: map of object

• balance: string (hex integer)
• code: string (hex data)
• movePrecompileToAddress: string (address)
• nonce: string (hex integer)
• state: map of string (hash)
• stateDiff: map of string (hash)

Request

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

Response

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

result: string

eth_chainId

Returns ChainID

Request

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

Response

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

result: string (hex integer)

eth_config

Provides configuration data for the current and next fork

Request

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

Response

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

result: object

• item: object
• item: object
• options: object
  • hasValue: boolean
  • value: object
    • propertyNameCaseInsensitive: boolean
• parent: object
• root: object

eth_createAccessList

Creates an EIP2930 type AccessList for the given transaction

Parameters

1. transactionCall: object

   • blockHash: string (hash)
   • blockNumber: string (hex integer)
   • gas: string (hex integer)
   • hash: string (hash)
   • transactionIndex: string (hex integer)
   • type: integer

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

3. optimize: boolean

Request

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

Response

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

result: object

• accessList: object
• gasUsed: string (hex integer)

eth_estimateGas

Executes a tx call and returns gas used (does not create a transaction)

Parameters

1. transactionCall: object

   • blockHash: string (hash)
   • blockNumber: string (hex integer)
   • gas: string (hex integer)
   • hash: string (hash)
   • transactionIndex: string (hex integer)
   • type: integer

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

3. stateOverride: map of object

• balance: string (hex integer)
• code: string (hex data)
• movePrecompileToAddress: string (address)
• nonce: string (hex integer)
• state: map of string (hash)
• stateDiff: map of string (hash)

Request

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

Response

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

result: string (hex integer)

eth_feeHistory

Returns block fee history.

Parameters

1. blockCount: string (hex integer)

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

3. rewardPercentiles: array of object

Request

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

Response

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

result: object

• baseFeePerBlobGas: array of string (hex integer)
• baseFeePerGas: array of string (hex integer)
• blobGasUsedRatio: array of object
• gasUsedRatio: array of object
• oldestBlock: string (hex integer)
• reward: array of array of string (hex integer)

eth_gasPrice

Returns miner's gas price

Request

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

Response

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

result: string (hex integer)

eth_getAccount

Retrieves Accounts via Address and Blocknumber

Parameters

1. accountAddress: string (address)

2. 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": "eth_getAccount",
      "params": [accountAddress, blockParameter]
    }'

Response

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

result: object

• balance: string (hex integer)
• codeHash: object
  • bytes: object
    • isEmpty: boolean
    • item: object
    • length: string (hex integer)
  • bytesAsSpan: object
    • isEmpty: boolean
    • item: object
    • length: string (hex integer)
• nonce: string (hex integer)
• storageRoot: object
  • bytes: object
    • isEmpty: boolean
    • item: object
    • length: string (hex integer)
  • bytesAsSpan: object
    • isEmpty: boolean
    • item: object
    • length: string (hex integer)

eth_getAccountInfo

Retrieves Account with code and no storageRoot via Address and Blocknumber

Parameters

1. accountAddress: string (address)

2. 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": "eth_getAccountInfo",
      "params": [accountAddress, blockParameter]
    }'

Response

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

result: object

• balance: string (hex integer)
• code: string (hex data)
• nonce: string (hex integer)

eth_getBalance

Returns account balance

Parameters

1. address: string (address)

2. 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": "eth_getBalance",
      "params": [address, blockParameter]
    }'

Response

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

result: string (hex integer)

eth_getBlockByHash

Retrieves a block by hash

Parameters

1. blockHash: string (hash)

2. returnFullTransactionObjects: boolean

Request

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

Response

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

result: 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)
• requestsHash: 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)

eth_getBlockByNumber

Retrieves a block by number

Parameters

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

2. returnFullTransactionObjects: boolean

Request

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

Response

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

result: 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)
• requestsHash: 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)

eth_getBlockReceipts

Get receipts from all transactions from particular block, more efficient than fetching the receipts one-by-one.

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": "eth_getBlockReceipts",
      "params": [blockParameter]
    }'

Response

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

result: 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)
  • blockTimestamp: 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

eth_getBlockTransactionCountByHash

Returns number of transactions in the block block hash

Parameters

1. blockHash: string (hash)

Request

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

Response

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

result: string (hex integer)

eth_getBlockTransactionCountByNumber

Returns number of transactions in the block by block number

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": "eth_getBlockTransactionCountByNumber",
      "params": [blockParameter]
    }'

Response

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

result: string (hex integer)

eth_getCode

Returns account code at given address and block

Parameters

1. address: string (address)

2. 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": "eth_getCode",
      "params": [address, blockParameter]
    }'

Response

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

result: string (hex data)

eth_getFilterChanges

Reads filter changes

Parameters

1. filterId: string (hex integer)

Request

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

Response

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

result: array of object

eth_getFilterLogs

Reads filter changes

Parameters

1. filterId: string (hex integer)

Request

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

Response

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

result: array of object

• address: string (address)
• blockHash: string (hash)
• blockNumber: string (hex integer)
• blockTimestamp: 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)

eth_getLogs

Reads logs

Parameters

1. filter: object
   • address: object
   • fromBlock: string (block number or hash or either of earliest, finalized, latest, pending, or safe)
   • toBlock: string (block number or hash or either of earliest, finalized, latest, pending, or safe)
   • topics: array of object

Request

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

Response

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

result: array of object

• address: string (address)
• blockHash: string (hash)
• blockNumber: string (hex integer)
• blockTimestamp: 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)

eth_getProof

https://github.com/ethereum/EIPs/issues/1186

Parameters

1. accountAddress: string (address)

2. hashRate: array of string (hex integer)

3. 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": "eth_getProof",
      "params": [accountAddress, hashRate, blockParameter]
    }'

Response

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

result: object

• address: string (address)
• balance: string (hex integer)
• codeHash: string (hash)
• nonce: string (hex integer)
• proof: array of string (hex data)
• storageProofs: array of object
  • key: string (hex data)
  • proof: array of string (hex data)
  • value: object
    • hasValue: boolean
    • value: object
      • isEmpty: boolean
      • length: string (hex integer)
      • span: object
        • isEmpty: boolean
        • item: object
        • length: string (hex integer)
• storageRoot: string (hash)

eth_getRawTransactionByHash

Retrieves a transaction RLP by hash

Parameters

1. transactionHash: string (hash)

Request

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

Response

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

result: string

eth_getStorageAt

Returns storage data at address. storage_index

Parameters

1. address: string (address)

2. positionIndex: string (hex integer)

3. 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": "eth_getStorageAt",
      "params": [address, positionIndex, blockParameter]
    }'

Response

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

result: string (hex data)

eth_getTransactionByBlockHashAndIndex

Retrieves a transaction by block hash and index

Parameters

1. blockHash: string (hash)

2. positionIndex: string (hex integer)

Request

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

Response

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

result: object

• blockHash: string (hash)
• blockNumber: string (hex integer)
• gas: string (hex integer)
• hash: string (hash)
• transactionIndex: string (hex integer)
• type: integer

eth_getTransactionByBlockNumberAndIndex

Retrieves a transaction by block number and index

Parameters

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

2. positionIndex: string (hex integer)

Request

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

Response

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

result: object

• blockHash: string (hash)
• blockNumber: string (hex integer)
• gas: string (hex integer)
• hash: string (hash)
• transactionIndex: string (hex integer)
• type: integer

eth_getTransactionByHash

Retrieves a transaction by hash

Parameters

1. transactionHash: string (hash)

Request

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

Response

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

result: object

• blockHash: string (hash)
• blockNumber: string (hex integer)
• gas: string (hex integer)
• hash: string (hash)
• transactionIndex: string (hex integer)
• type: integer

eth_getTransactionCount

Returns account nonce (number of trnsactions from the account since genesis) at the given block number

Parameters

1. address: string (address)

2. 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": "eth_getTransactionCount",
      "params": [address, blockParameter]
    }'

Response

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

result: string (hex integer)

eth_getTransactionReceipt

Retrieves a transaction receipt by tx hash

Parameters

1. txHashData: string (hash)

Request

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

Response

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

result: 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)
  • blockTimestamp: 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

eth_getUncleByBlockHashAndIndex

Retrieves an uncle block header by block hash and uncle index

Parameters

1. blockHashData: string (hash)

2. positionIndex: string (hex integer)

Request

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

Response

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

result: 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)
• requestsHash: 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)

eth_getUncleByBlockNumberAndIndex

Retrieves an uncle block header by block number and uncle index

Parameters

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

2. positionIndex: string (hex integer)

Request

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

Response

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

result: 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)
• requestsHash: 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)

eth_getUncleCountByBlockHash

Returns number of uncles in the block by block hash

Parameters

1. blockHash: string (hash)

Request

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

Response

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

result: string (hex integer)

eth_getUncleCountByBlockNumber

Returns number of uncles in the block by block number

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": "eth_getUncleCountByBlockNumber",
      "params": [blockParameter]
    }'

Response

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

result: string (hex integer)

eth_newBlockFilter

Creates an update filter

Request

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

Response

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

result: string (hex integer)

eth_newFilter

Creates an update filter

Parameters

1. filter: object
   • address: object
   • fromBlock: string (block number or hash or either of earliest, finalized, latest, pending, or safe)
   • toBlock: string (block number or hash or either of earliest, finalized, latest, pending, or safe)
   • topics: array of object

Request

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

Response

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

result: string (hex integer)

eth_newPendingTransactionFilter

Creates an update filter

Request

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

Response

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

result: string (hex integer)

eth_pendingTransactions

Returns the pending transactions list

Request

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

Response

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

result: array of object

• blockHash: string (hash)
• blockNumber: string (hex integer)
• gas: string (hex integer)
• hash: string (hash)
• transactionIndex: string (hex integer)
• type: integer

eth_protocolVersion

Returns ETH protocol version

Request

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

Response

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

result: string

eth_sendRawTransaction

Send a raw transaction to the tx pool and broadcasting

Parameters

1. transaction: string (hex data)

Request

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

Response

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

result: string (hash)

eth_sendTransaction

Send a transaction to the tx pool and broadcasting

Parameters

1. rpcTx: object
   • blockHash: string (hash)
   • blockNumber: string (hex integer)
   • gas: string (hex integer)
   • hash: 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": "eth_sendTransaction",
      "params": [rpcTx]
    }'

Response

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

result: string (hash)

eth_simulateV1

Executes a simulation across multiple blocks (does not create a transaction or block)

Parameters

1. payload: object

   • blockStateCalls: array of object
     • blockOverrides: object
       • baseFeePerGas: string (hex integer)
       • blobBaseFee: string (hex integer)
       • feeRecipient: string (address)
       • gasLimit: string (hex integer)
       • number: string (hex integer)
       • prevRandao: string (hash)
       • time: string (hex integer)
     • calls: array of object
       • blockHash: string (hash)
       • blockNumber: string (hex integer)
       • gas: string (hex integer)
       • hash: string (hash)
       • transactionIndex: string (hex integer)
       • type: integer
     • stateOverrides: map of object
       • balance: string (hex integer)
       • code: string (hex data)
       • movePrecompileToAddress: string (address)
       • nonce: string (hex integer)
       • state: map of string (hash)
       • stateDiff: map of string (hash)
   • returnFullTransactionObjects: boolean
   • returnFullTransactions: boolean
   • traceTransfers: boolean
   • validation: boolean

2. 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": "eth_simulateV1",
      "params": [payload, blockParameter]
    }'

Response

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

result: array of object

• calls: array of object
  • error: object
    • code: string (hex integer)
    • data: string
    • message: string
  • gasUsed: string (hex integer)
  • logs: array of object
    • address: string (address)
    • blockHash: string (hash)
    • blockNumber: string (hex integer)
    • blockTimestamp: 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)
  • returnData: string (hex data)
  • status: string (hex integer)
• traces: array of object
  • error: object
    • code: string (hex integer)
    • data: string
    • message: string
  • gasUsed: string (hex integer)
  • logs: array of object
    • address: string (address)
    • blockHash: string (hash)
    • blockNumber: string (hex integer)
    • blockTimestamp: 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)
  • returnData: string (hex data)
  • status: string (hex integer)

eth_subscribe

Starts a subscription to a particular event over WebSockets. A JSON-RPC notification with event payload and subscription id is sent to a client for every event matching the subscription topic.

info

This method is enabled by adding subscribe to JsonRpc.EnabledModules.

Parameters

1. subscriptionName: string

2. filter: object

   • address: string (address)
   • fromBlock: string (block number or hash or either of earliest, finalized, latest, pending, or safe)
   • toBlock: string (block number or hash or either of earliest, finalized, latest, pending, or safe)
   • topics: array of string (hex data)

Request

wscat -c localhost:8545

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "eth_subscribe",
  "params": [subscriptionName, args]
}

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": "0x..." // subscription id
}

result: string

Notification

{
  "jsonrpc": "2.0",
  "method": "eth_subscription",
  "params": {
    "subscription": "0x...", // subscription id
    "result": payload
  }
}

See specific subcription topic below for payload details.

Subscription topics

newHeads

Subscribes to incoming block headers. Fires a notification each time a new header is appended to the chain, including chain reorganizations.

Notification payload: 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)
  • amount: string (hex integer)
  • index: string (hex integer)
  • validatorIndex: string (hex integer)
• withdrawalsRoot: string (hash)

logs

Subscribes to incoming logs filtered by the given options. In case of a chain reorganization, previously sent logs on the old chain will be re-sent with the removed field set to true.

Notification payload: 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)
• transactionLogIndex: string (hex integer)

newPendingTransactions

Subscribes to incoming pending transactions. Returns the transaction hash.

Notification payload: string (hash)

droppedPendingTransactions

Subscribes to transactions evicted from the transaction pool. Returns the transaction hash.

Notification payload: string (hash)

syncing

Subscribes to syncing events. Returns false (once) if the node is synced or an object with statistics (once) when the node starts syncing.

Notification payload:

• if synced: boolean
• if syncing: object
  • currentBlock: string (hex integer)
  • highestBlock: string (hex integer)
  • isSyncing: boolean
  • startingBlock: string (hex integer)

eth_syncing

Returns syncing status

Request

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

Response

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

result: object

• currentBlock: string (hex integer)
• highestBlock: string (hex integer)
• isSyncing: boolean
• startingBlock: string (hex integer)
• syncMode: integer

eth_uninstallFilter

Creates an update filter

Parameters

1. filterId: string (hex integer)

Request

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

Response

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

result: boolean

eth_unsubscribe

Unsubscribes from a subscription.

info

This method is enabled by adding subscribe to JsonRpc.EnabledModules.

Parameters

1. subscriptionId: string

Request

wscat -c localhost:8545

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "eth_unsubscribe",
  "params": [subscriptionId]
}

Response

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

result: boolean (true if unsubscribed successfully; otherwise, false)