Bitcoin Hardware Wallet Interface

The Bitcoin Hardware Wallet Interface is a Python library and command line tool for interacting with hardware wallets. It provides a standard way for software to work with hardware wallets without needing to implement device specific drivers. Python software can use the provided library (hwilib). Software in other languages can execute the hwi tool.

Caveat emptor: Inclusion of a specific hardware wallet vendor does not imply any endorsement of quality or security.

Prerequisites

Python 3 is required. The libraries and udev rules for each device must also be installed. Some libraries will need to be installed

For Ubuntu/Debian:

sudo apt install libusb-1.0-0-dev libudev-dev python3-dev

For Centos:

sudo yum -y install python3-devel libusbx-devel systemd-devel

For macOS:

brew install libusb

Install

git clone https://github.com/bitcoin-core/HWI.git
cd HWI
poetry install # or 'pip3 install .' or 'python3 setup.py install'

This project uses the Poetry dependency manager. HWI and its dependencies can be installed via poetry by executing the following in the root source directory:

poetry install

Pip can also be used to automatically install HWI and its dependencies using the setup.py file (which is usually in sync with pyproject.toml):

pip3 install .

The setup.py file can be used to install HWI and its dependencies so long as setuptools is also installed:

pip3 install -U setuptools
python3 setup.py install

Dependencies

See pyproject.toml for all dependencies. Dependencies under [tool.poetry.dependecies] are user dependencies, and [tool.poetry.dev-dependencies] for development based dependencies. These dependencies will be installed with any of the three above installation methods.

Usage

To use, first enumerate all devices and find the one that you want to use with

./hwi.py enumerate

Once the device type and device path is known, issue commands to it like so:

./hwi.py -t <type> -d <path> <command> <command args>

All output will be in JSON form and sent to stdout. Additional information or prompts will be sent to stderr and will not necessarily be in JSON. This additional information is for debugging purposes.

To see a complete list of available commands and global parameters, run ./hwi.py --help. To see options specific to a particular command, pass the --help parameter after the command name; for example:

./hwi.py getdescriptors --help

Device Support

The below table lists what devices and features are supported for each device.

Please also see docs for additional information about each device.

| Feature \ Device | Ledger Nano X | Ledger Nano S | Trezor One | Trezor Model T | BitBox01 | BitBox02 | KeepKey | Coldcard | |:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:| | Support Planned | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Implemented | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | xpub retrieval | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Message Signing | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | | Device Setup | N/A | N/A | Yes | Yes | Yes | Yes | Yes | N/A | | Device Wipe | N/A | N/A | Yes | Yes | Yes | Yes | Yes | N/A | | Device Recovery | N/A | N/A | Yes | Yes | N/A | Yes | Yes | N/A | | Device Backup | N/A | N/A | N/A | N/A | Yes | Yes | N/A | Yes | | P2PKH Inputs | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | | P2SH-P2WPKH Inputs | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | P2WPKH Inputs | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | P2SH Multisig Inputs | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | | P2SH-P2WSH Multisig Inputs | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | | P2WSH Multisig Inputs | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Bare Multisig Inputs | Yes | Yes | N/A | N/A | Yes | N/A | N/A | N/A | | Arbitrary scriptPubKey Inputs | Yes | Yes | N/A | N/A | Yes | N/A | N/A | N/A | | Arbitrary redeemScript Inputs | Yes | Yes | N/A | N/A | Yes | N/A | N/A | N/A | | Arbitrary witnessScript Inputs | Yes | Yes | N/A | N/A | Yes | N/A | N/A | N/A | | Non-wallet inputs | Yes | Yes | Yes | Yes | Yes | N/A | Yes | Yes | | Mixed Segwit and Non-Segwit Inputs | N/A | N/A | Yes | Yes | Yes | Yes | Yes | Yes | | Display on device screen | Yes | Yes | Yes | Yes | N/A | Yes | Yes | Yes |

Using with Bitcoin Core

See Using Bitcoin Core with Hardware Wallets.

License

This project is available under the MIT License, Copyright Andrew Chow.