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