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
Exporting single public key
path
— requiredstring | Array<number>
minimum length is1
. read morecoin
- optionalstring
determines network definition specified in coins.json file. Coinshortcut
,name
orlabel
can be used. Ifcoin
is not set API will try to get network definition frompath
.scriptType
— optionalstring
used to distinguish between various address formats (non-segwit, segwit, etc.).ignoreXpubMagic
— optionalboolean
ignore SLIP-0132 XPUB magic, use xpub/tpub prefix for all account types.ecdsaCurveName
— optionalstring
ECDSA curve name to usecrossChain
— optionalboolean
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.unlockPath
- optional PROTO.UnlockPath, the result of TrezorConnect.unlockPath method.
Exporting bundle of public keys
bundle
-Array
of Objects withpath
,coin
andcrossChain
fields
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
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, // BIP32 serialization format
childNum: number, // BIP32 serialization format
publicKey: string, // BIP32 serialization format
fingerprint: number, // BIP32 serialization format
depth: number, // BIP32 serialization format
}
}
Read more about BIP32 serialization format
Result with bundle of public keys
{
success: true,
payload: [
{ path, serializedPath, xpub, xpubSegwit?, chainCode, childNum, publicKey, fingerprint, depth }, // account 1
{ path, serializedPath, xpub, xpubSegwit?, chainCode, childNum, publicKey, fingerprint, depth }, // account 2
{ path, serializedPath, xpub, xpubSegwit?, chainCode, childNum, publicKey, fingerprint, depth } // account 3
]
}
Error
{
success: false,
payload: {
error: string // error message
}
}