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