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 import time
  20 from util import *
  21 from bitcoin import *
  22 from decimal import Decimal
  23 import bitcoin
  24 from transaction import Transaction
  25
  26 class Command:
  27     def __init__(self, name, min_args, max_args, requires_network, requires_wallet, requires_password, description, syntax = '', options_syntax = ''):
  28         self.name = name
  29         self.min_args=min_args
  30         self.max_args = max_args
  31         self.requires_network = requires_network
  32         self.requires_wallet = requires_wallet
  33         self.requires_password = requires_password
  34         self.description = description
  35         self.syntax = syntax
  36         self.options = options_syntax
  37
  38 known_commands = {}
  39 def register_command(*args):
  40     global known_commands
  41     name = args[0]
  42     known_commands[name] = Command(*args)
  43
  44
  45
  46 payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -F: send from address -\n --changeaddr, -c: send change to address'
  47 listaddr_options = " -a: show all addresses, including change addresses\n -l: include labels in results"
  48 restore_options = " accepts a seed or master public key."
  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('getprivatekeys',       1, 1, False, True,  True,  'Get the private keys of a given address', 'getprivatekeys <bitcoin address>')
  67 register_command('dumpprivkeys',         0, 0, False, True,  True,  'Dump all private keys in your wallet')
  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('getversion',           0, 0, False, False, False, 'Return the version of your client', 'getversion')
  72 register_command('getaddressbalance',    1, 1, True,  False, False, 'Return the balance of an address', 'getaddressbalance <address>')
  73 register_command('getaddresshistory',    1, 1, True,  False, False, 'Return the transaction history of a wallet address', 'getaddresshistory <address>')
  74 register_command('getconfig',            1, 1, False, False, False, 'Return a configuration variable', 'getconfig <name>')
  75 register_command('getpubkeys',           1, 1, False, True,  False, 'Return the public keys for a wallet address', 'getpubkeys <bitcoin address>')
  76 register_command('getrawtransaction',    1, 1, True,  False, False, 'Retrieve a transaction', 'getrawtransaction <txhash>')
  77 register_command('getseed',              0, 0, False, True,  True,  'Print the generation seed of your wallet.')
  78 register_command('getmpk',               0, 0, False, True,  False, 'Return your wallet\'s master public key', 'getmpk')
  79 register_command('help',                 0, 1, False, False, False, 'Prints this help')
  80 register_command('history',              0, 0, True,  True,  False, 'Returns the transaction history of your wallet')
  81 register_command('importprivkey',        1, 1, False, True,  True,  'Import a private key', 'importprivkey <privatekey>')
  82 register_command('listaddresses',        2, 2, False, True,  False, 'Returns your list of addresses.', '', listaddr_options)
  83 register_command('listunspent',          0, 0, True,  True,  False, 'Returns the list of unspent inputs in your wallet.')
  84 register_command('getaddressunspent',    1, 1, True,  False, False, 'Returns the list of unspent inputs for an address.')
  85 register_command('mktx',                 5, 5, False, True,  True,  'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
  86 register_command('mksendmanytx',         4, 4, False, True,  True,  'Create a signed transaction', mksendmany_syntax, payto_options)
  87 register_command('payto',                5, 5, True,  True,  True,  'Create and broadcast a transaction.', payto_syntax, payto_options)
  88 register_command('paytomany',            4, 4, True,  True,  True,  'Create and broadcast a transaction.', paytomany_syntax, payto_options)
  89 register_command('password',             0, 0, False, True,  True,  'Change your password')
  90 register_command('restore',              0, 0, True,  True,  False, 'Restore a wallet', '', restore_options)
  91 register_command('setconfig',            2, 2, False, False, False, 'Set a configuration variable', 'setconfig <name> <value>')
  92 register_command('setlabel',             2,-1, False, True,  False, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
  93 register_command('sendrawtransaction',   1, 1, True,  False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
  94 register_command('signrawtransaction',   1, 3, False, True,  True,  'similar to bitcoind\'s command')
  95 register_command('signmessage',          2,-1, False, True,  True,  'Sign a message with a key', signmessage_syntax)
  96 register_command('unfreeze',             1, 1, False, True,  False, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
  97 register_command('validateaddress',      1, 1, False, False, False, 'Check that the address is valid', 'validateaddress <address>')
  98 register_command('verifymessage',        3,-1, False, False, False, 'Verifies a signature', verifymessage_syntax)
  99
 100 register_command('encrypt',              2,-1, False, False, False, 'encrypt a message with pubkey','encrypt <pubkey> <message>')
 101 register_command('decrypt',              2,-1, False, True, True,   'decrypt a message encrypted with pubkey','decrypt <pubkey> <message>')
 102 register_command('daemon',               1, 1, True, False, False,  '<stop|status>')
 103 register_command('getproof',             1, 1, True, False, False, 'get merkle proof', 'getproof <address>')
 104 register_command('getutxoaddress',       2, 2, True, False, False, 'get the address of an unspent transaction output','getutxoaddress <txid> <pos>')
 105 register_command('sweep',                2, 3, True, False, False, 'Sweep a private key.', 'sweep privkey addr [fee]')
 106
 107
 108
 109
 110 class Commands:
 111
 112     def __init__(self, wallet, network, callback = None):
 113         self.wallet = wallet
 114         self.network = network
 115         self._callback = callback
 116         self.password = None
 117
 118
 119     def _run(self, method, args, password_getter):
 120         cmd = known_commands[method]
 121         if cmd.requires_password and self.wallet.use_encryption:
 122             self.password = apply(password_getter,())
 123         f = getattr(self, method)
 124         result = f(*args)
 125         self.password = None
 126         if self._callback:
 127             apply(self._callback, ())
 128         return result
 129
 130
 131     def getaddresshistory(self, addr):
 132         return self.network.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
 133
 134
 135     def daemon(self, arg):
 136         if arg=='stop':
 137             return self.network.stop()
 138         elif arg=='status':
 139             return {
 140                 'server':self.network.main_server(),
 141                 'connected':self.network.is_connected()
 142             }
 143         else:
 144             return "unknown command \"%s\""% arg
 145
 146
 147     def listunspent(self):
 148         import copy
 149         l = copy.deepcopy(self.wallet.get_unspent_coins())
 150         for i in l: i["value"] = str(Decimal(i["value"])/100000000)
 151         return l
 152
 153
 154     def getaddressunspent(self, addr):
 155         return self.network.synchronous_get([ ('blockchain.address.listunspent',[addr]) ])[0]
 156
 157
 158     def getutxoaddress(self, txid, num):
 159         r = self.network.synchronous_get([ ('blockchain.utxo.get_address',[txid, num]) ])
 160         if r:
 161             return {'address':r[0] }
 162
 163
 164     def createrawtransaction(self, inputs, outputs):
 165         for i in inputs:
 166             i['prevout_hash'] = i['txid']
 167             i['prevout_n'] = i['vout']
 168         outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
 169         tx = Transaction.from_io(inputs, outputs)
 170         return tx
 171
 172
 173     def signrawtransaction(self, raw_tx, input_info, private_keys):
 174         tx = Transaction(raw_tx)
 175         self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
 176         return tx
 177
 178     def decoderawtransaction(self, raw):
 179         tx = Transaction(raw)
 180         return tx.deserialize()
 181
 182     def sendrawtransaction(self, raw):
 183         tx = Transaction(raw)
 184         return self.network.synchronous_get([('blockchain.transaction.broadcast', [str(tx)])])[0]
 185
 186     def createmultisig(self, num, pubkeys):
 187         assert isinstance(pubkeys, list)
 188         redeem_script = Transaction.multisig_script(pubkeys, num)
 189         address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
 190         return {'address':address, 'redeemScript':redeem_script}
 191
 192     def freeze(self,addr):
 193         return self.wallet.freeze(addr)
 194
 195     def unfreeze(self,addr):
 196         return self.wallet.unfreeze(addr)
 197
 198     def getprivatekeys(self, addr):
 199         return self.wallet.get_private_key(addr, self.password)
 200
 201     def dumpprivkeys(self, addresses = None):
 202         if addresses is None:
 203             addresses = self.wallet.addresses(True)
 204         return [self.wallet.get_private_key(address, self.password) for address in addresses]
 205
 206     def validateaddress(self, addr):
 207         isvalid = is_valid(addr)
 208         out = { 'isvalid':isvalid }
 209         if isvalid:
 210             out['address'] = addr
 211         return out
 212
 213     def getpubkeys(self, addr):
 214         out = { 'address':addr }
 215         out['pubkeys'] = self.wallet.getpubkeys(addr)
 216         return out
 217
 218
 219     def getbalance(self, account= None):
 220         if account is None:
 221             c, u = self.wallet.get_balance()
 222         else:
 223             c, u = self.wallet.get_account_balance(account)
 224
 225         out = { "confirmed": str(Decimal(c)/100000000) }
 226         if u: out["unconfirmed"] = str(Decimal(u)/100000000)
 227         return out
 228
 229     def getaddressbalance(self, addr):
 230         out = self.network.synchronous_get([ ('blockchain.address.get_balance',[addr]) ])[0]
 231         out["confirmed"] =  str(Decimal(out["confirmed"])/100000000)
 232         out["unconfirmed"] =  str(Decimal(out["unconfirmed"])/100000000)
 233         return out
 234
 235
 236     def getproof(self, addr):
 237         p = self.network.synchronous_get([ ('blockchain.address.get_proof',[addr]) ])[0]
 238         out = []
 239         for i,s in p:
 240             out.append(i)
 241         return out
 242
 243     def getservers(self):
 244         while not self.network.is_up_to_date():
 245             time.sleep(0.1)
 246         return self.network.get_servers()
 247
 248     def getversion(self):
 249         import electrum
 250         return electrum.ELECTRUM_VERSION
 251
 252     def getmpk(self):
 253         return self.wallet.get_master_public_key()
 254
 255     def getseed(self):
 256         mnemonic = self.wallet.get_mnemonic(self.password)
 257         return { 'mnemonic':mnemonic, 'version':self.wallet.seed_version }
 258
 259     def importprivkey(self, sec):
 260         try:
 261             addr = self.wallet.import_key(sec,self.password)
 262             out = "Keypair imported: ", addr
 263         except Exception as e:
 264             out = "Error: Keypair import failed: " + str(e)
 265         return out
 266
 267
 268     def sweep(self, privkey, to_address, fee = 0.0001):
 269         fee = int(Decimal(fee)*100000000)
 270         return Transaction.sweep([privkey], self.network, to_address, fee)
 271
 272
 273     def signmessage(self, address, message):
 274         return self.wallet.sign_message(address, message, self.password)
 275
 276
 277     def verifymessage(self, address, signature, message):
 278         return bitcoin.verify_message(address, signature, message)
 279
 280
 281     def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
 282
 283         for to_address, amount in outputs:
 284             if not is_valid(to_address):
 285                 raise Exception("Invalid Bitcoin address", to_address)
 286
 287         if change_addr:
 288             if not is_valid(change_addr):
 289                 raise Exception("Invalid Bitcoin address", change_addr)
 290
 291         if domain is not None:
 292             for addr in domain:
 293                 if not is_valid(addr):
 294                     raise Exception("invalid Bitcoin address", addr)
 295
 296                 if not self.wallet.is_mine(addr):
 297                     raise Exception("address not in wallet", addr)
 298
 299         for k, v in self.wallet.labels.items():
 300             if change_addr and v == change_addr:
 301                 change_addr = k
 302
 303         final_outputs = []
 304         for to_address, amount in outputs:
 305             for k, v in self.wallet.labels.items():
 306                 if v == to_address:
 307                     to_address = k
 308                     print_msg("alias", to_address)
 309                     break
 310
 311             amount = int(100000000*amount)
 312             final_outputs.append((to_address, amount))
 313
 314         if fee: fee = int(100000000*fee)
 315         return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
 316
 317
 318     def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
 319         tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
 320         return tx
 321
 322     def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
 323         tx = self._mktx(outputs, fee, change_addr, domain)
 324         return tx
 325
 326
 327     def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
 328         tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
 329         r, h = self.wallet.sendtx( tx )
 330         return h
 331
 332     def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
 333         tx = self._mktx(outputs, fee, change_addr, domain)
 334         r, h = self.wallet.sendtx( tx )
 335         return h
 336
 337
 338     def history(self):
 339         import datetime
 340         balance = 0
 341         out = []
 342         for item in self.wallet.get_tx_history():
 343             tx_hash, conf, is_mine, value, fee, balance, timestamp = item
 344             try:
 345                 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
 346             except Exception:
 347                 time_str = "----"
 348
 349             label, is_default_label = self.wallet.get_label(tx_hash)
 350
 351             out.append({'txid':tx_hash, 'date':"%16s"%time_str, 'label':label, 'value':format_satoshis(value)})
 352         return out
 353
 354
 355
 356     def setlabel(self, key, label):
 357         self.wallet.set_label(key, label)
 358
 359
 360
 361     def contacts(self):
 362         c = {}
 363         for addr in self.wallet.addressbook:
 364             c[addr] = self.wallet.labels.get(addr)
 365         return c
 366
 367
 368     def listaddresses(self, show_all = False, show_label = False):
 369         out = []
 370         for addr in self.wallet.addresses(True):
 371             if show_all or not self.wallet.is_change(addr):
 372                 if show_label:
 373                     item = { 'address': addr }
 374                     if show_label:
 375                         label = self.wallet.labels.get(addr,'')
 376                         if label:
 377                             item['label'] = label
 378                 else:
 379                     item = addr
 380                 out.append( item )
 381         return out
 382
 383     def help(self, cmd=None):
 384         if cmd not in known_commands:
 385             print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
 386         else:
 387             cmd = known_commands[cmd]
 388             print_msg(cmd.description)
 389             if cmd.syntax: print_msg("Syntax: " + cmd.syntax)
 390             if cmd.options: print_msg("options:\n" + cmd.options)
 391         return None
 392
 393
 394     def getrawtransaction(self, tx_hash):
 395         import transaction
 396         if self.wallet:
 397             tx = self.wallet.transactions.get(tx_hash)
 398             if tx:
 399                 return tx
 400
 401         r = self.network.synchronous_get([ ('blockchain.transaction.get',[tx_hash]) ])[0]
 402         if r:
 403             return transaction.Transaction(r)
 404         else:
 405             return "unknown transaction"
 406
 407
 408     def encrypt(self, pubkey, message):
 409         return bitcoin.encrypt_message(message, pubkey)
 410
 411
 412     def decrypt(self, pubkey, message):
 413         return self.wallet.decrypt_message(pubkey, message, self.password)
 414
 415
 416