Supported JSON-RPC Methods
Here are the supported JSON-RPC Methods.
For a full description, see the JSON RPC Method details.
Module | Method | Supported | Comments |
---|---|---|---|
web3 | web3_clientVersion | YES | |
web3 | web3_sha3 | YES | |
eth | net_version | YES | Mainnet Chain Id = 30 , Testnet Chain Id = 31 |
eth | net_peerCount | YES | |
eth | net_peerList | YES | |
eth | net_listening | YES | |
eth | eth_chainId | YES | Same response as eth_protocolVersion |
eth | eth_protocolVersion | YES | |
eth | eth_syncing | YES | |
eth | eth_coinbase | YES | |
eth | eth_mining | YES | |
eth | eth_hashrate | YES | |
eth | eth_gasPrice | YES | |
eth | eth_accounts | YES | |
eth | eth_blockNumber | YES | |
eth | eth_getBalance | YES | |
eth | eth_getStorageAt | YES | |
eth | eth_getTransactionCount | YES | |
eth | eth_getBlockTransactionCountByHash | YES | |
eth | eth_getBlockTransactionCountByNumber | YES | |
eth | eth_getUncleCountByBlockHash | YES | |
eth | eth_getUncleCountByBlockNumber | PARTIALLY | Option "pending" not yet supported. |
eth | eth_getCode | PARTIALLY | Option "pending" not yet supported. |
eth | eth_sign | YES | |
eth | eth_sendTransaction | YES | |
eth | eth_sendRawTransaction | YES | |
eth | eth_call | YES | |
eth | eth_estimateGas | YES | |
eth | eth_getBlockByHash | YES | |
eth | eth_getBlockByNumber | PARTIALLY | Option "pending" not yet supported. |
eth | eth_getTransactionByHash | YES | |
eth | eth_getTransactionByBlockHashAndIndex | YES | |
eth | eth_getTransactionByBlockNumberAndIndex | PARTIALLY | Option "pending" not yet supported. |
eth | eth_getTransactionReceipt | YES | |
eth | eth_pendingTransactions | YES | |
eth | eth_getUncleByBlockHashAndIndex | YES | |
eth | eth_getUncleByBlockNumberAndIndex | PARTIALLY | Option "pending" not yet supported. |
eth | eth_getCompilers | - | For security reasons, we've decided not to include compilers in node. |
eth | eth_compileLLL | - | For security reasons, we've decided not to include compilers in node. |
eth | eth_compileSolidity | - | For security reasons, we've decided not to include compilers in node. |
eth | eth_compileSerpent | - | For security reasons, we've decided not to include compilers in node. |
eth | eth_newFilter | YES | |
eth | eth_newBlockFilter | YES | |
eth | eth_newPendingTransactionFilter | YES | |
eth | eth_uninstallFilter | YES | |
eth | eth_getFilterChanges | YES | |
eth | eth_getFilterLogs | YES | |
eth | eth_getLogs | YES | |
eth | eth_bridgeState | YES | |
eth | eth_netHashrate | YES | |
db | db_putString | - | Deprecated |
db | db_getString | - | Deprecated |
db | db_putHex | - | Deprecated |
db | db_getHex | - | Deprecated |
debug | debug_traceTransaction | YES | |
debug | debug_traceBlockByHash | YES | |
debug | debug_wireProtocolQueueSize | YES | |
evm | evm_increaseTime | YES | |
evm | evm_mine | YES | |
evm | evm_reset | YES | |
evm | evm_revert | YES | |
evm | evm_snapshot | YES | |
evm | evm_startMining | YES | |
evm | evm_stopMining | YES | |
mnr | mnr_submitBitcoinBlock | YES | |
mnr | mnr_submitBitcoinBlockTransactions | YES | |
mnr | mnr_submitBitcoinBlockPartialMerkle | YES | |
mnr | mnr_getWork | YES | |
personal | personal_dumpRawKey | YES | |
personal | personal_importRawKey | YES | |
personal | personal_listAccounts | YES | |
personal | personal_lockAccount | YES | |
personal | personal_newAccountWithSeed | YES | |
personal | personal_newAccount | YES | |
personal | personal_sendTransaction | YES | |
personal | personal_unlockAccount | YES | |
rsk | rsk_getRawTransactionReceiptByHash | YES | |
rsk | rsk_getTransactionReceiptNodesByHash | YES | |
rsk | rsk_getRawBlockHeaderByHash | YES | |
rsk | rsk_getRawBlockHeaderByNumber | YES | |
rsk | rsk_protocolVersion | YES | |
trace | trace_transaction | YES | |
trace | trace_block | YES | |
trace | trace_filter | YES | |
txpool | txpool_content | YES | |
txpool | txpool_inspect | YES | |
txpool | txpool_status | YES | |
sco | sco_banAddress | YES | |
sco | sco_unbanAddress | YES | |
sco | sco_peerList | YES | |
sco | sco_bannedAddresses | YES | |
sco | sco_reputationSummary | YES | |
shh | shh_post | - | Whisper protocol not supported. |
shh | shh_version | - | Whisper protocol not supported. |
shh | shh_newIdentity | - | Whisper protocol not supported. |
shh | shh_hasIdentity | - | Whisper protocol not supported. |
shh | shh_newGroup | - | Whisper protocol not supported. |
shh | shh_addToGroup | - | Whisper protocol not supported. |
shh | shh_newFilter | - | Whisper protocol not supported. |
shh | shh_uninstallFilter | - | Whisper protocol not supported. |
shh | shh_getFilterChanges | - | Whisper protocol not supported. |
shh | shh_getMessages | - | Whisper protocol not supported. |
JSON RPC method details​
These descriptions are taken from Ethereum's JSON RPC documentation.
web3_clientVersion​
Returns the current client version.
Parameters​
none
Returns​
String
- The current client version.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"web3_clientVersion","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc":"2.0",
"result": "Mist/v0.9.3/darwin/go1.4.1"
}
web3_sha3​
Returns Keccak-256 (not the standardized SHA3-256) of the given data.
Parameters​
DATA
- the data to convert into a SHA3 hash.
Example Parameters​
params: ["0x68656c6c6f20776f726c64"];
Returns​
DATA
- The SHA3 result of the given string.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"web3_sha3","params":["0x68656c6c6f20776f726c64"],"id":64}'
// Result
{
"id":64,
"jsonrpc": "2.0",
"result": "0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad"
}
net_version​
Returns the current network id.
Parameters​
none
Returns​
String
- The current network id.
"30"
: RSK Mainnet"31"
: Ethercamp test network"32"
: Developer network"33"
: RSK created local network
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_version","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc": "2.0",
"result": "3"
}
net_listening​
Returns true
if client is actively listening for network connections.
Parameters​
none
Returns​
Boolean
- true
when listening, otherwise false
.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_listening","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc":"2.0",
"result":true
}
net_peerCount​
Returns number of peers currently connected to the client.
Parameters​
none
Returns​
QUANTITY
- integer of the number of connected peers.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":74}'
// Result
{
"id":74,
"jsonrpc": "2.0",
"result": "0x2" // 2
}
net_peerList​
Returns list of peers known to the client.
Parameters​
none
Returns​
Array
- The list of peers.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_peerList","params":[],"id":1}'
// Result
{
"jsonrpc":"2.0",
"id":1,
"result": [
"3fd44f66 | ec2-52-15-37-171.us-east-2.compute.amazonaws.com/52.15.37.171:5050",
"50517861 | bootstrap14.rsk.co/54.169.136.187:5050",
"434f8932 | bootstrap07.rsk.co/54.169.12.15:5050"]
}
eth_chainId​
Returns the currently configured chain id, a value used in replay-protected transaction signing as introduced by EIP-155.
Parameters​
none
Returns​
String
- The current chainId.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc": "2.0",
"result": "0x1e"
}
eth_protocolVersion​
Returns the current ethereum protocol version.
Parameters​
none
Returns​
String
- The current ethereum protocol version.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_protocolVersion","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc": "2.0",
"result": "0x54"
}
eth_syncing​
Returns an object with data about the sync status or false
.
Parameters​
none
Returns​
Object|Boolean
, An object with sync status data or FALSE
, when not syncing:
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 eth_blockNumberhighestBlock
:QUANTITY
- The estimated highest block
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": {
startingBlock: '0x384',
currentBlock: '0x386',
highestBlock: '0x454'
}
}
// Or when not syncing
{
"id":1,
"jsonrpc": "2.0",
"result": false
}
eth_coinbase​
Returns the client coinbase address.
Parameters​
none
Returns​
DATA
, 20 bytes - the current coinbase address.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_coinbase","params":[],"id":64}'
// Result
{
"id":64,
"jsonrpc": "2.0",
"result": "0xc94770007dda54cF92009BFF0dE90c06F603a09f"
}
eth_mining​
Returns true
if client is actively mining new blocks.
Parameters​
none
Returns​
Boolean
- returns true
of the client is mining, otherwise false
.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_mining","params":[],"id":71}'
// Result
{
"id":71,
"jsonrpc": "2.0",
"result": true
}
eth_hashrate​
Returns the number of hashes per second that the node is mining with.
Parameters​
none
Returns​
QUANTITY
- number of hashes per second.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_hashrate","params":[],"id":71}'
// Result
{
"id":71,
"jsonrpc": "2.0",
"result": "0x38a"
}
eth_gasPrice​
Returns the current price per gas in wei.
Parameters​
none
Returns​
QUANTITY
- integer of the current gas price in wei.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73}'
// Result
{
"id":73,
"jsonrpc": "2.0",
"result": "0x09184e72a000" // 10000000000000
}
eth_accounts​
Returns a list of addresses owned by client.
Parameters​
none
Returns​
Array of DATA
, 20 Bytes - addresses owned by the client.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": ["0xc94770007dda54cF92009BFF0dE90c06F603a09f"]
}
eth_blockNumber​
Returns the number of most recent block.
Parameters​
none
Returns​
QUANTITY
- integer of the current block number the client is on.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}'
// Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0xc94" // 1207
}
eth_getBalance​
Returns the balance of the account of given address.
Parameters​
DATA
, 20 Bytes - address to check for balance.QUANTITY|TAG|MAP
- integer block number, or the string"latest"
,"earliest"
or"pending"
, see the default block parameter, or a map containing a block hash string, under the key"blockHash"
or a string hexadecimal number, under the key"blockNumber"
.
Example Parameters​
params: ["0xc94770007dda54cF92009BFF0dE90c06F603a09f", "latest"];
Returns​
QUANTITY
- integer of the current balance in wei.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBalance","params":["0xc94770007dda54cF92009BFF0dE90c06F603a09f", "latest"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x0234c8a3397aab58" // 158972490234375000
}
eth_getStorageAt​
Returns the value from a storage position at a given address.
Parameters​
DATA
, 20 Bytes - address of the storage.QUANTITY
- integer of the position in the storage.QUANTITY|TAG|MAP
- integer block number, or the string"latest"
,"earliest"
or"pending"
, see the default block parameter, or a map containing a block hash string, under the key"blockHash"
or a string hexadecimal number, under the key"blockNumber"
.
Returns​
DATA
- the value at this storage position (A 32-byte zero value is returned
for non-existing keys).
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 -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}' localhost:8545
{"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:
keccack(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 geth console which comes with the web3 library can be used to make the calculation:
> var key = "000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298" + "0000000000000000000000000000000000000000000000000000000000000001"
undefined
> web3.sha3(key, {"encoding": "hex"})
"0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9"
Now to fetch the storage:
curl -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9", "latest"], "id": 1}' localhost:8545
{"jsonrpc":"2.0","id":1,"result":"0x000000000000000000000000000000000000000000000000000000000000162e"}
eth_getTransactionCount​
Returns the number of transactions sent from an address.
Parameters​
DATA
, 20 Bytes - address.QUANTITY|TAG|MAP
- integer block number, or the string"latest"
,"earliest"
or"pending"
, see the default block parameter, or a map containing a block hash string, under the key"blockHash"
or a string hexadecimal number, under the key"blockNumber"
.
Example Parameters​
params: [
"0xc94770007dda54cF92009BFF0dE90c06F603a09f",
"latest", // state at the latest block
];
Returns​
QUANTITY
- integer of the number of transactions send from this address.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0xc94770007dda54cF92009BFF0dE90c06F603a09f","latest"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
eth_getBlockTransactionCountByHash​
Returns the number of transactions in a block from a block matching the given block hash.
Parameters​
DATA
, 32 Bytes - hash of a block.
Example Parameters​
params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"];
Returns​
QUANTITY
- integer of the number of transactions in this block, or null
when no block was found.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xc94770007dda54cF92009BFF0dE90c06F603a09f"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xc" // 11
}
eth_getBlockTransactionCountByNumber​
Returns the number of transactions in a block matching the given block number.
Parameters​
QUANTITY|TAG
- integer of a block number, or the string"earliest"
,"latest"
or"pending"
, as in the default block parameter.
Example Parameters​
params: [
"0xe8", // 232
];
Returns​
QUANTITY
- integer of the number of transactions in this block.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xa" // 10
}
eth_getUncleCountByBlockHash​
Returns the number of uncles in a block from a block matching the given block hash.
Parameters​
DATA
, 32 Bytes - hash of a block.
Example Parameters​
params: ["0xc94770007dda54cF92009BFF0dE90c06F603a09f"];
Returns​
QUANTITY
- integer of the number of uncles in this block.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","params":["0xc94770007dda54cF92009BFF0dE90c06F603a09f"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xc" // 1
}
eth_getUncleCountByBlockNumber​
Returns the number of uncles in a block from a block matching the given block number.
Parameters​
QUANTITY|TAG
- integer of a block number, or the string "latest", "earliest" or "pending", see the default block parameter.
params: [
"0xe8", // 232
];
Returns​
QUANTITY
- integer of the number of uncles in this block.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber","params":["0xe8"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
eth_getCode​
Returns code at a given address.
Parameters​
DATA
, 20 Bytes - address.QUANTITY|TAG|MAP
- integer block number, or the string"latest"
,"earliest"
or"pending"
, see the default block parameter, or a map containing a block hash string, under the key"blockHash"
or a string hexadecimal number, under the key"blockNumber"
.
Example Parameters​
params: [
"0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
"0x2", // 2
];
Returns​
DATA
- the code from the given address.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056"
}
eth_sign​
The sign method calculates an Ethereum specific signature with: sign(keccak256("\x19Ethereum Signed Message:\n" + len(message) + message)))
.
By adding a prefix to the message makes the calculated signature recognisable as an Ethereum specific signature. This prevents misuse where a malicious DApp can sign arbitrary data (e.g. transaction) and use the signature to impersonate the victim.
Note the address to sign with must be unlocked.
Parameters​
account, message
DATA
, 20 Bytes - address.DATA
, N Bytes - message to sign.
Returns​
DATA
: Signature
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sign","params":["0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", "0xdeadbeaf"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b"
}
eth_sendTransaction​
Creates new message call transaction or a contract creation, if the data field contains code.
Parameters​
Object
- The transaction object
from
:DATA
, 20 Bytes - The address the transaction is sent from.to
:DATA
, 20 Bytes - (optional when creating new contract) The address the transaction is sent to.gas
:QUANTITY
- (optional, default: 90000) Integer of the gas provided for the transaction execution. It will return unused gas.gasPrice
:QUANTITY
- (optional, default: 0) Integer of the gasPrice used for each paid gasvalue
:QUANTITY
- (optional) Integer of the value sent with this transactiondata
:DATA
- The compiled code of a contract OR the hash of the invoked method signature and encoded parameters. For details see Ethereum Contract ABInonce
:QUANTITY
- (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.
Example Parameters​
params: [
{
from: "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
to: "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
gas: "0x76c0", // 30400
gasPrice: "0x9184e72a000", // 10000000000000
value: "0x9184e72a", // 2441406250
data: "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
},
];
Returns​
DATA
, 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.
Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendTransaction","params":[{see above}],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}
eth_sendRawTransaction​
Creates new message call transaction or a contract creation for signed transactions.
Parameters​
DATA
, The signed transaction data.
Example Parameters​
params: [
"0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
];
Returns​
DATA
, 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.
Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params":[{see above}],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}
eth_call​
Executes a new message call immediately without creating a transaction on the block chain.
Parameters​
Object
- The transaction call object
from
:DATA
, 20 Bytes - (optional) The address the transaction is sent from.to
:DATA
, 20 Bytes - The address the transaction is directed to.gas
:QUANTITY
- (optional) Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.gasPrice
:QUANTITY
- (optional) Integer of the gasPrice used for each paid gasvalue
:QUANTITY
- (optional) Integer of the value sent with this transactiondata|input
:DATA
- (optional) Hash of the method signature and encoded parameters. For details see Ethereum Contract ABI in the Solidity documentation
QUANTITY|TAG
- integer block number, or the string"latest"
,"earliest"
or"pending"
, see the default block parameter
Example Parameters​
params: [
{
from: "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
to: "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
},
"latest",
];
Returns​
DATA
- the return value of executed contract.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_call","params":[{see above}],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x"
}
// In case of REVERT error
{
"jsonrpc":"2.0",
"id":1,
"error":{
"code":-32015,
"message":"VM Exception while processing transaction: revert reason",
"data":"0x08c379a..."
}
}
eth_estimateGas​
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. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.
Note that when eth_estimateGas
is called, the node simulates the transaction execution without broadcasting it to the network.
The simulation runs through the entire transaction process as if it were being executed, including checking for sufficient balance, contract code execution, etc.
During the simulation, the method calculates the exact amount of gas that would be consumed by the transaction if it were to be executed on the blockchain. The estimated gas amount is returned, helping users set an appropriate gas limit for the actual transaction.
Until Arrowhead 6.5.0
, there was a difference in Rootstock compared to Ethereum, and it is that if one of the steps of the simulated transaction fails, the node would return the gas estimation needed for the transaction, while on Ethereum, the node would return an error instead of the gas estimation. Starting with Arrowhead 6.5.0
this is not valid anymore, Rootstock will behave same way as Ethereum, returning an error if one of the steps of the simulated transaction fails.
You can see this behavior on the following example, where we call eth_estimateGas
for a transaction that would be executed from an address without enough balance.
Example:
{
"jsonrpc":"2.0",
"method":"eth_estimateGas",
"params":[
{"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
"to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
"gas": "0x76c0",
"gasPrice": "0x9184e72a000",
"value": "0x9184e72a",
"data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"},
"latest"
],
"id":0
}
Response on Rootstock:
{
"jsonrpc": "2.0",
"id": 0,
"result": "0x5498"
}
Response on Ethereum:
{
"jsonrpc": "2.0",
"id": 0,
"error": {
"code": -32000,
"message": "insufficient funds for transfer"
}
}
Parameters​
See eth_call parameters, expect that all properties are optional. If no gas limit is specified geth uses the block gas limit from the pending block as an upper bound. As a result the returned estimate might not be enough to executed the call/transaction when the amount of gas is higher than the pending block gas limit.
Returns​
QUANTITY
- the amount of gas used.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see above}],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x5208" // 21000
}
eth_getBlockByHash​
Returns information about a block by hash.
Parameters​
DATA
, 32 Bytes - Hash of a block.Boolean
- Iftrue
it returns the full transaction objects, iffalse
only the hashes of the transactions.
Example Parameters​
params: [
"0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
true,
];
Returns​
Object
- A block object, or null
when no block was found:
number
:QUANTITY
- the block number.null
when its pending block.hash
:DATA
, 32 Bytes - hash of the block.null
when its pending block.parentHash
:DATA
, 32 Bytes - hash of the parent block.nonce
:DATA
, 8 Bytes - hash of the generated proof-of-work.null
when its pending block.sha3Uncles
:DATA
, 32 Bytes - SHA3 of the uncles data in the block.logsBloom
:DATA
, 256 Bytes - the bloom filter for the logs of the block.null
when its pending block.transactionsRoot
:DATA
, 32 Bytes - the root of the transaction trie of the block.stateRoot
:DATA
, 32 Bytes - the root of the final state trie of the block.receiptsRoot
:DATA
, 32 Bytes - the root of the receipts trie of the block.miner
:DATA
, 20 Bytes - the address of the beneficiary to whom the mining rewards were given.difficulty
:QUANTITY
- integer of the difficulty for this block.cumulativeDifficulty
:QUANTITY
- integer of the difficulty for this block plus its uncles' difficulties.totalDifficulty
:QUANTITY
- integer of the total difficulty 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.gasLimit
:QUANTITY
- the maximum gas allowed in 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.transactions
:Array
- Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.uncles
:Array
- Array of uncle hashes.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331", true],"id":1}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": {
"number": "0x1b4", // 436
"hash": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
"parentHash": "0x9646252be9520f6e71339a8df9c55e4d7619deeb018d2a3f2d21fc165dde5eb5",
"nonce": "0xe04d296d2460cfb8472af2c5fd05b5a214109c25688d3704aed5484f9a7792f2",
"sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
"logsBloom": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
"transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
"stateRoot": "0xd5855eb08b3387c0af375e9cdb6acfc05eb8f519e419b874b6ff2ffda7ed1dff",
"miner": "0x4e65fda2159562a496f9f3522f89122a3088497a",
"difficulty": "0x027f07", // 163591
"cumulativeDifficulty": "0x027f07", // 163591
"totalDifficulty": "0x027f07", // 163591
"extraData": "0x0000000000000000000000000000000000000000000000000000000000000000",
"size": "0x027f07", // 163591
"gasLimit": "0x9f759", // 653145
"gasUsed": "0x9f759", // 653145
"timestamp": "0x54e34e8e" // 1424182926
"transactions": [{...},{ ... }]
"uncles": ["0x1606e5...", "0xd5145a9..."]
}
}
eth_getBlockByNumber​
Returns information about a block by block number.
Parameters​
QUANTITY|TAG
- integer of a block number, or the string"earliest"
,"latest"
or"pending"
, as in the default block parameter.Boolean
- Iftrue
it returns the full transaction objects, iffalse
only the hashes of the transactions.
Example Parameters​
params: [
"0x1b4", // 436
true,
];
Returns​
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'
Result see eth_getBlockByHash
eth_getTransactionByHash​
Returns the information about a transaction requested by transaction hash.
Parameters​
DATA
, 32 Bytes - hash of a transaction
Example Parameters​
params: ["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"];
Returns​
Object
- A transaction object, or null
when no transaction was found:
blockHash
:DATA
, 32 Bytes - hash of the block where this transaction was in.null
when its pending.blockNumber
:QUANTITY
- block number where this transaction was in.null
when its pending.from
:DATA
, 20 Bytes - address of the sender.gas
:QUANTITY
- gas provided by the sender.gasPrice
:QUANTITY
- gas price provided by the sender in Wei.hash
:DATA
, 32 Bytes - hash of the transaction.input
:DATA
- the data send along with the transaction.nonce
:QUANTITY
- the number of transactions made by the sender prior to this one.to
:DATA
, 20 Bytes - address of the receiver.null
when its a contract creation transaction.transactionIndex
:QUANTITY
- integer of the transaction's index position in the block.null
when its pending.value
:QUANTITY
- value transferred in Wei.v
:QUANTITY
- ECDSA recovery idr
:QUANTITY
- ECDSA signature rs
:QUANTITY
- ECDSA signature s
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","params":["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"],"id":1}'
// Result
{
"jsonrpc":"2.0",
"id":1,
"result":{
"blockHash":"0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2",
"blockNumber":"0x5daf3b", // 6139707
"from":"0xa7d9ddbe1f17865597fbd27ec712455208b6b76d",
"gas":"0xc350", // 50000
"gasPrice":"0x4a817c800", // 20000000000
"hash":"0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b",
"input":"0x68656c6c6f21",
"nonce":"0x15", // 21
"to":"0xf02c1c8e6114b1dbe8937a39260b5b0a374432bb",
"transactionIndex":"0x41", // 65
"value":"0xf3dbb76162000", // 4290000000000000
"v":"0x25", // 37
"r":"0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea",
"s":"0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c"
}
}
eth_getTransactionByBlockHashAndIndex​
Returns information about a transaction by block hash and transaction index position.
Parameters​
DATA
, 32 Bytes - hash of a block.QUANTITY
- integer of the transaction index position.
Example Parameters​
params: [
"0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
"0x0", // 0
];
Returns​
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
Result see eth_getTransactionByHash
eth_getTransactionByBlockNumberAndIndex​
Returns information about a transaction by block number and transaction index position.
Parameters​
QUANTITY|TAG
- a block number, or the string"earliest"
,"latest"
or"pending"
, as in the default block parameter.QUANTITY
- the transaction index position.
Example Parameters​
params: [
"0x29c", // 668
"0x0", // 0
];
Returns​
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'
Result see eth_getTransactionByHash
eth_getTransactionReceipt​
Returns the receipt of a transaction by transaction hash.
Note That the receipt is not available for pending transactions.
Parameters​
DATA
, 32 Bytes - hash of a transaction
Example Parameters​
params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"];
Returns​
Object
- A transaction receipt object, or null
when no receipt was found:
transactionHash
:DATA
, 32 Bytes - hash of the transaction.transactionIndex
:QUANTITY
- integer of the transaction's index position in the block.blockHash
:DATA
, 32 Bytes - hash of the block where this transaction was in.blockNumber
:QUANTITY
- block number where this transaction was in.from
:DATA
, 20 Bytes - address of the sender.to
:DATA
, 20 Bytes - address of the receiver. null when it's a contract creation transaction.cumulativeGasUsed
:QUANTITY
- The total amount of gas used when this transaction was executed in the block.gasUsed
:QUANTITY
- The amount of gas used by this specific transaction alone.contractAddress
:DATA
, 20 Bytes - The contract address created, if the transaction was a contract creation, otherwisenull
.logs
:Array
- Array of log objects, which this transaction generated.logsBloom
:DATA
, 256 Bytes - Bloom filter for light clients to quickly retrieve related logs.effectiveGasPrice
:QUANTITY
- The actual value per gas deducted on the transaction.
It also returns either :
root
:DATA
32 bytes of post-transaction stateroot (pre Byzantium)status
:QUANTITY
either1
(success) or0
(failure)
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": {
transactionHash: '0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238',
transactionIndex: '0x1', // 1
blockNumber: '0xb', // 11
blockHash: '0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b',
cumulativeGasUsed: '0x33bc', // 13244
gasUsed: '0x4dc', // 1244
contractAddress: '0xb60e8dd61c5d32be8058bb8eb970870f07233155', // or null, if none was created
logs: [{
// logs as returned by getFilterLogs, etc.
}, ...],
logsBloom: "0x00...0", // 256 byte bloom filter
status: '0x1',
effectiveGasPrice: '0x64' // 100
}
}
eth_pendingTransactions​
Returns the pending transactions submitted by the node operator.
Parameters​
none
Returns​
Array
- A list of pending transactions submitted by the node operator.
Example​
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_pendingTransactions","params":[],"id":1}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": [{
blockHash: '0x0000000000000000000000000000000000000000000000000000000000000000',
blockNumber: null,
from: '0x28bdb9c230f4d5e45435e4d006326ee32e46cb31',
gas: '0x204734',
gasPrice: '0x4a817c800',
hash: '0x8dfa6a59307a490d672494a171feee09db511f05e9c097e098edc2881f9ca4f6',
input: '0x6080604052600',
nonce: '0x12',
to: null,
transactionIndex: '0x0',
value: '0x0',
v: '0x3d',
r: '0xaabc9ddafffb2ae0bac4107697547d22d9383667d9e97f5409dd6881ce08f13f',
s: '0x69e43116be8f842dcd4a0b2f760043737a59534430b762317db21d9ac8c5034',
type: '0x0'
},....,{
blockHash: '0x0000000000000000000000000000000000000000000000000000000000000000',
blockNumber: null,
from: '0x28bdb9c230f4d5e45435e4d006326ee32e487b31',
gas: '0x205940',
gasPrice: '0x4a817c800',
hash: '0x8e4340ea3983d86e4b6c44249362f716ec9e09849ef9b6e3321140581d2e4dac',
input: '0xe4b6c4424936',
nonce: '0x14',
to: null,
transactionIndex: '0x0',
value: '0x0',
v: '0x3d',
r: '0x1ec191ef20b0e9628c4397665977cbe7a53a263c04f6f185132b77fa0fd5ca44',
s: '0x8a58e00c63e05cfeae4f1cf19f05ce82079dc4d5857e2cc281b7797d58b5faf',
type: '0x0'
}]
}