← 博客
10 分钟阅读
|
发布于
|
更新于

BNB Smart Chain API:你可以构建什么

BNB Smart Chain API 提供的功能:钱包、BNB 与 BEP-20 转账、余额及 Webhook,附请求示例。文章列出 Chaingateway BSC 端点的五组功能,并说明公共 RPC 的限制,以及何时公共端点已经足够。

章节
C
Chaingateway Team
区块链专家

审核: Maurice Sobiera

BNB Smart Chain API 是 BNB 智能链(BSC,原名 Binance Smart Chain)的网络接口。它让应用无需运行 BSC 节点,即可创建钱包、发送 BNB 和 BEP-20 代币、读取余额并接收充值通知。你的后端发送 HTTPS 请求,服务商负责签名、广播和链访问。

本文列出此类 API 涵盖的内容,展示两个针对 Chaingateway BSC 端点的请求,并说明何时公共 RPC 端点就已足够。

BSC API 涵盖哪些功能?

BSC API 涵盖付款或钱包后端所需的操作。依据 OpenAPI 文件,Chaingateway 的端点分为五组:

分组端点
地址POST /api/v2/bsc/addresses 创建钱包,GET 列出钱包,POST /api/v2/bsc/addresses/import 导入私钥
余额GET /api/v2/bsc/balances/{address} 查询 BNB,GET /api/v2/bsc/balances/{address}/bep20/{contract_address} 查询 BEP-20 代币
转账POST /api/v2/bsc/transactions 转 BNB,POST /api/v2/bsc/transactions/bep20 转 BEP-20 代币,POST /api/v2/bsc/transactions/bep721 转 NFT
链上数据最新区块、按编号或哈希查询区块、交易、收据、Gas 价格、NFT 所有者和代币 URI
Webhook创建、更新和删除 Webhook,列出通知、列出失败的通知并重试

所有请求都在 Authorization 请求头中使用 Bearer 令牌。发送 X-Network: testnet 即可使用测试网。不带该请求头的请求会发送到主网。

如何查询余额并发送 BNB?

用一次 GET 请求查询余额,再用一次 POST 请求发送 BNB。两个示例都使用基础地址 https://app.chaingateway.io 和控制台中的令牌。

Terminal window
curl https://app.chaingateway.io/api/v2/bsc/balances/0x0000000000000000000000000000000000001000 \
-H "Authorization: Bearer $CHAINGATEWAY_TOKEN" \
-H "X-Network: testnet"

响应以十进制字符串的形式包含余额:

{"status": 200, "ok": true, "message": "Balance fetched", "data": "0.000000000000000000"}

要从你通过 API 创建的钱包发送 BNB,请提交发送方、接收方、金额和钱包密码。Gas 字段是可选的。

Terminal window
curl -X POST https://app.chaingateway.io/api/v2/bsc/transactions \
-H "Authorization: Bearer $CHAINGATEWAY_TOKEN" \
-H "X-Network: testnet" \
-H "Content-Type: application/json" \
-d '{"from": "0x...", "to": "0x...", "amount": "0.001", "password": "wallet-password"}'

如果发送方的 BNB 不足以支付金额加 Gas,API 会返回状态码 422,并附带节点的 insufficient funds 消息。钱包密码错误则返回 401。

如何读取代币余额与交易?

在路径中传入钱包地址和代币合约地址,即可读取 BEP-20 代币余额。使用交易哈希即可读取交易。两者都是 GET 请求,请求头与上文相同。

Terminal window
# BEP-20 token balance
curl https://app.chaingateway.io/api/v2/bsc/balances/0xWalletAddress/bep20/0xTokenContract \
-H "Authorization: Bearer $CHAINGATEWAY_TOKEN"
# Transaction with decoded data
curl https://app.chaingateway.io/api/v2/bsc/transactions/0xTransactionHash/decoded \
-H "Authorization: Bearer $CHAINGATEWAY_TOKEN"
# Current gas price
curl https://app.chaingateway.io/api/v2/bsc/gasprice \
-H "Authorization: Bearer $CHAINGATEWAY_TOKEN"

余额端点以十进制字符串返回代币数量,因此你无需自行按代币的小数位数换算。已解码的交易端点会以可读字段返回交易,而不是原始的十六进制数据。未知哈希会返回 422 响应,消息为 transaction not found。

GET /api/v2/bsc/transactions 列出你自己的交易历史。它只包含通过 Chaingateway API 发起的交易,因为 Chaingateway 不会自动索引你的地址。若要查看转入的转账,请使用 Webhook。

如果你已经持有某个钱包,可以使用 POST /api/v2/bsc/addresses/import 导入其私钥。导入的钱包和新建的钱包使用相同的发送及 Webhook 端点。

如何获得充值通知?

使用 POST /api/v2/bsc/webhooks 创建 Webhook。url 字段为必填。可按 to(收款地址)、from,或代币的 contractaddress 进行过滤,并将 type 设为 BNB、BEP20 或 BEP721。检测到匹配的交易时,Chaingateway 会将交易数据发送到你的 URL。

Webhook 不会自动重试。失败的投递会出现在 GET /api/v2/bsc/webhooks/notifications/failed 中,而 POST /api/v2/bsc/webhooks/notifications/{id}/retry 会再次发送它。请让你的接收端点具有幂等性,以交易 ID 为键,确保重试不会导致账户被重复入账。

什么是 BEP-20?

BEP-20 是 BNB 智能链的代币标准。根据其规范,它源自以太坊的 ERC-20,并要求实现以下函数:symbol()、decimals()、totalSupply()、balanceOf()、transfer()、transferFrom()、approve() 和 allowance()。因此,同一套钱包代码既可用于 BSC 上的代币,也可用于以太坊上的代币,Chaingateway 的 BSC 端点也与以太坊端点保持一致。

何时公共 RPC 端点就够用?

BNB Chain 为主网和测试网提供公共 JSON-RPC 端点。BNB Chain 文档规定的速率限制为每 5 分钟 10,000 次请求,并说明公共主网端点已禁用 eth_getLogs。

对于原型和偶尔的读取,这已经足够。对于需要监视大量地址的服务,你需要自己的节点、服务商,或是能够向你推送事件的 API。关于节点路线,参见如何使用 JSON-RPC 与节点通信。Chaingateway 方面的更多信息见 BSC API 页面。

我们如何撰写这些文章

准备好自己动手构建了吗? 获取你的 API key — 7 天试用,无需信用卡 — 或查看 Binance Smart Chain API 获取完整的 endpoint 参考。

C
Chaingateway Team
区块链专家

Chaingateway 团队致力于为全球开发者简化区块链集成。