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/>.
22 from decimal import Decimal
27 protected_commands = []
29 def register_command(name, min_args, max_args, is_protected, is_offline, description, syntax = '', options_syntax = ''):
30 global known_commands, protected_commands, offline_commands
31 known_commands[name] = (min_args, max_args, description, syntax, options_syntax)
33 protected_commands.append(name)
35 offline_commands.append(name)
38 payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -s: send from address -\n --changeaddr, -c: send change to address'
39 listaddr_options = " -a: show all addresses, including change addresses\n -b: include balance in results\n -l: include labels in results"
40 restore_options = " accepts a seed or master public key."
41 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"
43 register_command('contacts', 0, 0, False, True, 'Show your list of contacts')
44 register_command('create', 0, 0, False, True, 'Create a new wallet')
45 register_command('createmultisig', 2, 2, False, True, 'similar to bitcoind\'s command')
46 register_command('createrawtransaction', 2, 2, False, True, 'similar to bitcoind\'s command')
47 register_command('deseed', 0, 0, False, True, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
48 register_command('decoderawtransaction', 1, 1, False, True, 'similar to bitcoind\'s command')
49 register_command('dumpprivkey', 1, 1, True, True, 'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
50 register_command('dumpprivkeys', 0, 0, True, True, 'dump all private keys')
51 register_command('freeze', 1, 1, False, True, 'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
52 register_command('getbalance', 0, 1, False, False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
53 register_command('getservers', 0, 0, False, False, 'Return the list of available servers')
54 register_command('getaddressbalance', 1, 1, False, False, 'Return the balance of an address', 'getbalance <address>')
55 register_command('getaddresshistory', 1, 1, False, False, 'Return the transaction history of an address', 'getaddresshistory <address>')
56 register_command('getconfig', 1, 1, False, True, 'Return a configuration variable', 'getconfig <name>', config_options)
57 register_command('getrawtransaction', 1, 2, False, False, 'Retrieve a transaction', 'getrawtransaction <txhash> <height>')
58 register_command('getseed', 0, 0, True, True, 'Print the generation seed of your wallet.')
59 register_command('help', 0, 1, False, True, 'Prints this help')
60 register_command('history', 0, 0, False, False, 'Returns the transaction history of your wallet')
61 register_command('importprivkey', 1, 1, True, True, 'Import a private key', 'importprivkey <privatekey>')
62 register_command('listaddresses', 3, 3, False, True, 'Returns your list of addresses.', '', listaddr_options)
63 register_command('listunspent', 0, 0, False, True, 'Returns a list of unspent inputs in your wallet.')
64 register_command('mktx', 5, 5, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
65 register_command('mksendmanytx', 4, 4, True, True, 'Create a signed transaction', 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]', payto_options)
66 register_command('payto', 5, 5, True, False, 'Create and broadcast a transaction.', "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label", payto_options)
67 register_command('paytomany', 4, 4, True, False, 'Create and broadcast a transaction.', "paytomany <recipient> <amount> [<recipient> <amount> ...]\n<recipient> can be a bitcoin address or a label", payto_options)
68 register_command('password', 0, 0, True, True, 'Change your password')
69 register_command('prioritize', 1, 1, False, True, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
70 register_command('restore', 0, 0, False, False, 'Restore a wallet', '', restore_options)
71 register_command('setconfig', 2, 2, False, True, 'Set a configuration variable', 'setconfig <name> <value>', config_options)
72 register_command('setlabel', 2,-1, False, True, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
73 register_command('sendrawtransaction', 1, 1, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
74 register_command('signrawtransaction', 1, 3, True, True, 'similar to bitcoind\'s command')
75 register_command('signmessage', 2,-1, True, True, 'Sign a message with a key', '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 "')
76 register_command('unfreeze', 1, 1, False, True, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
77 register_command('unprioritize', 1, 1, False, True, 'Unprioritize an address', 'unprioritize <address>')
78 register_command('validateaddress', 1, 1, False, True, 'Check that the address is valid', 'validateaddress <address>')
79 register_command('verifymessage', 3,-1, False, True, 'Verifies a signature', '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 "')
86 def __init__(self, wallet, network, callback = None):
88 self.network = network
89 self._callback = callback
92 def _run(self, method, args, password_getter):
93 if method in protected_commands and self.wallet.use_encryption:
94 self.password = apply(password_getter,())
95 f = eval('self.'+method)
96 result = apply(f,args)
99 apply(self._callback, ())
102 def getaddresshistory(self, addr):
103 h = self.wallet.get_history(addr)
104 if h is None: h = self.wallet.interface.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
107 def listunspent(self):
109 l = copy.deepcopy(self.wallet.get_unspent_coins())
110 for i in l: i["value"] = str(Decimal(i["value"])/100000000)
113 def createrawtransaction(self, inputs, outputs):
114 # convert to own format
116 i['tx_hash'] = i['txid']
117 i['index'] = i['vout']
118 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
119 tx = Transaction.from_io(inputs, outputs)
122 def signrawtransaction(self, raw_tx, input_info, private_keys):
123 tx = Transaction(raw_tx)
124 self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
127 def decoderawtransaction(self, raw):
128 tx = Transaction(raw)
129 return tx.deserialize()
131 def sendrawtransaction(self, raw):
132 tx = Transaction(raw)
133 r, h = self.wallet.sendtx( tx )
136 def createmultisig(self, num, pubkeys):
137 assert isinstance(pubkeys, list)
138 redeem_script = Transaction.multisig_script(pubkeys, num)
139 address = hash_160_to_bc_address(hash_160(redeem_script.decode('hex')), 5)
140 return {'address':address, 'redeemScript':redeem_script}
142 def freeze(self,addr):
143 return self.wallet.freeze(addr)
145 def unfreeze(self,addr):
146 return self.wallet.unfreeze(addr)
148 def prioritize(self, addr):
149 return self.wallet.prioritize(addr)
151 def unprioritize(self, addr):
152 return self.wallet.unprioritize(addr)
154 def dumpprivkey(self, addr):
155 return self.wallet.get_private_key(addr, self.password)
157 def dumpprivkeys(self, addresses = None):
158 if addresses is None:
159 addresses = self.wallet.addresses(True)
160 return [self.wallet.get_private_key(address, self.password) for address in addresses]
162 def validateaddress(self,addr):
163 isvalid = is_valid(addr)
164 out = { 'isvalid':isvalid }
166 is_mine = self.wallet.is_mine(addr)
167 out['address'] = addr
168 out['ismine'] = is_mine
170 account, sequence = self.wallet.get_address_index(addr)
172 out['pubkey'] = self.wallet.get_public_key(addr)
175 def getbalance(self, account= None):
177 c, u = self.wallet.get_balance()
179 c, u = self.wallet.get_account_balance(account)
181 out = { "confirmed": str(Decimal(c)/100000000) }
182 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
185 def getaddressbalance(self, addr):
186 c, u = self.wallet.get_addr_balance(addr)
187 out = { "confirmed": str(Decimal(c)/100000000) }
188 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
191 def getservers(self):
192 return self.network.get_servers()
196 seed = self.wallet.decode_seed(self.password)
197 return { "hex":seed, "mnemonic": ' '.join(mnemonic.mn_encode(seed)) }
199 def importprivkey(self, sec):
201 addr = self.wallet.import_key(sec,self.password)
202 out = "Keypair imported: ", addr
203 except BaseException as e:
204 out = "Error: Keypair import failed: " + str(e)
208 def signmessage(self, address, message):
209 return self.wallet.sign_message(address, message, self.password)
212 def verifymessage(self, address, signature, message):
213 return self.wallet.verify_message(address, signature, message)
216 def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
218 for to_address, amount in outputs:
219 if not is_valid(to_address):
220 raise BaseException("Invalid Bitcoin address", to_address)
223 if not is_valid(change_addr):
224 raise BaseException("Invalid Bitcoin address", change_addr)
226 if domain is not None:
228 if not is_valid(addr):
229 raise BaseException("invalid Bitcoin address", addr)
231 if not self.wallet.is_mine(addr):
232 raise BaseException("address not in wallet", addr)
234 for k, v in self.wallet.labels.items():
235 if change_addr and v == change_addr:
239 for to_address, amount in outputs:
240 for k, v in self.wallet.labels.items():
243 print_msg("alias", to_address)
246 amount = int(100000000*amount)
247 final_outputs.append((to_address, amount))
249 if fee: fee = int(100000000*fee)
250 return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
253 def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
254 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
257 def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
258 tx = self._mktx(outputs, fee, change_addr, domain)
262 def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
263 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
264 r, h = self.wallet.sendtx( tx )
267 def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
268 tx = self._mktx(outputs, fee, change_addr, domain)
269 r, h = self.wallet.sendtx( tx )
277 for item in self.wallet.get_tx_history():
278 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
280 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
284 label, is_default_label = self.wallet.get_label(tx_hash)
285 if not label: label = tx_hash
286 else: label = label + ' '*(64 - len(label) )
288 out.append( "%16s"%time_str + " " + label + " " + format_satoshis(value)+ " "+ format_satoshis(balance) )
293 def setlabel(self, key, label):
294 self.wallet.set_label(key, label)
300 for addr in self.wallet.addressbook:
301 c[addr] = self.wallet.labels.get(addr)
305 def listaddresses(self, show_all = False, show_balance = False, show_label = False):
307 for addr in self.wallet.addresses(True):
308 if show_all or not self.wallet.is_change(addr):
309 if show_balance or show_label:
310 item = { 'address': addr }
312 item['balance'] = str(Decimal(self.wallet.get_addr_balance(addr)[0])/100000000)
314 label = self.wallet.labels.get(addr,'')
316 item['label'] = label
322 def help(self, cmd2=None):
323 if cmd2 not in known_commands:
324 print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
326 _, _, description, syntax, options_syntax = known_commands[cmd2]
327 print_msg(description)
328 if syntax: print_msg("Syntax: " + syntax)
329 if options_syntax: print_msg("options:\n" + options_syntax)
332 def getrawtransaction(self, tx_hash, height = 0):
333 tx = self.wallet.transactions.get(tx_hash)
337 return self.network.retrieve_transaction(tx_hash, height)