本页目录

API 参考

OneKey Cardano provider 的方法和类型参考。

钱包接口 (CIP-30)

属性/方法	描述
`name`	钱包名称 (‘OneKey’)
`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?)`	返回 witness set 中已签名的部分
`signData(addr, payload)`	签署数据（CIP-8）
`submitTx(tx)`	提交交易

实验性 API

方法	描述
`experimental.getCollateral()`	获取抵押 UTxO
`experimental.on(event, cb)`	订阅事件
`experimental.off()`	取消订阅

类型


type Cbor = string // Hex-encoded CBOR
 
interface Paginate {
  page: number
  limit: number
}
 
interface Cip30DataSignature {
  signature: string // COSE_Sign1 hex
  key: string       // COSE_Key hex
}
 
type NetworkId = 0 | 1 // 0=testnet, 1=mainnet

事件

事件	描述
`accountChange`	账户已变更

错误码

错误码	说明
-1	请求无效
-2	内部错误
-3	请求被拒绝
-4	账户已变更

当前 provider 的 experimental.getCollateral() 实现返回空数组。该方法存在，并不代表可获取 Plutus 抵押输入。钱包信息接口的 isEnabled() 也不能代替成功调用 enable()。CIP-30 各操作的专用错误码与上方通用 API 错误码不同。