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 from decimal import Decimal
  20 import json
  21 import optparse
  22 import os
  23 import re
  24 import sys
  25 import time
  26 import traceback
  27
  28 try:
  29     import ecdsa  # todo: 'ecdsa' imported but unused
  30 except ImportError:
  31     sys.exit("Error: python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'")
  32
  33 try:
  34     import aes  # todo: 'aes' imported but unused
  35 except ImportError:
  36     sys.exit("Error: AES does not seem to be installed. Try 'sudo pip install slowaes'")
  37
  38
  39 is_local = os.path.dirname(os.path.realpath(__file__)) == os.getcwd()
  40 is_android = 'ANDROID_DATA' in os.environ
  41
  42 import __builtin__
  43 __builtin__.use_local_modules = is_local or is_android
  44
  45 # load local module as electrum
  46 if __builtin__.use_local_modules:
  47     import imp
  48     imp.load_module('electrum', *imp.find_module('lib'))
  49     imp.load_module('electrum_gui', *imp.find_module('gui'))
  50
  51 from electrum import *  # todo: import * is generally frowned upon. should import just what is used
  52
  53
  54 # get password routine
  55 def prompt_password(prompt, confirm=True):
  56     import getpass
  57     if sys.stdin.isatty():
  58         password = getpass.getpass(prompt)
  59         if password and confirm:
  60             password2 = getpass.getpass("Confirm: ")
  61             if password != password2:
  62                 sys.exit("Error: Passwords do not match.")
  63     else:
  64         password = raw_input(prompt)
  65     if not password:
  66         password = None
  67     return password
  68
  69
  70 def arg_parser():
  71     usage = "%prog [options] command"
  72     parser = optparse.OptionParser(prog=usage, add_help_option=False)
  73     parser.add_option("-h", "--help", action="callback", callback=print_help_cb, help="show this help text")
  74     parser.add_option("-g", "--gui", dest="gui", help="User interface: qt, lite, gtk, text or stdio")
  75     parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
  76     parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
  77     parser.add_option("-C", "--concealed", action="store_true", dest="concealed", default=False, help="don't echo seed to console when restoring")
  78     parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
  79     parser.add_option("-l", "--labels", action="store_true", dest="show_labels", default=False, help="show the labels of listed addresses")
  80     parser.add_option("-f", "--fee", dest="tx_fee", default=None, help="set tx fee")
  81     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.")
  82     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")
  83     parser.add_option("-s", "--server", dest="server", default=None, help="set server host:port:protocol, where protocol is either t (tcp), h (http), s (tcp+ssl), or g (https)")
  84     parser.add_option("-p", "--proxy", dest="proxy", default=None, help="set proxy [type:]host[:port], where type is socks4,socks5 or http")
  85     parser.add_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="show debugging information")
  86     parser.add_option("-P", "--portable", action="store_true", dest="portable", default=False, help="portable wallet")
  87     parser.add_option("-L", "--lang", dest="language", default=None, help="defaut language used in GUI")
  88     parser.add_option("-u", "--usb", dest="bitkey", action="store_true", help="Turn on support for hardware wallets (EXPERIMENTAL)")
  89     parser.add_option("-G", "--gap", dest="gap_limit", default=None, help="gap limit")
  90     parser.add_option("-W", "--password", dest="password", default=None, help="set password for usage with commands (currently only implemented for create command, do not use it for longrunning gui session since the password is visible in /proc)")
  91     parser.add_option("-1", "--oneserver", action="store_true", dest="oneserver", default=False, help="connect to one server only")
  92     parser.add_option("--bip32", action="store_true", dest="bip32", default=False, help="bip32 (not final)")
  93     parser.add_option("--mpk", dest="mpk", default=False, help="restore from master public key")
  94     return parser
  95
  96
  97 def print_help(parser):
  98     parser.print_help()
  99     print_msg("Type 'electrum help <command>' to see the help for a specific command")
 100     print_msg("Type 'electrum --help' to see the list of options")
 101     run_command(known_commands['help'])
 102     sys.exit(1)
 103
 104
 105 def print_help_cb(self, opt, value, parser):
 106     print_help(parser)
 107
 108
 109 def run_command(cmd, password=None, args=[]):
 110     import xmlrpclib, socket
 111     cmd_runner = Commands(wallet, network)
 112     func = getattr(cmd_runner, cmd.name)
 113     cmd_runner.password = password
 114
 115     if cmd.requires_network and not options.offline:
 116         cmd_runner.network = xmlrpclib.ServerProxy('http://localhost:8000')
 117
 118         while True:
 119             try:
 120                 if cmd_runner.network.ping() == 'pong':
 121                     break
 122             except socket.error:
 123                 if cmd.name != 'daemon':
 124                     start_daemon()
 125                 else:
 126                     print "Daemon not running"
 127                     sys.exit(1)
 128
 129         if wallet:
 130             wallet.start_threads(cmd_runner.network)
 131             wallet.update()
 132     else:
 133         cmd_runner.network = None
 134
 135     try:
 136         result = func(*args[1:])
 137     except Exception:
 138         print "ecxeption"
 139         traceback.print_exc(file=sys.stdout)
 140         sys.exit(1)
 141
 142
 143     if cmd.requires_network and not options.offline:
 144         if wallet:
 145             wallet.stop_threads()
 146
 147
 148     if type(result) == str:
 149         util.print_msg(result)
 150     elif result is not None:
 151         util.print_json(result)
 152
 153
 154
 155 def start_server():
 156     network = Network(config)
 157     if not network.start(wait=True):
 158         print_msg("Not connected, aborting.")
 159         sys.exit(1)
 160     print_msg("Network daemon connected to " + network.interface.connection_msg)
 161     from SimpleXMLRPCServer import SimpleXMLRPCServer
 162     server = SimpleXMLRPCServer(('localhost',8000), allow_none=True, logRequests=False)
 163     server.network = network
 164     server.register_function(lambda: 'pong', 'ping')
 165     server.register_function(network.synchronous_get, 'synchronous_get')
 166     server.register_function(network.get_servers, 'get_servers')
 167     server.register_function(network.main_server, 'main_server')
 168     server.register_function(network.send, 'send')
 169     server.register_function(network.subscribe, 'subscribe')
 170     server.register_function(network.is_connected, 'is_connected')
 171     server.register_function(network.is_up_to_date, 'is_up_to_date')
 172     server.register_function(lambda: setattr(server,'running', False), 'stop')
 173     return server
 174
 175 def start_daemon():
 176     pid = os.fork()
 177     if (pid == 0): # The first child.
 178         os.chdir("/")
 179         os.setsid()
 180         os.umask(0)
 181         pid2 = os.fork()
 182         if (pid2 == 0):  # Second child
 183             server = start_server()
 184             server.running = True
 185             timeout = 60
 186             t0 = time.time()
 187             server.socket.settimeout(timeout)
 188             while server.running:
 189                 server.handle_request()
 190                 t = time.time()
 191                 if t - t0 > 0.9*timeout:
 192                     break
 193                 if not server.network.is_connected():
 194                     break
 195                 t0 = t
 196         sys.exit(0)
 197
 198     time.sleep(2)
 199
 200
 201 if __name__ == '__main__':
 202
 203     parser = arg_parser()
 204     options, args = parser.parse_args()
 205     if options.portable and options.wallet_path is None:
 206         options.electrum_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'electrum_data')
 207
 208     # config is an object passed to the various constructors (wallet, interface, gui)
 209     if is_android:
 210         config_options = {
 211             'portable': True,
 212             'verbose': True,
 213             'gui': 'android',
 214             'auto_cycle': True,
 215         }
 216     else:
 217         config_options = eval(str(options))
 218         for k, v in config_options.items():
 219             if v is None:
 220                 config_options.pop(k)
 221
 222     set_verbosity(config_options.get('verbose'))
 223
 224     config = SimpleConfig(config_options)
 225
 226     if len(args) == 0:
 227         url = None
 228         cmd = 'gui'
 229     elif len(args) == 1 and re.match('^bitcoin:', args[0]):
 230         url = args[0]
 231         cmd = 'gui'
 232     else:
 233         cmd = args[0]
 234
 235     if cmd == 'gui':
 236         gui_name = config.get('gui', 'classic')
 237         if gui_name in ['lite', 'classic']:
 238             gui_name = 'qt'
 239         try:
 240             gui = __import__('electrum_gui.' + gui_name, fromlist=['electrum_gui'])
 241         except ImportError:
 242             traceback.print_exc(file=sys.stdout)
 243             sys.exit()
 244             #sys.exit("Error: Unknown GUI: " + gui_name )
 245
 246         # network interface
 247         if not options.offline:
 248             network = Network(config)
 249             network.start()
 250         else:
 251             network = None
 252
 253         gui = gui.ElectrumGui(config, network)
 254         gui.main(url)
 255
 256         if network:
 257             network.stop()
 258
 259         # we use daemon threads, their termination is enforced.
 260         # this sleep command gives them time to terminate cleanly.
 261         time.sleep(0.1)
 262         sys.exit(0)
 263
 264     if cmd not in known_commands:
 265         cmd = 'help'
 266
 267     cmd = known_commands[cmd]
 268
 269     # instanciate wallet for command-line
 270     storage = WalletStorage(config)
 271
 272
 273     if cmd.name in ['create', 'restore']:
 274         if storage.file_exists:
 275             sys.exit("Error: Remove the existing wallet first!")
 276         if options.password is not None:
 277             password = options.password
 278         elif cmd.name == 'restore' and options.mpk:
 279             password = None
 280         else:
 281             password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
 282
 283         # if config.server is set, the user either passed the server on command line
 284         # or chose it previously already. if he didn't pass a server on the command line,
 285         # we just pick up a random one.
 286         if not config.get('server'):
 287             config.set_key('server', pick_random_server())
 288
 289         #fee = options.tx_fee if options.tx_fee else raw_input("fee (default:%s):" % (str(Decimal(wallet.fee)/100000000)))
 290         #gap = options.gap_limit if options.gap_limit else raw_input("gap limit (default 5):")
 291         #if fee:
 292         #    wallet.set_fee(float(fee)*100000000)
 293         #if gap:
 294         #    wallet.change_gap_limit(int(gap))
 295
 296         if cmd.name == 'restore':
 297             if options.mpk:
 298                 wallet = Wallet.from_mpk(options.mpk, storage)
 299             else:
 300                 import getpass
 301                 seed = getpass.getpass(prompt="seed:", stream=None) if options.concealed else raw_input("seed:")
 302                 wallet = Wallet.from_seed(str(seed),storage)
 303                 if not wallet:
 304                     sys.exit("Error: Invalid seed")
 305                 wallet.save_seed(password)
 306
 307             if not options.offline:
 308                 network = Network(config)
 309                 network.start()
 310                 wallet.start_threads(network)
 311                 print_msg("Recovering wallet...")
 312                 wallet.restore(lambda x: x)
 313                 if wallet.is_found():
 314                     print_msg("Recovery successful")
 315                 else:
 316                     print_msg("Warning: Found no history for this wallet")
 317             else:
 318                 wallet.synchronize()
 319                 print_msg("Warning: This wallet was restored offline. It may contain more addresses than displayed.")
 320
 321         else:
 322             wallet = Wallet(storage)
 323             wallet.init_seed(None)
 324             wallet.save_seed(password)
 325             wallet.synchronize()
 326             print_msg("Your wallet generation seed is:\n\"%s\"" % wallet.get_mnemonic(password))
 327             print_msg("Please keep it in a safe place; if you lose it, you will not be able to restore your wallet.")
 328
 329         print_msg("Wallet saved in '%s'" % wallet.storage.path)
 330
 331         # terminate
 332         sys.exit(0)
 333
 334
 335     if cmd.name not in ['create', 'restore'] and cmd.requires_wallet and not storage.file_exists:
 336         print_msg("Error: Wallet file not found.")
 337         print_msg("Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option")
 338         sys.exit(0)
 339
 340
 341     if cmd.requires_wallet:
 342         wallet = Wallet(storage)
 343     else:
 344         wallet = None
 345
 346
 347     # important warning
 348     if cmd.name in ['dumpprivkey', 'dumpprivkeys']:
 349         print_msg("WARNING: ALL your private keys are secret.")
 350         print_msg("Exposing a single private key can compromise your entire wallet!")
 351         print_msg("In particular, DO NOT use 'redeem private key' services proposed by third parties.")
 352
 353     # commands needing password
 354     if cmd.requires_password:
 355         if wallet.seed == '':
 356             seed = ''
 357             password = None
 358         elif wallet.use_encryption:
 359             password = prompt_password('Password:', False)
 360             if not password:
 361                 print_msg("Error: Password required")
 362                 sys.exit(1)
 363             # check password
 364             try:
 365                 seed = wallet.get_seed(password)
 366             except Exception:
 367                 print_msg("Error: This password does not decode this wallet.")
 368                 sys.exit(1)
 369         else:
 370             password = None
 371             seed = wallet.get_seed(None)
 372     else:
 373         password = None
 374
 375     # add missing arguments, do type conversions
 376     if cmd.name == 'importprivkey':
 377         # See if they specificed a key on the cmd line, if not prompt
 378         if len(args) == 1:
 379             args[1] = prompt_password('Enter PrivateKey (will not echo):', False)
 380
 381     elif cmd.name == 'signrawtransaction':
 382         args = [cmd, args[1], json.loads(args[2]) if len(args) > 2 else [], json.loads(args[3]) if len(args) > 3 else []]
 383
 384     elif cmd.name == 'createmultisig':
 385         args = [cmd, int(args[1]), json.loads(args[2])]
 386
 387     elif cmd.name == 'createrawtransaction':
 388         args = [cmd, json.loads(args[1]), json.loads(args[2])]
 389
 390     elif cmd.name == 'listaddresses':
 391         args = [cmd, options.show_all, options.show_labels]
 392
 393     elif cmd.name in ['payto', 'mktx']:
 394         domain = [options.from_addr] if options.from_addr else None
 395         args = ['mktx', args[1], Decimal(args[2]), Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain]
 396
 397     elif cmd.name in ['paytomany', 'mksendmanytx']:
 398         domain = [options.from_addr] if options.from_addr else None
 399         outputs = []
 400         for i in range(1, len(args), 2):
 401             if len(args) < i+2:
 402                 print_msg("Error: Mismatched arguments.")
 403                 sys.exit(1)
 404             outputs.append((args[i], Decimal(args[i+1])))
 405         args = ['mksendmanytx', outputs, Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain]
 406
 407     elif cmd.name == 'help':
 408         if len(args) < 2:
 409             print_help(parser)
 410
 411     # check the number of arguments
 412     if len(args) - 1 < cmd.min_args:
 413         print_msg("Not enough arguments")
 414         print_msg("Syntax:", cmd.syntax)
 415         sys.exit(1)
 416
 417     if cmd.max_args >= 0 and len(args) - 1 > cmd.max_args:
 418         print_msg("too many arguments", args)
 419         print_msg("Syntax:", cmd.syntax)
 420         sys.exit(1)
 421
 422     if cmd.max_args < 0:
 423         if len(args) > cmd.min_args + 1:
 424             message = ' '.join(args[cmd.min_args:])
 425             print_msg("Warning: Final argument was reconstructed from several arguments:", repr(message))
 426             args = args[0:cmd.min_args] + [message]
 427
 428
 429
 430     # run the command
 431     if cmd.name == 'deseed':
 432         if not wallet.seed:
 433             print_msg("Error: This wallet has no seed")
 434         else:
 435             ns = wallet.storage.path + '.seedless'
 436             print_msg("Warning: you are going to create a seedless wallet'\nIt will be saved in '%s'" % ns)
 437             if raw_input("Are you sure you want to continue? (y/n) ") in ['y', 'Y', 'yes']:
 438                 wallet.storage.path = ns
 439                 wallet.seed = ''
 440                 wallet.storage.put('seed', '', True)
 441                 wallet.use_encryption = False
 442                 wallet.storage.put('use_encryption', wallet.use_encryption, True)
 443                 for k in wallet.imported_keys.keys():
 444                     wallet.imported_keys[k] = ''
 445                 wallet.storage.put('imported_keys', wallet.imported_keys, True)
 446                 print_msg("Done.")
 447             else:
 448                 print_msg("Action canceled.")
 449
 450     elif cmd.name == 'getconfig':
 451         key = args[1]
 452         out = config.get(key)
 453         print_msg(out)
 454
 455     elif cmd.name == 'setconfig':
 456         key, value = args[1:3]
 457         config.set_key(key, value, True)
 458         print_msg(True)
 459
 460     elif cmd.name == 'password':
 461         new_password = prompt_password('New password:')
 462         wallet.update_password(password, new_password)
 463
 464     else:
 465         run_command(cmd, password, args)
 466
 467
 468     time.sleep(0.1)
 469     sys.exit(0)