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