trezor-suite/docs/packages/connect/methods/getOwnershipProof.md

Bitcoin: get Ownership proof

Export SLIP-0019 ownership proof. Read more

const result = await TrezorConnect.getOwnershipProof(params);

:note: Supported only by Trezor T with Firmware 2.4.4 or higher!

Params

**Optional common params**

Exporting single proof

• path — required string | Array<number> minimum length is 5. read more
• coin - optional string

  Determines network definition specified in coins.json file. Coin shortcut, name or label can be used.

• scriptType — optional InputScriptType
• userConfirmation — optional boolean
• ownershipIds — optional Array<string>
• commitmentData — optional string
• multisig — optional MultisigRedeemScriptType
• preauthorized — optional boolean read more

Exporting bundle of proofs

• bundle - Array of Objects with fields listed above.

Example

Display ownership proof of the first bitcoin address:

TrezorConnect.getOwnershipProof({
    path: "m/86'/0'/0'/0/0",
});

Return a bundle of ownership proofs:

TrezorConnect.getOwnershipProof({
    bundle: [
        { path: "m/86'/0'/0'/0/0" }, // taproot
        { path: "m/84'/0'/0'/0/0" }, // bech32
        { path: "m/49'/0'/0'/0/0" }, // segwit
    ],
});

Result

Result with single proof:

{
    success: true,
    payload: {
        ownership_proof: string,
        signature: string
    }
}

Result with bundle of proofs sorted by FIFO

{
    success: true,
    payload: [
        { ownership_proof: string, signature: string }, // taproot
        { ownership_proof: string, signature: string }, // bech32
        { ownership_proof: string, signature: string }  // segwit
    ]
}

Error

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