Bitcoind Rest API

通过rest api端点从Bitcoind请求数据。

☠️⚠️ 进行中 ⚠️☠️

安装

将包添加到Cargo.toml文件中

$ cargo install bitcoind-rest-api

设置

必须在终端中设置以下环境变量才能运行。可以放入你的 .zshrc 或 .bashrc

export BITCOIND_PASSWORD="..."
export BITCOIND_USERNAME="..."
export BITCOIND_URL="127.0.0.1:8332"

启动服务器

要在默认主机和端口 127.0.0.1:3030 上启动服务器，请运行

 $ bitcoind-rest-api

要指定端口启动服务器，请传递PORT参数

 $ bitcoind-rest-api 3031

可选地传递环境变量到脚本中

 BITCOIND_PASSWORD=... BITCOIND_USERNAME=...BITCOIND_URL=... bitcoind-rest-api

通过HTTPS提供服务

要通过HTTPS提供服务，必须设置以下环境变量

IS_TLS_ENABLED=true TLS_CERT_PATH="<CERT_PATH_HERE>" TLS_KEY_PATH="<KEY_PATH_HERE>"

端点

使用的端点应直接映射到rpc命令和参数，其中命令名称是url路径，参数是查询参数。如果rpc参数是可选的，则查询参数也是可选的——同样适用于必需参数。例如，getchaintxstats 命令接受两个参数，nblocks 和 blockhash，因此请求相同信息的url路径将是 localhost:3030/api/v1/getchaintxstats?nblocks={...}&blockhash={...}

已实现以下端点

getblockcount

GET /api/v1/getblockcount

getblockstats

GET /api/v1/getblockstats?hash_or_height={blockhash or height}

getchaintxstats

GET /api/v1/getchaintxstats?n_blocks={nblocks}&blockhash={blockhash}

getdifficutly

GET /api/v1/getdifficutly

getnetworkhashps

GET /api/v1/getnetworkhashps?n_blocks={nblocks}&height={height}

gettxoutsetinfo

注意：这将花费几秒钟（或更长）才能返回

GET /api/v1/gettxoutsetinfo?hash_type={hash_type}

getblockhash

GET /api/v1/getblockhash?height={height}

getblock

GET /api/v1/getblock?blockhash={blockhash}&verbosity={verbosity}

getblockchaininfo

GET /api/v1/getblockchaininfo

相关

• bitcoind-request - 环绕bitcoind RPC命令的类型安全包装器
• bitcoin-node-query - 查询有关比特币网络的信息

许可

MIT © Joe Gesualdo