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