logoAnt Design Web3

Bitcoin

Ant Design Web3 官方提供了 @ant-design/web3-bitcoin 来适配比特币,它为 @ant-design/web3 的组件提供了连接比特币链的能力。你不需要自己处理组件的连接状态,它会通过 Web3ConfigProvider 为组件提供相关全局状态和接口。同时,也不需要定制化处理钱包,useBitcoinWallet 暴露出了诸如签名、交易等通用的方法, 可以直接调用。当然了,你依然可以通过 provider 调用不同钱包独有的 API。

目前支持的钱包如下,也欢迎给我们提交 GitHub issue 或 PR 支持其他钱包。

连接钱包

签名 / PSBT

Phantom 目前仅对 PSBT 提供部分支持,使用之前请充分测试。

发送交易

如果钱包暂未支持 sendTransfer,将会抛出 NotImplementedError

获取铭文信息展示

结合 NFTCard 展示 Ordinals NFT

#2087
Bitcoin Puppet #2087
Vibing, thriving, and striving for world peace.
No:9740
NodeMonkes
The first original 10k collection inscribed on bitcoin.

API

BitcoinWeb3ConfigProvider

属性描述类型默认值版本
autoConnect是否自动连接booleanfalse-
balance是否显示余额booleanfalse-
wallets可用的钱包WalletFactory[]--
locale多语言设置Locale--

useBitcoinWallet

Result

参数描述类型版本
name当前连接的钱包名称string1.0.0
provider获取当前连接钱包的 provider 对象any1.0.0
account账户地址string1.0.0
connect连接钱包() => Promise<void>1.0.0
getBalance获取钱包余额() => Promise<Balance>1.0.0
signMessage签名(message: string) => Promise<string>1.0.0
sendTransfer发送交易(prams: TransferParams) => Promise<string>1.0.0
signPsbt签名 PSBT(params: SignPsbtParams) => Promise<SignPsbtResult>1.1.0
getInscriptions获取铭文(分页)(offset?: number, size?: number) => Promise<{ total: number; list: Inscription[] }>1.3.0
TransferParams
属性描述类型默认值版本
to接收地址string--
sats发送聪的数目(1BTC = 100000000sats)number--
options可选项,交易费率{ feeRate: number }--
SignPsbtParams
属性描述类型默认值版本
psbt待签名的 base64 编码的 psbt 数据string--
optionspsbt 选项SignPsbtOptions--
SignPsbtOptions
属性描述类型默认值版本
signInputs需要签名的输入数组:{ 地址:输入 UTXO 编号数组 }Record<string, number[]>--
broadcast签名 PSBT 后是否广播交易booleanfalse-
signHash签名哈希类型,默认与输入相同number--

需要注意的是,signHash 在 Xverse 钱包中不生效,如果要指定签名类型,建议直接在签名数据中包含签名类型。参考链接 #43signPsbt

SignPsbtResult
属性描述类型默认值版本
psbt签名后 base64 编码的 PSBT 数据string--
txid广播后的交易哈希。仅 broadcast 为 true 时返回string--
Inscription
属性描述类型默认值版本
inscriptionId铭文IDstring--
address铭文所属地址string--
outputValue铭文所在 UTXO 的大小string--
content铭文内容 URLstring--
contentLength铭文内容长度string--
contentType铭文内容类型string--
preview铭文预览 URLstring--
timestamp铭文所在交易确认的时间戳number--
offset铭文所在聪的 UTXO 偏移number--
genesisTransaction产生铭文的原始交易哈希string--
location铭文索引位置(交易+输出)string--
  • 最后更新时间:
    Types类型Ethereum以太坊