lib/commands.py

   1 #!/usr/bin/env python
   2 #
   3 # Electrum - lightweight Bitcoin client
   4 # Copyright (C) 2011 thomasv@gitorious
   5 #
   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.
  10 #
  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.
  15 #
  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/>.
  18
  19
  20 from util import *
  21 from bitcoin import *
  22 from decimal import Decimal
  23 import bitcoin
  24
  25 known_commands = {
  26     'help':'Prints this help',
  27     'validateaddress':'Check that the address is valid',
  28     'balance': "Display the balance of your wallet or of an address.\nSyntax: balance [<address>]",
  29     'contacts': "Show your list of contacts",
  30     'create':'Create a wallet',
  31     'restore':'Restore a wallet',
  32     'payto':"""Create and broadcast a transaction.
  33 Syntax: payto <recipient> <amount> [label]
  34 <recipient> can be a bitcoin address or a label
  35 options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
  36             """,
  37     'sendrawtransaction':
  38             'Broadcasts a transaction to the network. \nSyntax: sendrawtransaction <tx in hexadecimal>',
  39     'password':
  40             "Changes your password",
  41     'addresses':
  42             """Shows your list of addresses.
  43 options:
  44   -a: show all addresses, including change addresses""",
  45
  46     'history':"Shows the transaction history",
  47     'setlabel':'Assign a label to an item\nSyntax: label <tx_hash> <label>',
  48     'mktx':
  49         """Create a signed transaction, password protected.
  50 Syntax: mktx <recipient> <amount> [label]
  51 options:\n  --fee, -f: set transaction fee\n  --fromaddr, -s: send from address -\n  --changeaddr, -c: send change to address
  52         """,
  53     'get_seed':
  54             "Print the generation seed of your wallet.",
  55     'importprivkey':
  56             'Import a private key\nSyntax: importprivkey <privatekey>',
  57     'signmessage':
  58             'Signs a message with a key\nSyntax: 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 "',
  59     'verifymessage':
  60              'Verifies a signature\nSyntax: 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 "',
  61     'eval':
  62              "Run python eval() on an object\nSyntax: eval <expression>\nExample: eval \"wallet.aliases\"",
  63     'get':
  64              "Get config parameter.",
  65     'set':
  66              "Set config parameter.",
  67     'deseed':
  68             "Create a seedless, watching-only wallet.",
  69     'freeze':'',
  70     'unfreeze':'',
  71     'prioritize':'',
  72     'unprioritize':'',
  73     'dumpprivkey':'similar to bitcoind\'s command',
  74     'dumpprivkeys':'dump all private keys',
  75     'listunspent':'similar to bitcoind\'s command',
  76     'createmultisig':'similar to bitcoind\'s command',
  77     'createrawtransaction':'similar to bitcoind\'s command',
  78     'decoderawtransaction':'similar to bitcoind\'s command',
  79     'signrawtransaction':'similar to bitcoind\'s command',
  80     'get_history': 'get history for an address'
  81
  82     }
  83
  84
  85
  86 offline_commands = [ 'password', 'mktx',
  87                      'setlabel', 'contacts',
  88                      'help', 'validateaddress',
  89                      'signmessage', 'verifymessage',
  90                      'eval', 'set', 'get', 'create', 'addresses',
  91                      'importprivkey', 'get_seed',
  92                      'deseed',
  93                      'freeze','unfreeze',
  94                      'prioritize','unprioritize',
  95                      'dumpprivkey','dumpprivkeys','listunspent',
  96                      'createmultisig', 'createrawtransaction', 'decoderawtransaction', 'signrawtransaction'
  97                      ]
  98
  99 protected_commands = ['payto', 'password', 'mktx', 'get_seed', 'importprivkey','signmessage', 'signrawtransaction', 'dumpprivkey', 'dumpprivkeys' ]
 100
 101 class Commands:
 102
 103     def __init__(self, wallet, interface, callback = None):
 104         self.wallet = wallet
 105         self.interface = interface
 106         self.callback = callback
 107
 108     def _run(self, method, args, password_getter):
 109         if method in protected_commands:
 110             self.password = apply(password_getter,())
 111         f = eval('self.'+method)
 112         result = apply(f,args)
 113         self.password = None
 114         if self.callback:
 115             apply(self.callback, ())
 116         return result
 117
 118     def get_history(self, addr):
 119         h = self.wallet.get_history(addr)
 120         if h is None: h = self.wallet.interface.synchronous_get([ ('blockchain.address.get_history',[addr]) ])[0]
 121         return h
 122
 123     def listunspent(self):
 124         import copy
 125         l = copy.deepcopy(self.wallet.get_unspent_coins())
 126         for i in l: i["value"] = i["value"]*1e-8
 127         return l
 128
 129     def createrawtransaction(self, inputs, outputs):
 130         # convert to own format
 131         for i in inputs:
 132             i['tx_hash'] = i['txid']
 133             i['index'] = i['vout']
 134         outputs = map(lambda x: (x[0],int(1e8*x[1])), outputs.items())
 135         tx = Transaction.from_io(inputs, outputs)
 136         return tx.as_dict()
 137
 138     def signrawtransaction(self, raw_tx, input_info, private_keys):
 139         tx = Transaction(raw_tx)
 140         unspent_coins = self.wallet.get_unspent_coins()
 141
 142         # convert private_keys to dict
 143         pk = {}
 144         for sec in private_keys:
 145             address = bitcoin.address_from_private_key(sec)
 146             pk[address] = sec
 147         private_keys = pk
 148
 149         for txin in tx.inputs:
 150             # convert to own format
 151             txin['tx_hash'] = txin['prevout_hash']
 152             txin['index'] = txin['prevout_n']
 153
 154             for item in input_info:
 155                 if item.get('txid') == txin['tx_hash'] and item.get('vout') == txin['index']:
 156                     txin['raw_output_script'] = item['scriptPubKey']
 157                     txin['redeemScript'] = item.get('redeemScript')
 158                     txin['electrumKeyID'] = item.get('electrumKeyID')
 159                     break
 160             else:
 161                 for item in unspent_coins:
 162                     if txin['tx_hash'] == item['tx_hash'] and txin['index'] == item['index']:
 163                         txin['raw_output_script'] = item['raw_output_script']
 164                         break
 165                 else:
 166                     # if neither, we might want to get it from the server..
 167                     raise
 168
 169             # find the address:
 170             import deserialize
 171             if txin.get('electrumKeyID'):
 172                 n, for_change = txin.get('electrumKeyID')
 173                 sec = wallet.sequence.get_private_key(n, for_change, seed)
 174                 address = bitcoin.address_from_private_key(sec)
 175                 txin['address'] = address
 176                 private_keys[address] = sec
 177
 178             elif txin.get("redeemScript"):
 179                 txin['address'] = bitcoin.hash_160_to_bc_address(bitcoin.hash_160(txin.get("redeemScript").decode('hex')), 5)
 180
 181             elif txin.get("raw_output_script"):
 182                 addr = deserialize.get_address_from_output_script(txin.get("raw_output_script").decode('hex'))
 183                 sec = wallet.get_private_key(addr, self.password)
 184                 if sec:
 185                     private_keys[addr] = sec
 186                     txin['address'] = addr
 187
 188         tx.sign( private_keys )
 189         return tx.as_dict()
 190
 191     def decoderawtransaction(self, raw):
 192         tx = Transaction(raw)
 193         return tx.deserialize()
 194
 195     def sendrawtransaction(self, raw):
 196         tx = Transaction(raw)
 197         r, h = wallet.sendtx( tx )
 198         return h
 199
 200     def createmultisig(self, num, pubkeys):
 201         assert isinstance(pubkeys, list)
 202         return Transaction.multisig_script(pubkeys, num)
 203
 204     def freeze(self,addr):
 205         return self.wallet.freeze(addr)
 206
 207     def unfreeze(self,addr):
 208         return self.wallet.unfreeze(addr)
 209
 210     def prioritize(self, addr):
 211         return self.wallet.prioritize(addr)
 212
 213     def unprioritize(self, addr):
 214         return self.wallet.unprioritize(addr)
 215
 216     def dumpprivkey(self, addr):
 217         return self.wallet.get_private_key(addr, self.password)
 218
 219     def dumpprivkeys(self, addresses):
 220         return self.wallet.get_private_keys(addresses, self.password)
 221
 222     def validateaddress(self,addr):
 223         is_valid = self.wallet.is_valid(addr)
 224         out = { 'isvalid':is_valid }
 225         if is_valid:
 226             is_mine = self.wallet.is_mine(addr)
 227             out['address'] = addr
 228             out['ismine'] = is_mine
 229             if is_mine:
 230                 out['pubkey'] = self.wallet.get_public_key(addr)
 231
 232         return out
 233
 234
 235     def balance(self, addresses = []):
 236         if addresses == []:
 237             c, u = self.wallet.get_balance()
 238         else:
 239             c = u = 0
 240             for addr in addresses:
 241                 cc, uu = wallet.get_addr_balance(addr)
 242                 c += cc
 243                 u += uu
 244
 245         out = { "confirmed": str(Decimal(c)/100000000) }
 246         if u: out["unconfirmed"] = str(Decimal(u)/100000000)
 247         return out
 248
 249
 250     def get_seed(self):
 251         import mnemonic
 252         seed = self.wallet.decode_seed(self.password)
 253         return { "hex":seed, "mnemonic": ' '.join(mnemonic.mn_encode(seed)) }
 254
 255     def importprivkey(self, sec):
 256         try:
 257             addr = wallet.import_key(sec,self.password)
 258             wallet.save()
 259             out = "Keypair imported: ", addr
 260         except BaseException as e:
 261             out = "Error: Keypair import failed: " + str(e)
 262         return out
 263
 264
 265     def sign_message(self, address, message):
 266         return self.wallet.sign_message(address, message, self.password)
 267
 268
 269     def verify_message(self, address, signature, message):
 270         try:
 271             EC_KEY.verify_message(address, signature, message)
 272             return True
 273         except BaseException as e:
 274             print_error("Verification error: {0}".format(e))
 275             return False
 276
 277
 278     def _mktx(self, to_address, amount, fee = None, change_addr = None, from_addr = None):
 279         for k, v in self.wallet.labels.items():
 280             if v == to_address:
 281                 to_address = k
 282                 print_msg("alias", to_address)
 283                 break
 284             if change_addr and v == change_addr:
 285                 change_addr = k
 286
 287         amount = int(10000000*amount)
 288         if fee: fee = int(10000000*fee)
 289         return self.wallet.mktx( [(to_address, amount)], self.password, fee , change_addr, from_addr)
 290
 291
 292     def mktx(self, to_address, amount, fee = None, change_addr = None, from_addr = None):
 293         tx = self._mktx(to_address, amount, fee, change_addr, from_addr)
 294         return tx.as_dict()
 295
 296
 297     def payto(self, to_address, amount, fee = None, change_addr = None, from_addr = None):
 298         tx = self._mktx(to_address, amount, fee, change_addr, from_addr)
 299         r, h = wallet.sendtx( tx )
 300         return h
 301
 302
 303     def history(self):
 304         import datetime
 305         balance = 0
 306         out = []
 307         for item in self.wallet.get_tx_history():
 308             tx_hash, conf, is_mine, value, fee, balance, timestamp = item
 309             try:
 310                 time_str = datetime.datetime.fromtimestamp( timestamp).isoformat(' ')[:-3]
 311             except:
 312                 time_str = "----"
 313
 314             label, is_default_label = self.wallet.get_label(tx_hash)
 315             if not label: label = tx_hash
 316             else: label = label + ' '*(64 - len(label) )
 317
 318             out.append( "%16s"%time_str + "  " + label + "  " + format_satoshis(value)+ "  "+ format_satoshis(balance) )
 319         return out
 320
 321
 322
 323     def setlabel(self, tx, label):
 324         self.wallet.labels[tx] = label
 325         self.wallet.save()
 326
 327
 328     def contacts(self):
 329         c = {}
 330         for addr in self.wallet.addressbook:
 331             c[addr] = self.wallet.labels.get(addr)
 332         return c
 333
 334
 335     def addresses(self, show_all):
 336         out = []
 337         for addr in self.wallet.all_addresses():
 338             if show_all or not self.wallet.is_change(addr):
 339
 340                 flags = self.wallet.get_address_flags(addr)
 341                 label = self.wallet.labels.get(addr,'')
 342                 if label: label = "\"%s\""%label
 343                 b = format_satoshis(self.wallet.get_addr_balance(addr)[0])
 344                 m_addr = "%34s"%addr
 345                 out.append( flags + ' ' + m_addr + ' ' + b + ' ' + label )
 346         return out
 347
 348