Klaytn Docs
Search…
Block

The Default Block Parameter

When requests are made that act on the state of Klaytn, the last default block parameter determines the height of the block.
The following options are possible for the defaultBlock parameter:
  • HEX String - an integer block number
  • String "earliest" for the earliest/genesis block
  • String "latest" - for the latest mined block
  • String "pending" - for the pending state/transactions

klay_blockNumber

Returns the number of most recent block.
Parameters
None
Return Value
Type
Description
QUANTITY
Integer of the current block number the client is on.
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_blockNumber","params":[],"id":83}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc": "2.0",
"id":83,
"result": "0xc94"
}

klay_getHeaderByNumber

NOTE: This API is supported from Klaytn v1.7.0.
Returns information about a header by number. This API works only on RPC call, not on JavaScript console.
Parameters
Type
Description
QUANTITY | TAG
Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter.
Return Value
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getHeaderByNumber","params":["0x1b4"],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"baseFeePerGas":"0x5d21dba00",
"blockScore":"0x1",
"extraData":"0xda83010800846b6c617989676f312e31362e31338664617277696e0000000000f89ed5949712f943b296758aaae79944ec975884188d3a96b841ddfdf7e2cb0a93538f757f87f23a93ee35df703c781c6f15e31e4978ecdfb3501fc00924372b9a01df2bc452f2a924c242d83580183d131c47e49a25b78f625201f843b841b9b6034d5a8c5f5b057274cda4f427614cd1f448ee781f4c4322861d1361d09d47d6030f2b69a26cb426db984f54e71f8c112fbf882930ccd715d595e8d8307500",
"gasUsed":"0x0",
"governanceData":"0x",
"hash":"0xe882d7a16f38126dc0c507f990b3fe18fa2d3a380002538581327abe96ca6edc",
"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number":"0x1e67",
"parentHash":"0x28b1c054346c3bd083741c757a750dcabf94b6d50c7f87158753544e96e73550",
"receiptsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"reward":"0x4b2c736fd05c2e2da3ccbd001a395a444f16a861",
"stateRoot":"0xdf9885621c9e6e75912ca94d6987bcb1b54fef0e4a99cbec5e68f1ffc7468a78",
"timestamp":"0x62130beb",
"timestampFoS":"0x0",
"transactionsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"
}
}

klay_getHeaderByHash

NOTE: This API is supported from Klaytn v1.7.0.
Returns information about a header by hash. This API works only on RPC call, not on JavaScript console.
Parameters
Type
Description
32-byte DATA
Hash of a block.
Return Value
Object - A header object, or error when no header was found:
Name
Type
Description
number
QUANTITY
The block number. null when it is pending block.
parentHash
32-byte DATA
The hash of the parent block.
logsBloom
256-byte DATA
The bloom filter for the logs of the block. null when it is pending block.
transactionsRoot
32-byte DATA
The root of the transaction trie of the block.
stateRoot
32-byte DATA
The root of the final state trie of the block.
receiptsRoot
32-byte DATA
The root of the receipts trie of the block.
reward
20-byte DATA
The address of the beneficiary to whom the block rewards were given.
blockScore
QUANTITY
Former difficulty. Always 1 in the BFT consensus engine
extraData
DATA
The "extra data" field of this block.
gasUsed
QUANTITY
The total used gas by all transactions in this block.
timestamp
QUANTITY
The Unix timestamp for when the block was collated.
timestampFoS
QUANTITY
The fraction of a second of the timestamp for when the block was collated.
governanceData
DATA
RLP encoded governance configuration
voteData
DATA
RLP encoded governance vote of the proposer
baseFeePerGas
QUANTITY
The base fee per gas. It has a meaningful value when EthTxTypeCompatible and Magma hardforks are activated.
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getHeaderByHash","params":["0xb8deae63002d2b6aa33247c8ef545383ee0fd2282ac9b49dbbb74114389ddb5c"],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"baseFeePerGas":"0x5d21dba00",
"blockScore":"0x1",
"extraData":"0xda83010800846b6c617989676f312e31362e31338664617277696e0000000000f89ed5949712f943b296758aaae79944ec975884188d3a96b841ddfdf7e2cb0a93538f757f87f23a93ee35df703c781c6f15e31e4978ecdfb3501fc00924372b9a01df2bc452f2a924c242d83580183d131c47e49a25b78f625201f843b841b9b6034d5a8c5f5b057274cda4f427614cd1f448ee781f4c4322861d1361d09d47d6030f2b69a26cb426db984f54e71f8c112fbf882930ccd715d595e8d8307500",
"gasUsed":"0x0",
"governanceData":"0x",
"hash":"0xe882d7a16f38126dc0c507f990b3fe18fa2d3a380002538581327abe96ca6edc",
"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number":"0x1e67",
"parentHash":"0x28b1c054346c3bd083741c757a750dcabf94b6d50c7f87158753544e96e73550",
"receiptsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"reward":"0x4b2c736fd05c2e2da3ccbd001a395a444f16a861",
"stateRoot":"0xdf9885621c9e6e75912ca94d6987bcb1b54fef0e4a99cbec5e68f1ffc7468a78",
"timestamp":"0x62130beb",
"timestampFoS":"0x0",
"transactionsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"
}
}

klay_getBlockByNumber

Returns information about a block by block number. This API works only on RPC call, not on JavaScript console.
Parameters
Type
Description
QUANTITY | TAG
Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter.
Boolean
If true it returns the full transaction objects, if false only the hashes of the transactions.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getBlockByNumber","params":["0x1b4", true],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"baseFeePerGas":"0x5d21dba00",
"blockscore":"0x1",
"extraData":"0xda83010800846b6c617989676f312e31362e31338664617277696e0000000000f89ed5949712f943b296758aaae79944ec975884188d3a96b841ddfdf7e2cb0a93538f757f87f23a93ee35df703c781c6f15e31e4978ecdfb3501fc00924372b9a01df2bc452f2a924c242d83580183d131c47e49a25b78f625201f843b841b9b6034d5a8c5f5b057274cda4f427614cd1f448ee781f4c4322861d1361d09d47d6030f2b69a26cb426db984f54e71f8c112fbf882930ccd715d595e8d8307500",
"gasUsed":"0x0",
"governanceData":"0x",
"hash":"0xe882d7a16f38126dc0c507f990b3fe18fa2d3a380002538581327abe96ca6edc",
"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number":"0x1e67",
"parentHash":"0x28b1c054346c3bd083741c757a750dcabf94b6d50c7f87158753544e96e73550",
"receiptsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"reward":"0x4b2c736fd05c2e2da3ccbd001a395a444f16a861",
"size":"0x272",
"stateRoot":"0xdf9885621c9e6e75912ca94d6987bcb1b54fef0e4a99cbec5e68f1ffc7468a78",
"timestamp":"0x62130beb",
"timestampFoS":"0x0",
"totalBlockScore":"0x1e68",
"transactions":[],
"transactionsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"voteData":"0x"
}
}

klay_getBlockByHash

Returns information about a block by hash. This API works only on RPC call, not on JavaScript console.
Parameters
Type
Description
32-byte DATA
Hash of a block.
Boolean
If true it returns the full transaction objects, if false only the hashes of the transactions.
Return Value
Object - A block object, or error when no block was found:
Name
Type
Description
number
QUANTITY
The block number. null when it is pending block.
hash
32-byte DATA
Hash of the block. null when it is pending block.
parentHash
32-byte DATA
Hash of the parent block.
logsBloom
256-byte DATA
The bloom filter for the logs of the block. null when it is pending block.
transactionsRoot
32-byte DATA
The root of the transaction trie of the block.
stateRoot
32-byte DATA
The root of the final state trie of the block.
receiptsRoot
32-byte DATA
The root of the receipts trie of the block.
reward
20-byte DATA
The address of the beneficiary to whom the block rewards were given.
blockScore
QUANTITY
Former difficulty. Always 1 in the BFT consensus engine
totalBlockScore
QUANTITY
Integer of the total blockScore of the chain until this block.
extraData
DATA
The "extra data" field of this block.
size
QUANTITY
Integer the size of this block in bytes.
gasUsed
QUANTITY
The total used gas by all transactions in this block.
timestamp
QUANTITY
The Unix timestamp for when the block was collated.
timestampFoS
QUANTITY
The fraction of a second of the timestamp for when the block was collated.
transactions
Array
Array of transaction objects, or 32-byte transaction hashes depending on the last given parameter.
governanceData
DATA
RLP encoded governance configuration
voteData
DATA
RLP encoded governance vote of the proposer
baseFeePerGas
QUANTITY
The base fee per gas. It has a meaningful value when EthTxTypeCompatible and Magma hardforks are activated.
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getBlockByHash","params":["0xb8deae63002d2b6aa33247c8ef545383ee0fd2282ac9b49dbbb74114389ddb5c", true],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"baseFeePerGas":"0x0",
"blockscore":"0x1",
"extraData":"0xda83010800846b6c617989676f312e31362e31338664617277696e0000000000f89ed5949712f943b296758aaae79944ec975884188d3a96b841ddfdf7e2cb0a93538f757f87f23a93ee35df703c781c6f15e31e4978ecdfb3501fc00924372b9a01df2bc452f2a924c242d83580183d131c47e49a25b78f625201f843b841b9b6034d5a8c5f5b057274cda4f427614cd1f448ee781f4c4322861d1361d09d47d6030f2b69a26cb426db984f54e71f8c112fbf882930ccd715d595e8d8307500",
"gasUsed":"0x0",
"governanceData":"0x",
"hash":"0xe882d7a16f38126dc0c507f990b3fe18fa2d3a380002538581327abe96ca6edc",
"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number":"0x1e67",
"parentHash":"0x28b1c054346c3bd083741c757a750dcabf94b6d50c7f87158753544e96e73550",
"receiptsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"reward":"0x4b2c736fd05c2e2da3ccbd001a395a444f16a861",
"size":"0x272",
"stateRoot":"0xdf9885621c9e6e75912ca94d6987bcb1b54fef0e4a99cbec5e68f1ffc7468a78",
"timestamp":"0x62130beb",
"timestampFoS":"0x0",
"totalBlockScore":"0x1e68",
"transactions":[],
"transactionsRoot":"0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"voteData":"0x"
}
}

klay_getBlockReceipts

Returns receipts included in a block identified by block hash.
Parameters
Type
Description
32-byte DATA
Block hash
Return Value
Receipts included in a block. If the target block contains no transaction, an empty array [] is returned.
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getBlockReceipts", "params":["0xdc762ed0274496e2a42278e2648d910d82468687b5415bb5eb058a96a0b93c30"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":73,
"result":[{
"blockHash":"0xdc762ed0274496e2a42278e2648d910d82468687b5415bb5eb058a96a0b93c30",
"blockNumber":"0x3ba38",
"contractAddress":null,
"effectiveGasPrice":"0x5d21dba00",
"from":"0x16b11cf9c2186a117b0da38315b42b1eaa03bbe5",
"gas":"0x30d40",
"gasPrice":"0xba43b7400",
"gasUsed":"0x1886c",
"logs":[],
"logsBloom":"0x00000000000000000000000000000000008000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000040000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"nonce":"0x58e",
"senderTxHash":"0x234469b3d3222657c98904deaba7ec6613161ea9405275025f4784a4d9918af5",
"signatures":["0x7f6","0x50b2b0f95b8a6d7018369b1933d6cebb52ef119463d1840a6181d05bf8fc29d8","0x329630f88d9d06c5f1bd7644dbf6bd6b92e4ab0e3d47122972f8294c9289e7bb"],
"status":"0x1",
"to":"0xdbb98c72e9818ad2c93a09e35ad43ada0d4223f0",
"transactionHash":"0x234469b3d3222657c98904deaba7ec6613161ea9405275025f4784a4d9918af5",
"transactionIndex":"0x0",
"type":"TxTypeValueTransfer",
"typeInt":8,
"value":"0x21e19e0c9bab2400000"
}
}

klay_getBlockTransactionCountByNumber

Returns the number of transactions in a block matching the given block number.
Parameters
Type
Description
QUANTITY | TAG
Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Type
Description
QUANTITY
Integer of the number of transactions in this block.
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc": "2.0",
"id":1,
"result": "0xa" // 10
}

klay_getBlockTransactionCountByHash

Returns the number of transactions in a block from a block that matches the given hash.
Parameters
Type
Description
32-byte DATA
Hash of a block
Return Value
Type
Description
QUANTITY
Integer of the number of transactions in this block.
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getBlockTransactionCountByHash","params":["0x0c11803ab36110db993e7520908b9ba9336cca2f2dcc9b6130c481a3ccdc2621"],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc": "2.0",
"id":1,
"result": "0x0"
}

klay_getBlockWithConsensusInfoByNumber

Returns a block with consensus information that matches the given block number.
Parameters
Type
Description
QUANTITY | TAG
Integer or hexadecimal block number, or the string "earliest" or "latest" as in the default block parameter.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getBlockWithConsensusInfoByNumber", "params":["0x6e0431"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc": "2.0",
"id": 73,
"result": {
"baseFeePerGas":"0x5d21dba00",
"blockscore": "0x1",
"committee": ["0xe783fc94fddaeebef7293d6c5864cff280f121e1", "0x8a88a093c05376886754a9b70b0d0a826a5e64be", "0xf113ec8c22765d485309cf1d025d1b975245b9f8", "0xe3d92072d8b9a59a0427485a1b5f459271df457c", "0xa2ba8f7798649a778a1fd66d3035904949fec555", "0x2bdd279522b8a0843831fbb94cfbb24a913597c5", "0x9419fa2e3b9eb1158de31be66c586a52f49c5de7", "0xc032c34cb9fe064fe435199e1078dd8756a166b5", "0x56e8c1463c341abf8b168c3079ea41ce8a387e18", "0x6873352021fe9226884616dc6f189f289aeb0cc5", "0xe93a890fb7ec5e993b1a7fd77b0d13a0763eff3d", "0xbca8ffa45cc8e30bbc0522cdf1a1e0ebf540dfe2", "0x386ca3cb8bb13f48d1a6adc1fb8df09e7bb7f9c8", "0x1782834bf8847e235f21f2c1f13fca4d5dff6621", "0x6f6770f1f67f44fb15b335b49581ad6b935d963a", "0x0b59cae1f03534209fdb9ddf5ea65b310cd7060c", "0xb9456fd65a6810b19df24832c50b2e61a41867f8", "0x16c192585a0ab24b552783b4bf7d8dc9f6855c35", "0xec6c1cede510be308f0fdbbc8dbdf238829bdb34", "0xf8c9c61c5e7f2b6219d1c28b94e5cb3cdc802594", "0x5e59db28cef098d5a2e877f84127aed10d7378f2", "0x52d41ca72af615a1ac3301b0a93efa222ecc7541"],
"extraData": "0xd883010101846b6c617988676f312e31322e35856c696e757800000000000000f90604f901ce9452d41ca72af615a1ac3301b0a93efa222ecc7541948a88a093c05376886754a9b70b0d0a826a5e64be94f113ec8c22765d485309cf1d025d1b975245b9f894e3d92072d8b9a59a0427485a1b5f459271df457c94a2ba8f7798649a778a1fd66d3035904949fec555942bdd279522b8a0843831fbb94cfbb24a913597c594bca8ffa45cc8e30bbc0522cdf1a1e0ebf540dfe294c032c34cb9fe064fe435199e1078dd8756a166b59456e3a565e31f8fb0ba0b12c03355518c64372120946f6770f1f67f44fb15b335b49581ad6b935d963a94e93a890fb7ec5e993b1a7fd77b0d13a0763eff3d94e783fc94fddaeebef7293d6c5864cff280f121e194386ca3cb8bb13f48d1a6adc1fb8df09e7bb7f9c8941782834bf8847e235f21f2c1f13fca4d5dff6621949419fa2e3b9eb1158de31be66c586a52f49c5de7940b59cae1f03534209fdb9ddf5ea65b310cd7060c94b9456fd65a6810b19df24832c50b2e61a41867f89416c192585a0ab24b552783b4bf7d8dc9f6855c3594ec6c1cede510be308f0fdbbc8dbdf238829bdb3494f8c9c61c5e7f2b6219d1c28b94e5cb3cdc802594946873352021fe9226884616dc6f189f289aeb0cc59456e8c1463c341abf8b168c3079ea41ce8a387e18b8418890007a341ee171ba8d5e3cb546d1d927c8202f0df3c3f381c8173eb36db41305227c289fb528a4614b1a2c04a7ec5a1b5d76f62b829496aa36979e88a9610c01f903edb841f0ba93ac8e28a021e582e50abbaa24fa5174674b3b0873dc568f6c9ebaf830bb4d03b857416304f97b4314e310f66f6c8043e716e70751bc9663dd6f9e5d6a9100b84174717204aa9d9f2dcb1269c89141ec2ee9d447e1981e8a704caa5a6ce376b0901f3e0ddf0ebe08542af86b23637df2f962b0f7ced5469cea310cb71c2358357300b841aa3aa8b450a6f4d883dcf2eda0f964ff4d35a250996b34aa91279c9c7f4383a22c879e2f21c9fddf8c3b1a6cbc59b273b4a0daf4b15aaf18f5e33e70c9277e6f00b8414adbeaaf82da005a33f00e7f74a3eeecb989698968b3694ea9e74018a0836184188eca727900280734ead256af02e72679addcddbf5ebd82c04c030c2bd85f4a01b841610b61422badd11afa2a617502f81c0c8aa1f11951d80893976a391026a3859c1f5e6c6d28e8b2ca8c4281c699b7b8ec30625801d4a6637291f9a8d1a2d8244f00b8417590e3d92063d4162f49493848ef0557daba3c2d82b9498eda09d5d08837296937a69e7b852579eeadf1c077d3b80d232ece03a12f4c45896e518cbb0771c52700b8415a2a40f416154793535cfe133040236ecc8b1f276df39e0a3713992fad06e38a42a455a636add93bff218544a4c53b852b8c4e461d3ae0663fdefe8fe7e327cc00b841e0c64cc8a30d84196d57639a42c5da941164b0700476d1b91d18f7c8f58d12f932ad1362270ec968294257f9c5cb60c40a7d4a5932a8f4d537be4db51f7dcf2500b841f61b6f014628ab751d79f095b1e739bc2b31fa8b6b847878e13b000a6dd53fa8467903119a72c7445f8490cf4932a42f4a418b89436b70d100c56c083399579500b841e6fe4f7c4bdcb4a81125bd282d0b9fedf1f51636c69bd4684d3131d685a7aed34face3d943d02b6ad632bb337f89fd6b0fb08e163ef84bb87fe556f4bafa0d3401b8412c6666136414f88327e07a6e8a2b04d105d6cf64daee239cea647a25f93ce0e6542f59f4363e3522bc838841e6db1940e569938b9458fb674fd543646a6b669b00b84134f967c4060d85a7c2f65d00695f3308d2ab78033e895775e0ab6f70cc6e71081c030bd997773191b3d2d7e5425e542c3b98fc127031784a858cf497c0e1532100b841d81aedf218d33e12087fb6c71b1d76e69dde542659c85661909b8c99793c7f1535afdc8addaefc5bcf6a3f99fd34518a1e9ab4a73ec9921e9865c1bd8543fd4c01b84199ec6f0fca02e48db37f0e4ae1b2fdf643abf610a9f1d7c0b490250aa7f1393d3069d1b4cec74ee99b0e18081bbf5e03d7b918d46499d579459cf0114ff76e9301b841d81a55eb96767edc5305dac78b904f70d2f44bd845fcd2bd581778669e5b8446220143680619986b9975ea528aacec0976406424588760f4fe086f16abaaaf4600",
"gasUsed": "0x1d065",
"governanceData": "0x",
"hash": "0x7d68d09a7a571cdf8a3b6a5ef6e037265b3e3093cf145b0954d22bde5c1d4f61",
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number": "0x6e0431",
"parentHash": "0xa76ef625874a4d2126eb3fd1ebb5c1a8d0deb360a12b4f8edf30fb417d82b5a1",
"proposer": "0xe783fc94fddaeebef7293d6c5864cff280f121e1",
"receiptsRoot": "0x56734b337c3daab6766104bb51bd2ca408cf4537f5528ab3362536c57e65ba67",
"reward": "0x79f83dbb81f6f706be3e8491b14790c30d03e659",
"size": "0x947",
"stateRoot": "0xf685dce2cbef004cb041cf23959aea65e8aa86911fac55739ae1971f7d1dacd4",
"timestamp": "0x5d801768",
"timestampFoS": "0x4",
"totalBlockScore": "0x6e0432",
"transactions": [
{
"blockHash": "0x7d68d09a7a571cdf8a3b6a5ef6e037265b3e3093cf145b0954d22bde5c1d4f61",
"blockNumber": "0x6e0431",
"contractAddress": null,
"feePayer": "0x08260736c18bd8612bee2b21beedf4e97c0bc6b9",
"feePayerSignatures": [
{
"V": "0x4055",
"R": "0xd3fdd58e18e5a96d1f9af3d1aff31601d8e543a8085c78edfc8602db4c91b3c6",
"S": "0x19d937e315472a188f11a6bb87f47e66a30b44ba907b5f01fcd47dab8d99f3f0"
}
],
"from": "0x84b605b268e89ccdf591974db82deaa48bce59dc",
"gas": "0x419ce0",
"gasPrice": "0x5d21dba00",
"gasUsed": "0x1d065",
"input": "0x50716652000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000013416c50000000000000000000000000000000000000000000000000000000000001f3f000000000000000000000000000000000000000000000000000000003b9af23c",
"logs": [],
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"nonce": "0x8",
"senderTxHash": "0x5fe7485db56c0c2b0eb54dd46e584a413193ad66b40e69281f44dadfa7409b2e",
"signatures": [
{
"V": "0x4056",
"R": "0xca32239c38e1080f3a394504e2a0bb9811cda0a87d25b750cbbab265d581074d",
"S": "0x584ab136a483e755d9d458f9965ca0d514724c7b45f6123d19323f6fa7ccdb5f"
}
],
"status": "0x1",
"to": "0x1db1b93447328dd904152f798ead97987844f7b7",
"transactionHash": "0x020a2156bb4b29dc84f26887efae79e07a3d738b2856a66bbaab8aee18d507b5",
"transactionIndex": "0x0",
"type": "TxTypeFeeDelegatedSmartContractExecution",
"typeInt": 49,
"value": "0x0"
}
],
"transactionsRoot": "0x020a2156bb4b29dc84f26887efae79e07a3d738b2856a66bbaab8aee18d507b5",
"voteData": "0x"
}
}

klay_getBlockWithConsensusInfoByHash

Returns a block with consensus information that matches the given hash.
Parameters
Type
Description
32-byte DATA
Hash of a block.
Return Value
Object - A block object with consensus information (a proposer and a list of committee members), or error when no block was found:
Name
Type
Description
blockScore
QUANTITY
Former difficulty. Always 1 in the BFT consensus engine
totalBlockScore
QUANTITY
Integer of the total blockScore of the chain until this block.
committee
Array
Array of addresses of committee members of this block. The committee is a subset of validators participated in the consensus protocol for this block.
gasUsed
QUANTITY
The total used gas by all transactions in this block.
hash
32-byte DATA
Hash of the block. null when it is pending block.
number
QUANTITY
The block number. null when it is pending block.
parentHash
32-byte DATA
Hash of the parent block.
proposer
20-byte DATA
The address of the block proposer.
receiptsRoot
32-byte DATA
The root of the receipts trie of the block.
size
QUANTITY
Integer the size of this block in bytes.
stateRoot
32-byte DATA
The root of the final state trie of the block.
timestamp
QUANTITY
The Unix timestamp for when the block was collated.
timestampFoS
QUANTITY
The fraction of a second of the timestamp for when the block was collated.
transactions
Array
Array of transaction objects.
transactionsRoot
32-byte DATA
The root of the transaction trie of the block.
baseFeePerGas
QUANTITY
The base fee per gas. It has a meaningful value when EthTxTypeCompatible and Magma hardforks are activated.
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getBlockWithConsensusInfoByHash", "params":["0x7d68d09a7a571cdf8a3b6a5ef6e037265b3e3093cf145b0954d22bde5c1d4f61"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc": "2.0",
"id": 73,
"result": {
"baseFeePerGas":"0x5d21dba00",
"blockscore": "0x1",
"committee": ["0xe783fc94fddaeebef7293d6c5864cff280f121e1", "0x8a88a093c05376886754a9b70b0d0a826a5e64be", "0xf113ec8c22765d485309cf1d025d1b975245b9f8", "0xe3d92072d8b9a59a0427485a1b5f459271df457c", "0xa2ba8f7798649a778a1fd66d3035904949fec555", "0x2bdd279522b8a0843831fbb94cfbb24a913597c5", "0x9419fa2e3b9eb1158de31be66c586a52f49c5de7", "0xc032c34cb9fe064fe435199e1078dd8756a166b5", "0x56e8c1463c341abf8b168c3079ea41ce8a387e18", "0x6873352021fe9226884616dc6f189f289aeb0cc5", "0xe93a890fb7ec5e993b1a7fd77b0d13a0763eff3d", "0xbca8ffa45cc8e30bbc0522cdf1a1e0ebf540dfe2", "0x386ca3cb8bb13f48d1a6adc1fb8df09e7bb7f9c8", "0x1782834bf8847e235f21f2c1f13fca4d5dff6621", "0x6f6770f1f67f44fb15b335b49581ad6b935d963a", "0x0b59cae1f03534209fdb9ddf5ea65b310cd7060c", "0xb9456fd65a6810b19df24832c50b2e61a41867f8", "0x16c192585a0ab24b552783b4bf7d8dc9f6855c35", "0xec6c1cede510be308f0fdbbc8dbdf238829bdb34", "0xf8c9c61c5e7f2b6219d1c28b94e5cb3cdc802594", "0x5e59db28cef098d5a2e877f84127aed10d7378f2", "0x52d41ca72af615a1ac3301b0a93efa222ecc7541"],
"extraData": "0xd883010101846b6c617988676f312e31322e35856c696e757800000000000000f90604f901ce9452d41ca72af615a1ac3301b0a93efa222ecc7541948a88a093c05376886754a9b70b0d0a826a5e64be94f113ec8c22765d485309cf1d025d1b975245b9f894e3d92072d8b9a59a0427485a1b5f459271df457c94a2ba8f7798649a778a1fd66d3035904949fec555942bdd279522b8a0843831fbb94cfbb24a913597c594bca8ffa45cc8e30bbc0522cdf1a1e0ebf540dfe294c032c34cb9fe064fe435199e1078dd8756a166b59456e3a565e31f8fb0ba0b12c03355518c64372120946f6770f1f67f44fb15b335b49581ad6b935d963a94e93a890fb7ec5e993b1a7fd77b0d13a0763eff3d94e783fc94fddaeebef7293d6c5864cff280f121e194386ca3cb8bb13f48d1a6adc1fb8df09e7bb7f9c8941782834bf8847e235f21f2c1f13fca4d5dff6621949419fa2e3b9eb1158de31be66c586a52f49c5de7940b59cae1f03534209fdb9ddf5ea65b310cd7060c94b9456fd65a6810b19df24832c50b2e61a41867f89416c192585a0ab24b552783b4bf7d8dc9f6855c3594ec6c1cede510be308f0fdbbc8dbdf238829bdb3494f8c9c61c5e7f2b6219d1c28b94e5cb3cdc802594946873352021fe9226884616dc6f189f289aeb0cc59456e8c1463c341abf8b168c3079ea41ce8a387e18b8418890007a341ee171ba8d5e3cb546d1d927c8202f0df3c3f381c8173eb36db41305227c289fb528a4614b1a2c04a7ec5a1b5d76f62b829496aa36979e88a9610c01f903edb841f0ba93ac8e28a021e582e50abbaa24fa5174674b3b0873dc568f6c9ebaf830bb4d03b857416304f97b4314e310f66f6c8043e716e70751bc9663dd6f9e5d6a9100b84174717204aa9d9f2dcb1269c89141ec2ee9d447e1981e8a704caa5a6ce376b0901f3e0ddf0ebe08542af86b23637df2f962b0f7ced5469cea310cb71c2358357300b841aa3aa8b450a6f4d883dcf2eda0f964ff4d35a250996b34aa91279c9c7f4383a22c879e2f21c9fddf8c3b1a6cbc59b273b4a0daf4b15aaf18f5e33e70c9277e6f00b8414adbeaaf82da005a33f00e7f74a3eeecb989698968b3694ea9e74018a0836184188eca727900280734ead256af02e72679addcddbf5ebd82c04c030c2bd85f4a01b841610b61422badd11afa2a617502f81c0c8aa1f11951d80893976a391026a3859c1f5e6c6d28e8b2ca8c4281c699b7b8ec30625801d4a6637291f9a8d1a2d8244f00b8417590e3d92063d4162f49493848ef0557daba3c2d82b9498eda09d5d08837296937a69e7b852579eeadf1c077d3b80d232ece03a12f4c45896e518cbb0771c52700b8415a2a40f416154793535cfe133040236ecc8b1f276df39e0a3713992fad06e38a42a455a636add93bff218544a4c53b852b8c4e461d3ae0663fdefe8fe7e327cc00b841e0c64cc8a30d84196d57639a42c5da941164b0700476d1b91d18f7c8f58d12f932ad1362270ec968294257f9c5cb60c40a7d4a5932a8f4d537be4db51f7dcf2500b841f61b6f014628ab751d79f095b1e739bc2b31fa8b6b847878e13b000a6dd53fa8467903119a72c7445f8490cf4932a42f4a418b89436b70d100c56c083399579500b841e6fe4f7c4bdcb4a81125bd282d0b9fedf1f51636c69bd4684d3131d685a7aed34face3d943d02b6ad632bb337f89fd6b0fb08e163ef84bb87fe556f4bafa0d3401b8412c6666136414f88327e07a6e8a2b04d105d6cf64daee239cea647a25f93ce0e6542f59f4363e3522bc838841e6db1940e569938b9458fb674fd543646a6b669b00b84134f967c4060d85a7c2f65d00695f3308d2ab78033e895775e0ab6f70cc6e71081c030bd997773191b3d2d7e5425e542c3b98fc127031784a858cf497c0e1532100b841d81aedf218d33e12087fb6c71b1d76e69dde542659c85661909b8c99793c7f1535afdc8addaefc5bcf6a3f99fd34518a1e9ab4a73ec9921e9865c1bd8543fd4c01b84199ec6f0fca02e48db37f0e4ae1b2fdf643abf610a9f1d7c0b490250aa7f1393d3069d1b4cec74ee99b0e18081bbf5e03d7b918d46499d579459cf0114ff76e9301b841d81a55eb96767edc5305dac78b904f70d2f44bd845fcd2bd581778669e5b8446220143680619986b9975ea528aacec0976406424588760f4fe086f16abaaaf4600",
"gasUsed": "0x1d065",
"governanceData": "0x",
"hash": "0x7d68d09a7a571cdf8a3b6a5ef6e037265b3e3093cf145b0954d22bde5c1d4f61",
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"number": "0x6e0431",
"parentHash": "0xa76ef625874a4d2126eb3fd1ebb5c1a8d0deb360a12b4f8edf30fb417d82b5a1",
"proposer": "0xe783fc94fddaeebef7293d6c5864cff280f121e1",
"receiptsRoot": "0x56734b337c3daab6766104bb51bd2ca408cf4537f5528ab3362536c57e65ba67",
"reward": "0x79f83dbb81f6f706be3e8491b14790c30d03e659",
"size": "0x947",
"stateRoot": "0xf685dce2cbef004cb041cf23959aea65e8aa86911fac55739ae1971f7d1dacd4",
"timestamp": "0x5d801768",
"timestampFoS": "0x4",
"totalBlockScore": "0x6e0432",
"transactions": [
{
"blockHash": "0x7d68d09a7a571cdf8a3b6a5ef6e037265b3e3093cf145b0954d22bde5c1d4f61",
"blockNumber": "0x6e0431",
"contractAddress": null,
"feePayer": "0x08260736c18bd8612bee2b21beedf4e97c0bc6b9",
"feePayerSignatures": [
{
"V": "0x4055",
"R": "0xd3fdd58e18e5a96d1f9af3d1aff31601d8e543a8085c78edfc8602db4c91b3c6",
"S": "0x19d937e315472a188f11a6bb87f47e66a30b44ba907b5f01fcd47dab8d99f3f0"
}
],
"from": "0x84b605b268e89ccdf591974db82deaa48bce59dc",
"gas": "0x419ce0",
"gasPrice": "0x5d21dba00",
"gasUsed": "0x1d065",
"input": "0x50716652000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000013416c50000000000000000000000000000000000000000000000000000000000001f3f000000000000000000000000000000000000000000000000000000003b9af23c",
"logs": [],
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"nonce": "0x8",
"senderTxHash": "0x5fe7485db56c0c2b0eb54dd46e584a413193ad66b40e69281f44dadfa7409b2e",
"signatures": [
{
"V": "0x4056",
"R": "0xca32239c38e1080f3a394504e2a0bb9811cda0a87d25b750cbbab265d581074d",
"S": "0x584ab136a483e755d9d458f9965ca0d514724c7b45f6123d19323f6fa7ccdb5f"
}
],
"status": "0x1",
"to": "0x1db1b93447328dd904152f798ead97987844f7b7",
"transactionHash": "0x020a2156bb4b29dc84f26887efae79e07a3d738b2856a66bbaab8aee18d507b5",
"transactionIndex": "0x0",
"type": "TxTypeFeeDelegatedSmartContractExecution",
"typeInt": 49,
"value": "0x0"
}
],
"transactionsRoot": "0x020a2156bb4b29dc84f26887efae79e07a3d738b2856a66bbaab8aee18d507b5",
"voteData": "0x"
}
}

klay_getCommittee

Returns a list of all validators in the committee at the specified block. If the parameter is not set, returns a list of all validators in the committee at the latest block.
Parameters
Name
Type
Description
QUANTITY | TAG
block number
(optional) Integer or hexadecimal block number, or the string "earliest" or "latest" as in the default block parameter.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Array - Array of addresses of all validators in the committee, or null when no committee was found:
Type
Description
Array of 20-byte DATA
Addresses of all validators in the committee.
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getCommittee", "params":["0x1b4"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":73,
"result":[
"0x207e38864b45a538733741dc1ff92eff9d1a6159",
"0x6d64bc82b93368a7f963d6c34483ca3893f405f6",
"0xbc9c19f91878369776812039e4ebcdfa3c646716",
"0xe3ed6fa287752b992f936b42360770c59731d9eb"
]
}

klay_getCommitteeSize

Returns the size of the committee at the specified block. If the parameter is not set, returns the size of the committee at the latest block.
Parameters
Name
Type
Description
QUANTITY | TAG
block number
(optional) Integer or hexadecimal block number, or the string "earliest" or "latest" as in the default block parameter.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Integer - The size of the committee, or -1 when no committee was found:
Type
Description
QUANTITY
The size of the council
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getCommitteeSize", "params":["0x1b4"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":73,
"result":4
}

klay_getCouncil

Returns a list of all validators of the council at the specified block. If the parameter is not set, returns a list of all validators of the council at the latest block.
NOTE: klay_getValidators is replaced with this method and is not supported anymore.
Parameters
Name
Type
Description
QUANTITY | TAG
block number
(optional) Integer or hexadecimal block number, or the string "earliest" or "latest" as in the default block parameter.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Array - Array of validator addresses of the council, or null when no council was found:
Type
Description
Array of 20-byte DATA
Addresses of all validators of the council.
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getCouncil", "params":["0x1b4"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":73,
"result":[
"0x207e38864b45a538733741dc1ff92eff9d1a6159",
"0x6d64bc82b93368a7f963d6c34483ca3893f405f6",
"0xbc9c19f91878369776812039e4ebcdfa3c646716",
"0xe3ed6fa287752b992f936b42360770c59731d9eb"
]
}

klay_getCouncilSize

Returns the size of the council at the specified block. If the parameter is not set, returns the size of the council at the latest block.
Parameters
Name
Type
Description
QUANTITY | TAG
block number
(optional) Integer or hexadecimal block number, or the string "earliest" or "latest" as in the default block parameter.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Integer - The size of the council, or -1 when no council was found:
Type
Description
QUANTITY
The size of the council
Example
// Request
curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method":"klay_getCouncilSize", "params":["0x1b4"],"id":73}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc":"2.0",
"id":73,
"result": 4
}

klay_getStorageAt

Returns the value from a storage position at a given address.
Parameters
Type
Description
20-byte DATA
Address of the storage.
QUANTITY
Integer of the position in the storage.
QUANTITY | TAG | HASH
Integer or hexadecimal block number, or the string "earliest", "latest" or "pending" as in the default block parameter, or block hash.
NOTE: In versions earlier than Klaytn v1.7.0, only integer block number, the string "earliest" and "latest" are available.
Return Value
Type
Description
DATA
The value at this storage position.
Example
Calculating the correct position depends on the storage to retrieve. Consider the following contract deployed at 0x295a70b2de5e3953354a6a8344e616ed314d7251 by address 0x391694e7e0b0cce554cb130d723a9d27458f9298.
contract Storage {
uint pos0;
mapping(address => uint) pos1;
function Storage() {
pos0 = 1234;
pos1[msg.sender] = 5678;
}
}
Retrieving the value of pos0 is straight forward:
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method": "klay_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}' https://api.baobab.klaytn.net:8651
{"jsonrpc":"2.0","id":1,"result":"0x00000000000000000000000000000000000000000000000000000000000004d2"}
Retrieving an element of the map is harder. The position of an element in the map is calculated with:
keccak(LeftPad32(key, 0), LeftPad32(map position, 0))
This means to retrieve the storage on pos1["0x391694e7e0b0cce554cb130d723a9d27458f9298"] we need to calculate the position with:
keccak(decodeHex("000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298" + "0000000000000000000000000000000000000000000000000000000000000001"))
The Klaytn console which comes with the klay library can be used to make the calculation
> var key = "000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298" + "0000000000000000000000000000000000000000000000000000000000000001"
undefined
> klay.sha3(key, {"encoding": "hex"})
"0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9"
Now to fetch the storage:
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0", "method": "klay_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9", "latest"], "id": 1}' https://api.baobab.klaytn.net:8651
{"jsonrpc":"2.0","id":1,"result":"0x000000000000000000000000000000000000000000000000000000000000162e"}

klay_syncing

Returns an object with data about the sync status or false.
Parameters
None
Return Value
Object|Boolean, an object with sync status data or false when not syncing:
Name
Type
Description
startingBlock
QUANTITY
The block at which the import started (will only be reset, after the sync reached his head).
currentBlock
QUANTITY
The current block, same as klay_blockNumber.
highestBlock
QUANTITY
The estimated highest block.
pulledStates
QUANTITY
The number of state entries processed until now. If the sync mode is not "fast", zero is returned.
knownStates
QUANTITY
The number of known state entries that still need to be pulled. If the sync mode is not "fast", zero is returned.
Example
// Request
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_syncing","params":[],"id":1}' https://api.baobab.klaytn.net:8651
// Result
{
"jsonrpc": "2.0",
"id":1,
"result": {
"currentBlock":"0x3e31e",
"highestBlock":"0x827eef",
"knownStates":"0x0",
"pulledStates":"0x0",
"startingBlock":"0x0"
}
}
// Or when not syncing
{
"jsonrpc": "2.0",
"id":1,
"result": false
}
Last modified 11d ago