lib/commands.py

   1 #!/usr/bin/env python
   2 #
   3 # Electrum - lightweight Bitcoin client
   4 # Copyright (C) 2011 thomasv@gitorious
   5 #
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18
  19 from util import *
  20 from bitcoin import *
  21 from decimal import Decimal
  22 import bitcoin
  23 from transaction import Transaction
  24
  25 class Command:
  26     def __init__(self, name, min_args, max_args, requires_network, requires_wallet, requires_password, description, syntax = '', options_syntax = ''):
  27         self.name = name
  28         self.min_args=min_args
  29         self.max_args = max_args
  30         self.requires_network = requires_network
  31         self.requires_wallet = requires_wallet
  32         self.requires_password = requires_password
  33         self.description = description
  34         self.syntax = syntax
  35         self.options = options_syntax
  36
  37 known_commands = {}
  38 def register_command(*args):
  39     global known_commands
  40     name = args[0]
  41     known_commands[name] = Command(*args)
  42
  43
  44
  45 payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -F: send from address -\n --changeaddr, -c: send change to address'
  46 listaddr_options = " -a: show all addresses, including change addresses\n -l: include labels in results"
  47 restore_options = " accepts a seed or master public key."
  48 mksendmany_syntax = 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]'
  49 payto_syntax = "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label"
  50 paytomany_syntax = "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label"
  51 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 "'
  52 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 "'
  53
  54
  55 #                command
  56 #                                              requires_network
  57 #                                                     requires_wallet
  58 #                                                            requires_password
  59 register_command('contacts',             0, 0, False, True,  False, 'Show your list of contacts')
  60 register_command('create',               0, 0, False, True,  False, 'Create a new wallet')
  61 register_command('createmultisig',       2, 2, False, True,  False, 'similar to bitcoind\'s command')
  62 register_command('createrawtransaction', 2, 2, False, True,  False, 'similar to bitcoind\'s command')
  63 register_command('deseed',               0, 0, False, True,  False, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
  64 register_command('decoderawtransaction', 1, 1, False, False, False, 'similar to bitcoind\'s command')
  65 register_command('dumpprivkey',          1, 1, False, True,  True,  'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
  66 register_command('dumpprivkeys',         0, 0, False, True,  True,  'dump all private keys')
  67 register_command('freeze',               1, 1, False, True,  True,  'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
  68 register_command('getbalance',           0, 1, True,  True,  False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
  69 register_command('getservers',           0, 0, True,  False, False, 'Return the list of available servers')
  70 register_command('getversion',           0, 0, False, False, False, 'Return the version of your client', 'getversion')
  71 register_command('getaddressbalance',    1, 1, True,  False, False, 'Return the balance of an address', 'getaddressbalance <address>')
  72 register_command('getaddresshistory',    1, 1, True,  False, False, 'Return the transaction history of a wallet address', 'getaddresshistory <address>')
  73 register_command('getconfig',            1, 1, False, False, False, 'Return a configuration variable', 'getconfig <name>')
  74 register_command('getpubkeys',           1, 1, False, True,  False, 'Return the public keys for a wallet address', 'getpubkeys <bitcoin address>')
  75 register_command('getrawtransaction',    1, 1, True,  False, False, 'Retrieve a transaction', 'getrawtransaction <txhash>')
  76 register_command('getseed',              0, 0, False, True,  True,  'Print the generation seed of your wallet.')
  77 register_command('getmpk',               0, 0, False, True,  False, 'Return your wallet\'s master public key', 'getmpk')
  78 register_command('help',                 0, 1, False, False, False, 'Prints this help')
  79 register_command('history',              0, 0, True,  True,  False, 'Returns the transaction history of your wallet')
  80 register_command('importprivkey',        1, 1, False, True,  True,  'Import a private key', 'importprivkey <privatekey>')
  81 register_command('listaddresses',        2, 2, False, True,  False, 'Returns your list of addresses.', '', listaddr_options)
  82 register_command('listunspent',          0, 0, True,  False, False, 'Returns the list of unspent inputs in your wallet.')
  83 register_command('getaddressunspent',    1, 1, True,  False, False, 'Returns the list of unspent inputs in your wallet.')
  84 register_command('mktx',                 5, 5, False, True,  True,  'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
  85 register_command('mksendmanytx',         4, 4, False, True,  True,  'Create a signed transaction', mksendmany_syntax, payto_options)
  86 register_command('payto',                5, 5, True,  True,  True,  'Create and broadcast a transaction.', payto_syntax, payto_options)
  87 register_command('paytomany',            4, 4, True,  True,  True,  'Create and broadcast a transaction.', paytomany_syntax, payto_options)
  88 register_command('password',             0, 0, False, True,  True,  'Change your password')
  89 register_command('restore',              0, 0, True,  True,  False, 'Restore a wallet', '', restore_options)
  90 register_command('setconfig',            2, 2, False, False, False, 'Set a configuration variable', 'setconfig <name> <value>')
  91 register_command('setlabel',             2,-1, False, True,  False, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
  92 register_command('sendrawtransaction',   1, 1, True,  False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
  93 register_command('signrawtransaction',   1, 3, False, True,  True,  'similar to bitcoind\'s command')
  94 register_command('signmessage',          2,-1, False, True,  True,  'Sign a message with a key', signmessage_syntax)
  95 register_command('unfreeze',             1, 1, False, True,  False, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
  96 register_command('validateaddress',      1, 1, False, False, False, 'Check that the address is valid', 'validateaddress <address>')
  97 register_command('verifymessage',        3,-1, False, False, False, 'Verifies a signature', verifymessage_syntax)
  98
  99 register_command('daemon',               1, 1, True, False, False, 'start/stop daemon')
 100
 101
 102
 103
 104 class Commands:
 105
 106     def __init__(self, wallet, network, callback = None):
 107         self.wallet = wallet
 108         self.network = network
 109         self._callback = callback
 110         self.password = None
 111
 112
 113     def _run(self, method, args, password_getter):
 114         cmd = known_commands[method]
 115         if cmd.requires_password and self.wallet.use_encryption:
 116             self.password = apply(password_getter,())
 117         f = getattr(self, method)
 118         result = f(*args)
 119         self.password = None
 120         if self._callback:
 121             apply(self._callback, ())
 122         return result
 123
 124
 125     def getaddresshistory(self, addr):
 126         return self.network.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
 127
 128
 129     def daemon(self, arg):
 130         if arg=='stop':
 131             return self.network.stop()
 132         elif arg=='status':
 133             return {
 134                 'server':self.network.main_server(),
 135                 'connected':self.network.is_connected()
 136             }
 137         else:
 138             return "unknown command \"%s\""% arg
 139
 140
 141     def listunspent(self):
 142         import copy
 143         l = copy.deepcopy(self.wallet.get_unspent_coins())
 144         for i in l: i["value"] = str(Decimal(i["value"])/100000000)
 145         return l
 146
 147
 148     def getaddressunspent(self, addr):
 149         return self.network.synchronous_get([ ('blockchain.address.listunspent',[addr]) ])[0]
 150
 151
 152     def createrawtransaction(self, inputs, outputs):
 153         # convert to own format
 154         for i in inputs:
 155             i['tx_hash'] = i['txid']
 156             i['index'] = i['vout']
 157         outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
 158         tx = Transaction.from_io(inputs, outputs)
 159         return tx
 160
 161     def signrawtransaction(self, raw_tx, input_info, private_keys):
 162         tx = Transaction(raw_tx)
 163         self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
 164         return tx
 165
 166     def decoderawtransaction(self, raw):
 167         tx = Transaction(raw)
 168         return tx.deserialize()
 169
 170     def sendrawtransaction(self, raw):
 171         tx = Transaction(raw)
 172         return self.network.synchronous_get([('blockchain.transaction.broadcast', [str(tx)])])[0]
 173
 174     def createmultisig(self, num, pubkeys):
 175         assert isinstance(pubkeys, list)
 176         redeem_script = Transaction.multisig_script(pubkeys, num)
 177         address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
 178         return {'address':address, 'redeemScript':redeem_script}
 179
 180     def freeze(self,addr):
 181         return self.wallet.freeze(addr)
 182
 183     def unfreeze(self,addr):
 184         return self.wallet.unfreeze(addr)
 185
 186     def dumpprivkey(self, addr):
 187         return self.wallet.get_private_key(addr, self.password)
 188
 189     def dumpprivkeys(self, addresses = None):
 190         if addresses is None:
 191             addresses = self.wallet.addresses(True)
 192         return [self.wallet.get_private_key(address, self.password) for address in addresses]
 193
 194     def validateaddress(self, addr):
 195         isvalid = is_valid(addr)
 196         out = { 'isvalid':isvalid }
 197         if isvalid:
 198             out['address'] = addr
 199         return out
 200
 201     def getpubkeys(self, addr):
 202         assert is_valid(addr) and self.wallet.is_mine(addr)
 203         out = { 'address':addr }
 204         account, sequence = self.wallet.get_address_index(addr)
 205         if account != -1:
 206             a = self.wallet.accounts[account]
 207             out['pubkeys'] = a.get_pubkeys( sequence )
 208
 209         return out
 210
 211     def getbalance(self, account= None):
 212         if account is None:
 213             c, u = self.wallet.get_balance()
 214         else:
 215             c, u = self.wallet.get_account_balance(account)
 216
 217         out = { "confirmed": str(Decimal(c)/100000000) }
 218         if u: out["unconfirmed"] = str(Decimal(u)/100000000)
 219         return out
 220
 221     def getaddressbalance(self, addr):
 222         b = self.network.synchronous_get([ ('blockchain.address.get_balance',[addr]) ])[0]
 223         return str(Decimal(b)/100000000)
 224
 225     def getservers(self):
 226         return self.network.get_servers()
 227
 228     def getversion(self):
 229         import electrum
 230         return electrum.ELECTRUM_VERSION
 231
 232     def getmpk(self):
 233         return self.wallet.get_master_public_key()
 234
 235     def getseed(self):
 236         mnemonic = self.wallet.get_mnemonic(self.password)
 237         seed = self.wallet.get_seed(self.password)
 238         return { 'mnemonic':mnemonic, 'seed':seed, 'version':self.wallet.seed_version }
 239
 240     def importprivkey(self, sec):
 241         try:
 242             addr = self.wallet.import_key(sec,self.password)
 243             out = "Keypair imported: ", addr
 244         except Exception as e:
 245             out = "Error: Keypair import failed: " + str(e)
 246         return out
 247
 248
 249     def signmessage(self, address, message):
 250         return self.wallet.sign_message(address, message, self.password)
 251
 252
 253     def verifymessage(self, address, signature, message):
 254         return bitcoin.verify_message(address, signature, message)
 255
 256
 257     def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
 258
 259         for to_address, amount in outputs:
 260             if not is_valid(to_address):
 261                 raise Exception("Invalid Bitcoin address", to_address)
 262
 263         if change_addr:
 264             if not is_valid(change_addr):
 265                 raise Exception("Invalid Bitcoin address", change_addr)
 266
 267         if domain is not None:
 268             for addr in domain:
 269                 if not is_valid(addr):
 270                     raise Exception("invalid Bitcoin address", addr)
 271
 272                 if not self.wallet.is_mine(addr):
 273                     raise Exception("address not in wallet", addr)
 274
 275         for k, v in self.wallet.labels.items():
 276             if change_addr and v == change_addr:
 277                 change_addr = k
 278
 279         final_outputs = []
 280         for to_address, amount in outputs:
 281             for k, v in self.wallet.labels.items():
 282                 if v == to_address:
 283                     to_address = k
 284                     print_msg("alias", to_address)
 285                     break
 286
 287             amount = int(100000000*amount)
 288             final_outputs.append((to_address, amount))
 289
 290         if fee: fee = int(100000000*fee)
 291         return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
 292
 293
 294     def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
 295         tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
 296         return tx
 297
 298     def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
 299         tx = self._mktx(outputs, fee, change_addr, domain)
 300         return tx
 301
 302
 303     def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
 304         tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
 305         r, h = self.wallet.sendtx( tx )
 306         return h
 307
 308     def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
 309         tx = self._mktx(outputs, fee, change_addr, domain)
 310         r, h = self.wallet.sendtx( tx )
 311         return h
 312
 313
 314     def history(self):
 315         import datetime
 316         balance = 0
 317         out = []
 318         for item in self.wallet.get_tx_history():
 319             tx_hash, conf, is_mine, value, fee, balance, timestamp = item
 320             try:
 321                 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
 322             except Exception:
 323                 time_str = "----"
 324
 325             label, is_default_label = self.wallet.get_label(tx_hash)
 326             if not label: label = tx_hash
 327             else: label = label + ' '*(64 - len(label) )
 328
 329             out.append( "%16s"%time_str + "  " + label + "  " + format_satoshis(value)+ "  "+ format_satoshis(balance) )
 330         return out
 331
 332
 333
 334     def setlabel(self, key, label):
 335         self.wallet.set_label(key, label)
 336
 337
 338
 339     def contacts(self):
 340         c = {}
 341         for addr in self.wallet.addressbook:
 342             c[addr] = self.wallet.labels.get(addr)
 343         return c
 344
 345
 346     def listaddresses(self, show_all = False, show_label = False):
 347         out = []
 348         for addr in self.wallet.addresses(True):
 349             if show_all or not self.wallet.is_change(addr):
 350                 if show_label:
 351                     item = { 'address': addr }
 352                     if show_label:
 353                         label = self.wallet.labels.get(addr,'')
 354                         if label:
 355                             item['label'] = label
 356                 else:
 357                     item = addr
 358                 out.append( item )
 359         return out
 360
 361     def help(self, cmd=None):
 362         if cmd not in known_commands:
 363             print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
 364         else:
 365             cmd = known_commands[cmd]
 366             print_msg(cmd.description)
 367             if cmd.syntax: print_msg("Syntax: " + cmd.syntax)
 368             if cmd.options: print_msg("options:\n" + cmd.options)
 369         return None
 370
 371
 372     def getrawtransaction(self, tx_hash):
 373         import transaction
 374         if self.wallet:
 375             tx = self.wallet.transactions.get(tx_hash)
 376             if tx:
 377                 return tx
 378
 379         r = self.network.synchronous_get([ ('blockchain.transaction.get',[tx_hash]) ])[0]
 380         if r:
 381             return transaction.Transaction(r)
 382         else:
 383             return "unknown transaction"
 384
 385
 386