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 sys
  21 import optparse
  22
  23 try:
  24     from lib.util import print_error
  25 except ImportError:
  26     from electrum.util import print_error
  27
  28 try:
  29     import ecdsa
  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
  35 except ImportError:
  36     sys.exit("Error: AES does not seem to be installed. Try 'sudo pip install slowaes'")
  37
  38 try:
  39     from lib import Wallet, Interface, WalletSynchronizer, WalletVerifier, format_satoshis, mnemonic, SimpleConfig, pick_random_server
  40 except ImportError:
  41     from electrum import Wallet, Interface, WalletSynchronizer, WalletVerifier, format_satoshis, mnemonic, SimpleConfig, pick_random_server
  42
  43 from decimal import Decimal
  44
  45 known_commands = {
  46     'help':'Prints this help',
  47     'validateaddress':'Check that the address is valid',
  48     'balance': "Display the balance of your wallet or of an address.\nSyntax: balance [<address>]",
  49     'contacts': "Show your list of contacts",
  50     'create':'Create a wallet',
  51     'restore':'Restore a wallet',
  52     'payto':"""Create and broadcast a transaction.
  53 Syntax: payto <recipient> <amount> [label]
  54 <recipient> can be a bitcoin address or a label
  55 options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
  56             """,
  57     'sendtx':
  58             'Broadcasts a transaction to the network. \nSyntax: sendtx <tx>\n<tx> must be in hexadecimal.',
  59     'password':
  60             "Changes your password",
  61     'addresses':
  62             """Shows your list of addresses.
  63 options:
  64   -a: show all addresses, including change addresses
  65   -k: show private keys
  66   -b: show the balance of addresses""",
  67
  68     'history':"Shows the transaction history",
  69     'label':'Assign a label to an item\nSyntax: label <tx_hash> <label>',
  70     'mktx':
  71         """Create a signed transaction, password protected.
  72 Syntax: mktx <recipient> <amount> [label]
  73 options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
  74         """,
  75     'seed':
  76             "Print the generation seed of your wallet.",
  77     'import':
  78             'Imports a key pair\nSyntax: import <address>:<privatekey>',
  79     'signmessage':
  80             'Signs a message with a key\nSyntax: signmessage <address> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello  This is a weird String "',
  81     'verifymessage':
  82              'Verifies a signature\nSyntax: verifymessage <address> <signature> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello  This is a weird String "',
  83     'eval':
  84              "Run python eval() on an object\nSyntax: eval <expression>\nExample: eval \"wallet.aliases\"",
  85     'set':
  86              "Set wallet parameter. (gui)",
  87     'deseed':
  88             "Remove seed from the wallet. The seed is stored in a file that has the name of the wallet plus '.seed'",
  89     'reseed':
  90             "Restore seed of the wallet. The wallet must have no seed, and the seed must match the wallet's master public key.",
  91     'freeze':'',
  92     'unfreeze':'',
  93     'prioritize':'',
  94     'unprioritize':'',
  95     }
  96
  97
  98
  99 offline_commands = [ 'password', 'mktx',
 100                      'label', 'contacts',
 101                      'help', 'validateaddress',
 102                      'signmessage', 'verifymessage',
 103                      'eval', 'set', 'create', 'addresses',
 104                      'import', 'seed',
 105                      'deseed','reseed',
 106                      'freeze','unfreeze',
 107                      'prioritize','unprioritize']
 108
 109
 110 protected_commands = ['payto', 'password', 'mktx', 'seed', 'import','signmessage' ]
 111
 112 # get password routine
 113 def prompt_password(prompt, confirm=True):
 114     import getpass
 115     if sys.stdin.isatty():
 116         password = getpass.getpass(prompt)
 117         if password and confirm:
 118             password2 = getpass.getpass("Confirm: ")
 119             if password != password2:
 120                 sys.exit("Error: Passwords do not match.")
 121     else:
 122         password = raw_input(prompt)
 123     if not password:
 124         password = None
 125     return password
 126
 127
 128
 129 if __name__ == '__main__':
 130
 131     usage = "usage: %prog [options] command\nCommands: "+ (', '.join(known_commands))
 132     parser = optparse.OptionParser(prog=usage)
 133     parser.add_option("-g", "--gui", dest="gui", help="User interface: qt, lite, gtk or text")
 134     parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
 135     parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
 136     parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
 137     parser.add_option("-b", "--balance", action="store_true", dest="show_balance", default=False, help="show the balance at listed addresses")
 138     parser.add_option("-k", "--keys",action="store_true", dest="show_keys",default=False, help="show the private keys of listed addresses")
 139     parser.add_option("-f", "--fee", dest="tx_fee", default="0.005", help="set tx fee")
 140     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.")
 141     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")
 142     parser.add_option("-s", "--server", dest="server", default=None, help="set server host:port:protocol, where protocol is t or h")
 143     parser.add_option("-p", "--proxy", dest="proxy", default=None, help="set proxy [type:]host[:port], where type is socks4,socks5 or http")
 144     options, args = parser.parse_args()
 145
 146     # config is an object passed to the various constructors (wallet, interface, gui)
 147     config = SimpleConfig(options)
 148     wallet = Wallet(config)
 149
 150     if len(args)==0:
 151         url = None
 152         cmd = 'gui'
 153     elif len(args)==1 and re.match('^bitcoin:', args[0]):
 154         url = args[0]
 155         cmd = 'gui'
 156     else:
 157         cmd = args[0]
 158         firstarg = args[1] if len(args) > 1 else ''
 159
 160     #this entire if/else block is just concerned with importing the
 161     #right GUI toolkit based the GUI command line option given
 162     if cmd == 'gui':
 163         pref_gui = config.get('gui','classic')
 164         if pref_gui == 'gtk':
 165             try:
 166                 import lib.gui as gui
 167             except ImportError:
 168                 import electrum.gui as gui
 169         elif pref_gui in ['classic', 'qt']:
 170             try:
 171                 import lib.gui_qt as gui
 172             except ImportError:
 173                 import electrum.gui_qt as gui
 174         elif pref_gui == 'lite':
 175               try:
 176                   import lib.gui_lite as gui
 177               except ImportError:
 178                   import electrum.gui_lite as gui
 179         elif pref_gui == 'text':
 180               try:
 181                   import lib.gui_text as gui
 182               except ImportError:
 183                   import electrum.gui_text as gui
 184         else:
 185             sys.exit("Error: Unknown GUI: " + pref_gui )
 186
 187         gui = gui.ElectrumGui(wallet, config)
 188         wallet.interface = Interface(config, True, gui.server_list_changed)
 189         wallet.interface.start()
 190
 191         WalletSynchronizer(wallet, config).start()
 192         WalletVerifier(wallet, config).start()
 193
 194         try:
 195             found = config.wallet_file_exists
 196             if not found:
 197                 found = gui.restore_or_create()
 198         except SystemExit, e:
 199             exit(e)
 200         except BaseException, e:
 201             import traceback
 202             traceback.print_exc(file=sys.stdout)
 203             #gui.show_message(e.message)
 204             exit(1)
 205
 206         if not found:
 207             exit(1)
 208         gui.main(url)
 209         wallet.save()
 210         sys.exit(0)
 211
 212     if cmd not in known_commands:
 213         cmd = 'help'
 214
 215     if not config.wallet_file_exists and cmd not in ['help','create','restore']:
 216         print "Error: Wallet file not found."
 217         print "Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option"
 218         sys.exit(0)
 219
 220     if cmd in ['create', 'restore']:
 221         if config.wallet_file_exists:
 222             sys.exit("Error: Remove the existing wallet first!")
 223         password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
 224
 225         server = config.get('server')
 226         if not server: server = pick_random_server()
 227         w_host, w_port, w_protocol = server.split(':')
 228         host = raw_input("server (default:%s):"%w_host)
 229         port = raw_input("port (default:%s):"%w_port)
 230         protocol = raw_input("protocol [t=tcp;h=http;n=native] (default:%s):"%w_protocol)
 231         fee = raw_input("fee (default:%s):"%( str(Decimal(wallet.fee)/100000000)) )
 232         gap = raw_input("gap limit (default 5):")
 233         if host: w_host = host
 234         if port: w_port = port
 235         if protocol: w_protocol = protocol
 236         wallet.config.set_key('server', w_host + ':' + w_port + ':' +w_protocol)
 237         if fee: wallet.fee = float(fee)
 238         if gap: wallet.gap_limit = int(gap)
 239
 240         if cmd == 'restore':
 241             seed = raw_input("seed:")
 242             try:
 243                 seed.decode('hex')
 244             except:
 245                 print_error("Warning: Not hex, trying decode.")
 246                 seed = mnemonic.mn_decode( seed.split(' ') )
 247             if not seed:
 248                 sys.exit("Error: No seed")
 249
 250             wallet.seed = str(seed)
 251             wallet.init_mpk( wallet.seed )
 252             if not options.offline:
 253                 WalletSynchronizer(wallet, config).start()
 254                 print "Recovering wallet..."
 255                 wallet.up_to_date_event.clear()
 256                 wallet.up_to_date = False
 257                 wallet.update()
 258                 if wallet.is_found():
 259                     print "Recovery successful"
 260                 else:
 261                     print_error("Warning: Found no history for this wallet")
 262             else:
 263                 wallet.synchronize()
 264             wallet.fill_addressbook()
 265             wallet.save()
 266             print_error("Wallet saved in '" + wallet.path)
 267         else:
 268             wallet.new_seed(None)
 269             wallet.init_mpk( wallet.seed )
 270             wallet.synchronize() # there is no wallet thread
 271             wallet.save()
 272             print "Your wallet generation seed is: " + wallet.seed
 273             print "Please keep it in a safe place; if you lose it, you will not be able to restore your wallet."
 274             print "Equivalently, your wallet seed can be stored and recovered with the following mnemonic code:"
 275             print "\""+' '.join(mnemonic.mn_encode(wallet.seed))+"\""
 276             print "Wallet saved in '%s'"%wallet.config.path
 277
 278         if password:
 279             wallet.update_password(wallet.seed, None, password)
 280
 281     # check syntax
 282     if cmd in ['payto', 'mktx']:
 283         try:
 284             to_address = args[1]
 285             amount = int( 100000000 * Decimal(args[2]) )
 286             change_addr = None
 287             label = ' '.join(args[3:])
 288             if options.tx_fee:
 289                 options.tx_fee = int( 100000000 * Decimal(options.tx_fee) )
 290         except:
 291             firstarg = cmd
 292             cmd = 'help'
 293
 294     # open session
 295     if cmd not in offline_commands and not options.offline:
 296         wallet.interface = Interface(config)
 297         wallet.interface.start()
 298         WalletSynchronizer(wallet, config).start()
 299         wallet.update()
 300         wallet.save()
 301
 302     # check if --from_addr not in wallet (for mktx/payto)
 303     is_temporary = False
 304     from_addr = None
 305     if options.from_addr:
 306         from_addr = options.from_addr
 307         if from_addr not in wallet.all_addresses():
 308             is_temporary = True
 309
 310     # important warning
 311     if cmd=='addresses' and options.show_keys:
 312         print "WARNING: ALL your private keys are secret."
 313         print "Exposing a single private key can compromise your entire wallet!"
 314         print "In particular, DO NOT use 'redeem private key' services proposed by third parties."
 315
 316     # commands needing password
 317     if cmd in protected_commands or ( cmd=='addresses' and options.show_keys):
 318         password = prompt_password('Password:', False) if wallet.use_encryption and not is_temporary else None
 319         # check password
 320         try:
 321             wallet.pw_decode( wallet.seed, password)
 322         except:
 323             print_error("Error: This password does not decode this wallet.")
 324             exit(1)
 325
 326     if cmd == 'import':
 327         # See if they specificed a key on the cmd line, if not prompt
 328         if len(args) > 1:
 329             keypair = args[1]
 330         else:
 331             keypair = prompt_password('Enter Address:PrivateKey (will not echo):', False)
 332         try:
 333             wallet.import_key(keypair,password)
 334             wallet.save()
 335             print "Keypair imported"
 336         except BaseException, e:
 337             print_error("Error: Keypair import failed: " + str(e))
 338
 339     if cmd == 'help':
 340         cmd2 = firstarg
 341         if cmd2 not in known_commands:
 342             parser.print_help()
 343             print "Type 'electrum help <command>' to see the help for a specific command"
 344             print "Type 'electrum --help' to see the list of options"
 345             print "List of commands:", ', '.join(known_commands)
 346         else:
 347             print known_commands[cmd2]
 348
 349     elif cmd == 'seed':
 350         seed = wallet.pw_decode( wallet.seed, password)
 351         print seed + ' "' + ' '.join(mnemonic.mn_encode(seed)) + '"'
 352
 353     elif cmd == 'deseed':
 354         if not wallet.seed:
 355             print_error("Error: This wallet has no seed")
 356         elif wallet.use_encryption:
 357             print_error("Error: This wallet is encrypted")
 358         else:
 359             ns = wallet.path + '.seed'
 360             print "Warning: you are going to extract the seed from '%s'\nThe seed will be saved in '%s'"%(wallet.path,ns)
 361             if raw_input("Are you sure you want to continue? (y/n) ") in ['y','Y','yes']:
 362                 f = open(ns,'w')
 363                 f.write(repr({'seed':wallet.seed, 'imported_keys':wallet.imported_keys})+"\n")
 364                 f.close()
 365                 wallet.seed = ''
 366                 for k in wallet.imported_keys.keys(): wallet.imported_keys[k] = ''
 367                 wallet.save()
 368                 print "Done."
 369             else:
 370                 print_error("Action canceled.")
 371
 372     elif cmd == 'reseed':
 373         if wallet.seed:
 374             print "Warning: This wallet already has a seed", wallet.seed
 375         else:
 376             ns = wallet.path + '.seed'
 377             try:
 378                 f = open(ns,'r')
 379                 data = f.read()
 380                 f.close()
 381             except IOError:
 382                 sys.exit("Error: Seed file not found")
 383             try:
 384                 import ast
 385                 d = ast.literal_eval( data )
 386                 seed = d['seed']
 387                 imported_keys = d.get('imported_keys',{})
 388             except:
 389                 sys.exit("Error: Error with seed file")
 390
 391             mpk = wallet.master_public_key
 392             wallet.seed = seed
 393             wallet.imported_keys = imported_keys
 394             wallet.use_encryption = False
 395             wallet.init_mpk(seed)
 396             if mpk == wallet.master_public_key:
 397                 wallet.save()
 398                 print "Done: " + wallet.path
 399             else:
 400                 print_error("Error: Master public key does not match")
 401
 402     elif cmd == 'validateaddress':
 403         addr = args[1]
 404         print wallet.is_valid(addr)
 405
 406     elif cmd == 'balance':
 407         try:
 408             addrs = args[1:]
 409         except:
 410             pass
 411         if addrs == []:
 412             c, u = wallet.get_balance()
 413             if u:
 414                 print Decimal( c ) / 100000000 , Decimal( u ) / 100000000
 415             else:
 416                 print Decimal( c ) / 100000000
 417         else:
 418             for addr in addrs:
 419                 c, u = wallet.get_addr_balance(addr)
 420                 if u:
 421                     print "%s %s, %s" % (addr, str(Decimal(c)/100000000), str(Decimal(u)/100000000))
 422                 else:
 423                     print "%s %s" % (addr, str(Decimal(c)/100000000))
 424
 425     elif cmd in [ 'contacts']:
 426         for addr in wallet.addressbook:
 427             print addr, "   ", wallet.labels.get(addr)
 428
 429     elif cmd == 'eval':
 430         print eval(args[1])
 431         wallet.save()
 432
 433     elif cmd == 'set':
 434         key, value = args[1:3]
 435         if key in ['gui', 'server', 'proxy', 'fee', 'gap_limit', 'use_change']:
 436             wallet.config.set_key(key, value, True)
 437             print True
 438         else:
 439             print False
 440
 441     elif cmd in [ 'addresses']:
 442         for addr in wallet.all_addresses():
 443             if options.show_all or not wallet.is_change(addr):
 444
 445                 flags = wallet.get_address_flags(addr)
 446                 label = wallet.labels.get(addr,'')
 447
 448                 if label: label = "\"%s\""%label
 449
 450                 if options.show_balance:
 451                     h = wallet.history.get(addr,[])
 452                     #ni = no = 0
 453                     #for item in h:
 454                     #    if item['is_input']:  ni += 1
 455                     #    else:              no += 1
 456                     b = format_satoshis(wallet.get_addr_balance(addr)[0])
 457                 else: b=''
 458                 m_addr = "%34s"%addr
 459                 if options.show_keys:
 460                     m_addr += ':' + str(wallet.get_private_key_base58(addr, password))
 461                 print flags, m_addr, b, label
 462
 463     if cmd == 'history':
 464         lines = wallet.get_tx_history()
 465         b = 0
 466         for line in lines:
 467             import datetime
 468             v = line['value']
 469             b += v
 470             try:
 471                 time_str = str( datetime.datetime.fromtimestamp( line['timestamp']))
 472             except:
 473                 print line['timestamp']
 474                 time_str = 'pending'
 475             label = line.get('label')
 476             if not label: label = line['tx_hash']
 477             else: label = label + ' '*(64 - len(label) )
 478
 479             print time_str , "  " + label + "  " + format_satoshis(v)+ "  "+ format_satoshis(b)
 480         print "# balance: ", format_satoshis(b)
 481
 482     elif cmd == 'label':
 483         try:
 484             tx = args[1]
 485             label = ' '.join(args[2:])
 486         except:
 487             print_error("Error. Syntax:  label <tx_hash> <text>")
 488             sys.exit(1)
 489         wallet.labels[tx] = label
 490         wallet.save()
 491
 492     elif cmd in ['payto', 'mktx']:
 493         if from_addr and is_temporary:
 494             if from_addr.find(":") == -1:
 495                 keypair = from_addr + ":" + prompt_password('Private key:', False)
 496             else:
 497                 keypair = from_addr
 498                 from_addr = keypair.split(':')[0]
 499             if not wallet.import_key(keypair,password):
 500                 print_error("Error: Invalid key pair")
 501                 exit(1)
 502             wallet.history[from_addr] = interface.retrieve_history(from_addr)
 503             wallet.update_tx_history()
 504             change_addr = from_addr
 505
 506         if options.change_addr:
 507             change_addr = options.change_addr
 508
 509         for k, v in wallet.labels.items():
 510             if v == to_address:
 511                 to_address = k
 512                 print "alias", to_address
 513                 break
 514             if change_addr and v == change_addr:
 515                 change_addr = k
 516         try:
 517             tx = wallet.mktx( to_address, amount, label, password,
 518                 fee = options.tx_fee, change_addr = change_addr, from_addr = from_addr )
 519         except:
 520             import traceback
 521             traceback.print_exc(file=sys.stdout)
 522             tx = None
 523
 524         if tx and cmd=='payto':
 525             r, h = wallet.sendtx( tx )
 526             print h
 527         else:
 528             print tx
 529
 530         if is_temporary:
 531             wallet.imported_keys.pop(from_addr)
 532             del(wallet.history[from_addr])
 533         wallet.save()
 534
 535     elif cmd == 'sendtx':
 536         tx = args[1]
 537         r, h = wallet.sendtx( tx )
 538         print h
 539
 540     elif cmd == 'password':
 541         try:
 542             seed = wallet.pw_decode( wallet.seed, password)
 543         except ValueError:
 544             sys.exit("Error: Password does not decrypt this wallet.")
 545
 546         new_password = prompt_password('New password:')
 547         wallet.update_password(seed, password, new_password)
 548
 549     elif cmd == 'signmessage':
 550         if len(args) < 3:
 551             print_error("Error: Invalid usage of signmessage.")
 552             print known_commands[cmd]
 553             sys.exit(1)
 554         address = args[1]
 555         message = ' '.join(args[2:])
 556         if len(args) > 3:
 557             print "Warning: Message was reconstructed from several arguments:", repr(message)
 558         print wallet.sign_message(address, message, password)
 559
 560     elif cmd == 'verifymessage':
 561         try:
 562             address = args[1]
 563             signature = args[2]
 564             message = ' '.join(args[3:])
 565         except:
 566             print_error("Error: Not all parameters were given, displaying help instead.")
 567             print known_commands[cmd]
 568             sys.exit(1)
 569         if len(args) > 4:
 570             print "Warning: Message was reconstructed from several arguments:", repr(message)
 571         try:
 572             wallet.verify_message(address, signature, message)
 573             print True
 574         except BaseException as e:
 575             print "Verification error: {0}".format(e)
 576             print False
 577
 578     elif cmd == 'freeze':
 579         addr = args[1]
 580         print wallet.freeze(addr)
 581
 582     elif cmd == 'unfreeze':
 583         addr = args[1]
 584         print wallet.unfreeze(addr)
 585
 586     elif cmd == 'prioritize':
 587         addr = args[1]
 588         print wallet.prioritize(addr)
 589
 590     elif cmd == 'unprioritize':
 591         addr = args[1]
 592         print wallet.unprioritize(addr)
 593