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