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