This folder contains test cases for HWI. To run these tests, hwilib will need to be installed to your python system. You can install it by doing pip install -e .[tests] in the root directory.

• test_bech32.py tests the bech32 serialization. This is taken directly from the python reference implementation.
• test_psbt.py tests the psbt serialization. It implements all of the BIP 174 serialization test vectors.
• test_trezor.py tests the command line interface and the Trezor implementation. It uses the Trezor One firmware emulator and Trezor Model T firmware emulator. It also tests usage with bitcoind.
• test_keepkey.py tests the command line interface and the Keepkey implementation. It uses the Keepkey firmware emulator. It also tests usage with bitcoind.
• test_coldcard.py tests the command line interface and Coldcard implementation. It uses the Coldcard simulator. It also tests usage with bitcoind.

setup_environment.sh will build the Trezor emulator, the Coldcard simulator, the Keepkey emulator, the Digital Bitbox simulator, and bitcoind. if run in the test/ directory, these will be built in work/test/trezor-firmware, work/test/firmware, work/test/keepkey-firmware, work/test/mcu, and work/test/bitcoin respectively. In order to build each simulator/emulator, you will need to use command line arguments. These are --trezor-1, --trezor-t, --coldcard, --keepkey, --bitbox01, and --bitcoind. If an environment variable is not present or not set, then the simulator/emulator or bitcoind that it guards will not be built.

run_tests.py runs the tests. If run from the test/ directory, it will be able to find the Trezor emulator, Coldcard simulator, Keepkey emulator, Digital Bitbox simulator, and bitcoind. Otherwise the paths to those will need to be specified on the command line. test_trezor.py, test_coldcard.py, test_keepkey.py, and test/test_digitalbitbox.py can be disabled.

If you are building the Trezor emulator, the Coldcard simulator, the Keepkey emulator, the Digital Bitbox simulator, and bitcoind without setup_environment.sh, then you will need to make work/ inside of test/.

$ cd test
$ mkdir -p work
$ cd work

In order to build the Trezor emulator, the following packages will need to be installed:

build-essential curl git python3 python3-pip libsdl2-dev libsdl2-image-dev gcc-arm-none-eabi libnewlib-arm-none-eabi gcc-multilib

The python packages can be installed with

pip install pipenv

Clone the repository:

$ git clone https://github.com/trezor/trezor-firmware/

Build the emulator in headless mode:

$ cd trezor-firmware/legacy
$ export EMULATOR=1 TREZOR_TRANSPORT_V1=1 DEBUG_LINK=1 HEADLESS=1
$ script/setup
$ pipenv install
$ pipenv run script/cibuild

In order to build the Coldcard simulator, the following packages will need to be installed:

build-essential git python3 python3-pip libudev-dev gcc-arm-none-eabi

After cloninig the Coldcard repo into this testing folder, the python packages can be installed with:

pip install -r ckcc_firmware/requirements.txt
pip install -r ckcc_firmware/unix/requirements.txt

Clone the repository:

$ git clone https://github.com/coldcard/firmware

Build the emulator in headless mode:

$ cd firmware/unix
$ make setup
$ make

In order to build the Bitbox simulator, the following packages will need to be installed:

build-essential git cmake

Clone the repository:

$ git clone https://github.com/digitalbitbox/mcu

Build the simulator:

$ cd mcu
$ mkdir -p build && cd build
$ cmake .. -DBUILD_TYPE=simulator
$ make

In order to build the KeepKey emulator, the following packages will need to be installed:

build-essential git python2 python2-pip

The python packages can be installed with

pip install protobuf

Clone the repository and dependencies:

$ git clone https://github.com/keepkey/keepkey-firmware.git
$ cd keepkey-firmware
$ git clone https://github.com/nanopb/nanopb.git -b nanopb-0.2.9.2

Build the emulator:

$ export PATH=$PATH:`pwd`/nanopb/generator
$ cmake -C cmake/caches/emulator.cmake . -DNANOPB_DIR=nanopb/ -DKK_HAVE_STRLCAT=OFF -DKK_HAVE_STRLCPY=OFF
$ make kkemu

In order to build bitcoind, see Bitcoin Core's build documentation to get all of the dependencies installed and for instructions on how to build.