@bitboxswiss/bitbox-api 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +129 -0
- package/LICENSE +203 -0
- package/README.md +259 -0
- package/package.json +79 -0
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
This repo is the pure TypeScript port of the BitBox02 browser API. The public
|
|
4
|
+
compatibility reference is the Rust/WASM package in the sibling
|
|
5
|
+
`bitbox-api-rs` checkout, while the protobuf source of truth is
|
|
6
|
+
`bitbox02-firmware/messages`.
|
|
7
|
+
|
|
8
|
+
## Prerequisites
|
|
9
|
+
|
|
10
|
+
- Node.js >= 20
|
|
11
|
+
- npm
|
|
12
|
+
- Linux x64 for the downloaded simulator test suite
|
|
13
|
+
|
|
14
|
+
Install dependencies with:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
make install
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Common Commands
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
make typecheck # tsc --noEmit
|
|
24
|
+
make lint # eslint .
|
|
25
|
+
make test # unit tests
|
|
26
|
+
make test-sim # simulator tests
|
|
27
|
+
make build # build ./dist
|
|
28
|
+
make ci # full validation pipeline
|
|
29
|
+
|
|
30
|
+
make sandbox-dev # browser sandbox at http://localhost:5173
|
|
31
|
+
make sandbox-typecheck
|
|
32
|
+
make sandbox-build
|
|
33
|
+
|
|
34
|
+
make proto-sync # copy firmware .proto files into messages/
|
|
35
|
+
make proto-gen # regenerate TS protobuf bindings
|
|
36
|
+
make proto-reset # clean, resync, and regenerate protobuf bindings
|
|
37
|
+
make api-fixture-update # refresh the Rust/WASM API snapshot fixture
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
`make ci` runs the same validation sequence as GitHub Actions. In CI it installs
|
|
41
|
+
dependencies first, checks protobuf regeneration, runs typecheck/lint/unit
|
|
42
|
+
tests/build/package/sandbox checks, and runs simulator tests on Linux x64
|
|
43
|
+
unless `SKIP_SIMULATOR=1` is set.
|
|
44
|
+
|
|
45
|
+
## Simulator Tests
|
|
46
|
+
|
|
47
|
+
Simulator tests live under `test/simulator-*.test.ts` and run through Vitest's
|
|
48
|
+
`simulator` project:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm run test:sim
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
On Linux x64, the harness downloads and caches the simulator binaries listed in
|
|
55
|
+
`test/simulators.json` under `test/simulators/`, verifies their sha256 hashes,
|
|
56
|
+
and starts the newest listed simulator by default.
|
|
57
|
+
|
|
58
|
+
Useful environment variables:
|
|
59
|
+
|
|
60
|
+
- `SIMULATOR=/path/to/simulator`: run a custom simulator binary instead of the
|
|
61
|
+
downloaded one.
|
|
62
|
+
- `SKIP_SIMULATOR=1`: skip simulator tests in `make ci`.
|
|
63
|
+
|
|
64
|
+
The simulator listens on fixed TCP port `15423`. Keep simulator suites
|
|
65
|
+
serialized and reuse one simulator process per file.
|
|
66
|
+
|
|
67
|
+
## Protobuf Workflow
|
|
68
|
+
|
|
69
|
+
The checked-in `.proto` files under `messages/` are copied from
|
|
70
|
+
`../bitbox02-firmware/messages`, not from the Rust API repo.
|
|
71
|
+
|
|
72
|
+
When firmware messages change:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
make proto-reset
|
|
76
|
+
make typecheck
|
|
77
|
+
make test
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
CI runs `npm run proto:check`, which regenerates bindings and fails if
|
|
81
|
+
`src/proto/gen` would change.
|
|
82
|
+
|
|
83
|
+
## Compatibility Policy
|
|
84
|
+
|
|
85
|
+
The package is intended as a drop-in TypeScript replacement for the current
|
|
86
|
+
`bitbox-api` Rust/WASM npm package where methods are implemented.
|
|
87
|
+
|
|
88
|
+
- Keep the exported function/class/type surface aligned with
|
|
89
|
+
`../bitbox-api-rs/pkg/bitbox_api.d.ts`.
|
|
90
|
+
- Only relax the API snapshot for deliberate source-compatible TypeScript
|
|
91
|
+
ergonomics, such as optional callbacks or safer `bigint` input paths.
|
|
92
|
+
- Public errors must keep the `{ code, message, err? }` shape. New public error
|
|
93
|
+
behavior should go through `src/internal/errors.ts` and match the compatibility
|
|
94
|
+
taxonomy unless there is an explicit reason to extend it.
|
|
95
|
+
- BTC, Cardano, and BIP85 methods remain compatibility stubs in this iteration.
|
|
96
|
+
Do not document or test them as implemented until their protocol support lands.
|
|
97
|
+
|
|
98
|
+
`test/api-snapshot.test.ts` compares the built `dist/index.d.ts` against the
|
|
99
|
+
checked-in `test/fixtures/bitbox_api.d.ts` fixture. To refresh the fixture,
|
|
100
|
+
rebuild the Rust/WASM package in `../bitbox-api-rs` so
|
|
101
|
+
`../bitbox-api-rs/pkg/bitbox_api.d.ts` exists, then run:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
make api-fixture-update
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Dependency Policy
|
|
108
|
+
|
|
109
|
+
Runtime dependencies should stay small, browser-safe, and audit-friendly.
|
|
110
|
+
|
|
111
|
+
- No native runtime modules.
|
|
112
|
+
- No WASM runtime dependency.
|
|
113
|
+
- Prefer the existing `@noble/*` crypto stack over adding wallet-framework
|
|
114
|
+
dependencies for small utilities.
|
|
115
|
+
- Keep peer dependency ranges intentional; many integrators already have
|
|
116
|
+
`@noble/*` through wallet/Web3 stacks.
|
|
117
|
+
|
|
118
|
+
## Sandbox
|
|
119
|
+
|
|
120
|
+
The sandbox in `sandbox/` is for manual browser testing against real BitBox
|
|
121
|
+
hardware through WebHID or BitBoxBridge:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
make sandbox-dev
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
The sandbox aliases `@bitboxswiss/bitbox-api` to `../src/index.ts`, so source edits
|
|
128
|
+
hot-reload without building `dist/`. Browsers cannot connect to the raw TCP
|
|
129
|
+
simulator transport directly; simulator coverage belongs in `npm run test:sim`.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Copyright 2026 Shift Crypto AG, Switzerland. All rights reserved.
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright [yyyy] [name of copyright owner]
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
# @bitboxswiss/bitbox-api
|
|
2
|
+
|
|
3
|
+
Pure TypeScript library for integrating BitBox02 hardware wallets in browser
|
|
4
|
+
applications.
|
|
5
|
+
|
|
6
|
+
`@bitboxswiss/bitbox-api` is source-compatible with the current `bitbox-api`
|
|
7
|
+
Rust/WASM package for the implemented surface, but it does not ship WASM and
|
|
8
|
+
does not require a WASM init step.
|
|
9
|
+
|
|
10
|
+
## Status
|
|
11
|
+
|
|
12
|
+
- **Implemented:** WebHID and BitBoxBridge transports, Noise XX pairing,
|
|
13
|
+
Ethereum xpub/address/signing methods, antiklepto, transaction data
|
|
14
|
+
streaming, EIP-712 typed messages, and `ethIdentifyCase()`.
|
|
15
|
+
- **Stubbed with `code: 'unsupported'`:** BTC, Cardano, and BIP85 methods.
|
|
16
|
+
- **Stubbed with `code: 'not-implemented'`:** `deviceInfo()`,
|
|
17
|
+
`rootFingerprint()`, `showMnemonic()`, and `changePassword()`.
|
|
18
|
+
`product()` and `version()` are implemented.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install @bitboxswiss/bitbox-api
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
`@noble/ciphers`, `@noble/curves`, and `@noble/hashes` are peer dependencies so
|
|
27
|
+
the library does not perturb the crypto dependency graph of wallet/Web3 apps.
|
|
28
|
+
|
|
29
|
+
- **npm 7+** installs peer dependencies automatically.
|
|
30
|
+
- **pnpm/yarn** peer handling depends on your package-manager version and
|
|
31
|
+
settings. If your dependency tree does not already include `@noble/*`, add
|
|
32
|
+
them:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
yarn add @noble/ciphers @noble/curves @noble/hashes
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
The package is ESM-only.
|
|
39
|
+
|
|
40
|
+
## Migrating from `bitbox-api`
|
|
41
|
+
|
|
42
|
+
For currently implemented methods, the intended migration is just the import
|
|
43
|
+
name:
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
import * as bitbox from '@bitboxswiss/bitbox-api';
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
There is no `init()` call and no WASM loader. Existing Webpack/Vite WASM plugin
|
|
50
|
+
configuration from `bitbox-api` is not needed for this package.
|
|
51
|
+
|
|
52
|
+
The first TypeScript iteration is Ethereum-focused. BTC, Cardano, BIP85, and a
|
|
53
|
+
few general device helpers are still present in the public type surface for
|
|
54
|
+
compatibility, but currently reject with typed errors as listed in
|
|
55
|
+
[Status](#status).
|
|
56
|
+
|
|
57
|
+
## Browser Requirements
|
|
58
|
+
|
|
59
|
+
- WebHID works in Chromium-based browsers in a secure context, such as HTTPS or
|
|
60
|
+
localhost. Call the connect function from a user action, such as a button
|
|
61
|
+
click, so the browser can show the device chooser.
|
|
62
|
+
- BitBoxBridge works through the local BitBoxBridge service. It is the fallback
|
|
63
|
+
used by `bitbox02ConnectAuto()` when WebHID is unavailable.
|
|
64
|
+
- Pairing trust is stored in `localStorage` when available. Clearing site data
|
|
65
|
+
can require the user to confirm the pairing code again. If `localStorage` is
|
|
66
|
+
unavailable, pairing trust is kept only for the current JavaScript runtime.
|
|
67
|
+
|
|
68
|
+
## Connecting and Pairing
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
import * as bitbox from '@bitboxswiss/bitbox-api';
|
|
72
|
+
|
|
73
|
+
async function connectBitBox(): Promise<bitbox.PairedBitBox | undefined> {
|
|
74
|
+
try {
|
|
75
|
+
const onClose = () => {
|
|
76
|
+
// Clear app state for this BitBox connection.
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
const unpaired = await bitbox.bitbox02ConnectAuto(onClose);
|
|
80
|
+
const pairing = await unpaired.unlockAndPair();
|
|
81
|
+
|
|
82
|
+
const pairingCode = pairing.getPairingCode();
|
|
83
|
+
if (pairingCode !== undefined) {
|
|
84
|
+
// Display the code and ask the user to confirm the same code on the BitBox02.
|
|
85
|
+
console.log('Pairing code:', pairingCode);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
const bb02 = await pairing.waitConfirm();
|
|
89
|
+
console.log('Product:', bb02.product());
|
|
90
|
+
console.log('Firmware:', bb02.version());
|
|
91
|
+
return bb02;
|
|
92
|
+
} catch (err) {
|
|
93
|
+
const typed = bitbox.ensureError(err);
|
|
94
|
+
if (bitbox.isUserAbort(typed)) {
|
|
95
|
+
return undefined;
|
|
96
|
+
}
|
|
97
|
+
throw typed;
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
`BitBox`, `PairingBitBox`, and `PairedBitBox` model a single connection flow.
|
|
103
|
+
After `unlockAndPair()` succeeds, use the returned `PairingBitBox` and stop
|
|
104
|
+
using the original `BitBox`. After `waitConfirm()` succeeds, use the returned
|
|
105
|
+
`PairedBitBox` and stop using the `PairingBitBox`. Reusing consumed or closed
|
|
106
|
+
objects throws `code: 'invalid-state'`.
|
|
107
|
+
|
|
108
|
+
If `unlockAndPair()` or `waitConfirm()` fails, the underlying transport is
|
|
109
|
+
closed. Reconnect before retrying.
|
|
110
|
+
|
|
111
|
+
Call `bb02.close()` when your app is done with the device. `close()` is
|
|
112
|
+
idempotent and invokes the `onClose` callback supplied to the connect function.
|
|
113
|
+
|
|
114
|
+
## Ethereum Usage
|
|
115
|
+
|
|
116
|
+
Keypaths can be strings such as `m/44'/60'/0'/0/0` or number arrays. Chain IDs
|
|
117
|
+
are `bigint` for most Ethereum methods. EIP-1559 transaction objects accept
|
|
118
|
+
`number | bigint` for source compatibility, but `bigint` is preferred when the
|
|
119
|
+
value may exceed JavaScript's safe integer range.
|
|
120
|
+
|
|
121
|
+
```ts
|
|
122
|
+
const keypath = "m/44'/60'/0'/0/0";
|
|
123
|
+
const chainId = 1n;
|
|
124
|
+
|
|
125
|
+
if (!bb02.ethSupported()) {
|
|
126
|
+
throw new Error('This BitBox02 does not support Ethereum');
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
const xpub = await bb02.ethXpub("m/44'/60'/0'/0");
|
|
130
|
+
const address = await bb02.ethAddress(chainId, keypath, true);
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Transaction byte fields are big-endian `Uint8Array`s without a `0x` prefix.
|
|
134
|
+
Returned signature byte fields are plain `number[]` arrays, matching the
|
|
135
|
+
runtime shape of the old WASM package. Pass `ethIdentifyCase()` for the
|
|
136
|
+
optional recipient case hint when you derive the transaction from a hex address
|
|
137
|
+
string.
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
function hexToBytes(hex: string): Uint8Array {
|
|
141
|
+
const body = hex.replace(/^0x/i, '');
|
|
142
|
+
if (body.length % 2 !== 0 || !/^[0-9a-fA-F]*$/.test(body)) {
|
|
143
|
+
throw new Error(`invalid hex length: ${hex}`);
|
|
144
|
+
}
|
|
145
|
+
const out = new Uint8Array(body.length / 2);
|
|
146
|
+
for (let i = 0; i < out.length; i += 1) {
|
|
147
|
+
out[i] = Number.parseInt(body.slice(i * 2, i * 2 + 2), 16);
|
|
148
|
+
}
|
|
149
|
+
return out;
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
const recipient = '04f264cf34440313b4a0192a352814fbe927b885';
|
|
153
|
+
const signature = await bb02.ethSignTransaction(
|
|
154
|
+
1n,
|
|
155
|
+
keypath,
|
|
156
|
+
{
|
|
157
|
+
nonce: hexToBytes('1fdc'),
|
|
158
|
+
gasPrice: hexToBytes('0165a0bc00'),
|
|
159
|
+
gasLimit: hexToBytes('5208'),
|
|
160
|
+
recipient: hexToBytes(recipient),
|
|
161
|
+
value: hexToBytes('075cf1259e9c4000'),
|
|
162
|
+
data: new Uint8Array(),
|
|
163
|
+
},
|
|
164
|
+
bitbox.ethIdentifyCase(recipient),
|
|
165
|
+
);
|
|
166
|
+
|
|
167
|
+
console.log(signature.r, signature.s, signature.v);
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
For EIP-1559, `chainId` is part of the transaction object:
|
|
171
|
+
|
|
172
|
+
```ts
|
|
173
|
+
await bb02.ethSign1559Transaction(keypath, {
|
|
174
|
+
chainId: 1n,
|
|
175
|
+
nonce: hexToBytes('1fdc'),
|
|
176
|
+
maxPriorityFeePerGas: hexToBytes('3b9aca00'),
|
|
177
|
+
maxFeePerGas: hexToBytes('04a817c800'),
|
|
178
|
+
gasLimit: hexToBytes('5208'),
|
|
179
|
+
recipient: hexToBytes(recipient),
|
|
180
|
+
value: hexToBytes('075cf1259e9c4000'),
|
|
181
|
+
data: new Uint8Array(),
|
|
182
|
+
});
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
Personal messages are signed with the standard Ethereum message prefix on the
|
|
186
|
+
device:
|
|
187
|
+
|
|
188
|
+
```ts
|
|
189
|
+
const msg = new TextEncoder().encode('hello bitbox');
|
|
190
|
+
await bb02.ethSignMessage(1n, keypath, msg);
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
EIP-712 typed messages are passed as JavaScript values. `use_antiklepto`
|
|
194
|
+
defaults to `true` when omitted.
|
|
195
|
+
|
|
196
|
+
```ts
|
|
197
|
+
await bb02.ethSignTypedMessage(1n, keypath, typedData);
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## Typed Errors
|
|
201
|
+
|
|
202
|
+
All public API entry points reject with, or can be normalized to, this shape:
|
|
203
|
+
|
|
204
|
+
```ts
|
|
205
|
+
type Error = {
|
|
206
|
+
code: string;
|
|
207
|
+
message: string;
|
|
208
|
+
err?: any;
|
|
209
|
+
};
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
Use `ensureError()` at API boundaries:
|
|
213
|
+
|
|
214
|
+
```ts
|
|
215
|
+
try {
|
|
216
|
+
await bb02.ethAddress(1n, keypath, true);
|
|
217
|
+
} catch (err) {
|
|
218
|
+
const typed = bitbox.ensureError(err);
|
|
219
|
+
if (bitbox.isUserAbort(typed)) {
|
|
220
|
+
return;
|
|
221
|
+
}
|
|
222
|
+
console.error(typed.code, typed.message);
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
Common client-facing codes include:
|
|
227
|
+
|
|
228
|
+
- `could-not-open`: the device or bridge connection could not be opened.
|
|
229
|
+
- `user-abort` / `bitbox-user-abort`: the user cancelled in the browser or on
|
|
230
|
+
the device.
|
|
231
|
+
- `invalid-type`, `keypath-parse`, `chain-id-too-large`: invalid host inputs.
|
|
232
|
+
- `communication`, `noise`, `noise-config`, `pairing-rejected`: transport,
|
|
233
|
+
pairing, or encrypted-channel failures.
|
|
234
|
+
- `version`: the connected firmware is too old for the requested method.
|
|
235
|
+
- `unsupported` / `not-implemented`: public compatibility methods that are not
|
|
236
|
+
wired in this TypeScript iteration.
|
|
237
|
+
|
|
238
|
+
## Sandbox and Development
|
|
239
|
+
|
|
240
|
+
The repository includes a browser sandbox for manual testing with real
|
|
241
|
+
hardware:
|
|
242
|
+
|
|
243
|
+
```bash
|
|
244
|
+
make install
|
|
245
|
+
make sandbox-dev
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Open the printed Vite URL, usually `http://localhost:5173`.
|
|
249
|
+
|
|
250
|
+
For build, test, simulator, protobuf, and contribution workflow details, see
|
|
251
|
+
[CONTRIBUTING.md](CONTRIBUTING.md).
|
|
252
|
+
|
|
253
|
+
## API Compatibility
|
|
254
|
+
|
|
255
|
+
`test/api-snapshot.test.ts` compares the built TypeScript declarations against
|
|
256
|
+
`../bitbox-api-rs/pkg/bitbox_api.d.ts` when the reference checkout is present.
|
|
257
|
+
The guard keeps the public surface drop-in compatible while still allowing
|
|
258
|
+
deliberate source-compatible TypeScript widenings, such as optional close
|
|
259
|
+
callbacks and safer `bigint` chain ID paths.
|
package/package.json
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@bitboxswiss/bitbox-api",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "A pure TypeScript library to interact with BitBox hardware wallets.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"import": "./dist/index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md",
|
|
18
|
+
"CONTRIBUTING.md",
|
|
19
|
+
"LICENSE"
|
|
20
|
+
],
|
|
21
|
+
"sideEffects": false,
|
|
22
|
+
"engines": {
|
|
23
|
+
"node": ">=20"
|
|
24
|
+
},
|
|
25
|
+
"scripts": {
|
|
26
|
+
"build": "rm -rf dist && tsc -p tsconfig.build.json",
|
|
27
|
+
"typecheck": "tsc --noEmit",
|
|
28
|
+
"lint": "eslint .",
|
|
29
|
+
"test": "vitest run --project unit",
|
|
30
|
+
"test:sim": "vitest run --project simulator",
|
|
31
|
+
"proto:sync": "cp ../bitbox02-firmware/messages/*.proto messages/",
|
|
32
|
+
"proto:gen": "buf generate",
|
|
33
|
+
"proto:check": "buf generate && git diff --exit-code -- src/proto/gen",
|
|
34
|
+
"sandbox:dev": "vite --config sandbox/vite.config.ts",
|
|
35
|
+
"sandbox:typecheck": "tsc -p sandbox/tsconfig.json",
|
|
36
|
+
"sandbox:build": "vite build --config sandbox/vite.config.ts"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@bufbuild/buf": "1.68.3",
|
|
40
|
+
"@bufbuild/protoc-gen-es": "2.11.0",
|
|
41
|
+
"@eslint/js": "10.0.1",
|
|
42
|
+
"@ethereumjs/rlp": "10.1.1",
|
|
43
|
+
"@noble/ciphers": "1.3.0",
|
|
44
|
+
"@noble/curves": "1.9.1",
|
|
45
|
+
"@noble/hashes": "1.8.0",
|
|
46
|
+
"@stylistic/eslint-plugin": "5.10.0",
|
|
47
|
+
"@types/node": "25.6.0",
|
|
48
|
+
"@types/react": "18.3.12",
|
|
49
|
+
"@types/react-dom": "18.3.1",
|
|
50
|
+
"@vitejs/plugin-react-swc": "4.3.0",
|
|
51
|
+
"eslint": "10.2.1",
|
|
52
|
+
"react": "18.3.1",
|
|
53
|
+
"react-dom": "18.3.1",
|
|
54
|
+
"typescript": "6.0.3",
|
|
55
|
+
"typescript-eslint": "8.59.0",
|
|
56
|
+
"vite": "6.4.2",
|
|
57
|
+
"vitest": "4.1.5"
|
|
58
|
+
},
|
|
59
|
+
"keywords": [
|
|
60
|
+
"bitbox",
|
|
61
|
+
"bitbox02",
|
|
62
|
+
"hardware-wallet",
|
|
63
|
+
"ethereum",
|
|
64
|
+
"typescript"
|
|
65
|
+
],
|
|
66
|
+
"repository": {
|
|
67
|
+
"type": "git",
|
|
68
|
+
"url": "https://github.com/BitBoxSwiss/bitbox-api-ts"
|
|
69
|
+
},
|
|
70
|
+
"homepage": "https://bitbox.swiss/",
|
|
71
|
+
"dependencies": {
|
|
72
|
+
"@bufbuild/protobuf": "2.11.0"
|
|
73
|
+
},
|
|
74
|
+
"peerDependencies": {
|
|
75
|
+
"@noble/ciphers": "^1.3.0",
|
|
76
|
+
"@noble/curves": "^1.2.0",
|
|
77
|
+
"@noble/hashes": "^1.8.0"
|
|
78
|
+
}
|
|
79
|
+
}
|