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, sys, getpass
  20
  21 try:
  22     import ecdsa
  23 except:
  24     print "python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'"
  25     sys.exit(1)
  26
  27 try:
  28     import aes
  29 except:
  30     print "AES does not seem to be installed. Try 'sudo pip install slowaes'"
  31     sys.exit(1)
  32
  33 try:
  34     from lib import Wallet, WalletSynchronizer, format_satoshis, mnemonic
  35 except:
  36     from electrum import Wallet, WalletSynchronizer, format_satoshis, mnemonic
  37
  38 from optparse import OptionParser
  39 from decimal import Decimal
  40
  41 known_commands = {
  42     'help':'print help',
  43     'validateaddress':'check that the address is valid',
  44     'balance': "Display the balance of your wallet or of an address.\nsyntax: balance [<address>]",
  45     'contacts': "Show your list of contacts",
  46     'create':'create wallet',
  47     'restore':'restore wallet',
  48     'payto':"""
  49             payto <recipient> <amount> [label]
  50             create and broadcast a transaction.
  51             <recipient> can be a bitcoin address or a label
  52             options:\n--fee, -f: set transaction fee\n--fromaddr, -s: send from address -\n--changeaddr, -c: send change to address
  53             """,
  54     'sendtx':
  55             """sendtx <tx>
  56             broadcast a transaction to the network. <tx> must be in hexadecimal""",
  57     'password':
  58             "change your password",
  59     'addresses':
  60             """show your list of addresses.
  61             options:
  62              -a: show all addresses, including change addresses
  63              -k: show private keys
  64              -b: show the balance of addresses""",
  65     'history':"show the transaction history",
  66     'label':"assign a label to an item",
  67     'mktx':
  68         """create a signed transaction. password protected
  69            syntax: mktx <recipient> <amount> [label]
  70            options:\n--fee, -f: set transaction fee\n--fromaddr, -s: send from address -\n--changeaddr, -c: send change to address
  71         """,
  72     'seed':
  73             "print the generation seed of your wallet.",
  74     'import':
  75             "import key pair",
  76     'signmessage':
  77             'sign a message with a key',
  78     'verifymessage':
  79              'verify signature',
  80     'eval':
  81              "Run python eval() on an object\nSyntax: eval <expression>\nExample: eval \"wallet.aliases\"",
  82     'deseed':
  83             "remove seed from the wallet. The seed is stored in a file that has the name of the wallet plus '.seed'",
  84     'reseed':
  85             "restore seed of the wallet. The wallet must have no seed, and the seed must match the wallet's master public key.",
  86     'freeze':'',
  87     'unfreeze':'',
  88     'prioritize':'',
  89     'unprioritize':'',
  90     }
  91
  92
  93
  94 offline_commands = [ 'password', 'mktx', 'label', 'contacts', 'help', 'validateaddress', 'signmessage', 'verifymessage', 'eval', 'create', 'addresses', 'import', 'seed','deseed','reseed','freeze','unfreeze','prioritize','unprioritize']
  95
  96 protected_commands = ['payto', 'password', 'mktx', 'seed', 'import','signmessage' ]
  97
  98 if __name__ == '__main__':
  99
 100     usage = "usage: %prog [options] command\nCommands: "+ (', '.join(known_commands))
 101     parser = OptionParser(usage=usage)
 102     parser.add_option("-g", "--gui", dest="gui", default="qt", help="gui")
 103     parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
 104     parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
 105     parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
 106     parser.add_option("-b", "--balance", action="store_true", dest="show_balance", default=False, help="show the balance at listed addresses")
 107     parser.add_option("-k", "--keys",action="store_true", dest="show_keys",default=False, help="show the private keys of listed addresses")
 108     parser.add_option("-f", "--fee", dest="tx_fee", default="0.005", help="set tx fee")
 109     parser.add_option("-s", "--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.")
 110     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")
 111     parser.add_option("-r", "--remote", dest="remote_url", default=None, help="URL of a remote wallet")
 112     options, args = parser.parse_args()
 113
 114     wallet = Wallet()
 115     wallet.set_path(options.wallet_path)
 116     wallet.read()
 117     wallet.remote_url = options.remote_url
 118
 119     if len(args)==0:
 120         url = None
 121         cmd = 'gui'
 122     elif len(args)==1 and re.match('^bitcoin:', args[0]):
 123         url = args[0]
 124         cmd = 'gui'
 125     else:
 126         cmd = args[0]
 127         firstarg = args[1] if len(args) > 1 else ''
 128
 129     if cmd == 'gui':
 130         if options.gui=='gtk':
 131             try:
 132                 import lib.gui as gui
 133             except:
 134                 import electrum.gui as gui
 135         elif options.gui=='qt':
 136             try:
 137                 import lib.gui_qt as gui
 138             except:
 139                 import electrum.gui_qt as gui
 140         else:
 141             print "unknown gui", options.gui
 142             exit(1)
 143
 144         gui = gui.ElectrumGui(wallet)
 145         WalletSynchronizer(wallet,True).start()
 146
 147         try:
 148             found = wallet.file_exists
 149             if not found:
 150                 found = gui.restore_or_create()
 151         except SystemExit, e:
 152             exit(e)
 153         except BaseException, e:
 154             import traceback
 155             traceback.print_exc(file=sys.stdout)
 156             #gui.show_message(e.message)
 157             exit(1)
 158
 159         if not found: exit(1)
 160         gui.main(url)
 161         wallet.save()
 162         sys.exit(0)
 163
 164     if cmd not in known_commands:
 165         cmd = 'help'
 166
 167     if not wallet.file_exists and cmd not in ['help','create','restore']:
 168         print "Wallet file not found."
 169         print "Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option"
 170         sys.exit(0)
 171
 172     if cmd in ['create', 'restore']:
 173         if wallet.file_exists:
 174             print "remove the existing wallet first!"
 175             sys.exit(0)
 176         password = getpass.getpass("Password (hit return if you do not wish to encrypt your wallet):")
 177         if password:
 178             password2 = getpass.getpass("Confirm password:")
 179             if password != password2:
 180                 print "error"
 181                 sys.exit(1)
 182         else:
 183             password = None
 184
 185         w_host, w_port, w_protocol = wallet.server.split(':')
 186         host = raw_input("server (default:%s):"%w_host)
 187         port = raw_input("port (default:%s):"%w_port)
 188         protocol = raw_input("protocol [t=tcp;h=http;n=native] (default:%s):"%w_protocol)
 189         fee = raw_input("fee (default:%s):"%( str(Decimal(wallet.fee)/100000000)) )
 190         gap = raw_input("gap limit (default 5):")
 191         if host: w_host = host
 192         if port: w_port = port
 193         if protocol: w_protocol = protocol
 194         wallet.server = w_host + ':' + w_port + ':' +w_protocol
 195         if fee: wallet.fee = float(fee)
 196         if gap: wallet.gap_limit = int(gap)
 197
 198         if cmd == 'restore':
 199             seed = raw_input("seed:")
 200             try:
 201                 seed.decode('hex')
 202             except:
 203                 print "not hex, trying decode"
 204                 seed = mnemonic.mn_decode( seed.split(' ') )
 205             if not seed:
 206                 print "no seed"
 207                 sys.exit(1)
 208
 209             wallet.seed = str(seed)
 210             wallet.init_mpk( wallet.seed )
 211             if not options.offline:
 212                 WalletSynchronizer(wallet).start()
 213                 print "recovering wallet..."
 214                 wallet.up_to_date_event.clear()
 215                 wallet.up_to_date = False
 216                 wallet.update()
 217                 if wallet.is_found():
 218                     print "recovery successful"
 219                 else:
 220                     print "found no history for this wallet"
 221             wallet.fill_addressbook()
 222             wallet.save()
 223             print "Wallet saved in '%s'"%wallet.path
 224         else:
 225             wallet.new_seed(None)
 226             wallet.init_mpk( wallet.seed )
 227             wallet.synchronize() # there is no wallet thread
 228             wallet.save()
 229             print "Your wallet generation seed is: " + wallet.seed
 230             print "Please keep it in a safe place; if you lose it, you will not be able to restore your wallet."
 231             print "Equivalently, your wallet seed can be stored and recovered with the following mnemonic code:"
 232             print "\""+' '.join(mnemonic.mn_encode(wallet.seed))+"\""
 233             print "Wallet saved in '%s'"%wallet.path
 234
 235         if password:
 236             wallet.update_password(wallet.seed, None, password)
 237
 238     # check syntax
 239     if cmd in ['payto', 'mktx']:
 240         try:
 241             to_address = args[1]
 242             amount = int( 100000000 * Decimal(args[2]) )
 243             change_addr = None
 244             label = ' '.join(args[3:])
 245             if options.tx_fee:
 246                 options.tx_fee = int( 100000000 * Decimal(options.tx_fee) )
 247         except:
 248             firstarg = cmd
 249             cmd = 'help'
 250
 251     # open session
 252     if cmd not in offline_commands and not options.offline:
 253         WalletSynchronizer(wallet).start()
 254         wallet.update()
 255         wallet.save()
 256
 257     # check if --from_addr not in wallet (for mktx/payto)
 258     is_temporary = False
 259     from_addr = None
 260     if options.from_addr:
 261         from_addr = options.from_addr
 262         if from_addr not in wallet.all_addresses():
 263             is_temporary = True
 264
 265     # commands needing password
 266     if cmd in protected_commands or ( cmd=='addresses' and options.show_keys):
 267         password = getpass.getpass('Password:') if wallet.use_encryption and not is_temporary else None
 268         # check password
 269         try:
 270             wallet.pw_decode( wallet.seed, password)
 271         except:
 272             print "invalid password"
 273             exit(1)
 274
 275     if cmd == 'import':
 276         keypair = args[1]
 277         try:
 278             wallet.import_key(keypair,password)
 279             wallet.save()
 280             print "keypair imported"
 281         except BaseException, e:
 282             print( 'Error:' + str(e) )
 283
 284     if cmd=='help':
 285         cmd2 = firstarg
 286         if cmd2 not in known_commands:
 287             print "type 'electrum help <command>' to see the help for a specific command"
 288             print "type 'electrum --help' to see the list of options"
 289             print "list of commands:", ', '.join(known_commands)
 290         else:
 291             print known_commands[cmd2]
 292
 293     elif cmd == 'seed':
 294         seed = wallet.pw_decode( wallet.seed, password)
 295         print seed + ' "' + ' '.join(mnemonic.mn_encode(seed)) + '"'
 296
 297     elif cmd == 'deseed':
 298         if not wallet.seed:
 299             print "Error: This wallet has no seed"
 300         elif wallet.use_encryption:
 301             print "Error: This wallet is encrypted"
 302         else:
 303             ns = wallet.path + '.seed'
 304             print "Warning: you are going to extract the seed from '%s'\nThe seed will be saved in '%s'"%(wallet.path,ns)
 305             if raw_input("Are you sure you want to continue? (y/n) ") in ['y','Y','yes']:
 306                 f = open(ns,'w')
 307                 f.write(repr({'seed':wallet.seed, 'imported_keys':wallet.imported_keys})+"\n")
 308                 f.close()
 309                 wallet.seed = ''
 310                 for k in wallet.imported_keys.keys(): wallet.imported_keys[k] = ''
 311                 wallet.save()
 312                 print "Done."
 313             else:
 314                 print "Action canceled."
 315
 316     elif cmd == 'reseed':
 317         if wallet.seed:
 318             print "This wallet already has a seed", wallet.seed
 319         else:
 320             ns = wallet.path + '.seed'
 321             try:
 322                 f = open(ns,'r')
 323                 data = f.read()
 324                 f.close()
 325             except:
 326                 print "seed file not found"
 327                 sys.exit()
 328             try:
 329                 import ast
 330                 d = ast.literal_eval( data )
 331                 seed = d['seed']
 332                 imported_keys = d.get('imported_keys',{})
 333             except:
 334                 print "error with seed file"
 335                 sys.exit(1)
 336
 337             mpk = wallet.master_public_key
 338             wallet.seed = seed
 339             wallet.imported_keys = imported_keys
 340             wallet.use_encryption = False
 341             wallet.init_mpk(seed)
 342             if mpk == wallet.master_public_key:
 343                 wallet.save()
 344                 print "Done: " + wallet.path
 345             else:
 346                 print "error: master public key does not match"
 347
 348     elif cmd == 'validateaddress':
 349         addr = args[1]
 350         print wallet.is_valid(addr)
 351
 352     elif cmd == 'balance':
 353         try:
 354             addrs = args[1:]
 355         except:
 356             pass
 357         if addrs == []:
 358             c, u = wallet.get_balance()
 359             if u:
 360                 print Decimal( c ) / 100000000 , Decimal( u ) / 100000000
 361             else:
 362                 print Decimal( c ) / 100000000
 363         else:
 364             for addr in addrs:
 365                 c, u = wallet.get_addr_balance(addr)
 366                 if u:
 367                     print "%s %s, %s" % (addr, str(Decimal(c)/100000000), str(Decimal(u)/100000000))
 368                 else:
 369                     print "%s %s" % (addr, str(Decimal(c)/100000000))
 370
 371     elif cmd in [ 'contacts']:
 372         for addr in wallet.addressbook:
 373             print addr, "   ", wallet.labels.get(addr)
 374
 375     elif cmd == 'eval':
 376         print eval(args[1])
 377         wallet.save()
 378
 379     elif cmd in [ 'addresses']:
 380         for addr in wallet.all_addresses():
 381             if options.show_all or not wallet.is_change(addr):
 382
 383                 flags = wallet.get_address_flags(addr)
 384                 label = wallet.labels.get(addr,'')
 385
 386                 if label: label = "\"%s\""%label
 387
 388                 if options.show_balance:
 389                     h = wallet.history.get(addr,[])
 390                     #ni = no = 0
 391                     #for item in h:
 392                     #    if item['is_input']:  ni += 1
 393                     #    else:              no += 1
 394                     b = format_satoshis(wallet.get_addr_balance(addr)[0])
 395                 else: b=''
 396                 addr = "%34s"%addr
 397                 if options.show_keys:
 398                     addr += ':' + str(wallet.get_private_key_base58(addr, password))
 399                 print flags, addr, b, label
 400
 401     if cmd == 'history':
 402         lines = wallet.get_tx_history()
 403         b = 0
 404         for line in lines:
 405             import datetime
 406             v = line['value']
 407             b += v
 408             try:
 409                 time_str = str( datetime.datetime.fromtimestamp( line['timestamp']))
 410             except:
 411                 print line['timestamp']
 412                 time_str = 'pending'
 413             label = line.get('label')
 414             if not label: label = line['tx_hash']
 415             else: label = label + ' '*(64 - len(label) )
 416
 417             print time_str , "  " + label + "  " + format_satoshis(v)+ "  "+ format_satoshis(b)
 418         print "# balance: ", format_satoshis(b)
 419
 420     elif cmd == 'label':
 421         try:
 422             tx = args[1]
 423             label = ' '.join(args[2:])
 424         except:
 425             print "syntax:  label <tx_hash> <text>"
 426             sys.exit(1)
 427         wallet.labels[tx] = label
 428         wallet.save()
 429
 430     elif cmd in ['payto', 'mktx']:
 431         if from_addr and is_temporary:
 432             if from_addr.find(":") == -1:
 433                 keypair = from_addr + ":" + getpass.getpass('Private key:')
 434             else:
 435                 keypair = from_addr
 436                 from_addr = keypair.split(':')[0]
 437             if not wallet.import_key(keypair,password):
 438                 print "invalid key pair"
 439                 exit(1)
 440             wallet.history[from_addr] = interface.retrieve_history(from_addr)
 441             wallet.update_tx_history()
 442             change_addr = from_addr
 443
 444         if options.change_addr:
 445             change_addr = options.change_addr
 446
 447         for k, v in wallet.labels.items():
 448             if v == to_address:
 449                 to_address = k
 450                 print "alias", to_address
 451                 break
 452             if change_addr and v == change_addr:
 453                 change_addr = k
 454         try:
 455             tx = wallet.mktx( to_address, amount, label, password,
 456                 fee = options.tx_fee, change_addr = change_addr, from_addr = from_addr )
 457         except:
 458             import traceback
 459             traceback.print_exc(file=sys.stdout)
 460             tx = None
 461
 462         if tx and cmd=='payto':
 463             r, h = wallet.sendtx( tx )
 464             print h
 465         else:
 466             print tx
 467
 468         if is_temporary:
 469             wallet.imported_keys.pop(from_addr)
 470             del(wallet.history[from_addr])
 471         wallet.save()
 472
 473     elif cmd == 'sendtx':
 474         tx = args[1]
 475         r, h = wallet.sendtx( tx )
 476         print h
 477
 478     elif cmd == 'password':
 479         try:
 480             seed = wallet.pw_decode( wallet.seed, password)
 481         except:
 482             print "sorry"
 483             sys.exit(1)
 484         new_password = getpass.getpass('New password:')
 485         if new_password == getpass.getpass('Confirm new password:'):
 486             wallet.update_password(seed, password, new_password)
 487         else:
 488             print "error: mismatch"
 489
 490     elif cmd == 'signmessage':
 491         address, message = args[1:3]
 492         print wallet.sign_message(address, message, password)
 493
 494     elif cmd == 'verifymessage':
 495         address, signature, message = args[1:4]
 496         try:
 497             wallet.verify_message(address, signature, message)
 498             print True
 499         except:
 500             print False
 501
 502     elif cmd == 'freeze':
 503         addr = args[1]
 504         print self.wallet.freeze(addr)
 505
 506     elif cmd == 'unfreeze':
 507         addr = args[1]
 508         print self.wallet.unfreeze(addr)
 509
 510     elif cmd == 'prioritize':
 511         addr = args[1]
 512         print self.wallet.prioritize(addr)
 513
 514     elif cmd == 'unprioritize':
 515         addr = args[1]
 516         print self.wallet.unprioritize(addr)
 517