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