Tendermint RPC API文档
Tendermint支持以下RPC协议:
- URI over HTTP
- JSONRPC over HTTP
- JSONRPC over websockets
可以使用配置文件$TMHOME/config/config.toml
或使用命令行参数--rpc.X
来调整terdernmint节点的rpc功能。
默认的rpc监听地址是tcp://0.0.0.0:26657
,要设置为其他地址,可以
修改laddr
配置参数。
要启用CORS,可以配置以下参数:
- cors_allowed_origins
- cors_allowed_methods
- cors_allowed_headers
RPC API的调用参数如果要求是字符串或字节数组,那么可以传入带引号
的字符串,例如"abc"
或者0x前缀的16进制表示,例如0x616263
。
JSONRPC请求可以采用HTTP协议的POST方式发送到RPC根访问点,即:http://localhost:26657/
。
JSONRPC请求可以使用websocket通道。Tendermint节点的websocket访问端结点
是/websocket
,例如:localhost:26657/websocket
。
异步RPC请求例如subscribe
和unbsubscribe
仅对websocket有效。
查询API:
- ABCIInfo - 获取应用描述信息
- ABCIQuery - 查询应用数据
- Block - 获取指定区块数据
- BlockResults - 获取指定区块ABCI结果
- BlockchainInfo - 查询区块链
- Commit - 查询提交数据
- ConsensusParams - 查询共识参数
- ConsensusState - 查询共识状态
- DumpConsensusState - 导出共识状态
- Genesis - 获取创世文件
- Health - 查询节点健康状态
- NetInfo - 查询节点网络状况
- NumUnconfirmedTxs - 查询未确认交易
- Status - 查询Tendermint状态
- Tx - 获取指定交易
- TxSearch - 查询交易
- UnconfirmedTxs - 获取未确认交易
- UnsafeDialPeers
- UnsafeDialSeeds
- Validators - 返回验证节点集
交易API:
实时事件API: