API说明
这里列出 UKey Wallet Cardano Provider 的 CIP-30 方法、实验性 API、类型和错误码。调用 dApp API 前，请先通过 enable() 获取授权后的 API 实例。
钱包接口 (CIP-30)
| 属性/方法 | 说明 |
|---|---|
name | 钱包名称（UKey Wallet） |
icon | 钱包图标 URL |
apiVersion | API 版本要求 |
isEnabled() | 核验是否已启用 |
enable() | 请求钱包访问 |
dApp API (enable 之后)
| 方法 | 说明 |
|---|---|
getNetworkId() | 获取网络 (0=测试网, 1=主网) |
getBalance() | 获取总余额 (CBOR) |
getUtxos(amount?, paginate?) | 获取 UTxO |
getUsedAddresses() | 获取已使用的地址 |
getUnusedAddresses() | 获取未使用的地址 |
getChangeAddress() | 获取找零地址 |
getRewardAddresses() | 获取质押地址 |
signTx(tx, partialSign?) | 签名交易 |
signData(addr, payload) | 签名数据（CIP-8） |
submitTx(tx) | 确认提交交易 |
实验性 API
| 方法 | 说明 |
|---|---|
experimental.getCollateral() | 获取抵押 UTxO |
experimental.on(event, cb) | 订阅事件 |
experimental.off() | 取消订阅 |
类型集
type Cbor = string; // 以十六进制表示的 CBOR
interface Paginate {
page: number;
limit: number;
}
interface Cip30DataSignature {
signature: string; // COSE_Sign1 的十六进制结果
key: string; // COSE_Key 的十六进制结果
}
type NetworkId = 0 | 1; // 0 表示测试网，1 表示主网
事件流
| 事件 | 说明 |
|---|---|
accountChange | 当前账户已切换 |
错误码
| 错误码 | 说明 |
|---|---|
| -1 | 用户取消了操作 |
| -2 | 未匹配到账户 |
| -3 | 网络参数不正确 |