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 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('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('mktx', 5, 5, False, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
84 register_command('mksendmanytx', 4, 4, False, True, True, 'Create a signed transaction', mksendmany_syntax, payto_options)
85 register_command('payto', 5, 5, True, True, True, 'Create and broadcast a transaction.', payto_syntax, payto_options)
86 register_command('paytomany', 4, 4, True, True, True, 'Create and broadcast a transaction.', paytomany_syntax, payto_options)
87 register_command('password', 0, 0, False, True, True, 'Change your password')
88 register_command('prioritize', 1, 1, False, True, False, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
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>', config_options)
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('unprioritize', 1, 1, False, True, False, 'Unprioritize an address', 'unprioritize <address>')
97 register_command('validateaddress', 1, 1, False, False, False, 'Check that the address is valid', 'validateaddress <address>')
98 register_command('verifymessage', 3,-1, False, False, False, 'Verifies a signature', verifymessage_syntax)
105 def __init__(self, wallet, network, callback = None):
107 self.network = network
108 self._callback = callback
111 def _run(self, method, args, password_getter):
112 cmd = known_commands[method]
113 if cmd.requires_password and self.wallet.use_encryption:
114 self.password = apply(password_getter,())
115 f = eval('self.'+method)
116 result = apply(f,args)
119 apply(self._callback, ())
122 def getaddresshistory(self, addr):
123 assert self.wallet.is_mine(addr)
124 h = self.wallet.get_history(addr)
125 if h is None: h = self.network.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
128 def listunspent(self):
130 l = copy.deepcopy(self.wallet.get_unspent_coins())
131 for i in l: i["value"] = str(Decimal(i["value"])/100000000)
134 def createrawtransaction(self, inputs, outputs):
135 # convert to own format
137 i['tx_hash'] = i['txid']
138 i['index'] = i['vout']
139 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
140 tx = Transaction.from_io(inputs, outputs)
143 def signrawtransaction(self, raw_tx, input_info, private_keys):
144 tx = Transaction(raw_tx)
145 self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
148 def decoderawtransaction(self, raw):
149 tx = Transaction(raw)
150 return tx.deserialize()
152 def sendrawtransaction(self, raw):
153 tx = Transaction(raw)
154 r, h = self.wallet.sendtx( tx )
157 def createmultisig(self, num, pubkeys):
158 assert isinstance(pubkeys, list)
159 redeem_script = Transaction.multisig_script(pubkeys, num)
160 address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
161 return {'address':address, 'redeemScript':redeem_script}
163 def freeze(self,addr):
164 return self.wallet.freeze(addr)
166 def unfreeze(self,addr):
167 return self.wallet.unfreeze(addr)
169 def prioritize(self, addr):
170 return self.wallet.prioritize(addr)
172 def unprioritize(self, addr):
173 return self.wallet.unprioritize(addr)
175 def dumpprivkey(self, addr):
176 return self.wallet.get_private_key(addr, self.password)
178 def dumpprivkeys(self, addresses = None):
179 if addresses is None:
180 addresses = self.wallet.addresses(True)
181 return [self.wallet.get_private_key(address, self.password) for address in addresses]
183 def validateaddress(self, addr):
184 isvalid = is_valid(addr)
185 out = { 'isvalid':isvalid }
187 out['address'] = addr
190 def getpubkeys(self, addr):
191 assert is_valid(addr) and self.wallet.is_mine(addr)
192 out = { 'address':addr }
193 account, sequence = self.wallet.get_address_index(addr)
195 a = self.wallet.accounts[account]
196 out['pubkeys'] = a.get_pubkeys( sequence )
200 def getbalance(self, account= None):
202 c, u = self.wallet.get_balance()
204 c, u = self.wallet.get_account_balance(account)
206 out = { "confirmed": str(Decimal(c)/100000000) }
207 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
210 def getaddressbalance(self, addr):
211 c, u = self.wallet.get_addr_balance(addr)
212 out = { "confirmed": str(Decimal(c)/100000000) }
213 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
216 def getservers(self):
217 return self.network.get_servers()
220 return self.wallet.get_master_public_key()
223 mnemonic = self.wallet.get_mnemonic(self.password)
224 seed = self.wallet.get_seed(self.password)
225 return { 'mnemonic':mnemonic, 'seed':seed, 'version':self.wallet.seed_version }
227 def importprivkey(self, sec):
229 addr = self.wallet.import_key(sec,self.password)
230 out = "Keypair imported: ", addr
231 except BaseException as e:
232 out = "Error: Keypair import failed: " + str(e)
236 def signmessage(self, address, message):
237 return self.wallet.sign_message(address, message, self.password)
240 def verifymessage(self, address, signature, message):
241 return bitcoin.verify_message(address, signature, message)
244 def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
246 for to_address, amount in outputs:
247 if not is_valid(to_address):
248 raise BaseException("Invalid Bitcoin address", to_address)
251 if not is_valid(change_addr):
252 raise BaseException("Invalid Bitcoin address", change_addr)
254 if domain is not None:
256 if not is_valid(addr):
257 raise BaseException("invalid Bitcoin address", addr)
259 if not self.wallet.is_mine(addr):
260 raise BaseException("address not in wallet", addr)
262 for k, v in self.wallet.labels.items():
263 if change_addr and v == change_addr:
267 for to_address, amount in outputs:
268 for k, v in self.wallet.labels.items():
271 print_msg("alias", to_address)
274 amount = int(100000000*amount)
275 final_outputs.append((to_address, amount))
277 if fee: fee = int(100000000*fee)
278 return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
281 def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
282 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
285 def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
286 tx = self._mktx(outputs, fee, change_addr, domain)
290 def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
291 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
292 r, h = self.wallet.sendtx( tx )
295 def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
296 tx = self._mktx(outputs, fee, change_addr, domain)
297 r, h = self.wallet.sendtx( tx )
305 for item in self.wallet.get_tx_history():
306 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
308 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
312 label, is_default_label = self.wallet.get_label(tx_hash)
313 if not label: label = tx_hash
314 else: label = label + ' '*(64 - len(label) )
316 out.append( "%16s"%time_str + " " + label + " " + format_satoshis(value)+ " "+ format_satoshis(balance) )
321 def setlabel(self, key, label):
322 self.wallet.set_label(key, label)
328 for addr in self.wallet.addressbook:
329 c[addr] = self.wallet.labels.get(addr)
333 def listaddresses(self, show_all = False, show_label = False):
335 for addr in self.wallet.addresses(True):
336 if show_all or not self.wallet.is_change(addr):
338 item = { 'address': addr }
340 label = self.wallet.labels.get(addr,'')
342 item['label'] = label
348 def help(self, cmd=None):
349 if cmd not in known_commands:
350 print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
352 cmd = known_commands[cmd]
353 print_msg(cmd.description)
354 if cmd.syntax: print_msg("Syntax: " + cmd.syntax)
355 if cmd.options: print_msg("options:\n" + cmd.options)
358 def getrawtransaction(self, tx_hash, height = 0):
359 tx = self.wallet.transactions.get(tx_hash)
363 return self.network.retrieve_transaction(tx_hash, height)