跳到主要内容

Alkanes 集成

Alkanes CLI (alkanes-cli) 是与 Bitcoin 上 Alkanes 元协议交互的主要命令行工具。它提供了钱包管理、代币操作、合约部署和网络查询等命令。

安装​

从 alkanes-rs 仓库安装:

git clone https://github.com/kungfuflex/alkanes-rs
cd alkanes-rs
cargo build --release

编译后的二进制文件位于 target/release/alkanes-cli。

全局选项​

所有命令均支持以下全局选项:

选项描述
--wallet-file <PATH>钱包文件路径
--passphrase <PHRASE>用于签名的钱包密码
--wallet-address <ADDR>只读模式(仅查看)
--jsonrpc-url <URL>自定义 JSON-RPC 端点
--provider <PROVIDER>网络:regtest、signet、mainnet
--frbtc-address <ADDR>覆盖 frBTC 合约地址

钱包命令​

创建钱包​

alkanes-cli wallet create

创建一个新钱包并生成 12 个助记词。请妥善保管此助记词。

列出地址​

alkanes-cli wallet addresses p2tr:0-5

显示钱包地址。可传入一个或多个位置参数形式的范围 TYPE:START-END(例如 p2tr:0-5 或 p2sh:0-500)来指定要显示的地址。不传范围时,显示当前网络下每种类型的前 5 个地址。

查询余额​

alkanes-cli wallet balance

显示钱包的 BTC 和代币余额。

列出 UTXO​

alkanes-cli wallet utxos

列出钱包中所有未花费的交易输出。

Alkanes 操作​

将 BTC 包装为 frBTC​

alkanes-cli alkanes wrap-btc <AMOUNT> \
--to <RECIPIENT_ADDRESS> \
--from <YOUR_ADDRESS> \
--change <CHANGE_ADDRESS> \
--fee-rate <SAT_PER_VB> \
-y

将原生 BTC 包装为 frBTC 代币。<AMOUNT> 为以聪为单位的整数金额(下例包装 1000000 聪 = 0.01 BTC),--to 为必填项。-y 标志表示自动确认交易。

示例:

alkanes-cli alkanes wrap-btc 1000000 \
--to bc1p... \
--from bc1q... \
--change bc1q... \
--fee-rate 10 \
-y

查询代币余额​

alkanes-cli alkanes getbalance <ADDRESS>

查看待处理的解包请求​

alkanes-cli alkanes unwrap --block-tag latest

显示等待处理的 frBTC 解包请求。

执行自定义交易​

alkanes-cli alkanes execute <PROTOSTONES> \
--inputs <REQUIREMENTS> \
--to <ADDRESSES> \
-y

供高级用户构建自定义 Alkanes 交易。Protostone 规格以位置参数传入,而不是通过标志传入。

输入格式:

  • B:amount — 以聪为单位的比特币数量
  • BLOCK:TX:amount — 指定代币数量

检查合约​

alkanes-cli alkanes inspect <OUTPOINT> --disasm --meta

反汇编并检查合约字节码。

模拟交易​

alkanes-cli alkanes simulate 32:0:103

在不广播任何交易的情况下模拟合约调用。参数格式为 BLOCK:TX:OPCODE[:ARG...];本例调用 frBTC 合约 {32, 0} 的操作码 103(获取签名者,见下表)。

Bitcoin RPC 命令​

直接访问 Bitcoin Core RPC:

# 获取区块数量
alkanes-cli bitcoind getblockcount

# 获取原始交易
alkanes-cli bitcoind getrawtransaction <TXID>

# 解码交易
alkanes-cli bitcoind decoderawtransaction <TX_HEX>

# 发送交易
alkanes-cli bitcoind sendrawtransaction <TX_HEX>

Esplora 命令​

查询 Esplora API:

# 获取地址信息
alkanes-cli esplora address <ADDRESS>

# 获取地址 UTXO
alkanes-cli esplora address-utxo <ADDRESS>

# 获取交易
alkanes-cli esplora tx <TXID>

# 手续费估算
alkanes-cli esplora fee-estimates

交易选项​

手续费率​

设置自定义手续费率(单位:sat/vB):

--fee-rate 15

广播方式​

选项描述
默认标准内存池广播
--use-slipstreamMARA Slipstream(绕过内存池)
--use-rebarRebar Shield(带 MEV 保护的私有中继)
--mine立即挖矿(仅限 regtest)

自动确认​

跳过确认提示:

-y, --auto-confirm

关键常量​

常量值描述
frBTC 合约{32, 0}区块 32,交易 0
包装操作码77frBTC exchange 函数
解包操作码78frBTC unwrap 函数
获取签名者操作码103查询签名者公钥
创世区块880000主网创世区块

获取帮助​

alkanes-cli --help
alkanes-cli <COMMAND> --help

如有问题或希望贡献代码:kungfuflex/alkanes-rs

另请参阅​