cfx 命名空间

JSON-RPC Spec

There is a JSON-RPC API spec of cfx namespace on GitHub. You can view it in open-rpc playground

CONVENTIONS

十六进制值编码

Two key data types get passed over JSON: unformatted byte arrays and quantities. Both are passed with a hex encoding but with different requirements for formatting.

Quantities

When encoding QUANTITIES (integers, numbers): encode as hex using the most compact representation and prefix with "0x". Zero should be represented as "0x0". 例如：

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)

未格式化的数据

当编码未格式化的数据（字节数组、哈希值、字节码数组）时：使用两个十六进制数字表示每个字节，并在前面加上“0x”作为前缀。例如：

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)

请注意，区块和交易的哈希值是用32个字节来表示的。

Base32 Address

BASE32：Base32 地址应该编码为一个ASCII字符串，包含42个字符加上网络前缀、分隔符和可选字段。请注意以下关于base32地址作为RPC参数的限制条件：

网络前缀应该与节点的网络匹配，例如：cfx:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp可以发送给主网节点，cfxtest:acc7uawf5ubtnmezvhu9dhc6sghea0403ywjz6wtpg可以发送给测试网节点。值得注意的是，这两个示例地址对应于不同网络上的同一个账户。
无论包含还是省去地址类型都是可以接受的，例如：cfx:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg和cfx:type.user:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg是等价的。但是，类型不正确的地址，例如：cfx:type.contract:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg，会被拒绝。
全大写或者全小写地址都是可以接受的，例如：cfx:aarc9abycue0hhzgyrr53m6cxedgccrmmyybjgh4xg和CFX:AARC9ABYCUE0HHZGYRR53M6CXEDGCCRMMYYBJGH4XG都是有效的。但混合大小写地址会被拒绝。

Refer to Addresses for more knowledge about Base32 addresses.

默认的 epochNumber （纪元数）参数

有几个RPC方法有一个epoch number参数。 Epoch的概念在Conflux中有点类似于其他账本中的区块号（高度），但是一个epoch可能包含多个区块。

Epoch number指定了在一个时间点时，系统的相应状态，这些状态受到共识的约束。 Epoch number参数有以下几种可能的选项：

HEX String - 整数纪元数。例如，0x3e8是epoch 1000。
String “earliest”表示创世区块的epoch。
String “latest_checkpoint”表示存储在内存中的最早的epoch。
String “latest_finalized” - 表示最新的已经确定（通过PoS）的epoch。（添加自conflux-rust v2.0.0）
String “latest_confirmed” - 表示最新的已经确认的epoch（使用确认计量器的估计值）。
string "latest_state" - 表示已经执行的最新纪元。
String “latest_mined” - 表示最新的已知epoch。

请注意，由于性能优化，最新的已知epoch没有被执行，所以这些epoch没有可用的状态。对于大多数与状态查询有关的RPC，推荐使用"latest_state"。 (Refer to transaction lifecycle for more information about transaction life cycle in Conflux).

EIP-1898 style Conflux epochNumber parameter

Conflux core space supports epoch number parameter in EIP-1898 style for certain RPCs. The EIP-1898 style epoch number parameter is an object with 3 optional fields:

epochNumber. Corresponding to EIP-1898 defined blockNumber
blockHash. Same as EIP-1898 blockHash
requirePivot. Corresponding to EIP-1898 requireCanonical. Defaults to true

例如：

{
  "blockHash": "0x692373025c7315fa18b2d02139d08e987cd7016025920f59ada4969c24e44e06",
  "requirePivot": false
}

The EIP-1898 style epoch number parameter is now usable in following RPCs:

cfx_getBalance
cfx_getStorageAt
cfx_call
cfx_getNextNonce
cfx_getCode
cfx_getEpochReceipts

CURL EXAMPLES

下面提供了通过向Conflux节点发出 curl 请求来使用 JSON_RPC 应用程序接口的示例。每个示例都包括对特定端点、其参数、返回类型的描述，以及应该如何使用它的工作示例。

Curl 请求可能会返回与内容类型相关的错误消息。这是因为 --data 选项将内容类型设置为 application/x-www-form-urlencoded。如果你的节点确实抱怨此问题，请通过在调用开始时放置 -H "Content-Type: application/json" 来手动设置标头。这些示例也未包括网址/互联网协议与端口组合，该组合必须是 curl 的最后一个参数（例如 127.0.0.1:12537）。包含这些附加数据的完整 curl 请求采用以下形式：

$ curl -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"cfx_clientVersion","params":[],"id":67}' 127.0.0.1:12537

本文档剩余部分的示例将使用 HTTP endpoint。

State and transaction availability

Conflux的归档节点和全节点会删除历史状态树，以减少存储空间的占用。全节点也会丢弃历史区块的交易和收据。因此，一些RPC接口可能无法用于历史查询。

下面是Conflux RPC API的列表，以及它们在归档节点和全节点上的可用性。 *“recent”表示该RPC只支持最近的项目，“OK”*表示它应该对任何有效的输入都能正常工作。

RPC	归档节点	全节点
`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).

从以太坊 JSON-RPC 迁移

以太坊和 Conflux 的一些 JSON-RPC 有对应关系。即使 JSON-RPC 的细节可能有所不同，但以下映射表在从以太坊迁移到 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`

GOSSIP, STATE, HISTORY

一些核心的 JSON-RPC 方法需要从 Conflux 网络获取数据，它们可以分为三个主要类别：Gossip, State 和 History。你可以使用这些部分中的链接跳转到每个方法，或者使用目录来浏览所有方法的列表。

Gossip 方法

这些方法跟踪链的头部。这是交易在网络中传播、进入区块的方式，以及客户端发现新区块的方式。

cfx_getStatus
cfx_epochNumber
cfx_sendRawTransaction

State 方法

这些方法报告存储的所有数据的当前状态。 “状态”就像一块大的共享内存，包括账户余额、合约数据和 gas 估算。

cfx_getBalance
cfx_getStorageAt
cfx_getNonce
cfx_getCode
cfx_call
cfx_estimateGasAndCollateral

History 方法

获取从创世区块开始的每个区块的历史记录。 This is like one large append-only file, and includes all block headers, block bodies, and transaction receipts.

cfx_getBlockByHash
cfx_getBlockByEpochNumber
cfx_getTransactionByHash
cfx_getTransactionReceipt

JSON-RPC methods

cfx_getTransactionByHash

Returns information about a transaction, identified by its hash.

参数

DATA, 32 Bytes - hash of a transaction

params: [
    "0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"
]

Returns

Object - a transaction object, or null when no transaction was found:

blockHash: DATA, 32 字节 - 包含并执行了这个交易的区块的哈希。 null when the transaction is pending.
chainId: QUANTITY - the chain ID specified by the sender.
contractCreated: BASE32 - 创建的合约的地址。 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 - 发送者的地址。
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, 2 for skiped, null when the transaction is skipped or not packed.
storageLimit: QUANTITY - the storage limit specified by the sender.
to: BASE32 - 接收者的地址。 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.

示例

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

参数

DATA, 32 Bytes - hash of a block.
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.
custom: Array- customized information. Note from v2.0 custom's type has changed from array of number array to array of hex string.
blockNumber: QUANTITY - the number of this block's total order in the tree-graph. null when the order is not determined. Added from Conflux-rust v1.1.5
posReference: DATA, 32 Bytes - the hash of the PoS newest committed block. Added from Conflux-rust v2.0.0

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.

示例

// 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"
    ],
    "custom": ["0x12"],
    "transactionsRoot": "0xfb245dae4539ea49812e822adbffa9dd2ee9b3de8f3d9a7d186d351dcc9a6ed4",
    "posReference": "0xd1c2ff79834f86eb4bc98e0e526de475144a13719afba6385cf62a4023c02ae3",
  },
  "id": 1
}

cfx_getBlockByEpochNumber

返回一个区块的信息，该区块由它的纪元号（epoch number）标识。

参数

QUANTITY|TAG - the epoch number, or the string "latest_mined", "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter.
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.

示例

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

返回最佳区块的哈希值。

参数

None.

Returns

DATA, 32 Bytes - hash of the best block.

示例

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

返回给定标签对应的纪元号。

参数

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.

示例

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

返回当前每单位gas的价格，单位为Drip。

参数

None.

Returns

QUANTITY - integer of the current gas price in Drip.

示例

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

返回指定纪元中的区块哈希值。

参数

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.

示例

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

返回给定账户的余额，该账户由它的地址标识。

参数

BASE32 - address to check for balance.
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.

示例

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

返回给定账户的质押余额，该账户由它的地址标识。

参数

BASE32 - address to check for staking balance.
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.

示例

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

返回给定地址的抵押存储的大小，单位为字节。

参数

BASE32 - address to check for collateral storage.
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.

示例

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

返回指定合约的管理员。

参数

BASE32 - address of the contract.
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.

备注

Although meaningless, it is also possible to use user address as the input parameter of cfx_getAdmin method. In this case, the return value will be zero address if the input user address exists in the world state, else null will be returned.

示例

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

返回指定合约的代码。如果合约不存在，将返回0x0。

参数

BASE32 - address of the contract.
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.

示例

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

返回给定合约的存储条目。

参数

BASE32 - address of the contract.
QUANTITY - a storage position (see here for more info).
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",
    "0x100",
    "latest_state"
]

Returns

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

示例

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

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

cfx_getStorageRoot

返回给定合约的存储根。

参数

BASE32 - address of the contract.
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).

示例

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

返回给定合约的赞助者信息。

参数

BASE32 - address of the contract.
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.
usedStoragePoints: QUANTITY - storage points already used.
availableStoragePoints: QUANTITY - the storage points available for sponsorship.

Hard fork v2.3 provides the introduction for storage points. Refer to CIP-107 for the detailed explanation.

示例

// 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": "CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2",
    "sponsorForGas": "CFX:TYPE.NULL:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA0SFBNJM2",
    "sponsorGasBound": "0x0"
  },
  "id": 1
}

cfx_getNextNonce

返回给定账户在发送交易时应该使用的下一个nonce值。

参数

BASE32 - address of the account.
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.

示例

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

发送一个已签名的交易到网络中进行处理。

参数

DATA, the signed transaction data.

params: [
    "0xf86eea8201a28207d0830f4240943838197c0c88d0d5b13b67e1bfdbdc132d4842e389056bc75e2d631000008080a017b8b26f473820475edc49bd153660e56b973b5985bbdb2828fceacb4c91f389a03452f9a69da34ef35acc9c554d7b1d63e9041141674b42c3abb1b57b9f83a2d3"
]

Returns

DATA, 32 Bytes - the transaction hash.

Common Errors

Check send raw transaction errors for details.

示例

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

虚拟地调用一个合约，返回输出数据。 The transaction will not be added to the blockchain.

参数

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

示例

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

虚拟地执行一个交易，返回存储抵押和交易使用的gas的大小估计。 The transaction will not be added to the blockchain.

参数

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:

gasLimit: QUANTITY - the recommended gas_limit.
gasUsed: QUANTITY - gas used during execution.
storageCollateralized: QUANTITY - size of storage collateralized, in bytes.

示例

// 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": {
    "gasLimit": "0x6d60",
    "gasUsed": "0x5208",
    "storageCollateralized": "0x80"
  },
  "id": 1
}

cfx_getLogs

返回与提供的过滤器匹配的日志。

参数

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.
- fromBlock: QUANTITY - (optional, default: null). Search will be applied from this specified block.
- toBlock: QUANTITY - (optional, default: null). Search will be applied untial (and including) this specified block.
- 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.

params: [
    {
        "fromEpoch": "0x873e12",
        "toEpoch": "0x87431b",
        "address": "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",
        "topics": [["0x233e08777131763a85257b15eafc9f96ef08f259653d9944301ff924b3917cf5", "0xd7fb65c06987247ab480a21659e16bdf0b5862a19869ec264075d50ab3525435"], null, "0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26"],
    }
]

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.

示例

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

返回一个交易收据，由相应的交易哈希值标识。

参数

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 字节 - 包含并执行了这个交易的区块的哈希。
epochNumber: QUANTITY - epoch number of the block where this transaction was in and got executed.
from: BASE32 - 发送者的地址。
to: BASE32 - 接收者的地址。 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 - 创建的合约的地址。 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. 0x1 means failed. 0x2 means skipped
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.
txExecErrorMsg: String, tx exec fail message, if transaction exec success this will be null.

示例

// 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",
    "txExecErrorMsg": null
  },
  "id": 1
}

cfx_getAccount

Returns an account, identified by its address.

参数

BASE32 - address of the account.
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:

address: BASE32 - address of the account.
balance: QUANTITY - the balance of the account.
nonce: QUANTITY - the nonce of the account's next transaction.
codeHash: DATA - 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.

示例

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

返回给定纪元的利率。

参数

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.

示例

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

返回给定纪元的累积利率。

参数

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.

示例

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

检查用户的余额是否足够发送一个带有指定gas和存储限制的交易到指定合约。如果用户可以支付执行和存储的预付款，或者这些费用由合约赞助，那么余额就足够了。

参数

BASE32, account address
BASE32, contract address
QUANTITY, gas limit
QUANTITY, gas price
QUANTITY, storage limit
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 for gas fee and collateral storage
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.

示例

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

参数

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

示例

// 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 risk of a given block, identified by its hash.

参数

DATA, 32 Bytes - the block hash.

params: [
  "0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c"
]

Returns

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

示例

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

参数

None.

Returns

bestHash: DATA - hash of the latest epoch's pivot block
blockNumber: QUANTITY - total block number
chainId: QUANTITY - chainId
networkId: QUANTITY - networkId
ethereumSpaceChainId: QUANTITY - eSpace's chainId (Added from v2.0)
epochNumber: QUANTITY - latest epoch number
latestCheckpoint: QUANTITY - latest checkpoint epoch number
latestConfirmed: QUANTITY - latest confirmed epoch number
latestFinalized: QUANTITY - latest finallized epoch number (Added from v2.0)
latestState: QUANTITY - latest state epoch number
pendingTxNumber: QUANTITY - current pending transaction count

示例

// 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",
    "chainId": "0x1",
    "networkId": "0x1",
    "blockNumber": "0x1a80325",
    "epochNumber": "0xaf28ab",
    "latestCheckpoint": "0xada520",
    "latestConfirmed": "0xaf2885",
    "latestState": "0xaf28a7",
    "latestFinalized": "0x2a420c",
    "ethereumSpaceChainId": "0x22b9",
    "pendingTxNumber": "0x0"
  },
  "id": 1
}

cfx_clientVersion

Returns the conflux-rust version.

参数

None.

Returns

STRING - the client version

示例

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

参数

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

示例

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

参数

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

params: [
   "0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c",
   "0x3912275cf09f8982a69735a876c14584dae95078762090c5d32fdf0dbec0647c",
   "0xba28"
]

Returns

See cfx_getBlockByHash.

示例

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

参数

BASE32 - address of the account.
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:aan02vpwvz8crpa1n10j17ufceefptdc2yzkagxk5u",
   "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.

示例

// Request
curl --data '{"jsonrpc":"2.0","method":"cfx_getDepositList","params":["cfx:aan02vpwvz8crpa1n10j17ufceefptdc2yzkagxk5u", "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.

参数

BASE32 - address of the account.
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:aan02vpwvz8crpa1n10j17ufceefptdc2yzkagxk5u",
   "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.

示例

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

// Result
{
  "jsonrpc": "2.0",
  "result": [{
    "amount": "0x8ac7230489e80000",
    "unlockBlockNumber": 1000000000000
  }],
  "id": 1
}

cfx_getSupplyInfo

Returns summary supply info of the entire chain.

参数

None.

Returns

Object - Object include the supply summary info.

totalIssued: QUANTITY - Amount of total issued CFX in Drip
totalCollateral: QUANTITY - Amount of total storage collateraled CFX in Drip
totalStaking: QUANTITY - Amount of total staking CFX in Drip
totalCirculating: QUANTITY - Amount: TotalIssued - FourYearUnlock - TwoYearUnlock
totalEspaceTokens: QUANTITY - Amount of total eSpace CFX in Drip (Added in Conflux-Rust v2.0.1)

示例

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

// Result
{
  "jsonrpc": "2.0",
  "result": {
    "totalCirculating": "0x1ed09beade67915041ca95cb0ea3b",
    "totalCollateral": "0x2b95bdcc39b610000",
    "totalIssued": "0x1ed09ced5cda57e32eec33328ea3b",
    "totalStaking": "0x56bc75e2d63100000"
  },
  "id": "15922956697249514502"
}

cfx_getAccountPendingInfo

Returns transaction pool pending info of one account

参数

BASE32 - address of the account.

params: [
    "cfx:aan02vpwvz8crpa1n10j17ufceefptdc2yzkagxk5u"
]

Returns

Object - Object include account's pending info.

localNonce: QUANTITY - User's transaction pool nonce that can be used for next transaction.
pendingNonce: QUANTITY - User's current pending nonce
pendingCount: QUANTITY - Count of pending transaction
nextPendingTx: DATA - Hash of next pending transaction

示例

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

// Response
{
    "jsonrpc": "2.0",
    "result": {
        "localNonce": "0x1ed",
        "nextPendingTx": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "pendingCount": "0x0",
        "pendingNonce": "0x0"
    },
    "id": "15922956697249514502"
}

cfx_getAccountPendingTransactions

Returns pending transactions in pool of one account

参数

BASE32 - address of the account.
[QUANTITY] - Optional start nonce to return
[QUANTITY] - Optional limit of pending transactions to return

params: [
    "cfx:aan02vpwvz8crpa1n10j17ufceefptdc2yzkagxk5u"
]

Returns

Object - Object include account's pending transaction info.

firstTxStatus: OBJECT - An object with only one field pending, it's value is the first pending transaction's status. Only have three case futureNonce, notEnoughCash. Or just a string ready
pendingCount: QUANTITY - Count of pending transactions
pendingTransactions: ARRAY - Array of pending transaction

示例

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

// Response
{
    "jsonrpc": "2.0",
    "result": {
        "firstTxStatus": {
            "pending": "futureNonce"
        },
        "pendingCount": "0x1",
        // Reference transaction example
        "pendingTransactions": [
            {
                "...": "..."
            }
        ]
    },
    "id": "15922956697249514502"
}

cfx_getBlockByBlockNumber

Returns information about a block, identified by its block number (block's tree-graph order number).

Added at

Conflux-rust v1.1.5

参数

QUANTITY - the block number.
Boolean - if true, it returns the full transaction objects. If false, only the hashes of the transactions are returned

params: [
    "0x1000",
    true
]

Returns

See cfx_getBlockByHash.

示例

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

Result see cfx_getBlockByHash.

cfx_getPoSEconomics

Returns PoS economics summary info.

Added at

Conflux-rust v2.0.0

参数

[QUANTITY] - (optional, default: "latest_state") integer epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter

Returns

distributablePosInterest: QUANTITY Total distributable PoS interest (Unit is Drip)
lastDistributeBlock: QUANTITY Last block that distributable PoS interest
totalPosStakingTokens: QUANTITY Total tokens staked in PoS (Unit is Drip)

示例

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw ' {
    "jsonrpc": "2.0",
    "id": "15922956697249514502",
    "method": "cfx_getPoSEconomics",
    "params": []
  }'

{
    "jsonrpc": "2.0",
    "result": {
        "distributablePosInterest": "0x6fd7fd91140603a45caff2",
        "lastDistributeBlock": "0x100",
        "totalPosStakingTokens": "0x29cbb85e5a6e849c00000"
    },
    "id": "15922956697249514502"
}

cfx_getPoSRewardByEpoch

Get rewards information of a PoS epoch by it's correspond PoW epoch number. Only PoW epoch happen's at PoS epoch end will have rewards information. Others will return null.

Added at

Conflux-rust v2.0.0

参数

QUANTITY: PoW epoch number

params: [
  "0x4a"
]

Returns

accountRewards: Array of AccountReward
powEpochHash: HASH - the hash value of the PoW block when the rewards are made

AccountReward

posAddress: ADDRESS - PoS account address
powAddress: BASE32 - PoW account address
reward: QUANTITY - the number of rewards, in the unit of Drip

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getPoSRewardByEpoch",
    "params": ["0x4a"]
}'

Response

{
    "jsonrpc": "2.0",
    "result": {
        "accountRewards": [
            {
                "posAddress": "0x459b19e745eb410c3696ff1ed15f9de9bb46aa5fefc27b0b6e8b8d7aaadfe8c0",
                "powAddress": "NET8888:TYPE.USER:AAKSNR7XKKFFAM17MNESKAGU076T8FAG3YJ6PTHN16",
                "reward": "0x14931d20aa21eae3e6f"
            },
            {
                "posAddress": "0x046ca462890f25ed9394ca9f92c979ff48e1738a81822ecab96d83813c1a433c",
                "powAddress": "NET8888:TYPE.USER:AAPXUPNXG96GZ4077DAV0151K7P8498N9A6DMAWK1N",
                "reward": "0x2d49549e023888cd390"
            }
        ],
        "powEpochHash": "0x361cb0f19fd13c30da467d20a84ef01aabcd55e9812c5e2fd0721ea11a52e9f1"
    },
    "id": 1
}

cfx_getParamsFromVote

Returns DAO vote params info

Added at

Conflux-rust v2.1.0

参数

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

params: [
  "0x4a"
]

Returns

powBaseReward: QUANTITY - The PoW base reward amount
interestRate: QUANTITY - The PoS interest rate
storagePointProp: QUANTITY - The proportion of sponsored storage will transfer to storage point

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getParamsFromVote",
    "params": ["0x4a"]
}'

Response

{
    "jsonrpc": "2.0",
    "result": {
        "powBaseReward": "0x1",
        "interestRate": "0x2",
    },
    "id": 1
}

cfx_newFilter

This function creates a log filter for tracking usage. It returns a log filter ID, which can be employed through the cfx_getFilterChanges command to retrieve logs newly generated from recently executed transactions. The from* field in this context will be disregarded by this RPC (Remote Procedure Call). This function can also be used via cfx_getFilterLogs to retrieve all logs that match the filter criteria. In this instance, the from* fields are considered.

It is important to note that the filter object will expire after a certain period of inactivity from the last request, typically 60 seconds. This expiration duration is configured by the node. To avoid losing log tracking, it is recommended to refresh or recreate the filter as necessary.

参数

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. The start epoch to search. Noting that [cfx_getFilterChanges] will ignore this parameter.
- 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.
- fromBlock: QUANTITY - (optional, default: null). The start block to search. Noting that [cfx_getFilterChanges] will ignore this parameter.
- toBlock: QUANTITY - (optional, default: null). Search will be applied untial (and including) this specified block.
- 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.

params: [
    {
        "fromEpoch": "0x873e12",
        "toEpoch": "0x87431b",
        "address": "cfx:type.contract:acc7uawf5ubtnmezvhu9dhc6sghea0403y2dgpyfjp",
        "topics": [["0x233e08777131763a85257b15eafc9f96ef08f259653d9944301ff924b3917cf5", "0xd7fb65c06987247ab480a21659e16bdf0b5862a19869ec264075d50ab3525435"], null, "0x0000000000000000000000001d618f9b63eca8faf90faa9cb799bf4bfe616c26"],
    }
]

Returns

QUANTITY - the id of the log filter object.

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getParamsFromVote",
    "params": ["fromEpoch": "0x873e12"]
}'

Response

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

cfx_newBlockFilter

Create a block filter for following up usage. Returns the block filter id which can be used via cfx_getFilterChanges to retrieve latest executed blocks.

参数

None.

Returns

QUANTITY - the id of the block filter object.

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_newBlockFilter",
    "params": []
}'

Response

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

cfx_newPendingTransactionFilter

Create a pending transaction filter for following up usage. Returns the transaction filter id which can be used via cfx_getFilterChanges to retrieve ready but not executed transactions.

备注

The created filter will only filter out ready transactions, which means a pending transaction with a future nonce will never be listed via corresponding cfx_getFilterChanges.

Besides, it is important to note that the filter object will expire after a certain period of inactivity from the last request, typically 60 seconds. This expiration duration is configured by the node. To avoid losing log tracking, it is recommended to refresh or recreate the filter as necessary.

参数

None.

Returns

QUANTITY - the id of the pending transaction filter object.

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_newPendingTransactionFilter",
    "params": []
}'

Response

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

cfx_getFilterChanges

Get filter changes since last retrieve. Return value depends on which type of filter id is provided. Filter id can be returned from current RPCs:

cfx_newFilter: new logs generated from newly executed transactions matching the filter. Noting that from* fields will be ignored by this RPC.
cfx_newBlockFilter: new executed blocks.
cfx_newPendingTransactionFilter: new pending transactions which are ready to execute.

备注

The created filter will only filter out ready transactions, which means a pending transaction with a future nonce will never be listed via corresponding cfx_getFilterChanges.

参数

QUANTITY - the filter id.

params: [
  "0x09294f7b3b63b52d3771fcafb7b7ed61"
]

Returns

Array - array of log receipts (same format as cfx_getLogs return value), block hashes, or transaction hashes depending on the input.

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getFilterChanges",
    "params": [0x09294f7b3b63b52d3771fcafb7b7ed61]
}'

Response

{
    "jsonrpc": "2.0",
    "result": ["0xcc103077ede14825a5667bddad79482d7bbf1f1a658fed6894fa0e9287fc6be1"],
    "id": 1
}

cfx_getFilterLogs

Returns all logs matching the log filter (Unlike cfx_getFilterChanges, from* fields still work).

参数

QUANTITY - the filter id.

params: [
  "0x09294f7b3b63b52d3771fcafb7b7ed61"
]

Returns

Array - array of log receipts (same as cfx_getLogs).

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getFilterLogs",
    "params": [0x09294f7b3b63b52d3771fcafb7b7ed61]
}'

Response

Refer to cfx_getLogs.

cfx_uninstallFilter

Uninstall the specified filter. Returns a bool whether the uninstallation succeeds.

参数

QUANTITY - the filter id.

params: [
  "0x09294f7b3b63b52d3771fcafb7b7ed61"
]

Returns

Boolean - whether the uninstallation succeeds.

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_uninstallFilter",
    "params": [0x09294f7b3b63b52d3771fcafb7b7ed61]
}'

Response

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

cfx_getEpochReceipts

Returns all transaction receipts within the specific epoch.

备注

This method is supported by Confura if api key is provided. For normal nodes, this method is also supported, but can only be accessed in local environment.

参数

QUANTITY|TAG - the epoch number, or the string "latest_state", "latest_confirmed", "latest_checkpoint" or "earliest", see the epoch number parameter.
Boolean - whether eSpace transaction receipts will be included in the return value, defaults to false.

params: [
    "0x1000",
    true
]

Returns

Array - This is a two-dimensional array of transaction receipts. Each sub-array represents transactions within a block. Noting an extra field of space will be added to each transaction receipt if the second parameter is set to true. The value of space will be either native meaning this is a core space transaction receipt or evm meaning the transaction is from eSpace.

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getEpochReceipts",
    "params": ["0x1000", true]
}'

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    [],
    [
      {
        "transactionHash": "0x386442f263e3d4b382f97efe577e3bb5956872a322936b8581133be4ec392153",
        "index": "0x0",
        "blockHash": "0x6ebb905fbfcc80506080e639b80d7bc696dab2f6168e01daedf3c15597987da2",
        "epochNumber": "0x7e6f164",
        "from": "cfxtest:aakvz2e5nt82c9nvbbg84hzbrjy53nsdf20ng5wuj1",
        "to": "cfxtest:acbpnfz9mu42a6ubhdcyadj04m2w8wt6sex7atgyg6",
        "gasUsed": "0x15a1b",
        "accumulatedGasUsed": "0x15a1b",
        "gasFee": "0x50957e574e00",
        "contractCreated": null,
        "logs": [],
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "stateRoot": "0x6ef7bcc4d8cb7c777a587a22002930c5d44e62e1047043c44dd44f89d16e462d",
        "outcomeStatus": "0x0",
        "txExecErrorMsg": null,
        "gasCoveredBySponsor": false,
        "storageCoveredBySponsor": false,
        "storageCollateralized": "0x0",
        "storageReleased": [],
        "space": "native"
      }
    ]
  ]
}

cfx_getCollateralInfo

Returns current chain collateral status info.

参数

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.

params: [
    "latest_state",
]

Returns

Object - The storage collateral info object of the chain.

totalStorageTokens
convertedStoragePoints - converted storage points of the total chain
usedStoragePoints - storage points already used for sponsorship

示例

Request

curl --location --request POST 'http://localhost:12537' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "cfx_getCollateralInfo",
    "params": ["latest_executed"]
}'

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "totalStorageTokens": "0x12c6e8ec75a2740998000",
    "convertedStoragePoints": "0x485ec66",
    "usedStoragePoints": "0x290bc0"
  }
}

JSON-RPC Spec​

CONVENTIONS​

十六进制值编码​

Quantities​

未格式化的数据​

Base32 Address​

默认的 epochNumber （纪元数） 参数​

EIP-1898 style Conflux epochNumber parameter​

CURL EXAMPLES​

State and transaction availability​

从以太坊 JSON-RPC 迁移​

GOSSIP, STATE, HISTORY​

Gossip 方法​

State 方法​

History 方法​

JSON-RPC methods​

cfx_getTransactionByHash​

参数​

Returns​

示例​

cfx_getBlockByHash​

参数​

Returns​

示例​

cfx_getBlockByEpochNumber​

参数​

Returns​

示例​

cfx_getBestBlockHash​

参数​

Returns​

示例​

cfx_epochNumber​

参数​

Returns​

示例​

cfx_gasPrice​

参数​

Returns​

示例​

cfx_getBlocksByEpoch​

参数​

Returns​

示例​

cfx_getBalance​

参数​

Returns​

示例​

cfx_getStakingBalance​

参数​

Returns​

示例​

cfx_getCollateralForStorage​

参数​

Returns​

示例​

cfx_getAdmin​

参数​

Returns​

示例​

cfx_getCode​

参数​

Returns​

示例​

cfx_getStorageAt​

参数​

Returns​

示例​

cfx_getStorageRoot​

参数​

Returns​

示例​

cfx_getSponsorInfo​

参数​

Returns​

示例​

cfx_getNextNonce​

参数​

Returns​

示例​

JSON-RPC Spec

CONVENTIONS

十六进制值编码

Quantities

未格式化的数据

Base32 Address

默认的 epochNumber （纪元数）参数

EIP-1898 style Conflux epochNumber parameter

CURL EXAMPLES

State and transaction availability

从以太坊 JSON-RPC 迁移

GOSSIP, STATE, HISTORY

Gossip 方法

State 方法

History 方法

JSON-RPC methods

cfx_getTransactionByHash

参数

Returns

示例

cfx_getBlockByHash

参数

Returns

示例

cfx_getBlockByEpochNumber

参数

Returns

示例

cfx_getBestBlockHash

参数

Returns

示例

cfx_epochNumber

参数

Returns

示例

cfx_gasPrice

参数

Returns

示例

cfx_getBlocksByEpoch

参数

Returns

示例

cfx_getBalance

参数

Returns

示例

cfx_getStakingBalance

参数

Returns

示例

cfx_getCollateralForStorage

参数

Returns

示例

cfx_getAdmin

参数

Returns

示例

cfx_getCode

参数

Returns

示例

cfx_getStorageAt

参数

Returns

示例

cfx_getStorageRoot

参数

Returns

示例

cfx_getSponsorInfo

参数

Returns

示例

cfx_getNextNonce

参数

Returns

示例