Add getfeatures command and dummy hwwclient.get_features

Author: achow101

hwilib/cli.py

@@ -5,6 +5,7 @@
     displayaddress,
     enumerate,
     find_device,
+    get_client_class,
     get_client,
     getmasterxpub,
     getxpub,
@@ -22,6 +23,7 @@
 )
 from .errors import (
     handle_errors,
+    BAD_ARGUMENT,
     DEVICE_CONN_ERROR,
     HELP_TEXT,
     MISSING_ARGUMENTS,
@@ -88,6 +90,10 @@ def send_pin_handler(args, client):
 def install_udev_rules_handler(args):
     return install_udev_rules('udev', args.location)
 
+def getfeatures_handler(args):
+    client_class = get_client_class(args.device_type)
+    return client_class.get_features()
+
 class HWIHelpFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter):
     pass
 
@@ -208,6 +214,9 @@ def process_commands(cli_args):
     sendpin_parser.add_argument('pin', help='The numeric positions of the PIN')
     sendpin_parser.set_defaults(func=send_pin_handler)
 
+    getfeatures_parser = subparsers.add_parser('getfeatures', help='Returns the supported features for the given device type')
+    getfeatures_parser.set_defaults(func=getfeatures_handler)
+
     if sys.platform.startswith("linux"):
         udevrules_parser = subparsers.add_parser('installudevrules', help='Install and load the udev rule files for the hardware wallet devices')
         udevrules_parser.add_argument('--location', help='The path where the udev rules files will be copied', default='/etc/udev/rules.d/')
@@ -254,6 +263,14 @@ def process_commands(cli_args):
             result = args.func(args)
         return result
 
+    # Do get features
+    if command == 'getfeatures':
+        if not args.device_type:
+            return {'error': 'Device type needs to be specified to get features', 'code': BAD_ARGUMENT}
+        with handle_errors(result=result, debug=args.debug):
+            result = args.func(args)
+        return result
+
     # Auto detect if we are using fingerprint or type to identify device
     if args.fingerprint or (args.device_type and not args.device_path):
         client = find_device(args.password, args.device_type, args.fingerprint, args.expert)

hwilib/devices/coldcard.py

@@ -340,6 +340,11 @@ def send_pin(self, pin):
     def toggle_passphrase(self):
         raise UnavailableActionError('The Coldcard does not support toggling passphrase from the host')
 
+    # Get HWI features for this device
+    @classmethod
+    def get_features(self):
+        raise NotImplementedError('The Coldcard does not implement this method')
+
 def enumerate(password=''):
     results = []
     devices = hid.enumerate(COINKITE_VID, CKCC_PID)

hwilib/devices/digitalbitbox.py

@@ -617,6 +617,11 @@ def send_pin(self, pin):
     def toggle_passphrase(self):
         raise UnavailableActionError('The Digital Bitbox does not support toggling passphrase from the host')
 
+    # Get HWI features for this device
+    @classmethod
+    def get_features(self):
+        raise NotImplementedError('The Digital Bitbox does not implement this method')
+
 class Digitalbitbox01Client(DigitalbitboxClient):
     def __init__(self, path, password='', expert=False):
         super(Digitalbitbox01Client, self).__init__(path, password, expert)

hwilib/devices/ledger.py

@@ -387,6 +387,11 @@ def send_pin(self, pin):
     def toggle_passphrase(self):
         raise UnavailableActionError('The Ledger Nano S and X do not support toggling passphrase from the host')
 
+    # Get HWI features for this device
+    @classmethod
+    def get_features(self):
+        raise NotImplementedError('The Ledger Nano S and X does not implement this method')
+
 class LedgerNanoSClient(LedgerClient):
     def __init__(self, path, password='', expert=False):
         super(LedgerNanoSClient, self).__init__(path, password, expert)

hwilib/devices/trezor.py

@@ -551,6 +551,11 @@ def toggle_passphrase(self):
                 print(PIN_MATRIX_DESCRIPTION, file=sys.stderr)
         return {'success': True}
 
+    # Get HWI features for this device
+    @classmethod
+    def get_features(self):
+        raise NotImplementedError('The {} does not implement this method'.format(self.type))
+
 class Trezor1Client(TrezorClient):
     def __init__(self, path, password='', expert=False):
         super(Trezor1Client, self).__init__(path, password, expert)

hwilib/hwwclient.py

@@ -4,6 +4,60 @@
 from .descriptor import Descriptor
 from .serializations import PSBT
 
+from enum import IntEnum
+
+class DeviceFeature(IntEnum):
+    SUPPORTED = 1 # The device supports the feature and so does HWI
+    NOT_SUPPORTED = 2 # The device supports the feature but HWI has not implemented it yet
+    FIRMWARE_NOT_SUPPORTED = 3 # The firmware does not support the feature so HWI cannot
+
+class SupportedFeatures(object):
+
+    def __init__(self) -> None:
+        self.getxpub = DeviceFeature.NOT_SUPPORTED
+        self.signmessage = DeviceFeature.NOT_SUPPORTED
+        self.setup = DeviceFeature.NOT_SUPPORTED
+        self.wipe = DeviceFeature.NOT_SUPPORTED
+        self.recover = DeviceFeature.NOT_SUPPORTED
+        self.backup = DeviceFeature.NOT_SUPPORTED
+        self.sign_p2pkh = DeviceFeature.NOT_SUPPORTED
+        self.sign_p2sh_p2wpkh = DeviceFeature.NOT_SUPPORTED
+        self.sign_p2wpkh = DeviceFeature.NOT_SUPPORTED
+        self.sign_multi_p2sh = DeviceFeature.NOT_SUPPORTED
+        self.sign_multi_p2sh_p2wsh = DeviceFeature.NOT_SUPPORTED
+        self.sign_multi_p2wsh = DeviceFeature.NOT_SUPPORTED
+        self.sign_multi_bare = DeviceFeature.NOT_SUPPORTED
+        self.sign_arbitrary_bare = DeviceFeature.NOT_SUPPORTED
+        self.sign_arbitrary_p2sh = DeviceFeature.NOT_SUPPORTED
+        self.sign_arbitrary_p2sh_p2wsh = DeviceFeature.NOT_SUPPORTED
+        self.sign_arbitrary_p2wsh = DeviceFeature.NOT_SUPPORTED
+        self.sign_coinjoin = DeviceFeature.NOT_SUPPORTED
+        self.sign_mixed_segwit = DeviceFeature.NOT_SUPPORTED
+        self.display_address = DeviceFeature.NOT_SUPPORTED
+
+    def get_printable_dict(self) -> Dict[str, DeviceFeature]:
+        d = {}
+        d['getxpub'] = self.getxpub
+        d['signmessage'] = self.signmessage
+        d['setup'] = self.setup
+        d['wipe'] = self.wipe
+        d['recover'] = self.recover
+        d['backup'] = self.backup
+        d['sign_p2pkh'] = self.sign_p2pkh
+        d['sign_p2sh_p2wpkh'] = self.sign_p2sh_p2wpkh
+        d['sign_p2wpkh'] = self.sign_p2wpkh
+        d['sign_multi_p2sh'] = self.sign_multi_p2sh
+        d['sign_multi_p2sh_p2wsh'] = self.sign_multi_p2sh_p2wsh
+        d['sign_multi_p2wsh'] = self.sign_multi_p2wsh
+        d['sign_multi_bare'] = self.sign_multi_bare
+        d['sign_arbitrary_bare'] = self.sign_arbitrary_bare
+        d['sign_arbitrary_p2sh'] = self.sign_arbitrary_p2sh
+        d['sign_arbitrary_p2sh_p2wsh'] = self.sign_arbitrary_p2sh_p2wsh
+        d['sign_arbitrary_p2wsh'] = self.sign_arbitrary_p2wsh
+        d['sign_coinjoin'] = self.sign_coinjoin
+        d['sign_mixed_segwit'] = self.sign_mixed_segwit
+        d['display_address'] = self.display_address
+        return d
 
 class HardwareWalletClient(object):
     """Create a client for a HID device that has already been opened.
@@ -185,3 +239,13 @@ def toggle_passphrase(self) -> Dict[str, Union[bool, str, int]]:
         """
         raise NotImplementedError("The HardwareWalletClient base class "
                                   "does not implement this method")
+
+    @classmethod
+    def get_features(self) -> 'SupportedFeatures':
+        """
+        Get features.
+
+        Returns an object with a listing of the features supported by this device.
+        """
+        raise NotImplementedError("The HardwareWalletClient base class "
+                                  "does not implement this method")