commit 2f66cdf908caaf2563fd53a5d10eb7076ead7c77
parent 77dd1ae1b18d5c249e2c90b7678cf4befe5c542b
Author: ThomasV <thomasv@gitorious>
Date: Thu, 3 Oct 2013 12:39:42 +0200
new flag for commands: requires_wallet
Diffstat:
| M | electrum | | | 77 | +++++++++++++++++++++++++++++++++++++++++++---------------------------------- |
| M | lib/__init__.py | | | 2 | +- |
| M | lib/commands.py | | | 116 | ++++++++++++++++++++++++++++++++++++++++++++++--------------------------------- |
3 files changed, 111 insertions(+), 84 deletions(-)
diff --git a/electrum b/electrum
@@ -171,20 +171,26 @@ if __name__ == '__main__':
sys.exit(0)
+ if cmd not in known_commands:
+ cmd = 'help'
+
+ cmd = known_commands[cmd]
+
# instanciate wallet for command-line
storage = WalletStorage(config)
- wallet = Wallet(storage)
- if cmd not in known_commands:
- cmd = 'help'
+ if cmd.requires_wallet:
+ wallet = Wallet(storage)
+ else:
+ wallet = None
- if not storage.file_exists and cmd not in ['help','create','restore']:
+ if cmd.name not in ['create', 'restore'] and cmd.requires_wallet and not storage.file_exists:
print_msg("Error: Wallet file not found.")
print_msg("Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option")
sys.exit(0)
- if cmd in ['create', 'restore']:
- if wallet.storage.file_exists:
+ if cmd.name in ['create', 'restore']:
+ if storage.file_exists:
sys.exit("Error: Remove the existing wallet first!")
if options.password != None:
password = options.password
@@ -203,7 +209,7 @@ if __name__ == '__main__':
if fee: wallet.set_fee(float(fee)*100000000)
if gap: wallet.change_gap_limit(int(gap))
- if cmd == 'restore':
+ if cmd.name == 'restore':
seed = raw_input("seed:")
try:
seed.decode('hex')
@@ -248,13 +254,13 @@ if __name__ == '__main__':
# important warning
- if cmd in ['dumpprivkey', 'dumpprivkeys']:
+ if cmd.name in ['dumpprivkey', 'dumpprivkeys']:
print_msg("WARNING: ALL your private keys are secret.")
print_msg("Exposing a single private key can compromise your entire wallet!")
print_msg("In particular, DO NOT use 'redeem private key' services proposed by third parties.")
# commands needing password
- if cmd in protected_commands:
+ if cmd.requires_password:
if wallet.use_encryption:
password = prompt_password('Password:', False)
if not password:
@@ -274,28 +280,28 @@ if __name__ == '__main__':
# add missing arguments, do type conversions
- if cmd == 'importprivkey':
+ if cmd.name == '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 == 'signrawtransaction':
+ elif cmd.name == 'signrawtransaction':
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':
+ elif cmd.name == 'createmultisig':
args = [ cmd, int(args[1]), json.loads(args[2])]
- elif cmd == 'createrawtransaction':
+ elif cmd.name == 'createrawtransaction':
args = [ cmd, json.loads(args[1]), json.loads(args[2])]
- elif cmd == 'listaddresses':
+ elif cmd.name == 'listaddresses':
args = [cmd, options.show_all, options.show_balance, options.show_labels]
- elif cmd in ['payto', 'mktx']:
+ elif cmd.name in ['payto', 'mktx']:
domain = [options.from_addr] if options.from_addr else None
args = [ 'mktx', args[1], Decimal(args[2]), Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain ]
- elif cmd in ['paytomany', 'mksendmanytx']:
+ elif cmd.name in ['paytomany', 'mksendmanytx']:
domain = [options.from_addr] if options.from_addr else None
outputs = []
for i in range(1, len(args), 2):
@@ -305,47 +311,49 @@ if __name__ == '__main__':
outputs.append((args[i], Decimal(args[i+1])))
args = [ 'mksendmanytx', outputs, Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain ]
- elif cmd == 'help':
+ elif cmd.name == 'help':
if len(args) < 2:
print_help(parser)
# check the number of arguments
- min_args, max_args, description, syntax, options_syntax = known_commands[cmd]
- if len(args) - 1 < min_args:
+ if len(args) - 1 < cmd.min_args:
print_msg("Not enough arguments")
print_msg("Syntax:", syntax)
sys.exit(1)
- if max_args >= 0 and len(args) - 1 > max_args:
+ if cmd.max_args >= 0 and len(args) - 1 > cmd.max_args:
print_msg("too many arguments", args)
print_msg("Syntax:", syntax)
sys.exit(1)
- if max_args < 0:
- if len(args) > min_args + 1:
- message = ' '.join(args[min_args:])
+ if cmd.max_args < 0:
+ if len(args) > cmd.min_args + 1:
+ message = ' '.join(args[cmd.min_args:])
print_msg("Warning: Final argument was reconstructed from several arguments:", repr(message))
- args = args[0:min_args] + [ message ]
+ args = args[0:cmd.min_args] + [ message ]
# open session
- if cmd not in offline_commands and not options.offline:
+ if cmd.requires_network and not options.offline:
network = Network(config)
network.register_callback('connected', lambda: sys.stderr.write("Connected to " + network.interface.connection_msg + "\n"))
if not network.start(wait=True):
print_msg("Not connected, aborting.")
sys.exit(1)
- wallet.start_threads(network)
- wallet.update()
+ if wallet:
+ wallet.start_threads(network)
+ wallet.update()
+ else:
+ network = None
# run the command
- if cmd == 'deseed':
+ if cmd.name == 'deseed':
if not wallet.seed:
print_msg("Error: This wallet has no seed")
else:
@@ -363,11 +371,11 @@ if __name__ == '__main__':
else:
print_msg("Action canceled.")
- elif cmd == 'getconfig':
+ elif cmd.name == 'getconfig':
key = args[1]
print_msg(config.get(key))
- elif cmd == 'setconfig':
+ elif cmd.name == 'setconfig':
key, value = args[1:3]
if key not in ['seed', 'seed_version', 'master_public_key', 'use_encryption']:
config.set_key(key, value, True)
@@ -375,16 +383,17 @@ if __name__ == '__main__':
else:
print_msg(False)
- elif cmd == 'password':
+ elif cmd.name == 'password':
new_password = prompt_password('New password:')
wallet.update_password(seed, password, new_password)
else:
- run_command(cmd, password, args)
+ run_command(cmd.name, password, args)
- if cmd not in offline_commands and not options.offline:
- wallet.stop_threads()
+ if network:
+ if wallet:
+ wallet.stop_threads()
network.stop()
time.sleep(0.1)
sys.exit(0)
diff --git a/lib/__init__.py b/lib/__init__.py
@@ -13,4 +13,4 @@ from transaction import Transaction
from plugins import BasePlugin
from mnemonic import mn_encode as mnemonic_encode
from mnemonic import mn_decode as mnemonic_decode
-from commands import protected_commands, known_commands, offline_commands, Commands
+from commands import Commands, known_commands
diff --git a/lib/commands.py b/lib/commands.py
@@ -16,68 +16,85 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
from util import *
from bitcoin import *
from decimal import Decimal
import bitcoin
+
+class Command:
+ def __init__(self, name, min_args, max_args, requires_network, requires_wallet, requires_password, description, syntax = '', options_syntax = ''):
+ self.name = name
+ self.min_args=min_args
+ self.max_args = max_args
+ self.requires_network = requires_network
+ self.requires_wallet = requires_wallet
+ self.requires_password = requires_password
+ self.description = description
+ self.syntax = syntax
+ self.options = options_syntax
+
known_commands = {}
-offline_commands = []
-protected_commands = []
+def register_command(*args):
+ global known_commands
+ name = args[0]
+ known_commands[name] = Command(*args)
-def register_command(name, min_args, max_args, is_protected, is_offline, description, syntax = '', options_syntax = ''):
- global known_commands, protected_commands, offline_commands
- known_commands[name] = (min_args, max_args, description, syntax, options_syntax)
- if is_protected:
- protected_commands.append(name)
- if is_offline:
- offline_commands.append(name)
payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -s: send from address -\n --changeaddr, -c: send change to address'
listaddr_options = " -a: show all addresses, including change addresses\n -b: include balance in results\n -l: include labels in results"
restore_options = " accepts a seed or master public key."
config_options = " accounts, addr_history, auto_cycle, column_widths, console-history, contacts,\n fee_per_kb, frozen_addresses, gap_limit, imported_keys, labels,\n master_public_key, num_zeros, prioritized_addresses, proxy, seed,\n seed_version, server, transactions, use_change, use_encryption, winpos-qt"
+mksendmany_syntax = 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]'
+payto_syntax = "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label"
+paytomany_syntax = "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label"
+signmessage_syntax = '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 "'
+verifymessage_syntax = '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 "'
+
+
+# command
+# requires_network
+# requires_wallet
+# requires_password
+register_command('contacts', 0, 0, False, True, False, 'Show your list of contacts')
+register_command('create', 0, 0, False, True, False, 'Create a new wallet')
+register_command('createmultisig', 2, 2, False, True, False, 'similar to bitcoind\'s command')
+register_command('createrawtransaction', 2, 2, False, True, False, 'similar to bitcoind\'s command')
+register_command('deseed', 0, 0, False, True, False, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
+register_command('decoderawtransaction', 1, 1, False, False, False, 'similar to bitcoind\'s command')
+register_command('dumpprivkey', 1, 1, False, True, True, 'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
+register_command('dumpprivkeys', 0, 0, False, True, True, 'dump all private keys')
+register_command('freeze', 1, 1, False, True, True, 'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
+register_command('getbalance', 0, 1, True, True, False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
+register_command('getservers', 0, 0, True, False, False, 'Return the list of available servers')
+register_command('getaddressbalance', 1, 1, True, True, False, 'Return the balance of an address', 'getbalance <address>')
+register_command('getaddresshistory', 1, 1, True, False, False, 'Return the transaction history of an address', 'getaddresshistory <address>')
+register_command('getconfig', 1, 1, False, False, False, 'Return a configuration variable', 'getconfig <name>', config_options)
+register_command('getrawtransaction', 1, 2, True, False, False, 'Retrieve a transaction', 'getrawtransaction <txhash> <height>')
+register_command('getseed', 0, 0, False, True, True, 'Print the generation seed of your wallet.')
+register_command('help', 0, 1, False, False, False, 'Prints this help')
+register_command('history', 0, 0, True, True, False, 'Returns the transaction history of your wallet')
+register_command('importprivkey', 1, 1, False, True, True, 'Import a private key', 'importprivkey <privatekey>')
+register_command('listaddresses', 3, 3, False, True, False, 'Returns your list of addresses.', '', listaddr_options)
+register_command('listunspent', 0, 0, True, True, False, 'Returns the list of unspent inputs in your wallet.')
+register_command('mktx', 5, 5, False, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
+register_command('mksendmanytx', 4, 4, False, True, True, 'Create a signed transaction', mksendmany_syntax, payto_options)
+register_command('payto', 5, 5, True, True, True, 'Create and broadcast a transaction.', payto_syntax, payto_options)
+register_command('paytomany', 4, 4, True, True, True, 'Create and broadcast a transaction.', paytomany_syntax, payto_options)
+register_command('password', 0, 0, False, True, True, 'Change your password')
+register_command('prioritize', 1, 1, False, True, False, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
+register_command('restore', 0, 0, True, True, False, 'Restore a wallet', '', restore_options)
+register_command('setconfig', 2, 2, False, False, False, 'Set a configuration variable', 'setconfig <name> <value>', config_options)
+register_command('setlabel', 2,-1, False, True, False, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
+register_command('sendrawtransaction', 1, 1, True, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
+register_command('signrawtransaction', 1, 3, False, True, True, 'similar to bitcoind\'s command')
+register_command('signmessage', 2,-1, False, True, True, 'Sign a message with a key', signmessage_syntax)
+register_command('unfreeze', 1, 1, False, True, False, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
+register_command('unprioritize', 1, 1, False, True, False, 'Unprioritize an address', 'unprioritize <address>')
+register_command('validateaddress', 1, 1, False, False, False, 'Check that the address is valid', 'validateaddress <address>')
+register_command('verifymessage', 3,-1, False, False, False, 'Verifies a signature', verifymessage_syntax)
-register_command('contacts', 0, 0, False, True, 'Show your list of contacts')
-register_command('create', 0, 0, False, True, 'Create a new wallet')
-register_command('createmultisig', 2, 2, False, True, 'similar to bitcoind\'s command')
-register_command('createrawtransaction', 2, 2, False, True, 'similar to bitcoind\'s command')
-register_command('deseed', 0, 0, False, True, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
-register_command('decoderawtransaction', 1, 1, False, True, 'similar to bitcoind\'s command')
-register_command('dumpprivkey', 1, 1, True, True, 'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
-register_command('dumpprivkeys', 0, 0, True, True, 'dump all private keys')
-register_command('freeze', 1, 1, False, True, 'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
-register_command('getbalance', 0, 1, False, False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
-register_command('getservers', 0, 0, False, False, 'Return the list of available servers')
-register_command('getaddressbalance', 1, 1, False, False, 'Return the balance of an address', 'getbalance <address>')
-register_command('getaddresshistory', 1, 1, False, False, 'Return the transaction history of an address', 'getaddresshistory <address>')
-register_command('getconfig', 1, 1, False, True, 'Return a configuration variable', 'getconfig <name>', config_options)
-register_command('getrawtransaction', 1, 2, False, False, 'Retrieve a transaction', 'getrawtransaction <txhash> <height>')
-register_command('getseed', 0, 0, True, True, 'Print the generation seed of your wallet.')
-register_command('help', 0, 1, False, True, 'Prints this help')
-register_command('history', 0, 0, False, False, 'Returns the transaction history of your wallet')
-register_command('importprivkey', 1, 1, True, True, 'Import a private key', 'importprivkey <privatekey>')
-register_command('listaddresses', 3, 3, False, True, 'Returns your list of addresses.', '', listaddr_options)
-register_command('listunspent', 0, 0, False, True, 'Returns a list of unspent inputs in your wallet.')
-register_command('mktx', 5, 5, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
-register_command('mksendmanytx', 4, 4, True, True, 'Create a signed transaction', 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]', payto_options)
-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)
-register_command('paytomany', 4, 4, True, False, 'Create and broadcast a transaction.', "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label", payto_options)
-register_command('password', 0, 0, True, True, 'Change your password')
-register_command('prioritize', 1, 1, False, True, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
-register_command('restore', 0, 0, False, False, 'Restore a wallet', '', restore_options)
-register_command('setconfig', 2, 2, False, True, 'Set a configuration variable', 'setconfig <name> <value>', config_options)
-register_command('setlabel', 2,-1, False, True, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
-register_command('sendrawtransaction', 1, 1, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
-register_command('signrawtransaction', 1, 3, True, True, 'similar to bitcoind\'s command')
-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 "')
-register_command('unfreeze', 1, 1, False, True, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
-register_command('unprioritize', 1, 1, False, True, 'Unprioritize an address', 'unprioritize <address>')
-register_command('validateaddress', 1, 1, False, True, 'Check that the address is valid', 'validateaddress <address>')
-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 "')
-
@@ -90,7 +107,8 @@ class Commands:
self.password = None
def _run(self, method, args, password_getter):
- if method in protected_commands and self.wallet.use_encryption:
+ cmd = known_commands[method]
+ if cmd.requires_password and self.wallet.use_encryption:
self.password = apply(password_getter,())
f = eval('self.'+method)
result = apply(f,args)
