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