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