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