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