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     return parser
  93
  94
  95 def print_help(parser):
  96     parser.print_help()
  97     print_msg("Type 'electrum help <command>' to see the help for a specific command")
  98     print_msg("Type 'electrum --help' to see the list of options")
  99     run_command('help')
 100     sys.exit(1)
 101
 102
 103 def print_help_cb(self, opt, value, parser):
 104     print_help(parser)
 105
 106
 107 def run_command(cmd, password=None, args=[]):
 108     cmd_runner = Commands(wallet, network)
 109     func = getattr(cmd_runner, cmd)
 110     cmd_runner.password = password
 111     try:
 112         result = func(*args[1:])
 113     except Exception:
 114         traceback.print_exc(file=sys.stdout)
 115         sys.exit(1)
 116
 117     if type(result) == str:
 118         util.print_msg(result)
 119     elif result is not None:
 120         util.print_json(result)
 121
 122
 123 if __name__ == '__main__':
 124
 125     parser = arg_parser()
 126     options, args = parser.parse_args()
 127     if options.portable and options.wallet_path is None:
 128         options.electrum_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'electrum_data')
 129
 130     # config is an object passed to the various constructors (wallet, interface, gui)
 131     if is_android:
 132         config_options = {
 133             'portable': True,
 134             'verbose': True,
 135             'gui': 'android',
 136             'auto_cycle': True,
 137         }
 138     else:
 139         config_options = eval(str(options))
 140         for k, v in config_options.items():
 141             if v is None:
 142                 config_options.pop(k)
 143
 144     set_verbosity(config_options.get('verbose'))
 145
 146     config = SimpleConfig(config_options)
 147
 148     if len(args) == 0:
 149         url = None
 150         cmd = 'gui'
 151     elif len(args) == 1 and re.match('^bitcoin:', args[0]):
 152         url = args[0]
 153         cmd = 'gui'
 154     else:
 155         cmd = args[0]
 156
 157     if cmd == 'gui':
 158         gui_name = config.get('gui', 'classic')
 159         if gui_name in ['lite', 'classic']:
 160             gui_name = 'qt'
 161         try:
 162             gui = __import__('electrum_gui.' + gui_name, fromlist=['electrum_gui'])
 163         except ImportError:
 164             traceback.print_exc(file=sys.stdout)
 165             sys.exit()
 166             #sys.exit("Error: Unknown GUI: " + gui_name )
 167
 168         # network interface
 169         if not options.offline:
 170             network = Network(config)
 171             network.start()
 172         else:
 173             network = None
 174
 175         gui = gui.ElectrumGui(config, network)
 176         gui.main(url)
 177
 178         if network:
 179             network.stop()
 180
 181         # we use daemon threads, their termination is enforced.
 182         # this sleep command gives them time to terminate cleanly.
 183         time.sleep(0.1)
 184         sys.exit(0)
 185
 186     if cmd not in known_commands:
 187         cmd = 'help'
 188
 189     cmd = known_commands[cmd]
 190
 191     # instanciate wallet for command-line
 192     storage = WalletStorage(config)
 193
 194     if cmd.requires_wallet:
 195         wallet = Wallet(storage)
 196     else:
 197         wallet = None
 198
 199     if cmd.name not in ['create', 'restore'] and cmd.requires_wallet and not storage.file_exists:
 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.name in ['create', 'restore']:
 205         if storage.file_exists:
 206             sys.exit("Error: Remove the existing wallet first!")
 207         if options.password is not None:
 208             password = options.password
 209         else:
 210             password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
 211
 212         # if config.server is set, the user either passed the server on command line
 213         # or chose it previously already. if he didn't pass a server on the command line,
 214         # we just pick up a random one.
 215         if not config.get('server'):
 216             config.set_key('server', pick_random_server())
 217
 218         fee = options.tx_fee if options.tx_fee else raw_input("fee (default:%s):" % (str(Decimal(wallet.fee)/100000000)))
 219         gap = options.gap_limit if options.gap_limit else raw_input("gap limit (default 5):")
 220
 221         if fee:
 222             wallet.set_fee(float(fee)*100000000)
 223         if gap:
 224             wallet.change_gap_limit(int(gap))
 225
 226         if cmd.name == 'restore':
 227             import getpass
 228             seed = getpass.getpass(prompt="seed:", stream=None) if options.concealed else raw_input("seed:")
 229             try:
 230                 seed.decode('hex')
 231             except Exception:
 232                 print_error("Warning: Not hex, trying decode.")
 233                 seed = mnemonic_decode(seed.split(' '))
 234             if not seed:
 235                 sys.exit("Error: No seed")
 236
 237             wallet.init_seed(str(seed))
 238             wallet.save_seed(password)
 239             if not options.offline:
 240                 network = Network(config)
 241                 network.start()
 242                 wallet.start_threads(network)
 243
 244                 print_msg("Recovering wallet...")
 245                 wallet.restore(lambda x: x)
 246
 247                 if wallet.is_found():
 248                     print_msg("Recovery successful")
 249                 else:
 250                     print_msg("Warning: Found no history for this wallet")
 251             else:
 252                 wallet.synchronize()
 253                 print_msg("Warning: This wallet was restored offline. It may contain more addresses than displayed.")
 254
 255         else:
 256             wallet.init_seed(None)
 257             wallet.save_seed(password)
 258             wallet.synchronize()
 259             print_msg("Your wallet generation seed is:\n\"%s\"" % wallet.get_mnemonic(password))
 260             print_msg("Please keep it in a safe place; if you lose it, you will not be able to restore your wallet.")
 261
 262         print_msg("Wallet saved in '%s'" % wallet.storage.path)
 263
 264         # terminate
 265         sys.exit(0)
 266
 267     # important warning
 268     if cmd.name in ['dumpprivkey', 'dumpprivkeys']:
 269         print_msg("WARNING: ALL your private keys are secret.")
 270         print_msg("Exposing a single private key can compromise your entire wallet!")
 271         print_msg("In particular, DO NOT use 'redeem private key' services proposed by third parties.")
 272
 273     # commands needing password
 274     if cmd.requires_password:
 275         if wallet.seed == '':
 276             seed = ''
 277             password = None
 278         elif wallet.use_encryption:
 279             password = prompt_password('Password:', False)
 280             if not password:
 281                 print_msg("Error: Password required")
 282                 sys.exit(1)
 283             # check password
 284             try:
 285                 seed = wallet.get_seed(password)
 286             except Exception:
 287                 print_msg("Error: This password does not decode this wallet.")
 288                 sys.exit(1)
 289         else:
 290             password = None
 291             seed = wallet.get_seed(None)
 292     else:
 293         password = None
 294
 295     # add missing arguments, do type conversions
 296     if cmd.name == 'importprivkey':
 297         # See if they specificed a key on the cmd line, if not prompt
 298         if len(args) == 1:
 299             args[1] = prompt_password('Enter PrivateKey (will not echo):', False)
 300
 301     elif cmd.name == 'signrawtransaction':
 302         args = [cmd, args[1], json.loads(args[2]) if len(args) > 2 else [], json.loads(args[3]) if len(args) > 3 else []]
 303
 304     elif cmd.name == 'createmultisig':
 305         args = [cmd, int(args[1]), json.loads(args[2])]
 306
 307     elif cmd.name == 'createrawtransaction':
 308         args = [cmd, json.loads(args[1]), json.loads(args[2])]
 309
 310     elif cmd.name == 'listaddresses':
 311         args = [cmd, options.show_all, options.show_labels]
 312
 313     elif cmd.name in ['payto', 'mktx']:
 314         domain = [options.from_addr] if options.from_addr else None
 315         args = ['mktx', args[1], Decimal(args[2]), Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain]
 316
 317     elif cmd.name in ['paytomany', 'mksendmanytx']:
 318         domain = [options.from_addr] if options.from_addr else None
 319         outputs = []
 320         for i in range(1, len(args), 2):
 321             if len(args) < i+2:
 322                 print_msg("Error: Mismatched arguments.")
 323                 sys.exit(1)
 324             outputs.append((args[i], Decimal(args[i+1])))
 325         args = ['mksendmanytx', outputs, Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain]
 326
 327     elif cmd.name == 'help':
 328         if len(args) < 2:
 329             print_help(parser)
 330
 331     # check the number of arguments
 332     if len(args) - 1 < cmd.min_args:
 333         print_msg("Not enough arguments")
 334         print_msg("Syntax:", cmd.syntax)
 335         sys.exit(1)
 336
 337     if cmd.max_args >= 0 and len(args) - 1 > cmd.max_args:
 338         print_msg("too many arguments", args)
 339         print_msg("Syntax:", cmd.syntax)
 340         sys.exit(1)
 341
 342     if cmd.max_args < 0:
 343         if len(args) > cmd.min_args + 1:
 344             message = ' '.join(args[cmd.min_args:])
 345             print_msg("Warning: Final argument was reconstructed from several arguments:", repr(message))
 346             args = args[0:cmd.min_args] + [message]
 347
 348     # open session
 349     if cmd.requires_network and not options.offline:
 350         network = Network(config)
 351         if not network.start(wait=True):
 352             print_msg("Not connected, aborting.")
 353             sys.exit(1)
 354         print_error("Connected to " + network.interface.connection_msg)
 355
 356         if wallet:
 357             wallet.start_threads(network)
 358             wallet.update()
 359     else:
 360         network = None
 361
 362     # run the command
 363     if cmd.name == 'deseed':
 364         if not wallet.seed:
 365             print_msg("Error: This wallet has no seed")
 366         else:
 367             ns = wallet.storage.path + '.seedless'
 368             print_msg("Warning: you are going to create a seedless wallet'\nIt will be saved in '%s'" % ns)
 369             if raw_input("Are you sure you want to continue? (y/n) ") in ['y', 'Y', 'yes']:
 370                 wallet.storage.path = ns
 371                 wallet.seed = ''
 372                 wallet.storage.put('seed', '', True)
 373                 wallet.use_encryption = False
 374                 wallet.storage.put('use_encryption', wallet.use_encryption, True)
 375                 for k in wallet.imported_keys.keys():
 376                     wallet.imported_keys[k] = ''
 377                 wallet.storage.put('imported_keys', wallet.imported_keys, True)
 378                 print_msg("Done.")
 379             else:
 380                 print_msg("Action canceled.")
 381
 382     elif cmd.name == 'getconfig':
 383         key = args[1]
 384         out = config.get(key)
 385         print_msg(out)
 386
 387     elif cmd.name == 'setconfig':
 388         key, value = args[1:3]
 389         config.set_key(key, value, True)
 390         print_msg(True)
 391
 392     elif cmd.name == 'password':
 393         new_password = prompt_password('New password:')
 394         wallet.update_password(password, new_password)
 395
 396     else:
 397         run_command(cmd.name, password, args)
 398
 399     if network:
 400         if wallet:
 401             wallet.stop_threads()
 402         network.stop()
 403         time.sleep(0.1)
 404         sys.exit(0)