Add getfeatures command and dummy hwwclient.get_features

Author: achow101

hwilib/cli.py

@@ -1,10 +1,29 @@
 #! /usr/bin/env python3
 
-from .commands import backup_device, displayaddress, enumerate, find_device, \
-    get_client, getmasterxpub, getxpub, getkeypool, getdescriptors, prompt_pin, toggle_passphrase, restore_device, send_pin, setup_device, \
-    signmessage, signtx, wipe_device, install_udev_rules
+from .commands import (
+    backup_device,
+    displayaddress,
+    enumerate,
+    find_device,
+    get_client_class,
+    get_client,
+    getmasterxpub,
+    getxpub,
+    getkeypool,
+    getdescriptors,
+    prompt_pin,
+    toggle_passphrase,
+    restore_device,
+    send_pin,
+    setup_device,
+    signmessage,
+    signtx,
+    wipe_device,
+    install_udev_rules,
+)
 from .errors import (
     handle_errors,
+    BAD_ARGUMENT,
     DEVICE_CONN_ERROR,
     HELP_TEXT,
     MISSING_ARGUMENTS,
@@ -71,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
 
@@ -188,6 +211,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/')
@@ -234,6 +260,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

@@ -246,6 +246,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

@@ -587,6 +587,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

@@ -358,6 +358,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

@@ -440,6 +440,11 @@ def toggle_passphrase(self):
         self._check_unlocked()
         return device.apply_settings(self.client, use_passphrase=not self.client.features.passphrase_protection)
 
+    # 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

@@ -75,3 +75,8 @@ def send_pin(self):
     # Toggle passphrase
     def toggle_passphrase(self):
         raise NotImplementedError('The HardwareWalletClient base class does not implement this method')
+
+    # Get HWI features for this device
+    @classmethod
+    def get_features(self):
+        raise NotImplementedError('The HardwareWalletClient base class does not implement this method')