API说明
这里列出 UKey Wallet Algorand Provider 的方法、类型、属性、事件和错误码。新项目建议优先使用 ARC-0001 相关接口。
方法集
| 方法 | 说明 |
|---|---|
connect() | 连接钱包(传统) |
disconnect() | 断开钱包连接 |
enable(opts?) | 启用钱包 (ARC-0001) |
signTxns(transactions) | 签名交易(ARC-0001) |
postTxns(signedTxns) | 广播交易 |
signAndPostTxns(transactions) | 签署并广播 |
signTransaction(txns) | 签名交易(传统) |
signAndSendTransaction(txns) | 签名并发送(传统) |
signMessage(message, encoding?) | 签名任意消息 |
getAlgodv2Client() | 获取 Algod 客户端 |
getIndexerClient() | 获取 Indexer 客户端 |
类型集
Enable 选项
interface EnableOpts {
genesisID?: string;
genesisHash?: string;
}
Enable 结果
interface EnableResult {
genesisID: string;
genesisHash: string;
accounts: string[];
}
钱包交易
interface WalletTransaction {
txn: string; // Base64 形式的未签名交易
signers?: string[]; // 需要签名的地址(留空表示跳过)
stxn?: string; // 已预签名交易
message?: string; // 需要展示给用户的消息
msig?: MultisigMetadata;
authAddr?: string; // rekey 后使用的认证地址
}
SignTxns 结果
interface SignTxnsResult {
// Base64 格式的已签名交易数组(跳过项为 null)
[index: number]: string | null;
}
PostTxns 结果
interface PostTxnsResult {
txIDs: string[];
}
属性
| 属性 | 类别 | 说明 |
|---|---|---|
isConnected | boolean | 连接状态 |
address | string | null | 已连接的地址 |
isUKey | boolean | UKey Wallet 标识 |
事件流
| 事件 | 参数 | 说明 |
|---|---|---|
connect | { address } | 钱包已连接 |
disconnect | - | 钱包连接已关闭 |
accountChanged | address | 当前账户已切换 |
错误码
| 错误码 | 说明 |
|---|---|
| 4001 | 用户取消了本次请求 |
| 4100 | 尚未完成授权 |
| 4200 | 当前方法不可用 |
| 4300 | 输入内容不合法 |