跳到主要内容

benfenGetAddress

Benfen:获取地址

返回指定的 BIP32 路径派生的地址。开启设备展示时,用户需要在 Ukey Wallet 上核对并确认导出该地址。

使用要求

  • 固件版本要求
    • UKey Lite 24 / UKey Lite 25 / UKey Core 26: 1.1.0
const result = await HardwareSDK.benfenGetAddress(connectId, deviceId, params);

参数

可选通用参数

  • path - 必需 string | Array<number>,字符串数组最小长度限制为 3更多信息
  • showOnUKey - 可选 boolean,决定是否在设备上进行地址显示;默认值为 true

返回值

  • success: boolean - 成功时为 true
  • payload:
    • address: string - 派生生成的 BFC 格式地址
    • path: string - 本次使用的 BIP32 路径
    • pub?: string - 对应的公钥(如有返回)

示例:

const params = {
path: "m/44'/728'/1'/0'/0'",
showOnUKey: false,
};

// 获取单个地址
const response = await HardwareSDK.benfenGetAddress(
connectId,
deviceId,
params,
);

// 批量地址
const batchParams = {
bundle: [
{
path: "m/44'/728'/3'/0'/0'",
showOnUKey: false,
},
{
path: "m/44'/728'/4'/0'/0'",
showOnUKey: false,
},
{
path: "m/44'/728'/5'/0'/0'",
showOnUKey: false,
},
],
};
const batchResponse = await HardwareSDK.benfenGetAddress(
connectId,
deviceId,
batchParams,
);

返回结果

单个地址返回示例

{
success: true,
payload: {
address: string, // 返回的地址
pub: string, // 返回的公钥
path: Array<number> // 派生路径
}
}

批量地址返回示例(顺序与请求一致)

{
success: true,
payload: [
{ address: string, pub: string, path: Array<number> }, // 第4个派生账户路径
{ address: string, pub: string, path: Array<number> }, // 第5个派生账户路径
{ address: string, pub: string, path: Array<number> } // 第6个派生账户路径
]
}

错误

{
success: false,
payload: {
error: string, // 错误消息
code: number // 错误码
}
}