Elastos.ELA节点RESTful API详解

概述

Elastos.ELA节点通过RESTful API提供了丰富的区块链数据查询和交互功能。这些API运行在节点的20334端口，开发者可以通过HTTP请求获取节点状态、区块信息、交易数据等关键信息。本文将详细介绍这些API的功能和使用方法。

基础API

1. 节点连接数查询

端点：/api/v1/node/connectioncount

功能：查询当前节点连接的其他节点数量

示例请求：

curl http://localhost:20334/api/v1/node/connectioncount

返回示例：

{
    "Desc": "Success",
    "Error": 0,
    "Result": 5
}

2. 节点状态查询

端点：/api/v1/node/state

功能：获取节点的详细状态信息，包括版本号、区块高度、邻居节点等

返回字段说明：

• Compile：节点编译版本
• Height：当前区块高度
• Neighbors：邻居节点列表，包含各节点的ID、高度和网络地址

示例请求：

curl http://localhost:20334/api/v1/node/state

区块相关API

3. 区块高度查询

端点：/api/v1/block/height

功能：获取当前节点的最新区块高度

示例请求：

curl http://localhost:20334/api/v1/block/height

4. 区块哈希查询

端点：/api/v1/block/hash/<height>

功能：根据区块高度查询对应的区块哈希值

参数：

• <height>：要查询的区块高度

示例请求：

curl http://localhost:20334/api/v1/block/hash/123

5. 区块详情查询

端点：

• /api/v1/block/details/height/<height>
• /api/v1/block/details/hash/<hash>

功能：通过高度或哈希获取区块的完整信息，包括交易列表、时间戳、难度值等

返回字段说明：

• merkleroot：区块的默克尔根
• tx：包含的交易列表
• difficulty：区块难度
• previousblockhash：前一个区块的哈希
• nextblockhash：后一个区块的哈希

示例请求：

curl http://localhost:20334/api/v1/block/details/height/123

交易相关API

6. 交易池查询

端点：/api/v1/transactionpool

功能：获取当前内存池中的交易信息

返回字段说明：

• txid：交易ID
• vout：交易输出列表
• confirmations：确认数（0表示未确认）
• type：交易类型

示例请求：

curl http://localhost:20334/api/v1/transactionpool

7. 交易详情查询

端点：/api/v1/transaction/<hash>

功能：根据交易哈希获取交易的详细信息

参数：

• <hash>：交易哈希值

示例请求：

curl http://localhost:20334/api/v1/transaction/5c0a30ad3764e6524803ac673d552af59acac910cea36f1678d5b0ae03c67078

8. 交易广播

端点：/api/v1/transaction

方法：POST

功能：向网络广播新的交易

请求参数：

• data：已签名的交易数据

示例请求：

curl -X POST http://localhost:21334/api/v1/transaction -H "Content-Type: application/json" -d '{"Action": "sendrawtransaction", "data": "02000100..."}'

资产相关API

9. 地址余额查询

端点：/api/v1/asset/balances/<addr>

功能：查询指定地址的所有资产余额

参数：

• <addr>：ELA地址

示例请求：

curl http://localhost:20334/api/v1/asset/balances/EgHPRhodCsDKuDBPApCK3KLayiBomrJrbH

10. UTXO查询

端点：/api/v1/asset/utxos/<addr>

功能：查询指定地址的未花费交易输出(UTXO)

返回字段说明：

• AssetId：资产ID
• Utxo：未花费输出列表，包含交易ID、输出索引和金额

示例请求：

curl http://localhost:20334/api/v1/asset/utxos/EgHPRhodCsDKuDBPApCK3KLayiBomrJrbH

其他API

11. 服务重启

端点：/api/v1/restart

功能：重启RESTful服务

12. 区块确认信息

端点：

• /api/v1/confirm/details/height/<height>
• /api/v1/confirm/details/hash/<hash>

功能：查询区块的确认信息，包括投票情况

返回字段说明：

• initiator：发起人
• votes：投票列表，包含签名者和投票结果

示例请求：

curl http://localhost:20334/api/v1/confirm/details/height/123

最佳实践

1. 错误处理：所有API返回都包含Error字段，0表示成功，非0表示错误

2. 分页查询：对于大量数据的查询，建议客户端实现分页逻辑

3. 交易构造：构建交易时，建议使用官方工具生成签名数据

4. 连接管理：频繁查询时，保持HTTP连接持久化可以提高性能

5. 数据验证：重要操作如交易广播，建议先本地验证数据有效性

总结

Elastos.ELA的RESTful API提供了全面的区块链数据访问接口，开发者可以利用这些API构建钱包、区块浏览器等应用。本文介绍了主要的API端点及其使用方法，实际开发时应参考最新的API文档，并注意部分API可能在未来版本中被弃用。