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
300 Commits 6 Branches 1 Tag 735 KiB
Python 97.5%
Shell 2.2%
Dockerfile 0.3%
2ddd4ed41a
Go to file
Andrew Chow 2ddd4ed41a Refactor to make hwilib more like a library 
Moves the command argument parsing to hwi.py. Instead of each function
taking args and client, they now take client and whatever else they
need. hwi.py handles the conversion from args and client to the actual
arguments.
2019-01-19 16:58:31 -05:00
docs Update documentation for keepkey 2019-01-12 21:45:42 -05:00
hwilib Refactor to make hwilib more like a library 2019-01-19 16:58:31 -05:00
test Refactor to make hwilib more like a library 2019-01-19 16:58:31 -05:00
.gitignore Add scripts to run tests and prepare test environments 2018-12-04 10:32:23 -05:00
.python-version Set Python version for PyEnv 2018-12-21 13:38:03 +00:00
.travis.yml Build keepkey emulator in setup_environment 2019-01-12 21:45:42 -05:00
hwi.py Refactor to make hwilib more like a library 2019-01-19 16:58:31 -05:00
LICENSE Add MIT license 2017-08-11 13:04:02 -07:00
README.md Update documentation for keepkey 2019-01-12 21:45:42 -05:00
setup.py Use keepkey 6.0.1 from keepkey/python-keepkey repo 2019-01-12 19:40:31 -05:00

README.md

Bitcoin Hardware Wallet Interaction scripts

Build Status

This project contains several scripts for interacting with Bitcoin hardware wallets.

Prerequisites

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

Install all of the libraries using pip (in virtualenv or system):

pip3 install hidapi # HID API needed in general
pip3 install trezor[hidapi] # Trezor One
pip3 install btchip-python # Ledger Nano S
pip3 install ecdsa # Needed for btchip-python but is not installed by it
pip3 install git+git://github.com/keepkey/python-keepkey.git@43fe80ae2e54b274c7b8641ff409bce4ebe04914#egg=keepkey # KeepKey. The tags and pypi don't have the right version yet, so lock to a specific commit from their git repo
pip3 install ckcc-protocol[cli] # Coldcard
pip3 install pyaes # For digitalbitbox

Install

git clone https://github.com/achow101/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 Digital BitBox KeepKey Coldcard
Support Planned Yes Yes Yes Yes Yes
Implemented Yes Yes Yes Yes Yes
xpub retrieval 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
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 No Yes Yes Yes Yes
Display on device screen 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.