stellarGetAddress

Stellar: 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.stellarGetAddress(
  connectId,
  deviceId,
  params,
);

Params

Optional common params

Exporting single address

• path - required string | Array<number> length is 3, Here's a special chain. more information
• 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

Display address of first stellar account:

HardwareSDK.stellarGetAddress(connectId, deviceId, {
  path: "m/44'/148'/0'",
});

Return a bundle of stellar addresses without displaying them on device:

HardwareSDK.stellarGetAddress(connectId, deviceId, {
  bundle: [
    { path: "m/44'/148'/0'", showOnUKey: false }, // account 1
    { path: "m/44'/148'/1'", showOnUKey: false }, // account 2
    { path: "m/44'/148'/2'", showOnUKey: false }, // account 3
  ],
});

Result

Result with only one address

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

Result with bundle of addresses sorted by FIFO

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

Error

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