bitbox-api 0.12.0

A library to interact with BitBox hardware wallets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

// SPDX-License-Identifier: Apache-2.0

syntax = "proto3";
package shiftcrypto.bitbox02;

import "common.proto";
import "antiklepto.proto";

// Kept for backwards compatibility. Use chain_id instead, introduced in v9.10.0.
enum ETHCoin {
  ETH = 0;
  // Removed in v9.14.0 - deprecated
  RopstenETH = 1;
  // Removed in v9.14.0 - deprecated
  RinkebyETH = 2;
}

enum ETHAddressCase {
  ETH_ADDRESS_CASE_MIXED = 0;
  ETH_ADDRESS_CASE_UPPER = 1;
  ETH_ADDRESS_CASE_LOWER = 2;
}

message ETHPubRequest {
  repeated uint32 keypath = 1;
  // Deprecated: use chain_id instead.
  ETHCoin coin = 2;
  enum OutputType {
    ADDRESS = 0;
    XPUB = 1;
  }
  OutputType output_type = 3;
  bool display = 4;
  bytes contract_address = 5;
  // If non-zero, `coin` is ignored and `chain_id` is used to identify the network.
  uint64 chain_id = 6;
}

// TX payload for "legacy" (EIP-155) transactions: https://eips.ethereum.org/EIPS/eip-155
message ETHSignRequest {
  // Deprecated: use chain_id instead.
  ETHCoin coin = 1;
  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;
  AntiKleptoHostNonceCommitment host_nonce_commitment = 9;
  // If non-zero, `coin` is ignored and `chain_id` is used to identify the network.
  uint64 chain_id = 10;
  ETHAddressCase address_case = 11;
  // For streaming: if non-zero, data field should be empty and data will be requested in chunks
  uint32 data_length = 12;
}

// TX payload for an EIP-1559 (type 2) transaction: https://eips.ethereum.org/EIPS/eip-1559
message ETHSignEIP1559Request {
  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;
  AntiKleptoHostNonceCommitment host_nonce_commitment = 10;
  ETHAddressCase address_case = 11;
  // For streaming: if non-zero, data field should be empty and data will be requested in chunks
  uint32 data_length = 12;
}

message ETHSignDataRequestChunkResponse {
  uint32 offset = 1;
  uint32 length = 2;
}

message ETHSignDataResponseChunkRequest {
  bytes chunk = 1;
}

message ETHSignMessageRequest {
  // Deprecated: use chain_id instead.
  ETHCoin coin = 1;
  repeated uint32 keypath = 2;
  bytes msg = 3;
  AntiKleptoHostNonceCommitment host_nonce_commitment = 4;
  // If non-zero, `coin` is ignored and `chain_id` is used to identify the network.
  uint64 chain_id = 5;
}

message ETHSignResponse {
  bytes signature = 1; // 65 bytes, last byte is the recid
}

message ETHSignTypedMessageRequest {
  enum DataType {
    UNKNOWN = 0;
    BYTES = 1;
    UINT = 2;
    INT = 3;
    BOOL = 4;
    ADDRESS = 5;
    STRING = 6;
    ARRAY = 7;
    STRUCT = 8;
  }

  message MemberType {
    DataType type = 1;
    uint32 size = 2;
    string struct_name = 3; // if type==STRUCT, name of struct type.
    MemberType array_type = 4; // if type==ARRAY, type of elements
  }

  message Member {
    string name = 1;
    MemberType type = 2;
  }

  message StructType {
    string name = 1;
    repeated Member members = 2;
  }

  uint64 chain_id = 1;
  repeated uint32 keypath = 2;
  repeated StructType types = 3;
  string primary_type = 4;
  AntiKleptoHostNonceCommitment host_nonce_commitment = 5;
}

message ETHTypedMessageValueResponse {
  enum RootObject {
    UNKNOWN = 0;
    DOMAIN = 1;
    MESSAGE = 2;
  }
  RootObject root_object = 1;
  repeated uint32 path = 2;
}

message ETHTypedMessageValueRequest {
  bytes value = 1;
  // If non-zero, value should be empty and data will be streamed via
  // DataRequestChunk/DataResponseChunk.
  uint32 data_length = 2;
}

message ETHRequest {
  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;
    ETHSignDataResponseChunkRequest data_response_chunk = 8;
  }
}

message ETHResponse {
  oneof response {
    PubResponse pub = 1;
    ETHSignResponse sign = 2;
    AntiKleptoSignerCommitment antiklepto_signer_commitment = 3;
    ETHTypedMessageValueResponse typed_msg_value = 4;
    ETHSignDataRequestChunkResponse data_request_chunk = 5;
  }
}