scdoGetAddress

Use requirement

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

SCDO: get address

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

const response = await HardwareSDK.scdoGetAddress(connectId, deviceId, {
  path: "m/44'/541'/0'/0/0",
  showOnUKey: true,
});

Params

Optional common params

Exporting single address

• path - required string | Array<number> minimum length is 3. read more
• showOnUKey - optional boolean determines if address will be displayed on device. Default is set to true

Exporting bundle of addresses

• bundle - Array of Objects with path and showOnUKey fields

Example

// Get single address
const response = await HardwareSDK.scdoGetAddress(connectId, deviceId, {
  path: "m/44'/541'/0'/0/0",
  showOnUKey: false,
});

// Get multiple addresses
const bundleResponse = await HardwareSDK.scdoGetAddress(connectId, deviceId, {
  bundle: [
    {
      path: "m/44'/541'/0'/0/0",
      showOnUKey: false,
    },
    {
      path: "m/44'/541'/1'/0/0",
      showOnUKey: false,
    },
  ],
});

Result with single address

{
    success: true,
    payload: {
        address: string,
        path: string
    }
}

Result with bundle of addresses

{
    success: true,
    payload: [
        { address: string, path: string }, // account 1
        { address: string, path: string }  // account 2
    ]
}

Error

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