package hw.trezor.messages.bitcoin

Get desktop application:
View/edit binary Protocol Buffers messages

* Response: Contains address derived from device private seed @end

• required string address = 1

  Coin address in Base58 encoding

• optional bytes mac = 2

  Address authentication code

* Unit to be used when showing amounts on the display

Used in: AuthorizeCoinJoin, SignTx

• BITCOIN = 0

  BTC

• MILLIBITCOIN = 1

  mBTC

• MICROBITCOIN = 2

  uBTC

• SATOSHI = 3

  sat

* Request: Ask device to prompt the user to authorize a CoinJoin transaction @start @next Success @next Failure

• required string coordinator = 1

  coordinator identifier to approve as a prefix in commitment

• required uint64 max_rounds = 2

  data (max. 36 ASCII characters)

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

• required uint32 max_coordinator_fee_rate = 3

  maximum coordination fee rate in units of 10^-6 percent

• required uint32 max_fee_per_kvbyte = 4

  maximum mining fee rate in units of satoshis per 1000 vbytes

• repeated uint32 address_n = 5

  prefix of the BIP-32 path leading to the account (m /

• optional string coin_name = 6

  purpose' / coin_type' / account')

  coin to use

• optional InputScriptType script_type = 7

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

• optional AmountUnit amount_unit = 8

  show amounts in

* Request: Ask device for a list of names of all supported benchmarks @start @next Benchmarks @next Failure

(message has no fields)

* Response: Contains the list of names of all supported benchmarks @end

• repeated string names = 1

* Response: Contains the result of the benchmark @end

• optional string value = 1

• optional string unit = 3

* Request: Ask device to run a benchmark @start @next BenchmarkResult @next Failure

• optional string name = 1

* Type of script which will be used for decred stake transaction input

Used in: TxAck.TransactionType.TxInputType, TxInput

• SSGen = 0

• SSRTX = 1

* Request: Ask device for address corresponding to address_n path @start @next Address @next Failure

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• optional string coin_name = 2

  coin to use

• optional bool show_display = 3

  optionally show on display before sending the result

• optional MultisigRedeemScriptType multisig = 4

  filled if we are showing a multisig address

• optional InputScriptType script_type = 5

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

• optional bool ignore_xpub_magic = 6

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

• optional bool chunkify = 7

  display the address in chunks of 4 characters

* Request: Ask device for ownership identifier corresponding to scriptPubKey for address_n path @start @next OwnershipId @next Failure

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• optional string coin_name = 2

  coin to use

• optional MultisigRedeemScriptType multisig = 3

  filled if we are dealing with a multisig scriptPubKey

• optional InputScriptType script_type = 4

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

* Request: Ask device for a proof of ownership corresponding to address_n path @start @next OwnershipProof @next Failure

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• optional string coin_name = 2

  coin to use

• optional InputScriptType script_type = 3

  used to distinguish between various scriptPubKey types

• optional MultisigRedeemScriptType multisig = 4

  filled if proof is for a multisig address

• optional bool user_confirmation = 5

  show a confirmation dialog and set the "user confirmation" bit in the proof

• repeated bytes ownership_ids = 6

  list of ownership identifiers in case of multisig

• optional bytes commitment_data = 7

  additional data to which the proof should commit

* Request: Ask device for public key corresponding to address_n path @start @next PublicKey @next Failure

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• optional string ecdsa_curve_name = 2

  ECDSA curve name to use

• optional bool show_display = 3

  optionally show on display before sending the result

• optional string coin_name = 4

  coin to use for verifying

• optional InputScriptType script_type = 5

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

• optional bool ignore_xpub_magic = 6

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

* Type of script which will be used for transaction input

Used in: AuthorizeCoinJoin, GetAddress, GetOwnershipId, GetOwnershipProof, GetPublicKey, SignMessage, TxAck.TransactionType.TxInputType, TxInput

• SPENDADDRESS = 0

  standard P2PKH address

• SPENDMULTISIG = 1

  P2SH multisig address

• EXTERNAL = 2

  reserved for external inputs (coinjoin)

• SPENDWITNESS = 3

  native SegWit

• SPENDP2SHWITNESS = 4

  SegWit over P2SH (backward compatible)

• SPENDTAPROOT = 5

  Taproot

* Response: Signed message @end

• required string address = 1

  address used to sign the message

• required bytes signature = 2

  signature of the message

Used in: MultisigRedeemScriptType

• PRESERVED = 0

  order of pubkeys is preserved

• LEXICOGRAPHIC = 1

  pubkeys are sorted lexicographically (BIP-67)

* Type of redeem script used in input @embed

Used in: GetAddress, GetOwnershipId, GetOwnershipProof, TxAck.TransactionType.TxInputType, TxAck.TransactionType.TxOutputType, TxInput, TxOutput

• repeated MultisigRedeemScriptType.HDNodePathType pubkeys = 1

  this field is deprecated and will be removed in the

• repeated bytes signatures = 2

  future, use nodes together with address_n instead

  existing signatures for partially signed input

• required uint32 m = 3

  "m" from n, how many valid signatures is necessary for spending

• repeated common.HDNodeType nodes = 4

• repeated uint32 address_n = 5

  path to derive pubkeys from nodes

• optional MultisigPubkeysOrder pubkeys_order = 6

  order of pubkeys in script pubkey

* Structure representing HDNode + Path

Used in: MultisigRedeemScriptType

• required common.HDNodeType node = 1

  BIP-32 node in deserialized form

• repeated uint32 address_n = 2

  BIP-32 path to derive the key from node

* Type of script which will be used for transaction output

Used in: TxAck.TransactionType.TxOutputType, TxOutput

• PAYTOADDRESS = 0

  used for all addresses (bitcoin, p2sh, witness)

• PAYTOSCRIPTHASH = 1

  p2sh address (deprecated; use PAYTOADDRESS)

• PAYTOMULTISIG = 2

  only for change output

• PAYTOOPRETURN = 3

  op_return

• PAYTOWITNESS = 4

  only for change output

• PAYTOP2SHWITNESS = 5

  only for change output

• PAYTOTAPROOT = 6

  only for change output

* Response: Contains the ownership identifier for the scriptPubKey and device private seed @end

• required bytes ownership_id = 1

  ownership identifier

* Response: Contains the proof of ownership @end

• required bytes ownership_proof = 1

  SLIP-0019 proof of ownership

• required bytes signature = 2

  signature of the proof

* Data type for inputs of previous transactions. When adding fields, take care to not conflict with TxInput @embed

Used in: TxAckPrevInput.TxAckPrevInputWrapper

• required bytes prev_hash = 2

  hash of previous transaction output to spend by this input

• required uint32 prev_index = 3

  index of previous output to spend

• required bytes script_sig = 4

  script signature

• required uint32 sequence = 5

  sequence

• optional uint32 decred_tree = 9

  only for Decred

* Data type for outputs of previous transactions. @embed

Used in: TxAckPrevOutput.TxAckPrevOutputWrapper

• required uint64 amount = 1

  amount sent to this output

• required bytes script_pubkey = 2

  scriptPubkey of this output

• optional uint32 decred_script_version = 3

  only for Decred

* Data type for metadata about previous transaction which contains the UTXO being spent. @embed

Used in: TxAckPrevMeta

• required uint32 version = 1

• required uint32 lock_time = 4

• required uint32 inputs_count = 6

• required uint32 outputs_count = 7

• optional uint32 extra_data_len = 9

  only for Dash, Zcash

• optional uint32 expiry = 10

  only for Decred and Zcash

• optional uint32 version_group_id = 12

  only for Zcash, nVersionGroupId

• optional uint32 timestamp = 13

  only for Peercoin

• optional uint32 branch_id = 14

  only for Zcash, BRANCH_ID

* Response: Contains public key derived from device private seed @end

• required common.HDNodeType node = 1

  BIP-32 public node

• required string xpub = 2

  serialized form of public node

• optional uint32 root_fingerprint = 3

  master root node fingerprint

• optional string descriptor = 4

  BIP-380 descriptor

* Request: Ask device to sign message @start @next MessageSignature @next Failure

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• required bytes message = 2

  message to be signed

• optional string coin_name = 3

  coin to use for signing

• optional InputScriptType script_type = 4

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

• optional bool no_script_type = 5

  don't include script type information in the recovery byte

• optional bool chunkify = 6

  of the signature, same as in Bitcoin Core

  display the address in chunks of 4 characters

* Request: Ask device to sign transaction @start @next TxRequest @next Failure

• required uint32 outputs_count = 1

  number of transaction outputs

• required uint32 inputs_count = 2

  number of transaction inputs

• optional string coin_name = 3

  coin to use

• optional uint32 version = 4

  transaction version

• optional uint32 lock_time = 5

  transaction lock_time

• optional uint32 expiry = 6

  only for Decred and Zcash

• optional bool overwintered = 7

  deprecated in 2.3.2, the field is not needed as it can be derived from `version`

• optional uint32 version_group_id = 8

  only for Zcash, nVersionGroupId

• optional uint32 timestamp = 9

  only for Peercoin

• optional uint32 branch_id = 10

  only for Zcash, BRANCH_ID

• optional AmountUnit amount_unit = 11

  show amounts in

• optional bool decred_staking_ticket = 12

  only for Decred, this is signing a ticket purchase

• optional bool serialize = 13

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

• optional SignTx.CoinJoinRequest coinjoin_request = 14

  only for preauthorized CoinJoins

• optional bool chunkify = 15

  display the address in chunks of 4 characters

* Signing request for a CoinJoin transaction.

Used in: SignTx

• required uint32 fee_rate = 1

  coordination fee rate in units of 10^-6 percent

• required uint64 no_fee_threshold = 2

  PlebsDontPayThreshold in Wasabi, the input amount

• required uint64 min_registrable_amount = 3

  above which the fee rate applies

  minimum registrable output amount

• optional bytes mask_public_key = 4

  ephemeral secp256k1 public key used for masking

• optional bytes signature = 5

  coinjoin_flags, 33 bytes in compressed form

  the trusted party's signature of the CoinJoin request digest

* Request: Reported transaction data (legacy) This message contains all possible field that can be sent in response to a TxRequest. Depending on the request_type, the host is supposed to fill some of these fields. The interface is wire-compatible with the new method of specialized TxAck subtypes, so it can be used in the old way. However, it is now recommended to use more specialized messages, which have better-configured constraints on field values. @next TxRequest

• optional TxAck.TransactionType tx = 1

* Structure representing transaction

Used in: TxAck

• optional uint32 version = 1

• repeated TransactionType.TxInputType inputs = 2

• repeated TransactionType.TxOutputBinType bin_outputs = 3

• optional uint32 lock_time = 4

• repeated TransactionType.TxOutputType outputs = 5

• optional uint32 inputs_cnt = 6

• optional uint32 outputs_cnt = 7

• optional bytes extra_data = 8

  only for Dash, Zcash

• optional uint32 extra_data_len = 9

  only for Dash, Zcash

• optional uint32 expiry = 10

  only for Decred and Zcash

• optional bool overwintered = 11

  Zcash only; deprecated in 2.3.2, the field is not

• optional uint32 version_group_id = 12

  needed, it can be derived from `version`

  only for Zcash, nVersionGroupId

• optional uint32 timestamp = 13

  only for Peercoin

• optional uint32 branch_id = 14

  only for Zcash, BRANCH_ID

* Structure representing transaction input

Used in: TransactionType

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• required bytes prev_hash = 2

  hash of previous transaction output to spend by this input

• required uint32 prev_index = 3

  index of previous output to spend

• optional bytes script_sig = 4

  script signature, unset for tx to sign

• optional uint32 sequence = 5

  sequence (default=0xffffffff)

• optional InputScriptType script_type = 6

  defines template of input script

• optional MultisigRedeemScriptType multisig = 7

  Filled if input is going to spend multisig tx

• optional uint64 amount = 8

  amount of previous transaction output (for segwit only)

• optional uint32 decred_tree = 9

  only for Decred, 0 is a normal transaction

• optional bytes witness = 13

  while 1 is a stake transaction optional uint32 decred_script_version = 10; // only for Decred // deprecated -> only 0 is supported optional bytes prev_block_hash_bip115 = 11; // BIP-115 support dropped optional uint32 prev_block_height_bip115 = 12;// BIP-115 support dropped

  witness data, only set for EXTERNAL inputs

• optional bytes ownership_proof = 14

  SLIP-0019 proof of ownership, only set for EXTERNAL inputs

• optional bytes commitment_data = 15

  optional commitment data for the SLIP-0019 proof of ownership

• optional bytes orig_hash = 16

  tx_hash of the original transaction where this input was spent (used when

• optional uint32 orig_index = 17

  creating a replacement transaction)

  index of the input in the original transaction

• optional DecredStakingSpendType decred_staking_spend = 18

  (used when creating a replacement transaction)

  if not None this holds the type of stake

• optional bytes script_pubkey = 19

  spend: revocation or stake generation

  scriptPubKey of the previous output spent by this

• optional uint32 coinjoin_flags = 20

  input, only set of EXTERNAL inputs

  bit field of CoinJoin-specific flags

* Structure representing compiled transaction output

Used in: TransactionType

• required uint64 amount = 1

• required bytes script_pubkey = 2

• optional uint32 decred_script_version = 3

  only for Decred, currently only 0 is supported

* Structure representing transaction output

Used in: TransactionType

• optional string address = 1

  target coin address in Base58 encoding

• repeated uint32 address_n = 2

  BIP-32 path to derive the key from master node; has

• required uint64 amount = 3

  higher priority than "address"

  amount to spend in satoshis

• optional OutputScriptType script_type = 4

  output script type

• optional MultisigRedeemScriptType multisig = 5

  defines multisig address; script_type must be

• optional bytes op_return_data = 6

  PAYTOMULTISIG

  defines op_return data; script_type must be PAYTOOPRETURN,

• optional bytes orig_hash = 10

  amount must be 0 optional uint32 decred_script_version = 7; // only for Decred // deprecated -> only 0 is supported optional bytes block_hash_bip115 = 8; // BIP-115 support dropped optional uint32 block_height_bip115 = 9; // BIP-115 support dropped

  tx_hash of the original transaction where this output was present (used

• optional uint32 orig_index = 11

  when creating a replacement transaction)

  index of the output in the original transaction

• optional uint32 payment_req_index = 12

  (used when creating a replacement transaction)

  index of the PaymentRequest containing this output

* Request: Data about input to be signed. Wire-alias of TxAck. Do not edit this type without considering compatibility with TxAck. Prefer to modify the inner TxInput type. @next TxRequest

• required TxAckInput.TxAckInputWrapper tx = 1

Used in: TxAckInput

• required TxInput input = 2

* Request: Data about output to be signed. Wire-alias of TxAck. Do not edit this type without considering compatibility with TxAck. Prefer to modify the inner TxOutput type. @next TxRequest

• required TxAckOutput.TxAckOutputWrapper tx = 1

Used in: TxAckOutput

• required TxOutput output = 5

* Request: Content of the extra data of a previous transaction Wire-alias of TxAck. Do not edit this type without considering compatibility with TxAck. @next TxRequest

• required TxAckPrevExtraData.TxAckPrevExtraDataWrapper tx = 1

Used in: TxAckPrevExtraData

• required bytes extra_data_chunk = 8

* Request: Data about previous transaction input Wire-alias of TxAck. Do not edit this type without considering compatibility with TxAck. Prefer to modify the inner PrevInput type. @next TxRequest

• required TxAckPrevInput.TxAckPrevInputWrapper tx = 1

Used in: TxAckPrevInput

• required PrevInput input = 2

* Request: Data about previous transaction metadata Wire-alias of TxAck. Do not edit this type without considering compatibility with TxAck. Prefer to modify the inner PrevTx type. @next TxRequest

• required PrevTx tx = 1

* Request: Data about previous transaction output Wire-alias of TxAck. Do not edit this type without considering compatibility with TxAck. Prefer to modify the inner PrevOutput type. @next TxRequest

• required TxAckPrevOutput.TxAckPrevOutputWrapper tx = 1

Used in: TxAckPrevOutput

• required PrevOutput output = 3

* Data type for transaction input to be signed. When adding fields, take care to not conflict with PrevInput @embed

Used in: TxAckInput.TxAckInputWrapper

• repeated uint32 address_n = 1

  BIP-32 path to derive the key from master node

• required bytes prev_hash = 2

  hash of previous transaction output to spend by this input

• required uint32 prev_index = 3

  index of previous output to spend

• optional bytes script_sig = 4

  script signature, only set for EXTERNAL inputs

• optional uint32 sequence = 5

  sequence

• optional InputScriptType script_type = 6

  defines template of input script

• optional MultisigRedeemScriptType multisig = 7

  Filled if input is going to spend multisig tx

• required uint64 amount = 8

  amount of previous transaction output

• optional uint32 decred_tree = 9

  only for Decred, 0 is a normal transaction while 1 is a stake transaction

• optional bytes witness = 13

  witness data, only set for EXTERNAL inputs

• optional bytes ownership_proof = 14

  SLIP-0019 proof of ownership, only set for EXTERNAL inputs

• optional bytes commitment_data = 15

  optional commitment data for the SLIP-0019 proof of ownership

• optional bytes orig_hash = 16

  tx_hash of the original transaction where this input was

• optional uint32 orig_index = 17

  spent (used when creating a replacement transaction)

  index of the input in the original transaction (used when

• optional DecredStakingSpendType decred_staking_spend = 18

  creating a replacement transaction)

  if not None this holds the type of stake spend: revocation or stake generation

• optional bytes script_pubkey = 19

  scriptPubKey of the previous output spent by this input, only set of EXTERNAL inputs

• optional uint32 coinjoin_flags = 20

  bit field of CoinJoin-specific flags

* Data type for transaction output to be signed. @embed

Used in: TxAckOutput.TxAckOutputWrapper

• optional string address = 1

  destination address in Base58 encoding; script_type must be PAYTOADDRESS

• repeated uint32 address_n = 2

  BIP-32 path to derive the destination (used for change addresses)

• required uint64 amount = 3

  amount to spend in satoshis

• optional OutputScriptType script_type = 4

  output script type

• optional MultisigRedeemScriptType multisig = 5

  defines multisig address; script_type must be PAYTOMULTISIG

• optional bytes op_return_data = 6

  defines op_return data; script_type must be PAYTOOPRETURN, amount must be 0

• optional bytes orig_hash = 10

  tx_hash of the original transaction where this output was

• optional uint32 orig_index = 11

  present (used when creating a replacement transaction)

  index of the output in the original transaction (used when

• optional uint32 payment_req_index = 12

  creating a replacement transaction)

  index of the PaymentRequest containing this output

* Response: Device asks for information for signing transaction or returns the last result If request_index is set, device awaits TxAck<any> matching the request type. If signature_index is set, 'signature' contains signed input of signature_index's input @end @next TxAckInput @next TxAckOutput @next TxAckPrevMeta @next TxAckPrevInput @next TxAckPrevOutput @next TxAckPrevExtraData @next PaymentRequest

• optional TxRequest.RequestType request_type = 1

  what should be filled in TxAck message?

• optional TxRequest.TxRequestDetailsType details = 2

  request for tx details

• optional TxRequest.TxRequestSerializedType serialized = 3

  serialized data and request for next

* Type of information required by transaction signing process

Used in: TxRequest

• TXINPUT = 0

• TXOUTPUT = 1

• TXMETA = 2

• TXFINISHED = 3

• TXEXTRADATA = 4

• TXORIGINPUT = 5

• TXORIGOUTPUT = 6

• TXPAYMENTREQ = 7

* Structure representing request details

Used in: TxRequest

• optional uint32 request_index = 1

  device expects TxAck message from the computer

• optional bytes tx_hash = 2

  tx_hash of requested transaction

• optional uint32 extra_data_len = 3

  length of requested extra data (only for Dash, Zcash)

• optional uint32 extra_data_offset = 4

  offset of requested extra data (only for Dash, Zcash)

* Structure representing serialized data

Used in: TxRequest

• optional uint32 signature_index = 1

  'signature' field contains signed input of this index

• optional bytes signature = 2

  signature of the signature_index input

• optional bytes serialized_tx = 3

  part of serialized and signed transaction

* Request: Ask device to verify message @start @next Success @next Failure

• required string address = 1

  address to verify

• required bytes signature = 2

  signature to verify

• required bytes message = 3

  message to verify

• optional string coin_name = 4

  coin to use for verifying

• optional bool chunkify = 5

  display the address in chunks of 4 characters