JSON RPC

IMPORTANT NOTICE (February 2021): Starting from conflux-rust v1.1.1, all hex addresses used in the RPCs below have been updated to base32 addresses, as defined in CIP-37. For converting legacy hex addresses into base32 addresses, please refer to conflux-address-js or use the conversion tool on Conflux Scan.

The Conflux JSON-RPC API is a collection of interfaces that allow you to interact with a local or remote Conflux node. You can use this API through an HTTP, TCP, or WebSocket connection.

The following is an API reference documentation with examples.

JSON-RPC

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 its data format.

JavaScript API

We also provide a JavaScript library js-conflux-sdk for you to interact with a Conflux node from a JavaScript application. This SDK offers a convenient interface on top of the RPC methods.

JSON-RPC endpoints

Currently, Conflux has a Rust implementation that supports JSON-RPC 2.0 over an HTTP, TPC, or WebSocket connection.

If you are a node operator, you can enable and configure various RPC interfaces through the TOML config file, or directly by passing command line arguments. The main configuration items are listed in the table below. Note that if you want to enable HTTPS or access control, you will need to set up a proxy for your node.

config parameter	cli parameter	default port	enabled by default
jsonrpc_ws_port	--jsonrpc-ws-port	12535	no
jsonrpc_tcp_port	--jsonrpc-tcp-port	12536	no
jsonrpc_http_port	--jsonrpc-http-port	12537	no
jsonrpc_local_tcp_port	-	12538	no
jsonrpc_local_http_port	-	12539	yes

The examples in the rest of this document will use the HTTP endpoint.

HEX value encoding

At present, there are two key data types that are passed over JSON: unformatted byte arrays and quantities. While both are encoded as hex strings, they have different formatting requirements:

When encoding QUANTITIES (integers, numbers): encode as hex using the most compact representation and prefix with "0x". 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 (missing 0x prefix)

When encoding UNFORMATTED DATA (byte arrays, hashes, bytecode arrays): encode as hex using two hex digits per byte and prefix with "0x". Examples:

• 0x41 (size 1, "A")
• 0x004200 (size 3, "\0B\0")
• 0x (size 0, "")
• WRONG: 0xf0f0f (must be even number of digits)
• WRONG: 004200 (missing 0x prefix)

Note that block and transaction hashes are represented using 32 bytes.

BASE32: Base32 addresses should be encoded as an ASCII string of 42-characters plus network prefix, separators, and optional fields. Please note the following constraints for base32 addresses as RPC parameters:

• The network-prefix should match the node's network, i.e. cfx:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp can be sent to mainnet nodes and cfxtest:acc7uawf5ubtnmezvhu9dhc6sghea0403ywjz6wtpg can be sent to testnet nodes. Note that these two example addresses correspond to the same account on different networks.
• Including and omitting the address-type are both accepted, i.e. cfx:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg and cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg are equivalent. However, addresses with an incorrect type, e.g. cfx:type.contract:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg, are rejected.
• Both lowercase (cfx:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg) and uppercase (CFX:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG) addresses are accepted. Mixed-case addresses are rejected.

The epoch number parameter

Several RPC methods have an epoch number parameter. The concept of epochs in Conflux is somewhat analogous to the concept of block numbers (height) in other ledgers, but one epoch might contain multiple blocks.

The epoch number specifies a point in time and the corresponding state of the system, subject to consensus. The following options are possible for the epoch number parameter:

• HEX String - an integer epoch number. For example, 0x3e8 is epoch 1000.
• String "earliest" for the epoch of the genesis block.
• String "latest_checkpoint" for the earliest epoch stored in memory.
• String "latest_confirmed" - for the latest confirmed epoch (using the confirmation meter's estimate).
• String "latest_state" - for the latest epoch that has been executed.
• String "latest_mined" - for the latest known epoch.

Please note that due to performance optimization, the latest mined epochs are not executed, so there is no state available for these epochs. For most RPCs related to state query, "latest_state" is recommended.

State and transaction availability

Conflux archive and full nodes remove historical state tries to reduce storage use. Full nodes will also discard transactions and receipts for historical blocks. As a result, some RPC interfaces might be unavailable for historical queries.

Below is a list of the Conflux RPC APIs and their availability on archive and full nodes. "recent" means that the RPC is only supported for recent items, "OK" means that it should work for any valid input.

RPC	archive node	full node
cfx_call	recent	recent
cfx_checkBalanceAgainstTransaction	recent	recent
cfx_clientVersion	OK	OK
cfx_epochNumber	OK	OK
cfx_estimateGasAndCollateral	recent	recent
cfx_gasPrice	OK	OK
cfx_getAccount	recent	recent
cfx_getAccumulateInterestRate	OK	OK
cfx_getAdmin	recent	recent
cfx_getBalance	recent	recent
cfx_getBestBlockHash	OK	OK
cfx_getBlockByEpochNumber	OK	recent
cfx_getBlockByHash	OK	recent
cfx_getBlockByHashWithPivotAssumption	OK	recent
cfx_getBlockRewardInfo	OK	recent
cfx_getBlocksByEpoch	OK	OK
cfx_getCode	recent	recent
cfx_getCollateralForStorage	recent	recent
cfx_getConfirmationRiskByHash	OK	recent
cfx_getDepositList	recent	recent
cfx_getInterestRate	recent	recent
cfx_getLogs	OK	recent
cfx_getNextNonce	recent	recent
cfx_getSkippedBlocksByEpoch	OK	OK
cfx_getSponsorInfo	recent	recent
cfx_getStakingBalance	recent	recent
cfx_getStatus	OK	OK
cfx_getStorageAt	recent	recent
cfx_getStorageRoot	recent	recent
cfx_getTransactionByHash	OK	recent
cfx_getTransactionReceipt	OK	recent
cfx_getVoteList	recent	recent
cfx_sendRawTransaction	OK	OK

If you query a state entry that is unavailable on the node, you will get an error response:

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBalance","params":["cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg", "earliest"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"error": {

"code": -32016,

"message": "Error processing request: State for epoch (number=0 hash=0x24dcc768132dc7f651d7cb35c52e7bba632eda073d8743f81cfe905ff7e4157a) does not exist: out-of-bound StateAvailabilityBoundary { synced_state_height: 0, lower_bound: 9510001, upper_bound: 9569393, optimistic_executed_height: Some(9569392) }"

},

"id": 1

}

In this example, we are told that the earliest available state is at epoch 9510001 (0x911c71).

Migrating from Ethereum JSON-RPC

There is a correspondence between some JSON-RPCs from Ethereum and Conflux. Even though the details of JSON-RPC may differ, the following mapping table could be helpful when migrating from Ethereum to Conflux:

Ethereum	Conflux
eth_blockNumber	cfx_epochNumber
eth_call	cfx_call
eth_estimateGas	cfx_estimateGasAndCollateral
eth_gasPrice	cfx_gasPrice
eth_getBalance	cfx_getBalance
eth_getBlockByHash	cfx_getBlockByHash
eth_getBlockByNumber	cfx_getBlockByEpochNumber
eth_getCode	cfx_getCode
eth_getLogs	cfx_getLogs
eth_getStorageAt	cfx_getStorageAt
eth_getTransactionByHash	cfx_getTransactionByHash
eth_getTransactionCount	cfx_getNextNonce
eth_getTransactionReceipt	cfx_getTransactionReceipt
eth_sendRawTransaction	cfx_sendRawTransaction

JSON-RPC methods

cfx_getTransactionByHash

Returns information about a transaction, identified by its hash.

Parameters

1. DATA, 32 Bytes - hash of a transaction

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 and got executed. null when the transaction is pending.
• chainId: QUANTITY - the chain ID specified by the sender.
• contractCreated: BASE32 - address of the contract created. null when it is not a contract deployment transaction.
• data: DATA - the data sent along with the transaction.
• epochHeight: QUANTITY - the epoch proposed by the sender. Note that this is NOT the epoch of the block containing this transaction.
• from: BASE32 - address of the sender.
• gas: QUANTITY - gas provided by the sender.
• gasPrice: QUANTITY - gas price provided by the sender in Drip.
• hash: DATA, 32 Bytes - hash of the transaction.
• nonce: QUANTITY - the number of transactions made by the sender prior to this one.
• r: DATA, 32 Bytes - ECDSA signature r.
• s: DATA, 32 Bytes - ECDSA signature s.
• status: QUANTITY - 0 for success, 1 if an error occurred, null when the transaction is skipped or not packed.
• storageLimit: QUANTITY - the storage limit specified by the sender.
• to: BASE32 - address of the receiver. null when it is a contract deployment transaction.
• transactionIndex: QUANTITY - the transaction's position in the block. null when the transaction is pending.
• v: QUANTITY - ECDSA recovery id.
• value: QUANTITY - value transferred in Drip.

Note that the fields blockHash, contractCreated, status, and transactionIndex are provided by the node as they depend on the transaction's position within the ledger. The rest of the fields are included in or derived from the original transaction.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getTransactionByHash","params":["0x497755f45baef13a35347933c48c0b8940f2cc3347477b5ed9f165581b082699"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"blockHash": "0x564750c06c7afb10de8beebcf24411cc73439295d5abb1264d2c9b90eee5606f",

"chainId": "0x2",

"contractCreated": null,

"data": "0x0",

"epochHeight": "0x909c9f",

"from": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"gas": "0xf4240",

"gasPrice": "0x174876e800",

"hash": "0x497755f45baef13a35347933c48c0b8940f2cc3347477b5ed9f165581b082699",

"nonce": "0x3b518",

"r": "0x14da6cff1a3cd864b04d1b16f480fa023f449322e318b04bb1109b5754b516ce",

"s": "0x304070abe6488c3532ecb66f4be32b88ee35ce48a4607b8d0c86461987a79fc7",

"status": "0x0",

"storageLimit": "0x100",

"to": "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP",

"transactionIndex": "0x0",

"v": "0x1",

"value": "0x3635c9adc5dea00000"

},

"id": 1

}

---

cfx_getBlockByHash

Returns information about a block, identified by its 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 are returned.

params: [

"0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",

true

]

Returns

Object - A block object, or null when no block was found:

• adaptive: Boolean - true if the weight of the block is adaptive under the GHAST rule.
• blame: QUANTITY - if 0, then this block does not blame any blocks on its parent path. If it is n > 0, then this block blames its n predecessors on its parent path, e.g. when n = 1, then the block blames its parent but not its parent's parent.
• deferredLogsBloomHash: DATA, 32 Bytes - the hash of the logs bloom after deferred execution at the block's epoch (assuming it is the pivot block).
• deferredReceiptsRoot: DATA, 32 Bytes - the Merkle root of the receipts after deferred execution at the block's epoch (assuming it is the pivot block).
• deferredStateRoot: DATA, 32 Bytes - the hash of the state trie root triplet after deferred execution at the block's epoch (assuming it is the pivot block).
• difficulty: QUANTITY - the PoW difficulty of this block.
• epochNumber: QUANTITY - the number of the epoch containing this block in the node's view of the ledger. null when the epoch number is not determined (e.g. the block is not in the best block's past set).
• gasLimit: QUANTITY - the maximum gas allowed in this block.
• gasUsed: QUANTITY - the total gas used in this block. null when the block is pending.
• hash: DATA, 32 Bytes - hash of the block.
• height: QUANTITY - the height of the block.
• miner: BASE32 - the address of the beneficiary to whom the mining rewards were given.
• nonce: DATA, 8 Bytes - hash of the generated proof-of-work.
• parentHash: DATA, 32 Bytes - hash of the parent block.
• powQuality: DATA - the PoW quality. null when the block is pending.
• refereeHashes: Array - array of referee block hashes.
• size: QUANTITY - the size of this block in bytes, excluding the block header.
• timestamp: QUANTITY - the unix timestamp for when the block was created.
• transactions: Array - array of transaction objects, or 32-byte transaction hashes, depending on the second parameter.
• transactionsRoot: DATA, 32 Bytes - the Merkle root of the transactions in this block.

Note that the fields epochNumber and gasUsed are provided by the node as they depend on the ledger. The rest of the fields are included in or derived from the block header directly.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBlockByHash","params":["0x692373025c7315fa18b2d02139d08e987cd7016025920f59ada4969c24e44e06", false],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"adaptive": false,

"blame": 0,

"deferredLogsBloomHash": "0xd397b3b043d87fcd6fad1291ff0bfd16401c274896d8c63a923727f077b8e0b5",

"deferredReceiptsRoot": "0x522717233b96e0a03d85f02f8127aa0e23ef2e0865c95bb7ac577ee3754875e4",

"deferredStateRoot": "0xd449df4ba49f5ab02abf261e976197beecf93c5198a6f0b6bd2713d84115c4ec",

"difficulty": "0xeee440",

"epochNumber": "0x1394cb",

"gasLimit": "0xb2d05e00",

"gasUsed": "0xad5ae8",

"hash": "0x692373025c7315fa18b2d02139d08e987cd7016025920f59ada4969c24e44e06",

"height": "0x1394c9",

"miner": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"nonce": "0x329243b1063c6773",

"parentHash": "0xd1c2ff79834f86eb4bc98e0e526de475144a13719afba6385cf62a4023c02ae3",

"powQuality": "0x2ab0c3513",

"refereeHashes": [

"0xcc103077ede14825a5667bddad79482d7bbf1f1a658fed6894fa0e9287fc6be1"

],

"size": "0x180",

"timestamp": "0x5e8d32a1",

"transactions": [

"0xedfa5b9c38ba51e791cc72b8f75ff758533c8c38f426eddee3fd95d984dd59ff"

],

"transactionsRoot": "0xfb245dae4539ea49812e822adbffa9dd2ee9b3de8f3d9a7d186d351dcc9a6ed4"

},

"id": 1

}

---

cfx_getBlockByEpochNumber

Returns information about a block, identified by its epoch number.

Parameters

1. QUANTITY|TAG - the epoch number, or the string "latest_mined", "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter.
2. Boolean - if true, it returns the full transaction objects. If false, only the hashes of the transactions are returned

params: [

"latest_mined",

true

]

Returns

See cfx_getBlockByHash.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBlockByEpochNumber","params":["latest_mined", false],"id":1}' -H "Content-Type: application/json" localhost:12539

Result see cfx_getBlockByHash.

---

cfx_getBestBlockHash

Returns the hash of the best block.

Parameters

None.

Returns

DATA, 32 Bytes - hash of the best block.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBestBlockHash","id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc" : "2.0",

"result" : "0x7d54c03f4fe971d5c45d95dddc770a0ec8d5bd27d57c049ce8adc469269e35a4",

"id" : 1

}

---

cfx_epochNumber

Returns the epoch number corresponding to the given tag.

Parameters

1. TAG - (optional, default: "latest_mined") String "latest_mined", "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter.

Returns

QUANTITY - the integer epoch number corresponding to the given tag.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_epochNumber","params":["latest_mined"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc" : "2.0",

"result" : "0x49",

"id" : 1

}

---

cfx_gasPrice

Returns the current price per gas in Drip.

Parameters

None.

Returns

QUANTITY - integer of the current gas price in Drip.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_gasPrice","id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc" : "2.0",

"result" : "0x09184e72a000",

"id" : 1

}

---

cfx_getBlocksByEpoch

Returns the block hashes in the specified epoch.

Parameters

1. QUANTITY|TAG - the epoch number, or the string "latest_mined", "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter.

Returns

Array - array of block hashes, sorted by their execution (topological) order. Note that the last one is the pivot hash.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBlocksByEpoch","params":["0x11"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": [

"0x618e813ed93f1020bab13a1ab77e1550da6c89d9c69de837033512e91ac46bd0",

"0x0f6ac81dcbc612e72e0019681bcec32254a34bd29a6bbab91e5e8dc37ecb64d5",

"0xad3238c00456adfbf847d251b004c1e306fe637227bb1b9917d77bd5b207af68",

"0x0f92c2e796be7b016d8b74c6c270fb1851e47fabaca3e464d407544286d6cd34",

"0x5bcc2b8d2493797fcadf7b80228ef5b713eb9ff65f7cdd86562db629d0caf721",

"0x7fcdc6fff506b19a2bd72cd3430310915f19a59b046759bb790ba4eeb95e9956",

"0xf4f33ed08e1c625f4dde608eeb92991d77fff26122bab28a6b3a2037511dcc83",

"0xa3762adc7f066d5cb62c683c2655be3bc3405ff1397f77d2e1dbeff2d8522e00",

"0xba7588476a5ec7e0ade00f060180cadb7430fd1be48940414baac48c0d39556d",

"0xe4dc4541d07118b598b2ec67bbdaa219eb1d649471fe7b5667a0001d83b1e9b6",

"0x93a15564544c57d6cb68dbdf60133b318a94439e1f0a9ccb331b0f5a0aaf8049"

],

"id": 1

}

---

cfx_getBalance

Returns the balance of the given account, identified by its address.

Parameters

1. BASE32 - address to check for balance.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"latest_state"

]

Returns

QUANTITY - integer of the current balance in Drip.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBalance","params":["cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x0234c8a3397aab58", // 158972490234375000

"id": 1

}

---

cfx_getStakingBalance

Returns the stacking balance of the given account, identified by its address.

Parameters

1. BASE32 - address to check for staking balance.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"latest_state"

]

Returns

QUANTITY - integer of the current staking balance in Drip.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getStakingBalance","params":["cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x0234c8a3397aab58", // 158972490234375000

"id": 1

}

---

cfx_getCollateralForStorage

Returns the size of the collateral storage of a given address, in bytes.

Parameters

1. BASE32 - address to check for collateral storage.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"latest_state"

]

Returns

QUANTITY - integer of the collateral storage in Byte.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getCollateralForStorage","params":["cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x0234c8a8",

"id": 1

}

---

cfx_getAdmin

Returns the admin of the specified contract.

Parameters

1. BASE32 - address of the contract.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"latest_state"

]

Returns

BASE32 - address of admin, or null if the contract does not exist.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getAdmin","params":["cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"id": 1

}

---

cfx_getCode

Returns the code of the specified contract.

Parameters

1. BASE32 - address of the contract.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"latest_state"

]

Returns

DATA - byte code of the contract, or 0x if the account has no code. This RPC will raise an error if the account does not exist.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getCode","params":["cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp","latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x6080604052600436106100705760003560e01c80638da5cb5b1161004e5780638da5cb5b14610146578063a035b1fe14610",

"id": 1

}

---

cfx_getStorageAt

Returns storage entries from a given contract.

Parameters

1. BASE32 - address of the contract.
2. DATA, 32 Bytes - a storage position (see here for more info).
3. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9",

"latest_state"

]

Returns

DATA - 32 Bytes - the contents of the storage position, or null if the contract does not exist.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getStorageAt","params":["cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp","0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9","latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x0000000000000000000000001dbda5dd2e952914bc74a802510d0fa59f9d7636",

"id": 1

}

---

cfx_getStorageRoot

Returns the storage root of a given contract.

Parameters

1. BASE32 - address of the contract.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"latest_state"

]

Returns

Object - A storage root object, or null if the contract does not exist:

• delta: DATA, 32 Bytes - the storage root in the delta trie, or the string "TOMBSTONE", or null.
• intermediate: DATA, 32 Bytes - storage root in the intermediate trie, or the string "TOMBSTONE", or null.
• snapshot: DATA, 32 Bytes - storage root in the snapshot, or the string "TOMBSTONE", or null.

If all three of these fields match for two invocations of this RPC, the contract's storage is guaranteed to be identical. If they do not match, storage has likely changed (or the system transitioned into a new era).

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getStorageRoot","params":["cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp","latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"delta": "0x0240a5a3486ac1cee71db22b8e12f1bb6ac9f207ecd81b06031c407663c20a94",

"intermediate": "0x314a41f277b678a1dc811a1fc0393b6d30c35e900cb27762ec9e9042bfdbdd49",

"snapshot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"

},

"id" :1

}

---

cfx_getSponsorInfo

Returns the sponsor info of a given contract.

Parameters

1. BASE32 - address of the contract.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"latest_state"

]

Returns

Object - A sponsor info object. If the contract doesn't have a sponsor, then all fields in the object returned will be 0:

• sponsorBalanceForCollateral: QUANTITY - the sponsored balance for storage.
• sponsorBalanceForGas: QUANTITY - the sponsored balance for gas.
• sponsorGasBound: QUANTITY - the max gas that could be sponsored for one transaction.
• sponsorForCollateral: BASE32 - the address of the storage sponsor.
• sponsorForGas: BASE32 - the address of the gas sponsor.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getSponsorInfo","params":["cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"sponsorBalanceForCollateral": "0x0",

"sponsorBalanceForGas": "0x0",

"sponsorForCollateral": "0x0000000000000000000000000000000000000000",

"sponsorForGas": "0x0000000000000000000000000000000000000000",

"sponsorGasBound": "0x0"

},

"id": 1

}

---

cfx_getNextNonce

Returns the next nonce that should be used by the given account when sending a transaction.

Parameters

1. BASE32 - address of the account.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"latest_state"

]

Returns

QUANTITY - integer of the next nonce that should be used by the given address.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getNextNonce","params":["cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc" : "2.0",

"result" : "0xe3269d",

"id" : 1

}

---

cfx_sendRawTransaction

Sends a signed transaction into the network for processing.

Parameters

1. DATA, the signed transaction data.

params: [

"0xf86eea8201a28207d0830f4240943838197c0c88d0d5b13b67e1bfdbdc132d4842e389056bc75e2d631000008080a017b8b26f473820475edc49bd153660e56b973b5985bbdb2828fceacb4c91f389a03452f9a69da34ef35acc9c554d7b1d63e9041141674b42c3abb1b57b9f83a2d3"

]

Returns

DATA, 32 Bytes - the transaction hash.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_sendRawTransaction","params":[{see above}],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0xf5338a6cb85d10acc9108869f94fe322b2dfa2715d16d264676c91f6a0404b61",

"id": 1

}

---

cfx_call

Virtually calls a contract, returns the output data. The transaction will not be added to the blockchain.

Parameters

1. Object - a call request object:

   • from: BASE32 - (optional, default: random address) address of sender.
   • to: BASE32 - (optional, default: null for contract creation) address of receiver.
   • gasPrice: QUANTITY - (optional, default: 0) gas price provided by the sender in Drip.
   • gas: QUANTITY - (optional, default: 500000000) gas provided by the sender.
   • value: QUANTITY - (optional, default: 0) value transferred in Drip.
   • data: DATA - (optional, default: 0x) the data send along with the transaction.
   • nonce: QUANTITY - (optional, default: 0) the number of transactions made by the sender prior to this one.

2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

{

"from": "cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"to": "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"data": "0xa6f2ae3a",

"gasPrice": "0x2540be400",

"nonce": "0x0"

},

"latest_state"

]

Returns

DATA, Bytes - the output data, or an execution error.

Example

// Request

curl -X POST --data '{"method":"cfx_call","id":1,"jsonrpc":"2.0","params":[{"from":"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg","to":"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp","data":"0xa6f2ae3a","gasPrice":"0x2540be400","nonce":"0x0"}]}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x",

"id": 1

}

---

cfx_estimateGasAndCollateral

Virtually executes a transaction, returns an estimate for the size of storage collateralized and the gas used by the transaction. The transaction will not be added to the blockchain.

Parameters

See cfx_call.

params: [

{

"from": "cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"to": "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"data": "0x",

"gasPrice": "0x2540be400",

"nonce": "0x0"

},

"latest_state"

]

Returns

Object - an estimate result object:

• gasUsed: QUANTITY - gas used during execution.
• storageCollateralized: QUANTITY - size of storage collateralized, in bytes.

Example

// Request

curl -X POST --data '{"method":"cfx_estimateGasAndCollateral","id":1,"jsonrpc":"2.0","params":[{"from":"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg","to":"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp","data":"0x","gasPrice":"0x2540be400","nonce":"0x0"}]}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"gasUsed": "0x5208",

"storageCollateralized": "0x80"

},

"id": 1

}

---

cfx_getLogs

Returns logs matching the filter provided.

Parameters

1. Object - A log filter object:
   • fromEpoch: QUANTITY|TAG - (optional, default: "latest_checkpoint") the epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter. Search will be applied from this epoch number.
   • toEpoch: QUANTITY|TAG - (optional, default: "latest_state") the epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter. Search will be applied up until (and including) this epoch number.
   • blockHashes: Array of DATA - (optional, default: null) Array of up to 128 block hashes that the search will be applied to. This will override from/to epoch fields if it's not null.
   • address: Array of BASE32 - (optional, default: null) Search contract addresses. If null, match all. If specified, the log must be produced by one of these contracts.
   • topics: Array - (optional, default: null) 32-byte earch topics. Logs can have 4 topics: the event signature and up to 3 indexed event arguments. The elements of topics match the corresponding log topics. Example: ["0xA", null, ["0xB", "0xC"], null] matches logs with "0xA" as the 1st topic AND ("0xB" OR "0xC") as the 3rd topic. If null, match all.
   • limit: QUANTITY - (optional, default: null) If null return all logs, otherwise should only return the last limit logs. Note: if the node has get_logs_filter_max_limit set, it will override limit if it is null or greater than the preset value.

params: [

{

"fromEpoch": "0x873e12",

"toEpoch": "0x87431b",

"address": "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"topics": [["0x233e08777131763a85257b15eafc9f96ef08f259653d9944301ff924b3917cf5", "0xd7fb65c06987247ab480a21659e16bdf0b5862a19869ec264075d50ab3525435"], null, "0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26"],

"limit": "0x2"

}

]

Returns

Array - array of log objects corresponding to the matching logs:

• address: BASE32 - address of the contract that emitted the log.
• topics: Array of DATA - array of 32-byte event topics.
• data: DATA - data of log.
• blockHash: DATA - 32 Bytes - hash of the block containing the log.
• epochNumber: QUANTITY - epoch number of the block containing the log.
• transactionHash: DATA, 32 Bytes - hash of the transaction that created the log.
• transactionIndex: QUANTITY - transaction index in the block.
• logIndex: QUANTITY - log index in block.
• transactionLogIndex: QUANTITY - log index in transaction.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getLogs","params":[{ "fromEpoch": "0x873e12", "toEpoch": "0x87431b", "address": "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp", "topics": [["0x233e08777131763a85257b15eafc9f96ef08f259653d9944301ff924b3917cf5", "0xd7fb65c06987247ab480a21659e16bdf0b5862a19869ec264075d50ab3525435"], null, "0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26"], "limit": "0x2" }],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": [{

"address": "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP",

"blockHash": "0x44531df7bad30d39dfaf844e7c7eb44628467e9bd8474d313397c664a1b9fd14",

"data": "0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26",

"epochNumber": "0x873e12",

"logIndex": "0x0",

"topics": [

"0x233e08777131763a85257b15eafc9f96ef08f259653d9944301ff924b3917cf5",

"0x000000000000000000000000873c4bd4d847bcf7dc066bf4a7cd31dcf182258c",

"0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26",

],

"transactionHash": "0x7c2536d287c9ac5445f30ccfa067d1f4a2d68d6843f4ba25a5e6d20349367eb3",

"transactionIndex": "0x0",

"transactionLogIndex": "0x0"

}, {

"address": "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP",

"blockHash": "0x82da9c6ef8a93036ac75b176230dd88c8fe1727104ab01878b54180f0fa25638",

"data": "0x00000000000000000000000019a3224214fe29107d84af9baa02118b614e46d5",

"epochNumber": "0x87431b",

"logIndex": "0x0",

"topics": [

"0xd7fb65c06987247ab480a21659e16bdf0b5862a19869ec264075d50ab3525435",

"0x000000000000000000000000873c4bd4d847bcf7dc066bf4a7cd31dcf182258c",

"0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26",

],

"transactionHash": "0xef11f262e31bc7ead1d0880b7c90855eb8f0ef7c26a198e805f2b9f1e9bc938b",

"transactionIndex": "0x0",

"transactionLogIndex": "0x0"

}],

"id": 1

}

---

cfx_getTransactionReceipt

Returns a transaction receipt, identified by the corresponding transaction hash.

Parameters

1. DATA, 32 Bytes - hash of a transaction

params: [

"0x53fe995edeec7d241791ff32635244e94ecfd722c9fe90f34ddf59082d814514",

]

Returns

Object - a transaction receipt object, or null when no transaction was found or the transaction was not executed yet:

• transactionHash: DATA, 32 Bytes - hash of the given transaction.
• index: QUANTITY - transaction index within the block.
• blockHash: DATA, 32 Bytes - hash of the block where this transaction was in and got executed.
• epochNumber: QUANTITY - epoch number of the block where this transaction was in and got executed.
• from: BASE32 - address of the sender.
• to: BASE32 - address of the receiver. null when it is a contract deployment transaction.
• gasUsed: QUANTITY - gas used for executing the transaction.
• gasFee: QUANTITY - gas charged to the sender's account. If the provided gas (gas limit) is larger than the gas used, at most 1/4 of it is refunded.
• gasCoveredBySponsor: Boolean, true if this transaction's gas fee was covered by the sponsor.
• storageCollateralized: QUANTITY, the amount of storage collateral this transaction required.
• storageCoveredBySponsor: Boolean, true if this transaction's storage collateral was covered by the sponsor.
• storageReleased: Array, array of storage change objects, each specifying an address and the corresponding amount of storage collateral released, e.g., [{ 'address': 'CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG', 'collaterals': '0x280' }]
• contractCreated: BASE32 - address of the contract created. null when it is not a contract deployment transaction.
• stateRoot: DATA, 32 Bytes - hash of the state root after the execution of the corresponding block. 0 if the state root is not available.
• outcomeStatus: QUANTITY - the outcome status code. 0x0 means success.
• logsBloom: DATA, 256 Bytes - bloom filter for light clients to quickly retrieve related logs.
• logs: Array - array of log objects that this transaction generated, see cfx_getLogs.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getTransactionReceipt","params":["0x53fe995edeec7d241791ff32635244e94ecfd722c9fe90f34ddf59082d814514"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"blockHash": "0xbb1eea3c8a574dc19f7d8311a2096e23a39f12e649a20766544f2df67aac0bed",

"contractCreated": null,

"epochNumber": "0x87431b",

"from": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"gasCoveredBySponsor": true,

"gasFee": "0x108ca",

"gasUsed": "0x8465",

"index": "0x0",

"logs": [{

"address": "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP",

"data": "0x00000000000000000000000019a3224214fe29107d84af9baa02118b614e46d5",

"topics": ["0x233e08777131763a85257b15eafc9f96ef08f259653d9944301ff924b3917cf5"]

}],

"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000080000000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000",

"outcomeStatus": "0x0",

"stateRoot": "0x1bc37c63c03d7e7066f9427f69e515988d19ebb26998087d75b50d2235e55ee7",

"storageCollateralized": "0x40",

"storageCoveredBySponsor": true,

"storageReleased": [{

"address": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"collaterals": "0x40"

}],

"to": "CFX:TYPE.CONTRACT:ACC7UAWF5UBTNMEZVHU9DHC6SGHEA0403Y2DGPYFJP",

"transactionHash": "0x53fe995edeec7d241791ff32635244e94ecfd722c9fe90f34ddf59082d814514"

},

"id": 1

}

---

cfx_getAccount

Returns an account, identified by its address.

Parameters

1. BASE32 - address of the account.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"latest_state"

]

Returns

Object - the state of the given account:

• balance: QUANTITY - the balance of the account.
• nonce: QUANTITY - the nonce of the account's next transaction.
• codeHash: QUANTITY - the code hash of the account.
• stakingBalance: QUANTITY - the staking balance of the account.
• collateralForStorage: QUANTITY - the collateral storage of the account.
• accumulatedInterestReturn: QUANTITY - accumulated interest return of the account.
• admin: BASE32 - admin of the account.

Example

// Request

curl --data '{"jsonrpc":"2.0","method":"cfx_getAccount","params":["cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"accumulatedInterestReturn": "0x0",

"admin": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"balance": "0x0",

"codeHash": "0x45fed62dd2b7c5ed76a63628ddc811e69bb5770cf31dd55647ca219aaee5434f",

"collateralForStorage": "0x0",

"nonce": "0x1",

"stakingBalance": "0x0"

},

"id": 1

}

---

cfx_getInterestRate

Returns the interest rate at the given epoch.

Parameters

1. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"latest_state"

]

Returns

QUANTITY - the interest rate at the given epoch.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getInterestRate","params":["latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x24b675dc000",

"id": 1

}

---

cfx_getAccumulateInterestRate

Returns the accumulate interest rate at the given epoch.

Parameters

1. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"latest_state"

]

Returns

QUANTITY - the accumulate interest rate at the given epoch.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getAccumulateInterestRate","params":["latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x3c35a9e557dc9ef76719db0226f",

"id": 1

}

---

cfx_checkBalanceAgainstTransaction

Check if a user's balance is enough to send a transaction with the specified gas and storage limits to the specified contract. The balance is enough if the user can cover the up-front payment of both execution and storage, or if these costs are sponsored by the contract.

Parameters

1. BASE32, account address
2. BASE32, contract address
3. QUANTITY, gas limit
4. QUANTITY, gas price
5. QUANTITY, storage limit
6. QUANTITY|TAG, (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter.

params: [

"cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg",

"cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",

"0x5208",

"0x2540be400",

"0x0",

"0xbf63"

]

Returns

• isBalanceEnough: Boolean - indicate balance is enough
• willPayCollateral: Boolean - false if the transaction is eligible for storage collateral sponsorship, true otherwise.
• willPayTxFee: Boolean - false if the transaction is eligible for gas sponsorship, true otherwise.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_checkBalanceAgainstTransaction","params":["cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg", "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp", "0x5208", "0x2540be400", "0x0", "0xbf63"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"isBalanceEnough": true,

"willPayCollateral": true,

"willPayTxFee": true

},

"id": 1

}

---

cfx_getSkippedBlocksByEpoch

Returns the list of non-executed blocks in an epoch. By default, Conflux only executes the last 200 blocks in each epoch (note that under normal circumstances, epochs should be much smaller).

Parameters

1. QUANTITY|TAG - integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"0xba28"

]

Returns

• Array of block hashes

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getSkippedBlocksByEpoch","params":["0xba28"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": [],

"id": 1

}

---

cfx_getConfirmationRiskByHash

Returns the confirmation block of a given block, identified by its hash.

Parameters

1. DATA, 32 Bytes - the block hash.

params: [

"0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c"

]

Returns

• QUANTITY, the integer confirmation risk, or null if the block does not exist.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getConfirmationRiskByHash","params":["0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": "0x2af31dc4611873bf3f70834acdae9f0f4f534f5d60585a5f1c1a3ced1b",

"id": 1

}

---

cfx_getStatus

Returns the node status.

Parameters

None.

Returns

• bestHash: DATA - hash of the latest epoch's pivot block
• blockNumber: QUANTITY - total block number
• chainId: QUANTITY - chainId
• epochNumber: QUANTITY - latest epoch number
• pendingTxNumber: QUANTITY - current pending transaction count

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getStatus","id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": {

"bestHash": "0xe4bf02ad95ad5452c7676d3dfc2e57fde2a70806c2e68231c58c77cdda5b7c6c",

"blockNumber": "0xa9b7",

"chainId": "0x0",

"epochNumber": "0xa9b6",

"pendingTxNumber": "0x0"

},

"id": 1

}

---

cfx_clientVersion

Returns the conflux-rust version.

Parameters

None.

Returns

• DATA - the client version

Example

//Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_clientVersion","id":1}' -H "Content-Type: application/json" localhost:12539

//Result

{

"jsonrpc": "2.0",

"result": "conflux-rust-0.6.3",

"id": 1

}

---

cfx_getBlockRewardInfo

Returns the reward info for all executed blocks in the specified epoch.

Parameters

1. QUANTITY|TAG - integer epoch number, or the string "latest_checkpoint", see the epoch number parameter

params: [

"0x5ee248"

]

Please note that reward calculation is delayed so it might not be available for the latest few epochs (including "latest_state").

Returns

Array - array of reward info objects

• blockHash: DATA - the block hash
• author: BASE32 - the address of block miner
• totalReward: QUANTITY - total reward of the block including base reward, tx fee, staking reward
• baseReward: QUANTITY - base reward
• txFee: QUANTITY - tx fee

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBlockRewardInfo","params":["0x5ee248"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": [

{

"author": "CFX:TYPE.USER:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG",

"baseReward": "0x9ccda666a9516000",

"blockHash": "0xa4a409ea5f1d31e787cd5e20a3eec1fd43851d29608d2de98fb127f518e1a211",

"totalReward": "0x9ccdca639a29ece1",

"txFee": "0x0"

}

],

"id": 1

}

---

cfx_getBlockByHashWithPivotAssumption

Returns the requested block if the provided pivot hash is correct, returns an error otherwise.

Parameters

• DATA, block hash
• DATA, assumed pivot hash
• QUANTITY, integer epoch number.

params: [

"0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c",

"0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c",

"0xba28"

]

Returns

See cfx_getBlockByHash.

Example

// Request

curl -X POST --data '{"jsonrpc":"2.0","method":"cfx_getBlockByHashWithPivotAssumption","params":["0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c", "0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c", "0xba28"],"id":1}' -H "Content-Type: application/json" localhost:12539

Result see cfx_getBlockByHash.

---

cfx_getDepositList

Returns the deposit list of the given account, identified by its address.

Parameters

1. BASE32 - address of the account.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"0x176c45928d7c26b0175dec8bf6051108563c62c5",

"latest_state"

]

Returns

Array - array of deposit info objects:

• accumulatedInterestRate: QUANTITY - the accumulated interest rate at the time of the deposit.
• amount: QUANTITY - the number of tokens deposited.
• depositTime: QUANTITY - the time of the deposit.

Example

// Request

curl --data '{"jsonrpc":"2.0","method":"cfx_getDepositList","params":["0x176c45928d7c26b0175dec8bf6051108563c62c5", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": [{

"accumulatedInterestRate": "0x3c4517ac75006c913c52c2402e8",

"amount": "0x8ac7230489e80000",

"depositTime": 3135949

}, {

"accumulatedInterestRate": "0x3c451870afdac66f40804d95742",

"amount": "0x8ac7230489e80000",

"depositTime": 3136255

}],

"id": 1

}

---

cfx_getVoteList

Returns the vote list of the given account, identified by its address.

Parameters

1. BASE32 - address of the account.
2. QUANTITY|TAG - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

params: [

"0x176c45928d7c26b0175dec8bf6051108563c62c5",

"latest_state"

]

Returns

Array - array of vote info objects:

• amount: QUANTITY - the number of tokens locked.
• unlockBlockNumber: QUANTITY - the block number at which the locked tokens are released.

For getting the current block number, please refer to conflux-rust#1973.

Example

// Request

curl --data '{"jsonrpc":"2.0","method":"cfx_getVoteList","params":["0x176c45928d7c26b0175dec8bf6051108563c62c5", "latest_state"],"id":1}' -H "Content-Type: application/json" localhost:12539

// Result

{

"jsonrpc": "2.0",

"result": [{

"amount": "0x8ac7230489e80000",

"unlockBlockNumber": 1000000000000

}],

"id": 1

}