Skip to content

Latest commit

 

History

History
98 lines (74 loc) · 3.04 KB

btcgetaddress.md

File metadata and controls

98 lines (74 loc) · 3.04 KB

btcGetAddress

Bitcoin: 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 OneKey.

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

Params

Optional common params

Exporting single address

  • path — required string | Array<number> minimum length is 3. read more
  • showOnOneKey — optional boolean determines if address will be displayed on device. Default is set to true
  • coin - optional string determines network definition specified in coins.json file. Coin shortcut, name or label can be used. If coin is not set API will try to get network definition from path.
  • multisig - optional MultisigRedeemScriptType, redeem script information (multisig addresses only)
  • scriptType - optional InputScriptType, address script type

Exporting bundle of addresses

  • bundle - Array of Objects with path, showOnOneKey, coin fields

Get different types of addresses

获取不同类型的 BTC 地址需要不同的 Path 参数。

Type Path Eg.
Legacy BIP44 m/44'/0'/x'/x/x It starts with a "1" and consists of 26 to 35 characters
Nested SegWit BIP49 m/49'/0'/x'/x/x It starts with a "3" and consists of 26 to 35 characters
Native SegWit BIP84 m/84'/0'/x'/x/x Start with "bc1" or "tb1" and consist of 41 to 62 characters
Taproot BIP86 m/86'/0'/x'/x/x It starts with "bc1" and consists of 41 to 62 characters

Example

Display third address of first bitcoin account:

HardwareSDK.btcGetAddress(connectId, deviceId, {
    path: "m/49'/0'/0'/0/2",
    coin: "btc"
});

Return a bundle of addresses from first bitcoin account without displaying them on device:

HardwareSDK.btcGetAddress(connectId, deviceId, {
    bundle: [
        { path: "m/49'/0'/0'/0/0", showOnOneKey: false }, // address 1
        { path: "m/49'/0'/0'/0/1", showOnOneKey: false }, // address 2
        { path: "m/49'/0'/0'/0/2", showOnOneKey: false }  // address 3
    ]
});

Result

Result with only one address

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

Result with bundle of addresses

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

Error

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