register commands, check for their arguments

electrum

@@ -297,20 +297,6 @@ if __name__ == '__main__':
         sys.exit(0)
 
 
-    # open session
-    if cmd not in offline_commands and not options.offline:
-        interface = Interface(config)
-        interface.register_callback('connected', lambda: sys.stderr.write("Connected to " + interface.connection_msg + "\n"))
-        interface.start()
-        wallet.interface = interface
-        verifier = WalletVerifier(interface, config)
-        wallet.set_verifier(verifier)
-        synchronizer = WalletSynchronizer(wallet, config)
-        synchronizer.start()
-        wallet.update()
-        wallet.save()
-
-
                 
     # important warning
     if cmd in ['dumpprivkey', 'dumpprivkeys']:
@@ -338,38 +324,13 @@ if __name__ == '__main__':
         password = None
 
 
-    # check and format the arguments
+    # add missing arguments
     if cmd == 'importprivkey':
         # See if they specificed a key on the cmd line, if not prompt
         if len(args) == 1:
             args[1] = prompt_password('Enter PrivateKey (will not echo):', False)
 
-    elif cmd == 'signmessage':
-        if len(args) < 3:
-            print_msg("Error: Invalid usage of signmessage.")
-            print_msg(known_commands[cmd])
-            sys.exit(1)
-        address = args[1]
-        message = ' '.join(args[2:])
-        if len(args) > 3:
-            print_msg("Warning: Message was reconstructed from several arguments:", repr(message))
-        args = [ cmd, address, message ]
-
-    elif cmd == 'verifymessage':
-        try:
-            address = args[1]
-            signature = args[2]
-            message = ' '.join(args[3:])
-        except:
-            print_msg("Error: Not all parameters were given, displaying help instead.")
-            print_msg(known_commands[cmd])
-            sys.exit(1)
-        if len(args) > 4:
-            print_msg("Warning: Message was reconstructed from several arguments:", repr(message))
-        args = [ cmd, address, signature, message]
-
     elif cmd == 'signrawtransaction':
-        import json
         args = [ cmd, args[1], json.loads(args[2]) if len(args)>2 else [], json.loads(args[3]) if len(args)>3 else []]
 
     elif cmd == 'createmultisig':
@@ -380,15 +341,6 @@ if __name__ == '__main__':
 
     elif cmd=='listaddresses':
         args = [cmd, options.show_all, options.show_balance, options.show_labels]
-                
-    elif cmd == 'setlabel':
-        try:
-            tx = args[1]
-            label = ' '.join(args[2:])
-        except:
-            print_msg("Error. Syntax:  label <tx_hash> <text>")
-            sys.exit(1)
-        args = [ cmd, tx, label ]
 
     elif cmd in ['payto', 'mktx']:
 
@@ -434,6 +386,44 @@ if __name__ == '__main__':
         #    del(wallet.history[from_addr])
         #wallet.save()
 
+                
+
+    # check the number of arguments
+    min_args, max_args, description, syntax, options_syntax = known_commands[cmd]
+    if len(args) - 1 < min_args:
+        print_msg("Not enough arguments")
+        print_msg("Syntax:", syntax)
+        sys.exit(1)
+
+    if max_args >= 0 and len(args) - 1 > max_args:
+        print_msg("too many arguments", args)
+        print_msg("Syntax:", syntax)
+        sys.exit(1)
+
+    if max_args < 0:
+        if len(args) > min_args:
+            message = ' '.join(args[min_args:])
+            print_msg("Warning: Final argument was reconstructed from several arguments:", repr(message))
+            args = args[0:min_args] + [ message ]
+        
+
+
+
+
+
+
+    # open session
+    if cmd not in offline_commands and not options.offline:
+        interface = Interface(config)
+        interface.register_callback('connected', lambda: sys.stderr.write("Connected to " + interface.connection_msg + "\n"))
+        interface.start()
+        wallet.interface = interface
+        verifier = WalletVerifier(interface, config)
+        wallet.set_verifier(verifier)
+        synchronizer = WalletSynchronizer(wallet, config)
+        synchronizer.start()
+        wallet.update()
+        wallet.save()
 
 
     # run the command
@@ -445,7 +435,10 @@ if __name__ == '__main__':
             print_msg("Type 'electrum --help' to see the list of options")
             print_msg("List of commands:", ', '.join(known_commands))
         else:
-            print_msg(known_commands[cmd2])
+            _, _, description, syntax, options_syntax = known_commands[cmd2]
+            print_msg(description)
+            if syntax: print_msg("Syntax: " + syntax)
+            if options_syntax: print_msg("options:\n" + options_syntax)
 
     elif cmd == 'deseed':
         if not wallet.seed:

lib/commands.py

@@ -22,85 +22,60 @@ from bitcoin import *
 from decimal import Decimal
 import bitcoin
 
-known_commands = {
+known_commands = {}
-    'help':'Prints this help',
+offline_commands = []
-    'validateaddress':'Check that the address is valid', 
+protected_commands = []
-    'getbalance': "Display the balance of your wallet or of an address.\nSyntax: getbalance [<address>]", 
+
-    'contacts': "Show your list of contacts", 
+def register_command(name, min_args, max_args, is_protected, is_offline, description, syntax = '', options_syntax = ''):
-    'create':'Create a wallet', 
+    global known_commands, protected_commands, offline_commands
-    'restore':'Restore a wallet', 
+    known_commands[name] = (min_args, max_args, description, syntax, options_syntax)
-    'payto':"""Create and broadcast a transaction.
+    if is_protected:
-Syntax: payto <recipient> <amount> [label]
+        protected_commands.append(name)
-<recipient> can be a bitcoin address or a label
+    if is_offline:
-options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
+        offline_commands.append(name)
-            """,
+
-    'sendrawtransaction':
+
-            'Broadcasts a transaction to the network. \nSyntax: sendrawtransaction <tx in hexadecimal>',
+payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -s: send from address -\n --changeaddr, -c: send change to address'
-    'password': 
+listaddr_options = " -a: show all addresses, including change addresses\n -b: include balance in results\n -l: include labels in results"
-            "Changes your password",
+
-    'listaddresses':
+
-            """Shows your list of addresses.
+register_command('contacts',             0, 0, False, True,  'Show your list of contacts')
-options:
+register_command('create',               0, 0, False, True,  'Create a new wallet')
-  -a: show all addresses, including change addresses
+register_command('createmultisig',       2, 2, False, True,  'similar to bitcoind\'s command')
-  -b: include balance in results
+register_command('createrawtransaction', 2, 2, False, True,  'similar to bitcoind\'s command')
-  -l: include labels in results
+register_command('deseed',               0, 0, False, True,  'Create a seedless, watching-only wallet.')
-  """,
+register_command('decoderawtransaction', 1, 1, False, True,  'similar to bitcoind\'s command')
-
+register_command('dumpprivkey',          1, 1, True,  True,  'similar to bitcoind\'s command')
-    'history':"Shows the transaction history",
+register_command('dumpprivkeys',         0, 0, True,  True,  'dump all private keys')
-    'setlabel':'Assign a label to an item\nSyntax: label <tx_hash> <label>',
+register_command('eval',                 1, 1, False, True,  'Run python eval() on an object', 'eval <expression>\nExample: eval \"wallet.aliases\"')
-    'mktx':
+register_command('freeze',               1, 1, False, True,  'Freeze the funds at one of your wallet\'s addresses')
-        """Create a signed transaction, password protected.
+register_command('getbalance',           0, 1, False, False, 'Display the balance of your wallet or of an address', 'getbalance [<address>]')
-Syntax: mktx <recipient> <amount> [label]
+register_command('getaddresshistory',    1, 1, False, False, 'get history for an address')
-options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
+register_command('getconfig',            1, 1, False, True,  'Return a configuration variable', 'getconfig <name>')
-        """,
+register_command('getseed',              0, 0, True,  True,  'Print the generation seed of your wallet.')
-    'getseed':
+register_command('help',                 0, 1, False, True,  'Prints this help')
-            "Print the generation seed of your wallet.",
+register_command('history',              0, 0, False, False, 'Returns the transaction history of your wallet')
-    'importprivkey': 
+register_command('importprivkey',        1, 1, True,  True,  'Import a private key', 'importprivkey <privatekey>')
-            'Import a private key\nSyntax: importprivkey <privatekey>',
+register_command('listaddresses',        3, 3, False, True,  'Returns your list of addresses.', '', listaddr_options)
-    'signmessage':
+register_command('listunspent',          0, 0, False, True,  'Returns a list of unspent inputs in your wallet.')
-            'Signs a message with a key\nSyntax: signmessage <address> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello  This is a weird String "',
+register_command('mktx',                 5, 5, True,  True,  'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
-    'verifymessage':
+register_command('payto',                5, 5, True,  False, 'Create and broadcast a transaction.', "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label", payto_options)
-             'Verifies a signature\nSyntax: verifymessage <address> <signature> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello  This is a weird String "',
+register_command('password',             0, 0, True,  True,  'Change your password')
-    'eval':  
+register_command('restore',              0, 0, False, False, 'Restore a wallet')
-             "Run python eval() on an object\nSyntax: eval <expression>\nExample: eval \"wallet.aliases\"",
+register_command('setconfig',            2, 2, False, True,  'Set a configuration variable', 'setconfig <name> <value>')
-    'get': 
+register_command('setlabel',             2,-1, False, True,  'Assign a label to an item', 'setlabel <tx_hash> <label>')
-             "Get config parameter.",
+register_command('sendrawtransaction',   1, 1, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
-    'set': 
+register_command('prioritize',           1, 1, False, True,  '')
-             "Set config parameter.",
+register_command('signrawtransaction',   1, 3, True,  True,  'similar to bitcoind\'s command')
-    'deseed':
+register_command('signmessage',          2,-1, True,  True,  'Sign a message with a key', 'signmessage <address> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello  This is a weird String "')
-            "Create a seedless, watching-only wallet.",
+register_command('unprioritize',         1, 1, False, True,  '')
-    'freeze':'',
+register_command('unfreeze',             1, 1, False, True,  '')
-    'unfreeze':'',
+register_command('validateaddress',      1, 1, False, True,  'Check that the address is valid')
-    'prioritize':'',
+register_command('verifymessage',        3,-1, False, True,  'Verifies a signature', 'verifymessage <address> <signature> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello  This is a weird String "')
-    'unprioritize':'',
-    'dumpprivkey':'similar to bitcoind\'s command',
-    'dumpprivkeys':'dump all private keys',
-    'listunspent':'similar to bitcoind\'s command',
-    'createmultisig':'similar to bitcoind\'s command',
-    'createrawtransaction':'similar to bitcoind\'s command',
-    'decoderawtransaction':'similar to bitcoind\'s command',
-    'signrawtransaction':'similar to bitcoind\'s command',
-    'get_history': 'get history for an address'
     
-    }
 
 
 
-offline_commands = [ 'password', 'mktx',
-                     'setlabel', 'contacts',
-                     'help', 'validateaddress',
-                     'signmessage', 'verifymessage',
-                     'eval', 'set', 'get', 'create', 'listaddresses',
-                     'importprivkey', 'getseed',
-                     'deseed',
-                     'freeze','unfreeze',
-                     'prioritize','unprioritize',
-                     'dumpprivkey','dumpprivkeys','listunspent',
-                     'createmultisig', 'createrawtransaction', 'decoderawtransaction', 'signrawtransaction'
-                     ]
-
-protected_commands = ['payto', 'password', 'mktx', 'getseed', 'importprivkey','signmessage', 'signrawtransaction', 'dumpprivkey', 'dumpprivkeys' ]
-
 class Commands:
 
     def __init__(self, wallet, interface, callback = None):
@@ -118,7 +93,7 @@ class Commands:
             apply(self._callback, ())
         return result
 
-    def get_history(self, addr):
+    def getaddresshistory(self, addr):
         h = self.wallet.get_history(addr)
         if h is None: h = self.wallet.interface.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
         return h