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, time, ast
  21 import optparse
  22 import platform
  23
  24 try:
  25     import ecdsa
  26 except ImportError:
  27     sys.exit("Error: python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'")
  28
  29 try:
  30     import aes
  31 except ImportError:
  32     sys.exit("Error: AES does not seem to be installed. Try 'sudo pip install slowaes'")
  33
  34 try:
  35     from lib import *
  36 except ImportError:
  37     from electrum import *
  38
  39 from decimal import Decimal
  40
  41
  42
  43 # get password routine
  44 def prompt_password(prompt, confirm=True):
  45     import getpass
  46     if sys.stdin.isatty():
  47         password = getpass.getpass(prompt)
  48         if password and confirm:
  49             password2 = getpass.getpass("Confirm: ")
  50             if password != password2:
  51                 sys.exit("Error: Passwords do not match.")
  52     else:
  53         password = raw_input(prompt)
  54     if not password:
  55         password = None
  56     return password
  57
  58 def arg_parser():
  59     usage = "usage: %prog [options] command\nCommands: "+ (', '.join(known_commands))
  60     parser = optparse.OptionParser(prog=usage)
  61     parser.add_option("-g", "--gui", dest="gui", help="User interface: qt, lite, gtk or text")
  62     parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
  63     parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
  64     parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
  65     parser.add_option("-b", "--balance", action="store_true", dest="show_balance", default=False, help="show the balance at listed addresses")
  66     parser.add_option("-f", "--fee", dest="tx_fee", default="0.005", help="set tx fee")
  67     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.")
  68     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")
  69     parser.add_option("-s", "--server", dest="server", default=None, help="set server host:port:protocol, where protocol is t or h")
  70     parser.add_option("-p", "--proxy", dest="proxy", default=None, help="set proxy [type:]host[:port], where type is socks4,socks5 or http")
  71     parser.add_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="show debugging information")
  72     parser.add_option("-P", "--portable", action="store_true", dest="portable", default=False, help="portable wallet")
  73     parser.add_option("-L", "--lang", dest="language", default=None, help="defaut language used in GUI")
  74     parser.add_option("-u", "--usb", dest="bitkey", action="store_true", help="Turn on support for hardware wallets (EXPERIMENTAL)")
  75     return parser
  76
  77
  78 if __name__ == '__main__':
  79
  80     parser = arg_parser()
  81     options, args = parser.parse_args()
  82     set_verbosity(options.verbose)
  83
  84     # config is an object passed to the various constructors (wallet, interface, gui)
  85     if 'ANDROID_DATA' in os.environ:
  86         config_options = {'wallet_path':"/sdcard/electrum.dat", 'portable':True, 'verbose':True, 'gui':'android'}
  87     else:
  88         config_options = eval(str(options))
  89         for k, v in config_options.items():
  90             if v is None: config_options.pop(k)
  91
  92     # Wallet migration on Electrum 1.7
  93     # Todo: In time we could remove this again
  94     if platform.system() == "Windows":
  95         util.check_windows_wallet_migration()
  96
  97     config = SimpleConfig(config_options)
  98     wallet = Wallet(config)
  99
 100     if len(args)==0:
 101         url = None
 102         cmd = 'gui'
 103     elif len(args)==1 and re.match('^bitcoin:', args[0]):
 104         url = args[0]
 105         cmd = 'gui'
 106     else:
 107         cmd = args[0]
 108         firstarg = args[1] if len(args) > 1 else ''
 109
 110     #this entire if/else block is just concerned with importing the
 111     #right GUI toolkit based the GUI command line option given
 112     if cmd == 'gui':
 113         pref_gui = config.get('gui','classic')
 114
 115         if pref_gui == 'gtk':
 116             try:
 117                 import lib.gui as gui
 118             except ImportError:
 119                 import electrum.gui as gui
 120         elif pref_gui in ['classic', 'qt']:
 121             try:
 122                 import lib.gui_qt as gui
 123             except ImportError:
 124                 import electrum.gui_qt as gui
 125         elif pref_gui == 'lite':
 126               try:
 127                   import lib.gui_lite as gui
 128               except ImportError:
 129                   import electrum.gui_lite as gui
 130         elif pref_gui == 'text':
 131               try:
 132                   import lib.gui_text as gui
 133               except ImportError:
 134                   import electrum.gui_text as gui
 135         elif pref_gui == 'android':
 136               try:
 137                   import lib.gui_android as gui
 138               except ImportError:
 139                   import electrum.gui_android as gui
 140         else:
 141             sys.exit("Error: Unknown GUI: " + pref_gui )
 142
 143
 144         interface = Interface(config, True)
 145         wallet.interface = interface
 146         interface.start()
 147         if interface.is_connected:
 148             interface.send([('server.peers.subscribe',[])])
 149
 150         set_language(config.get('language'))
 151         gui = gui.ElectrumGui(wallet, config)
 152
 153         found = config.wallet_file_exists
 154         if not found:
 155             a = gui.restore_or_create()
 156             if not a: exit()
 157             # select a server.
 158             s = gui.network_dialog()
 159
 160             if a =='create':
 161                 wallet.init_seed(None)
 162             else:
 163                 # ask for seed and gap.
 164                 sg = gui.seed_dialog()
 165                 if not sg: exit()
 166                 seed, gap = sg
 167                 if not seed: exit()
 168                 wallet.gap_limit = gap
 169                 if len(seed) == 128:
 170                     wallet.seed = ''
 171                     wallet.sequence.master_public_key = seed
 172                 else:
 173                     wallet.init_seed(str(seed))
 174
 175
 176             # generate the first addresses, in case we are offline
 177             if s is None or a == 'create':
 178                 wallet.synchronize()
 179             if a == 'create':
 180                 # display seed
 181                 gui.show_seed()
 182
 183         verifier = WalletVerifier(interface, config)
 184         wallet.set_verifier(verifier)
 185         synchronizer = WalletSynchronizer(wallet, config)
 186         synchronizer.start()
 187
 188         if not found and a == 'restore' and s is not None:
 189             try:
 190                 keep_it = gui.restore_wallet()
 191                 wallet.fill_addressbook()
 192             except:
 193                 import traceback
 194                 traceback.print_exc(file=sys.stdout)
 195                 exit()
 196
 197             if not keep_it: exit()
 198
 199         if not found:
 200             gui.password_dialog()
 201
 202         wallet.save()
 203         verifier.start()
 204         gui.main(url)
 205         wallet.save()
 206
 207         verifier.stop()
 208         synchronizer.stop()
 209         interface.stop()
 210
 211         # we use daemon threads, their termination is enforced.
 212         # this sleep command gives them time to terminate cleanly.
 213         time.sleep(0.1)
 214         sys.exit(0)
 215
 216     if cmd not in known_commands:
 217         cmd = 'help'
 218
 219     if not config.wallet_file_exists and cmd not in ['help','create','restore']:
 220         print_msg("Error: Wallet file not found.")
 221         print_msg("Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option")
 222         sys.exit(0)
 223
 224     if cmd in ['create', 'restore']:
 225         if config.wallet_file_exists:
 226             sys.exit("Error: Remove the existing wallet first!")
 227         password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
 228
 229         server = config.get('server')
 230         if not server: server = pick_random_server()
 231         w_host, w_port, w_protocol = server.split(':')
 232         host = raw_input("server (default:%s):"%w_host)
 233         port = raw_input("port (default:%s):"%w_port)
 234         protocol = raw_input("protocol [t=tcp;h=http;n=native] (default:%s):"%w_protocol)
 235         fee = raw_input("fee (default:%s):"%( str(Decimal(wallet.fee)/100000000)) )
 236         gap = raw_input("gap limit (default 5):")
 237         if host: w_host = host
 238         if port: w_port = port
 239         if protocol: w_protocol = protocol
 240         wallet.config.set_key('server', w_host + ':' + w_port + ':' +w_protocol)
 241         if fee: wallet.fee = float(fee)
 242         if gap: wallet.gap_limit = int(gap)
 243
 244         if cmd == 'restore':
 245             seed = raw_input("seed:")
 246             try:
 247                 seed.decode('hex')
 248             except:
 249                 print_error("Warning: Not hex, trying decode.")
 250                 seed = mnemonic_decode( seed.split(' ') )
 251             if not seed:
 252                 sys.exit("Error: No seed")
 253
 254             if len(seed) == 128:
 255                 wallet.seed = None
 256                 wallet.sequence.master_public_key = seed
 257             else:
 258                 wallet.seed = str(seed)
 259                 wallet.init_mpk( wallet.seed )
 260
 261             if not options.offline:
 262                 interface = Interface(config)
 263                 interface.start()
 264                 wallet.interface = interface
 265
 266                 verifier = WalletVerifier(interface, config)
 267                 wallet.set_verifier(verifier)
 268
 269                 print_msg("Recovering wallet...")
 270                 WalletSynchronizer(wallet, config).start()
 271                 wallet.update()
 272                 if wallet.is_found():
 273                     print_msg("Recovery successful")
 274                 else:
 275                     print_msg("Warning: Found no history for this wallet")
 276             else:
 277                 wallet.synchronize()
 278             wallet.fill_addressbook()
 279             wallet.save()
 280             print_msg("Wallet saved in '%s'"%wallet.config.path)
 281         else:
 282             wallet.init_seed(None)
 283             wallet.synchronize() # there is no wallet thread
 284             wallet.save()
 285             print_msg("Your wallet generation seed is: " + wallet.seed)
 286             print_msg("Please keep it in a safe place; if you lose it, you will not be able to restore your wallet.")
 287             print_msg("Equivalently, your wallet seed can be stored and recovered with the following mnemonic code:")
 288             print_msg("\""+' '.join(mnemonic_encode(wallet.seed))+"\"")
 289             print_msg("Wallet saved in '%s'"%wallet.config.path)
 290
 291         if password:
 292             wallet.update_password(wallet.seed, None, password)
 293
 294
 295     # open session
 296     if cmd not in offline_commands and not options.offline:
 297         interface = Interface(config)
 298         interface.register_callback('connected', lambda: sys.stderr.write("Connected to " + interface.connection_msg + "\n"))
 299         interface.start()
 300         wallet.interface = interface
 301         verifier = WalletVerifier(interface, config)
 302         wallet.set_verifier(verifier)
 303         synchronizer = WalletSynchronizer(wallet, config)
 304         synchronizer.start()
 305         wallet.update()
 306         wallet.save()
 307
 308
 309
 310     # important warning
 311     if cmd in ['dumpprivkey', 'dumpprivkeys']:
 312         print_msg("WARNING: ALL your private keys are secret.")
 313         print_msg("Exposing a single private key can compromise your entire wallet!")
 314         print_msg("In particular, DO NOT use 'redeem private key' services proposed by third parties.")
 315
 316     # commands needing password
 317     if cmd in protected_commands:
 318         if wallet.use_encryption:
 319             password = prompt_password('Password:', False)
 320             if not password:
 321                 print_msg("Error: Password required")
 322                 exit(1)
 323             # check password
 324             try:
 325                 seed = wallet.decode_seed(password)
 326             except:
 327                 print_msg("Error: This password does not decode this wallet.")
 328                 exit(1)
 329         else:
 330             password = None
 331             seed = wallet.seed
 332     else:
 333         password = None
 334
 335
 336     # check and format the arguments
 337     if cmd == 'importprivkey':
 338         # See if they specificed a key on the cmd line, if not prompt
 339         if len(args) == 1:
 340             args[1] = prompt_password('Enter PrivateKey (will not echo):', False)
 341
 342     elif cmd == 'signmessage':
 343         if len(args) < 3:
 344             print_msg("Error: Invalid usage of signmessage.")
 345             print_msg(known_commands[cmd])
 346             sys.exit(1)
 347         address = args[1]
 348         message = ' '.join(args[2:])
 349         if len(args) > 3:
 350             print_msg("Warning: Message was reconstructed from several arguments:", repr(message))
 351         args = [ cmd, address, message ]
 352
 353     elif cmd == 'verifymessage':
 354         try:
 355             address = args[1]
 356             signature = args[2]
 357             message = ' '.join(args[3:])
 358         except:
 359             print_msg("Error: Not all parameters were given, displaying help instead.")
 360             print_msg(known_commands[cmd])
 361             sys.exit(1)
 362         if len(args) > 4:
 363             print_msg("Warning: Message was reconstructed from several arguments:", repr(message))
 364         args = [ cmd, address, signature, message]
 365
 366     elif cmd == 'signrawtransaction':
 367         args = [ cmd, args[1], ast.literal_eval(args[2]) if len(args)>2 else [], ast.literal_eval(args[3]) if len(args)>3 else []]
 368
 369     elif cmd == 'createmultisig':
 370         args = [ cmd, int(args[1]), ast.literal_eval(args[2])]
 371
 372     elif cmd == 'createrawtransaction':
 373         args = [ cmd, ast.literal_eval(args[1]), ast.literal_eval(args[2])]
 374
 375     elif cmd=='addresses':
 376         args = [cmd, options.show_all]
 377
 378     elif cmd == 'setlabel':
 379         try:
 380             tx = args[1]
 381             label = ' '.join(args[2:])
 382         except:
 383             print_msg("Error. Syntax:  label <tx_hash> <text>")
 384             sys.exit(1)
 385         args = [ cmd, tx, label ]
 386
 387     elif cmd in ['payto', 'mktx']:
 388
 389         #is_temporary = False
 390         from_addr = None
 391         if options.from_addr:
 392             from_addr = options.from_addr
 393             if from_addr not in wallet.all_addresses():
 394                 #is_temporary = True
 395                 raise BaseException("address not in wallet")
 396
 397         try:
 398             to_address = args[1]
 399             amount = Decimal(args[2])
 400             change_addr = None
 401             label = ' '.join(args[3:])
 402             if options.tx_fee:
 403                 options.tx_fee = Decimal(options.tx_fee)
 404         except:
 405             firstarg = cmd
 406             cmd = 'help'
 407
 408         #if from_addr and is_temporary:
 409         #    if from_addr.find(":") == -1:
 410         #        keypair = from_addr + ":" + prompt_password('Private key:', False)
 411         #    else:
 412         #        keypair = from_addr
 413         #        from_addr = keypair.split(':')[0]
 414         #    if not wallet.import_key(keypair,password):
 415         #        print_msg("Error: Invalid key pair")
 416         #        exit(1)
 417         #    wallet.history[from_addr] = interface.retrieve_history(from_addr)
 418         #    wallet.update_tx_history()
 419         #    change_addr = from_addr
 420
 421         if options.change_addr:
 422             change_addr = options.change_addr
 423
 424         args = [ 'mktx', to_address, amount, options.tx_fee, options.change_addr, from_addr ]
 425
 426         #if is_temporary:
 427         #    wallet.imported_keys.pop(from_addr)
 428         #    del(wallet.history[from_addr])
 429         #wallet.save()
 430
 431
 432
 433     # run the command
 434     if cmd == 'help':
 435         cmd2 = firstarg
 436         if cmd2 not in known_commands:
 437             parser.print_help()
 438             print_msg("Type 'electrum help <command>' to see the help for a specific command")
 439             print_msg("Type 'electrum --help' to see the list of options")
 440             print_msg("List of commands:", ', '.join(known_commands))
 441         else:
 442             print_msg(known_commands[cmd2])
 443
 444     elif cmd == 'deseed':
 445         if not wallet.seed:
 446             print_msg("Error: This wallet has no seed")
 447         else:
 448             ns = wallet.config.path + '.seedless'
 449             print_msg("Warning: you are going to create a seedless wallet'\nIt will be saved in '%s'"%ns)
 450             if raw_input("Are you sure you want to continue? (y/n) ") in ['y','Y','yes']:
 451                 wallet.config.path = ns
 452                 wallet.seed = ''
 453                 wallet.use_encryption = False
 454                 wallet.config.set_key('seed','', True)
 455                 for k in wallet.imported_keys.keys(): wallet.imported_keys[k] = ''
 456                 wallet.save()
 457                 print_msg("Done.")
 458             else:
 459                 print_msg("Action canceled.")
 460
 461     elif cmd == 'eval':
 462         print_msg(eval(args[1]))
 463         wallet.save()
 464
 465     elif cmd == 'get':
 466         key = args[1]
 467         print_msg(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_msg(True)
 474         else:
 475             print_msg(False)
 476
 477
 478     elif cmd == 'password':
 479         new_password = prompt_password('New password:')
 480         wallet.update_password(seed, password, new_password)
 481
 482
 483
 484     else:
 485         cmd_runner = Commands(wallet, interface)
 486         func = eval('cmd_runner.' + cmd)
 487         cmd_runner.password = password
 488         result = func(*args[1:])
 489         if type(result) == str:
 490             util.print_msg(result)
 491         else:
 492             util.print_json(result)
 493
 494
 495
 496     if cmd not in offline_commands and not options.offline:
 497         verifier.stop()
 498         synchronizer.stop()
 499         interface.stop()
 500         time.sleep(0.1)
 501         sys.exit(0)