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