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('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)
63 register_command('password', 0, 0, True, True, 'Change your password')
64 register_command('prioritize', 1, 1, False, True, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
65 register_command('restore', 0, 0, False, False, 'Restore a wallet')
66 register_command('setconfig', 2, 2, False, True, 'Set a configuration variable', 'setconfig <name> <value>')
67 register_command('setlabel', 2,-1, False, True, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
68 register_command('sendrawtransaction', 1, 1, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
69 register_command('signrawtransaction', 1, 3, True, True, 'similar to bitcoind\'s command')
70 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 "')
71 register_command('unfreeze', 1, 1, False, True, '')
72 register_command('unprioritize', 1, 1, False, True, '')
73 register_command('validateaddress', 1, 1, False, True, 'Check that the address is valid')
74 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 "')
81 def __init__(self, wallet, interface, callback = None):
83 self.interface = interface
84 self._callback = callback
87 def _run(self, method, args, password_getter):
88 if method in protected_commands and self.wallet.use_encryption:
89 self.password = apply(password_getter,())
90 f = eval('self.'+method)
91 result = apply(f,args)
94 apply(self._callback, ())
97 def getaddresshistory(self, addr):
98 h = self.wallet.get_history(addr)
99 if h is None: h = self.wallet.interface.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
102 def listunspent(self):
104 l = copy.deepcopy(self.wallet.get_unspent_coins())
105 for i in l: i["value"] = str(Decimal(i["value"])/100000000)
108 def createrawtransaction(self, inputs, outputs):
109 # convert to own format
111 i['tx_hash'] = i['txid']
112 i['index'] = i['vout']
113 outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
114 tx = Transaction.from_io(inputs, outputs)
117 def signrawtransaction(self, raw_tx, input_info, private_keys):
118 tx = Transaction(raw_tx)
119 self.wallet.signrawtransaction(tx, input_info, private_keys, self.password)
122 def decoderawtransaction(self, raw):
123 tx = Transaction(raw)
124 return tx.deserialize()
126 def sendrawtransaction(self, raw):
127 tx = Transaction(raw)
128 r, h = self.wallet.sendtx( tx )
131 def createmultisig(self, num, pubkeys):
132 assert isinstance(pubkeys, list)
133 return Transaction.multisig_script(pubkeys, num)
135 def freeze(self,addr):
136 return self.wallet.freeze(addr)
138 def unfreeze(self,addr):
139 return self.wallet.unfreeze(addr)
141 def prioritize(self, addr):
142 return self.wallet.prioritize(addr)
144 def unprioritize(self, addr):
145 return self.wallet.unprioritize(addr)
147 def dumpprivkey(self, addr):
148 return self.wallet.get_private_key(addr, self.password)
150 def dumpprivkeys(self, addresses = None):
151 if addresses is None:
152 addresses = self.wallet.addresses(True)
153 return self.wallet.get_private_keys(addresses, self.password)
155 def validateaddress(self,addr):
156 isvalid = is_valid(addr)
157 out = { 'isvalid':isvalid }
159 is_mine = self.wallet.is_mine(addr)
160 out['address'] = addr
161 out['ismine'] = is_mine
163 out['pubkey'] = self.wallet.get_public_key(addr)
168 def getbalance(self, addresses = []):
170 c, u = self.wallet.get_balance()
173 for addr in addresses:
174 cc, uu = self.wallet.get_addr_balance(addr)
178 out = { "confirmed": str(Decimal(c)/100000000) }
179 if u: out["unconfirmed"] = str(Decimal(u)/100000000)
185 seed = self.wallet.decode_seed(self.password)
186 return { "hex":seed, "mnemonic": ' '.join(mnemonic.mn_encode(seed)) }
188 def importprivkey(self, sec):
190 addr = self.wallet.import_key(sec,self.password)
192 out = "Keypair imported: ", addr
193 except BaseException as e:
194 out = "Error: Keypair import failed: " + str(e)
198 def signmessage(self, address, message):
199 return self.wallet.sign_message(address, message, self.password)
202 def verifymessage(self, address, signature, message):
204 EC_KEY.verify_message(address, signature, message)
206 except BaseException as e:
207 print_error("Verification error: {0}".format(e))
211 def _mktx(self, to_address, amount, fee = None, change_addr = None, from_addr = None):
213 if not is_valid(to_address):
214 raise BaseException("Invalid Bitcoin address", to_address)
217 if not is_valid(change_addr):
218 raise BaseException("Invalid Bitcoin address", change_addr)
221 if not is_valid(from_addr):
222 raise BaseException("invalid Bitcoin address", from_addr)
224 if not self.wallet.is_mine(from_addr):
225 raise BaseException("address not in wallet")
227 for k, v in self.wallet.labels.items():
230 print_msg("alias", to_address)
232 if change_addr and v == change_addr:
235 amount = int(100000000*amount)
236 if fee: fee = int(100000000*fee)
237 return self.wallet.mktx( [(to_address, amount)], self.password, fee , change_addr, from_addr)
240 def mktx(self, to_address, amount, fee = None, change_addr = None, from_addr = None):
241 tx = self._mktx(to_address, amount, fee, change_addr, from_addr)
245 def payto(self, to_address, amount, fee = None, change_addr = None, from_addr = None):
246 tx = self._mktx(to_address, amount, fee, change_addr, from_addr)
247 r, h = self.wallet.sendtx( tx )
255 for item in self.wallet.get_tx_history():
256 tx_hash, conf, is_mine, value, fee, balance, timestamp = item
258 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
262 label, is_default_label = self.wallet.get_label(tx_hash)
263 if not label: label = tx_hash
264 else: label = label + ' '*(64 - len(label) )
266 out.append( "%16s"%time_str + " " + label + " " + format_satoshis(value)+ " "+ format_satoshis(balance) )
271 def setlabel(self, tx, label):
272 self.wallet.labels[tx] = label
278 for addr in self.wallet.addressbook:
279 c[addr] = self.wallet.labels.get(addr)
283 def listaddresses(self, show_all = False, show_balance = False, show_label = False):
285 for addr in self.wallet.addresses(True):
286 if show_all or not self.wallet.is_change(addr):
287 if show_balance or show_label:
288 item = { 'address': addr }
290 item['balance'] = str(Decimal(self.wallet.get_addr_balance(addr)[0])/100000000)
292 label = self.wallet.labels.get(addr,'')
294 item['label'] = label
300 def help(self, cmd2=None):
301 if cmd2 not in known_commands:
302 print_msg("List of commands:", ', '.join(known_commands))
304 _, _, description, syntax, options_syntax = known_commands[cmd2]
305 print_msg(description)
306 if syntax: print_msg("Syntax: " + syntax)
307 if options_syntax: print_msg("options:\n" + options_syntax)