tonGetAddress

Use requirement

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

TON: 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.tonGetAddress(connectId, deviceId, {
  path: "m/44'/607'/0'",
  showOnUKey: true,
  walletVersion: 3,
  isBounceable: false,
  isTestnetOnly: false,
});

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
• walletVersion - optional TonWalletVersion TON wallet version (default: 3)
• isBounceable - optional boolean whether address is bounceable (default: false)
• isTestnetOnly - optional boolean whether to use testnet (default: false)

Exporting bundle of addresses

• bundle - Array of Objects with path and showOnUKey fields

Example

// Get single address
const response = await HardwareSDK.tonGetAddress(connectId, deviceId, {
  path: "m/44'/607'/0'",
  showOnUKey: false,
  walletVersion: 3,
  isBounceable: false,
  isTestnetOnly: false,
});

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

Result

Result with only one address

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

Result with bundle of addresses sorted by FIFO

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

Error

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