#JSON-RPC API

JSON-RPC methods and namespaces supported on OKBC.

#Mainnet (chain-id: 0xC4, 196 in decimal)

https://okbrpc.okbchain.org/

#Testnet (chain-id: 0xC3, 195 in decimal)

https://okbtestrpc.okbchain.org/

#3rd Party Provider

Currently there is no 3rd party provider for OKBC RPC. However, you can set up your RPC node based on our hardware requirement.

#Pre-requisite Readings

#Start HTTP JSON-RPC

We recommend you start the HTTP JSON-RPC with curl.

## mainnet
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' -H "Content-Type: application/json" https://okbrpc.okbchain.org/

## testnet
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' -H "Content-Type: application/json" https://okbtestrpc.okbchain.org/

Moreover, you also can start the HTTP JSON-RPC with geth. For getting geth you can download or building with source self.

## mainnet
geth attach https://okbrpc.okbchain.org/

## testnet
geth attach https://okbtestrpc.okbchain.org/

#JSON-RPC Methods

MethodNamespaceIf supported by OKBCNotes
web3_clientVersionWeb3supportedGet the web3 client version.
web3_sha3Web3supportedReturns Keccak-256 (not the standardized SHA3-256) of the given data.
net_versionNetsupportedReturns the current network id.
net_peerCountNetnot supported-
net_listeningNetnot supported-
eth_protocolVersionEthsupportedReturns the current ethereum protocol version.
eth_syncingEthsupportedThe sync status object may need to be different depending on the details of Tendermint's sync protocol.
eth_gasPriceEthsupportedReturns the current gas price in OKB.
eth_accountsEthsupportedReturns array of all eth accounts.
eth_blockNumberEthsupportedReturns the current block height.
eth_chainIdEthsupportedReturns the chain's identifier in hex format.
eth_getBalanceEthsupportedReturns the account balance for a given account address and Block Number.
eth_getStorageAtEthsupportedReturns the storage address for a given account address.
eth_getTransactionCountEthsupportedReturns the total transaction for a given account address and Block Number.
eth_getBlockTransactionCountByNumberEthsupportedReturns the total transaction count for a given block number.
eth_getBlockTransactionCountByHashEthsupportedReturns the total transaction count for a given block hash.
eth_getCodeEthsupportedReturns the code for a given account address and Block Number.
eth_signEthsupportedThe sign method calculates an Ethereum specific signature.
eth_sendTransactionEthsupportedSends transaction from given account to a given account.
eth_sendRawTransactionEthsupportedCreates new message call transaction or a contract creation for signed transactions.
eth_callEthsupportedExecutes a new message call immediately without creating a transaction on the block chain.
eth_estimateGasEthsupportedReturns an estimate value of the gas required to send the transaction.
eth_getBlockByNumberEthsupportedReturns information about a block by block number.
eth_getBlockByHashEthsupportedReturns the block info given the hash found in the command above and a bool.
eth_getTransactionByHashEthsupportedReturns transaction details given the ethereum tx something.
eth_getTransactionByBlockHashAndIndexEthsupportedReturns transaction details given the block hash and the transaction index.
eth_getTransactionReceiptEthsupportedReturns the receipt of a transaction by transaction hash.
eth_newFilterEthsupportedCreate new filter using topics of some kind.
eth_newBlockFilterEthsupportedCreates a filter in the node, to notify when a new block arrives.
eth_newPendingTransactionFilterEthsupportedCreates a filter in the node, to notify when new pending transactions arrive.
eth_uninstallFilterEthsupportedRemoves the filter with the given filter id.
eth_getFilterChangesEthsupportedPolling method for a filter, which returns an array of logs which occurred since last poll.
eth_getLogsEthsupportedReturns an array of all logs matching a given filter object.
eth_getFilterLogsEthsupportedReturns an array of all logs matching filter with given id.
eth_getTransactionLogsEthsupportedReturns the logs with given a transaction hash
eth_getTransactionbyBlockNumberAndIndexEthsupportedReturn transaction details by block height and block index.
eth_getWorkEthnot supported-
eth_submitWorkEthnot supported-
eth_submitHashrateEthnot supported-
eth_getCompilersEthnot supported-
eth_compileLLLEthnot supported-
eth_compileSolidityEthnot supported-
eth_compileSerpentEthnot supported-
eth_signTransactionEthnot supported-
eth_miningEthnot supported-
eth_coinbaseEthnot supported-
eth_hashrateEthnot supported-
eth_getUncleCountByBlockHashEthnot supported-
eth_getUncleCountByBlockNumberEthnot supported-
eth_getUncleByBlockHashAndIndexEthnot supported-
eth_getUncleByBlockNumberAndIndexEthnot supported-
eth_subscribeWebsocketsupportedSubscribe using JSON-RPC notifications.
eth_unsubscribeWebsocketsupportedUnsubscribe from an event using the subscription id
personal_importRawKeyPersonalsupportedImports the given unencrypted private key (hex string) into the key store, encrypting it with the passphrase.
personal_listAccountsPersonalsupportedReturns a list of addresses for accounts this node manages.
personal_lockAccountPersonalsupportedRemoves the private key with given address from memory.
personal_newAccountPersonalsupportedGenerates a new private key and stores it in the key store directory.
personal_unlockAccountPersonalsupportedDecrypts the key with the given address from the key store.
personal_sendTransactionPersonalsupportedValidate the given passphrase and submit transaction.
personal_signPersonalsupportedThe sign method calculates an Ethereum specific signature.
personal_ecRecoverPersonalsupportedecRecover returns the address associated with the private key that was used to calculate the signature in personal_sign.
db_putStringDBnot supported-
db_getStringDBnot supported-
db_putHexDBnot supported-
db_getHexDBnot supported-
shh_postSSHnot supported-
shh_versionSSHnot supported-
shh_newIdentitySSHnot supported-
shh_hasIdentitySSHnot supported-
shh_newGroupSSHnot supported-
shh_addToGroupSSHnot supported-
shh_newFilterSSHnot supported-
shh_uninstallFilterSSHnot supported-
shh_getFilterChangesSSHnot supported-
shh_getMessagesSSHnot supported-
admin_addPeerAdminnot supported-
admin_datadirAdminnot supported-
admin_nodeInfoAdminnot supported-
admin_peersAdminnot supported-
admin_startRPCAdminnot supported-
admin_startWSAdminnot supported-
admin_stopRPCAdminnot supported-
admin_stopWSAdminnot supported-
clique_getSnapshotCliquenot supported-
clique_getSnapshotAtHashCliquenot supported-
clique_getSignersCliquenot supported-
clique_proposalsCliquenot supported-
clique_proposeCliquenot supported-
clique_discardCliquenot supported-
clique_statusCliquenot supported-
debug_backtraceAtDebugnot supported-
debug_blockProfileDebugnot supported-
debug_cpuProfileDebugnot supported-
debug_dumpBlockDebugnot supported-
debug_gcStatsDebugnot supported-
debug_getBlockRlpDebugnot supported-
debug_goTraceDebugnot supported-
debug_memStatsDebugnot supported-
debug_seedHashDebugnot supported-
debug_setHeadDebugnot supported-
debug_setBlockProfileRateDebugnot supported-
debug_stacksDebugnot supported-
debug_startCPUProfileDebugnot supported-
debug_startGoTraceDebugnot supported-
debug_stopCPUProfileDebugnot supported-
debug_stopGoTraceDebugnot supported-
debug_traceBlockDebugnot supported-
debug_traceBlockByNumberDebugnot supported-
debug_traceBlockByHashDebugnot supported-
debug_traceBlockFromFileDebugnot supported-
debug_standardTraceBlockToFileDebugnot supported-
debug_standardTraceBadBlockToFileDebugnot supported-
debug_traceTransactionDebugnot supported-
debug_verbosityDebugnot supported-
debug_vmoduleDebugnot supported-
debug_writeBlockProfileDebugnot supported-
debug_writeMemProfileDebugnot supported-
les_serverInfoLesnot supported-
les_clientInfoLesnot supported-
les_priorityClientInfoLesnot supported-
les_addBalanceLesnot supported-
les_setClientParamsLesnot supported-
les_setDefaultParamsLesnot supported-
les_latestCheckpointLesnot supported-
les_getCheckpointLesnot supported-
les_getCheckpointContractAddressLesnot supported-
miner_getHashrateMinernot supported-
miner_setExtraMinernot supported-
miner_setGasPriceMinernot supported-
miner_startMinernot supported-
miner_stopMinernot supported-
miner_setEtherbaseMinernot supported-
txpool_contentTXPoolsupportedReturns a list of the exact details of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
txpool_inspectTXPoolsupportedReturns a list on text format to summarize all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
txpool_statusTXPoolsupportedReturns the number of transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.

Below is a list of the RPC methods, the parameters and an example response from the namespaces.

#Web3 Methods

#web3_clientVersion

Get the web3 client version.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "web3_clientVersion",
	"params": [],
	"id": 67
}' -H "Content-Type: application/json" http://localhost:8545

// Result
 {"jsonrpc":"2.0","id":1,"result":"Ethermint/0.0.0+/linux/go1.14"}

#web3_sha3

Returns Keccak-256 (not the standardized SHA3-256) of the given data.

#Parameters

  • The data to convert into a SHA3 hash

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "web3_sha3",
	"params": ["0x67656c6c6f20776f726c64"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x1b84adea42d5b7d192fd8a61a85b25abe0757e9a65cab1da470258914053823f"
}

#Net Methods

#net_version

Returns the current network id.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "net_version",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "8"
}

#Eth Methods

#eth_protocolVersion

Returns the current ethereum protocol version.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_protocolVersion",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x3f"
}

#eth_syncing

The sync status object may need to be different depending on the details of Tendermint's sync protocol. However, the 'synced' result is simply a boolean, and can easily be derived from Tendermint's internal sync state.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_syncing",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

#eth_gasPrice

Returns the current gas price in OKB.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_gasPrice",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x0"
}

#eth_accounts

Returns array of all eth accounts.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_accounts",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": ["0x3b7252d007059ffc82d16d022da3cbf9992d2f70", "0xddd64b4712f7c8f1ace3c145c950339eddaf221d", "0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0"]
}

#eth_blockNumber

Returns the current block height.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_blockNumber",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x66"
}

#eth_chainId

Returns the chain's identifier in hex format.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_chainId",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x63"
}

#eth_getBalance

Returns the account balance for a given account address and Block Number.

#Parameters

  • Account Address
  • Block Number

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getBalance",
	"params": ["0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0", "0x0"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x36354d5575577c8000"
}

#eth_getStorageAt

Returns the storage address for a given account address.

#Parameters

  • Account Address
  • Integer of the position in the storage
  • Block Number

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getStorageAt",
	"params": ["0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0", "0", "latest"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x0000000000000000000000000000000000000000000000000000000000000000"
}

#eth_getTransactionCount

Returns the total transaction for a given account address and Block Number.

#Parameters

  • Account Address
  • Block Number

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getTransactionCount",
	"params": ["0x7bf7b17da59880d9bcca24915679668db75f9397", "0x0"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x8"
}

#eth_getBlockTransactionCountByNumber

Returns the total transaction count for a given block number.

#Parameters

  • Block number

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getBlockTransactionCountByNumber",
	"params": ["0x1"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"difficulty": null,
		"extraData": "0x0",
		"gasLimit": "0xffffffff",
		"gasUsed": "0x0",
		"hash": "0x8101cc04aea3341a6d4b3ced715e3f38de1e72867d6c0db5f5247d1a42fbb085",
		"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
		"miner": "0x0000000000000000000000000000000000000000",
		"nonce": null,
		"number": "0x17d",
		"parentHash": "0x70445488069d2584fea7d18c829e179322e2b2185b25430850deced481ca2e77",
		"sha3Uncles": null,
		"size": "0x1df",
		"stateRoot": "0x269bb17fe7adb8dd5f15f57b717979f82078d6b7a675c1ba1b0da2d27e415fcc",
		"timestamp": "0x5f5ba97c",
		"totalDifficulty": null,
		"transactions": [],
		"transactionsRoot": "0x",
		"uncles": []
	}
}

#eth_getBlockTransactionCountByHash

Returns the total transaction count for a given block hash.

#Parameters

  • Block Hash

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getBlockTransactionCountByHash",
	"params": ["0x8101cc04aea3341a6d4b3ced715e3f38de1e72867d6c0db5f5247d1a42fbb085"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x3"
}

#eth_getCode

Returns the code for a given account address and Block Number.

#Parameters

  • Account Address
  • Block Number

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getCode",
	"params": ["0x7bf7b17da59880d9bcca24915679668db75f9397", "0x0"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0xef616c92f3cfc9e92dc270d6acff9cea213cecc7020a76ee4395af09bdceb4837a1ebdb5735e11e7d3adb6104e0c3ac55180b4ddf5e54d022cc5e8837f6a4f971b"
}

#eth_getFilterLogs

Returns an array of all logs matching filter with given id.

#Parameters

  • The filter id

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getFilterLogs",
	"params": ["0xfe704947a3cd3ca12541458a4321c869"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": [{
		"address": "0xb5a5f22694352c15b00323844ad545abb2b11028",
		"blockHash": "0x99e8663c7b6d8bba3c7627a17d774238eae3e793dee30008debb2699666657de",
		"blockNumber": "0x5d12ab",
		"data": "0x0000000000000000000000000000000000000000000000a247d7a2955b61d000",
		"logIndex": "0x0",
		"removed": false,
		"topics": ["0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x000000000000000000000000bdc0afe57b8e9468aa95396da2ab2063e595f37e", "0x0000000000000000000000007503e090dc2b64a88f034fb45e247cbd82b8741e"],
		"transactionHash": "0xa74c2432c9cf7dbb875a385a2411fd8f13ca9ec12216864b1a1ead3c99de99cd",
		"transactionIndex": "0x3"
	}]
}

#eth_getTransactionLogs

Returns the logs with given a transaction hash

#Parameters

  • Hash of a transaction

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getTransactionLogs",
	"params": ["0x4a9e7c5ec484c1cb854d2831ff51f66f2771e8143362aa75c84f0c6544048fba"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 2233,
	"result": [{
		"address": "0x9ea0eff7153cebbdd18c2ca3bad818e29e556ba7",
		"topics": ["0x7ac369dbd14fa5ea3f473ed67cc9d598964a77501540ba6751eb0b3decf5870d"],
		"data": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f4ffabb197396c7f48c9cd47ec462b54ed9ce84c",
		"blockNumber": "0x25b",
		"transactionHash": "0x4a9e7c5ec484c1cb854d2831ff51f66f2771e8143362aa75c84f0c6544048fba",
		"transactionIndex": "0x0",
		"blockHash": "0x77abadf9e4ad688212a70260244987f6623b54b56ea737a2cfbc7e7a6344eddc",
		"logIndex": "0x0",
		"removed": false
	}]
}

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

#Parameters

  • Account Address
  • Message to sign

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_sign",
	"params": ["0x3b7252d007059ffc82d16d022da3cbf9992d2f70", "0xdeadbeaf"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x909809c76ed2a5d38733de39207d0f411222b9b49c64a192bf649cb13f63f37b45acb4f6939facb4f1c277bc70fb00407564140c0f18600ac44388f2c1dfd1dc1b"
}

#eth_sendTransaction

Sends transaction from given account to a given account.

#Parameters

  • Object containing:

    ParameterTypeDescription
    fromDATA20 Bytes, The address the transaction is send from
    toDATA20 Bytes, (optional when creating new contract) The address the transaction is directed to
    gasQUANTITY(optional, default: 90000) Integer of the gas provided for the transaction execution. It will return unused gas.
    gasPriceQUANTITY(optional, default: To-Be-Determined) Integer of the gasPrice used for each paid gas
    valueQUANTITYvalue sent with this transaction
    dataDATAThe compiled code of a contract OR the hash of the invoked method signature and encoded parameters. For details see Ethereum Contract ABI
    nonceQUANTITY(optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_sendTransaction",
	"params": [{
		"from": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70",
		"to": "0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0",
		"value": "0x16345785d8a0000",
		"gasLimit": "0x5208",
		"gasPrice": "0x55ae82600"
	}],
	"id": 1
}'  -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x33653249db68ebe5c7ae36d93c9b2abc10745c80a72f591e296f598e2d4709f6"
}

#eth_sendRawTransaction

Creates new message call transaction or a contract creation for signed transactions.

You can get signed transaction data using the personal_sign method

#Parameters

  • The signed transaction data

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_sendRawTransaction",
	"params": ["0xf9ff74c86aefeb5f6019d77280bbb44fb695b4d45cfe97e6eed7acd62905f4a85034d5c68ed25a2e7a8eeb9baf1b8401e4f865d92ec48c1763bf649e354d900b1c"],
	"id": 1
}'  -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x0000000000000000000000000000000000000000000000000000000000000000"
}

#eth_call

Executes a new message call immediately without creating a transaction on the block chain. The eth_call method can be used to query internal contract state, to execute validations coded into a contract or even to test what the effect of a transaction would be without running it live. The method takes 3 parameters:

  • an unsigned transaction object to execute in read-only mode;
  • the block number to execute the call against;
  • an optional state override-set to allow executing the call against a modified chain state

#Parameters

  • Transaction call object

    The transaction call object is mandatory and contains all the necessary parameters to execute a read-only EVM contract method

    ParameterTypeDescription
    fromDATA20 Bytes - (optional) The address the transaction is sent from.
    toDATA20 Bytes - The address the transaction is directed to.
    gasQUANTITY(optional) Gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
    gasPriceQUANTITY(optional) GasPrice used for each paid gas
    valueQUANTITY(optional) Value sent with this transaction
    dataDATA(optional) Hash of the method signature and encoded parameters. For details see Ethereum Contract ABI in the Solidity documentation
  • Block number

    integer block number, or the string "latest", "earliest" or "pending"

  • State override set (optional)

    The state override set is an optional address-to-state mapping, where each entry specifies some state to be ephemerally overridden prior to executing the call. Each address maps to an object containing:

    ParameterTypeDescription
    balanceQuantityFake balance to set for the account before executing the call.
    nonceQuantityFake nonce to set for the account before executing the call.
    codeBinaryFake EVM bytecode to inject into the account before executing the call.
    stateObjectFake key-value mapping to override all slots in the account storage before executing the call.
    stateDiffObjectFake key-value mapping to override individual slots in the account storage before executing the call.

    The goal of the state override set is manyfold: It can be used by DApps to reduce the amount of contract code needed to be deployed on chain. Code that simply returns internal state or does pre-defined validations can be kept off chain and fed to the node on-demand. It can be used for smart contract analysis by extending the code deployed on chain with custom methods and invoking them. This avoids having to download and reconstruct the entire state in a sandbox to run custom code against. It can be used to debug smart contracts in an already deployed large suite of contracts by selectively overriding some code or state and seeing how execution changes. Specialized tooling will probably be necessary.

#Example

  • eth_call
// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_call",
	"params": [{
		"from": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70",
		"to": "0xddd64b4712f7c8f1ace3c145c950339eddaf221d",
		"gas": "0x5208",
		"gasPrice": "0x55ae82600",
		"value": "0x16345785d8a0000",
		"data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"
	}, "0x0"],
	"id": 1
}'  -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x"
}
  • eth_call with override set
// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_call",
	"params": [{
		"from": "0xbbE4733d85bc2b90682147779DA49caB38C0aA1F",
		"to": "0x45dD91b0289E60D89Cec94dF0Aac3a2f539c514b",
		"data": "0xf8b2cb4f000000000000000000000000bbe4733d85bc2b90682147779da49cab38c0aa1f",
		"gas": "0x520800",
		"gasPrice": "0x55ae82600"
	}, "latest", {
		"0x45dD91b0289E60D89Cec94dF0Aac3a2f539c514b": {
			"balance": "0x3e8000",
			"code": "0x608060405234801561001057600080fd5b506004361061004c5760003560e01c80632e64cec1146100515780634cd8de131461006f5780636057361d1461009f578063f8b2cb4f146100bb575b600080fd5b6100596100eb565b604051610066919061025a565b60405180910390f35b61008960048036038101906100849190610196565b6100f4565b6040516100969190610238565b60405180910390f35b6100b960048036038101906100b491906101c3565b610130565b005b6100d560048036038101906100d09190610196565b61014b565b6040516100e2919061025a565b60405180910390f35b60008054905090565b60608173ffffffffffffffffffffffffffffffffffffffff16803b806020016040519081016040528181526000908060200190933c9050919050565b806000808282546101419190610291565b9250508190555050565b60008173ffffffffffffffffffffffffffffffffffffffff16319050919050565b60008135905061017b8161039b565b92915050565b600081359050610190816103b2565b92915050565b6000602082840312156101ac576101ab610385565b5b60006101ba8482850161016c565b91505092915050565b6000602082840312156101d9576101d8610385565b5b60006101e784828501610181565b91505092915050565b60006101fb82610275565b6102058185610280565b9350610215818560208601610323565b61021e8161038a565b840191505092915050565b61023281610319565b82525050565b6000602082019050818103600083015261025281846101f0565b905092915050565b600060208201905061026f6000830184610229565b92915050565b600081519050919050565b600082825260208201905092915050565b600061029c82610319565b91506102a783610319565b9250827fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff038211156102dc576102db610356565b5b828201905092915050565b60006102f2826102f9565b9050919050565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b60005b83811015610341578082015181840152602081019050610326565b83811115610350576000848401525b50505050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b600080fd5b6000601f19601f8301169050919050565b6103a4816102e7565b81146103af57600080fd5b50565b6103bb81610319565b81146103c657600080fd5b5056fea26469706673582212202f99901e5c26c9c389fef67564f7c7b71316025fe9346120d3b01d4b7066034364736f6c63430008070033",
			"state": {
				"0x0000000000000000000000000000000000000000000000000000000000000000": "0x0000000000000000000000000000000000000000000000000000000000000007"
			}
		},
		"0xbbE4733d85bc2b90682147779DA49caB38C0aA1F": {
			"balance": "0x3e8000"
		}
	}],
	"id": 1
}'  -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x00000000000000000000000000000000000000000000000000000000003e8000"
}

#eth_estimateGas

Returns an estimate value of the gas required to send the transaction.

#Parameters

  • Object containing:

    ParameterTypeDescription
    fromDATA20 Bytes - The address the transaction is send from.
    toDATA20 Bytes - (optional when creating new contract) The address the transaction is directed to.
    valueQUANTITYvalue sent with this transaction

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_estimateGas",
	"params": [{
		"from": "0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0",
		"to": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70",
		"value": "0x16345785d8a00000"
	}],
	"id": 1
}'  -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x1199b"
}

#eth_getBlockByNumber

Returns information about a block by block number.

#Parameters

  • Block Number
  • If true it returns the full transaction objects, if false only the hashes of the transactions.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getBlockByNumber",
	"params": ["0x1", false],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"difficulty": null,
		"extraData": "0x0",
		"gasLimit": "0xffffffff",
		"gasUsed": null,
		"hash": "0xabac6416f737a0eb54f47495b60246d405d138a6a64946458cf6cbeae0d48465",
		"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
		"miner": "0x0000000000000000000000000000000000000000",
		"nonce": null,
		"number": "0x1",
		"parentHash": "0x",
		"sha3Uncles": null,
		"size": "0x9b",
		"stateRoot": "0x",
		"timestamp": "0x5f5bd3e5",
		"totalDifficulty": null,
		"transactions": [],
		"transactionsRoot": "0x",
		"uncles": []
	}
}

#eth_getBlockByHash

Returns the block info given the hash found in the command above and a bool.

#Parameters

  • Hash of a block.
  • If true it returns the full transaction objects, if false only the hashes of the transactions.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getBlockByHash",
	"params": ["0x1b9911f57c13e5160d567ea6cf5b545413f96b95e43ec6e02787043351fb2cc4", false],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"difficulty": null,
		"extraData": "0x0",
		"gasLimit": "0xffffffff",
		"gasUsed": null,
		"hash": "0x1b9911f57c13e5160d567ea6cf5b545413f96b95e43ec6e02787043351fb2cc4",
		"logsBloom": "0x00000000100000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000040000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000002000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000",
		"miner": "0x0000000000000000000000000000000000000000",
		"nonce": null,
		"number": "0xc",
		"parentHash": "0x404e58f31a9ede1b614b98701d6b0fbf1450f186842dbcf6426dd16811a5ca0d",
		"sha3Uncles": null,
		"size": "0x307",
		"stateRoot": "0x599ccdb111fc62c6398dc39be957df8e97bf8ab72ce6c06ff10641a92b754627",
		"timestamp": "0x5f5fdbbd",
		"totalDifficulty": null,
		"transactions": ["0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea615"],
		"transactionsRoot": "0x4764dba431128836fa919b83d314ba9cc000e75f38e1c31a60484409acea777b",
		"uncles": []
	}
}

#eth_getTransactionByHash

Returns transaction details given the ethereum tx something.

#Parameters

  • hash of a transaction

#Example

// Request
curl -H "Content-Type:application/json" -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getTransactionByHash",
	"params": ["0xec5fa15e1368d6ac314f9f64118c5794f076f63c02e66f97ea5fe1de761a8973"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"blockHash": "0x7a7398cc11d9c4c8e6f53e0c73824297aceafdab62db9e4b867a0da694384864",
		"blockNumber": "0x188",
		"from": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70",
		"gas": "0x147ee",
		"gasPrice": "0x3b9aca00",
		"hash": "0xec5fa15e1368d6ac314f9f64118c5794f076f63c02e66f97ea5fe1de761a8973",
		"input": "0x6dba746c",
		"nonce": "0x18",
		"to": "0xa655256f589060437e5ffe2246dec385d040f148",
		"transactionIndex": "0x0",
		"value": "0x0",
		"v": "0xa96",
		"r": "0x6db399d694a452fb4106419140a6e5dbbe6817743a0f6f695a651e6576e59a5e",
		"s": "0x25dd6ab1f936d0280d2fed0caeb0ebe5b9a46de6d8cb08ad8fd2c88deb55fc31"
	}
}

#eth_getTransactionByBlockHashAndIndex

Returns transaction details given the block hash and the transaction index.

#Parameters

  • Hash of a block.
  • Transaction index position.

#Example

// Request
curl -H "Content-Type:application/json" -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getTransactionByBlockHashAndIndex",
	"params": ["0x1b9911f57c13e5160d567ea6cf5b545413f96b95e43ec6e02787043351fb2cc4", "0x0"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"blockHash": "0x1b9911f57c13e5160d567ea6cf5b545413f96b95e43ec6e02787043351fb2cc4",
		"blockNumber": "0xc",
		"from": "0xddd64b4712f7c8f1ace3c145c950339eddaf221d",
		"gas": "0x4c4b40",
		"gasPrice": "0x3b9aca00",
		"hash": "0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea615",
		"input": "0x4f2be91f",
		"nonce": "0x0",
		"to": "0x439c697e0742a0ddb124a376efd62a72a94ac35a",
		"transactionIndex": "0x0",
		"value": "0x0",
		"v": "0xa96",
		"r": "0xced57d973e58b0f634f776d57daf41d3d3387ceb347a3a72ca0746e5ec2b709e",
		"s": "0x384e89e209a5eb147a2bac3a4e399507400ac7b29cd155531f9d6203a89db3f2"
	}
}

#eth_getTransactionReceipt

Returns the receipt of a transaction by transaction hash.

#Parameters

  • Hash of a transaction

#Example

// Request
curl -H "Content-Type:application/json" -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getTransactionReceipt",
	"params": ["0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea614"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"blockHash": "0x1b9911f57c13e5160d567ea6cf5b545413f96b95e43ec6e02787043351fb2cc4",
		"blockNumber": "0xc",
		"contractAddress": "0x0000000000000000000000000000000000000000",
		"cumulativeGasUsed": null,
		"from": "0xddd64b4712f7c8f1ace3c145c950339eddaf221d",
		"gasUsed": "0x5289",
		"logs": [{
			"address": "0x439c697e0742a0ddb124a376efd62a72a94ac35a",
			"topics": ["0x64a55044d1f2eddebe1b90e8e2853e8e96931cefadbfa0b2ceb34bee36061941"],
			"data": "0x0000000000000000000000000000000000000000000000000000000000000002",
			"blockNumber": "0xc",
			"transactionHash": "0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea615",
			"transactionIndex": "0x0",
			"blockHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
			"logIndex": "0x0",
			"removed": false
		}, {
			"address": "0x439c697e0742a0ddb124a376efd62a72a94ac35a",
			"topics": ["0x938d2ee5be9cfb0f7270ee2eff90507e94b37625d9d2b3a61c97d30a4560b829"],
			"data": "0x0000000000000000000000000000000000000000000000000000000000000002",
			"blockNumber": "0xc",
			"transactionHash": "0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea615",
			"transactionIndex": "0x0",
			"blockHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
			"logIndex": "0x1",
			"removed": false
		}],
		"logsBloom": "0x00000000100000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000040000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000002000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000",
		"status": "0x1",
		"to": "0x439c697e0742a0ddb124a376efd62a72a94ac35a",
		"transactionHash": "0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea615",
		"transactionIndex": "0x0"
	}
}

#eth_newFilter

Create new filter using topics of some kind.

#Parameters

  • hash of a transaction

#Example

// Request
curl -H "Content-Type:application/json" -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_newFilter",
	"params": [{
		"topics": ["0x0000000000000000000000000000000000000000000000000000000012341234"]
	}],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0xdc714a4a2e3c39dc0b0b84d66a3ccb00"
}

#eth_newBlockFilter

Creates a filter in the node, to notify when a new block arrives.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_newBlockFilter",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x3503de5f0c766c68f78a03a3b05036a5"
}

#eth_newPendingTransactionFilter

Creates a filter in the node, to notify when new pending transactions arrive.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_newPendingTransactionFilter",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x9daacfb5893d946997d3801ea18e9902"
}

#eth_uninstallFilter

Removes the filter with the given filter id. Returns true if the filter was successfully uninstalled, otherwise false.

#Parameters

  • The filter id

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_uninstallFilter",
	"params": ["0xb91b6608b61bf56288a661a1bd5eb34a"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

#eth_getFilterChanges

Polling method for a filter, which returns an array of logs which occurred since last poll.

#Parameters

  • The filter id

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getFilterChanges",
	"params": ["0x127e9eca4f7751fb4e5cb5291ad8b455"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": ["0xc6f08d183a81e149896fc5317c872f9092068e88e956ca1864e9bd4c81c09b44", "0x3ca6dfb5be15549d721d1b3d10c1bec50ed6217c9ac7b61df361fac9692a27e5", "0x776fffac134171acb1ebf2e59856625501ad5ccc5c4c8fe0359e0d4dff8919f2", "0x84123103704dbd738c089276ab2b04b5936330b24f6e78453c4ba8bf4848aaf9", "0xffddbe5bd8e8aa41e44002daa9ea89ade9e6980a0d83f51d104cf16498827eca", "0x53430e49963e8ae32605d8f22dec2e757a691e6436d593854ca4d9383eeab86a", "0x975948058c9351a91fbec332ca00dda39d1a919f5f16b996a4c7e30c38ba423b", "0x619e37e32024c8efef7f7220e6caff4ee1d682ea78b2ac91e0a6b30850dc0677", "0x31a5d985a40d08303ac68000ce008df512bcd1a911c497415c97f0624b4a271a", "0x91dcf1fce4503a8dbb3e6fb61073f25cd31d69c766ecba639fefde4436e59d07", "0x606d9e0143cfdb410a6812c590a8135b5c6b5c59eec26d760d5cd930aa47257d", "0xd3c00b859b29b20ba654415eef648ef58251389c73a138580db87675b0d5465f", "0x954391f0eb50888be90489898016ebb54f750f612f3adec2a00854955d5e52d8", "0x698905f06aff921a9e9fcef39b8b0d107747c3e6204d2ea79cf4c12debf8d253", "0x9fcafec5721938a06eb8e2951ede4b6ef8fae54a8c8f85f3166ec9782a0032b5", "0xaec6d3364e47a5716ba69e4705f3c705d017f81298859589591183bfea87be7a", "0x91bf2ee13319b6eaca96ed89c126437b66c4df1b13560c6a9bb18556ee3b7e1f", "0x4f426dc1fc0ea8149052033065b237892d2d34927b2d558ab50c5a7fb98d6e79", "0xdd809fb07e5aab638fef5311371b4e2b27c9c9a6183fde0cdd2b7724f6d2a89b", "0x7e12fc92ab953e233a304959a2a8474d96195e71efd9388fdceb1326a577811a", "0x30618ef6b490c3cc9979c47163459db37c1a1e0aa5793c56accd417f9d89973b", "0x614609f06ee24bae7408e45895b1a25e6b19a8159aeea7a95c9d1339d9ba286f", "0x115ddc6d533620040791d241f01f1c5ae3d9d1a8f64b15af5e9793e4d9096e22", "0xb7458c9323beeca2cd54f32a6af5671f3cd5a7a251aed9d82bdd6ebe5f56305b", "0x573dd48a5ba7bf4cc3d49597cd7419f75ecc9897258f1ebadebd670446d0d358", "0xcb6670918439f9698413b53f3b5336d82ca4be152fdefaacf45e052fff6262fc", "0xf3fe2a8945abafd269ab97bfdc80b3dbff2202ffdce59a227f952874b966b230", "0x989980707007533cc0840a079f77f261a2e818abae1a1ffd3af02f3fff1d35fd", "0x886b6ae365fec996be8a9a2c31cf4cda97ff8352908be2c83f17abd66ef1591e", "0xfd90df68706ef95a62b317de93d6899a9bd6c80416e42d007f5c30fcdedfce24", "0x7af8491fbb0373886d9032bb74e0ef52ed9e100f260b79bd15f46126b38cbede", "0x91d1e2cd55533cf7dd5de86c9aa73295e811b1279be193d429bbd6ba83810e16", "0x6b65b3128c2104005a04923288fe2aa33a2477a4962bef70532f94cab582f2a7"]
}

#eth_getLogs

Returns an array of all logs matching a given filter object.

#Parameters

  • Object containing:

    ParameterTypeDescription
    fromBlockQUANTITY|TAG(optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
    toBlockQUANTITY|TAG(optional, default: "latest") Integer block number, or "latest" for the last mined block or "pending", "earliest" for not yet mined transactions.
    addressDATA|Array20 Bytes - (optional) Contract address or a list of addresses from which logs should originate.
    topicsArray of DATA(optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with “or” options.
    blockhashDATA(optional, future) With the addition of EIP-234, blockHash will be a new filter option which restricts the logs returned to the single block with the 32-byte hash blockHash. Using blockHash is equivalent to fromBlock = toBlock = the block number with hash blockHash. If blockHash is present in in the filter criteria, then neither fromBlock nor toBlock are allowed.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getLogs",
	"params": [{
		"topics": ["0x775a94827b8fd9b519d36cd827093c664f93347070a554f65e4a6f56cd738898", "0x0000000000000000000000000000000000000000000000000000000000000011"],
		"fromBlock": "latest"
	}],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

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

#eth_getTransactionbyBlockNumberAndIndex

Return transaction details by block height and block index.

  • The filter id

#Example

// Request
curl -H "Content-Type:application/json" -X POST --data '{
	"jsonrpc": "2.0",
	"method": "eth_getTransactionByBlockNumberAndIndex",
	"params": ["0xc", "0x0"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"blockHash": "0x1b9911f57c13e5160d567ea6cf5b545413f96b95e43ec6e02787043351fb2cc4",
		"blockNumber": "0xc",
		"from": "0xddd64b4712f7c8f1ace3c145c950339eddaf221d",
		"gas": "0x4c4b40",
		"gasPrice": "0x3b9aca00",
		"hash": "0xae64961cb206a9773a6e5efeb337773a6fd0a2085ce480a174135a029afea615",
		"input": "0x4f2be91f",
		"nonce": "0x0",
		"to": "0x439c697e0742a0ddb124a376efd62a72a94ac35a",
		"transactionIndex": "0x0",
		"value": "0x0",
		"v": "0xa96",
		"r": "0xced57d973e58b0f634f776d57daf41d3d3387ceb347a3a72ca0746e5ec2b709e",
		"s": "0x384e89e209a5eb147a2bac3a4e399507400ac7b29cd155531f9d6203a89db3f2"
	}
}

#WebSocket Methods

#eth_subscribe

subscribe using JSON-RPC notifications. This allows clients to wait for events instead of polling for them.

It works by subscribing to particular events. The node will return a subscription id. For each event that matches the subscription a notification with relevant data is send together with the subscription id.

#Parameters

  • Subscription Name
  • Optional Arguments

#Example

// Request
{"id": 1, "method": "eth_subscribe", "params": ["newHeads", {"includeTransactions": true}]}

// Result
{
	"jsonrpc": "2.0",
	"result": "0x34da6f29e3e953af4d0c7c58658fd525",
	"id": 1
}

#eth_unsubscribe

Unsubscribe from an event using the subscription id

#Parameters

  • Subscription ID

#Example

// Request
{"id": 1, "method": "eth_unsubscribe", "params": ["0x34da6f29e3e953af4d0c7c58658fd525"]}

// Result
{
	"jsonrpc": "2.0",
	"result": true,
	"id": 1
}

#Personal Methods

#personal_importRawKey

Imports the given unencrypted private key (hex string) into the key store, encrypting it with the passphrase.

Returns the address of the new account.

#Parameters

  • Hex encoded ECDSA key
  • Passphrase

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_importRawKey",
	"params": ["c5bd76cd0cd948de17a31261567d219576e992d9066fe1a6bca97496dec634e2c8e06f8949773b300b9f73fabbbc7710d5d6691e96bcf3c9145e15daf6fe07b9", "the key is this"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

#personal_listAccounts

Returns a list of addresses for accounts this node manages.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_listAccounts",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": ["0x3b7252d007059ffc82d16d022da3cbf9992d2f70", "0xddd64b4712f7c8f1ace3c145c950339eddaf221d", "0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0"]
}

#personal_lockAccount

Removes the private key with given address from memory. The account can no longer be used to send transactions.

#Parameters

  • Account Address

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_lockAccount",
	"params": ["0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

#personal_newAccount

Generates a new private key and stores it in the key store directory. The key file is encrypted with the given passphrase. Returns the address of the new account.

#Parameters

  • Passphrase

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_newAccount",
	"params": ["This is the passphrase"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0xf0e4086ad1c6aab5d42161d5baaae2f9ad0571c0"
}

#personal_unlockAccount

Decrypts the key with the given address from the key store.

Both passphrase and unlock duration are optional when using the JavaScript console. The unencrypted key will be held in memory until the unlock duration expires. If the unlock duration defaults to 300 seconds. An explicit duration of zero seconds unlocks the key until geth exits.

The account can be used with eth_sign and eth_sendTransaction while it is unlocked.

#Parameters

  • Account Address
  • Passphrase
  • Duration

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_unlockAccount",
	"params": ["0x0f54f47bf9b8e317b214ccd6a7c3e38b893cd7f0", "secret passphrase", 30],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

#personal_sendTransaction

Validate the given passphrase and submit transaction.

The transaction is the same argument as for eth_sendTransaction and contains the from address. If the passphrase can be used to decrypt the private key belogging to tx.from the transaction is verified, signed and send onto the network.

#Parameters

  • Object containing:

    ParameterTypeDescription
    fromDATA20 Bytes - The address the transaction is send from.
    toDATA20 Bytes - (optional when creating new contract) The address the transaction is directed to.
    valueQUANTITYvalue sent with this transaction
  • Passphrase

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_sendTransaction",
	"params": [{
		"from": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70",
		"to": "0xddd64b4712f7c8f1ace3c145c950339eddaf221d",
		"value": "0x16345785d8a0000"
	}, "passphrase"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0xd2a31ec1b89615c8d1f4d08fe4e4182efa4a9c0d5758ace6676f485ea60e154c"
}

#personal_sign

The sign method calculates an Ethereum specific signature with: sign(keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))).

#Parameters

  • Message
  • Account Address
  • Password

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_sign",
	"params": ["0xdeadbeaf", "0x3b7252d007059ffc82d16d022da3cbf9992d2f70", "password"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0xf9ff74c86aefeb5f6019d77280bbb44fb695b4d45cfe97e6eed7acd62905f4a85034d5c68ed25a2e7a8eeb9baf1b8401e4f865d92ec48c1763bf649e354d900b1c"
}

#personal_ecRecover

ecRecover returns the address associated with the private key that was used to calculate the signature in personal_sign.

#Parameters

  • Message
  • Signature returned from personal_sign

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "personal_ecRecover",
	"params": ["0xdeadbeaf", "0xf9ff74c86aefeb5f6019d77280bbb44fb695b4d45cfe97e6eed7acd62905f4a85034d5c68ed25a2e7a8eeb9baf1b8401e4f865d92ec48c1763bf649e354d900b1c"],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70"
}

#txpool_content

Returns a list of the exact details of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "txpool_content",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "0x3b7252d007059ffc82d16d022da3cbf9992d2f70"
}

#txpool_inspect

Returns a list on text format to summarize all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only. This is a method specifically tailored to developers to quickly see the transactions in the pool and find any potential issues.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "txpool_inspect",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"queued": {
			"0xbbE4733d85bc2b90682147779DA49caB38C0aA1F": {
				"5": "0x96897899078973b00D49d7d0442287DefF413F49: 0x56bc75e2d63100000 wei + 0x16405 gas × 0x5f5e100 wei"
			}
		}
	}
}

#txpool_status

Returns the number of transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.

#Example

// Request
curl -X POST --data '{
	"jsonrpc": "2.0",
	"method": "txpool_status",
	"params": [],
	"id": 1
}' -H "Content-Type: application/json" http://localhost:8545

// Result
{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"pending": "0x1",
		"queued": "0x2"
	}
}