package shiftcrypto.bitbox02

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: BTCSignInputRequest, BTCSignMessageRequest, ETHSignEIP1559Request, ETHSignMessageRequest, ETHSignRequest, ETHSignTypedMessageRequest

• bytes commitment = 1

Used in: BTCRequest, ETHRequest

• bytes host_nonce = 1

Used in: BTCResponse, BTCSignNextResponse, ETHResponse

• bytes commitment = 1

Used in: Request

• oneof app

  • google.protobuf.Empty bip39 = 1

  • BIP85Request.AppLn ln = 2

Used in: BIP85Request

• uint32 account_number = 1

Used in: Response

• oneof app

  • google.protobuf.Empty bip39 = 1

  • bytes ln = 2

Used in: BTCPubRequest, BTCScriptConfigRegistration, BTCSignInitRequest, BTCSignMessageRequest

• BTC = 0

• TBTC = 1

• LTC = 2

• TLTC = 3

• RBTC = 4

  Regtest

Used in: BTCRequest

• optional BTCScriptConfigRegistration registration = 1

Used in: BTCResponse

• bool is_registered = 1

Used in: BTCSignOutputRequest

• UNKNOWN = 0

• P2PKH = 1

• P2SH = 2

• P2WPKH = 3

• P2WSH = 4

• P2TR = 5

Used in: BTCRequest

• string recipient_name = 1

• repeated BTCPaymentRequestRequest.Memo memos = 2

• bytes nonce = 3

• uint64 total_amount = 4

• bytes signature = 5

Used in: BTCPaymentRequestRequest

• oneof memo

  • Memo.TextMemo text_memo = 1

Used in: Memo

• string note = 1

Used in: BTCRequest

• uint32 version = 1

• uint32 num_inputs = 2

• uint32 num_outputs = 3

• uint32 locktime = 4

Used in: BTCRequest

• bytes prev_out_hash = 1

• uint32 prev_out_index = 2

• bytes signature_script = 3

• uint32 sequence = 4

Used in: BTCRequest

• uint64 value = 1

• bytes pubkey_script = 2

Used in: Request

• BTCCoin coin = 1

• repeated uint32 keypath = 2

• oneof output

  • BTCPubRequest.XPubType xpub_type = 3

  • BTCScriptConfig script_config = 4

• bool display = 5

Used in: BTCPubRequest

• TPUB = 0

• XPUB = 1

• YPUB = 2

• ZPUB = 3

  zpub

• VPUB = 4

  vpub

• UPUB = 5

• CAPITAL_VPUB = 6

  Vpub

• CAPITAL_ZPUB = 7

  Zpub

• CAPITAL_UPUB = 8

  Upub

• CAPITAL_YPUB = 9

  Ypub

Used in: BTCRequest

• optional BTCScriptConfigRegistration registration = 1

• string name = 2

  If empty, the name is entered on the device instead.

• BTCRegisterScriptConfigRequest.XPubType xpub_type = 3

Used in: BTCRegisterScriptConfigRequest

• AUTO_ELECTRUM = 0

  Automatically choose to match Electrum's xpub format (e.g. Zpub/Vpub for p2wsh multisig mainnet/testnet).

• AUTO_XPUB_TPUB = 1

  Always xpub for mainnets, tpub for testnets.

Used in: Request

• oneof request

  • BTCIsScriptConfigRegisteredRequest is_script_config_registered = 1

  • BTCRegisterScriptConfigRequest register_script_config = 2

  • BTCPrevTxInitRequest prevtx_init = 3

  • BTCPrevTxInputRequest prevtx_input = 4

  • BTCPrevTxOutputRequest prevtx_output = 5

  • BTCSignMessageRequest sign_message = 6

  • AntiKleptoSignatureRequest antiklepto_signature = 7

  • BTCPaymentRequestRequest payment_request = 8

Used in: Response

• oneof response

  • BTCSuccess success = 1

  • BTCIsScriptConfigRegisteredResponse is_script_config_registered = 2

  • BTCSignNextResponse sign_next = 3

  • BTCSignMessageResponse sign_message = 4

  • AntiKleptoSignerCommitment antiklepto_signer_commitment = 5

Used in: BTCPubRequest, BTCScriptConfigRegistration, BTCScriptConfigWithKeypath

• oneof config

  • BTCScriptConfig.SimpleType simple_type = 1

  • BTCScriptConfig.Multisig multisig = 2

  • BTCScriptConfig.Policy policy = 3

Used in: BTCScriptConfig

• uint32 threshold = 1

• repeated XPub xpubs = 2

  xpubs are acount-level xpubs. Addresses are going to be derived from it using: `m/<change>/<receive>`. The number of xpubs defines the number of cosigners.

• uint32 our_xpub_index = 3

  Index to the xpub of our keystore in xpubs. The keypath to it is provided via BTCPubRequest/BTCSignInit.

• Multisig.ScriptType script_type = 4

Used in: Multisig

• P2WSH = 0

  native segwit v0 multisig (bech32 addresses)

• P2WSH_P2SH = 1

  wrapped segwit for legacy address compatibility

A policy as specified by 'Wallet policies': https://github.com/bitcoin/bips/pull/1389

Used in: BTCScriptConfig

• string policy = 1

• repeated KeyOriginInfo keys = 2

SimpleType is a "simple" script: one public key, no additional inputs.

Used in: BTCScriptConfig

• P2WPKH_P2SH = 0

• P2WPKH = 1

• P2TR = 2

Used in: BTCIsScriptConfigRegisteredRequest, BTCRegisterScriptConfigRequest

• BTCCoin coin = 1

• optional BTCScriptConfig script_config = 2

• repeated uint32 keypath = 3

  Unused for policy registrations.

Used in: BTCSignInitRequest, BTCSignMessageRequest

• optional BTCScriptConfig script_config = 2

• repeated uint32 keypath = 3

Used in: Request

• BTCCoin coin = 1

• repeated BTCScriptConfigWithKeypath script_configs = 2

  used script configs in inputs and changes

• uint32 version = 4

  must be 1 or 2

• uint32 num_inputs = 5

• uint32 num_outputs = 6

• uint32 locktime = 7

  must be <500000000

• BTCSignInitRequest.FormatUnit format_unit = 8

• bool contains_silent_payment_outputs = 9

• repeated BTCScriptConfigWithKeypath output_script_configs = 10

  used script configs for outputs that send to an address of the same keystore, but not necessarily the same account (as defined by `script_configs` above).

Used in: BTCSignInitRequest

• DEFAULT = 0

  According to `coin` (BTC, LTC, etc.).

• SAT = 1

  Only valid for BTC/TBTC, formats as "sat"/"tsat".

Used in: Request

• bytes prevOutHash = 1

• uint32 prevOutIndex = 2

• uint64 prevOutValue = 3

• uint32 sequence = 4

  must be 0xffffffff-2, 0xffffffff-1 or 0xffffffff

• repeated uint32 keypath = 6

  all inputs must be ours.

• uint32 script_config_index = 7

  References a script config from BTCSignInitRequest

• optional AntiKleptoHostNonceCommitment host_nonce_commitment = 8

Used in: BTCRequest

• BTCCoin coin = 1

• optional BTCScriptConfigWithKeypath script_config = 2

• bytes msg = 3

• optional AntiKleptoHostNonceCommitment host_nonce_commitment = 4

Used in: BTCResponse

• bytes signature = 1

  65 bytes (32 bytes big endian R, 32 bytes big endian S, 1 recid).

Used in: BTCResponse, Response

• BTCSignNextResponse.Type type = 1

• uint32 index = 2

  index of the current input or output

• bool has_signature = 3

  only as a response to BTCSignInputRequest

• bytes signature = 4

  64 bytes (32 bytes big endian R, 32 bytes big endian S). Only if has_signature is true.

• uint32 prev_index = 5

  Previous tx's input/output index in case of PREV_INPUT or PREV_OUTPUT, for the input at `index`.

• optional AntiKleptoSignerCommitment anti_klepto_signer_commitment = 6

• bytes generated_output_pkscript = 7

  Generated output. The host *must* verify its correctness using `silent_payment_dleq_proof`.

• bytes silent_payment_dleq_proof = 8

Used in: BTCSignNextResponse

• INPUT = 0

• OUTPUT = 1

• DONE = 2

• PREVTX_INIT = 3

  For the previous transaction at input `index`.

• PREVTX_INPUT = 4

• PREVTX_OUTPUT = 5

• HOST_NONCE = 6

• PAYMENT_REQUEST = 7

Used in: Request

• bool ours = 1

• BTCOutputType type = 2

  if ours is false

• uint64 value = 3

  20 bytes for p2pkh, p2sh, pw2wpkh. 32 bytes for p2wsh.

• bytes payload = 4

  if ours is false. Renamed from `hash`.

• repeated uint32 keypath = 5

  if ours is true

• uint32 script_config_index = 6

  If ours is true and `output_script_config_index` is absent. References a script config from BTCSignInitRequest. This allows change output identification and allows us to identify non-change outputs to the same account, so we can display this info to the user.

• optional uint32 payment_request_index = 7

• optional BTCSignOutputRequest.SilentPayment silent_payment = 8

  If provided, `type` and `payload` is ignored. The generated output pkScript is returned in BTCSignNextResponse. `contains_silent_payment_outputs` in the init request must be true.

• optional uint32 output_script_config_index = 9

  If ours is true. If set, `script_config_index` is ignored. References an output script config from BTCSignInitRequest. This enables verification that an output belongs to the same keystore, even if it is from a different account than we spend from, allowing us to display this info to the user.

https://github.com/bitcoin/bips/blob/master/bip-0352.mediawiki

Used in: BTCSignOutputRequest

• string address = 1

Used in: BTCResponse

(message has no fields)

Used in: ListBackupsResponse

• string id = 1

• uint32 timestamp = 2

• string name = 4

  uint32 timezone_offset = 3;

Used in: CardanoRequest

• CardanoNetwork network = 1

• bool display = 2

• optional CardanoScriptConfig script_config = 3

Used in: CardanoAddressRequest, CardanoSignTransactionRequest

• CardanoMainnet = 0

• CardanoTestnet = 1

Used in: Request

• oneof request

  • CardanoXpubsRequest xpubs = 1

  • CardanoAddressRequest address = 2

  • CardanoSignTransactionRequest sign_transaction = 3

Used in: Response

• oneof response

  • CardanoXpubsResponse xpubs = 1

  • PubResponse pub = 2

  • CardanoSignTransactionResponse sign_transaction = 3

Used in: CardanoAddressRequest, CardanoSignTransactionRequest.Output

• oneof config

  Entries correspond to address types as described in: https://github.com/cardano-foundation/CIPs/blob/6c249ef48f8f5b32efc0ec768fadf4321f3173f2/CIP-0019/CIP-0019.md See also: https://github.com/input-output-hk/cardano-ledger-specs/blob/d0aa86ded0b973b09b629e5aa62aa1e71364d088/eras/alonzo/test-suite/cddl-files/alonzo.cddl#L137

  • CardanoScriptConfig.PkhSkh pkh_skh = 1

    Shelley PaymentKeyHash & StakeKeyHash

Used in: CardanoScriptConfig

• repeated uint32 keypath_payment = 1

• repeated uint32 keypath_stake = 2

Max allowed transaction size is 16384 bytes according to https://github.com/cardano-foundation/CIPs/blob/master/CIP-0009/CIP-0009.md. Unlike with BTC, we can fit the whole request in RAM and don't need to stream. See also: https://github.com/input-output-hk/cardano-ledger-specs/blob/d0aa86ded0b973b09b629e5aa62aa1e71364d088/eras/alonzo/test-suite/cddl-files/alonzo.cddl#L50

Used in: CardanoRequest

• CardanoNetwork network = 1

• repeated CardanoSignTransactionRequest.Input inputs = 2

• repeated CardanoSignTransactionRequest.Output outputs = 3

• uint64 fee = 4

• uint64 ttl = 5

• repeated CardanoSignTransactionRequest.Certificate certificates = 6

• repeated CardanoSignTransactionRequest.Withdrawal withdrawals = 7

• uint64 validity_interval_start = 8

• bool allow_zero_ttl = 9

  include ttl even if it is zero

• bool tag_cbor_sets = 10

  Tag arrays in the transaction serialization with the 258 tag. See https://github.com/IntersectMBO/cardano-ledger/blob/6e2d37cc0f47bd02e89b4ce9f78b59c35c958e96/eras/conway/impl/cddl-files/extra.cddl#L5

https://github.com/input-output-hk/cardano-ledger/blob/d0aa86ded0b973b09b629e5aa62aa1e71364d088/eras/alonzo/test-suite/cddl-files/alonzo.cddl#L358

Used in: Output

• bytes policy_id = 1

• repeated AssetGroup.Token tokens = 2

Used in: AssetGroup

• bytes asset_name = 1

• uint64 value = 2

  Number of tokens transacted of this asset.

See https://github.com/IntersectMBO/cardano-ledger/blob/cardano-ledger-conway-1.12.0.0/eras/conway/impl/cddl-files/conway.cddl#L273

Used in: CardanoSignTransactionRequest

• oneof cert

  • Keypath stake_registration = 1

  • Keypath stake_deregistration = 2

  • Certificate.StakeDelegation stake_delegation = 3

  • Certificate.VoteDelegation vote_delegation = 10

Used in: Certificate

• repeated uint32 keypath = 1

• bytes pool_keyhash = 2

Used in: Certificate

• repeated uint32 keypath = 1

  keypath in this instance refers to stake credential

• VoteDelegation.CardanoDRepType type = 2

• optional bytes drep_credhash = 3

Used in: VoteDelegation

• KEY_HASH = 0

• SCRIPT_HASH = 1

• ALWAYS_ABSTAIN = 2

• ALWAYS_NO_CONFIDENCE = 3

Used in: CardanoSignTransactionRequest

• repeated uint32 keypath = 1

• bytes prev_out_hash = 2

• uint32 prev_out_index = 3

Used in: CardanoSignTransactionRequest

• string encoded_address = 1

• uint64 value = 2

• optional CardanoScriptConfig script_config = 3

  Optional. If provided, this is validated as a change output.

• repeated AssetGroup asset_groups = 4

Used in: CardanoSignTransactionRequest

• repeated uint32 keypath = 1

• uint64 value = 2

Used in: CardanoResponse

• repeated CardanoSignTransactionResponse.ShelleyWitness shelley_witnesses = 1

Used in: CardanoSignTransactionResponse

• bytes public_key = 1

• bytes signature = 2

Used in: CardanoRequest

• repeated Keypath keypaths = 1

Used in: CardanoResponse

• repeated bytes xpubs = 1

Used in: Request

• bool silent = 1

Used in: Response

• string id = 1

Used in: Request

(message has no fields)

Used in: Response

• bool inserted = 1

Timestamp must be in UTC

Used in: Request

• uint32 timestamp = 1

• int32 timezone_offset = 2

Used in: Request

(message has no fields)

Used in: Response

• string name = 1

• bool initialized = 2

• string version = 3

• bool mnemonic_passphrase_enabled = 4

• uint32 monotonic_increments_remaining = 5

• string securechip_model = 6

  From v9.6.0: "ATECC608A" or "ATECC608B".

Used in: ETHSignEIP1559Request, ETHSignRequest

• ETH_ADDRESS_CASE_MIXED = 0

• ETH_ADDRESS_CASE_UPPER = 1

• ETH_ADDRESS_CASE_LOWER = 2

Kept for backwards compatibility. Use chain_id instead, introduced in v9.10.0.

Used in: ETHPubRequest, ETHSignMessageRequest, ETHSignRequest

• ETH = 0

• RopstenETH = 1

  Removed in v9.14.0 - deprecated

• RinkebyETH = 2

  Removed in v9.14.0 - deprecated

Used in: ETHRequest

• repeated uint32 keypath = 1

• ETHCoin coin = 2

  Deprecated: use chain_id instead.

• ETHPubRequest.OutputType output_type = 3

• bool display = 4

• bytes contract_address = 5

• uint64 chain_id = 6

  If non-zero, `coin` is ignored and `chain_id` is used to identify the network.

Used in: ETHPubRequest

• ADDRESS = 0

• XPUB = 1

Used in: Request

• oneof request

  • ETHPubRequest pub = 1

  • ETHSignRequest sign = 2

  • ETHSignMessageRequest sign_msg = 3

  • AntiKleptoSignatureRequest antiklepto_signature = 4

  • ETHSignTypedMessageRequest sign_typed_msg = 5

  • ETHTypedMessageValueRequest typed_msg_value = 6

  • ETHSignEIP1559Request sign_eip1559 = 7

Used in: Response

• oneof response

  • PubResponse pub = 1

  • ETHSignResponse sign = 2

  • AntiKleptoSignerCommitment antiklepto_signer_commitment = 3

  • ETHTypedMessageValueResponse typed_msg_value = 4

TX payload for an EIP-1559 (type 2) transaction: https://eips.ethereum.org/EIPS/eip-1559

Used in: ETHRequest

• uint64 chain_id = 1

• repeated uint32 keypath = 2

• bytes nonce = 3

  smallest big endian serialization, max. 16 bytes

• bytes max_priority_fee_per_gas = 4

  smallest big endian serialization, max. 16 bytes

• bytes max_fee_per_gas = 5

  smallest big endian serialization, max. 16 bytes

• bytes gas_limit = 6

  smallest big endian serialization, max. 16 bytes

• bytes recipient = 7

  20 byte recipient

• bytes value = 8

  smallest big endian serialization, max. 32 bytes

• bytes data = 9

• optional AntiKleptoHostNonceCommitment host_nonce_commitment = 10

• ETHAddressCase address_case = 11

Used in: ETHRequest

• ETHCoin coin = 1

  Deprecated: use chain_id instead.

• repeated uint32 keypath = 2

• bytes msg = 3

• optional AntiKleptoHostNonceCommitment host_nonce_commitment = 4

• uint64 chain_id = 5

  If non-zero, `coin` is ignored and `chain_id` is used to identify the network.

TX payload for "legacy" (EIP-155) transactions: https://eips.ethereum.org/EIPS/eip-155

Used in: ETHRequest

• ETHCoin coin = 1

  Deprecated: use chain_id instead.

• repeated uint32 keypath = 2

• bytes nonce = 3

  smallest big endian serialization, max. 16 bytes

• bytes gas_price = 4

  smallest big endian serialization, max. 16 bytes

• bytes gas_limit = 5

  smallest big endian serialization, max. 16 bytes

• bytes recipient = 6

  20 byte recipient

• bytes value = 7

  smallest big endian serialization, max. 32 bytes

• bytes data = 8

• optional AntiKleptoHostNonceCommitment host_nonce_commitment = 9

• uint64 chain_id = 10

  If non-zero, `coin` is ignored and `chain_id` is used to identify the network.

• ETHAddressCase address_case = 11

Used in: ETHResponse

• bytes signature = 1

  65 bytes, last byte is the recid

Used in: ETHRequest

• uint64 chain_id = 1

• repeated uint32 keypath = 2

• repeated ETHSignTypedMessageRequest.StructType types = 3

• string primary_type = 4

• optional AntiKleptoHostNonceCommitment host_nonce_commitment = 5

Used in: MemberType

• UNKNOWN = 0

• BYTES = 1

• UINT = 2

• INT = 3

• BOOL = 4

• ADDRESS = 5

• STRING = 6

• ARRAY = 7

• STRUCT = 8

Used in: StructType

• string name = 1

• optional MemberType type = 2

Used in: Member

• DataType type = 1

• uint32 size = 2

• string struct_name = 3

  if type==STRUCT, name of struct type.

• optional MemberType array_type = 4

  if type==ARRAY, type of elements

Used in: ETHSignTypedMessageRequest

• string name = 1

• repeated Member members = 2

Used in: ETHRequest

• bytes value = 1

Used in: ETHResponse

• ETHTypedMessageValueResponse.RootObject root_object = 1

• repeated uint32 path = 2

Used in: ETHTypedMessageValueResponse

• UNKNOWN = 0

• DOMAIN = 1

• MESSAGE = 2

Used in: Request

• repeated uint32 keypath = 1

Used in: Response

• string key = 1

Used in: Response

• int32 code = 1

• string message = 2

Used in: Request

• InsertRemoveSDCardRequest.SDCardAction action = 1

Used in: InsertRemoveSDCardRequest

• REMOVE_CARD = 0

• INSERT_CARD = 1

Used in: BTCScriptConfig.Policy

• bytes root_fingerprint = 1

• repeated uint32 keypath = 2

• optional XPub xpub = 3

This message exists for use in oneof or repeated fields, where one can't inline `repeated uint32` due to protobuf rules.

Used in: CardanoSignTransactionRequest.Certificate, CardanoXpubsRequest

• repeated uint32 keypath = 1

Used in: Request

(message has no fields)

Used in: Response

• repeated BackupInfo info = 1

Deprecated, last used in v1.0.0

Used in: Request

• bytes challenge = 1

  32 bytes challenge.

Deprecated, last used in v1.0.0

Used in: Response

• bytes bootloader_hash = 1

• bytes device_pubkey = 2

• bytes certificate = 3

• bytes root_pubkey_identifier = 4

• bytes challenge_signature = 5

Used in: CardanoResponse, ETHResponse, Response

• string pub = 1

Used in: Request

• RebootRequest.Purpose purpose = 1

Used in: RebootRequest

• UPGRADE = 0

• SETTINGS = 1

• oneof request

  • SetDeviceNameRequest device_name = 2

    removed: RandomNumberRequest random_number = 1;

  • SetDeviceLanguageRequest device_language = 3

  • DeviceInfoRequest device_info = 4

  • SetPasswordRequest set_password = 5

  • CreateBackupRequest create_backup = 6

  • ShowMnemonicRequest show_mnemonic = 7

  • BTCPubRequest btc_pub = 8

  • BTCSignInitRequest btc_sign_init = 9

  • BTCSignInputRequest btc_sign_input = 10

  • BTCSignOutputRequest btc_sign_output = 11

  • InsertRemoveSDCardRequest insert_remove_sdcard = 12

  • CheckSDCardRequest check_sdcard = 13

  • SetMnemonicPassphraseEnabledRequest set_mnemonic_passphrase_enabled = 14

  • ListBackupsRequest list_backups = 15

  • RestoreBackupRequest restore_backup = 16

  • PerformAttestationRequest perform_attestation = 17

  • RebootRequest reboot = 18

  • CheckBackupRequest check_backup = 19

  • ETHRequest eth = 20

  • ResetRequest reset = 21

  • RestoreFromMnemonicRequest restore_from_mnemonic = 22

  • RootFingerprintRequest fingerprint = 24

    removed: BitBoxBaseRequest bitboxbase = 23;

  • BTCRequest btc = 25

  • ElectrumEncryptionKeyRequest electrum_encryption_key = 26

  • CardanoRequest cardano = 27

  • BIP85Request bip85 = 28

Used in: Request

(message has no fields)

• oneof response

  • Success success = 1

  • Error error = 2

  • DeviceInfoResponse device_info = 4

    removed: RandomNumberResponse random_number = 3;

  • PubResponse pub = 5

  • BTCSignNextResponse btc_sign_next = 6

  • ListBackupsResponse list_backups = 7

  • CheckBackupResponse check_backup = 8

  • PerformAttestationResponse perform_attestation = 9

  • CheckSDCardResponse check_sdcard = 10

  • ETHResponse eth = 11

  • RootFingerprintResponse fingerprint = 12

  • BTCResponse btc = 13

  • ElectrumEncryptionKeyResponse electrum_encryption_key = 14

  • CardanoResponse cardano = 15

  • BIP85Response bip85 = 16

Used in: Request

• string id = 1

• uint32 timestamp = 2

• int32 timezone_offset = 3

Used in: Request

• uint32 timestamp = 1

• int32 timezone_offset = 2

Used in: Request

(message has no fields)

Used in: Response

• bytes fingerprint = 1

Used in: Request

• string language = 1

Used in: Request

• string name = 1

Used in: Request

• bool enabled = 1

Used in: Request

• bytes entropy = 1

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

See https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki. version field dropped as it will set dynamically based on the context (xpub, ypub, etc.).

Used in: BTCScriptConfig.Multisig, KeyOriginInfo

• bytes depth = 1

• bytes parent_fingerprint = 2

• uint32 child_num = 3

• bytes chain_code = 4

• bytes public_key = 5