JSON is a lightweight data-interchange format. It can represent numbers, strings, ordered sequences of values, and collections of name/value pairs.
JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. Primarily this specification defines several data structures and the rules around their processing. It is transport agnostic in that the concepts can be used within the same process, over sockets, over HTTP, or in many various message passing environments. It uses JSON (RFC 4627) as data format.
To talk to an ethereum node from inside a JavaScript application use the web3.js library, which gives an convenient interface for the RPC methods. See the JavaScript API for more.
Default JSON-RPC endpoints:
C++: http://localhost:8080
Go: http://localhost:8545
You can start the HTTP JSON-RPC with the --rpc
flag
geth --rpc
change the default port (8545) and listing address (localhost) with:
geth --rpc --rpcaddr <ip> --rpcport <portnumber>
If accessing the RPC from a browser, CORS will need to be enabled with the appropriate domain set. Otherwise, JavaScript calls are limit by the same-origin policy and requests will fail:
geth --rpc --rpccorsdomain "http://localhost:3000"
The JSON RPC can also be started from the geth console using the admin.startRPC(addr, port)
command.
You can start it by running eth
application with -j
option:
./eth -j
You can also specify JSON-RPC port (default is 8080):
./eth -j --json-rpc-port 8079
cpp-ethereum | go-ethereum | |
---|---|---|
JSON-RPC 1.0 | ✓ | |
JSON-RPC 2.0 | ✓ | ✓ |
Batch requests | ✓ | ✓ |
HTTP | ✓ | ✓ |
At present there are two key datatypes that are passed over JSON: unformatted byte arrays and quantities. Both are passed with a hex encoding, however with different requirements to formatting:
When encoding QUANTITIES (integers, numbers): encode as hex, prefix with "0x", the most compact representation (slight exception: zero should be represented as "0x0"). Examples:
When encoding UNFORMATTED DATA (byte arrays, account addresses, hashes, bytecode arrays): encode as hex, prefix with "0x", two hex digits per byte. Examples:
Currently cpp-ethereum and go-ethereum provides JSON-RPC communication only over http.
The following methods have a extra default block parameter:
When requests are made that act on the state of ethereum, the last default block parameter determines the height of the block.
The following options are possible for the defaultBlock parameter:
HEX String
- an integer block numberString "latest"
- for the latest minded blockString "earliest"
for the earliest/genesis blockString "pending"
- for the pending state/transactionsReturns the current client version.
none
String
- The current client version
// 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"
}
Returns SHA3 of the given data.
String
- the data to convert into a SHA3 hashparams: [
'0x68656c6c6f20776f726c64'
]
DATA
- The SHA3 result of the given string.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"web3_sha3","params":["0x68656c6c6f20776f726c64"],"id":64}'
// Result
{
"id":64,
"jsonrpc": "2.0",
"result": "0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad"
}
Returns the current network protocol version.
none
String
- The current network protocol version
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_version","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc": "2.0",
"result": "59"
}
Returns true
if client is actively listening for network connections.
none
Boolean
- true
when listening, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_listening","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc":"2.0",
"result":true
}
Returns number of peers currenly connected to the client.
none
QUANTITY
- integer of the number of connected peers.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":74}'
// Result
{
"id":74,
"jsonrpc": "2.0",
"result": "0x2" // 2
}
Returns the current ethereum protocol version.
none
String
- The current ethereum protocol version
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_protocolVersion","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc": "2.0",
"result": "54"
}
Returns the client coinbase address.
none
DATA
, 20 bytes - the current coinbase address.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_coinbase","params":[],"id":64}'
// Result
{
"id":64,
"jsonrpc": "2.0",
"result": "0x407d73d8a49eeb85d32cf465507dd71d507100c1"
}
Returns true
if client is actively mining new blocks.
none
Boolean
- returns true
of the client is mining, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_mining","params":[],"id":71}'
// Result
{
"id":71,
"jsonrpc": "2.0",
"result": true
}
Returns the current price per gas in wei.
none
QUANTITY
- integer of the current gas price in wei.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73}'
// Result
{
"id":73,
"jsonrpc": "2.0",
"result": "0x09184e72a000" // 10000000000000
}
Returns a list of addresses owned by client.
none
Array of DATA
, 20 Bytes - addresses owned by the client.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]
}
Returns the number of most recent block.
none
QUANTITY
- integer of the current block number the client is on.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":83}'
// Result
{
"id":83,
"jsonrpc": "2.0",
"result": "0x4b7" // 1207
}
Returns the balance of the account of given address.
DATA
, 20 Bytes - address to check for balance.QUANTITY|TAG
- integer block number, or the string "latest"
, "earliest"
or "pending"
, see the default block parameterparams: [
'0x407d73d8a49eeb85d32cf465507dd71d507100c1',
'latest'
]
QUANTITY
- integer of the current balance in wei.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBalance","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1", "latest"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x0234c8a3397aab58" // 158972490234375000
}
Returns the value from a storage position at a given address.
DATA
, 20 Bytes - address of the storage.QUANTITY
- integer of the position in the storage.QUANTITY|TAG
- integer block number, or the string "latest"
, "earliest"
or "pending"
, see the default block parameterparams: [
'0x407d73d8a49eeb85d32cf465507dd71d507100c1',
'0x0', // storage position at 0
'0x2' // state at block number 2
]
DATA
- the value at this storage position.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getStorageAt","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1", "0x0", "0x2"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x03"
}
Returns the number of transactions send from a address.
DATA
, 20 Bytes - address.QUANTITY|TAG
- integer block number, or the string "latest"
, "earliest"
or "pending"
, see the default block parameterparams: [
'0x407d73d8a49eeb85d32cf465507dd71d507100c1',
'latest' // state at the latest block
]
QUANTITY
- integer of the number of transactions send from this address.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1","latest"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Returns the number of transactions in a block from a block matching the given block hash.
DATA
, 32 Bytes - hash of a blockparams: [
'0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238'
]
QUANTITY
- integer of the number of transactions in this block.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xb" // 11
}
Returns the number of transactions in a block from a block matching the given block number.
QUANTITY
- integer of a block number, or the string "latest", "earliest" or "pending", see the default block parameterparams: [
'0xe8', // 232
]
QUANTITY
- integer of the number of transactions in this block.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xa" // 10
}
Returns the number of uncles in a block from a block matching the given block hash.
DATA
, 32 Bytes - hash of a blockparams: [
'0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238'
]
QUANTITY
- integer of the number of uncles in this block.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id"Block:1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Returns the number of uncles in a block from a block matching the given block number.
QUANTITY
- integer of a block number, or the string "latest", "earliest" or "pending", see the default block parameterparams: [
'0xe8', // 232
]
QUANTITY
- integer of the number of uncles in this block.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber","params":["0xe8"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Returns code at a given address.
DATA
, 20 Bytes - addressQUANTITY|TAG
- integer block number, or the string "latest"
, "earliest"
or "pending"
, see the default block parameterparams: [
'0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b',
'0x2' // 2
]
DATA
- the code from the given address.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056"
}
Creates new message call transaction or a contract creation, if the data field contains code.
Object
- The transaction objectfrom
: DATA
, 20 Bytes - The address the transaction is send from.to
: DATA
, 20 Bytes - (optional when creating new contract) The address the transaction is directed to.gas
: QUANTITY
- (optional, default: To-Be-Determined) Integer of the gas provided for the transaction execution. It will return unused gas.gasPrice
: QUANTITY
- (optional, default: To-Be-Determined) Integer of the gasPrice used for each payed gasvalue
: QUANTITY
- (optional) Integer of the value send with this transactiondata
: DATA
- (optional) The compiled code of a contractparams: [{
"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
"to": "0xd46e8dd67c5d32be8058bb8eb970870f072445675",
"gas": "0x76c0", // 30400,
"gasPrice": "0x9184e72a000", // 10000000000000
"value": "0x9184e72a", // 2441406250
"data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"
}]
DATA
, 20 Bytes - the address of the newly created contract, or the 32 Bytes transaction hash.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendTransaction","params":[{see above}],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x7f9fade1c0d57a7af66ab4ead7c2eb7b11a91385"
}
Executes a new message call immediately without creating a transaction on the block chain.
Object
- The transaction call objectfrom
: DATA
, 20 Bytes - The address the transaction is send from.to
: DATA
, 20 Bytes - The address the transaction is directed to.gas
: QUANTITY
- (optional) Integer of the gas provided for the transaction execution. It will return unused gas.gasPrice
: QUANTITY
- (optional) Integer of the gasPrice used for each payed gasvalue
: QUANTITY
- (optional) Integer of the value send with this transactiondata
: DATA
- (optional) The compiled code of a contractQUANTITY|TAG
- integer block number, or the string "latest"
, "earliest"
or "pending"
, see the default block parameterSee: eth_sendTransaction Parameters
DATA
- the return value of executed contract.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_call","params":[{see above}],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x0"
}
Returns information about a block by hash.
DATA
, 32 Bytes - Hash of a block.Boolean
- If true
it returns the full transaction objects, if false
only the hashes of the transactions.params: [
'0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331',
true
]
Object
- A block object, or null
when no transaction was found:
number
: QUANTITY
- the block number.hash
: DATA
, 32 Bytes - hash of the block.parentHash
: DATA
, 32 Bytes - hash of the parent block.nonce
: DATA
, 8 Bytes - hash of the generated proof-of-work.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.transactionsRoot
: DATA
, 32 Bytes - the root of the transaction trie of the blockstateRoot
: DATA
, 32 Bytes - the root of the final state 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.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.// 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
"totalDifficulty": "0x027f07", // 163591
"extraData": "0x0000000000000000000000000000000000000000000000000000000000000000",
"size": "0x027f07", // 163591
"gasLimit": "0x9f759", // 653145
"minGasPrice": "0x9f759", // 653145
"gasUsed": "0x9f759", // 653145
"timestamp": "0x54e34e8e" // 1424182926
"transactions": [{...},{ ... }]
"uncles": ["0x1606e5...", "0xd5145a9..."]
}
}
Returns information about a block by block number.
QUANTITY
- integer of a block number.Boolean
- If true
it returns the full transaction objects, if false
only the hashes of the transactions.params: [
'0x1b4', // 436
true
]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'
Result see eth_getBlockByHash
Returns the information about a transaction requested by transaction hash.
DATA
, 32 Bytes - hash of a transactionparams: [
"0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
]
Object
- A transaction object, or null
when no transaction was found:
hash
: DATA
, 32 Bytes - hash of the transaction.nonce
: QUANTITY
- the number of transactions made by the sender prior to this one.blockHash
: DATA
, 32 Bytes - hash of the block where this transaction was in. null
when the transaction is pending.blockNumber
: QUANTITY
- block number where this transaction was in. null
when the transaction is pending.transactionIndex
: QUANTITY
- integer of the transactions index position in the block.from
: DATA
, 20 Bytes - address of the sender.to
: DATA
, 20 Bytes - address of the receiver. null
when its a contract creation transaction.value
: QUANTITY
- value transferred in Wei.gasPrice
: QUANTITY
- price paid per gas in Wei.gas
: QUANTITY
- gas used.input
: DATA
- the data send along with the transaction.// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": {
"hash":"0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b",
"nonce":"0x",
"blockHash": "0xbeab0aa2411b7ab17f30a99d3cb9c6ef2fc5426d6ad6fd9e2a26a6aed1d1055b",
"blockNumber": "0x15df", // 5599
"transactionIndex": "0x1", // 1
"from":"0x407d73d8a49eeb85d32cf465507dd71d507100c1",
"to":"0x85h43d8a49eeb85d32cf465507dd71d507100c1",
"value":"0x7f110" // 520464
"gas": "0x7f110" // 520464
"gasPrice":"0x09184e72a000",
"input":"0x603880600c6000396000f300603880600c6000396000f3603880600c6000396000f360",
}
}
Returns information about a transaction by block hash and transaction index position.
DATA
, 32 Bytes - hash of a block.QUANTITY
- integer of the transaction index position.params: [
'0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331',
'0x0' // 0
]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockHashAndIndex","params":[0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b, "0x0"],"id":1}'
Result see eth_getTransactionByHash
Returns information about a transaction by block number and transaction index position.
QUANTITY
- a block number.QUANTITY
- the transaction index position.params: [
'0x29c', // 668
'0x0' // 0
]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'
Result see eth_getTransactionByHash
Returns information about a uncle of a block by hash and uncle index position.
DATA
, 32 Bytes - hash a block.QUANTITY
- the uncle's index position.params: [
'0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b',
'0x0' // 0
]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
Result see eth_getBlockByHash
Note: An uncle doesn't contain individual transactions.
Returns information about a uncle of a block by number and uncle index position.
QUANTITY
- a block number.QUANTITY
- the uncle's index position.params: [
'0x29c', // 668
'0x0' // 0
]
Note: An uncle doesn't contain individual transactions.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'
Result see eth_getBlockByHash
Returns a list of available compilers in the client.
none
Array
- Array of available compilers.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getCompilers","params":[],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": ["solidity", "lll", "serpent"]
}
Returns compiled solidity code.
String
- The source code.params: [
"contract test { function multiply(uint a) returns(uint d) { return a * 7; } }",
]
DATA
- The compiled source code.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_compileSolidity","params":["contract test { function multiply(uint a) returns(uint d) { return a * 7; } }"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x603880600c6000396000f3006001600060e060020a600035048063c6888fa114601857005b6021600435602b565b8060005260206000f35b600081600702905091905056" // the compiled source code
}
Returns compiled LLL code.
String
- The source code.params: [
"(returnlll (suicide (caller)))",
]
DATA
- The compiled source code.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_compileSolidity","params":["(returnlll (suicide (caller)))"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x603880600c6000396000f3006001600060e060020a600035048063c6888fa114601857005b6021600435602b565b8060005260206000f35b600081600702905091905056" // the compiled source code
}
Returns compiled serpent code.
String
- The source code.params: [
"/* some serpent */",
]
DATA
- The compiled source code.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_compileSolidity","params":["/* some serpent */"],"id":1}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x603880600c6000396000f3006001600060e060020a600035048063c6888fa114601857005b6021600435602b565b8060005260206000f35b600081600702905091905056" // the compiled source code
}
Creates a filter object, based on filter options, to notify when the state changes (logs). To check if the state has changed, call eth_getFilterChanges.
Object
- The filter options:fromBlock
: QUANTITY|TAG
- (optional, default: "latest"
) Integer block number, or "latest"
for the last mined block or "pending"
, "earliest"
for not yet mined transactions.toBlock
: QUANTITY|TAG
- (optional, default: "latest"
) Integer block number, or "latest"
for the last mined block or "pending"
, "earliest"
for not yet mined transactions.address
: DATA|Array
, 20 Bytes - (optional) Contract address or a list of addresses from which logs should originate.topics
: Array of DATA
, - (optional) Array of 32 Bytes DATA
topics.params: [{
"fromBlock": "0x1",
"toBlock": "0x2",
"address": "0x8888f1f195afa192cfee860698584c030f4c9db1",
"topics": ["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]
}]
QUANTITY
- A filter id.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_newFilter","params":[{"topics":["0x12341234"]}],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Creates a filter object, based on an option string, to notify when state changes (logs). To check if the state has changed, call eth_getFilterChanges.
TAG
- The string "latest"
for notifications about new block and "pending"
for notifications about pending transactions.params: ["pending"]
QUANTITY
- A filter id.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_newBlockFilter","params":["pending"],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0x1" // 1
}
Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additonally Filters timeout when they aren't requested with eth_getFilterChanges for a period of time.
QUANTITY
- The filter id.params: [
"0xb" // 11
]
Boolean
- true
if the filter was successfully uninstalled, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_uninstallFilter","params":["0xb"],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": true
}
Polling method for a filter, which returns an array of logs which occurred since last poll.
QUANTITY
- the filter id.params: [
"0x16" // 22
]
Array
- Array of log objects, or an empty array (if nothing has changed since last poll).
For filters created with eth_newBlockFilter
log objects are null
.
For filters created with eth_newFilter
logs are objects with following params:
logIndex
: QUANTITY
- integer of the log index position in the block.transactionIndex
: QUANTITY
- integer of the transactions index position log was created from.transactionHash
: DATA
, 32 Bytes - hash of the transactions this log was created from.blockHash
: DATA
, 32 Bytes - hash of the block where this log was in. null
when the log is pending.blockNumber
: QUANTITY
- the block number where this log was in. null
when the log is pending.address
: DATA
, 32 Bytes - address from which this log originated.data
: DATA
- contains one or more 32 Bytes non-indexed arguments of the log.topics
: Array of DATA
- Array of 0 to 4 32 Bytes DATA
of indexed log arguments. (In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)
), except you declared the event with the anonymous
specifier.)// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getFilterChanges","params":["0x16"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": [{
"logIndex": "0x1", // 1
"blockNumber":"0x1b4" // 436
"blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"transactionHash": "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
"transactionIndex": "0x0", // 0
"address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
"data":"0x0000000000000000000000000000000000000000000000000000000000000000",
"topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
},{
...
}]
}
Returns an array of all logs matching filter with given id.
QUANTITY
- The filter id.params: [
"0x16" // 22
]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getFilterLogs","params":["0x16"],"id":74}'
Result see eth_getFilterChanges
Returns an array of all logs matching a given filter object.
Object
- the filter object, see eth_newFilter parameters.params: [{
"topics": ["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]
}]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getLogs","params":[{"topics":["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]}],"id":74}'
Result see eth_getFilterChanges
Returns the hash of the current block, the seedHash, and the boundary condition to be met ("target").
none
Array
- Array with the following properties:
DATA
, 32 Bytes - current block header pow-hashDATA
, 32 Bytes - the seed hash used for the DAG.DATA
, 32 Bytes - the boundary condition ("target"), 2^256 / difficulty.// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getWork","params":[],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": [
"0x1234567890abcdef1234567890abcdef",
"0x5EED0000000000000000000000000000",
"0xd1ff1c01710000000000000000000000"
]
}
Used for submitting a proof-of-work solution.
DATA
, 8 Bytes - The nonce found (64 bits)DATA
, 32 Bytes - The header's pow-hash (256 bits)DATA
, 32 Bytes - The mix digest (256 bits)params: [
"0x0000000000000001",
"0x1234567890abcdef1234567890abcdef",
"0xD1FE5700000000000000000000000000"
]
Boolean
- returns true
if the provided solution is valid, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0", "method":"eth_submitWork", "params":["0x0000000000000001", "0x1234567890abcdef1234567890abcdef", "0xD1GE5700000000000000000000000000"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": true
}
Stores a string in the local database.
String
- Database name.String
- Key name.String
- String to store.params: [
"testDB",
"myKey",
"myString"
]
Boolean
- returns true
if the value was stored, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"db_putString","params":["testDB","myKey","myString"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": true
}
Returns string from the local database.
String
- Database name.String
- Key name.params: [
"testDB",
"myKey",
]
String
- The previously stored string.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"db_getString","params":["testDB","myKey"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": "myString"
}
Stores binary data in the local database.
String
- Database name.String
- Key name.DATA
- The data to store.params: [
"testDB",
"myKey",
"0x68656c6c6f20776f726c64"
]
Boolean
- returns true
if the value was stored, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"db_putHex","params":["testDB","myKey","0x68656c6c6f20776f726c64"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": true
}
Returns binary data from the local database.
String
- Database name.String
- Key name.params: [
"testDB",
"myKey",
]
DATA
- The previously stored data.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"db_getHex","params":["testDB","myKey"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": "0x68656c6c6f20776f726c64"
}
Returns the current whisper protocol version.
none
String
- The current whisper protocol version
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_version","params":[],"id":67}'
// Result
{
"id":67,
"jsonrpc": "2.0",
"result": "2"
}
Sends a whisper message.
Object
- The whisper post object:from
: DATA
, 60 Bytes - (optional) The identity of the sender.to
: DATA
, 60 Bytes - (optional) The identity of the receiver. When present whisper will encrypt the message so that only the receiver can decrypt it.topics
: Array of DATA
- Array of DATA
topics, for the receiver to identify messages.payload
: DATA
- The payload of the message.priority
: QUANTITY
- The integer of the priority in a rang from ... (?).ttl
: QUANTITY
- integer of the time to live in seconds.params: [{
from: "0x04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a03e245533f97284d442460f2998cd41858798ddfd4d661997d3940272b717b1",
to: "0x3e245533f97284d442460f2998cd41858798ddf04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a0d4d661997d3940272b717b1",
topics: ["0x776869737065722d636861742d636c69656e74", "0x4d5a695276454c39425154466b61693532"],
payload: "0x7b2274797065223a226d6",
priority: "0x64",
ttl: "0x64",
}]
Boolean
- returns true
if the message was send, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"db_getString","params":[{"from":"0xc931d93e97ab07fe42d923478ba2465f2..","topics": ["0x68656c6c6f20776f726c64"],"payload":"0x68656c6c6f20776f726c64","ttl":0x64,"priority":0x64}],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": true
}
Creates new whisper identity in the client.
none
DATA
, 60 Bytes - the address of the new identiy.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_newIdentinty","params":[],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xc931d93e97ab07fe42d923478ba2465f283f440fd6cabea4dd7a2c807108f651b7135d1d6ca9007d5b68aa497e4619ac10aa3b27726e1863c1fd9b570d99bbaf"
}
Checks if the client hold the private keys for a given identity.
DATA
, 60 Bytes - The identity address to check.params: [
"0x04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a03e245533f97284d442460f2998cd41858798ddfd4d661997d3940272b717b1"
]
Boolean
- returns true
if the client holds the privatekey for that identity, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_hasIdentity","params":["0x04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a03e245533f97284d442460f2998cd41858798ddfd4d661997d3940272b717b1"],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": true
}
(?)
none
DATA
, 60 Bytes - the address of the new group. (?)
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_newIdentinty","params":[],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": "0xc65f283f440fd6cabea4dd7a2c807108f651b7135d1d6ca90931d93e97ab07fe42d923478ba2407d5b68aa497e4619ac10aa3b27726e1863c1fd9b570d99bbaf"
}
(?)
DATA
, 60 Bytes - The identity address to add to a group (?).params: [
"0x04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a03e245533f97284d442460f2998cd41858798ddfd4d661997d3940272b717b1"
]
Boolean
- returns true
if the identity was successfully added to the group, otherwise false
(?).
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_hasIdentity","params":["0x04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a03e245533f97284d442460f2998cd41858798ddfd4d661997d3940272b717b1"],"id":73}'
// Result
{
"id":1,
"jsonrpc": "2.0",
"result": true
}
Creates filter to notify, when client receives whisper message matching the filter options.
Object
- The filter options:to
: DATA
, 60 Bytes - (optional) Identity of the receiver. When present it will try to decrypt any incoming message if the client holds the private key to this identity.topics
: Array of DATA
- Array of DATA
topics which the incoming message's topics should match. params: [{
"topics": ['0x12341234bf4b564f'],
"to": "0x04f96a5e25610293e42a73908e93ccc8c4d4dc0edcfa9fa872f50cb214e08ebf61a03e245533f97284d442460f2998cd41858798ddfd4d661997d3940272b717b1"
}]
QUANTITY
- The newly created filter.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_newFilter","params":[{"topics": ['0x12341234bf4b564f'],"to": "0x2341234bf4b2341234bf4b564f..."}],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": "0x7" // 7
}
Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additonally Filters timeout when they aren't requested with shh_getFilterChanges for a period of time.
QUANTITY
- The filter id.params: [
"0x7" // 7
]
Boolean
- true
if the filter was successfully uninstalled, otherwise false
.
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_uninstallFilter","params":["0x7"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": true
}
Polling method for whisper filters. Returns new messages since the last call of this method.
Note calling the shh_getMessages method, will reset the buffer for this method, so that you won't receive duplicate messages.
QUANTITY
- The filter id.params: [
"0x7" // 7
]
Array
- Array of messages received since last poll:
hash
: DATA
, 32 Bytes (?) - The hash of the message.from
: DATA
, 60 Bytes - The sender of the message, if a sender was specified.to
: DATA
, 60 Bytes - The receiver of the message, if a receiver was specified.expiry
: QUANTITY
- Integer of the time in seconds when this message should expire (?).ttl
: QUANTITY
- Integer of the time the message should float in the system in seconds (?).sent
: QUANTITY
- Integer of the unix timestamp when the message was sent.topics
: Array of DATA
- Array of DATA
topics the message contained. You can use the following combinations:[A, B] = A && B
[A, [B, C]] = A && (B || C)
[null, A, B] = ANYTHING && A && B
null
works as a wildcardpayload
: DATA
- The payload of the message.workProved
: QUANTITY
- Integer of the work this message required before it was send (?).// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_getFilterChanges","params":["0x7"],"id":73}'
// Result
{
"id":1,
"jsonrpc":"2.0",
"result": [{
"hash": "0x33eb2da77bf3527e28f8bf493650b1879b08c4f2a362beae4ba2f71bafcd91f9",
"from": "0x3ec052fc33..",
"to": "0x87gdf76g8d7fgdfg...",
"expiry": "0x54caa50a", // 1422566666
"sent": "0x54ca9ea2", // 1422565026
"ttl": "0x64" // 100
"topics": ["0x6578616d"],
"payload": "0x7b2274797065223a226d657373616765222c2263686...",
"workProved": "0x0"
}]
}
Get all messages matching a filter, which are still existing in the node's buffer.
Note calling this method, will also reset the buffer for the shh_getFilterChanges method, so that you won't receive duplicate messages.
QUANTITY
- The filter id.params: [
"0x7" // 7
]
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"shh_getMessages","params":["0x7"],"id":73}'
Result see shh_getFilterChanges