Quick Access
Coin Methods
Bitcoin
Miscellaneous
Methods
Bitcoin
getPublicKey

Get public key

Retrieves BIP32 extended public derived by given BIP32 path. User is presented with a description of the requested key and asked to confirm the export.

const result = await TrezorConnect.getPublicKey(params);

Params

Including CommonParams

GetPublicKey

path

String | Array<Number>

Required

minimum length is 1. read more

showOnTrezor

Boolean

Optional

Display the result on the Trezor device. Default is false

suppressBackupWarning

Boolean

Optional

By default, this method will emit an event to show a warning if the wallet does not have a backup. This option suppresses the message.

chunkify

Boolean

Optional

Display the result in chunks for better readability. Default is false

and

coin

String

Optional

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.

crossChain

Boolean

Optional

Advanced feature. Use it only if you are know what you are doing. Allows to generate address between chains. For example Bitcoin path on Litecoin network will display cross chain address in Litecoin format.

scriptType

"SPENDADDRESS" | "SPENDMULTISIG" | "SPENDWITNESS" | "SPENDP2SHWITNESS" | "SPENDTAPROOT"

Optional

used to distinguish between various address formats (non-segwit, segwit, etc.).

ignoreXpubMagic

Boolean

Optional

ignore SLIP-0132 XPUB magic, use xpub/tpub prefix for all account types.

ecdsaCurveName

String

Optional

ECDSA curve name to use

unlockPath

UnlockPath

Optional

the result of TrezorConnect.unlockPath method

Bundle(GetPublicKey)

bundle

Array of Objects with above schema

Example

Return public key of fifth bitcoin account:

TrezorConnect.getPublicKey({
    path: "m/49'/0'/4'",
    coin: 'btc',
});

Return a bundle of public keys for multiple bitcoin accounts:

TrezorConnect.getPublicKey({
    bundle: [
        { path: "m/49'/0'/0'" }, // account 1
        { path: "m/49'/0'/1'" }, // account 2
        { path: "m/49'/0'/2'" }, // account 3
    ],
});

Result

HDNodeResponse type

Result with only one public key

{
    success: true,
    payload: {
        path: Array<number>, // hardended path
        serializedPath: string, // serialized path
        xpub: string,        // xpub in legacy format
        xpubSegwit?: string, // optional for segwit accounts: xpub in segwit format
        chainCode: string,   // BIP-32 serialization format
        childNum: number,    // BIP-32 serialization format
        publicKey: string,   // BIP-32 serialization format
        fingerprint: number, // BIP-32 serialization format
        depth: number,       // BIP-32 serialization format
        descriptor?: string, // BIP-380 descriptor. Not available for model One
    }
}

Read more about BIP32 serialization format

Result with bundle of public keys

{
    success: true,
    payload: [
        { path, serializedPath, xpub, xpubSegwit?, chainCode, childNum, publicKey, fingerprint, depth, descriptor }, // account 1
        { path, serializedPath, xpub, xpubSegwit?, chainCode, childNum, publicKey, fingerprint, depth, descriptor }, // account 2
        { path, serializedPath, xpub, xpubSegwit?, chainCode, childNum, publicKey, fingerprint, depth, descriptor }  // account 3
    ]
}

Error

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