Quick Access
Coin Methods
Bitcoin
Miscellaneous
Methods
Bitcoin
signTransaction

Sign transaction

Asks device to sign given inputs and outputs of pre-composed transaction. User is asked to confirm all transaction details on Trezor.

const result = await TrezorConnect.signTransaction(params);

Params

Including CommonParams

SignTransaction

SignTransaction type

coin

String

Required

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

inputs

Array<CommonTxInputType & Object | CommonTxInputType & Object>

Required

of PROTO.TxInputType

Union

prev_hash

String

Required

prev_index

Number

Required

amount

Uint

Required

sequence

Number

Optional

multisig

MultisigRedeemScriptType

Optional

decred_tree

Number

Optional

orig_hash

String

Optional

orig_index

Number

Optional

decred_staking_spend

Enum: SSGen (0) | SSRTX (1)

Optional

script_pubkey

String

Optional

coinjoin_flags

Number

Optional

script_sig

String

Optional

witness

String

Optional

ownership_proof

String

Optional

commitment_data

String

Optional

or

prev_hash

String

Required

prev_index

Number

Required

amount

Uint

Required

sequence

Number

Optional

multisig

MultisigRedeemScriptType

Optional

decred_tree

Number

Optional

orig_hash

String

Optional

orig_index

Number

Optional

decred_staking_spend

Enum: SSGen (0) | SSRTX (1)

Optional

script_pubkey

String

Optional

coinjoin_flags

Number

Optional

script_sig

String

Optional

witness

String

Optional

ownership_proof

String

Optional

commitment_data

String

Optional

outputs

Array<Object | Object | Object | Object>

Required

of PROTO.TxOutputType

Union

or

address

Undefined

Optional

address_n

Array<Number>

Required

script_type

"PAYTOADDRESS" | "PAYTOSCRIPTHASH" | "PAYTOMULTISIG" | "PAYTOWITNESS" | "PAYTOP2SHWITNESS" | "PAYTOTAPROOT"

Optional

amount

Uint

Required

multisig

MultisigRedeemScriptType

Optional

orig_hash

String

Optional

orig_index

Number

Optional

payment_req_index

Number

Optional

or

address

String

Required

address_n

Undefined

Optional

script_type

"PAYTOADDRESS" | "PAYTOSCRIPTHASH" | "PAYTOMULTISIG" | "PAYTOWITNESS" | "PAYTOP2SHWITNESS" | "PAYTOTAPROOT"

Optional

amount

Uint

Required

multisig

MultisigRedeemScriptType

Optional

orig_hash

String

Optional

orig_index

Number

Optional

payment_req_index

Number

Optional

paymentRequests

Array<TxAckPaymentRequest>

Optional

of PROTO.TxAckPaymentRequest. See SLIP-24

refTxs

Array<Object>

Optional

of RefTransaction.

If you don't want to use build-in blockbook backend you can optionally provide those data from your own backend transformed to Trezor format. Since Firmware 2.3.0/1.9.0 referenced transactions are required. Zcash and Komodo refTxs should also contains expiry, version_group_id and extra_data fields.

locktime

Number

Optional

version

Number

Optional

transaction version,

expiry

Number

Optional

only for Decred and Zcash,

versionGroupId

Number

Optional

only for Zcash, nVersionGroupId when overwintered is set,

overwintered

Boolean

Optional

only for Zcash

timestamp

Number

Optional

only for Capricoin, transaction timestamp,

branchId

Number

Optional

only for Zcash, BRANCH_ID when overwintered is set

push

Boolean

Optional

Broadcast signed transaction to blockchain. Default is set to false

amountUnit

Enum: BITCOIN (0) | MILLIBITCOIN (1) | MICROBITCOIN (2) | SATOSHI (3)

Optional

show amounts in BTC, mBTC, uBTC, sat

unlockPath

UnlockPath

Optional

the result of TrezorConnect.unlockPath method

serialize

Boolean

Optional

default true serialize the full transaction, as opposed to only outputting the signatures

chunkify

Boolean

Optional

determines if recipient address will be displayed in chunks of 4 characters. Default is set to false

Example

PAYTOADDRESS
TrezorConnect.signTransaction({
    inputs: [
        {
            address_n: [
                (44 | 0x80000000) >>> 0,
                (0 | 0x80000000) >>> 0,
                (2 | 0x80000000) >>> 0,
                1,
                0,
            ],
            prev_index: 0,
            prev_hash: 'b035d89d4543ce5713c553d69431698116a822c57c03ddacf3f04b763d1999ac',
            amount: 3431747,
        },
    ],
    outputs: [
        {
            address_n: [
                (44 | 0x80000000) >>> 0,
                (0 | 0x80000000) >>> 0,
                (2 | 0x80000000) >>> 0,
                1,
                1,
            ],
            amount: 3181747,
            script_type: 'PAYTOADDRESS',
        },
        {
            address: '18WL2iZKmpDYWk1oFavJapdLALxwSjcSk2',
            amount: 200000,
            script_type: 'PAYTOADDRESS',
        },
    ],
    coin: 'btc',
});
SPENDP2SHWITNESS
TrezorConnect.signTransaction({
    inputs: [
        {
            address_n: [
                (49 | 0x80000000) >>> 0,
                (0 | 0x80000000) >>> 0,
                (2 | 0x80000000) >>> 0,
                1,
                0,
            ],
            prev_index: 0,
            prev_hash: 'b035d89d4543ce5713c553d69431698116a822c57c03ddacf3f04b763d1999ac',
            amount: 3431747,
            script_type: 'SPENDP2SHWITNESS',
        },
    ],
    outputs: [
        {
            address_n: [
                (49 | 0x80000000) >>> 0,
                (0 | 0x80000000) >>> 0,
                (2 | 0x80000000) >>> 0,
                1,
                1,
            ],
            amount: 3181747,
            script_type: 'PAYTOP2SHWITNESS',
        },
        {
            address: '18WL2iZKmpDYWk1oFavJapdLALxwSjcSk2',
            amount: 200000,
            script_type: 'PAYTOADDRESS',
        },
    ],
    coin: 'btc',
});
PAYTOADDRESS with refTxs (transaction data provided from custom backend)
TrezorConnect.signTransaction({
    inputs: [
        {
            address_n: [
                (44 | 0x80000000) >>> 0,
                (0 | 0x80000000) >>> 0,
                (2 | 0x80000000) >>> 0,
                1,
                0,
            ],
            prev_index: 0,
            prev_hash: 'b035d89d4543ce5713c553d69431698116a822c57c03ddacf3f04b763d1999ac',
            amount: 3431747,
        },
    ],
    outputs: [
        {
            address_n: [
                (44 | 0x80000000) >>> 0,
                (0 | 0x80000000) >>> 0,
                (2 | 0x80000000) >>> 0,
                1,
                1,
            ],
            amount: 3181747,
            script_type: 'PAYTOADDRESS',
        },
        {
            address: '18WL2iZKmpDYWk1oFavJapdLALxwSjcSk2',
            amount: 200000,
            script_type: 'PAYTOADDRESS',
        },
    ],
    refTxs: [
        {
            hash: 'b035d89d4543ce5713c553d69431698116a822c57c03ddacf3f04b763d1999ac',
            inputs: [
                {
                    prev_hash: '448946a44f1ef514601ccf9b22cc3e638c69ea3900b67b87517ea673eb0293dc',
                    prev_index: 0,
                    script_sig:
                        '47304402202872cb8459eed053dcec0f353c7e293611fe77615862bfadb4d35a5d8807a4cf022015057aa0aaf72ab342b5f8939f86f193ad87b539931911a72e77148a1233e022012103f66bbe3c721f119bb4b8a1e6c1832b98f2cf625d9f59242008411dd92aab8d94',
                    sequence: 4294967295,
                },
            ],
            bin_outputs: [
                {
                    amount: 3431747,
                    script_pubkey: '76a91441352a84436847a7b660d5e76518f6ebb718dedc88ac',
                },
                {
                    amount: 10000,
                    script_pubkey: '76a9141403b451c79d34e6a7f6e36806683308085467ac88ac',
                },
            ],
            lock_time: 0,
            version: 1,
        },
    ],
    coin: 'btc',
});

Result

SignedTransaction type

{
    success: true,
    payload: {
        signatures: Array<string>, // Array of signer signatures
        serializedTx: string,      // serialized transaction
        txid?: string,             // broadcasted transaction id
    }
}

Error

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