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"
42 register_command('contacts', 0, 0, False, True, 'Show your list of contacts')
43 register_command('create', 0, 0, False, True, 'Create a new wallet')
44 register_command('createmultisig', 2, 2, False, True, 'similar to bitcoind\'s command')
45 register_command('createrawtransaction', 2, 2, False, True, 'similar to bitcoind\'s command')
46 register_command('deseed', 0, 0, False, True, 'Create a seedless, watching-only wallet.')
47 register_command('decoderawtransaction', 1, 1, False, True, 'similar to bitcoind\'s command')
48 register_command('dumpprivkey', 1, 1, True, True, 'similar to bitcoind\'s command')
49 register_command('dumpprivkeys', 0, 0, True, True, 'dump all private keys')
50 register_command('eval', 1, 1, False, True, 'Run python eval() on an object', 'eval <expression>\nExample: eval \"wallet.aliases\"')
51 register_command('freeze', 1, 1, False, True, 'Freeze the funds at one of your wallet\'s addresses')
52 register_command('getbalance', 0, 1, False, False, 'Display the balance of your wallet or of an address', 'getbalance [<address>]')
53 register_command('getaddresshistory', 1, 1, False, False, 'get history for an address')
54 register_command('getconfig', 1, 1, False, True, 'Return a configuration variable', 'getconfig <name>')
55 register_command('getseed', 0, 0, True, True, 'Print the generation seed of your wallet.')
56 register_command('help', 0, 1, False, True, 'Prints this help')
57 register_command('history', 0, 0, False, False, 'Returns the transaction history of your wallet')
58 register_command('importprivkey', 1, 1, True, True, 'Import a private key', 'importprivkey <privatekey>')
59 register_command('listaddresses', 3, 3, False, True, 'Returns your list of addresses.', '', listaddr_options)
60 register_command('listunspent', 0, 0, False, True, 'Returns a list of unspent inputs in your wallet.')
61 register_command('mktx', 5, 5, True, True, 'Create a signed transaction', 'mktx <recipient> <amount> [label]', payto_options)
62 register_command('mksendmanytx', 4, 4, True, True, 'Create a signed transaction', 'mksendmanytx <recipient> <amount> [<recipient> <amount> ...]', payto_options)
63 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)
64 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)
65 register_command('password', 0, 0, True, True, 'Change your password')
66 register_command('prioritize', 1, 1, False, True, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
67 register_command('restore', 0, 0, False, False, 'Restore a wallet')
68 register_command('setconfig', 2, 2, False, True, 'Set a configuration variable', 'setconfig <name> <value>')
69 register_command('setlabel', 2,-1, False, True, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
70 register_command('sendrawtransaction', 1, 1, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
71 register_command('signrawtransaction', 1, 3, True, True, 'similar to bitcoind\'s command')
72 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 "')
73 register_command('unfreeze', 1, 1, False, True, '')
74 register_command('unprioritize', 1, 1, False, True, '')
75 register_command('validateaddress', 1, 1, False, True, 'Check that the address is valid')
76 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 "')
83 def __init__(self, wallet, interface, callback = None):
85 self.interface = interface
86 self._callback = callback
89 def _run(self, method, args, password_getter):
90 if method in protected_commands and self.wallet.use_encryption:
91 self.password = apply(password_getter,())
92 f = eval('self.'+method)
93 result = apply(f,args)
96 apply(self._callback, ())
99 def getaddresshistory(self, addr):
100 h = self.wallet.get_history(addr)
101 if h is None: h = self.wallet.interface.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
104 def listunspent(self):
106 l = copy.deepcopy(self.wallet.get_unspent_coins())
107 for i in l: i["value"] = str(Decimal(i["value"])/100000000)
110 def createrawtransaction(self, inputs, outputs):
111 # convert to own format
113 i['tx_hash'] = i['txid']
114 i['index'] = i['vout']
115 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
116 tx = Transaction.from_io(inputs, outputs)
119 def signrawtransaction(self, raw_tx, input_info, private_keys):
120 tx = Transaction(raw_tx)
121 self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
124 def decoderawtransaction(self, raw):
125 tx = Transaction(raw)
126 return tx.deserialize()
128 def sendrawtransaction(self, raw):
129 tx = Transaction(raw)
130 r, h = self.wallet.sendtx( tx )
133 def createmultisig(self, num, pubkeys):
134 assert isinstance(pubkeys, list)
135 return Transaction.multisig_script(pubkeys, num)
137 def freeze(self,addr):
138 return self.wallet.freeze(addr)
140 def unfreeze(self,addr):
141 return self.wallet.unfreeze(addr)
143 def prioritize(self, addr):
144 return self.wallet.prioritize(addr)
146 def unprioritize(self, addr):
147 return self.wallet.unprioritize(addr)
149 def dumpprivkey(self, addr):
150 return self.wallet.get_private_key(addr, self.password)
152 def dumpprivkeys(self, addresses = None):
153 if addresses is None:
154 addresses = self.wallet.addresses(True)
155 return self.wallet.get_private_keys(addresses, self.password)
157 def validateaddress(self,addr):
158 isvalid = is_valid(addr)
159 out = { 'isvalid':isvalid }
161 is_mine = self.wallet.is_mine(addr)
162 out['address'] = addr
163 out['ismine'] = is_mine
165 out['pubkey'] = self.wallet.get_public_key(addr)
170 def getbalance(self, addresses = []):
172 c, u = self.wallet.get_balance()
175 for addr in addresses:
176 cc, uu = self.wallet.get_addr_balance(addr)
180 out = { "confirmed": str(Decimal(c)/100000000) }
181 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
187 seed = self.wallet.decode_seed(self.password)
188 return { "hex":seed, "mnemonic": ' '.join(mnemonic.mn_encode(seed)) }
190 def importprivkey(self, sec):
192 addr = self.wallet.import_key(sec,self.password)
194 out = "Keypair imported: ", addr
195 except BaseException as e:
196 out = "Error: Keypair import failed: " + str(e)
200 def signmessage(self, address, message):
201 return self.wallet.sign_message(address, message, self.password)
204 def verifymessage(self, address, signature, message):
206 EC_KEY.verify_message(address, signature, message)
208 except BaseException as e:
209 print_error("Verification error: {0}".format(e))
213 def _mktx(self, outputs, fee = None, change_addr = None, domain = None):
215 for to_address, amount in outputs:
216 if not is_valid(to_address):
217 raise BaseException("Invalid Bitcoin address", to_address)
220 if not is_valid(change_addr):
221 raise BaseException("Invalid Bitcoin address", change_addr)
223 if domain is not None:
225 if not is_valid(addr):
226 raise BaseException("invalid Bitcoin address", addr)
228 if not self.wallet.is_mine(addr):
229 raise BaseException("address not in wallet", addr)
231 for k, v in self.wallet.labels.items():
232 if change_addr and v == change_addr:
236 for to_address, amount in outputs:
237 for k, v in self.wallet.labels.items():
240 print_msg("alias", to_address)
243 amount = int(100000000*amount)
244 final_outputs.append((to_address, amount))
246 if fee: fee = int(100000000*fee)
247 return self.wallet.mktx(final_outputs, self.password, fee , change_addr, domain)
250 def mktx(self, to_address, amount, fee = None, change_addr = None, domain = None):
251 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
254 def mksendmanytx(self, outputs, fee = None, change_addr = None, domain = None):
255 tx = self._mktx(outputs, fee, change_addr, domain)
259 def payto(self, to_address, amount, fee = None, change_addr = None, domain = None):
260 tx = self._mktx([(to_address, amount)], fee, change_addr, domain)
261 r, h = self.wallet.sendtx( tx )
264 def paytomany(self, outputs, fee = None, change_addr = None, domain = None):
265 tx = self._mktx(outputs, fee, change_addr, domain)
266 r, h = self.wallet.sendtx( tx )
274 for item in self.wallet.get_tx_history():
275 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
277 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
281 label, is_default_label = self.wallet.get_label(tx_hash)
282 if not label: label = tx_hash
283 else: label = label + ' '*(64 - len(label) )
285 out.append( "%16s"%time_str + " " + label + " " + format_satoshis(value)+ " "+ format_satoshis(balance) )
290 def setlabel(self, tx, label):
291 self.wallet.labels[tx] = label
297 for addr in self.wallet.addressbook:
298 c[addr] = self.wallet.labels.get(addr)
302 def listaddresses(self, show_all = False, show_balance = False, show_label = False):
304 for addr in self.wallet.addresses(True):
305 if show_all or not self.wallet.is_change(addr):
306 if show_balance or show_label:
307 item = { 'address': addr }
309 item['balance'] = str(Decimal(self.wallet.get_addr_balance(addr)[0])/100000000)
311 label = self.wallet.labels.get(addr,'')
313 item['label'] = label
319 def help(self, cmd2=None):
320 if cmd2 not in known_commands:
321 print_msg("List of commands:", ', '.join(known_commands))
323 _, _, description, syntax, options_syntax = known_commands[cmd2]
324 print_msg(description)
325 if syntax: print_msg("Syntax: " + syntax)
326 if options_syntax: print_msg("options:\n" + options_syntax)