3 # Electrum - lightweight Bitcoin client
4 # Copyright (C) 2011 thomasv@gitorious
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.
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.
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/>.
20 import sys, os, time, ast
27 sys.exit("Error: python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'")
32 sys.exit("Error: AES does not seem to be installed. Try 'sudo pip install slowaes'")
37 from electrum import *
39 from decimal import Decimal
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
54 'Broadcasts a transaction to the network. \nSyntax: sendrawtransaction <tx in hexadecimal>',
56 "Changes your password",
58 """Shows your list of addresses.
60 -a: show all addresses, including change addresses
62 -b: show the balance of addresses""",
64 'history':"Shows the transaction history",
65 'label':'Assign a label to an item\nSyntax: label <tx_hash> <label>',
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
72 "Print the generation seed of your wallet.",
74 'Import a private key\nSyntax: importprivkey <privatekey>',
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 "',
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 "',
80 "Run python eval() on an object\nSyntax: eval <expression>\nExample: eval \"wallet.aliases\"",
82 "Get config parameter.",
84 "Set config parameter.",
86 "Create a seedless, watching-only wallet.",
91 'dumpprivkey':'similar to bitcoind\'s command',
92 'listunspent':'similar to bitcoind\'s command',
93 'createmultisig':'similar to bitcoind\'s command',
94 'createrawtransaction':'similar to bitcoind\'s command',
95 'decoderawtransaction':'similar to bitcoind\'s command',
96 'signrawtransaction':'similar to bitcoind\'s command',
102 offline_commands = [ 'password', 'mktx',
104 'help', 'validateaddress',
105 'signmessage', 'verifymessage',
106 'eval', 'set', 'get', 'create', 'addresses',
107 'importprivkey', 'seed',
110 'prioritize','unprioritize',
111 'dumpprivkey','listunspent',
112 'createmultisig', 'createrawtransaction', 'decoderawtransaction', 'signrawtransaction'
116 protected_commands = ['payto', 'password', 'mktx', 'seed', 'importprivkey','signmessage', 'signrawtransaction','dumpprivkey' ]
118 # get password routine
119 def prompt_password(prompt, confirm=True):
121 if sys.stdin.isatty():
122 password = getpass.getpass(prompt)
123 if password and confirm:
124 password2 = getpass.getpass("Confirm: ")
125 if password != password2:
126 sys.exit("Error: Passwords do not match.")
128 password = raw_input(prompt)
134 usage = "usage: %prog [options] command\nCommands: "+ (', '.join(known_commands))
135 parser = optparse.OptionParser(prog=usage)
136 parser.add_option("-g", "--gui", dest="gui", help="User interface: qt, lite, gtk or text")
137 parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
138 parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
139 parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
140 parser.add_option("-b", "--balance", action="store_true", dest="show_balance", default=False, help="show the balance at listed addresses")
141 parser.add_option("-k", "--keys",action="store_true", dest="show_keys",default=False, help="show the private keys of listed addresses")
142 parser.add_option("-f", "--fee", dest="tx_fee", default="0.005", help="set tx fee")
143 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.")
144 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")
145 parser.add_option("-s", "--server", dest="server", default=None, help="set server host:port:protocol, where protocol is t or h")
146 parser.add_option("-p", "--proxy", dest="proxy", default=None, help="set proxy [type:]host[:port], where type is socks4,socks5 or http")
147 parser.add_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="show debugging information")
148 parser.add_option("-P", "--portable", action="store_true", dest="portable", default=False, help="portable wallet")
149 parser.add_option("-L", "--lang", dest="language", default=None, help="defaut language used in GUI")
150 parser.add_option("-u", "--usb", dest="bitkey", action="store_true", help="Turn on support for hardware wallets (EXPERIMENTAL)")
154 if __name__ == '__main__':
156 parser = arg_parser()
157 options, args = parser.parse_args()
158 set_verbosity(options.verbose)
160 # config is an object passed to the various constructors (wallet, interface, gui)
161 if 'ANDROID_DATA' in os.environ:
162 config_options = {'wallet_path':"/sdcard/electrum.dat", 'portable':True, 'verbose':True, 'gui':'android'}
164 config_options = eval(str(options))
165 for k, v in config_options.items():
166 if v is None: config_options.pop(k)
168 # Wallet migration on Electrum 1.7
169 # Todo: In time we could remove this again
170 if platform.system() == "Windows":
171 util.check_windows_wallet_migration()
173 config = SimpleConfig(config_options)
174 wallet = Wallet(config)
179 elif len(args)==1 and re.match('^bitcoin:', args[0]):
184 firstarg = args[1] if len(args) > 1 else ''
186 #this entire if/else block is just concerned with importing the
187 #right GUI toolkit based the GUI command line option given
189 pref_gui = config.get('gui','classic')
191 if pref_gui == 'gtk':
193 import lib.gui as gui
195 import electrum.gui as gui
196 elif pref_gui in ['classic', 'qt']:
198 import lib.gui_qt as gui
200 import electrum.gui_qt as gui
201 elif pref_gui == 'lite':
203 import lib.gui_lite as gui
205 import electrum.gui_lite as gui
206 elif pref_gui == 'text':
208 import lib.gui_text as gui
210 import electrum.gui_text as gui
211 elif pref_gui == 'android':
213 import lib.gui_android as gui
215 import electrum.gui_android as gui
217 sys.exit("Error: Unknown GUI: " + pref_gui )
220 interface = Interface(config, True)
221 wallet.interface = interface
223 if interface.is_connected:
224 interface.send([('server.peers.subscribe',[])])
226 set_language(config.get('language'))
227 gui = gui.ElectrumGui(wallet, config)
229 found = config.wallet_file_exists
231 a = gui.restore_or_create()
234 s = gui.network_dialog()
237 wallet.init_seed(None)
239 # ask for seed and gap.
240 sg = gui.seed_dialog()
244 wallet.gap_limit = gap
247 wallet.sequence.master_public_key = seed
249 wallet.init_seed(str(seed))
252 # generate the first addresses, in case we are offline
253 if s is None or a == 'create':
259 verifier = WalletVerifier(interface, config)
260 wallet.set_verifier(verifier)
261 synchronizer = WalletSynchronizer(wallet, config)
264 if not found and a == 'restore' and s is not None:
266 keep_it = gui.restore_wallet()
267 wallet.fill_addressbook()
270 traceback.print_exc(file=sys.stdout)
273 if not keep_it: exit()
276 gui.password_dialog()
287 # we use daemon threads, their termination is enforced.
288 # this sleep command gives them time to terminate cleanly.
292 if cmd not in known_commands:
295 if not config.wallet_file_exists and cmd not in ['help','create','restore']:
296 print_msg("Error: Wallet file not found.")
297 print_msg("Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option")
300 if cmd in ['create', 'restore']:
301 if config.wallet_file_exists:
302 sys.exit("Error: Remove the existing wallet first!")
303 password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
305 server = config.get('server')
306 if not server: server = pick_random_server()
307 w_host, w_port, w_protocol = server.split(':')
308 host = raw_input("server (default:%s):"%w_host)
309 port = raw_input("port (default:%s):"%w_port)
310 protocol = raw_input("protocol [t=tcp;h=http;n=native] (default:%s):"%w_protocol)
311 fee = raw_input("fee (default:%s):"%( str(Decimal(wallet.fee)/100000000)) )
312 gap = raw_input("gap limit (default 5):")
313 if host: w_host = host
314 if port: w_port = port
315 if protocol: w_protocol = protocol
316 wallet.config.set_key('server', w_host + ':' + w_port + ':' +w_protocol)
317 if fee: wallet.fee = float(fee)
318 if gap: wallet.gap_limit = int(gap)
321 seed = raw_input("seed:")
325 print_error("Warning: Not hex, trying decode.")
326 seed = mnemonic_decode( seed.split(' ') )
328 sys.exit("Error: No seed")
332 wallet.sequence.master_public_key = seed
334 wallet.seed = str(seed)
335 wallet.init_mpk( wallet.seed )
337 if not options.offline:
338 interface = Interface(config)
340 wallet.interface = interface
342 verifier = WalletVerifier(interface, config)
343 wallet.set_verifier(verifier)
345 print_msg("Recovering wallet...")
346 WalletSynchronizer(wallet, config).start()
348 if wallet.is_found():
349 print_msg("Recovery successful")
351 print_msg("Warning: Found no history for this wallet")
354 wallet.fill_addressbook()
356 print_msg("Wallet saved in '%s'"%wallet.config.path)
358 wallet.init_seed(None)
359 wallet.synchronize() # there is no wallet thread
361 print_msg("Your wallet generation seed is: " + wallet.seed)
362 print_msg("Please keep it in a safe place; if you lose it, you will not be able to restore your wallet.")
363 print_msg("Equivalently, your wallet seed can be stored and recovered with the following mnemonic code:")
364 print_msg("\""+' '.join(mnemonic_encode(wallet.seed))+"\"")
365 print_msg("Wallet saved in '%s'"%wallet.config.path)
368 wallet.update_password(wallet.seed, None, password)
371 if cmd in ['payto', 'mktx']:
374 amount = int( 100000000 * Decimal(args[2]) )
376 label = ' '.join(args[3:])
378 options.tx_fee = int( 100000000 * Decimal(options.tx_fee) )
384 if cmd not in offline_commands and not options.offline:
385 interface = Interface(config)
386 interface.register_callback('connected', lambda: sys.stderr.write("Connected to " + interface.connection_msg + "\n"))
388 wallet.interface = interface
389 synchronizer = WalletSynchronizer(wallet, config)
394 # check if --from_addr not in wallet (for mktx/payto)
397 if options.from_addr:
398 from_addr = options.from_addr
399 if from_addr not in wallet.all_addresses():
403 if cmd=='addresses' and options.show_keys:
404 print_msg("WARNING: ALL your private keys are secret.")
405 print_msg("Exposing a single private key can compromise your entire wallet!")
406 print_msg("In particular, DO NOT use 'redeem private key' services proposed by third parties.")
408 # commands needing password
409 if cmd in protected_commands or ( cmd=='addresses' and options.show_keys):
410 if wallet.use_encryption and not is_temporary:
411 password = prompt_password('Password:', False)
413 print_msg("Error: Password required")
417 seed = wallet.decode_seed(password)
419 print_msg("Error: This password does not decode this wallet.")
425 if cmd == 'importprivkey':
426 # See if they specificed a key on the cmd line, if not prompt
430 sec = prompt_password('Enter PrivateKey (will not echo):', False)
432 addr = wallet.import_key(sec,password)
434 print_msg("Keypair imported: ", addr)
435 except BaseException as e:
436 print_msg("Error: Keypair import failed: " + str(e))
440 if cmd2 not in known_commands:
442 print_msg("Type 'electrum help <command>' to see the help for a specific command")
443 print_msg("Type 'electrum --help' to see the list of options")
444 print_msg("List of commands:", ', '.join(known_commands))
446 print_msg(known_commands[cmd2])
449 print_msg(seed + ' "' + ' '.join(mnemonic_encode(seed)) + '"')
451 elif cmd == 'deseed':
453 print_msg("Error: This wallet has no seed")
455 ns = wallet.config.path + '.seedless'
456 print_msg("Warning: you are going to create a seedless wallet'\nIt will be saved in '%s'"%ns)
457 if raw_input("Are you sure you want to continue? (y/n) ") in ['y','Y','yes']:
458 wallet.config.path = ns
460 wallet.config.set_key('seed','', True)
461 for k in wallet.imported_keys.keys(): wallet.imported_keys[k] = ''
465 print_msg("Action canceled.")
468 elif cmd == 'validateaddress':
470 is_valid = wallet.is_valid(addr)
471 out = { 'isvalid':is_valid }
473 is_mine = wallet.is_mine(addr)
474 out['address'] = addr
475 out['ismine'] = is_mine
477 out['pubkey'] = wallet.get_public_key(addr)
481 elif cmd == 'balance':
487 c, u = wallet.get_balance()
489 print_msg(Decimal( c ) / 100000000 , Decimal( u ) / 100000000)
491 print_msg(Decimal( c ) / 100000000)
494 c, u = wallet.get_addr_balance(addr)
496 print_msg("%s %s, %s" % (addr, str(Decimal(c)/100000000), str(Decimal(u)/100000000)))
498 print_msg("%s %s" % (addr, str(Decimal(c)/100000000)))
500 elif cmd in [ 'contacts']:
501 for addr in wallet.addressbook:
502 print_msg(addr, " ", wallet.labels.get(addr))
505 print_msg(eval(args[1]))
510 print_msg(wallet.config.get(key))
513 key, value = args[1:3]
514 if key not in ['seed', 'seed_version', 'master_public_key', 'use_encryption']:
515 wallet.config.set_key(key, value, True)
520 elif cmd in [ 'addresses']:
521 for addr in wallet.all_addresses():
522 if options.show_all or not wallet.is_change(addr):
524 flags = wallet.get_address_flags(addr)
525 label = wallet.labels.get(addr,'')
527 if label: label = "\"%s\""%label
529 if options.show_balance:
530 h = wallet.history.get(addr,[])
533 # if item['is_input']: ni += 1
535 b = format_satoshis(wallet.get_addr_balance(addr)[0])
538 if options.show_keys:
539 m_addr += ':' + str(wallet.get_private_key(addr, password))
540 print_msg(flags, m_addr, b, label)
545 for item in wallet.get_tx_history():
546 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
548 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
552 label, is_default_label = wallet.get_label(tx_hash)
553 if not label: label = tx_hash
554 else: label = label + ' '*(64 - len(label) )
556 print_msg("%17s"%time_str, " " + label + " " + format_satoshis(value)+ " "+ format_satoshis(balance))
557 print_msg("# balance: ", format_satoshis(balance))
562 label = ' '.join(args[2:])
564 print_msg("Error. Syntax: label <tx_hash> <text>")
566 wallet.labels[tx] = label
569 elif cmd in ['payto', 'mktx']:
570 if from_addr and is_temporary:
571 if from_addr.find(":") == -1:
572 keypair = from_addr + ":" + prompt_password('Private key:', False)
575 from_addr = keypair.split(':')[0]
576 if not wallet.import_key(keypair,password):
577 print_msg("Error: Invalid key pair")
579 wallet.history[from_addr] = interface.retrieve_history(from_addr)
580 wallet.update_tx_history()
581 change_addr = from_addr
583 if options.change_addr:
584 change_addr = options.change_addr
586 for k, v in wallet.labels.items():
589 print_msg("alias", to_address)
591 if change_addr and v == change_addr:
594 tx = wallet.mktx( [(to_address, amount)], label, password,
595 fee = options.tx_fee, change_addr = change_addr, from_addr = from_addr )
598 traceback.print_exc(file=sys.stdout)
601 if tx and cmd=='payto':
602 r, h = wallet.sendtx( tx )
605 out = {"hex":str(tx), "complete":tx.is_complete}
606 if not tx.is_complete:
608 out['input_info'] = repr(tx.input_info).replace(' ','')
612 wallet.imported_keys.pop(from_addr)
613 del(wallet.history[from_addr])
616 elif cmd == 'sendrawtransaction':
617 tx = Transaction(args[1])
618 r, h = wallet.sendtx( tx )
621 elif cmd == 'password':
622 new_password = prompt_password('New password:')
623 wallet.update_password(seed, password, new_password)
625 elif cmd == 'signmessage':
627 print_msg("Error: Invalid usage of signmessage.")
628 print_msg(known_commands[cmd])
631 message = ' '.join(args[2:])
633 print_msg("Warning: Message was reconstructed from several arguments:", repr(message))
635 print_msg(wallet.sign_message(address, message, password))
637 elif cmd == 'verifymessage':
641 message = ' '.join(args[3:])
643 print_msg("Error: Not all parameters were given, displaying help instead.")
644 print_msg(known_commands[cmd])
647 print_msg("Warning: Message was reconstructed from several arguments:", repr(message))
648 EC_KEY.verify_message(address, signature, message)
650 EC_KEY.verify_message(address, signature, message)
652 except BaseException as e:
653 print_error("Verification error: {0}".format(e))
656 elif cmd == 'freeze':
658 print_msg(wallet.freeze(addr))
660 elif cmd == 'unfreeze':
662 print_msg(wallet.unfreeze(addr))
664 elif cmd == 'prioritize':
666 print_msg(wallet.prioritize(addr))
668 elif cmd == 'unprioritize':
670 print_msg(wallet.unprioritize(addr))
673 elif cmd == 'dumpprivkey':
675 sec = wallet.get_private_key(addr, password)
679 elif cmd == 'createmultisig':
681 pubkeys = ast.literal_eval(args[2])
682 assert isinstance(pubkeys,list)
683 print_json( Transaction.multisig_script(pubkeys, num) )
686 elif cmd == 'createrawtransaction':
687 inputs = ast.literal_eval(args[1])
688 outputs = ast.literal_eval(args[2])
689 # convert to own format
691 i['tx_hash'] = i['txid']
692 i['index'] = i['vout']
693 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
694 tx = Transaction.from_io(inputs, outputs)
698 elif cmd == 'decoderawtransaction':
699 tx = Transaction(args[1])
700 print_json( tx.deserialize() )
703 elif cmd == 'signrawtransaction':
704 tx = Transaction(args[1])
705 input_info = ast.literal_eval(args[2]) if len(args)>2 else []
706 private_keys = ast.literal_eval(args[3]) if len(args)>3 else []
707 unspent_coins = wallet.get_unspent_coins()
709 # convert private_keys to dict
711 for sec in private_keys:
712 address = bitcoin.address_from_private_key(sec)
716 for txin in tx.inputs:
717 # convert to own format
718 txin['tx_hash'] = txin['prevout_hash']
719 txin['index'] = txin['prevout_n']
721 for item in input_info:
722 if item.get('txid') == txin['tx_hash'] and item.get('vout') == txin['index']:
723 txin['raw_output_script'] = item['scriptPubKey']
724 txin['redeemScript'] = item.get('redeemScript')
725 txin['electrumKeyID'] = item.get('electrumKeyID')
728 for item in unspent_coins:
729 if txin['tx_hash'] == item['tx_hash'] and txin['index'] == item['index']:
730 txin['raw_output_script'] = item['raw_output_script']
733 # if neither, we might want to get it from the server..
737 from lib import deserialize
738 if txin.get('electrumKeyID'):
739 n, for_change = txin.get('electrumKeyID')
740 sec = wallet.sequence.get_private_key(n, for_change, seed)
741 address = bitcoin.address_from_private_key(sec)
742 txin['address'] = address
743 private_keys[address] = sec
745 elif txin.get("redeemScript"):
746 txin['address'] = bitcoin.hash_160_to_bc_address(bitcoin.hash_160(txin.get("redeemScript").decode('hex')), 5)
748 elif txin.get("raw_output_script"):
749 addr = deserialize.get_address_from_output_script(txin.get("raw_output_script").decode('hex'))
750 sec = wallet.get_private_key(addr, password)
752 private_keys[addr] = sec
753 txin['address'] = addr
755 tx.sign( private_keys )
756 print_json({ "hex":str(tx),"complete":tx.is_complete})
759 elif cmd == 'listunspent':
760 print_json(wallet.get_unspent_coins())
763 if cmd not in offline_commands and not options.offline: