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