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