backends/libbitcoin/history.py

   1 import bitcoin
   2 from bitcoin import bind, _1, _2, _3
   3 import threading
   4 import multimap
   5 import time
   6
   7 class MemoryPoolBuffer:
   8
   9     def __init__(self, service, txpool, chain):
  10         self.txpool = txpool
  11         self.chain = chain
  12         # prevout: inpoint
  13         self.lookup_input = {}
  14         # payment_address: outpoint
  15         self.lookup_address = multimap.MultiMap()
  16         # transaction timestamps
  17         self.timestamps = {}
  18
  19     def recv_tx(self, tx):
  20         tx_hash = bitcoin.hash_transaction(tx)
  21         desc = (tx_hash, [], [])
  22         for input in tx.inputs:
  23             desc[1].append(input.previous_output)
  24         for idx, output in enumerate(tx.outputs):
  25             address = bitcoin.payment_address()
  26             if address.extract(output.output_script):
  27                 desc[2].append((idx, address))
  28         self.txpool.store(tx,
  29             bind(self.confirmed, _1, desc),
  30             bind(self.mempool_stored, _1, desc))
  31
  32     def mempool_stored(self, ec, desc):
  33         tx_hash, prevouts, addrs = desc
  34         if ec:
  35             print "Error storing memory pool transaction", tx_hash, ec
  36             return
  37         print "Accepted transaction", tx_hash
  38         for idx, prevout in enumerate(prevouts):
  39             inpoint = bitcoin.input_point()
  40             inpoint.hash, inpoint.index = tx_hash, idx
  41             self.lookup_input[str(prevout)] = inpoint
  42         for idx, address in addrs:
  43             outpoint = bitcoin.output_point()
  44             outpoint.hash, outpoint.index = tx_hash, idx
  45             self.lookup_address[str(address)] = outpoint
  46         self.timestamps[str(tx_hash)] = int(time.time())
  47
  48     def confirmed(self, ec, desc):
  49         tx_hash, prevouts, addrs = desc
  50         if ec:
  51             print "Problem confirming transaction", tx_hash, ec
  52             return
  53         print "Confirmed", tx_hash
  54         for idx, prevout in enumerate(prevouts):
  55             inpoint = bitcoin.input_point()
  56             inpoint.hash, inpoint.index = tx_hash, idx
  57             assert self.lookup_input[str(prevout)] == inpoint
  58             del self.lookup_input[str(prevout)]
  59         for idx, address in addrs:
  60             outpoint = bitcoin.output_point()
  61             outpoint.hash, outpoint.index = tx_hash, idx
  62             self.lookup_address.delete(str(address), outpoint)
  63         del self.timestamps[str(tx_hash)]
  64
  65     def check(self, output_points, address, handle):
  66         class ExtendableDict(dict):
  67             pass
  68         result = []
  69         for outpoint in output_points:
  70             if self.lookup_input.has_key(str(outpoint)):
  71                 point = self.lookup_input[str(outpoint)]
  72                 info = ExtendableDict()
  73                 info["tx_hash"] = str(point.hash)
  74                 info["index"] = point.index
  75                 info["is_input"] = 1
  76                 info["timestamp"] = self.timestamps[info["tx_hash"]]
  77                 result.append(info)
  78         if self.lookup_address.has_key(str(address)):
  79             addr_points = self.lookup_address[str(address)]
  80             for point in addr_points:
  81                 info = ExtendableDict()
  82                 info["tx_hash"] = str(point.hash)
  83                 info["index"] = point.index
  84                 info["is_input"] = 0
  85                 info["timestamp"] = self.timestamps[info["tx_hash"]]
  86                 result.append(info)
  87         handle(result)
  88
  89 class PaymentEntry:
  90
  91     def __init__(self, output_point):
  92         self.lock = threading.Lock()
  93         self.output_point = output_point
  94         self.output_loaded = None
  95         self.input_point = None
  96         self.input_loaded = None
  97         self.raw_output_script = None
  98
  99     def is_loaded(self):
 100         with self.lock:
 101             if self.output_loaded is None:
 102                 return False
 103             elif self.has_input() and self.input_loaded is None:
 104                 return False
 105         return True
 106
 107     def has_input(self):
 108         return self.input_point is not False
 109
 110 class History:
 111
 112     def __init__(self, service, chain, txpool, membuf):
 113         self.chain = chain
 114         self.txpool = txpool
 115         self.membuf = membuf
 116         self.lock = threading.Lock()
 117         self._stopped = False
 118
 119     def start(self, address, handle_finish):
 120         self.statement = []
 121         self.membuf_result = None
 122         self.address = address
 123         self.handle_finish = handle_finish
 124
 125         address = bitcoin.payment_address(address)
 126         # To begin we fetch all the outputs (payments in)
 127         # associated with this address
 128         self.chain.fetch_outputs(address,
 129             bind(self.check_membuf, _1, _2))
 130
 131     def stop(self):
 132         with self.lock:
 133             assert self._stopped == False
 134             self._stopped = True
 135
 136     def stopped(self):
 137         with self.lock:
 138             return self._stopped
 139
 140     def stop_on_error(self, ec):
 141         if ec:
 142             self.handle_finish(None)
 143             self.stop()
 144         return self.stopped()
 145
 146     def check_membuf(self, ec, output_points):
 147         if self.stop_on_error(ec):
 148             return
 149         self.membuf.check(output_points, self.address,
 150             bind(self.start_loading, _1, output_points))
 151
 152     def start_loading(self, membuf_result, output_points):
 153         # Create a bunch of entry lines which are outputs and
 154         # then their corresponding input (if it exists)
 155         for outpoint in output_points:
 156             entry = PaymentEntry(outpoint)
 157             with self.lock:
 158                 self.statement.append(entry)
 159             # Attempt to fetch the spend of this output
 160             self.chain.fetch_spend(outpoint,
 161                 bind(self.load_spend, _1, _2, entry))
 162             self.load_tx_info(outpoint, entry, False)
 163         # Load memory pool transactions
 164         with self.lock:
 165             self.membuf_result = membuf_result
 166         for info in self.membuf_result:
 167             self.txpool.fetch(bitcoin.hash_digest(info["tx_hash"]),
 168                 bind(self.load_pool_tx, _1, _2, info))
 169
 170     def load_spend(self, ec, inpoint, entry):
 171         # Need a custom self.stop_on_error(...) as a missing spend
 172         # is not an error in this case.
 173         if not self.stopped() and ec and ec != bitcoin.error.unspent_output:
 174             self.handle_finish(None)
 175             self.stop()
 176         if self.stopped():
 177             return
 178         with entry.lock:
 179             if ec == bitcoin.error.unspent_output:
 180                 # This particular entry.output_point
 181                 # has not been spent yet
 182                 entry.input_point = False
 183             else:
 184                 entry.input_point = inpoint
 185         if ec == bitcoin.error.unspent_output:
 186             # Attempt to stop if all the info for the inputs and outputs
 187             # has been loaded.
 188             self.finish_if_done()
 189         else:
 190             # We still have to load at least one more payment outwards
 191             self.load_tx_info(inpoint, entry, True)
 192
 193     def finish_if_done(self):
 194         with self.lock:
 195             # Still have more entries to finish loading, so return
 196             if any(not entry.is_loaded() for entry in self.statement):
 197                 return
 198             # Memory buffer transactions finished loading?
 199             if any(not info.has_key("height") for info in self.membuf_result):
 200                 return
 201         # Whole operation completed successfully! Finish up.
 202         result = []
 203         for entry in self.statement:
 204             if entry.input_point:
 205                 # value of the input is simply the inverse of
 206                 # the corresponding output
 207                 entry.input_loaded["value"] = -entry.output_loaded["value"]
 208                 # output should come before the input as it's chronological
 209                 result.append(entry.output_loaded)
 210                 result.append(entry.input_loaded)
 211             else:
 212                 # Unspent outputs have a raw_output_script field
 213                 assert entry.raw_output_script is not None
 214                 entry.output_loaded["raw_output_script"] = \
 215                     entry.raw_output_script
 216                 result.append(entry.output_loaded)
 217         mempool_result = []
 218         for info in self.membuf_result:
 219             # Lookup prevout in result
 220             # Set "value" field
 221             if info["is_input"] == 1:
 222                 prevout_tx = None
 223                 for prevout_info in result:
 224                     if prevout_info["tx_hash"] == info.previous_output.hash:
 225                         prevout_tx = prevout_info
 226                 assert prevout_tx is not None
 227                 info["value"] = -prevout_info["value"]
 228             mempool_result.append(info)
 229         result.extend(mempool_result)
 230         self.handle_finish(result)
 231         self.stop()
 232
 233     def load_tx_info(self, point, entry, is_input):
 234         info = {}
 235         info["tx_hash"] = str(point.hash)
 236         info["index"] = point.index
 237         info["is_input"] = 1 if is_input else 0
 238         # Before loading the transaction, Stratum requires the hash
 239         # of the parent block, so we load the block depth and then
 240         # fetch the block header and hash it.
 241         self.chain.fetch_transaction_index(point.hash,
 242             bind(self.tx_index, _1, _2, _3, entry, info))
 243
 244     def tx_index(self, ec, block_depth, offset, entry, info):
 245         if self.stop_on_error(ec):
 246             return
 247         info["height"] = block_depth
 248         # And now for the block hash
 249         self.chain.fetch_block_header_by_depth(block_depth,
 250             bind(self.block_header, _1, _2, entry, info))
 251
 252     def block_header(self, ec, blk_head, entry, info):
 253         if self.stop_on_error(ec):
 254             return
 255         info["timestamp"] = blk_head.timestamp
 256         info["block_hash"] = str(bitcoin.hash_block_header(blk_head))
 257         tx_hash = bitcoin.hash_digest(info["tx_hash"])
 258         # Now load the actual main transaction for this input or output
 259         self.chain.fetch_transaction(tx_hash,
 260             bind(self.load_chain_tx, _1, _2, entry, info))
 261
 262     def load_pool_tx(self, ec, tx, info):
 263         if self.stop_on_error(ec):
 264             return
 265         # block_hash = mempool:5
 266         # inputs (load from prevtx)
 267         # outputs (load from tx)
 268         # raw_output_script (load from tx)
 269         # height is always None
 270         # value (get from finish_if_done)
 271         self.load_tx(tx, info)
 272         if info["is_input"] == 0:
 273             our_output = tx.outputs[info["index"]]
 274             info["value"] = our_output.value
 275             # Save serialised output script in case this output is unspent
 276             info["raw_output_script"] = \
 277                 str(bitcoin.save_script(our_output.output_script))
 278         else:
 279             assert(info["is_input"] == 1)
 280             info.previous_output = tx.inputs[info["index"]].previous_output
 281         # If all the inputs are loaded
 282         if self.inputs_all_loaded(info["inputs"]):
 283             # We are the sole input
 284             assert(info["is_input"] == 1)
 285             self.finish_if_done()
 286         create_handler = lambda prevout_index, input_index: \
 287             bind(self.load_input_pool_tx, _1, _2,
 288                 prevout_index, info, input_index)
 289         self.fetch_input_txs(tx, info, create_handler)
 290
 291     def load_tx(self, tx, info):
 292         # List of output addresses
 293         outputs = []
 294         for tx_out in tx.outputs:
 295             address = bitcoin.payment_address()
 296             # Attempt to extract address from output script
 297             if address.extract(tx_out.output_script):
 298                 outputs.append(address.encoded())
 299             else:
 300                 # ... otherwise append "Unknown"
 301                 outputs.append("Unknown")
 302         info["outputs"] = outputs
 303         # For the inputs, we need the originator address which has to
 304         # be looked up in the blockchain.
 305         # Create list of Nones and then populate it.
 306         # Loading has finished when list is no longer all None.
 307         info["inputs"] = [None for i in tx.inputs]
 308         # If this transaction was loaded for an input, then we already
 309         # have a source address for at least one input.
 310         if info["is_input"] == 1:
 311             info["inputs"][info["index"]] = self.address
 312
 313     def fetch_input_txs(self, tx, info, create_handler):
 314         # Load the previous_output for every input so we can get
 315         # the output address
 316         for input_index, tx_input in enumerate(tx.inputs):
 317             if info["is_input"] == 1 and info["index"] == input_index:
 318                 continue
 319             prevout = tx_input.previous_output
 320             handler = create_handler(prevout.index, input_index)
 321             self.chain.fetch_transaction(prevout.hash, handler)
 322
 323     def load_chain_tx(self, ec, tx, entry, info):
 324         if self.stop_on_error(ec):
 325             return
 326         self.load_tx(tx, info)
 327         if info["is_input"] == 0:
 328             our_output = tx.outputs[info["index"]]
 329             info["value"] = our_output.value
 330             # Save serialised output script in case this output is unspent
 331             with entry.lock:
 332                 entry.raw_output_script = \
 333                     str(bitcoin.save_script(our_output.output_script))
 334         # If all the inputs are loaded
 335         if self.inputs_all_loaded(info["inputs"]):
 336             # We are the sole input
 337             assert(info["is_input"] == 1)
 338             with entry.lock:
 339                 entry.input_loaded = info
 340             self.finish_if_done()
 341         create_handler = lambda prevout_index, input_index: \
 342             bind(self.load_input_chain_tx, _1, _2,
 343                 prevout_index, entry, info, input_index)
 344         self.fetch_input_txs(tx, info, create_handler)
 345
 346     def inputs_all_loaded(self, info_inputs):
 347         return not [empty_in for empty_in in info_inputs if empty_in is None]
 348
 349     def load_input_tx(self, tx, output_index, info, input_index):
 350         # For our input, we load the previous tx so we can get the
 351         # corresponding output.
 352         # We need the output to extract the address.
 353         script = tx.outputs[output_index].output_script
 354         address = bitcoin.payment_address()
 355         if address.extract(script):
 356             info["inputs"][input_index] = address.encoded()
 357         else:
 358             info["inputs"][input_index] = "Unknown"
 359
 360     def load_input_chain_tx(self, ec, tx, output_index,
 361                             entry, info, input_index):
 362         if self.stop_on_error(ec):
 363             return
 364         self.load_input_tx(tx, output_index, info, input_index)
 365         # If all the inputs are loaded, then we have finished loading
 366         # the info for this input-output entry pair
 367         if self.inputs_all_loaded(info["inputs"]):
 368             with entry.lock:
 369                 if info["is_input"] == 1:
 370                     entry.input_loaded = info
 371                 else:
 372                     entry.output_loaded = info
 373         self.finish_if_done()
 374
 375     def load_input_pool_tx(self, ec, tx, output_index, info, input_index):
 376         if self.stop_on_error(ec):
 377             return
 378         self.load_input_tx(tx, output_index, info, input_index)
 379         if not [inp for inp in info["inputs"] if inp is None]:
 380             # No more inputs left to load
 381             # This info has finished loading
 382             info["height"] = None
 383             info["block_hash"] = "mempool"
 384         self.finish_if_done()
 385
 386 if __name__ == "__main__":
 387     ex = bitcoin.satoshi_exporter()
 388     tx_a = bitcoin.data_chunk("0100000003d0406a31f628e18f5d894b2eaf4af719906dc61be4fb433a484ed870f6112d15000000008b48304502210089c11db8c1524d8839243803ac71e536f3d876e8265bbb3bc4a722a5d0bd40aa022058c3e59a7842ef1504b1c2ce048f9af2d69bbf303401dced1f68b38d672098a10141046060f6c8e355b94375eec2cc1d231f8044e811552d54a7c4b36fe8ee564861d07545c6c9d5b9f60d16e67d683b93486c01d3bd3b64d142f48af70bb7867d0ffbffffffff6152ed1552b1f2635317cea7be06615a077fc0f4aa62795872836c4182ca0f25000000008b48304502205f75a468ddb08070d235f76cb94c3f3e2a75e537bc55d087cc3e2a1559b7ac9b022100b17e4c958aaaf9b93359f5476aa5ed438422167e294e7207d5cfc105e897ed91014104a7108ec63464d6735302085124f3b7a06aa8f9363eab1f85f49a21689b286eb80fbabda7f838d9b6bff8550b377ad790b41512622518801c5230463dbbff6001ffffffff01c52914dcb0f3d8822e5a9e3374e5893a7b6033c9cfce5a8e5e6a1b3222a5cb010000008c4930460221009561f7206cc98f40f3eab5f3308b12846d76523bd07b5f058463f387694452b2022100b2684ec201760fa80b02954e588f071e46d0ff16562c1ab393888416bf8fcc44014104a7108ec63464d6735302085124f3b7a06aa8f9363eab1f85f49a21689b286eb80fbabda7f838d9b6bff8550b377ad790b41512622518801c5230463dbbff6001ffffffff02407e0f00000000001976a914c3b98829108923c41b3c1ba6740ecb678752fd5e88ac40420f00000000001976a914424648ea6548cc1c4ea707c7ca58e6131791785188ac00000000")
 389     tx_a = ex.load_transaction(tx_a)
 390     assert bitcoin.hash_transaction(tx_a) == "e72e4f025695446cfd5c5349d1720beb38801f329a00281f350cb7e847153397"
 391     tx_b = bitcoin.data_chunk("0100000001e269f0d74b8e6849233953715bc0be3ba6727afe0bc5000d015758f9e67dde34000000008c4930460221008e305e3fdf4420203a8cced5be20b73738a3b51186dfda7c6294ee6bebe331b7022100c812ded044196132f5e796dbf4b566b6ee3246cc4915eca3cf07047bcdf24a9301410493b6ce24182a58fc3bd0cbee0ddf5c282e00c0c10b1293c7a3567e95bfaaf6c9a431114c493ba50398ad0a82df06254605d963d6c226db615646fadd083ddfd9ffffffff020f9c1208000000001976a91492fffb2cb978d539b6bcd12c968b263896c6aacf88ac8e3f7600000000001976a914654dc745e9237f86b5fcdfd7e01165af2d72909588ac00000000")
 392     tx_b = ex.load_transaction(tx_b)
 393     assert bitcoin.hash_transaction(tx_b) == "acfda6dbf4ae1b102326bfb7c9541702d5ebb0339bc57bd74d36746855be8eac"
 394
 395     def blockchain_started(ec, chain):
 396         print "Blockchain initialisation:", ec
 397     def finish(result):
 398         print "Finish"
 399         if result is None:
 400             return
 401         for line in result:
 402             for k, v in line.iteritems():
 403                 begin = k + ":"
 404                 print begin, " " * (12 - len(begin)), v
 405             print
 406
 407     service = bitcoin.async_service(1)
 408     prefix = "/home/genjix/libbitcoin/database.old"
 409     chain = bitcoin.bdb_blockchain(service, prefix, blockchain_started)
 410     txpool = bitcoin.transaction_pool(service, chain)
 411     local_service = bitcoin.AsyncService()
 412     membuf = MemoryPoolBuffer(local_service, txpool, chain)
 413     membuf.recv_tx(tx_a)
 414     membuf.recv_tx(tx_b)
 415     raw_input()
 416     address = "1Jqu2PVGDvNv4La113hgCJsvRUCDb3W65D", "1EMnecJFwihf2pf4nE2m8fUNFKVRMWKqhR"
 417     #address = "1Pbn3DLXfjqF1fFV9YPdvpvyzejZwkHhZE"
 418     print "Looking up", address
 419     h = History(local_service, chain, txpool, membuf)
 420     h.start(address[0], finish)
 421     raw_input()
 422     h = History(local_service, chain, txpool, membuf)
 423     h.start(address[1], finish)
 424     raw_input()
 425     print "Stopping..."
 426