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
  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, -s: send from address -\n --changeaddr, -c: send change to address'
  46 listaddr_options = " -a: show all addresses, including change addresses\n -b: include balance in results\n -l: include labels in results"
  47 restore_options = " accepts a seed or master public key."
  48 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"
  49 mksendmany_syntax = 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]'
  50 payto_syntax = "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label"
  51 paytomany_syntax = "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label"
  52 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 "'
  53 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 "'
  54
  55
  56 #                command
  57 #                                              requires_network
  58 #                                                     requires_wallet
  59 #                                                            requires_password
  60 register_command('contacts',             0, 0, False, True,  False, 'Show your list of contacts')
  61 register_command('create',               0, 0, False, True,  False, 'Create a new wallet')
  62 register_command('createmultisig',       2, 2, False, True,  False, 'similar to bitcoind\'s command')
  63 register_command('createrawtransaction', 2, 2, False, True,  False, 'similar to bitcoind\'s command')
  64 register_command('deseed',               0, 0, False, True,  False, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
  65 register_command('decoderawtransaction', 1, 1, False, False, False, 'similar to bitcoind\'s command')
  66 register_command('dumpprivkey',          1, 1, False, True,  True,  'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
  67 register_command('dumpprivkeys',         0, 0, False, True,  True,  'dump all private keys')
  68 register_command('freeze',               1, 1, False, True,  True,  'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
  69 register_command('getbalance',           0, 1, True,  True,  False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
  70 register_command('getservers',           0, 0, True,  False, False, 'Return the list of available servers')
  71 register_command('getaddressbalance',    1, 1, True,  True,  False, 'Return the balance of an address', 'getbalance <address>')
  72 register_command('getaddresshistory',    1, 1, True,  False, False, 'Return the transaction history of an address', 'getaddresshistory <address>')
  73 register_command('getconfig',            1, 1, False, False, False, 'Return a configuration variable', 'getconfig <name>', config_options)
  74 register_command('getrawtransaction',    1, 2, True,  False, False, 'Retrieve a transaction', 'getrawtransaction <txhash> <height>')
  75 register_command('getseed',              0, 0, False, True,  True,  'Print the generation seed of your wallet.')
  76 register_command('help',                 0, 1, False, False, False, 'Prints this help')
  77 register_command('history',              0, 0, True,  True,  False, 'Returns the transaction history of your wallet')
  78 register_command('importprivkey',        1, 1, False, True,  True,  'Import a private key', 'importprivkey <privatekey>')
  79 register_command('listaddresses',        3, 3, False, True,  False, 'Returns your list of addresses.', '', listaddr_options)
  80 register_command('listunspent',          0, 0, True,  True,  False, 'Returns the list of unspent inputs in your wallet.')
  81 register_command('mktx',                 5, 5, False, True,  True,  'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
  82 register_command('mksendmanytx',         4, 4, False, True,  True,  'Create a signed transaction', mksendmany_syntax, payto_options)
  83 register_command('payto',                5, 5, True,  True,  True,  'Create and broadcast a transaction.', payto_syntax, payto_options)
  84 register_command('paytomany',            4, 4, True,  True,  True,  'Create and broadcast a transaction.', paytomany_syntax, payto_options)
  85 register_command('password',             0, 0, False, True,  True,  'Change your password')
  86 register_command('prioritize',           1, 1, False, True,  False, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
  87 register_command('restore',              0, 0, True,  True,  False, 'Restore a wallet', '', restore_options)
  88 register_command('setconfig',            2, 2, False, False, False, 'Set a configuration variable', 'setconfig <name> <value>', config_options)
  89 register_command('setlabel',             2,-1, False, True,  False, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
  90 register_command('sendrawtransaction',   1, 1, True,  False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
  91 register_command('signrawtransaction',   1, 3, False, True,  True,  'similar to bitcoind\'s command')
  92 register_command('signmessage',          2,-1, False, True,  True,  'Sign a message with a key', signmessage_syntax)
  93 register_command('unfreeze',             1, 1, False, True,  False, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
  94 register_command('unprioritize',         1, 1, False, True,  False, 'Unprioritize an address', 'unprioritize <address>')
  95 register_command('validateaddress',      1, 1, False, False, False, 'Check that the address is valid', 'validateaddress <address>')
  96 register_command('verifymessage',        3,-1, False, False, False, 'Verifies a signature', verifymessage_syntax)
  97
  98
  99
 100
 101 class Commands:
 102
 103     def __init__(self, wallet, network, callback = None):
 104         self.wallet = wallet
 105         self.network = network
 106         self._callback = callback
 107         self.password = None
 108
 109     def _run(self, method, args, password_getter):
 110         cmd = known_commands[method]
 111         if cmd.requires_password and self.wallet.use_encryption:
 112             self.password = apply(password_getter,())
 113         f = eval('self.'+method)
 114         result = apply(f,args)
 115         self.password = None
 116         if self._callback:
 117             apply(self._callback, ())
 118         return result
 119
 120     def getaddresshistory(self, addr):
 121         h = self.wallet.get_history(addr)
 122         if h is None: h = self.network.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
 123         return h
 124
 125     def listunspent(self):
 126         import copy
 127         l = copy.deepcopy(self.wallet.get_unspent_coins())
 128         for i in l: i["value"] = str(Decimal(i["value"])/100000000)
 129         return l
 130
 131     def createrawtransaction(self, inputs, outputs):
 132         # convert to own format
 133         for i in inputs:
 134             i['tx_hash'] = i['txid']
 135             i['index'] = i['vout']
 136         outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
 137         tx = Transaction.from_io(inputs, outputs)
 138         return tx
 139
 140     def signrawtransaction(self, raw_tx, input_info, private_keys):
 141         tx = Transaction(raw_tx)
 142         self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
 143         return tx
 144
 145     def decoderawtransaction(self, raw):
 146         tx = Transaction(raw)
 147         return tx.deserialize()
 148
 149     def sendrawtransaction(self, raw):
 150         tx = Transaction(raw)
 151         r, h = self.wallet.sendtx( tx )
 152         return h
 153
 154     def createmultisig(self, num, pubkeys):
 155         assert isinstance(pubkeys, list)
 156         redeem_script = Transaction.multisig_script(pubkeys, num)
 157         address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
 158         return {'address':address, 'redeemScript':redeem_script}
 159
 160     def freeze(self,addr):
 161         return self.wallet.freeze(addr)
 162
 163     def unfreeze(self,addr):
 164         return self.wallet.unfreeze(addr)
 165
 166     def prioritize(self, addr):
 167         return self.wallet.prioritize(addr)
 168
 169     def unprioritize(self, addr):
 170         return self.wallet.unprioritize(addr)
 171
 172     def dumpprivkey(self, addr):
 173         return self.wallet.get_private_key(addr, self.password)
 174
 175     def dumpprivkeys(self, addresses = None):
 176         if addresses is None:
 177             addresses = self.wallet.addresses(True)
 178         return [self.wallet.get_private_key(address, self.password) for address in addresses]
 179
 180     def validateaddress(self,addr):
 181         isvalid = is_valid(addr)
 182         out = { 'isvalid':isvalid }
 183         if isvalid:
 184             is_mine = self.wallet.is_mine(addr)
 185             out['address'] = addr
 186             out['ismine'] = is_mine
 187             if is_mine:
 188                 account, sequence = self.wallet.get_address_index(addr)
 189                 if account != -1:
 190                     out['pubkey'] = self.wallet.get_public_key(addr)
 191         return out
 192
 193     def getbalance(self, account= None):
 194         if account is None:
 195             c, u = self.wallet.get_balance()
 196         else:
 197             c, u = self.wallet.get_account_balance(account)
 198
 199         out = { "confirmed": str(Decimal(c)/100000000) }
 200         if u: out["unconfirmed"] = str(Decimal(u)/100000000)
 201         return out
 202
 203     def getaddressbalance(self, addr):
 204         c, u = self.wallet.get_addr_balance(addr)
 205         out = { "confirmed": str(Decimal(c)/100000000) }
 206         if u: out["unconfirmed"] = str(Decimal(u)/100000000)
 207         return out
 208
 209     def getservers(self):
 210         return self.network.get_servers()
 211
 212     def getseed(self):
 213         import mnemonic
 214         seed = self.wallet.decode_seed(self.password)
 215         return { "hex":seed, "mnemonic": ' '.join(mnemonic.mn_encode(seed)) }
 216
 217     def importprivkey(self, sec):
 218         try:
 219             addr = self.wallet.import_key(sec,self.password)
 220             out = "Keypair imported: ", addr
 221         except BaseException as e:
 222             out = "Error: Keypair import failed: " + str(e)
 223         return out
 224
 225
 226     def signmessage(self, address, message):
 227         return self.wallet.sign_message(address, message, self.password)
 228
 229
 230     def verifymessage(self, address, signature, message):
 231         return self.wallet.verify_message(address, signature, message)
 232
 233
 234     def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
 235
 236         for to_address, amount in outputs:
 237             if not is_valid(to_address):
 238                 raise BaseException("Invalid Bitcoin address", to_address)
 239
 240         if change_addr:
 241             if not is_valid(change_addr):
 242                 raise BaseException("Invalid Bitcoin address", change_addr)
 243
 244         if domain is not None:
 245             for addr in domain:
 246                 if not is_valid(addr):
 247                     raise BaseException("invalid Bitcoin address", addr)
 248
 249                 if not self.wallet.is_mine(addr):
 250                     raise BaseException("address not in wallet", addr)
 251
 252         for k, v in self.wallet.labels.items():
 253             if change_addr and v == change_addr:
 254                 change_addr = k
 255
 256         final_outputs = []
 257         for to_address, amount in outputs:
 258             for k, v in self.wallet.labels.items():
 259                 if v == to_address:
 260                     to_address = k
 261                     print_msg("alias", to_address)
 262                     break
 263
 264             amount = int(100000000*amount)
 265             final_outputs.append((to_address, amount))
 266
 267         if fee: fee = int(100000000*fee)
 268         return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
 269
 270
 271     def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
 272         tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
 273         return tx
 274
 275     def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
 276         tx = self._mktx(outputs, fee, change_addr, domain)
 277         return tx
 278
 279
 280     def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
 281         tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
 282         r, h = self.wallet.sendtx( tx )
 283         return h
 284
 285     def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
 286         tx = self._mktx(outputs, fee, change_addr, domain)
 287         r, h = self.wallet.sendtx( tx )
 288         return h
 289
 290
 291     def history(self):
 292         import datetime
 293         balance = 0
 294         out = []
 295         for item in self.wallet.get_tx_history():
 296             tx_hash, conf, is_mine, value, fee, balance, timestamp = item
 297             try:
 298                 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
 299             except:
 300                 time_str = "----"
 301
 302             label, is_default_label = self.wallet.get_label(tx_hash)
 303             if not label: label = tx_hash
 304             else: label = label + ' '*(64 - len(label) )
 305
 306             out.append( "%16s"%time_str + "  " + label + "  " + format_satoshis(value)+ "  "+ format_satoshis(balance) )
 307         return out
 308
 309
 310
 311     def setlabel(self, key, label):
 312         self.wallet.set_label(key, label)
 313
 314
 315
 316     def contacts(self):
 317         c = {}
 318         for addr in self.wallet.addressbook:
 319             c[addr] = self.wallet.labels.get(addr)
 320         return c
 321
 322
 323     def listaddresses(self, show_all = False, show_balance = False, show_label = False):
 324         out = []
 325         for addr in self.wallet.addresses(True):
 326             if show_all or not self.wallet.is_change(addr):
 327                 if show_balance or show_label:
 328                     item = { 'address': addr }
 329                     if show_balance:
 330                         item['balance'] = str(Decimal(self.wallet.get_addr_balance(addr)[0])/100000000)
 331                     if show_label:
 332                         label = self.wallet.labels.get(addr,'')
 333                         if label:
 334                             item['label'] = label
 335                 else:
 336                     item = addr
 337                 out.append( item )
 338         return out
 339
 340     def help(self, cmd2=None):
 341         if cmd2 not in known_commands:
 342             print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
 343         else:
 344             _, _, description, syntax, options_syntax = known_commands[cmd2]
 345             print_msg(description)
 346             if syntax: print_msg("Syntax: " + syntax)
 347             if options_syntax: print_msg("options:\n" + options_syntax)
 348         return None
 349
 350     def getrawtransaction(self, tx_hash, height = 0):
 351         tx = self.wallet.transactions.get(tx_hash)
 352         if tx:
 353             return tx
 354         height = int(height)
 355         return self.network.retrieve_transaction(tx_hash, height)
 356
 357