API说明
这里列出 UKey Wallet Aptos Provider 的常用方法、类型、事件和错误码。实现业务前,请先确认账户是否已连接,并检查当前网络是否符合预期。
方法集
| 方法 | 说明 |
|---|---|
connect() | 发起连接并返回账户 |
disconnect() | 关闭当前钱包连接 |
isConnected() | 核验连接状态 |
account() | 获取当前账户信息 |
network() | 获取当前网络名称 |
getNetwork() | 获取完整网络信息 |
getNetworkURL() | 获取 RPC 地址 |
signMessage(request) | 发起消息签名 |
signAndSubmitTransaction(payload, options?) | 签名并提交交易 |
signTransaction(payload, options?) | 仅签名,不提交 |
signTransactionV2(params) | 对 BCS 序列化交易签名 |
signAndSubmitTransactionV2(params) | 签名并确认提交 Standard V1.1.0 交易 |
signIn(payload) | Aptos AIP 登录流程 |
onAccountChange(callback) | 订阅账户变化 |
onNetworkChange(callback) | 订阅网络变化 |
onDisconnect(callback) | 订阅断开事件 |
类型集
账户信息
interface AptosAccountInfo {
address: string; // 地址按 0x 开头的 hex 形式给出
publicKey: string; // Ed25519 格式公钥
}
网络信息
interface AptosNetwork {
name: string; // 网络标识名
chainId: string; // 链标识
url: string; // RPC 地址
}
签署消息请求
interface SignMessageRequest {
message: string; // 下面是待签消息
nonce?: string; // 可选 nonce
address?: boolean; // 是否把地址带入消息
application?: boolean; // 是否附带应用信息
chainId?: boolean; // 是否附带链 ID
}
签署消息响应
interface SignMessageResponse {
signature: string; // hex 形式的签名
fullMessage: string; // 完整签名消息
kaspa: string; // APTOS 前缀
address?: string; // 签名发起地址
application?: string; // 应用描述信息
chainId?: number; // 链标识
nonce: string; // 本次使用的 nonce
}
交易 Payload
interface TransactionPayload {
type: "entry_function_payload" | "script_payload" | "module_bundle_payload";
function: string; // Module::function 形式
type_arguments: string[];
arguments: any[];
}
签署交易 V2 入参
interface SignTransactionV2Params {
transaction: string; // 经过 BCS 序列化后的交易内容
transactionType: "simple" | "multi_agent";
asFeePayer?: boolean; // 是否以代付方身份参与签署
}
支持的网络
| 网络 | 说明 |
|---|---|
| 主网 | 主网 |
| 测试网 | 测试网 |
| Devnet | 开发网 |
事件流
| 事件 | 回调入参 | 说明 |
|---|---|---|
accountChanged | address: string | null | 当前账户已切换 |
accountChangedV2 | account: AptosAccountInfo | null | 当前账户已切换(完整信息) |
networkChange | network: string | null | 网络已更新 |
disconnect | - | 钱包连接已关闭 |
错误码
| 错误码 | 说明 |
|---|---|
| 4001 | 用户取消了本次请求 |
| 4100 | 尚未完成授权 |
| 4200 | 当前方法不可用 |
| 4201 | 当前网络暂不支持 |
| -32603 | 内部处理异常 |