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

Bitcoin: authorize CoinJoin

Allow device to do preauthorized operations in signTransaction and getOwnershipProof methods without further user interaction.

Permission persists until physical device disconnection or maxRounds limit is reached.

const result = await TrezorConnect.authorizeCoinJoin(params);

⚠️ This feature is experimental! Do not use it in production!

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

Params

**Optional common params**

Exporting single id

• path — required string | Array<number>

  prefix of the BIP-32 path leading to the account (m / purpose' / coin_type' / account')read more

• coordinator — required string

  coordinator identifier to approve as a prefix in commitment data (max. 36 ASCII characters)

• maxRounds — required number

  maximum number of rounds that Trezor is authorized to take part in

• maxCoordinatorFeeRate — required number

  maximum coordination fee rate in units of 10**8 percent

• maxFeePerKvbyte — required number

  maximum mining fee rate in units of satoshis per 1000 vbytes

• coin - optional string

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

• scriptType — optional PROTO.InputScriptType

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

• amountUnit — optional PROTO.AmountUnit

  show amounts in

Example:

TrezorConnect.authorizeCoinJoin({
    path: "m/10086'/0'/0'",
    maxRounds: 3,
    maxCoordinatorFeeRate: 5000000, // 5% => 0.05 * 10**8;
    maxFeePerKvbyte: 3500,
    scriptType: 'SPENDWITNESS',
});

Result

{
    success: true,
    payload: {
        message: 'CoinJoin authorized'
    }
}

Error

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