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/>.
19 from decimal import Decimal
29 import ecdsa # todo: 'ecdsa' imported but unused
31 sys.exit("Error: python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'")
34 import aes # todo: 'aes' imported but unused
36 sys.exit("Error: AES does not seem to be installed. Try 'sudo pip install slowaes'")
39 is_local = os.path.dirname(os.path.realpath(__file__)) == os.getcwd()
40 is_android = 'ANDROID_DATA' in os.environ
43 __builtin__.use_local_modules = is_local or is_android
45 # load local module as electrum
46 if __builtin__.use_local_modules:
48 imp.load_module('electrum', *imp.find_module('lib'))
49 imp.load_module('electrum_gui', *imp.find_module('gui'))
51 from electrum import * # todo: import * is generally frowned upon. should import just what is used
54 # get password routine
55 def prompt_password(prompt, confirm=True):
57 if sys.stdin.isatty():
58 password = getpass.getpass(prompt)
59 if password and confirm:
60 password2 = getpass.getpass("Confirm: ")
61 if password != password2:
62 sys.exit("Error: Passwords do not match.")
64 password = raw_input(prompt)
71 usage = "%prog [options] command"
72 parser = optparse.OptionParser(prog=usage, add_help_option=False)
73 parser.add_option("-h", "--help", action="callback", callback=print_help_cb, help="show this help text")
74 parser.add_option("-g", "--gui", dest="gui", help="User interface: qt, lite, gtk, text or stdio")
75 parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
76 parser.add_option("-o", "--offline", action="store_true", dest="offline", default=False, help="remain offline")
77 parser.add_option("-C", "--concealed", action="store_true", dest="concealed", default=False, help="don't echo seed to console when restoring")
78 parser.add_option("-a", "--all", action="store_true", dest="show_all", default=False, help="show all addresses")
79 parser.add_option("-l", "--labels", action="store_true", dest="show_labels", default=False, help="show the labels of listed addresses")
80 parser.add_option("-f", "--fee", dest="tx_fee", default=None, help="set tx fee")
81 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.")
82 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")
83 parser.add_option("-s", "--server", dest="server", default=None, help="set server host:port:protocol, where protocol is either t (tcp), h (http), s (tcp+ssl), or g (https)")
84 parser.add_option("-p", "--proxy", dest="proxy", default=None, help="set proxy [type:]host[:port], where type is socks4,socks5 or http")
85 parser.add_option("-v", "--verbose", action="store_true", dest="verbose", default=False, help="show debugging information")
86 parser.add_option("-P", "--portable", action="store_true", dest="portable", default=False, help="portable wallet")
87 parser.add_option("-L", "--lang", dest="language", default=None, help="defaut language used in GUI")
88 parser.add_option("-u", "--usb", dest="bitkey", action="store_true", help="Turn on support for hardware wallets (EXPERIMENTAL)")
89 parser.add_option("-G", "--gap", dest="gap_limit", default=None, help="gap limit")
90 parser.add_option("-W", "--password", dest="password", default=None, help="set password for usage with commands (currently only implemented for create command, do not use it for longrunning gui session since the password is visible in /proc)")
91 parser.add_option("-1", "--oneserver", action="store_true", dest="oneserver", default=False, help="connect to one server only")
95 def print_help(parser):
97 print_msg("Type 'electrum help <command>' to see the help for a specific command")
98 print_msg("Type 'electrum --help' to see the list of options")
103 def print_help_cb(self, opt, value, parser):
107 def run_command(cmd, password=None, args=[]):
108 import xmlrpclib, socket
109 cmd_runner = Commands(wallet, network)
110 func = getattr(cmd_runner, cmd.name)
111 cmd_runner.password = password
113 if cmd.requires_network and not options.offline:
114 cmd_runner.network = xmlrpclib.ServerProxy('http://localhost:8000')
116 wallet.start_threads(cmd_runner.network)
119 cmd_runner.network = None
122 result = func(*args[1:])
124 print "Daemon not running"
127 traceback.print_exc(file=sys.stdout)
131 if cmd.requires_network and not options.offline:
133 wallet.stop_threads()
136 if type(result) == str:
137 util.print_msg(result)
138 elif result is not None:
139 util.print_json(result)
142 if __name__ == '__main__':
144 parser = arg_parser()
145 options, args = parser.parse_args()
146 if options.portable and options.wallet_path is None:
147 options.electrum_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'electrum_data')
149 # config is an object passed to the various constructors (wallet, interface, gui)
158 config_options = eval(str(options))
159 for k, v in config_options.items():
161 config_options.pop(k)
163 set_verbosity(config_options.get('verbose'))
165 config = SimpleConfig(config_options)
170 elif len(args) == 1 and re.match('^bitcoin:', args[0]):
177 gui_name = config.get('gui', 'classic')
178 if gui_name in ['lite', 'classic']:
181 gui = __import__('electrum_gui.' + gui_name, fromlist=['electrum_gui'])
183 traceback.print_exc(file=sys.stdout)
185 #sys.exit("Error: Unknown GUI: " + gui_name )
188 if not options.offline:
189 network = Network(config)
194 gui = gui.ElectrumGui(config, network)
200 # we use daemon threads, their termination is enforced.
201 # this sleep command gives them time to terminate cleanly.
205 if cmd not in known_commands:
208 cmd = known_commands[cmd]
210 # instanciate wallet for command-line
211 storage = WalletStorage(config)
214 if cmd.name in ['create', 'restore']:
215 if storage.file_exists:
216 sys.exit("Error: Remove the existing wallet first!")
217 if options.password is not None:
218 password = options.password
220 password = prompt_password("Password (hit return if you do not wish to encrypt your wallet):")
222 # if config.server is set, the user either passed the server on command line
223 # or chose it previously already. if he didn't pass a server on the command line,
224 # we just pick up a random one.
225 if not config.get('server'):
226 config.set_key('server', pick_random_server())
228 #fee = options.tx_fee if options.tx_fee else raw_input("fee (default:%s):" % (str(Decimal(wallet.fee)/100000000)))
229 #gap = options.gap_limit if options.gap_limit else raw_input("gap limit (default 5):")
231 # wallet.set_fee(float(fee)*100000000)
233 # wallet.change_gap_limit(int(gap))
235 if cmd.name == 'restore':
237 seed = getpass.getpass(prompt="seed:", stream=None) if options.concealed else raw_input("seed:")
238 wallet = Wallet.from_seed(str(seed),storage)
240 sys.exit("Error: Invalid seed")
241 wallet.save_seed(password)
242 if not options.offline:
243 network = Network(config)
245 wallet.start_threads(network)
246 print_msg("Recovering wallet...")
247 wallet.restore(lambda x: x)
248 if wallet.is_found():
249 print_msg("Recovery successful")
251 print_msg("Warning: Found no history for this wallet")
254 print_msg("Warning: This wallet was restored offline. It may contain more addresses than displayed.")
257 wallet = Wallet(storage)
258 wallet.init_seed(None)
259 wallet.save_seed(password)
261 print_msg("Your wallet generation seed is:\n\"%s\"" % wallet.get_mnemonic(password))
262 print_msg("Please keep it in a safe place; if you lose it, you will not be able to restore your wallet.")
264 print_msg("Wallet saved in '%s'" % wallet.storage.path)
270 if cmd.name not in ['create', 'restore'] and cmd.requires_wallet and not storage.file_exists:
271 print_msg("Error: Wallet file not found.")
272 print_msg("Type 'electrum create' to create a new wallet, or provide a path to a wallet with the -w option")
276 if cmd.requires_wallet:
277 wallet = Wallet(storage)
283 if cmd.name in ['dumpprivkey', 'dumpprivkeys']:
284 print_msg("WARNING: ALL your private keys are secret.")
285 print_msg("Exposing a single private key can compromise your entire wallet!")
286 print_msg("In particular, DO NOT use 'redeem private key' services proposed by third parties.")
288 # commands needing password
289 if cmd.requires_password:
290 if wallet.seed == '':
293 elif wallet.use_encryption:
294 password = prompt_password('Password:', False)
296 print_msg("Error: Password required")
300 seed = wallet.get_seed(password)
302 print_msg("Error: This password does not decode this wallet.")
306 seed = wallet.get_seed(None)
310 # add missing arguments, do type conversions
311 if cmd.name == 'importprivkey':
312 # See if they specificed a key on the cmd line, if not prompt
314 args[1] = prompt_password('Enter PrivateKey (will not echo):', False)
316 elif cmd.name == 'signrawtransaction':
317 args = [cmd, args[1], json.loads(args[2]) if len(args) > 2 else [], json.loads(args[3]) if len(args) > 3 else []]
319 elif cmd.name == 'createmultisig':
320 args = [cmd, int(args[1]), json.loads(args[2])]
322 elif cmd.name == 'createrawtransaction':
323 args = [cmd, json.loads(args[1]), json.loads(args[2])]
325 elif cmd.name == 'listaddresses':
326 args = [cmd, options.show_all, options.show_labels]
328 elif cmd.name in ['payto', 'mktx']:
329 domain = [options.from_addr] if options.from_addr else None
330 args = ['mktx', args[1], Decimal(args[2]), Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain]
332 elif cmd.name in ['paytomany', 'mksendmanytx']:
333 domain = [options.from_addr] if options.from_addr else None
335 for i in range(1, len(args), 2):
337 print_msg("Error: Mismatched arguments.")
339 outputs.append((args[i], Decimal(args[i+1])))
340 args = ['mksendmanytx', outputs, Decimal(options.tx_fee) if options.tx_fee else None, options.change_addr, domain]
342 elif cmd.name == 'help':
346 # check the number of arguments
347 if len(args) - 1 < cmd.min_args:
348 print_msg("Not enough arguments")
349 print_msg("Syntax:", cmd.syntax)
352 if cmd.max_args >= 0 and len(args) - 1 > cmd.max_args:
353 print_msg("too many arguments", args)
354 print_msg("Syntax:", cmd.syntax)
358 if len(args) > cmd.min_args + 1:
359 message = ' '.join(args[cmd.min_args:])
360 print_msg("Warning: Final argument was reconstructed from several arguments:", repr(message))
361 args = args[0:cmd.min_args] + [message]
364 if cmd.name == 'daemon' and args[1] == 'start':
366 if (pid == 0): # The first child.
371 if (pid2 == 0): # Second child
372 from SimpleXMLRPCServer import SimpleXMLRPCServer
374 network = Network(config)
375 if not network.start(wait=True):
376 print_msg("Not connected, aborting.")
378 print_msg("Connected to " + network.interface.connection_msg)
379 server = SimpleXMLRPCServer(('localhost',8000), allow_none=True, logRequests=False)
380 server.register_function(network.synchronous_get, 'synchronous_get')
381 server.register_function(network.get_servers, 'get_servers')
382 server.register_function(network.main_server, 'main_server')
383 server.register_function(network.send, 'send')
384 server.register_function(network.subscribe, 'subscribe')
385 server.register_function(network.is_connected, 'is_connected')
386 server.register_function(network.is_up_to_date, 'is_up_to_date')
387 server.register_function(lambda: setattr(server,'running', False), 'stop')
388 server.running = True
389 while server.running:
390 server.handle_request()
391 print_msg("Daemon stopped")
396 if cmd.name == 'deseed':
398 print_msg("Error: This wallet has no seed")
400 ns = wallet.storage.path + '.seedless'
401 print_msg("Warning: you are going to create a seedless wallet'\nIt will be saved in '%s'" % ns)
402 if raw_input("Are you sure you want to continue? (y/n) ") in ['y', 'Y', 'yes']:
403 wallet.storage.path = ns
405 wallet.storage.put('seed', '', True)
406 wallet.use_encryption = False
407 wallet.storage.put('use_encryption', wallet.use_encryption, True)
408 for k in wallet.imported_keys.keys():
409 wallet.imported_keys[k] = ''
410 wallet.storage.put('imported_keys', wallet.imported_keys, True)
413 print_msg("Action canceled.")
415 elif cmd.name == 'getconfig':
417 out = config.get(key)
420 elif cmd.name == 'setconfig':
421 key, value = args[1:3]
422 config.set_key(key, value, True)
425 elif cmd.name == 'password':
426 new_password = prompt_password('New password:')
427 wallet.update_password(password, new_password)
430 run_command(cmd, password, args)