- C 62.7%
- Rust 25.1%
- Python 4.9%
- HTML 3.3%
- Standard ML 1.8%
- Other 2.1%
| .ci | ||
| .github/workflows | ||
| doc | ||
| external | ||
| messages | ||
| py | ||
| releases | ||
| scripts | ||
| src | ||
| test | ||
| tools | ||
| .clang-format | ||
| .clang-tidy | ||
| .codecov.yml | ||
| .containerversion | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .pylintrc | ||
| AGENTS.md | ||
| arm.cmake | ||
| bitbox-da14531-firmware.bin | ||
| bitbox-da14531-firmware.bin.sha256 | ||
| bootloader.ld | ||
| BUILD.md | ||
| CHANGELOG.md | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| firmware.ld | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| SECURITY.md | ||
| versions.json | ||
The BitBox02 is a hardware wallet that simplifies secure handling of crypto coins through storing private keys and signing transactions. The content of this repository is the bootloader and firmware used on the device. The BitBox02 is meant to be used primarily with the BitBoxApp, although third party integration is possible through the BitBox02 API.
The main functionality of the firmware is the following:
- Safely receive and send coins.
- Interacting with the user through touch sliders and a display.
- Back up the seed to a microSD card.
- Back up the seed by displaying the BIP39 mnemonic encoding on the screen.
- Import 12, 18 or 24 word BIP39 mnemonics
- Generate a random seed from multiple strong sources of entropy.
- Protect the seed from attackers.
- Derive keys from the seed according to BIP39 and BIP32.
- Return the extended public key for a keypath so that the app can find all unspent transaction outputs.
- Display the receive address for the keypath, coin and script/address type.
- Display the receive address, transaction amount and network fee and sign each input after confirmation.
Architecture
The main chip on the device is the microcontroller from Microchip (ATSAMD51J20A). This chip is used for communication to the BitBoxApp via USB, to the user via the sliders and to the secure element (ATECC608B) via I2C.
Sliders
The sliders along the edges of the device are used for user input. There are three input gestures:
- Tap
- Slide
- Hold to confirm
USB
The USB communication is implemented using the request-response pattern with encrypted protobuf messages. The encryption protocol used is Noise with out-of-band authentication.
Hardware docs
PCB bill of materials (BOM) v2.1
Contributing
The instructions for setting up a development environment can be found in BUILD.md. Please also read our CONTRIBUTING.md before filing issues and pull requests.
Simulator
To test without hardware there are two kinds of simulators. One with GUI and one without. See more details in BUILD.md.
Installing/upgrading firmware
There are two main ways to install or upgrade firmware on a BitBox02:
- by running the BitBoxApp
- by running ./py/load_firmware.py after installing the bitbox02
Python package, e.g.
./py/load_firmware.py firmware-btc.v9.12.0.signed.bin.
Reporting a vulnerability
See our security policy.