coldcard/HWI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
[BREAKGLASS] Append-only mirror of github.com/coldcard/HWI
409 Commits 6 Branches 1 Tag 735 KiB
Python 97.5%
Shell 2.2%
Dockerfile 0.3%
b5d74ec24c
Go to file
Andrew Chow b5d74ec24c
Merge #153: Include Windows UCRT in Windows build 
f109365 Install Windoew Universal C++ Runtime from Windows 10 SDK in Windows build (Andrew Chow)

Pull request description:

  Older versions of Windows needs to have the Windows Universal C++ Runtime packaged with the binary to work. This PR adds to the `build_wine.sh` build script to download the DLLs for the UCRT and package them with the Windows build.

  Fixes #150

ACKs for commit f10936:

Tree-SHA512: 7b9b98cdc4e329cf228dc42a09aa434f984c4db90b09b2ca6cb3dd7d8c1957cd717f761e8a1eeadbd8662f74452141a4df583ab40d939c57e20f0b0f83625b47
2019-04-21 18:08:02 -04:00
contrib Install Windoew Universal C++ Runtime from Windows 10 SDK in Windows build 2019-04-19 22:37:49 -04:00
docs Fix last command format at examples.md 2019-04-20 20:38:16 +03:00
hwilib Import HID in Ledger driver 2019-04-15 19:45:39 -04:00
test Add interactive option and move setup and restore to interactive only 2019-03-14 16:39:12 -04:00
udev [ci skip] Document udev rules 2019-04-16 14:30:36 -04:00
.gitignore Add scripts to run tests and prepare test environments 2018-12-04 10:32:23 -05:00
.python-version Add build scripts and documentation for building releases 2019-03-08 00:17:33 -05:00
.travis.yml Add tests for stdin interface and travis job 2019-03-11 10:23:45 -04:00
hwi.py Refactor to make hwilib more like a library 2019-01-19 16:58:31 -05:00
hwi.spec Add a hwi.spec file for pyinstaller to build standalone binaries 2019-03-08 00:17:33 -05:00
LICENSE Add MIT license 2017-08-11 13:04:02 -07:00
poetry.lock Add pyproject.toml and poetry.lock for poetry dependency manager 2019-03-01 19:47:07 -05:00
pyproject.toml bump version number to 1.0.0 2019-03-15 16:43:53 -04:00
README.md Add Trezor Model T 2019-04-21 22:20:19 +02:00
setup.py bump version number to 1.0.0 2019-03-15 16:43:53 -04:00

README.md

Bitcoin Hardware Wallet Interface

Build Status

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.

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

For macOS:

brew install libusb

This project uses the Poetry dependency manager. Once HWI's source has been downloaded with git clone, it and its dependencies can be installed via poetry by execting the following in the root source directory:

poetry install

Pip can also be used to install all of the dependencies (in virtualenv or system):

pip3 install hidapi # HID API needed in general
pip3 install ecdsa
pip3 install pyaes
pip3 install typing_extensions
pip3 install mnemonic
pip3 install libusb1

Install

git clone https://github.com/bitcoin-core/HWI.git
cd HWI

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>

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 S Trezor One Trezor Model T Digital BitBox KeepKey Coldcard
Support Planned Yes Yes Yes Yes Yes Yes
Implemented Yes Yes Yes Yes Yes Yes
xpub retrieval Yes Yes Yes Yes Yes Yes
Message Signing Yes Yes ? Yes Yes Yes
Device Setup N/A Yes ? Yes Yes N/A
Device Wipe N/A Yes ? Yes Yes N/A
Device Recovery N/A Yes ? N/A Yes N/A
Device Backup N/A N/A ? Yes N/A Yes
P2PKH Inputs Yes Yes ? Yes Yes Yes
P2SH-P2WPKH Inputs Yes Yes ? Yes Yes Yes
P2WPKH Inputs Yes Yes Yes Yes Yes Yes
P2SH Multisig Inputs Yes Yes ? Yes Yes N/A
P2SH-P2WSH Multisig Inputs Yes No ? Yes No N/A
P2WSH Multisig Inputs Yes No ? Yes Yes N/A
Bare Multisig Inputs Yes N/A ? Yes N/A N/A
Aribtrary scriptPubKey Inputs Yes N/A ? Yes N/A N/A
Aribtrary redeemScript Inputs Yes N/A ? Yes N/A N/A
Arbitrary witnessScript Inputs Yes N/A ? Yes N/A N/A
Non-wallet inputs Yes Yes ? Yes Yes Yes
Mixed Segwit and Non-Segwit Inputs N/A Yes ? Yes Yes Yes
Display on device screen Yes Yes Yes N/A 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.