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