btcGetAddress

Bitcoin : obtenir une adresse

Dérive et renvoie l’adresse au chemin spécifié. Lorsque showOnOneKey vaut true, l’utilisateur doit confirmer l’adresse sur l’appareil.

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

Paramètres

Paramètres communs facultatifs

Adresse unique

• path - obligatoire string | Array<number> La longueur minimale du SDK est 1. en savoir plus
• showOnOneKey - facultatif boolean Indique s’il faut afficher l’adresse sur l’appareil. Valeur par défaut : true.
• coin - facultatif string détermine la définition du réseau spécifiée dans le fichier coins.json . Les champs shortcut, name ou label de la monnaie peuvent être utilisés. Si coin n’est pas défini, l’API tente d’obtenir la définition du réseau depuis path.
• multisig - facultatif MultisigRedeemScriptType, informations du script de rachat (adresses multisignatures uniquement)
• scriptType - facultatif InputScriptType, type de script d’adresse

Plusieurs adresses

• bundle - tableau d’objets contenant les champs path, showOnOneKey, coin

Obtenir différents types d’adresses

Les différents types d’adresses BTC nécessitent des paramètres de chemin de dérivation différents.

Exemple

Afficher la troisième adresse du premier compte bitcoin :

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

Renvoyer un lot d’adresses du premier compte bitcoin sans les afficher sur l’appareil :

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
    ]
});

Résultat

Réponse pour une seule adresse

{
    success: true,
    payload: {
        address: string,     // displayed address
        path: string // serialized BIP32 path
    }
}

Réponse d’adresses par lot

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

Erreur

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