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.