Getting Started with Rootstock RPC API
The RPC API provides a seamless and intuitive web interface for developers to interact with Rootstock nodes via JSON-RPC methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain.
In this guide, you will learn:
- How to create an account and make your first API call
- View a list of JSON-RPC methods available.
Who is it for?
- DApp Developers looking to interact with the Rootstock nodes
Features
Easy Setup:
- Create an API key effortlessly to initiate development.
- Make the First API call in minutes.
API Key Authentication:
- Provides secure authentication for decentralized applications (dApps).
- Limits API requests on a daily or monthly basis.
Getting Started
Note: The RPC API is available on Testnet and Mainnet.
Visit the Rootstock RPC API
Get a FREE account
To create an account, click on Sign up
Get an API Key
To get an API key:
Log in to the dashboard, and click on New API key:
Choose a name to identify your apikey
, and the Network (either Testnet
or Mainnet
). You can also add a description (optional). Click on Create.
Make first API Call
Click on the newly created apikey
to get the details:
You can make your first api call by using one of the provided examples, or simply by adding a url and apikey
to your application.
Example Request
curl --location --request POST 'https://rpc.testnet.rootstock.io/<your-apikey>' \
--header 'Content-Type: application/json' \
--data ' {
"jsonrpc": "2.0",
"method": "eth_blockNumber",
"params": [],
"id": 0
}'
Response:
{"jsonrpc":"2.0","id":0,"result":"0x4b7eca"}
The daily limit is 25,000 requests per user, and each user can have up to 4 API keys, which allows an easy differentiation for different applications the user wants to test.
JSON RPC methods
Find below a list of JSON-RPC methods available on the RPC API.
- eth_accounts
- Method:
eth_accounts
- Returns a list of addresses owned by the client. Since Rootstock RPC API does not store keys, this will always return empty.
- Params: None
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_accounts", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": [] }
- Method:
- eth_blockNumber
- Method:
eth_blockNumber
- Returns the number of the most recent block.
- Params: None
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_blockNumber", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x4bdcfb" }
- Method:
- eth_call
- Executes a new message call immediately without creating a transaction on the blockchain.
- Params:
transaction
: object, the transaction call object which contains the following fields:- from: String, the address from which the transaction is sent
- to: String, required, the address to which the transaction is addressed
- gas: String, the integer of gas provided for the transaction execution
- gasPrice: String, the integer of the
gasPrice
used for each paid gas, encoded as a hexadecimal - value: String, the integer of value sent with this transaction encoded as hexadecimal
- data: string, the hash of the method signature and encoded parameters. For more information, see the Contract ABI description in the Solidity documentation
blockNumber
: String, required. The number of the block (in hex) from which the number of transactions is required, OR one of the following block tags:- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from a local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_call", "params":[{"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "gas": "0x76c0", "gasPrice": "0x9184e72a000", "value": "0x9184e72a", "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"}, "latest" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x" }
- eth_chainId
- Method:
eth_chainId
- Returns the number of the network, in hexadecimal value.
- Params: None
- Responses:
0x1f
-> Rootstock Testnet0x1e
-> Rootstock Mainnet
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_chainId", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x1f" }
- Method:
- eth_estimateGas
- Method:
- Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain.
- Params:
- transaction: object, the transaction call object which contains the following fields:
- from: String, the address from which the transaction is sent
- to: String, required, the address to which the transaction is addressed
- gas: String, the integer of gas provided for the transaction execution
gasPrice
: String, the integer of gasPrice used for each paid gas encoded as hexadecimalvalue
: String, the integer of value sent with this transaction encoded as hexadecimaldata
: string, the hash of the method signature and encoded parameters. For more information, see the Contract ABI description in the Solidity documentation
blockNumber
: String, optional. The number of the block (in hex) from which the number of transactions is required, OR one of the following block tags:- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- transaction: object, the transaction call object which contains the following fields:
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_estimateGas", "params":[{"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "gas": "0x76c0", "gasPrice": "0x9184e72a000", "value": "0x9184e72a", "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"}, "latest" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x5cec" }
- Method:
- eth_gasPrice
- Method:
eth_gasPrice
- Returns the current price per gas in wei (hexadecimal).
- Params: None
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_gasPrice", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x3e252e0" }
- Method:
- eth_getBalance
- Method:
eth_getBalance
- Returns the balance of the account of a given address (hexadecimal).
- Note: eth_getBalance only returns the balance of the native chain currency (RBTC) and does not include any ERC20 token balances for the given address.
- Params:
- Address: String, required - 20 Bytes (type: account)
- Block: String: optional, either the hexadecimal value of a blockNumber, OR a blockHash, OR one of the following block tags:
- Latest: the most recent block the client has available.
- Earliest: the lowest numbered block the client has available.
- Pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- if not specified, it will return the balance at the latest block available.
- Example request by
blockNumber
:curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBalance", "params":[ "0x1fab9a0e24ffc209b01faa5a61ad4366982d0b7f", "latest"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x2971b6b90ba793f" }
- Example request by
blockHash
:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBalance", "params":[ "0x1fab9a0e24ffc209b01faa5a61ad4366982d0b7f", "0x98e7878cc686d5ca61ca2339bda064004c82a6bbf7b6d43d7674897f775edc91" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x2971b6b90ba793f" }
- Example request by
blockTag
:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBalance", "params":[ "0x1fab9a0e24ffc209b01faa5a61ad4366982d0b7f", "latest" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x2971b6b90ba793f" }
- Method:
- eth_getBlockByHash
- Method:
eth_getBlockByHash
- Returns information about a block by
blockHash
.
- Returns information about a block by
- Params:
- Block: String: required, the hash of a block.
- Option: Boolean, optional.
- false: returns only the hashes of the transactions (default)
- true: returns the full transactions objects
- Returns:
- object: A block object, or null when no block was found. The returned object has the following properties:
- number: The block number of the requested block encoded as a hexadecimal string. null if pending.
- hash: The block hash of the requested block. null if pending.
- parentHash: Hash of the parent block.
- sha3Uncles: SHA3 of the uncles data in the block.
- logsBloom: The bloom filter for the logs of the block. null if pending.
- transactionsRoot: The root of the transaction trie of the block.
- stateRoot: The root of the final state trie of the block.
- receiptsRoot: The root of the receipts trie of the block.
- miner: The address of the beneficiary to whom the mining rewards were given.
- difficulty: Integer of the difficulty for this block encoded as a hexadecimal string.
- totalDifficulty: Integer of the total difficulty of the chain until this block encoded as a hexadecimal string.
- extraData: The “extra data” field of this block.
- size: The size of this block in bytes as an Integer value encoded as hexadecimal.
- gasLimit: The maximum gas allowed in this block encoded as a hexadecimal string.
- gasUsed: The total used gas by all transactions in this block encoded as a hexadecimal string.
- timestamp: The unix timestamp for when the block was collated.
- transactions: Array of transaction objects - please see eth_getTransactionByHash for exact shape.
- uncles: Array of uncle hashes.
- minimumGasPrice: Minimum gas price a transaction should have in order to be included in that block.
- bitcoinMergedMiningHeader: It is the Bitcoin block header of the block that was used for merged mining the RSK block.
- bitcoinMergedMiningCoinbaseTransaction: It is the coinbase transaction of the Bitcoin block that was used for merged mining the RSK block.
- bitcoinMergedMiningMerkleProof: It is the Merkle proof that links the Bitcoin block's Merkle root with the coinbase transaction.
- hashForMergedMining: It is a hash that is calculated from various fields in the RSK block header.
- paidFees: It represents the total amount of fees paid by all transactions included in the block.
- cumulativeDifficulty: It represents the total difficulty of the chain up to the current block.
- object: A block object, or null when no block was found. The returned object has the following properties:
- Example Request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBlockByHash", "params":[ "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f", false], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": { "number": "0xfcea", "hash": "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f", "parentHash": "0xb004f5597ac7eedb515079d33e5b805818fab26c269aa6094fbfea4d99845405", "sha3Uncles": "0xff84b3163df46a90bc9414e86bfb70ddb15ecb67834eb87528f8a8abbddc23e0", "logsBloom": "0x00000008000000800000000000000000000000000000000000000000000008000000000000040000000000000000000050000000000000000000000000000000000000000000000000000000005000000010008000000000100000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000200000000000200000000000001040000000000000400000000000000000000100000000000000010000000000000000000001000000000000001000001000000000000000000000000000020000000000080200000100000000000000000000000000000000000000000080000000000000000000000000000", "transactionsRoot": "0x3db27be7411aed7534c14990298234782ad91e2b7964be25bb081fc014d49583", "stateRoot": "0x1e07d7d8c5e82f40ef338816c777f5f67a445f904dbcf785647dde1bc24512ea", "receiptsRoot": "0x11422b4b5228ed3bed9eae08bb64bbad7230e9b85ef4f74b75964d17dcdecc66", "miner": "0x1fab9a0e24ffc209b01faa5a61ad4366982d0b7f", "difficulty": "0x24aa8907", "totalDifficulty": "0x4b96af092bb7", "extraData": "0x", "size": "0x7a5", "gasLimit": "0x67c280", "gasUsed": "0x0", "timestamp": "0x5d404bf0", "transactions": [ "0xd63e3b6e1dd408800df812d2ab758316ac21cde155c401ae63ff9d2fff7e7710" ], "uncles": [ "0xa5c66b4cd18b4d4c355528d8b3fc4f1724fea9f56ac11c4649515c4aea55bb70" ], "minimumGasPrice": "0x0", "bitcoinMergedMiningHeader": "0x00000020ec6f391bfb4fbad152de916fcf40868295b82d96533ce2329501000000000000fc38d5be8687dc934c89b3ae2a6ad3e8f77efdad192b9ceef737399fcffb1ff30c4c405df421031a441284ce", "bitcoinMergedMiningCoinbaseTransaction": "0x0000000000000080e53dea0fdaf87e68c8b878bb8741ae72dc2d529c9604fb603d9fade1340ad3f66088ac0000000000000000266a24aa21a9ed55c19836d4dbd18acc186dae6ff453d46444df4a4ee48b6850179b871755b90d00000000000000002a6a52534b424c4f434b3a9b846df8ecbe1e7b98351144b1672c25f54207e3998ef7d8c8492a320000fcea00000000", "bitcoinMergedMiningMerkleProof": "0x2e925b7315afc6cf5a938435ad424fa9c71c61b1c668104e34dfd30107915b7d60293a2d23038560421361d1bf29901efe8d30228d04f593c1cc991c4a5d373094588d9356998b9736912df45fb8c02c2c1228c415a5ed15b2e0dd9e14c501c40d6c398a3c6d0796b08b2d7c8e06a986e3cfc3b58b1a15073a8ef8d0ecad33d5b5d9b4d4da261ac1629892cec44816ebdc64e1d92756b554f525ff933fdfd016cab57a26339ba10486f4af5f3fdf8bf11651d5c345abb4f797c30d75252e8bf5e90e9da3aa73428dc01b7c165760eff60d0742ea243f907a7156c897a8fa29ce357a909b4933c4ea9f1744e21422550bde9e0c51064f160e7ba0b19646ca7d6d", "hashForMergedMining": "0x9b846df8ecbe1e7b98351144b1672c25f54207e3998ef7d8c8492a320000fcea", "paidFees": "0x0", "cumulativeDifficulty": "0x47e89477" } }
- Method:
- eth_getBlockByNumber
- Method:
eth_getBlockByNumber
- Returns information about a block by blockNumber.
- Params:
- Block: String: required, either the hexadecimal value of a blockNumber, OR one of the following block tags:
- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from a local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- Option: Boolean, optional.
- false: returns only the hashes of the transactions (default)
- true: returns the full transactions object
- Block: String: required, either the hexadecimal value of a blockNumber, OR one of the following block tags:
- Returns:
- object - A block object, or null when no block was found. The returned object has the following properties:
- number - The block number of the requested block encoded as a hexadecimal string. null if pending.
- hash - The block hash of the requested block. null if pending.
- parentHash - Hash of the parent block.
- sha3Uncles - SHA3 of the uncles data in the block.
- logsBloom - The bloom filter for the logs of the block. null if pending.
- transactionsRoot - The root of the transaction trie of the block.
- stateRoot - The root of the final state trie of the block.
- receiptsRoot - The root of the receipts trie of the block.
- miner - The address of the beneficiary to whom the mining rewards were given.
- difficulty - Integer of the difficulty for this block encoded as a hexadecimal string.
- totalDifficulty - Integer of the total difficulty of the chain until this block encoded as a hexadecimal string.
- extraData - The “extra data” field of this block.
- size - The size of this block in bytes as an Integer value encoded as hexadecimal.
- gasLimit - The maximum gas allowed in this block encoded as a hexadecimal string.
- gasUsed - The total used gas by all transactions in this block encoded as a hexadecimal string.
- timestamp - The unix timestamp for when the block was collated.
- transactions - Array of transaction objects - please see eth_getTransactionByHash for exact shape.
- uncles - Array of uncle hashes.
- minimumGasPrice: minimum gas price a transaction should have in order to be included in that block.
- bitcoinMergedMiningHeader: It is the Bitcoin block header of the block that was used for merged mining the RSK block.
- bitcoinMergedMiningCoinbaseTransaction: It is the coinbase transaction of the Bitcoin block that was used for merged mining the RSK block.
- bitcoinMergedMiningMerkleProof: It is the Merkle proof that links the Bitcoin block's Merkle root with the coinbase transaction.
- hashForMergedMining: It is a hash that is calculated from various fields in the RSK block header.
- paidFees: It represents the total amount of fees paid by all transactions included in the block.
- cumulativeDifficulty: It represents the total difficulty of the chain up to the current block.
- Example Request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBlockByNumber", "params":[ "0xfcea", false ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": { "number": "0xfcea", "hash": "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f", "parentHash": "0xb004f5597ac7eedb515079d33e5b805818fab26c269aa6094fbfea4d99845405", "sha3Uncles": "0xff84b3163df46a90bc9414e86bfb70ddb15ecb67834eb87528f8a8abbddc23e0", "logsBloom": "0x00000008000000800000000000000000000000000000000000000000000008000000000000040000000000000000000050000000000000000000000000000000000000000000000000000000005000000010008000000000100000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000200000000000200000000000001040000000000000400000000000000000000100000000000000010000000000000000000001000000000000001000001000000000000000000000000000020000000000080200000100000000000000000000000000000000000000000080000000000000000000000000000", "transactionsRoot": "0x3db27be7411aed7534c14990298234782ad91e2b7964be25bb081fc014d49583", "stateRoot": "0x1e07d7d8c5e82f40ef338816c777f5f67a445f904dbcf785647dde1bc24512ea", "receiptsRoot": "0x11422b4b5228ed3bed9eae08bb64bbad7230e9b85ef4f74b75964d17dcdecc66", "miner": "0x1fab9a0e24ffc209b01faa5a61ad4366982d0b7f", "difficulty": "0x24aa8907", "totalDifficulty": "0x4b96af092bb7", "extraData": "0x", "size": "0x7a5", "gasLimit": "0x67c280", "gasUsed": "0x0", "timestamp": "0x5d404bf0", "transactions": [ "0xd63e3b6e1dd408800df812d2ab758316ac21cde155c401ae63ff9d2fff7e7710" ], "uncles": [ "0xa5c66b4cd18b4d4c355528d8b3fc4f1724fea9f56ac11c4649515c4aea55bb70" ], "minimumGasPrice": "0x0", "bitcoinMergedMiningHeader": "0x00000020ec6f391bfb4fbad152de916fcf40868295b82d96533ce2329501000000000000fc38d5be8687dc934c89b3ae2a6ad3e8f77efdad192b9ceef737399fcffb1ff30c4c405df421031a441284ce", "bitcoinMergedMiningCoinbaseTransaction": "0x0000000000000080e53dea0fdaf87e68c8b878bb8741ae72dc2d529c9604fb603d9fade1340ad3f66088ac0000000000000000266a24aa21a9ed55c19836d4dbd18acc186dae6ff453d46444df4a4ee48b6850179b871755b90d00000000000000002a6a52534b424c4f434b3a9b846df8ecbe1e7b98351144b1672c25f54207e3998ef7d8c8492a320000fcea00000000", "bitcoinMergedMiningMerkleProof": "0x2e925b7315afc6cf5a938435ad424fa9c71c61b1c668104e34dfd30107915b7d60293a2d23038560421361d1bf29901efe8d30228d04f593c1cc991c4a5d373094588d9356998b9736912df45fb8c02c2c1228c415a5ed15b2e0dd9e14c501c40d6c398a3c6d0796b08b2d7c8e06a986e3cfc3b58b1a15073a8ef8d0ecad33d5b5d9b4d4da261ac1629892cec44816ebdc64e1d92756b554f525ff933fdfd016cab57a26339ba10486f4af5f3fdf8bf11651d5c345abb4f797c30d75252e8bf5e90e9da3aa73428dc01b7c165760eff60d0742ea243f907a7156c897a8fa29ce357a909b4933c4ea9f1744e21422550bde9e0c51064f160e7ba0b19646ca7d6d", "hashForMergedMining": "0x9b846df8ecbe1e7b98351144b1672c25f54207e3998ef7d8c8492a320000fcea", "paidFees": "0x0", "cumulativeDifficulty": "0x47e89477" } }
- Method:
- eth_getCode
- Method: Returns the compiled byte code of a smart contract, if any, at a given address.
- Params:
- Address: String: required, address
- Block: String, required, either the hexadecimal value of a blockNumber, OR a blockHash, OR one of the following block tags:
- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from a local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- Example Request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getCode", "params":[ "0xebea27d994371cd0cb9896ae4c926bc5221f6317", "latest" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x608060405260043610610...." }
- eth_getLogs
- Method:
eth_getLogs
- Returns an array of all the logs matching the given filter object.
- Params:
blockHash
: String, optional. Using blockHash is:- is equivalent to fromBlock = toBlock = the block number with hash blockHash
- if blockHash is present in the filter criteria, then neither
fromBlock
nortoBlock
are allowed.
address
: String, optional. Contract address from which logs should originate.fromBlock
: String, optional.- either the hexadecimal value of a blockNumber, OR one of the following block tags:
- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- either the hexadecimal value of a blockNumber, OR one of the following block tags:
toBlock
: String, optional.- either the hexadecimal value of a blockNumber, OR one of the following block tags:
- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- either the hexadecimal value of a blockNumber, OR one of the following block tags:
- topics: Array of 32 bytes DATA topics, optional. The required topic to filter.
- Returns:
- log objects: An array of log objects, or an empty array if nothing has changed since last poll. Log objects contain the following keys and their values:
- logIndex: Hexadecimal of the log index position in the block. Null when it is a pending log.
- transactionIndex: Hexadecimal of the transactions index position from which the log created. Null when it is a pending log.
- transactionHash: 32 bytes. Hash of the transactions from which this log was created. Null when it is a pending log.
- blockHash: 32 bytes. Hash of the block where this log was in. Null when it is a pending log.
- blockNumber: Block number where this log was in. Null when it is a pending log.
- address: 20 bytes. Address from which this log originated.
- data: Contains one or more 32-bytes non-indexed arguments of the log.
- topics: An array of 0 to 4 indexed log arguments, each 32 bytes. In solidity the first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except when you declared the event with the anonymous specifier.
- log objects: An array of log objects, or an empty array if nothing has changed since last poll. Log objects contain the following keys and their values:
- Constraints:
- You can make
eth_getLogs
requests on any block range with a cap of:- 10K logs in the response
- OR a 2K block range with no cap on logs in the response
- Note that it can be filtered either by blockHash OR (fromBlock and toBlock), but not both.
- If
fromBlock
,toBlock
, orblockHash
are not specified, the query will return the logs corresponding to the latest block
- You can make
- Example request by blockHash:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getLogs", "params":[ {"blockHash": "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f"}], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": [ { { "address": "0x0000000000000000000000000000000001000008", "blockHash": "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f", "blockNumber": "0xfcea", "data": "0xe6a06c82436df2ac379ed378269415c15ffda97df39ccabf71b0a9639475dd51e0778423488365", "logIndex": "0x1", "topics": [ "0x000000000000000000000000000000006d696e696e675f6665655f746f706963", "0x0000000000000000000000004495768e683423a4299d6a7f02a0689a6ff5a0a4" ], "transactionHash": "0xd63e3b6e1dd408800df812d2ab758316ac21cde155c401ae63ff9d2fff7e7710", "transactionIndex": "0x0" }, {...} }] }
- Example request by blockHash and address:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getLogs", "params":[{"blockHash": "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f", "address": "0x7f62ed5ffed1ddf15fb44632fae33f33712e31b5"}], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": [ { "address": "0x7f62ed5ffed1ddf15fb44632fae33f33712e31b5", "blockHash": "0x98e7878cc686d5ca61ca2339bda064004c82a6bbf7b6d43d7674897f775edc91", "blockNumber": "0xf904", "data": "0x0000000000000000000000000000000000000000000001ffe49e9e1d03940000", "logIndex": "0x1", "topics": [ "0x296ba4ca62c6c21c95e828080cb8aec7481b71390585605300a8a76f9e95b527" ], "transactionHash": "0xb6f35548247f43a6a5c20923fe6b7bfc57242e3c3b2b39354c6d0d131527140c", "transactionIndex": "0x0" } ] }
- Example request by fromBlock, toBlock:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getLogs", "params":[ { "fromBlock": "0xfcea", "toBlock": "0xfcea" } ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": [ { "address": "0x0000000000000000000000000000000001000008", "blockHash": "0xcca8612942582f1a890231a25245174d6947b7e2e990adf74e84c035c52b104f", "blockNumber": "0xfcea", "data": "0xe6a06c82436df2ac379ed378269415c15ffda97df39ccabf71b0a9639475dd51e0778423488365", "logIndex": "0x1", "topics": [ "0x000000000000000000000000000000006d696e696e675f6665655f746f706963", "0x0000000000000000000000004495768e683423a4299d6a7f02a0689a6ff5a0a4" ], "transactionHash": "0xd63e3b6e1dd408800df812d2ab758316ac21cde155c401ae63ff9d2fff7e7710", "transactionIndex": "0x0" }, {...} ] }
- Method:
- eth_getStorageAt
- Method:
eth_getStorageAt
- Returns the value from a storage position at a given address.
- Params:
- Address: String, required - A string representing the address (20 bytes) of the storage.
- Position: String, required - A hexadecimal code of the position in the storage.
- Block: String: required, either the hexadecimal value of a blockNumber, OR a blockHash, OR one of the following block tags:
- Latest: the most recent block the client has available.
- Earliest: the lowest numbered block the client has available.
- Pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from a local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- Example request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getStorageAt", "params":[ "0x295a70b2de5e3953354a6a8344e616ed314d7251","0x0" "latest"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x0000000000000000000000000000000000000000000000000000000000000000" }
- Method:
- eth_getTransactionByHash
- Method:
eth_getTransactionByHash
- Returns the information about a transaction requested by transaction hash. In the response object,
blockHash
,blockNumber
, andtransactionIndex
are null when the transaction is pending.
- Returns the information about a transaction requested by transaction hash. In the response object,
- Params:
transactionHash
: String, required - A string representing the hash (32 bytes) of a transaction.
- Returns:
- A transaction object, or null when no transaction was found. The transaction object will consist of the following keys and their values: -
blockHash
: 32 bytes. A hash of the block including this transaction. null when it's pending.blockNumber
: The number of the block including this transaction. null when it's pending.from
: 20 bytes. The address of the sender.to
: 20 bytes. The address of the receiver. null when it's a contract creation transaction.gas
: Gas provided by the sender.gasPrice
: Gas price provided by the sender in Wei.hash
: 32 bytes. The hash of the transaction.input
: The data sent along with the transaction.nonce
: The number of transactions made by the sender prior to this one.v
: The ECDSA recovery ID.r
: 32 bytes. The ECDSA signature r.s
: 32 bytes. The ECDSA signature s.transactionIndex
: The transaction's index position in the block, in hexadecimal. null when it's pending.type
: The transaction type.value
: The value transferred in Wei.
- A transaction object, or null when no transaction was found. The transaction object will consist of the following keys and their values: -
- Example Request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getTransactionByHash", "params":["0x359f6010957a25b885387e3201c9262c71f91e47ff487c49e5168a54fc8ea110"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": [ { "hash": "0x359f6010957a25b885387e3201c9262c71f91e47ff487c49e5168a54fc8ea110", "nonce": "0x10", "blockHash": "0xf0b093db64e06ff6b94cd3cfc06d85d3664d7b021bef36c4471475b4f1d8b2b9", "blockNumber": "0x35aa", "transactionIndex": "0x0", "from": "0x3843d583b0f087ec7e3476c3495e52dbde5280b3", "to": "0x052ef40ccda2d51ca3d49cc3d6007b25965bec5b", "gas": "0x20cfb", "gasPrice": "0x387ee40", "value": "0x0", "input": "0xcc6ebc8b00000000000000000000000000", "v": "0x62", "r": "0x1f8bb5859d8194eebfb781ed6d12de95d44b66ecf", "s": "0x4a98b84d16a534681c5a639318b1ceffe967ce751458f51", "type": "0x0" } ] }
- Method:
- eth_getTransactionCount
- Method:
eth_getTransactionCount
- Returns the number of transactions sent from an address.
- Params:
- Address: String, required - 20 Bytes
- Block: String: optional, either the hexadecimal value of a
blockNumber
, OR ablockHash
, OR one of the following block tags:latest
: the most recent block the client has available.earliest
: the lowest numbered block the client has available.pending
: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.- if not specified, it will return the balance at the latest block available.
- Returns:
- transaction count: A hexadecimal equivalent of the integer representing the number of transactions sent from the given address.
- Example Request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getTransactionCount", "params":["0x4495768e683423a4299d6a7f02a0689a6ff5a0a4", "latest"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x9856" }
- Method:
- eth_getTransactionReceipt
- Method:
eth_getTransactionReceipt
- Returns the receipt of a transaction given transaction hash. Note that the receipt is not available for pending transactions.
- Params:
transactionHash
: String, required. A string representing the hash (32 bytes) of a transaction.
- Returns:
- A transaction receipt object, or null when no receipt was found. The transaction receipt object will contain the following keys and their values:
blockHash
: 32 bytes. Hash of the block including this transaction.blockNumber
: Block number including this transaction.contractAddress
: 20 bytes. The contract address created if the transaction was a contract creation, otherwise null.cumulativeGasUsed
: The total amount of gas used when this transaction was executed in the block.effectiveGasPrice
: The actual value per gas deducted from the sender's account. Before EIP-1559, equal to the gas price.from
: 20 bytes. The address of the sender.gasUsed
: The amount of gas used by this specific transaction alone.logs
: (Array) An array of log objects generated by this transaction.logsBloom
: 256 bytes. Bloom filter for light clients to quickly retrieve related logs.- One of the following:
root
: 32 bytes of post-transaction stateroot (pre-Byzantium)status
: Either 1 (success) or 0 (failure)
to
: 20 bytes. The address of the receiver. null when the transaction is a contract creation transaction.transactionHash
: 32 bytes. The hash of the transaction.transactionIndex
: Hexadecimal of the transaction's index position in the block.type
: the transaction type.
- A transaction receipt object, or null when no receipt was found. The transaction receipt object will contain the following keys and their values:
- Example Request:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getTransactionReceipt", "params":[ "0x359f6010957a25b885387e3201c9262c71f91e47ff487c49e5168a54fc8ea110" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": { "transactionHash": "0x359f6010957a25b885387e3201c9262c71f91e47ff487c49e5168a54fc8ea110", "transactionIndex": "0x0", "blockHash": "0xf0b093db64e06ff6b94cd3cfc06d85d3664d7b021bef36c4471475b4f1d8b2b9", "blockNumber": "0x35aa", "cumulativeGasUsed": "0x15efc", "gasUsed": "0x15efc", "contractAddress": null, "logs": [], "from": "0x3843d583b0f087ec7e3476c3495e52dbde5280b3", "to": "0x052ef40ccda2d51ca3d49cc3d6007b25965bec5b", "status": "0x1", "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "type": "0x0" } }
- Method:
- eth_getBlockTransactionCountByHash
- Method:
eth_getBlockTransactionCountByHash
- Returns the number of transactions for the block matching the given block hash (in hex).
- Params:
blockHash
: String, required. The hash of the block from which the number of transactions is required.
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBlockTransactionCountByHash", "params":[" 0xf0b093db64e06ff6b94cd3cfc06d85d3664d7b021bef36c4471475b4f1d8b2b9"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x2" }
- Method:
- eth_getBlockTransactionCountByNumber
- Method:
eth_getBlockTransactionCountByNumber
- Returns the number of transactions for the block matching the given block number (in hex).
- Params:
blockNumber
: String, required. The number of the block (in hex) from which the number of transactions is required, OR one of the following block tags:- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- Example
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getBlockTransactionCountByNumber", "params":["0xfcea"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x1" }
- Method:
- eth_getTransactionByBlockHashAndIndex
- Method:
eth_getTransactionByBlockHashAndIndex
- Returns information about a transaction for a specific block and transaction index position.
- Params:
- blockHash: String, required. The hash of the block in which the transaction is recorded.
- index: String, required. The position number of the transaction (in Hex).
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getTransactionByBlockHashAndIndex", "params":[ "0x1e3566b5fe1109d0054e43cf169f9aa4484aba61fc83fe6799d2271bab725d36", "0x0" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": { "_id": "6528a2bdc44af7001f969f62", "hash": "0x7188161bc67e8c19031bfa1732a8e74f32921b45fa3762e5451122459c5fe135", "nonce": "0x37a", "blockHash": "0x1e3566b5fe1109d0054e43cf169f9aa4484aba61fc83fe6799d2271bab725d36", "blockNumber": "0x35c7", "transactionIndex": "0x0", "from": "0x9a3bfdea2245738dd5f25453d13742350a4f1c6e", "to": "0x0000000000000000000000000000000001000006", "gas": "0x0", "gasPrice": "0x0", "value": "0x0", "input": "0xe5400e7b00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000500000ff3feef74a17227d680e1bc4117b4207f8b101f132f5da9c9abf8699d590000000006708c984514a47f5d4781d31ce2761392b41254374f636ab3bf3f838f40f28cccf27265d531d041a40bd27d900000000000000000000000000000000", "v": "0x61", "r": "0xfdb6ea619ca1fbb42e8f8976209ec0f617b7068e7e89cceae2dc33492eab92af", "s": "0x8b2a4279058793069d74b9e1d5e71747120ba90bbfa99d99215a55c5020b47", "type": "0x0" } }
- Method:
- eth_getTransactionByBlockNumberAndIndex
- Method:
eth_getTransactionByBlockNumberAndIndex
- Returns information about a transaction for a specific block and transaction index position.
- Params:
blockNumber
: String, required. The number of the block (in hex) from which the number of transactions is required, OR one of the following block tags:- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- index: String, required. The position number of the transaction (in Hex).
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getTransactionByBlockNumberAndIndex", "params":[ "0x35c7", "0x0" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": { "_id": "6528a2bdc44af7001f969f62", "hash": "0x7188161bc67e8c19031bfa1732a8e74f32921b45fa3762e5451122459c5fe135", "nonce": "0x37a", "blockHash": "0x1e3566b5fe1109d0054e43cf169f9aa4484aba61fc83fe6799d2271bab725d36", "blockNumber": "0x35c7", "transactionIndex": "0x0", "from": "0x9a3bfdea2245738dd5f25453d13742350a4f1c6e", "to": "0x0000000000000000000000000000000001000006", "gas": "0x0", "gasPrice": "0x0", "value": "0x0", "input": "0xe5400e7b00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000500000ff3feef74a17227d680e1bc4117b4207f8b101f132f5da9c9abf8699d590000000006708c984514a47f5d4781d31ce2761392b41254374f636ab3bf3f838f40f28cccf27265d531d041a40bd27d900000000000000000000000000000000", "v": "0x61", "r": "0xfdb6ea619ca1fbb42e8f8976209ec0f617b7068e7e89cceae2dc33492eab92af", "s": "0x8b2a4279058793069d74b9e1d5e71747120ba90bbfa99d99215a55c5020b47", "type": "0x0" } }
- Method:
- eth_getUncleCountByBlockHash
- Method:
eth_getUncleCountByBlockHash
- Returns the number of uncles for the block matching the given block hash (in hex).
- Params:
blockHash
: String, required. The hash of the block from which the number of uncles is required.
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getUncleCountByBlockHash", "params":[ "0xf0b093db64e06ff6b94cd3cfc06d85d3664d7b021bef36c4471475b4f1d8b2b9" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x3" }
- Method:
- eth_getUncleCountByBlockNumber
- Method:
eth_getUncleCountByBlockNumber
- Returns the number of uncles for the block matching the given block number (in hex).
- Params:
blockNumber
: String, required. The number of the block (in hex) from which the number of transactions is required, OR one of the following block tags:- latest: the most recent block the client has available.
- earliest: the lowest numbered block the client has available.
- pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet.
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_getUncleCountByBlockNumber", "params":[ "0x35aa" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x3" }
- Method:
- eth_protocolVersion
- Method:
eth_protocolVersion
- Returns the current protocol version.
- Params: None
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_protocolVersion", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x3e" }
- Method:
- eth_sendRawTransaction
- Method:
eth_sendRawTransaction
- Creates a new message call transaction or a contract creation for signed transactions.
- Response: The transaction hash, or the zero hash if the transaction is not yet available.
- Params:
transactionData
: Required, the signed transaction data (typically signed with a library, using your private key). Useeth_getTransactionReceipt
to get the contract address, after the transaction was mined, when you created a contract.
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"eth_estimateGas", "params":[ "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675" ], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x359f6010957a25b885387e3201c9262c71f91e47ff487c49e5168a54fc8ea110" }
- Method:
- net_version
- Method:
net_version
- Returns the number of the network, in decimal value.
- Params: None
- Responses:
31
-> Rootstock Testnet30
-> Rootstock Mainnet
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"net_version", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "31" }
- Method:
- web3_clientVersion
- Method:
web3_clientVersion
- Returns the current client version.
- Params: None
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"web3_clientVersion", "params":[], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "RskJ/6.2.0/Linux/Java1.8/ARROWHEAD-45eb751" }
- Method:
- web3_sha3
- Method:
web3_sha3
- Returns Keccak-256 (not the standardized SHA3-256) hash of the given data.
- Params:
data
: Required, string: The data in hexadecimal form to convert into a SHA3 hash
- Example:
curl --location 'https://rpc.testnet.rootstock.io/<api-key>' \ --request POST \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"web3_sha3", "params":["0x68656c6c6f20776f726c64"], "id":0 }'
- Example Response:
{ "jsonrpc": "2.0", "id": 0, "result": "0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad" }
- Method:
Get Support
Join the Rootstock Discord to get support or give feedback.