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