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