Add getfeatures command and dummy hwwclient.get_features

Author: achow101

hwilib/cli.py

@@ -1,10 +1,11 @@
 #! /usr/bin/env python3
 
 from .commands import backup_device, displayaddress, enumerate, find_device, \
-    get_client, getmasterxpub, getxpub, getkeypool, getdescriptors, prompt_pin, restore_device, send_pin, setup_device, \
+    get_client_class, get_client, getmasterxpub, getxpub, getkeypool, getdescriptors, prompt_pin, 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,
@@ -68,6 +69,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
 
@@ -180,6 +185,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/')
@@ -226,6 +234,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.device_path, args.password, args.device_type, args.fingerprint)

hwilib/devices/coldcard.py

@@ -237,6 +237,11 @@ def prompt_pin(self):
     def send_pin(self, pin):
         raise UnavailableActionError('The Coldcard does not need a PIN sent 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 = []
     for d in hid.enumerate(COINKITE_VID, CKCC_PID):

hwilib/devices/digitalbitbox.py

@@ -578,6 +578,11 @@ def prompt_pin(self):
     def send_pin(self, pin):
         raise UnavailableActionError('The Digital Bitbox does not need a PIN sent 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=''):
         super(Digitalbitbox01Client, self).__init__(path, password)

hwilib/devices/ledger.py

@@ -348,6 +348,11 @@ def prompt_pin(self):
     def send_pin(self, pin):
         raise UnavailableActionError('The {} does not need a PIN sent from the host'.format(self.type))
 
+    # 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=''):
         super(LedgerNanoSClient, self).__init__(path, password)

hwilib/devices/trezor.py

@@ -429,6 +429,11 @@ def send_pin(self, pin):
             return {'success': False}
         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=''):
         super(Trezor1Client, self).__init__(path, password)

hwilib/hwwclient.py

@@ -63,3 +63,8 @@ def prompt_pin(self):
     # Send pin
     def send_pin(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')