JSON RPC

Contents

• JSON RPC API

  • JavaScript API

  • JSON-RPC Endpoint

    • Go

  • JSON-RPC support

  • HEX value encoding

  • The default block parameter

  • Curl Examples Explained

  • JSON-RPC methods

  • JSON RPC API Reference

    • web3_clientVersion

      • Parameters

      • Returns

      • Example

    • web3_sha3

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • net_version

      • Parameters

      • Returns

      • Example

    • net_listening

      • Parameters

      • Returns

      • Example

    • net_peerCount

      • Parameters

      • Returns

      • Example

    • eth_protocolVersion

      • Parameters

      • Returns

      • Example

    • eth_syncing

      • Parameters

      • Returns

      • Example

    • eth_coinbase

      • Parameters

      • Returns

      • Example

    • eth_mining

      • Parameters

      • Returns

      • Example

    • eth_hashrate

      • Parameters

      • Returns

      • Example

    • eth_gasPrice

      • Parameters

      • Returns

      • Example

    • eth_accounts

      • Parameters

      • Returns

      • Example

    • eth_blockNumber

      • Parameters

      • Returns

      • Example

    • eth_getBalance

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getStorageAt

      • Parameters

      • Returns

      • Example

    • eth_getTransactionCount

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getBlockTransactionCountByHash

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getBlockTransactionCountByNumber

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getUncleCountByBlockHash

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getUncleCountByBlockNumber

      • Parameters

      • Returns

      • Example

    • eth_getCode

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_sign

      • Parameters

      • Returns

      • Example

    • eth_sendTransaction

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_sendRawTransaction

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_call

      • Parameters

      • Returns

      • Example

    • eth_estimateGas

      • Parameters

      • Returns

      • Example

    • eth_getBlockByHash

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getBlockByNumber

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getTransactionByHash

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getTransactionByBlockHashAndIndex

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getTransactionByBlockNumberAndIndex

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getTransactionReceipt

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_pendingTransactions

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getUncleByBlockHashAndIndex

      • Parameters

      • Returns

      • Example

    • eth_getUncleByBlockNumberAndIndex

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getCompilers (DEPRECATED)

      • Parameters

      • Returns

      • Example

    • eth_compileSolidity (DEPRECATED)

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_compileLLL (DEPRECATED)

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_compileSerpent (DEPRECATED)

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_newFilter

      • A note on specifying topic filters:

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_newBlockFilter

      • Parameters

      • Returns

      • Example

    • eth_newPendingTransactionFilter

      • Parameters

      • Returns

      • Example

    • eth_uninstallFilter

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getFilterChanges

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getFilterLogs

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getLogs

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getWork

      • Parameters

      • Returns

      • Example

    • eth_submitWork

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_submitHashrate

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • eth_getProof

      • getProof-Parameters

      • Example Parameters

      • getProof-Returns

      • getProof-Example

    • db_putString

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • db_getString

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • db_putHex

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • db_getHex

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_version

      • Parameters

      • Returns

      • Example

    • shh_post

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_newIdentity

      • Parameters

      • Returns

      • Example

    • shh_hasIdentity

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_newGroup

      • Parameters

      • Returns

      • Example

    • shh_addToGroup

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_newFilter

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_uninstallFilter

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_getFilterChanges

      • Parameters

      • Example Parameters

      • Returns

      • Example

    • shh_getMessages

      • Parameters

      • Example Parameters

      • Returns

      • Example

JSON RPC API

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 a 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.

JavaScript API

See the JavaScript API for more.

JSON-RPC Endpoint

Default JSON-RPC endpoints:

Client	URL
Go	http://localhost:20636

Go

You can start the HTTP JSON-RPC with the --rpc flag

geth --rpc

change the default port (20636) and listing address (localhost) with:

geth --rpc --rpcaddr <ip> --rpcport <portnumber> --spvmoniaddr <configure SPV module monitoring ela chain address> --black.contract.address <configure block contract address> --pass.balance <configure oracle contract account balance>
                                                    

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"

HEX value encoding

At present, there are two key datatypes that are passed over JSON: unformatted byte arrays and quantities. Both are passed with a Hhex EX 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:

• 0x41 (65 in decimal)

• 0x400 (1024 in decimal)

• WRONG: 0x (should always have at least one digit - zero is "0x0")

• WRONG: 0x0400 (no leading zeroes allowed)

• WRONG: ff (must be prefixed 0x)

When encoding UNFORMATTED DATA (byte arrays, account addresses, hashes, bytecode arrays): encode as hex, prefix with "0x", two hex digits per byte. Here are some examples:

• 0x41 (size 1, "A")

• 0x004200 (size 3, "\0B\0")

• 0x (size 0, "")

• WRONG: 0xf0f0f (must be even number of digits)

• WRONG: 004200 (must be prefixed 0x)

The default block parameter

The following methods have an extra default block parameter:

• eth_getBalance

• eth_getCode

• eth_getTransactionCount

• eth_getStorageAt

• eth_call

The following options are possible for the defaultBlock parameter:

• HEX String - an integer block number

• String "earliest" for the earliest/genesis block

• String "latest" - for the latest mined block

• String "pending" - for the pending state/transactions

Curl Examples Explained

The curl options below might return a response where the node complains about the content type. This is because the --data option sets the content type to application/x-www-form-urlencoded . If your node does complain, manually set the header by placing -H "Content-Type: application/json" at the start of the call.

The examples also don't include the URL/IP & port combination, which must be the last argument given to curl e.x. 127.0.0.1:20636

JSON-RPC methods

• web3_clientVersion

• web3_sha3

• net_version

• net_peerCount

• net_listening

• eth_protocolVersion

• eth_syncing

• eth_coinbase

• eth_mining

• eth_hashrate

• eth_gasPrice

• eth_accounts

• eth_blockNumber

• eth_getBalance

• eth_getStorageAt

• eth_getTransactionCount

• eth_getBlockTransactionCountByHash

• eth_getBlockTransactionCountByNumber

• eth_getUncleCountByBlockHash

• eth_getUncleCountByBlockNumber

• eth_getCode

• eth_sign

• eth_sendTransaction

• eth_sendRawTransaction

• eth_call

• eth_estimateGas

• eth_getBlockByHash

• eth_getBlockByNumber

• eth_getTransactionByHash

• eth_getTransactionByBlockHashAndIndex

• eth_getTransactionByBlockNumberAndIndex

• eth_getTransactionReceipt

• eth_pendingTransactions

• eth_getUncleByBlockHashAndIndex

• eth_getUncleByBlockNumberAndIndex

• eth_getCompilers

• eth_compileLLL

• eth_compileSolidity

• eth_compileSerpent

• eth_newFilter

• eth_newBlockFilter

• eth_newPendingTransactionFilter

• eth_uninstallFilter

• eth_getFilterChanges

• eth_getFilterLogs

• eth_getLogs

• eth_getWork

• eth_submitWork

• eth_submitHashrate

• eth_getProof

• db_putString

• db_getString

• db_putHex

• db_getHex

• shh_post

• shh_version

• shh_newIdentity

• shh_hasIdentity

• shh_newGroup

• shh_addToGroup

• shh_newFilter

• shh_uninstallFilter

• shh_getFilterChanges

• shh_getMessages

JSON RPC API Reference

---

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

1. 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.

• "1": Elastos.ELA.SideChain.ETH Mainnet

• "2": Morden Testnet (deprecated)

• "3": Ropsten Testnet

• "4": Rinkeby Testnet

• "42": Kovan Testnet

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
}

---

Parameters

none

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_blockNumber

• highestBlock: 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

1. DATA, 20 Bytes - address to check for balance.

2. QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the default block parameter

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

1. DATA, 20 Bytes - address of the storage.

2. QUANTITY - integer of the position in the storage.

3. QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the default block parameter

Returns

DATA - the value at this storage position.

Example

Calculating the correct position depends on the storage to retrieve. Consider the following contract deployed at 0x295a70b2de5e3953354a6a8344e616ed314d7251 by address 0x391694e7e0b0cce554cb130d723a9d27458f9298.

contract Storage {
    uint pos0;
    mapping(address => uint) pos1;
    
    function Storage() {
        pos0 = 1234;
        pos1[msg.sender] = 5678;
    }
}

Retrieving the value of pos0 is straightforward:

curl -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}' localhost:20636

{"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:20636

{"jsonrpc":"2.0","id":1,"result":"0x000000000000000000000000000000000000000000000000000000000000162e"}

---

eth_getTransactionCount returns the number of transactions sent from an address.

Parameters

1. DATA, 20 Bytes - address.

2. QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the default block parameter

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

1. DATA, 32 Bytes - hash of a block.

Example Parameters

params: [
   '0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238'
]

Returns

QUANTITY - integer of the number of transactions in this block.

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

1. 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

1. 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

1. 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

1. DATA, 20 Bytes - address.

2. QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the default block parameter.

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"
}

---

Parameters

account, message

1. DATA, 20 Bytes - address.

2. 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"
}

An example of how to use solidity ecrecover to verify the signature calculated with eth_sign can be found here. The contract is deployed on the testnet: Ropsten and Rinkeby.

---

eth_sendTransaction

Creates a new message call transaction or a contract creation, if the data field contains code.

Parameters

1. Object - The transaction object

• from: 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: 90000) 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 paid gas

• value: QUANTITY - (optional) Integer of the value sent with this transaction

• nonce: 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

1. 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

1. Object - The transaction call object

• from: DATA, 20 Bytes - (optional) Tdhe 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 gas

• value: QUANTITY - (optional) Integer of the value sent with this transaction

1. QUANTITY|TAG - integer block number, or the string "latest", "earliest" or "pending", see the default block parameter

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"
}

---

eth_estimateGas

Generates and returns an estimate of how much gas is necessary to allow the transaction to completed. 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 (Ethereum Virtual Machine) mechanics and node performance.

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 execute 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

1. DATA, 32 Bytes - Hash of a block.

2. Boolean - If true it returns the full transaction objects, if false 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.

• 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
    "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

1. QUANTITY|TAG - integer of a block number, or the string "earliest", "latest" or "pending", as in the default block parameter.

2. Boolean - If true it returns the full transaction objects; if false only the hashes of the transactions.

Example Parameters

params: [
   '0x1b4', // 436
   true
]

Returns

See eth_getBlockByHash

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

1. 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 id

• r: QUANTITY - ECDSA signature r

• s: 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 index position.

Parameters

1. DATA, 32 Bytes - hash of a block.

2. QUANTITY - integer of the transaction index position.

Example Parameters

params: [
   '0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331',
   '0x0' // 0
]

Returns

See eth_getTransactionByHash

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 index position.

Parameters

1. QUANTITY|TAG - a block number, or the string "earliest", "latest" or "pending", as in the default block parameter.

2. QUANTITY - the transaction index position.

Example Parameters

params: [
   '0x29c', // 668
   '0x0' // 0
]

Returns

See eth_getTransactionByHash

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 its hash.

Please note: The receipt is not available for pending transactions.

Parameters

1. 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 - transaction hash.

• 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, otherwise null.

• logs: Array - Array of log objects, which this transaction generated.

• logsBloom: DATA, 256 Bytes - Bloom filter for light clients to quickly retrieve related logs.

It also returns either:

• root : DATA 32 bytes of post-transaction stateroot (pre Byzantium)

• status: QUANTITY either 1 (success) or 0 (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'
  }
}

---

eth_pendingTransactions

Returns the list of pending transactions.

Parameters

None

Returns

Array - A list of pending transactions.

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' 
   },....,{ 
    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' 
   }]
}

---

eth_getUncleByBlockHashAndIndex

Returns information about a uncle of a block by hash and uncle index position.

Parameters

1. DATA, 32 Bytes - hash a block.

2. QUANTITY - the uncle's index position.

params: [
   '0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b',
   '0x0' // 0
]

Returns

See eth_getBlockByHash

Example

// 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.

eth_getUncleByBlockNumberAndIndex

Returns information about a uncle of a block by number and uncle index position.

Parameters

1. QUANTITY|TAG - a block number, or the string "earliest", "latest" or "pending", as in the default block parameter.

2. QUANTITY - the uncle's index position.

Example Parameters

params: [
   '0x29c', // 668
   '0x0' // 0
]

Returns

See eth_getBlockByHash

Note: An uncle doesn't contain individual transactions.

Example

// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'

Result see eth_getBlockByHash

---

eth_getCompilers (DEPRECATED)

Returns a list of available compilers in the client.

Parameters

None

Returns

Array - Array of available compilers.

Example

// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getCompilers","params":[],"id":1}'

// Result
{
  "id":1,
  "jsonrpc": "2.0",
  "result": ["solidity", "lll", "serpent"]
}

---

eth_compileSolidity (DEPRECATED)

Returns compiled solidity code.

Parameters

1. String - The source code.

Example Parameters

params: [
   "contract test { function multiply(uint a) returns(uint d) {   return a * 7;   } }",
]

Returns

DATA - The compiled source code.

Example

// 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"<