CKB JSON-RPC协议

RPC接口与节点版本共享相同的版本，该版本在local_node_info中返回。该接口在不同补丁版本之间完全兼容，例如，0.25.0版本的客户端应与0.25.x版本的任何x兼容。

允许任意机器访问JSON-RPC端口（使用rpc.listen_address配置选项）是危险的，并且强烈不建议。请严格限制只有受信任的机器可以访问。

CKB JSON-RPC目前仅支持HTTP。如果需要SSL，请通过Nginx或其他HTTP服务器设置代理。

请参阅项目列表以设置RPC服务器的代理。

订阅需要全双工连接。CKB以TCP（通过rpc.tcp_listen_address配置选项启用）和WebSocket（通过rpc.ws_listen_address配置选项启用）的形式提供此类连接。

JSONRPC弃用过程

CKB RPC方法弃用分为三个步骤。

首先，该方法在CKB发行说明和RPC文档中被标记为已弃用。然而，RPC方法仍然可用。RPC文档将建议替代解决方案。

CKB开发团队将从下一个次要版本开始禁用任何已弃用的RPC方法。用户可以通过配置文件选项rpc.enable_deprecated_rpc启用已弃用的方法。

一旦禁用已弃用方法，CKB开发团队将在未来的次要版本中删除它。

例如，一个方法在0.35.0中被标记为已弃用，它可以在0.36.0中禁用，并在0.37.0中删除。次要版本每月发布一次，因此对于已弃用的RPC方法至少有两个月的时间缓冲。

最小支持的Rust版本策略（MSRV）

软件包ckb-rpc的最小支持的rustc版本是1.71.1。

目录

• RPC方法

  • 模块警告 👉 OpenRPC规范

    • 方法 send_alert

  • 模块链 👉 OpenRPC规范

    • 方法 get_block
    • 方法 get_block_by_number
    • 方法 get_header
    • 方法 get_header_by_number
    • 方法 get_block_filter
    • 方法 get_transaction
    • 方法 get_block_hash
    • 方法 get_tip_header
    • 方法 get_live_cell
    • 方法 get_tip_block_number
    • 方法 get_current_epoch
    • 方法 get_epoch_by_number
    • 方法 get_block_economic_state
    • 方法 get_transaction_proof
    • 方法 verify_transaction_proof
    • 方法 get_transaction_and_witness_proof
    • 方法 verify_transaction_and_witness_proof
    • 方法 get_fork_block
    • 方法 get_consensus
    • 方法 get_block_median_time
    • 方法 estimate_cycles
    • 方法 get_fee_rate_statics
    • 方法 get_fee_rate_statistics

  • 模块调试 👉 OpenRPC规范

    • 方法 jemalloc_profiling_dump
    • 方法 update_main_logger
    • 方法 set_extra_logger

  • 模块实验 👉 OpenRPC规范

    • 方法 dry_run_transaction
    • 方法 calculate_dao_maximum_withdraw

  • 模块索引器 👉 OpenRPC规范

    • 方法 get_indexer_tip
    • 方法 get_cells
    • 方法 get_transactions
    • 方法 get_cells_capacity

  • 模块集成测试 👉 OpenRPC 规范

    • 方法 process_block_without_verify
    • 方法 truncate
    • 方法 generate_block
    • 方法 generate_epochs
    • 方法 notify_transaction
    • 方法 generate_block_with_template
    • 方法 calculate_dao_field
    • 方法 send_test_transaction

  • 模块矿工 👉 OpenRPC 规范

    • 方法 get_block_template
    • 方法 submit_block

  • 模块网络 👉 OpenRPC 规范

    • 方法 local_node_info
    • 方法 get_peers
    • 方法 get_banned_addresses
    • 方法 clear_banned_addresses
    • 方法 set_ban
    • 方法 sync_state
    • 方法 set_network_active
    • 方法 add_node
    • 方法 remove_node
    • 方法 ping_peers

  • 模块池 👉 OpenRPC 规范

    • 方法 send_transaction
    • 方法 test_tx_pool_accept
    • 方法 remove_transaction
    • 方法 tx_pool_info
    • 方法 clear_tx_pool
    • 方法 get_raw_tx_pool
    • 方法 get_pool_tx_detail_info
    • 方法 tx_pool_ready

  • 模块富索引器 👉 OpenRPC 规范

    • 方法 get_indexer_tip
    • 方法 get_cells
    • 方法 get_transactions
    • 方法 get_cells_capacity

  • 模块统计 👉 OpenRPC 规范

    • 方法 get_blockchain_info
    • 方法 get_deployments_info

  • 模块订阅 👉 OpenRPC 规范

    • 方法 subscribe
    • 方法 unsubscribe

• RPC 类型

  • 类型 Alert
  • 类型 AlertId
  • 类型 AlertId
  • 类型 AlertMessage
  • 类型 AlertPriority
  • 类型 AlertPriority
  • 类型 AncestorsScoreSortKey
  • 类型 BannedAddr
  • 类型 Block
  • 类型 BlockEconomicState
  • 类型 BlockFilter
  • 类型 BlockIssuance
  • 类型 BlockNumber
  • 类型 BlockResponse
  • 类型 BlockTemplate
  • 类型 BlockView
  • 类型 BlockWithCyclesResponse
  • 类型 Buried
  • 类型 Byte32
  • 类型 Capacity
  • 类型 CellData
  • 类型 CellDep
  • 类型 CellInfo
  • 类型 CellInput
  • 类型 CellOutput
  • 类型 CellWithStatus
  • 类型 CellbaseTemplate
  • 类型 ChainInfo
  • 类型 Consensus
  • 类型 Cycle
  • 类型 DaoWithdrawingCalculationKind
  • 类型 DepType
  • 类型 Deployment
  • 类型 DeploymentInfo
  • 类型 DeploymentState
  • 类型 DeploymentsInfo
  • 类型 EntryCompleted
  • 类型 EpochNumber
  • 类型 EpochNumber
  • 类型 EpochNumberWithFraction
  • 类型 EpochView
  • 类型 EstimateCycles
  • 类型 ExtraLoggerConfig
  • 类型 FeeRateStatistics
  • 类型 H256
  • 类型 HardForkFeature
  • 类型 HardForks
  • 类型 Header
  • 类型 HeaderView
  • 类型 IndexerCell
  • 类型 IndexerCellType
  • 类型 IndexerCellsCapacity
  • 类型 IndexerOrder
  • 类型 IndexerPagination<IndexerCell>
  • 类型 IndexerPagination<IndexerTx>
  • 类型 IndexerRange
  • 类型 IndexerScriptType
  • 类型 IndexerSearchKey
  • 类型 IndexerSearchKeyFilter
  • 类型 IndexerSearchMode
  • 类型 IndexerTip
  • 类型 IndexerTx
  • 类型 IndexerTxWithCell
  • 类型 IndexerTxWithCells
  • 类型 JsonBytes
  • 类型 LocalNode
  • 类型 LocalNodeProtocol
  • 类型 MainLoggerConfig
  • 类型 MerkleProof
  • 类型 MinerReward
  • 类型 NodeAddress
  • 类型 OutPoint
  • 类型 OutputsValidator
  • 类型 PeerSyncState
  • 类型 PoolTransactionReject
  • 类型 PoolTxDetailInfo
  • 类型 ProposalShortId
  • 类型 ProposalWindow
  • 类型 Ratio
  • 类型 RationalU256
  • 类型 RawTxPool
  • 类型 RemoteNode
  • 类型 RemoteNodeProtocol
  • 类型 ResponseFormat<BlockView>
  • 类型 ResponseFormat<HeaderView>
  • 类型 ResponseFormat<TransactionView>
  • 类型 Rfc0043
  • 类型 Script
  • 类型 ScriptHashType
  • 类型 SerializedBlock
  • 类型 SerializedHeader
  • 类型 SoftFork
  • 类型 SoftForkStatus
  • 类型 Status
  • 类型 SyncState
  • 类型 Timestamp
  • 类型 Transaction
  • 类型 TransactionAndWitnessProof
  • 类型 TransactionProof
  • 类型 TransactionTemplate
  • 类型 TransactionView
  • 类型 TransactionWithStatusResponse
  • 类型 TxPoolEntries
  • 类型 TxPoolEntry
  • 类型 TxPoolIds
  • 类型 TxPoolInfo
  • 类型 TxStatus
  • 类型 U256
  • 类型 Uint128
  • 类型 Uint32
  • 类型 Uint64
  • 类型 UncleBlock
  • 类型 UncleBlockView
  • 类型 UncleTemplate
  • 类型 Version

• RPC 错误

RPC 模块

模块 Alert

• 👉 OpenRPC 规范

RPC 模块 Alert 用于网络警报。

警报是关于关键问题的消息，将通过 p2p 网络广播到所有节点。

警报必须由 2-of-4 签名签名，其中公钥在源代码中硬编码，属于早期的 CKB 开发者。

方法 send_alert

• send_alert(alert)
  • alert: Alert
• 结果: null

发送警报。

此 RPC 在成功时返回 null。

错误

• AlertFailedToVerifySignatures (-1000) - 请求中的一些签名无效。
• P2PFailedToBroadcast (-101) - 警报已保存到本地，但未能广播到 P2P 网络。
• InvalidParams (-32602) - alert.notice_until 中指定的日期必须在将来。

示例

请求

{
  "jsonrpc": "2.0",
  "method": "send_alert",
  "params": [
    {
      "id": "0x1",
      "cancel": "0x0",
      "priority": "0x1",
      "message": "An example alert message!",
      "notice_until": "0x24bcca57c00",
      "signatures": [
        "0xbd07059aa9a3d057da294c2c4d96fa1e67eeb089837c87b523f124239e18e9fc7d11bb95b720478f7f937d073517d0e4eb9a91d12da5c88a05f750362f4c214dd0",
        "0x0242ef40bb64fe3189284de91f981b17f4d740c5e24a3fc9b70059db6aa1d198a2e76da4f84ab37549880d116860976e0cf81cd039563c452412076ebffa2e4453"
      ]
    }
  ],
  "id": 42
}

响应

{
  "error": {
    "code": -1000,
    "data": "SigNotEnough",
    "message":"AlertFailedToVerifySignatures: The count of sigs is less than threshold."
  },
  "jsonrpc": "2.0",
  "result": null,
  "id": 42
}

模块 Chain

• 👉 OpenRPC 规范

RPC 模块 Chain 用于与主链相关的功能。

此模块查询有关主链的信息。

主链

主链是累积工作量最多的链。累积工作量是链中所有区块难度的总和。

链重组

当 CKB 找到累积工作量比主链更多的链时，会发生链重组。如果需要，链重组将回滚当前主链中的区块，并将主链切换到更好的链。

活动细胞

如果一个细胞是

• 在任何交易中被发现作为输出（在 主链 中），并且
• 在任何交易中都没有被发现作为输入（在主链中）。

方法 get_block

• get_block(block_hash,verbosity,with_cycles)
  • block_hash: H256
  • verbosity: Uint32 | null
  • with_cycles: boolean | null
• 结果：BlockResponse | null

通过哈希返回区块信息。

参数

• block_hash - 区块哈希。
• verbosity - 结果格式，允许0和2。(可选，默认为2)
• with_cycles - 是否返回区块交易的循环。(可选，默认为false)

返回值

RPC返回一个区块或null。当RPC返回一个区块时，区块哈希必须等于参数block_hash。

如果区块在主链中，RPC必须返回区块信息。否则，行为未定义。RPC可能返回在本地存储中找到的区块，或者简单地返回所有不在主链中的区块的null。并且由于链重组，对于相同的block_hash，RPC有时可能返回null，有时返回区块。

当verbosity为2时，它返回一个JSON对象作为result。有关架构，请参阅BlockView。

当verbosity为0时，它返回一个以0x前缀的十六进制字符串作为result。该字符串使用table Block架构编码了由molecule序列化的区块。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_block",
  "params": [
     "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "header": {
      "compact_target": "0x1e083126",
      "dao": "0xb5a3e047474401001bc476b9ee573000c0c387962a38000000febffacf030000",
      "epoch": "0x7080018000001",
      "extra_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "hash": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40",
      "nonce": "0x0",
      "number": "0x400",
      "parent_hash": "0xae003585fa15309b30b31aed3dcf385e9472c3c3e93746a6c4540629a6a1ed2d",
      "proposals_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": "0x5cd2b117",
      "transactions_root": "0xc47d5b78b3c4c4c853e2a32810818940d0ee403423bea9ec7b8e566d9595206c",
      "version": "0x0"
    },
    "proposals": [],
    "transactions": [
      {
        "cell_deps": [],
        "hash": "0x365698b50ca0da75dca2c87f9e7b563811d3b5813736b8cc62cc3b106faceb17",
        "header_deps": [],
        "inputs": [
          {
            "previous_output": {
              "index": "0xffffffff",
              "tx_hash": "0x0000000000000000000000000000000000000000000000000000000000000000"
            },
            "since": "0x400"
          }
        ],
        "outputs": [
          {
            "capacity": "0x18e64b61cf",
            "lock": {
              "code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
              "hash_type": "data",
              "args": "0x"
            },
            "type": null
          }
        ],
        "outputs_data": [
          "0x"
        ],
        "version": "0x0",
        "witnesses": [
          "0x450000000c000000410000003500000010000000300000003100000028e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5000000000000000000"
        ]
      }
    ],
    "uncles": []
  }
}

当verbosity为0时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x..."
}

指定with_cycles时，响应对象将如下不同

{
    "id": 42,
    "jsonrpc": "2.0",
    "result": {
        "block": <Object> or "0x...",
        "cycles": []
    }
}

方法 get_block_by_number

• get_block_by_number(区块编号,verbosity,with_cycles)
  • block_number - Uint64
  • verbosity: Uint32 | null
  • with_cycles: boolean | null
• 结果：BlockResponse | null

返回具有特定区块编号的主链中的区块。

参数

• block_number - 区块编号。
• verbosity - 结果格式，允许0和2。(可选，默认为2)
• with_cycles - 是否返回区块交易的循环。(可选，默认为false)

返回值

当block_number小于或等于由get_tip_block_number返回的提示区块编号时，RPC返回区块；否则返回null。

由于链重组，PRC可能在不同的调用中返回null或具有相同block_number的不同区块。

当verbosity为2时，它返回一个JSON对象作为result。有关架构，请参阅BlockView。

当verbosity为0时，它返回一个以0x前缀的十六进制字符串作为result。该字符串使用table Block架构编码了由molecule序列化的区块。

错误

• ChainIndexIsInconsistent (-201) - 索引不一致。它表示一个区块哈希在主链中，但不能从数据库中读取它。
• DatabaseIsCorrupt (-202) - 从数据库中读取的数据是脏的。请将其报告为错误。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_block_by_number",
  "params": [
    "0x400"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "header": {
      "compact_target": "0x1e083126",
      "dao": "0xb5a3e047474401001bc476b9ee573000c0c387962a38000000febffacf030000",
      "epoch": "0x7080018000001",
      "extra_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "hash": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40",
      "nonce": "0x0",
      "number": "0x400",
      "parent_hash": "0xae003585fa15309b30b31aed3dcf385e9472c3c3e93746a6c4540629a6a1ed2d",
      "proposals_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": "0x5cd2b117",
      "transactions_root": "0xc47d5b78b3c4c4c853e2a32810818940d0ee403423bea9ec7b8e566d9595206c",
      "version": "0x0"
    },
    "proposals": [],
    "transactions": [
      {
        "cell_deps": [],
        "hash": "0x365698b50ca0da75dca2c87f9e7b563811d3b5813736b8cc62cc3b106faceb17",
        "header_deps": [],
        "inputs": [
          {
            "previous_output": {
              "index": "0xffffffff",
              "tx_hash": "0x0000000000000000000000000000000000000000000000000000000000000000"
            },
            "since": "0x400"
          }
        ],
        "outputs": [
          {
            "capacity": "0x18e64b61cf",
            "lock": {
              "code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
              "hash_type": "data",
              "args": "0x"
            },
            "type": null
          }
        ],
        "outputs_data": [
          "0x"
        ],
        "version": "0x0",
        "witnesses": [
          "0x450000000c000000410000003500000010000000300000003100000028e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5000000000000000000"
        ]
      }
    ],
    "uncles": []
  }
}

当verbosity为0时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x..."
}

指定with_cycles时，响应对象将如下不同

{
    "id": 42,
    "jsonrpc": "2.0",
    "result": {
        "block": <Object> or "0x...",
        "cycles": []
    }
}

方法 get_header

• get_header(block_hash,verbosity)
  • block_hash: H256
  • verbosity: Uint32 | null
• 结果：ResponseFormat<HeaderView> | null

通过哈希返回区块头信息。

参数

• block_hash - 区块哈希。
• verbosity - 结果格式，允许0和1。(可选，默认为1)

返回值

RPC返回一个头或null。当RPC返回一个头时，区块哈希必须等于参数block_hash。

如果块位于规范链中，RPC必须返回头部信息。否则，行为未定义。RPC可能返回本地存储中找到的块，或者简单地返回所有不在规范链中的块的null。

当verbosity为1时，它以JSON对象的形式返回result。有关模式，请参阅HeaderView。

当verbosity为0时，它以0x前缀的十六进制字符串作为result返回。该字符串使用table Header模式编码了由molecule序列化的块头部。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_header",
  "params": [
    "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "compact_target": "0x1e083126",
    "dao": "0xb5a3e047474401001bc476b9ee573000c0c387962a38000000febffacf030000",
    "epoch": "0x7080018000001",
    "extra_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "hash": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40",
    "nonce": "0x0",
    "number": "0x400",
    "parent_hash": "0xae003585fa15309b30b31aed3dcf385e9472c3c3e93746a6c4540629a6a1ed2d",
    "proposals_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "timestamp": "0x5cd2b117",
    "transactions_root": "0xc47d5b78b3c4c4c853e2a32810818940d0ee403423bea9ec7b8e566d9595206c",
    "version": "0x0"
  }
}

当verbosity为0时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x..."
}

方法 get_header_by_number

• get_header_by_number(区块编号,verbosity)
  • block_number - Uint64
  • verbosity: Uint32 | null
• 结果：ResponseFormat<HeaderView> | null

返回具有特定块号的规范链中的块头部。

参数

• block_number - 块编号
• verbosity - 结果格式，允许0和1。(可选，默认为1)

返回值

当block_number小于或等于get_tip_block_number返回的顶端块号时，RPC返回块头部，否则返回null。

由于链重组，PRC可能在不同调用中返回null或具有相同block_number的不同块头部。

当verbosity为1时，它以JSON对象的形式返回result。有关模式，请参阅HeaderView。

当verbosity为0时，它以0x前缀的十六进制字符串作为result返回。该字符串使用table Header模式编码了由molecule序列化的块头部。

错误

• ChainIndexIsInconsistent (-201) - 索引不一致。它表示一个区块哈希在主链中，但不能从数据库中读取它。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_header_by_number",
  "params": [
    "0x400"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "compact_target": "0x1e083126",
    "dao": "0xb5a3e047474401001bc476b9ee573000c0c387962a38000000febffacf030000",
    "epoch": "0x7080018000001",
    "extra_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "hash": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40",
    "nonce": "0x0",
    "number": "0x400",
    "parent_hash": "0xae003585fa15309b30b31aed3dcf385e9472c3c3e93746a6c4540629a6a1ed2d",
    "proposals_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "timestamp": "0x5cd2b117",
    "transactions_root": "0xc47d5b78b3c4c4c853e2a32810818940d0ee403423bea9ec7b8e566d9595206c",
    "version": "0x0"
  }
}

当verbosity为0时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x..."
}

方法 get_block_filter

• get_block_filter(block_hash)
  • block_hash: H256
• 结果：BlockFilter | null

通过块哈希返回块过滤器。

参数

• block_hash - 区块哈希。

返回值

块过滤器数据

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_block_filter",
  "params": [
    "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": null
}

当块具有块过滤器时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
   "data": "0x...",
   "hash": "0x..."
  }
}

方法 get_transaction

• get_transaction(tx_hash,verbosity,only_committed)
  • tx_hash: H256
  • verbosity: Uint32 | null
  • only_committed: boolean | null
• 结果：TransactionWithStatusResponse

返回由交易哈希请求的交易信息。

返回值

如果交易既不在规范链中，也不在交易内存池中，则此RPC返回null。

如果交易在链中，则也返回块哈希。

参数

• tx_hash - 交易哈希
• verbosity - 结果格式，允许0、1和2。（可选，默认为2。）
• only_committed - 是否仅查询已提交的交易。（可选，未设置时，将查询所有交易状态。）

返回值

当verbosity=0时，其响应值与verbosity=2相同，但在transaction字段上返回一个0x前缀的十六进制编码的molecule packed::Transaction。

当verbosity为1时：RPC不返回交易内容，且字段transaction必须为null。

当verbosity为2时：如果tx_status.status为pending、proposed或committed，RPC将作为字段transaction返回交易内容，否则字段为null。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_transaction",
  "params": [
    "0xa0ef4eb5f4ceeb08a4c8524d84c5da95dce2f608e0ca2ec8091191b0f330c6e3"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "transaction": {
      "cell_deps": [
        {
          "dep_type": "code",
          "out_point": {
            "index": "0x0",
            "tx_hash": "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
          }
        }
      ],
      "hash": "0xa0ef4eb5f4ceeb08a4c8524d84c5da95dce2f608e0ca2ec8091191b0f330c6e3",
      "header_deps": [
        "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed"
      ],
      "inputs": [
        {
          "previous_output": {
            "index": "0x0",
            "tx_hash": "0x365698b50ca0da75dca2c87f9e7b563811d3b5813736b8cc62cc3b106faceb17"
          },
          "since": "0x0"
        }
      ],
      "outputs": [
        {
          "capacity": "0x2540be400",
          "lock": {
            "code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
            "hash_type": "data",
            "args": "0x"
          },
          "type": null
        }
      ],
      "outputs_data": [
        "0x"
      ],
      "version": "0x0",
      "witnesses": []
    },
    "cycles": "0x219",
    "time_added_to_pool" : "0x187b3d137a1",
    "fee": "0x16923f7dcf",
    "min_replace_fee": "0x16923f7f6a",
    "tx_status": {
      "block_hash": null,
      "block_number": null,
      "status": "pending",
      "tx_index": null,
      "reason": null
    }
  }
}

当verbosity为0时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "transaction": "0x.....",
    "cycles": "0x219",
    "tx_status": {
      "block_hash": null,
      "block_number": null,
      "status": "pending",
      "tx_index": null,
      "reason": null
    }
  }
}

方法 get_block_hash

• get_block_hash(区块编号)
  • block_number - Uint64
• 结果：H256 | null

返回具有指定block_number的规范链中块的哈希。

参数

• block_number - 块编号

返回值

当 block_number 小于或等于由 get_tip_block_number 返回的链头区块号时，RPC 返回该区块的哈希值；否则返回 null。

由于 链重组，PRC 可能返回 null，甚至在相同 block_number 下返回不同的区块哈希。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_block_hash",
  "params": [
    "0x400"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40"
}

方法 get_tip_header

• get_tip_header(verbosity)
  • verbosity: Uint32 | null
• 结果: ResponseFormat<HeaderView>

返回 规范链 中具有最高区块号的头部。

由于 链重组，返回的区块号可能小于之前的调用，并且不同的调用可能返回具有相同区块号的不同的区块头部。

参数

• verbosity - 结果格式，允许0和1。(可选，默认为1)

返回值

当 verbosity 为 1 时，RPC 以 JSON 对象作为 result 返回。有关架构信息，请参阅 HeaderView。

当 verbosity 为 0 时，它以以 0x 开头的十六进制字符串作为 result 返回。该字符串使用 table Header 架构编码头部序列化。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_tip_header",
  "params": []
}

响应

{
  "jsonrpc": "2.0",
  "result": {
    "compact_target": "0x1e083126",
    "dao": "0xb5a3e047474401001bc476b9ee573000c0c387962a38000000febffacf030000",
    "epoch": "0x7080018000001",
    "extra_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "hash": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40",
    "nonce": "0x0",
    "number": "0x400",
    "parent_hash": "0xae003585fa15309b30b31aed3dcf385e9472c3c3e93746a6c4540629a6a1ed2d",
    "proposals_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "timestamp": "0x5cd2b117",
    "transactions_root": "0xc47d5b78b3c4c4c853e2a32810818940d0ee403423bea9ec7b8e566d9595206c",
    "version": "0x0"
  },
  "id": 42
}

当verbosity为0时，响应如下。

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x..."
}

方法 get_live_cell

• get_live_cell(out_point,with_data,include_tx_pool)
  • out_point: OutPoint
  • with_data: boolean
  • include_tx_pool: boolean | null
• 结果: CellWithStatus

返回单元格的状态。如果是 活动单元格，RPC 将返回额外的信息。

返回值

此 RPC 告诉单元格是否是活动的。

如果是活动单元格，RPC 将返回有关单元格的详细信息。否则，结果中的 cell 字段为 null。

如果是活动单元格且 with_data 设置为 false，结果中的 cell.data 字段为 null。

参数

• out_point - 通过交易哈希和输出索引引用单元格。
• with_data - RPC 是否应返回单元格数据。单元格数据可能很大，如果客户端不需要数据，它应将此设置为 false 以节省带宽。
• include_tx_pool - RPC 是否检查 TxPool 中的活动单元格，默认为 false。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_live_cell",
  "params": [
    {
      "index": "0x0",
      "tx_hash": "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
    },
    true
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "cell": {
      "data": {
        "content": "0x7f454c460201010000000000000000000200f3000100000078000100000000004000000000000000980000000000000005000000400038000100400003000200010000000500000000000000000000000000010000000000000001000000000082000000000000008200000000000000001000000000000001459308d00573000000002e7368737472746162002e74657874000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000b000000010000000600000000000000780001000000000078000000000000000a0000000000000000000000000000000200000000000000000000000000000001000000030000000000000000000000000000000000000082000000000000001100000000000000000000000000000001000000000000000000000000000000",
        "hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5"
      },
      "output": {
        "capacity": "0x802665800",
        "lock": {
          "code_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
          "hash_type": "data",
          "args": "0x"
        },
        "type": null
      }
    },
    "status": "live"
  }
}

方法 get_tip_block_number

• get_tip_block_number()

• 结果: Uint64

返回 规范链 中的最高区块号。

由于 链重组，返回的区块号可能小于之前调用返回的值。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_tip_block_number",
  "params": []
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x400"
}

方法 get_current_epoch

• get_current_epoch()

• 结果: EpochView

返回 规范链 中具有最高数字的纪元。

请注意，由于 链重组，具有特定区块号的区块可能发生变化，因此此 RPC 可能返回具有相同纪元数字的不同纪元。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_current_epoch",
  "params": []
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "compact_target": "0x1e083126",
    "length": "0x708",
    "number": "0x1",
    "start_number": "0x3e8"
  }
}

方法 get_epoch_by_number

• get_epoch_by_number(epoch_number)
  • epoch_number: Uint64
• 结果: EpochView | null

返回 规范链 中具有特定纪元数字的纪元。

参数

• epoch_number - 纪元数字

返回值

当epoch_number小于或等于由get_current_epoch返回的当前纪元数时，RPC返回该纪元；否则返回null。

由于链重组，对于相同的epoch_number，此RPC可能在不同的调用中返回null或不同的纪元。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_epoch_by_number",
  "params": [
    "0x0"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "compact_target": "0x20010000",
    "length": "0x3e8",
    "number": "0x0",
    "start_number": "0x0"
  }
}

方法 get_block_economic_state

• get_block_economic_state(block_hash)
  • block_hash: H256
• 结果: BlockEconomicState | null

返回区块的增加发行量、矿工奖励以及总交易费。

如果区块不在主链上，此RPC返回null。

CKB延迟为矿工创建CKB。区块N的cellbase输出细胞是为创建区块N - 1 - ProposalWindow.farthest的矿工而创建的。

在主网上，ProposalWindow.farthest为10，因此区块100的输出是奖励给创建区块89的矿工。

由于延迟，如果区块奖励尚未最终确定，此RPC返回null。例如，只有当get_tip_block_number返回的数字大于或等于100时，区块89的经济状态才可用。

参数

• block_hash - 指定应分析奖励的区块哈希。

返回值

如果具有哈希block_hash的区块位于主链上，并且其奖励已最终确定，则返回此区块的区块奖励分析。一个特殊情况是创世块的返回值为null。

示例

请求

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_block_economic_state",
  "params": [
    "0x02530b25ad0ff677acc365cb73de3e8cc09c7ddd58272e879252e199d08df83b"
  ]
}

响应

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "finalized_at": "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40",
    "issuance": {
      "primary": "0x18ce922bca",
      "secondary": "0x7f02ec655"
    },
    "miner_reward": {
      "committed": "0x0",
      "primary": "0x18ce922bca",
      "proposal": "0x0",
      "secondary": "0x17b93605"
    },
    "txs_fee": "0x0"
  }
}

方法 get_transaction_proof

• get_transaction_proof(tx_hashes,block_hash)
  • tx_hashes: Array< H256 >
  • block_hash: H256 | null
• 结果: TransactionProof

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_transaction_proof",
  "params": [
    [ "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3" ]
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "block_hash": "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed",
    "proof": {
      "indices": [ "0x0" ],
      "lemmas": []
    },
    "witnesses_root": "0x2bb631f4a251ec39d943cc238fc1e39c7f0e99776e8a1e7be28a03c70c4f4853"
  }
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "verify_transaction_proof",
  "params": [
    {
      "block_hash": "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed",
      "proof": {
        "indices": [ "0x0" ],
        "lemmas": []
      },
      "witnesses_root": "0x2bb631f4a251ec39d943cc238fc1e39c7f0e99776e8a1e7be28a03c70c4f4853"
    }
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": [
    "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_transaction_and_witness_proof",
  "params": [
    [ "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3" ]
  ]
}

{
    "jsonrpc": "2.0",
    "result": {
        "block_hash": "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed",
        "transactions_proof": {
            "indices": [ "0x0" ],
            "lemmas": []
        },
        "witnesses_proof": {
            "indices": [
                "0x0"
            ],
            "lemmas": []
        }
    },
    "id": 42
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "verify_transaction_and_witness_proof",
  "params": [
    {
      "block_hash": "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed",
        "transactions_proof": {
            "indices": [ "0x0" ],
            "lemmas": []
        },
        "witnesses_proof": {
            "indices": [
                "0x0"
            ],
            "lemmas": []
        }
    }
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": [
    "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_fork_block",
  "params": [
    "0xdca341a42890536551f99357612cef7148ed471e3b6419d0844a4e400be6ee94"
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "header": {
      "compact_target": "0x1e083126",
      "dao": "0xb5a3e047474401001bc476b9ee573000c0c387962a38000000febffacf030000",
      "epoch": "0x7080018000001",
      "extra_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "hash": "0xdca341a42890536551f99357612cef7148ed471e3b6419d0844a4e400be6ee94",
      "nonce": "0x0",
      "number": "0x400",
      "parent_hash": "0xae003585fa15309b30b31aed3dcf385e9472c3c3e93746a6c4540629a6a1ed2d",
      "proposals_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": "0x5cd2b118",
      "transactions_root": "0xc47d5b78b3c4c4c853e2a32810818940d0ee403423bea9ec7b8e566d9595206c",
      "version": "0x0"
    },
    "proposals": [],
    "transactions": [
      {
        "cell_deps": [],
        "hash": "0x365698b50ca0da75dca2c87f9e7b563811d3b5813736b8cc62cc3b106faceb17",
        "header_deps": [],
        "inputs": [
          {
            "previous_output": {
              "index": "0xffffffff",
              "tx_hash": "0x0000000000000000000000000000000000000000000000000000000000000000"
            },
            "since": "0x400"
          }
        ],
        "outputs": [
          {
            "capacity": "0x18e64b61cf",
            "lock": {
              "code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
              "hash_type": "data",
              "args": "0x"
            },
            "type": null
          }
        ],
        "outputs_data": [
          "0x"
        ],
        "version": "0x0",
        "witnesses": [
          "0x450000000c000000410000003500000010000000300000003100000028e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5000000000000000000"
        ]
      }
    ],
    "uncles": []
  }
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x..."
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_consensus",
  "params": []
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
        "block_version": "0x0",
        "cellbase_maturity": "0x10000000000",
        "dao_type_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "epoch_duration_target": "0x3840",
        "genesis_hash": "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed",
        "hardfork_features": [
            { "rfc": "0028", "epoch_number": "0x1526" },
            { "rfc": "0029", "epoch_number": "0x0" },
            { "rfc": "0030", "epoch_number": "0x0" },
            { "rfc": "0031", "epoch_number": "0x0" },
            { "rfc": "0032", "epoch_number": "0x1526" },
            { "rfc": "0036", "epoch_number": "0x0" },
            { "rfc": "0038", "epoch_number": "0x0" },
            { "rfc": "0048", "epoch_number": null },
            { "rfc": "0049", "epoch_number": null }
         ],
        "id": "main",
        "initial_primary_epoch_reward": "0x71afd498d000",
        "max_block_bytes": "0x91c08",
        "max_block_cycles": "0xd09dc300",
        "max_block_proposals_limit": "0x5dc",
        "max_uncles_num": "0x2",
        "median_time_block_count": "0x25",
        "orphan_rate_target": {
            "denom": "0x28",
            "numer": "0x1"
        },
        "permanent_difficulty_in_dummy": false,
        "primary_epoch_reward_halving_interval": "0x2238",
        "proposer_reward_ratio": {
            "denom": "0xa",
            "numer": "0x4"
        },
        "secondary_epoch_reward": "0x37d0c8e28542",
        "secp256k1_blake160_multisig_all_type_hash": null,
        "secp256k1_blake160_sighash_all_type_hash": null,
        "softforks": {
            "testdummy": {
                "status": "rfc0043",
                "rfc0043": {
                    "bit": 1,
                    "min_activation_epoch": "0x0",
                    "period": "0xa",
                    "start": "0x0",
                    "threshold": {
                        "denom": "0x4",
                        "numer": "0x3"
                    },
                    "timeout": "0x0"
                }
            }
        },
        "tx_proposal_window": {
            "closest": "0x2",
            "farthest": "0xa"
        },
        "tx_version": "0x0",
        "type_id_code_hash": "0x00000000000000000000000000000000000000000000000000545950455f4944"
    }
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_block_median_time",
  "params": [
    "0xa5f5c85987a15de25661e5a214f2c1449cd803f071acc7999820f25246471f40"
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": "0x5cd2b105"
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "estimate_cycles",
  "params": [
    {
      "cell_deps": [
        {
          "dep_type": "code",
          "out_point": {
            "index": "0x0",
            "tx_hash": "0xa4037a893eb48e18ed4ef61034ce26eba9c585f15c9cee102ae58505565eccc3"
          }
        }
      ],
      "header_deps": [
        "0x7978ec7ce5b507cfb52e149e36b1a23f6062ed150503c85bbf825da3599095ed"
      ],
      "inputs": [
        {
          "previous_output": {
            "index": "0x0",
            "tx_hash": "0x365698b50ca0da75dca2c87f9e7b563811d3b5813736b8cc62cc3b106faceb17"
          },
          "since": "0x0"
        }
      ],
      "outputs": [
        {
          "capacity": "0x2540be400",
          "lock": {
            "code_hash": "0x28e83a1277d48add8e72fadaa9248559e1b632bab2bd60b27955ebc4c03800a5",
            "hash_type": "data",
            "args": "0x"
          },
          "type": null
        }
      ],
      "outputs_data": [
        "0x"
      ],
      "version": "0x0",
      "witnesses": []
    }
  ]
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "cycles": "0x219"
  }
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_fee_rate_statics",
  "params": []
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "mean": "0xe79d",
    "median": "0x14a8"
   }
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "method": "get_fee_rate_statistics",
  "params": []
}

{
  "id": 42,
  "jsonrpc": "2.0",
  "result": {
    "mean": "0xe79d",
    "median": "0x14a8"
   }
}