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/>.
21 from decimal import Decimal
23 from transaction import Transaction
26 def __init__(self, name, min_args, max_args, requires_network, requires_wallet, requires_password, description, syntax = '', options_syntax = ''):
28 self.min_args=min_args
29 self.max_args = max_args
30 self.requires_network = requires_network
31 self.requires_wallet = requires_wallet
32 self.requires_password = requires_password
33 self.description = description
35 self.options = options_syntax
38 def register_command(*args):
41 known_commands[name] = Command(*args)
45 payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -F: send from address -\n --changeaddr, -c: send change to address'
46 listaddr_options = " -a: show all addresses, including change addresses\n -l: include labels in results"
47 restore_options = " accepts a seed or master public key."
48 mksendmany_syntax = 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]'
49 payto_syntax = "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label"
50 paytomany_syntax = "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label"
51 signmessage_syntax = '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 "'
52 verifymessage_syntax = '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 "'
59 register_command('contacts', 0, 0, False, True, False, 'Show your list of contacts')
60 register_command('create', 0, 0, False, True, False, 'Create a new wallet')
61 register_command('createmultisig', 2, 2, False, True, False, 'similar to bitcoind\'s command')
62 register_command('createrawtransaction', 2, 2, False, True, False, 'similar to bitcoind\'s command')
63 register_command('deseed', 0, 0, False, True, False, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
64 register_command('decoderawtransaction', 1, 1, False, False, False, 'similar to bitcoind\'s command')
65 register_command('dumpprivkey', 1, 1, False, True, True, 'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
66 register_command('dumpprivkeys', 0, 0, False, True, True, 'dump all private keys')
67 register_command('freeze', 1, 1, False, True, True, 'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
68 register_command('getbalance', 0, 1, True, True, False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
69 register_command('getservers', 0, 0, True, False, False, 'Return the list of available servers')
70 register_command('getversion', 0, 0, False, False, False, 'Return the version of your client', 'getversion')
71 register_command('getaddressbalance', 1, 1, True, False, False, 'Return the balance of an address', 'getaddressbalance <address>')
72 register_command('getaddresshistory', 1, 1, True, False, False, 'Return the transaction history of a wallet address', 'getaddresshistory <address>')
73 register_command('getconfig', 1, 1, False, False, False, 'Return a configuration variable', 'getconfig <name>')
74 register_command('getpubkeys', 1, 1, False, True, False, 'Return the public keys for a wallet address', 'getpubkeys <bitcoin address>')
75 register_command('getrawtransaction', 1, 1, True, False, False, 'Retrieve a transaction', 'getrawtransaction <txhash>')
76 register_command('getseed', 0, 0, False, True, True, 'Print the generation seed of your wallet.')
77 register_command('getmpk', 0, 0, False, True, False, 'Return your wallet\'s master public key', 'getmpk')
78 register_command('help', 0, 1, False, False, False, 'Prints this help')
79 register_command('history', 0, 0, True, True, False, 'Returns the transaction history of your wallet')
80 register_command('importprivkey', 1, 1, False, True, True, 'Import a private key', 'importprivkey <privatekey>')
81 register_command('listaddresses', 2, 2, False, True, False, 'Returns your list of addresses.', '', listaddr_options)
82 register_command('listunspent', 0, 0, True, True, False, 'Returns the list of unspent inputs in your wallet.')
83 register_command('getaddressunspent', 1, 1, True, False, False, 'Returns the list of unspent inputs for an address.')
84 register_command('mktx', 5, 5, False, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
85 register_command('mksendmanytx', 4, 4, False, True, True, 'Create a signed transaction', mksendmany_syntax, payto_options)
86 register_command('payto', 5, 5, True, True, True, 'Create and broadcast a transaction.', payto_syntax, payto_options)
87 register_command('paytomany', 4, 4, True, True, True, 'Create and broadcast a transaction.', paytomany_syntax, payto_options)
88 register_command('password', 0, 0, False, True, True, 'Change your password')
89 register_command('restore', 0, 0, True, True, False, 'Restore a wallet', '', restore_options)
90 register_command('setconfig', 2, 2, False, False, False, 'Set a configuration variable', 'setconfig <name> <value>')
91 register_command('setlabel', 2,-1, False, True, False, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
92 register_command('sendrawtransaction', 1, 1, True, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
93 register_command('signrawtransaction', 1, 3, False, True, True, 'similar to bitcoind\'s command')
94 register_command('signmessage', 2,-1, False, True, True, 'Sign a message with a key', signmessage_syntax)
95 register_command('unfreeze', 1, 1, False, True, False, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
96 register_command('validateaddress', 1, 1, False, False, False, 'Check that the address is valid', 'validateaddress <address>')
97 register_command('verifymessage', 3,-1, False, False, False, 'Verifies a signature', verifymessage_syntax)
99 register_command('encrypt', 2,-1, False, False, False, 'encrypt a message with pubkey','encrypt <pubkey> <message>')
100 register_command('decrypt', 2,-1, False, True, True, 'decrypt a message encrypted with pubkey','decrypt <pubkey> <message>')
101 register_command('daemon', 1, 1, True, False, False, '<stop|status>')
102 register_command('getproof', 1, 1, True, False, False, 'get merkle proof', 'getproof <address>')
103 register_command('getutxoaddress', 2, 2, True, False, False, 'get the address of an unspent transaction output','getutxoaddress <txid> <pos>')
110 def __init__(self, wallet, network, callback = None):
112 self.network = network
113 self._callback = callback
117 def _run(self, method, args, password_getter):
118 cmd = known_commands[method]
119 if cmd.requires_password and self.wallet.use_encryption:
120 self.password = apply(password_getter,())
121 f = getattr(self, method)
125 apply(self._callback, ())
129 def getaddresshistory(self, addr):
130 return self.network.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
133 def daemon(self, arg):
135 return self.network.stop()
138 'server':self.network.main_server(),
139 'connected':self.network.is_connected()
142 return "unknown command \"%s\""% arg
145 def listunspent(self):
147 l = copy.deepcopy(self.wallet.get_unspent_coins())
148 for i in l: i["value"] = str(Decimal(i["value"])/100000000)
152 def getaddressunspent(self, addr):
153 return self.network.synchronous_get([ ('blockchain.address.listunspent',[addr]) ])[0]
156 def getutxoaddress(self, txid, num):
157 r = self.network.synchronous_get([ ('blockchain.utxo.get_address',[txid, num]) ])
159 return {'address':r[0] }
162 def createrawtransaction(self, inputs, outputs):
163 inputs = map(lambda i: {'prevout_hash': i['txid'], 'prevout_n':i['vout']}, inputs )
164 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
165 tx = Transaction.from_io(inputs, outputs)
169 def signrawtransaction(self, raw_tx, input_info, private_keys):
170 tx = Transaction(raw_tx)
171 self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
174 def decoderawtransaction(self, raw):
175 tx = Transaction(raw)
176 return tx.deserialize()
178 def sendrawtransaction(self, raw):
179 tx = Transaction(raw)
180 return self.network.synchronous_get([('blockchain.transaction.broadcast', [str(tx)])])[0]
182 def createmultisig(self, num, pubkeys):
183 assert isinstance(pubkeys, list)
184 redeem_script = Transaction.multisig_script(pubkeys, num)
185 address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
186 return {'address':address, 'redeemScript':redeem_script}
188 def freeze(self,addr):
189 return self.wallet.freeze(addr)
191 def unfreeze(self,addr):
192 return self.wallet.unfreeze(addr)
194 def dumpprivkey(self, addr):
195 return self.wallet.get_private_key(addr, self.password)
197 def dumpprivkeys(self, addresses = None):
198 if addresses is None:
199 addresses = self.wallet.addresses(True)
200 return [self.wallet.get_private_key(address, self.password) for address in addresses]
202 def validateaddress(self, addr):
203 isvalid = is_valid(addr)
204 out = { 'isvalid':isvalid }
206 out['address'] = addr
209 def getpubkeys(self, addr):
210 out = { 'address':addr }
211 out['pubkeys'] = self.wallet.getpubkeys(addr)
215 def getbalance(self, account= None):
217 c, u = self.wallet.get_balance()
219 c, u = self.wallet.get_account_balance(account)
221 out = { "confirmed": str(Decimal(c)/100000000) }
222 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
225 def getaddressbalance(self, addr):
226 out = self.network.synchronous_get([ ('blockchain.address.get_balance',[addr]) ])[0]
227 out["confirmed"] = str(Decimal(out["confirmed"])/100000000)
228 out["unconfirmed"] = str(Decimal(out["unconfirmed"])/100000000)
232 def getproof(self, addr):
233 p = self.network.synchronous_get([ ('blockchain.address.get_proof',[addr]) ])[0]
239 def getservers(self):
240 return self.network.get_servers()
242 def getversion(self):
244 return electrum.ELECTRUM_VERSION
247 return self.wallet.get_master_public_key()
250 mnemonic = self.wallet.get_mnemonic(self.password)
251 seed = self.wallet.get_seed(self.password)
252 return { 'mnemonic':mnemonic, 'seed':seed, 'version':self.wallet.seed_version }
254 def importprivkey(self, sec):
256 addr = self.wallet.import_key(sec,self.password)
257 out = "Keypair imported: ", addr
258 except Exception as e:
259 out = "Error: Keypair import failed: " + str(e)
263 def signmessage(self, address, message):
264 return self.wallet.sign_message(address, message, self.password)
267 def verifymessage(self, address, signature, message):
268 return bitcoin.verify_message(address, signature, message)
271 def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
273 for to_address, amount in outputs:
274 if not is_valid(to_address):
275 raise Exception("Invalid Bitcoin address", to_address)
278 if not is_valid(change_addr):
279 raise Exception("Invalid Bitcoin address", change_addr)
281 if domain is not None:
283 if not is_valid(addr):
284 raise Exception("invalid Bitcoin address", addr)
286 if not self.wallet.is_mine(addr):
287 raise Exception("address not in wallet", addr)
289 for k, v in self.wallet.labels.items():
290 if change_addr and v == change_addr:
294 for to_address, amount in outputs:
295 for k, v in self.wallet.labels.items():
298 print_msg("alias", to_address)
301 amount = int(100000000*amount)
302 final_outputs.append((to_address, amount))
304 if fee: fee = int(100000000*fee)
305 return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
308 def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
309 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
312 def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
313 tx = self._mktx(outputs, fee, change_addr, domain)
317 def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
318 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
319 r, h = self.wallet.sendtx( tx )
322 def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
323 tx = self._mktx(outputs, fee, change_addr, domain)
324 r, h = self.wallet.sendtx( tx )
332 for item in self.wallet.get_tx_history():
333 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
335 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
339 label, is_default_label = self.wallet.get_label(tx_hash)
341 out.append({'txid':tx_hash, 'date':"%16s"%time_str, 'label':label, 'value':format_satoshis(value)})
346 def setlabel(self, key, label):
347 self.wallet.set_label(key, label)
353 for addr in self.wallet.addressbook:
354 c[addr] = self.wallet.labels.get(addr)
358 def listaddresses(self, show_all = False, show_label = False):
360 for addr in self.wallet.addresses(True):
361 if show_all or not self.wallet.is_change(addr):
363 item = { 'address': addr }
365 label = self.wallet.labels.get(addr,'')
367 item['label'] = label
373 def help(self, cmd=None):
374 if cmd not in known_commands:
375 print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
377 cmd = known_commands[cmd]
378 print_msg(cmd.description)
379 if cmd.syntax: print_msg("Syntax: " + cmd.syntax)
380 if cmd.options: print_msg("options:\n" + cmd.options)
384 def getrawtransaction(self, tx_hash):
387 tx = self.wallet.transactions.get(tx_hash)
391 r = self.network.synchronous_get([ ('blockchain.transaction.get',[tx_hash]) ])[0]
393 return transaction.Transaction(r)
395 return "unknown transaction"
398 def encrypt(self, pubkey, message):
399 return bitcoin.encrypt_message(message, pubkey)
402 def decrypt(self, pubkey, message):
403 return self.wallet.decrypt_message(pubkey, message, self.password)