Ant Design Web3

⌘ K

最后更新时间：

帮助改进此文档

Hooks钩子函数 Bitcoin比特币

Types

这里定义了 Ant Design Web3 统一类型，在多个组件中可能都会用到。

Account

属性	描述	类型	默认值	版本
address	账户地址（适配器支持多地址时为 `addresses[0]`）	`string`	-	-
name	账户名称，比如以太坊的 ENS	`string`	-	-
addresses	用户授权的钱包地址列表（依赖适配器实现，部分链中支持）	`string[]`	-	-

ChainIds

这是一个枚举类型，包含了一些常用的链的 ID，它的值是一个数字，你可以通过它来判断当前链是否是某个特定的链。

Chain

属性	描述	类型	默认值	版本
id	链的 ID	ChainIds	-	-
name	链的名称	`string`	-	-
icon	链的图标	`React.ReactNode`	-	-
type	链类型，以太坊虚拟机兼容链/Solana虚拟机链/比特币链	`EVM \| SVM \| Bitcoin`	-	-
browser	链浏览器配置	ChainBrowser	-	-

ChainBrowser

属性	描述	类型	默认值	版本
icon	链浏览器图标	`React.ReactNode`	-	-
getBrowserLink	从区块链浏览器获取地址或交易链接方法	`(address: string, type: 'address' \| 'transaction') => string`	-	-

Wallet

属性	描述	类型	默认值	版本
name	钱包名称	`string`	-	-
icon	钱包图标	`string \| React.ReactNode`	-	-
remark	钱包简介	`string`	-	-
key	钱包 Key	`React.Key`	-	-
extensions	该钱包支持的浏览器扩展程序列表	`false` \| ExtensionItem[]	-	-
app	该钱包是否支持 APP 调用	`false \| { link: string }`	-	-
group	钱包所属分组名称	`string`	-	-
hasWalletReady	钱包是否已经准备好	`() => boolean`	-	-
hasExtensionInstalled	是否安装浏览器扩展程序	`() => boolean`	-	-
getQrCode	获取钱包的二维码	`() => { uri: string }`	-	-
customQrCodePanel	自定义二维码展示的面板	`boolean`	`false`	`1.17.0`
universalProtocol	通用协议配置	`{ link: string }`	-	-

ExtensionItem

属性	描述	类型	默认值	版本
link	浏览器扩展程序链接	`string`	-	-
key	浏览器扩展程序 Key	`'Chrome' \| 'Firefox' \| 'Edge' \| 'Safari' \| (string & {})`	-	-
browserIcon	浏览器图标	`string`	-	-
browserName	浏览器扩展程序名称	`string`	-	-
description	浏览器扩展程序的描述	`string`	-	-

NFTMetadata

属性	描述	类型	默认值	版本
name	NFT 的名称	`string`	-	-
description	NFT 的描述	`string`	-	-
image	NFT 的图像链接	`string`	-	-
dna	NFT 的 DNA 或基因编码	`string`	-	-
edition	NFT 的版本号	`number`	-	-
date	NFT 的日期	`number`	-	-
attributes	NFT 的附加属性列表。包括 `trait_type` 和 `value` 属性的对象数组	`Attribute[]`	-	-
compiler	用于创建 NFT 的编译器或工具	`string`	-	-

Attribute

属性	描述	类型	默认值	版本
trait_type	属性的类型，表示 NFT 的特征类型	`string`	-	-
value	属性的值，表示 NFT 的特征值	`string`	-	-

ConnectOptions

属性	描述	类型	默认值	版本
connectType	连接类型	`'extension' \| 'qrCode'`	-	-

SignConfig

属性	描述	类型	默认值	版本
signIn	签名登录	`(address: string) => Promise<void>;`	-	-
signOut	签名登出	`() => Promise<void>;`	-	-

UniversalWeb3ProviderInterface

属性	描述	类型	默认值	版本
account	当前账户	Account	-	-
chain	当前链	Chain	-	-
availableChains	可以连接的链列表	Chain[]	-	-
availableWallets	可用的钱包列表	Wallet[]	-	-
connect	连接钱包	`(wallet: Wallet, options?: ConnectOptions) => Promise<void \| Account>`	-	-
disconnect	断开钱包连接	`() => Promise<void>`	-	-
switchChain	切换链	`(chain: Chain) => Promise<void>`	-	-
getNFTMetadata	获取 NFT 的元数据	`(params: { address: string; tokenId?: bigint \| number }) => Promise<NFTMetadata>`	-	-
sign	签名登录相关配置	`SignConfig`	-	`1.20.0`

Token

属性	描述	类型	默认值	版本
name	代币名称	`string`	-	-
symbol	代币符号	`string`	-	-
icon	代币图标	`React.ReactNode`	-	-
decimal	代币金额精度	`number`	-	-
availableChains	代币可用的链列表	TokenChain[]	-	-

TokenChain

属性	描述	类型	默认值	版本
chain	链信息	Chain	-	-
contract	代币在该链的合约地址	`string`	-

Locale

国际化支持的文案请参考代码。