stellarGetAddress.md

Stellar: get address

Display requested address on device and returns it to caller. User is presented with a description of the requested key and asked to confirm the export.

ES6

const result = await TrezorConnect.stellarGetAddress(params);

CommonJS

TrezorConnect.stellarGetAddress(params).then(function(result) {

});

Params

Optional common params

Exporting single address

• path — obligatory string | Array<number> minimum length is 3. read more
• showOnTrezor — 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 showOnTrezor fields

Example

Display address of first stellar account:

TrezorConnect.stellarGetAddress({
    path: "m/44'/148'/0'"
});

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

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

Result

Result with only one address

{
    success: true,
    payload: {
        address: string,
        path: Array<number>,
        serializedPath: string,
    }
}

Result with bundle of addresses

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

Error

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