Merge pull request #211 from OpShin/feat/cache_chain_tip

Per default refetch the chain tip at most every 20 seconds

Author: cffls

pycardano/backend/base.py

@@ -8,7 +8,7 @@
 from pycardano.address import Address
 from pycardano.network import Network
 from pycardano.plutus import ExecutionUnits
-from pycardano.transaction import UTxO, Transaction
+from pycardano.transaction import Transaction, UTxO
 
 __all__ = [
     "GenesisParameters",

pycardano/backend/ogmios.py

@@ -1,4 +1,5 @@
 import json
+import time
 from datetime import datetime, timezone
 from enum import Enum
 from typing import Any, Dict, List, Optional, Tuple, Union
@@ -45,6 +46,7 @@ class OgmiosChainContext(ChainContext):
     _service_name: str
     _kupo_url: Optional[str]
     _last_known_block_slot: int
+    _last_chain_tip_fetch: float
     _genesis_param: Optional[GenesisParameters]
     _protocol_param: Optional[ProtocolParameters]
 
@@ -54,14 +56,26 @@ def __init__(
         network: Network,
         compact_result=True,
         kupo_url=None,
+        refetch_chain_tip_interval: Optional[float] = None,
     ):
         self._ws_url = ws_url
         self._network = network
         self._service_name = "ogmios.v1:compact" if compact_result else "ogmios"
         self._kupo_url = kupo_url
         self._last_known_block_slot = 0
+        self._refetch_chain_tip_interval = (
+            refetch_chain_tip_interval
+            if refetch_chain_tip_interval is not None
+            else 1000
+        )
+        self._last_chain_tip_fetch = 0
         self._genesis_param = None
         self._protocol_param = None
+        if refetch_chain_tip_interval is None:
+            self._refetch_chain_tip_interval = (
+                self.genesis_param.slot_length
+                / self.genesis_param.active_slots_coefficient
+            )
 
     def _request(self, method: OgmiosQueryType, args: JsonDict) -> Any:
         ws = websocket.WebSocket()
@@ -110,8 +124,12 @@ def _query_utxos_by_tx_id(self, tx_id: str, index: int) -> List[List[JsonDict]]:
         return self._request(OgmiosQueryType.Query, args)
 
     def _is_chain_tip_updated(self):
+        # fetch at most every twenty seconds!
+        if time.time() - self._last_chain_tip_fetch < self._refetch_chain_tip_interval:
+            return False
+        self._last_chain_tip_fetch = time.time()
         slot = self.last_block_slot
-        if self._last_known_block_slot != slot:
+        if self._last_known_block_slot < slot:
             self._last_known_block_slot = slot
             return True
         else:

test/pycardano/backend/test_ogmios.py

@@ -1,3 +1,5 @@
+from unittest.mock import patch
+
 from pycardano.backend.base import GenesisParameters, ProtocolParameters
 from pycardano.backend.ogmios import OgmiosChainContext
 from pycardano.network import Network
@@ -80,30 +82,31 @@
 ]
 
 
-class TestOgmiosChainContext:
-    chain_context = OgmiosChainContext("", Network.TESTNET)
-
-    def override_request(method, args):
-        if args["query"] == "currentProtocolParameters":
-            return PROTOCOL_RESULT
-        elif args["query"] == "genesisConfig":
-            return GENESIS_RESULT
-        elif "utxo" in args["query"]:
-            query = args["query"]["utxo"][0]
-            if isinstance(query, dict):
-                for utxo in UTXOS:
-                    if (
-                        utxo[0]["txId"] == query["txId"]
-                        and utxo[0]["index"] == query["index"]
-                    ):
-                        return [utxo]
-                return []
-            else:
-                return UTXOS
+def override_request(method, args):
+    if args["query"] == "currentProtocolParameters":
+        return PROTOCOL_RESULT
+    elif args["query"] == "genesisConfig":
+        return GENESIS_RESULT
+    elif "utxo" in args["query"]:
+        query = args["query"]["utxo"][0]
+        if isinstance(query, dict):
+            for utxo in UTXOS:
+                if (
+                    utxo[0]["txId"] == query["txId"]
+                    and utxo[0]["index"] == query["index"]
+                ):
+                    return [utxo]
+            return []
         else:
-            return None
+            return UTXOS
+    else:
+        return None
 
-    chain_context._request = override_request
+
+class TestOgmiosChainContext:
+    def __init__(self):
+        with patch("OgmiosChainContext._request", return_value=override_request):
+            self.chain_context = OgmiosChainContext("", Network.TESTNET)
 
     def test_protocol_param(self):
         assert (