do not queue requests that can be answered using the cache
[electrum-server.git] / backends / abe / __init__.py
index 1971a6c..78271d0 100644 (file)
@@ -10,6 +10,28 @@ from Queue import Queue
 import time, threading
 
 
+import hashlib
+encode = lambda x: x[::-1].encode('hex')
+decode = lambda x: x.decode('hex')[::-1]
+Hash = lambda x: hashlib.sha256(hashlib.sha256(x).digest()).digest()
+
+def rev_hex(s):
+    return s.decode('hex')[::-1].encode('hex')
+
+def int_to_hex(i, length=1):
+    s = hex(i)[2:].rstrip('L')
+    s = "0"*(2*length - len(s)) + s
+    return rev_hex(s)
+
+def header_to_string(res):
+    s = int_to_hex(res.get('version'),4) \
+        + rev_hex(res.get('prev_block_hash')) \
+        + rev_hex(res.get('merkle_root')) \
+        + int_to_hex(int(res.get('timestamp')),4) \
+        + int_to_hex(int(res.get('bits')),4) \
+        + int_to_hex(int(res.get('nonce')),4)
+    return s
+
 
 class AbeStore(Datastore_class):
 
@@ -24,16 +46,43 @@ class AbeStore(Datastore_class):
         elif args.dbtype == 'psycopg2':
             args.connect_args = { 'database' : config.get('database','database') }
 
+        coin = config.get('server', 'coin')
+        self.addrtype = 0
+        if coin == 'litecoin':
+            print 'Litecoin settings:'
+            datadir = config.get('server','datadir')
+            print '  datadir = ' + datadir
+            args.datadir = [{"dirname":datadir,"chain":"Litecoin","code3":"LTC","address_version":"\u0030"}]
+            print '  addrtype = 48'
+            self.addrtype = 48
+
         Datastore_class.__init__(self,args)
 
+        # Use 1 (Bitcoin) if chain_id is not sent
+        self.chain_id = self.datadirs[0]["chain_id"] or 1
+        print 'Coin chain_id = %d' % self.chain_id
+
         self.sql_limit = int( config.get('database','limit') )
 
         self.tx_cache = {}
         self.bitcoind_url = 'http://%s:%s@%s:%s/' % ( config.get('bitcoind','user'), config.get('bitcoind','password'), config.get('bitcoind','host'), config.get('bitcoind','port'))
 
+        self.chunk_cache = {}
+
         self.address_queue = Queue()
 
-        self.dblock = thread.allocate_lock()
+        self.lock = threading.Lock()        # for the database
+        self.cache_lock = threading.Lock()  # for the cache
+        self.last_tx_id = 0
+        self.known_mempool_hashes = []
+
+
+    
+    def import_tx(self, tx, is_coinbase):
+        tx_id = super(AbeStore, self).import_tx(tx, is_coinbase)
+        self.last_tx_id = tx_id
+        return tx_id
+        
 
 
 
@@ -60,10 +109,12 @@ class AbeStore(Datastore_class):
                 #print "WARNING: missing tx_in for tx", txid
                 continue
 
-            address = hash_to_address(chr(0), _hash)
-            if self.tx_cache.has_key(address):
-                print "cache: invalidating", address
-                self.tx_cache.pop(address)
+            address = hash_to_address(chr(self.addrtype), _hash)
+            with self.cache_lock:
+                if self.tx_cache.has_key(address):
+                    print "cache: invalidating", address
+                    self.tx_cache.pop(address)
+
             self.address_queue.put(address)
 
         outrows = self.get_tx_outputs(txid, False)
@@ -73,23 +124,25 @@ class AbeStore(Datastore_class):
                 #print "WARNING: missing tx_out for tx", txid
                 continue
 
-            address = hash_to_address(chr(0), _hash)
-            if self.tx_cache.has_key(address):
-                print "cache: invalidating", address
-                self.tx_cache.pop(address)
+            address = hash_to_address(chr(self.addrtype), _hash)
+            with self.cache_lock:
+                if self.tx_cache.has_key(address):
+                    print "cache: invalidating", address
+                    self.tx_cache.pop(address)
+
             self.address_queue.put(address)
 
     def safe_sql(self,sql, params=(), lock=True):
 
         error = False
         try:
-            if lock: self.dblock.acquire()
+            if lock: self.lock.acquire()
             ret = self.selectall(sql,params)
         except:
             error = True
             traceback.print_exc(file=sys.stdout)
         finally:
-            if lock: self.dblock.release()
+            if lock: self.lock.release()
 
         if error: 
             raise BaseException('sql error')
@@ -152,8 +205,9 @@ class AbeStore(Datastore_class):
               JOIN txout prevout ON (txin.txout_id = prevout.txout_id)
               JOIN pubkey ON (pubkey.pubkey_id = prevout.pubkey_id)
              WHERE pubkey.pubkey_hash = ?
+               AND cc.chain_id = ?
                AND cc.in_longest = 1
-             LIMIT ? """, (dbhash,self.sql_limit))
+             LIMIT ? """, (dbhash, self.chain_id, self.sql_limit))
 
         if len(out)==self.sql_limit: 
             raise BaseException('limit reached')
@@ -195,8 +249,9 @@ class AbeStore(Datastore_class):
               JOIN txout ON (txout.tx_id = tx.tx_id)
               JOIN pubkey ON (pubkey.pubkey_id = txout.pubkey_id)
              WHERE pubkey.pubkey_hash = ?
+               AND cc.chain_id = ?
                AND cc.in_longest = 1
-               LIMIT ? """, (dbhash,self.sql_limit))
+               LIMIT ? """, (dbhash, self.chain_id, self.sql_limit))
 
         if len(out)==self.sql_limit: 
             raise BaseException('limit reached')
@@ -219,11 +274,15 @@ class AbeStore(Datastore_class):
             raise BaseException('limit reached')
         return out
 
-    def get_history(self, addr):
 
-        cached_version = self.tx_cache.get( addr )
-        if cached_version is not None:
-            return cached_version
+
+    def get_history(self, addr, cache_only=False):
+        with self.cache_lock:
+            cached_version = self.tx_cache.get( addr )
+            if cached_version is not None:
+                return cached_version
+
+        if cache_only: return -1
 
         version, binaddr = decode_check_address(addr)
         if binaddr is None:
@@ -268,22 +327,19 @@ class AbeStore(Datastore_class):
         rows += self.get_address_out_rows_memorypool( dbhash )
         address_has_mempool = False
 
-        current_id = self.safe_sql("""SELECT last_value FROM tx_seq""")
-        current_id = current_id[0][0]
-
         for row in rows:
             is_in, tx_hash, tx_id, pos, value = row
             tx_hash = self.hashout_hex(tx_hash)
             if tx_hash in known_tx:
                 continue
 
-            # this means that pending transactions were added to the db, even if they are not returned by getmemorypool
-            address_has_mempool = True
-
-            # fixme: we need to detect transactions that became invalid
-            if current_id - tx_id > 10000:
+            # discard transactions that are too old
+            if self.last_tx_id - tx_id > 50000:
+                print "discarding tx id", tx_id
                 continue
 
+            # this means that pending transactions were added to the db, even if they are not returned by getmemorypool
+            address_has_mempool = True
 
             #print "mempool", tx_hash
             txpoint = {
@@ -309,7 +365,7 @@ class AbeStore(Datastore_class):
                 if not _hash:
                     #print "WARNING: missing tx_in for tx", tx_id, addr
                     continue
-                address = hash_to_address(chr(0), _hash)
+                address = hash_to_address(chr(self.addrtype), _hash)
                 txinputs.append(address)
             txpoint['inputs'] = txinputs
             txoutputs = []
@@ -319,7 +375,7 @@ class AbeStore(Datastore_class):
                 if not _hash:
                     #print "WARNING: missing tx_out for tx", tx_id, addr
                     continue
-                address = hash_to_address(chr(0), _hash)
+                address = hash_to_address(chr(self.addrtype), _hash)
                 txoutputs.append(address)
             txpoint['outputs'] = txoutputs
 
@@ -336,17 +392,32 @@ class AbeStore(Datastore_class):
                 if row:
                     if not row[4]: txpoint['raw_output_script'] = row[1]
 
+            txpoint.pop('tx_id')
+
         # cache result
         # do not cache mempool results because statuses are ambiguous
         if not address_has_mempool:
-            self.tx_cache[addr] = txpoints
+            with self.cache_lock:
+                self.tx_cache[addr] = txpoints
         
         return txpoints
 
+    def get_history2(self, addr, cache_only=False):
+        h = self.get_history(addr, cache_only)
+        if cache_only and h==-1: return -1
+
+        out = map(lambda x: {'tx_hash':x['tx_hash'], 'height':x['height']}, h)
+        out2 = []
+        for item in out:
+            if item not in out2: out2.append(item)
+        return out2
 
-    def get_status(self,addr):
+
+    def get_status(self, addr, cache_only=False):
         # get address status, i.e. the last block for that address.
-        tx_points = self.get_history(addr)
+        tx_points = self.get_history(addr, cache_only)
+        if cache_only and tx_points == -1: return -1
+
         if not tx_points:
             status = None
         else:
@@ -357,38 +428,192 @@ class AbeStore(Datastore_class):
                 status = status + ':%d'% len(tx_points)
         return status
 
+    def get_status2(self, addr, cache_only=False):
+        # for 0.5 clients
+        tx_points = self.get_history2(addr)
+        if cache_only and tx_points == -1: return -1
+
+        if not tx_points: return None
+        status = ''
+        for tx in tx_points:
+            status += tx.get('tx_hash') + ':%d:' % tx.get('height')
+        return hashlib.sha256( status ).digest().encode('hex')
+
+
+    def get_block_header(self, block_height):
+        out = self.safe_sql("""
+            SELECT
+                block_hash,
+                block_version,
+                block_hashMerkleRoot,
+                block_nTime,
+                block_nBits,
+                block_nNonce,
+                block_height,
+                prev_block_hash,
+                block_id
+              FROM chain_summary
+             WHERE block_height = %d AND in_longest = 1"""%block_height)
+
+        if not out: raise BaseException("block not found")
+        row = out[0]
+        (block_hash, block_version, hashMerkleRoot, nTime, nBits, nNonce, height,prev_block_hash, block_id) \
+            = ( self.hashout_hex(row[0]), int(row[1]), self.hashout_hex(row[2]), int(row[3]), int(row[4]), int(row[5]), int(row[6]), self.hashout_hex(row[7]), int(row[8]) )
+
+        out = {"block_height":block_height, "version":block_version, "prev_block_hash":prev_block_hash, 
+                "merkle_root":hashMerkleRoot, "timestamp":nTime, "bits":nBits, "nonce":nNonce}
+        return out
+        
+
+    def get_chunk(self, index):
+        with self.cache_lock:
+            msg = self.chunk_cache.get(index)
+            if msg: return msg
+
+        sql = """
+            SELECT
+                block_hash,
+                block_version,
+                block_hashMerkleRoot,
+                block_nTime,
+                block_nBits,
+                block_nNonce,
+                block_height,
+                prev_block_hash,
+                block_height
+              FROM chain_summary
+             WHERE block_height >= %d AND block_height< %d AND in_longest = 1"""%(index*2016, (index+1)*2016)
+
+        out = self.safe_sql(sql)
+        msg = ''
+        for row in out:
+            (block_hash, block_version, hashMerkleRoot, nTime, nBits, nNonce, height, prev_block_hash, block_height) \
+                = ( self.hashout_hex(row[0]), int(row[1]), self.hashout_hex(row[2]), int(row[3]), int(row[4]), int(row[5]), int(row[6]), self.hashout_hex(row[7]), int(row[8]) )
+            h = {"block_height":block_height, "version":block_version, "prev_block_hash":prev_block_hash, 
+                   "merkle_root":hashMerkleRoot, "timestamp":nTime, "bits":nBits, "nonce":nNonce}
+
+            if h.get('block_height')==0: h['prev_block_hash'] = "0"*64
+            msg += header_to_string(h)
+
+            #print "hash", encode(Hash(msg.decode('hex')))
+            #if h.get('block_height')==1:break
+
+        with self.cache_lock:
+            self.chunk_cache[index] = msg
+        print "get_chunk", index, len(msg)
+        return msg
+
+
+
+    def get_raw_tx(self, tx_hash, height):
+        postdata = dumps({"method": 'getrawtransaction', 'params': [tx_hash, 0, height], 'id':'jsonrpc'})
+        respdata = urllib.urlopen(self.bitcoind_url, postdata).read()
+        r = loads(respdata)
+        if r['error'] != None:
+            raise BaseException(r['error'])
+
+        hextx = r.get('result')
+        return hextx
+
+
+    def get_tx_merkle(self, tx_hash):
+
+        out = self.safe_sql("""
+             SELECT block_tx.block_id FROM tx 
+             JOIN block_tx on tx.tx_id = block_tx.tx_id 
+             JOIN chain_summary on chain_summary.block_id = block_tx.block_id
+             WHERE tx_hash='%s' AND in_longest = 1"""%tx_hash)
+
+        if not out: raise BaseException("not in a block")
+        block_id = int(out[0][0])
+
+        # get block height
+        out = self.safe_sql("SELECT block_height FROM chain_summary WHERE block_id = %d AND in_longest = 1"%block_id)
+
+        if not out: raise BaseException("block not found")
+        block_height = int(out[0][0])
+
+        merkle = []
+        tx_pos = None
+
+        # list all tx in block
+        for row in self.safe_sql("""
+            SELECT DISTINCT tx_id, tx_pos, tx_hash
+              FROM txin_detail
+             WHERE block_id = ?
+             ORDER BY tx_pos""", (block_id,)):
+            _id, _pos, _hash = row
+            merkle.append(_hash)
+            if _hash == tx_hash: tx_pos = int(_pos)
+
+        # find subset.
+        # TODO: do not compute this on client request, better store the hash tree of each block in a database...
+
+        merkle = map(decode, merkle)
+        target_hash = decode(tx_hash)
+
+        s = []
+        while len(merkle) != 1:
+            if len(merkle)%2: merkle.append( merkle[-1] )
+            n = []
+            while merkle:
+                new_hash = Hash( merkle[0] + merkle[1] )
+                if merkle[0] == target_hash:
+                    s.append( encode(merkle[1]))
+                    target_hash = new_hash
+                elif merkle[1] == target_hash:
+                    s.append( encode(merkle[0]))
+                    target_hash = new_hash
+                n.append( new_hash )
+                merkle = merkle[2:]
+            merkle = n
+
+        # send result
+        return {"block_height":block_height, "merkle":s, "pos":tx_pos}
+
+
 
 
     def memorypool_update(store):
 
         ds = BCDataStream.BCDataStream()
-        postdata = dumps({"method": 'getmemorypool', 'params': [], 'id':'jsonrpc'})
-
+        postdata = dumps({"method": 'getrawmempool', 'params': [], 'id':'jsonrpc'})
         respdata = urllib.urlopen(store.bitcoind_url, postdata).read()
         r = loads(respdata)
         if r['error'] != None:
+            print r['error']
             return
 
-        v = r['result'].get('transactions')
-        for hextx in v:
+        mempool_hashes = r.get('result')
+        for tx_hash in mempool_hashes:
+
+            if tx_hash in store.known_mempool_hashes: continue
+            store.known_mempool_hashes.append(tx_hash)
+
+            postdata = dumps({"method": 'getrawtransaction', 'params': [tx_hash], 'id':'jsonrpc'})
+            respdata = urllib.urlopen(store.bitcoind_url, postdata).read()
+            r = loads(respdata)
+            if r['error'] != None:
+                continue
+            hextx = r.get('result')
             ds.clear()
             ds.write(hextx.decode('hex'))
             tx = deserialize.parse_Transaction(ds)
             tx['hash'] = util.double_sha256(tx['tx'])
-            tx_hash = store.hashin(tx['hash'])
-
+                
             if store.tx_find_id_and_value(tx):
                 pass
             else:
                 tx_id = store.import_tx(tx, False)
                 store.update_tx_cache(tx_id)
                 #print tx_hash
-    
+
         store.commit()
+        store.known_mempool_hashes = mempool_hashes
 
 
     def send_tx(self,tx):
-        postdata = dumps({"method": 'importtransaction', 'params': [tx], 'id':'jsonrpc'})
+        postdata = dumps({"method": 'sendrawtransaction', 'params': [tx], 'id':'jsonrpc'})
         respdata = urllib.urlopen(self.bitcoind_url, postdata).read()
         r = loads(respdata)
         if r['error'] != None:
@@ -399,23 +624,18 @@ class AbeStore(Datastore_class):
         return out
 
 
-    def main_iteration(store):
-        try:
-            store.dblock.acquire()
-            store.catch_up()
-            store.memorypool_update()
-            block_number = store.get_block_number(1)
-
-        except IOError:
-            print "IOError: cannot reach bitcoind"
-            block_number = 0
-        except:
-            traceback.print_exc(file=sys.stdout)
-            block_number = 0
-        finally:
-            store.dblock.release()
+    def main_iteration(self):
+        with self.lock:
+            self.catch_up()
+            self.memorypool_update()
+            height = self.get_block_number( self.chain_id )
+            try: self.chunk_cache.pop(height/2016) 
+            except: pass
+
+        block_header = self.get_block_header( height )
+        return block_header
+
 
-        return block_number
 
 
     def catch_up(store):
@@ -438,11 +658,23 @@ class BlockchainProcessor(Processor):
     def __init__(self, config):
         Processor.__init__(self)
         self.store = AbeStore(config)
-        self.block_number = -1
         self.watched_addresses = []
+
+        # catch_up first
+        self.block_header = self.store.main_iteration()
+        self.block_number = self.block_header.get('block_height')
+        print "blockchain: %d blocks"%self.block_number
+
         threading.Timer(10, self.run_store_iteration).start()
 
-    def process(self, request):
+
+    def add_request(self, request):
+        # see if we can get if from cache. if not, add to queue
+        if self.process( request, cache_only=True) == -1:
+            self.queue.put(request)
+
+
+    def process(self, request, cache_only = False):
         #print "abe process", request
 
         message_id = request['id']
@@ -454,10 +686,22 @@ class BlockchainProcessor(Processor):
         if method == 'blockchain.numblocks.subscribe':
             result = self.block_number
 
+        elif method == 'blockchain.headers.subscribe':
+            result = self.block_header
+
         elif method == 'blockchain.address.subscribe':
             try:
                 address = params[0]
-                result = self.store.get_status(address)
+                result = self.store.get_status(address, cache_only)
+                self.watch_address(address)
+            except BaseException, e:
+                error = str(e) + ': ' + address
+                print "error:", error
+
+        elif method == 'blockchain.address.subscribe2':
+            try:
+                address = params[0]
+                result = self.store.get_status2(address, cache_only)
                 self.watch_address(address)
             except BaseException, e:
                 error = str(e) + ': ' + address
@@ -466,19 +710,70 @@ class BlockchainProcessor(Processor):
         elif method == 'blockchain.address.get_history':
             try:
                 address = params[0]
-                result = self.store.get_history( address ) 
+                result = self.store.get_history( address, cache_only )
+            except BaseException, e:
+                error = str(e) + ': ' + address
+                print "error:", error
+
+        elif method == 'blockchain.address.get_history2':
+            try:
+                address = params[0]
+                result = self.store.get_history2( address, cache_only )
             except BaseException, e:
                 error = str(e) + ': ' + address
                 print "error:", error
 
+        elif method == 'blockchain.block.get_header':
+            if cache_only: 
+                result = -1
+            else:
+                try:
+                    height = params[0]
+                    result = self.store.get_block_header( height ) 
+                except BaseException, e:
+                    error = str(e) + ': %d'% height
+                    print "error:", error
+                    
+        elif method == 'blockchain.block.get_chunk':
+            if cache_only:
+                result = -1
+            else:
+                try:
+                    index = params[0]
+                    result = self.store.get_chunk( index ) 
+                except BaseException, e:
+                    error = str(e) + ': %d'% index
+                    print "error:", error
+                    
         elif method == 'blockchain.transaction.broadcast':
             txo = self.store.send_tx(params[0])
             print "sent tx:", txo
             result = txo 
 
+        elif method == 'blockchain.transaction.get_merkle':
+            if cache_only:
+                result = -1
+            else:
+                try:
+                    tx_hash = params[0]
+                    result = self.store.get_tx_merkle(tx_hash ) 
+                except BaseException, e:
+                    error = str(e) + ': ' + tx_hash
+                    print "error:", error
+                    
+        elif method == 'blockchain.transaction.get':
+            try:
+                tx_hash = params[0]
+                height = params[1]
+                result = self.store.get_raw_tx(tx_hash, height ) 
+            except BaseException, e:
+                error = str(e) + ': ' + tx_hash
+                print "error:", error
+
         else:
             error = "unknown method:%s"%method
 
+        if cache_only and result == -1: return -1
 
         if error:
             response = { 'id':message_id, 'error':error }
@@ -494,15 +789,29 @@ class BlockchainProcessor(Processor):
 
 
     def run_store_iteration(self):
+        
+        try:
+            t1 = time.time()
+            block_header = self.store.main_iteration()
+            t2 = time.time() - t1
+        except:
+            traceback.print_exc(file=sys.stdout)
+            print "terminating"
+            self.shared.stop()
+
         if self.shared.stopped(): 
             print "exit timer"
             return
-        
-        block_number = self.store.main_iteration()
-        if self.block_number != block_number:
-            self.block_number = block_number
-            print "block number:", self.block_number
-            self.push_response({ 'method':'blockchain.numblocks.subscribe', 'params':[self.block_number] })
+
+        if self.block_number != block_header.get('block_height'):
+            self.block_number = block_header.get('block_height')
+            print "block number: %d  (%.3f seconds)"%(self.block_number, t2)
+            self.push_response({ 'id': None, 'method':'blockchain.numblocks.subscribe', 'params':[self.block_number] })
+
+        if self.block_header != block_header:
+            self.block_header = block_header
+            self.push_response({ 'id': None, 'method':'blockchain.headers.subscribe', 'params':[self.block_header] })
+
 
         while True:
             try:
@@ -511,7 +820,9 @@ class BlockchainProcessor(Processor):
                 break
             if addr in self.watched_addresses:
                 status = self.store.get_status( addr )
-                self.push_response({ 'method':'blockchain.address.subscribe', 'params':[addr, status] })
+                status2 = self.store.get_status2( addr )
+                self.push_response({ 'id': None, 'method':'blockchain.address.subscribe', 'params':[addr, status] })
+                self.push_response({ 'id': None, 'method':'blockchain.address.subscribe2', 'params':[addr, status2] })
 
         threading.Timer(10, self.run_store_iteration).start()