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