Add support for the Blockstream Jade hww

Author: JamieDriver

.cirrus.yml

@@ -102,6 +102,7 @@ task:
         hwilib/devices/bitbox02.py
         hwilib/devices/coldcard.py
         hwilib/devices/digitalbitbox.py
+        hwilib/devices/jade.py
         hwilib/devices/__init__.py
         hwilib/devices/keepkey.py
         hwilib/devices/ledger.py

.flake8

@@ -1,4 +1,4 @@
 [flake8]
-exclude = *.pyc,__pycache__,hwilib/devices/btchip/,hwilib/devices/ckcc/,hwilib/devices/trezorlib/,test/work/,hwilib/ui
+exclude = *.pyc,__pycache__,hwilib/devices/btchip/,hwilib/devices/ckcc/,hwilib/devices/jadepy/,hwilib/devices/trezorlib/,test/work/,hwilib/ui
 ignore = E261,E302,E305,E501,E722,W5
 per-file-ignores = setup.py:E122

docs/devices/index.rst

@@ -10,51 +10,51 @@ The table below lists what devices and features are supported for each device.
 * ``✗`` - supported by the firmware and not implemented in HWI
 * ``―`` - not supported by the firmware
 
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Feature \\ Device                  | Ledger Nano X | Ledger Nano S | Trezor One | Trezor Model T | BitBox01 | BitBox02 | KeepKey | Coldcard |
-+====================================+===============+===============+============+================+==========+==========+=========+==========+
-| Support Planned                    | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Implemented                        | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| xpub retrieval                     | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Message Signing                    | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Device Setup                       | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Device Wipe                        | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Device Recovery                    | ―             | ―             | ✓          | ✓              | ―        | ✓        | ✓       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Device Backup                      | ―             | ―             | ―          | ―              | ✓        | ✓        | ―       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| P2PKH Inputs                       | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| P2SH-P2WPKH Inputs                 | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| P2WPKH Inputs                      | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| P2SH Multisig Inputs               | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| P2SH-P2WSH Multisig Inputs         | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| P2WSH Multisig Inputs              | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Bare Multisig Inputs               | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Arbitrary scriptPubKey Inputs      | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Arbitrary redeemScript Inputs      | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Arbitrary witnessScript Inputs     | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Non-wallet inputs                  | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Mixed Segwit and Non-Segwit Inputs | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
-| Display on device screen           | ✓             | ✓             | ✓          | ✓              | ―        | ✓        | ✓       | ✓        |
-+------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Feature \\ Device                  | Ledger Nano X | Ledger Nano S | Trezor One | Trezor Model T | BitBox01 | BitBox02 | KeepKey | Coldcard | Blockstream Jade |
++====================================+===============+===============+============+================+==========+==========+=========+==========+==================+
+| Support Planned                    | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Implemented                        | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| xpub retrieval                     | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Message Signing                    | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Device Setup                       | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ―        | ―                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Device Wipe                        | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ―        | ―                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Device Recovery                    | ―             | ―             | ✓          | ✓              | ―        | ✓        | ✓       | ―        | ―                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Device Backup                      | ―             | ―             | ―          | ―              | ✓        | ✓        | ―       | ✓        | ―                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| P2PKH Inputs                       | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| P2SH-P2WPKH Inputs                 | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| P2WPKH Inputs                      | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| P2SH Multisig Inputs               | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| P2SH-P2WSH Multisig Inputs         | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| P2WSH Multisig Inputs              | ✓             | ✓             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Bare Multisig Inputs               | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Arbitrary scriptPubKey Inputs      | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Arbitrary redeemScript Inputs      | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Arbitrary witnessScript Inputs     | ✓             | ✓             | ―          | ―              | ✓        | ―        | ―       | ―        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Non-wallet inputs                  | ✓             | ✓             | ✓          | ✓              | ✓        | ―        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Mixed Segwit and Non-Segwit Inputs | ―             | ―             | ✓          | ✓              | ✓        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
+| Display on device screen           | ✓             | ✓             | ✓          | ✓              | ―        | ✓        | ✓       | ✓        | ✓                |
++------------------------------------+---------------+---------------+------------+----------------+----------+----------+---------+----------+------------------+
 
 Support Policy
 ================
@@ -99,3 +99,5 @@ Device APIs
    :members:
 .. automodule:: hwilib.devices.coldcard
    :members:
+.. automodule:: hwilib.devices.jade
+   :members:

hwilib/devices/__init__.py

@@ -5,4 +5,5 @@
     'digitalbitbox',
     'coldcard',
     'bitbox02',
+    'jade'
 ]