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
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, -s: send from address -\n --changeaddr, -c: send change to address'
46 listaddr_options = " -a: show all addresses, including change addresses\n -b: include balance in results\n -l: include labels in results"
47 restore_options = " accepts a seed or master public key."
48 config_options = " accounts, addr_history, auto_cycle, column_widths, console-history, contacts,\n fee_per_kb, frozen_addresses, gap_limit, imported_keys, labels,\n master_public_key, num_zeros, prioritized_addresses, proxy, seed,\n seed_version, server, transactions, use_change, use_encryption, winpos-qt"
49 mksendmany_syntax = 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]'
50 payto_syntax = "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label"
51 paytomany_syntax = "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label"
52 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 "'
53 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 "'
60 register_command('contacts', 0, 0, False, True, False, 'Show your list of contacts')
61 register_command('create', 0, 0, False, True, False, 'Create a new wallet')
62 register_command('createmultisig', 2, 2, False, True, False, 'similar to bitcoind\'s command')
63 register_command('createrawtransaction', 2, 2, False, True, False, 'similar to bitcoind\'s command')
64 register_command('deseed', 0, 0, False, True, False, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
65 register_command('decoderawtransaction', 1, 1, False, False, False, 'similar to bitcoind\'s command')
66 register_command('dumpprivkey', 1, 1, False, True, True, 'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
67 register_command('dumpprivkeys', 0, 0, False, True, True, 'dump all private keys')
68 register_command('freeze', 1, 1, False, True, True, 'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
69 register_command('getbalance', 0, 1, True, True, False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
70 register_command('getservers', 0, 0, True, False, False, 'Return the list of available servers')
71 register_command('getaddressbalance', 1, 1, True, True, False, 'Return the balance of an address', 'getbalance <address>')
72 register_command('getaddresshistory', 1, 1, True, True, 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>', config_options)
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, 2, True, False, False, 'Retrieve a transaction', 'getrawtransaction <txhash> <height>')
76 register_command('getseed', 0, 0, False, True, True, 'Print the generation seed of your wallet.')
77 register_command('help', 0, 1, False, False, False, 'Prints this help')
78 register_command('history', 0, 0, True, True, False, 'Returns the transaction history of your wallet')
79 register_command('importprivkey', 1, 1, False, True, True, 'Import a private key', 'importprivkey <privatekey>')
80 register_command('listaddresses', 3, 3, False, True, False, 'Returns your list of addresses.', '', listaddr_options)
81 register_command('listunspent', 0, 0, True, True, False, 'Returns the list of unspent inputs in your wallet.')
82 register_command('mktx', 5, 5, False, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
83 register_command('mksendmanytx', 4, 4, False, True, True, 'Create a signed transaction', mksendmany_syntax, payto_options)
84 register_command('payto', 5, 5, True, True, True, 'Create and broadcast a transaction.', payto_syntax, payto_options)
85 register_command('paytomany', 4, 4, True, True, True, 'Create and broadcast a transaction.', paytomany_syntax, payto_options)
86 register_command('password', 0, 0, False, True, True, 'Change your password')
87 register_command('prioritize', 1, 1, False, True, False, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
88 register_command('restore', 0, 0, True, True, False, 'Restore a wallet', '', restore_options)
89 register_command('setconfig', 2, 2, False, False, False, 'Set a configuration variable', 'setconfig <name> <value>', config_options)
90 register_command('setlabel', 2,-1, False, True, False, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
91 register_command('sendrawtransaction', 1, 1, True, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
92 register_command('signrawtransaction', 1, 3, False, True, True, 'similar to bitcoind\'s command')
93 register_command('signmessage', 2,-1, False, True, True, 'Sign a message with a key', signmessage_syntax)
94 register_command('unfreeze', 1, 1, False, True, False, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
95 register_command('unprioritize', 1, 1, False, True, False, 'Unprioritize an address', 'unprioritize <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)
104 def __init__(self, wallet, network, callback = None):
106 self.network = network
107 self._callback = callback
110 def _run(self, method, args, password_getter):
111 cmd = known_commands[method]
112 if cmd.requires_password and self.wallet.use_encryption:
113 self.password = apply(password_getter,())
114 f = eval('self.'+method)
115 result = apply(f,args)
118 apply(self._callback, ())
121 def getaddresshistory(self, addr):
122 assert self.wallet.is_mine(addr)
123 h = self.wallet.get_history(addr)
124 if h is None: h = self.network.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
127 def listunspent(self):
129 l = copy.deepcopy(self.wallet.get_unspent_coins())
130 for i in l: i["value"] = str(Decimal(i["value"])/100000000)
133 def createrawtransaction(self, inputs, outputs):
134 # convert to own format
136 i['tx_hash'] = i['txid']
137 i['index'] = i['vout']
138 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
139 tx = Transaction.from_io(inputs, outputs)
142 def signrawtransaction(self, raw_tx, input_info, private_keys):
143 tx = Transaction(raw_tx)
144 self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
147 def decoderawtransaction(self, raw):
148 tx = Transaction(raw)
149 return tx.deserialize()
151 def sendrawtransaction(self, raw):
152 tx = Transaction(raw)
153 r, h = self.wallet.sendtx( tx )
156 def createmultisig(self, num, pubkeys):
157 assert isinstance(pubkeys, list)
158 redeem_script = Transaction.multisig_script(pubkeys, num)
159 address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
160 return {'address':address, 'redeemScript':redeem_script}
162 def freeze(self,addr):
163 return self.wallet.freeze(addr)
165 def unfreeze(self,addr):
166 return self.wallet.unfreeze(addr)
168 def prioritize(self, addr):
169 return self.wallet.prioritize(addr)
171 def unprioritize(self, addr):
172 return self.wallet.unprioritize(addr)
174 def dumpprivkey(self, addr):
175 return self.wallet.get_private_key(addr, self.password)
177 def dumpprivkeys(self, addresses = None):
178 if addresses is None:
179 addresses = self.wallet.addresses(True)
180 return [self.wallet.get_private_key(address, self.password) for address in addresses]
182 def validateaddress(self, addr):
183 isvalid = is_valid(addr)
184 out = { 'isvalid':isvalid }
186 out['address'] = addr
188 def getpubkeys(self, addr):
189 assert is_valid(addr) and self.wallet.is_mine(addr)
190 out = { 'address':addr }
191 account, sequence = self.wallet.get_address_index(addr)
193 a = self.wallet.accounts[account]
194 out['pubkeys'] = a.get_pubkeys( sequence )
198 def getbalance(self, account= None):
200 c, u = self.wallet.get_balance()
202 c, u = self.wallet.get_account_balance(account)
204 out = { "confirmed": str(Decimal(c)/100000000) }
205 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
208 def getaddressbalance(self, addr):
209 c, u = self.wallet.get_addr_balance(addr)
210 out = { "confirmed": str(Decimal(c)/100000000) }
211 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
214 def getservers(self):
215 return self.network.get_servers()
219 seed = self.wallet.decode_seed(self.password)
220 return { "hex":seed, "mnemonic": ' '.join(mnemonic.mn_encode(seed)) }
222 def importprivkey(self, sec):
224 addr = self.wallet.import_key(sec,self.password)
225 out = "Keypair imported: ", addr
226 except BaseException as e:
227 out = "Error: Keypair import failed: " + str(e)
231 def signmessage(self, address, message):
232 return self.wallet.sign_message(address, message, self.password)
235 def verifymessage(self, address, signature, message):
236 return bitcoin.verify_message(address, signature, message)
239 def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
241 for to_address, amount in outputs:
242 if not is_valid(to_address):
243 raise BaseException("Invalid Bitcoin address", to_address)
246 if not is_valid(change_addr):
247 raise BaseException("Invalid Bitcoin address", change_addr)
249 if domain is not None:
251 if not is_valid(addr):
252 raise BaseException("invalid Bitcoin address", addr)
254 if not self.wallet.is_mine(addr):
255 raise BaseException("address not in wallet", addr)
257 for k, v in self.wallet.labels.items():
258 if change_addr and v == change_addr:
262 for to_address, amount in outputs:
263 for k, v in self.wallet.labels.items():
266 print_msg("alias", to_address)
269 amount = int(100000000*amount)
270 final_outputs.append((to_address, amount))
272 if fee: fee = int(100000000*fee)
273 return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
276 def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
277 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
280 def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
281 tx = self._mktx(outputs, fee, change_addr, domain)
285 def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
286 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
287 r, h = self.wallet.sendtx( tx )
290 def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
291 tx = self._mktx(outputs, fee, change_addr, domain)
292 r, h = self.wallet.sendtx( tx )
300 for item in self.wallet.get_tx_history():
301 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
303 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
307 label, is_default_label = self.wallet.get_label(tx_hash)
308 if not label: label = tx_hash
309 else: label = label + ' '*(64 - len(label) )
311 out.append( "%16s"%time_str + " " + label + " " + format_satoshis(value)+ " "+ format_satoshis(balance) )
316 def setlabel(self, key, label):
317 self.wallet.set_label(key, label)
323 for addr in self.wallet.addressbook:
324 c[addr] = self.wallet.labels.get(addr)
328 def listaddresses(self, show_all = False, show_balance = False, show_label = False):
330 for addr in self.wallet.addresses(True):
331 if show_all or not self.wallet.is_change(addr):
332 if show_balance or show_label:
333 item = { 'address': addr }
335 item['balance'] = str(Decimal(self.wallet.get_addr_balance(addr)[0])/100000000)
337 label = self.wallet.labels.get(addr,'')
339 item['label'] = label
345 def help(self, cmd=None):
346 if cmd not in known_commands:
347 print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
349 cmd = known_commands[cmd]
350 print_msg(cmd.description)
351 if cmd.syntax: print_msg("Syntax: " + cmd.syntax)
352 if cmd.options: print_msg("options:\n" + cmd.options)
355 def getrawtransaction(self, tx_hash, height = 0):
356 tx = self.wallet.transactions.get(tx_hash)
360 return self.network.retrieve_transaction(tx_hash, height)