Skip to main content

[Block] klay_getBlockByHash

Returns information about a block by hash. This API works only on RPC call, not on JavaScript console.

JSONRPC: klay_getBlockByHash

Request

Body

    method stringrequired

    Default value: klay_getBlockByHash

    Method name

    id int64required

    Default value: 1

    Request ID, Random or Auto incrementation

    jsonrpc stringrequired

    Default value: 2.0

    JSON-RPC Version (2.0)

    params

    undefined[]

    required

  • Array [

  • BlockHash 32-byte DATA

    Hash of a block.

    ReturnTransactionObject ReturnTransactionObject

    If true it returns the full transaction objects, if false only the hashes of the transactions.

  • ]

Responses

Returns information about a block by hash

Schema

    jsonrpc stringrequired

    Default value: 2.0

    id int64required

    error

    object

    code int64required

    A Number that indicates the error type that occurred. This MUST be an integer.

    | code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

    message string

    A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

    data string

    A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

    result

    object

    A block object, or error when no block was found

    number hexrequired

    The block number. null when it is pending block.

    hash 32-byte DATArequired

    Hash of the block. null when it is pending block.

    parentHash 32-byte DATArequired

    Hash of the parent block.

    logsBloom 256-byte DATArequired

    The bloom filter for the logs of the block. null when it is pending block.

    transactionsRoot 32-byte DATArequired

    The root of the transaction trie of the block.

    stateRoot 32-byte DATArequired

    The root of the final state trie of the block.

    receiptsRoot 32-byte DATArequired

    The root of the receipts trie of the block.

    reward 20-byte DATArequired

    The address of the beneficiary to whom the block rewards were given.

    blockScore hexrequired

    Former difficulty. Always 1 in the BFT consensus engine

    totalBlockScore hexrequired

    Integer of the total blockScore of the chain until this block.

    extraData DATArequired

    The "extra data" field of this block.

    size hexrequired

    Integer the size of this block in bytes.

    gasUsed hexrequired

    The total used gas by all transactions in this block.

    timestamp hexrequired

    The unix timestamp for when the block was collated.

    timestampFoS hexrequired

    The fraction of a second of the timestamp for when the block was collated.

    transactions

    object[]

    required

    Array of transaction objects, or 32-byte transaction hashes depending on the last given parameter.

  • Array [

  • oneOf

    string

  • ]

  • governanceData DATArequired

    RLP encoded governance configuration

    voteData DATArequired

    RLP encoded governance vote of the proposer

    baseFeePerGas hexrequired

    The base fee per gas. It has a meaningful value when EthTxTypeCompatible and Magma hardforks are activated.

Loading...
Make this page better