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