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