Chia区块链的RPCAPI中文文档

1、ChiaRPCAPI简述：

Chia节点内嵌JSONRPCAPI服务项目，开发者可以使用该服务来获取区块链信息内容并进行控制。开发者可以使用HTTP、WebSockets或Python手机客户端来浏览这种API。RPCAPI的端口号可以在~/.chia/mainnet/config/config.yaml环境变量中进行设置。需要注意的是，为了安全考虑，不要在网络上暴露RPCAPI端口号，Chia应用TLS资格证书用于数据加密通讯。

ChiaRPCAPI默认设置端口号如下所示：

• Daemon/后台管理服务项目：55400

• FullNode/全节点：8555

• Farmer/农民：8559

• Harvester/收种人：8560

• Wallet/钱包:9256

在命令启用RPCAPI时必须应用资格证书，确保应用了合适的资格证书。所有的客户端节点都是采用JSON数据信息进行POST请求，回应结果是一个JSON词典，在其中的success字段名可以是true或false。

假如开发者使用 WebSocket API，则可以同时使用Daemon来路由器请求。每一个WebSocket信息都包括下列字段名：

{"command":"get_blockchain_state","ack":false,"data":{},"request_id":"123456","destination":"wallet","origin":"ui",}

大部分RPC方式都可以通过访问Chia的命令完成来掌握其操作方法，例如部分chiahwallet、chiashow等命令。

开发者可以查询JavaScript手机客户端完成地址：https://github.com/freddiecoleman/chia-client。

2、ChiaRPCAPI文件目录：

• FullNodeApi

get_blockchain_state：查询区块链情况

get_block：查询指定区块

get_blocks：查询指定高度区段的区块

get_block_record_by_height：查询指定高度的区块记录

get_block_record：查询指定哈希的区块记录

get_block_records：查询指定高度区段的区块记录

get_unfinished_block_headers：查询未完成的区块

get_network_space：查询互联网总室内空间

get_additions_and_removals：查询加上和删除历史记录

get_initial_freeze_period：查询最初的冻结期

get_network_info：查询信息网络

get_coin_records_by_puzzle_hash：查询指定哈希的coin记录

get_coin_record_by_name：查询指定名字的coin记录

push_tx：提交买卖

get_all_mempool_tx_ids：返回内存池所有买卖ID

get_all_mempool_items：返回内存池所有买卖

get_mempool_item_by_tx_id：返回内存池指定买卖

• WalletApi

log_in：登录钱包

get_public_keys：查询根公开密钥

get_private_key：查询根私钥

generate_mnemonic：生成助记词

add_key：添加公钥

delete_key：删除公钥

delete_all_keys：删除所有的公钥

get_sync_status：查询钱包同步情况

get_height_info：查询钱包高度信息

farm_block：模拟耕地区块

get_initial_freeze_period：查询最初的冻结期

get_network_info：查询信息网络

get_wallets：查询公钥的详细地址

create_new_wallet：创建新钱包

get_wallet_balance：查询钱包账户余额

get_transaction：查询指定交易的信息

get_transactions：查询交易记录

get_next_address：返回下一个详细地址

send_transaction：提交买卖

create_backup：创建钱包备份数据

get_transaction_count：查询钱包买卖总数

get_farmed_amount：查询奖励信息

• HarvesterApi

get_plots：查询所有的制图

refresh_plots：更新制图

delete_plot：删除制图

add_plot_directory：添加制图文件目录

get_plot_directories：查询制图文件目录

remove_plot_directory：删除制图文件目录

• FarmerApi

get_signage_point：查询指定的signage点

get_signage_points：查询signage点的详细信息

get_reward_targets：查询耕地总体目标的详细地址

set_reward_targets：设置耕地总体目标的详细地址

• 公共性Api

get_connections：查询联接节点

open_connection：连接节点

close_connection：断开节点联接

stop_node：停止节点运作

热点：pi 区块链