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