benfenGetAddress

Benfen: get address

Display requested address derived by given BIP32 path on device and returns it to caller. User is asked to confirm the export on Ukey Wallet.

Use requirement

• Firmware version required
  • UKey Lite 24 / UKey Lite 25 / UKey Core 26: 4.12.0

const result = await HardwareSDK.benfenGetAddress(connectId, deviceId, params);

Params

Optional common params

• path - required string | Array<number> minimum length is 3. read more
• showOnUKey - optional boolean whether to display address on device

Returns

• success: boolean - True if successful
• payload:
  • address: string - Derived BFC format address
  • path: string - BIP32 path used
  • pub?: string - Public key if available

Example:

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

// Single address
const response = await HardwareSDK.benfenGetAddress(
  connectId,
  deviceId,
  params,
);

// Batch addresses
const batchParams = {
  bundle: [
    {
      path: "m/44'/728'/0'/0'/0'",
      showOnUKey: false,
    },
    {
      path: "m/44'/728'/1'/0'/0'",
      showOnUKey: false,
    },
  ],
};
const batchResponse = await HardwareSDK.benfenGetAddress(
  connectId,
  deviceId,
  batchParams,
);

Result

Result with only one address

{
    success: true,
    payload: {
        address: string,     // displayed address
        pub: string,
        path: Array<number> // hardended path
    }
}

Result with bundle of addresses sorted by FIFO

{
    success: true,
    payload: [
        { address: string, pub: string, path: Array<number> }, // account 1
        { address: string, pub: string, path: Array<number> }, // account 2
        { address: string, pub: string, path: Array<number> }  // account 3
    ]
}

Error

{
    success: false,
    payload: {
        error: string, // error message
        code: number // error code
    }
}