#api #bitcoin #hardware-wallet #api-bindings #wasm #bitbox

bitbox-api

A library to interact with the BitBox02 hardware wallet

13 releases (5 breaking)

0.6.0 Oct 31, 2024
0.4.0 Jun 4, 2024
0.3.1 Feb 4, 2024
0.2.2 Nov 18, 2023

#12 in #hardware-wallet

Download history 121/week @ 2024-08-02 171/week @ 2024-08-09 151/week @ 2024-08-16 103/week @ 2024-08-23 234/week @ 2024-08-30 487/week @ 2024-09-06 167/week @ 2024-09-13 74/week @ 2024-09-20 61/week @ 2024-09-27 34/week @ 2024-10-04 99/week @ 2024-10-11 223/week @ 2024-10-18 225/week @ 2024-10-25 335/week @ 2024-11-01 236/week @ 2024-11-08 259/week @ 2024-11-15

1,083 downloads per month
Used in async-hwi

Apache-2.0

350KB
8K SLoC

Rust 7K SLoC // 0.0% comments TSX 1.5K SLoC JavaScript 148 SLoC // 0.0% comments Shell 27 SLoC TypeScript 8 SLoC // 0.2% comments

BitBox02 library

A library to interact with the BitBox02 hardware wallet.

Check out examples/singlethreaded.rs for an example.

To run the example:

cargo run --example singlethreaded --features=usb,tokio/rt,tokio/macros

See Cargo.toml for further examples.

Simulator tests

tests/simulator_tests.rs runs a set of integration tests against BitBox02 simulators. They are automatically downloaded based on tests/simulators.json, and each one is tested with.

To run them, use:

cargo test --features=simulator,tokio

If you want to test against a custom simulator build (e.g. when developing new firmware features), you can run:

SIMULATOR=/path/to/simulator cargo test --features=simulator,tokio

In this case, only the given simulator will be used, and the ones defined in simulators.json will be ignored.


lib.rs:

Rust BitBox hardware wallet client library.

Dependencies

~10–23MB
~298K SLoC