electrum

   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 re, sys
  20 from lib.util import print_error
  21
  22 try:
  23     import ecdsa
  24 except:
  25     print_error("Error: python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'")
  26     sys.exit(1)
  27
  28 try:
  29     import aes
  30 except:
  31     print_error("Error: AES does not seem to be installed. Try 'sudo pip install slowaes'")
  32     sys.exit(1)
  33
  34 try:
  35     from lib import Wallet, WalletSynchronizer, format_satoshis, mnemonic, prompt_password
  36 except ImportError:
  37     from electrum import Wallet, WalletSynchronizer, format_satoshis, mnemonic, prompt_password
  38
  39 from optparse import OptionParser
  40 from decimal import Decimal
  41
  42 known_commands = {
  43     'help':'Prints this help',
  44     'validateaddress':'Check that the address is valid',
  45     'balance': "Display the balance of your wallet or of an address.\nSyntax: balance [<address>]",
  46     'contacts': "Show your list of contacts",
  47     'create':'Create a wallet',
  48     'restore':'Restore a wallet',
  49     'payto':"""Create and broadcast a transaction.
  50 Syntax: payto <recipient> <amount> [label]
  51 <recipient> can be a bitcoin address or a label
  52 options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
  53             """,
  54     'sendtx':
  55             'Broadcasts a transaction to the network. \nSyntax: sendtx <tx>\n<tx> must be in hexadecimal.',
  56     'password':
  57             "Changes your password",
  58     'addresses':
  59             """Shows your list of addresses.
  60 options:
  61   -a: show all addresses, including change addresses
  62   -k: show private keys
  63   -b: show the balance of addresses""",
  64
  65     'history':"Shows the transaction history",
  66     'label':'Assign a label to an item\nSyntax: label <tx_hash> <label>',
  67     'mktx':
  68         """Create a signed transaction, password protected.
  69 Syntax: mktx <recipient> <amount> [label]
  70 options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
  71         """,
  72     'seed':
  73             "Print the generation seed of your wallet.",
  74     'import':
  75             'Imports a key pair\nSyntax: import <address>:<privatekey>',
  76     'signmessage':
  77             'Signs a message with a key\nSyntax: signmessage <address> <message>',
  78     'verifymessage':
  79              'Verifies a signature\nSyntax: verifymessage <address> <signature> <message>',
  80     'eval':
  81              "Run python eval() on an object\nSyntax: eval <expression>\nExample: eval \"wallet.aliases\"",
  82     'deseed':
  83             "Remove seed from the wallet. The seed is stored in a file that has the name of the wallet plus '.seed'",
  84     'reseed':
  85             "Restore seed of the wallet. The wallet must have no seed, and the seed must match the wallet's master public key.",
  86     'freeze':'',
  87     'unfreeze':'',
  88     'prioritize':'',
  89     'unprioritize':'',
  90     }
  91
  92
  93
  94 offline_commands = [ 'password', 'mktx', 'label', 'contacts', 'help', 'validateaddress', 'signmessage', 'verifymessage', 'eval', 'create', 'addresses', 'import', 'seed','deseed','reseed','freeze','unfreeze','prioritize','unprioritize']
  95
  96 protected_commands = ['payto', 'password', 'mktx', 'seed', 'import','signmessage' ]
  97
  98 if __name__ == '__main__':
  99
 100     usage = "usage: %prog [options] command\nCommands: "+ (', '.join(known_commands))
 101     parser = OptionParser(usage=usage)
 102     parser.add_option("-g", "--gui", dest="gui", default="lite", help="gui")
 103     parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
 104     parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
 105     parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
 106     parser.add_option("-b", "--balance", action="store_true", dest="show_balance", default=False, help="show the balance at listed addresses")
 107     parser.add_option("-k", "--keys",action="store_true", dest="show_keys",default=False, help="show the private keys of listed addresses")
 108     parser.add_option("-f", "--fee", dest="tx_fee", default="0.005", help="set tx fee")
 109     parser.add_option("-s", "--fromaddr", dest="from_addr", default=None, help="set source address for payto/mktx. if it isn't in the wallet, it will ask for the private key unless supplied in the format public_key:private_key. It's not saved in the wallet.")
 110     parser.add_option("-c", "--changeaddr", dest="change_addr", default=None, help="set the change address for payto/mktx. default is a spare address, or the source address if it's not in the wallet")
 111     parser.add_option("-r", "--remote", dest="remote_url", default=None, help="URL of a remote wallet")
 112     options, args = parser.parse_args()
 113
 114     wallet = Wallet()
 115     wallet.set_path(options.wallet_path)
 116     wallet.read()
 117     wallet.remote_url = options.remote_url
 118
 119     if len(args)==0:
 120         url = None
 121         cmd = 'gui'
 122     elif len(args)==1 and re.match('^bitcoin:', args[0]):
 123         url = args[0]
 124         cmd = 'gui'
 125     else:
 126         cmd = args[0]
 127         firstarg = args[1] if len(args) > 1 else ''
 128
 129     if cmd == 'gui':
 130         if options.gui=='gtk':
 131             try:
 132                 import lib.gui as gui
 133             except ImportError:
 134                 import electrum.gui as gui
 135         elif options.gui=='qt':
 136             try:
 137                 import lib.gui_qt as gui
 138             except ImportError:
 139                 import electrum.gui_qt as gui
 140         elif options.gui == 'lite':
 141             try:
 142                 import lib.gui_lite as gui
 143             except ImportError:
 144                 import electrum.gui_lite as gui
 145         else:
 146             print_error("Error: Unknown GUI: " + options.gui)
 147             exit(1)
 148
 149         gui = gui.ElectrumGui(wallet)
 150         WalletSynchronizer(wallet,True).start()
 151
 152         try:
 153             found = wallet.file_exists
 154             if not found:
 155                 found = gui.restore_or_create()
 156         except SystemExit, e:
 157             exit(e)
 158         except BaseException, e:
 159             import traceback
 160             traceback.print_exc(file=sys.stdout)
 161             #gui.show_message(e.message)
 162             exit(1)
 163
 164         if not found:
 165             exit(1)
 166         gui.main(url)
 167         wallet.save()
 168         sys.exit(0)
 169
 170     if cmd not in known_commands:
 171         cmd = 'help'
 172
 173     if not wallet.file_exists and cmd not in ['help','create','restore']:
 174         print_error("Error: Wallet file not found.")
 175         print_error("Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option")
 176         sys.exit(0)
 177
 178     if cmd in ['create', 'restore']:
 179         if wallet.file_exists:
 180             print_error("Error: Remove the existing wallet first!")
 181             sys.stderr.flush()
 182             sys.exit(0)
 183         password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
 184
 185         w_host, w_port, w_protocol = wallet.server.split(':')
 186         host = raw_input("server (default:%s):"%w_host)
 187         port = raw_input("port (default:%s):"%w_port)
 188         protocol = raw_input("protocol [t=tcp;h=http;n=native] (default:%s):"%w_protocol)
 189         fee = raw_input("fee (default:%s):"%( str(Decimal(wallet.fee)/100000000)) )
 190         gap = raw_input("gap limit (default 5):")
 191         if host: w_host = host
 192         if port: w_port = port
 193         if protocol: w_protocol = protocol
 194         wallet.server = w_host + ':' + w_port + ':' +w_protocol
 195         if fee: wallet.fee = float(fee)
 196         if gap: wallet.gap_limit = int(gap)
 197
 198         if cmd == 'restore':
 199             seed = raw_input("seed:")
 200             try:
 201                 seed.decode('hex')
 202             except:
 203                 print_error("Warning: Not hex, trying decode.")
 204                 seed = mnemonic.mn_decode( seed.split(' ') )
 205             if not seed:
 206                 print_error("Error: No seed")
 207                 sys.exit(1)
 208
 209             wallet.seed = str(seed)
 210             wallet.init_mpk( wallet.seed )
 211             if not options.offline:
 212                 WalletSynchronizer(wallet).start()
 213                 print "Recovering wallet..."
 214                 wallet.up_to_date_event.clear()
 215                 wallet.up_to_date = False
 216                 wallet.update()
 217                 if wallet.is_found():
 218                     print "Recovery successful"
 219                 else:
 220                     print_error("Warning: Found no history for this wallet")
 221             wallet.fill_addressbook()
 222             wallet.save()
 223             print_error("Wallet saved in '" + wallet.path)
 224         else:
 225             wallet.new_seed(None)
 226             wallet.init_mpk( wallet.seed )
 227             wallet.synchronize() # there is no wallet thread
 228             wallet.save()
 229             print "Your wallet generation seed is: " + wallet.seed
 230             print "Please keep it in a safe place; if you lose it, you will not be able to restore your wallet."
 231             print "Equivalently, your wallet seed can be stored and recovered with the following mnemonic code:"
 232             print "\""+' '.join(mnemonic.mn_encode(wallet.seed))+"\""
 233             print "Wallet saved in '%s'"%wallet.path
 234
 235         if password:
 236             wallet.update_password(wallet.seed, None, password)
 237
 238     # check syntax
 239     if cmd in ['payto', 'mktx']:
 240         try:
 241             to_address = args[1]
 242             amount = int( 100000000 * Decimal(args[2]) )
 243             change_addr = None
 244             label = ' '.join(args[3:])
 245             if options.tx_fee:
 246                 options.tx_fee = int( 100000000 * Decimal(options.tx_fee) )
 247         except:
 248             firstarg = cmd
 249             cmd = 'help'
 250
 251     # open session
 252     if cmd not in offline_commands and not options.offline:
 253         WalletSynchronizer(wallet).start()
 254         wallet.update()
 255         wallet.save()
 256
 257     # check if --from_addr not in wallet (for mktx/payto)
 258     is_temporary = False
 259     from_addr = None
 260     if options.from_addr:
 261         from_addr = options.from_addr
 262         if from_addr not in wallet.all_addresses():
 263             is_temporary = True
 264
 265     # commands needing password
 266     if cmd in protected_commands or ( cmd=='addresses' and options.show_keys):
 267         password = prompt_password('Password:') if wallet.use_encryption and not is_temporary else None
 268         # check password
 269         try:
 270             wallet.pw_decode( wallet.seed, password)
 271         except:
 272             print_error("Error: This password does not decode this wallet.")
 273             exit(1)
 274
 275     if cmd == 'import':
 276         keypair = args[1]
 277         try:
 278             wallet.import_key(keypair,password)
 279             wallet.save()
 280             print "Keypair imported"
 281         except BaseException, e:
 282             print_error("Error: Keypair import failed: " + str(e))
 283
 284     if cmd=='help':
 285         cmd2 = firstarg
 286         if cmd2 not in known_commands:
 287             print_error("Error: Command not found.")
 288             print "Type 'electrum help <command>' to see the help for a specific command"
 289             print "Type 'electrum --help' to see the list of options"
 290             print "List of commands:", ', '.join(known_commands)
 291         else:
 292             print known_commands[cmd2]
 293
 294     elif cmd == 'seed':
 295         seed = wallet.pw_decode( wallet.seed, password)
 296         print seed + ' "' + ' '.join(mnemonic.mn_encode(seed)) + '"'
 297
 298     elif cmd == 'deseed':
 299         if not wallet.seed:
 300             print_error("Error: This wallet has no seed")
 301         elif wallet.use_encryption:
 302             print_error("Error: This wallet is encrypted")
 303         else:
 304             ns = wallet.path + '.seed'
 305             print "Warning: you are going to extract the seed from '%s'\nThe seed will be saved in '%s'"%(wallet.path,ns)
 306             if raw_input("Are you sure you want to continue? (y/n) ") in ['y','Y','yes']:
 307                 f = open(ns,'w')
 308                 f.write(repr({'seed':wallet.seed, 'imported_keys':wallet.imported_keys})+"\n")
 309                 f.close()
 310                 wallet.seed = ''
 311                 for k in wallet.imported_keys.keys(): wallet.imported_keys[k] = ''
 312                 wallet.save()
 313                 print "Done."
 314             else:
 315                 print_error("Action canceled.")
 316
 317     elif cmd == 'reseed':
 318         if wallet.seed:
 319             print "Warning: This wallet already has a seed", wallet.seed
 320         else:
 321             ns = wallet.path + '.seed'
 322             try:
 323                 f = open(ns,'r')
 324                 data = f.read()
 325                 f.close()
 326             except:
 327                 print_error("Error: Seed file not found")
 328                 sys.exit()
 329             try:
 330                 import ast
 331                 d = ast.literal_eval( data )
 332                 seed = d['seed']
 333                 imported_keys = d.get('imported_keys',{})
 334             except:
 335                 print_error("Error: Error with seed file")
 336                 sys.exit(1)
 337
 338             mpk = wallet.master_public_key
 339             wallet.seed = seed
 340             wallet.imported_keys = imported_keys
 341             wallet.use_encryption = False
 342             wallet.init_mpk(seed)
 343             if mpk == wallet.master_public_key:
 344                 wallet.save()
 345                 print "Done: " + wallet.path
 346             else:
 347                 print_error("Error: Master public key does not match")
 348
 349     elif cmd == 'validateaddress':
 350         addr = args[1]
 351         print wallet.is_valid(addr)
 352
 353     elif cmd == 'balance':
 354         try:
 355             addrs = args[1:]
 356         except:
 357             pass
 358         if addrs == []:
 359             c, u = wallet.get_balance()
 360             if u:
 361                 print Decimal( c ) / 100000000 , Decimal( u ) / 100000000
 362             else:
 363                 print Decimal( c ) / 100000000
 364         else:
 365             for addr in addrs:
 366                 c, u = wallet.get_addr_balance(addr)
 367                 if u:
 368                     print "%s %s, %s" % (addr, str(Decimal(c)/100000000), str(Decimal(u)/100000000))
 369                 else:
 370                     print "%s %s" % (addr, str(Decimal(c)/100000000))
 371
 372     elif cmd in [ 'contacts']:
 373         for addr in wallet.addressbook:
 374             print addr, "   ", wallet.labels.get(addr)
 375
 376     elif cmd == 'eval':
 377         print eval(args[1])
 378         wallet.save()
 379
 380     elif cmd in [ 'addresses']:
 381         for addr in wallet.all_addresses():
 382             if options.show_all or not wallet.is_change(addr):
 383
 384                 flags = wallet.get_address_flags(addr)
 385                 label = wallet.labels.get(addr,'')
 386
 387                 if label: label = "\"%s\""%label
 388
 389                 if options.show_balance:
 390                     h = wallet.history.get(addr,[])
 391                     #ni = no = 0
 392                     #for item in h:
 393                     #    if item['is_input']:  ni += 1
 394                     #    else:              no += 1
 395                     b = format_satoshis(wallet.get_addr_balance(addr)[0])
 396                 else: b=''
 397                 m_addr = "%34s"%addr
 398                 if options.show_keys:
 399                     m_addr += ':' + str(wallet.get_private_key_base58(addr, password))
 400                 print flags, m_addr, b, label
 401
 402     if cmd == 'history':
 403         lines = wallet.get_tx_history()
 404         b = 0
 405         for line in lines:
 406             import datetime
 407             v = line['value']
 408             b += v
 409             try:
 410                 time_str = str( datetime.datetime.fromtimestamp( line['timestamp']))
 411             except:
 412                 print line['timestamp']
 413                 time_str = 'pending'
 414             label = line.get('label')
 415             if not label: label = line['tx_hash']
 416             else: label = label + ' '*(64 - len(label) )
 417
 418             print time_str , "  " + label + "  " + format_satoshis(v)+ "  "+ format_satoshis(b)
 419         print "# balance: ", format_satoshis(b)
 420
 421     elif cmd == 'label':
 422         try:
 423             tx = args[1]
 424             label = ' '.join(args[2:])
 425         except:
 426             print_error("Error. Syntax:  label <tx_hash> <text>")
 427             sys.exit(1)
 428         wallet.labels[tx] = label
 429         wallet.save()
 430
 431     elif cmd in ['payto', 'mktx']:
 432         if from_addr and is_temporary:
 433             if from_addr.find(":") == -1:
 434                 keypair = from_addr + ":" + prompt_password('Private key:', False)
 435             else:
 436                 keypair = from_addr
 437                 from_addr = keypair.split(':')[0]
 438             if not wallet.import_key(keypair,password):
 439                 print_error("Error: Invalid key pair")
 440                 exit(1)
 441             wallet.history[from_addr] = interface.retrieve_history(from_addr)
 442             wallet.update_tx_history()
 443             change_addr = from_addr
 444
 445         if options.change_addr:
 446             change_addr = options.change_addr
 447
 448         for k, v in wallet.labels.items():
 449             if v == to_address:
 450                 to_address = k
 451                 print "alias", to_address
 452                 break
 453             if change_addr and v == change_addr:
 454                 change_addr = k
 455         try:
 456             tx = wallet.mktx( to_address, amount, label, password,
 457                 fee = options.tx_fee, change_addr = change_addr, from_addr = from_addr )
 458         except:
 459             import traceback
 460             traceback.print_exc(file=sys.stdout)
 461             tx = None
 462
 463         if tx and cmd=='payto':
 464             r, h = wallet.sendtx( tx )
 465             print h
 466         else:
 467             print tx
 468
 469         if is_temporary:
 470             wallet.imported_keys.pop(from_addr)
 471             del(wallet.history[from_addr])
 472         wallet.save()
 473
 474     elif cmd == 'sendtx':
 475         tx = args[1]
 476         r, h = wallet.sendtx( tx )
 477         print h
 478
 479     elif cmd == 'password':
 480         try:
 481             seed = wallet.pw_decode( wallet.seed, password)
 482         except:
 483             print_error("Error: Password does not decrypt this wallet.")
 484             sys.exit(1)
 485
 486         new_password = prompt_password('New password:')
 487         wallet.update_password(seed, password, new_password)
 488
 489     elif cmd == 'signmessage':
 490         address = args[1]
 491         message = ' '.join(args[2:])
 492         if len(args) > 3:
 493             print "Warning: Message was reconstructed from several arguments:", repr(message)
 494         print wallet.sign_message(address, message, password)
 495
 496     elif cmd == 'verifymessage':
 497         try:
 498             address = args[1]
 499             signature = args[2]
 500             message = ' '.join(args[3:])
 501         except:
 502             print_error("Error: Not all parameters were given, displaying help instead.")
 503             print known_commands[cmd]
 504             sys.exit(1)
 505         if len(args) > 4:
 506             print "Warning: Message was reconstructed from several arguments:", repr(message)
 507         try:
 508             wallet.verify_message(address, signature, message)
 509             print True
 510         except:
 511             print False
 512
 513     elif cmd == 'freeze':
 514         addr = args[1]
 515         print self.wallet.freeze(addr)
 516
 517     elif cmd == 'unfreeze':
 518         addr = args[1]
 519         print self.wallet.unfreeze(addr)
 520
 521     elif cmd == 'prioritize':
 522         addr = args[1]
 523         print self.wallet.prioritize(addr)
 524
 525     elif cmd == 'unprioritize':
 526         addr = args[1]
 527         print self.wallet.unprioritize(addr)
 528