echonet: refactor alchemy get_logs, return raw value (#10657)

Author: ayeletstarkware

echonet/l1_blocks.py

@@ -58,9 +58,11 @@ def find_l1_block_for_tx(
         if not start_block_data or not end_block_data:
             return None
 
-        logs = client.get_logs(start_block_data, end_block_data)
+        logs_response = client.get_logs(start_block_data, end_block_data)
+        if logs_response is None:
+            return None
 
-        for log in logs:
+        for log in logs_response.get("result", []):
             l1_event = L1Client.decode_log_response(log)
 
             if L1Blocks.l1_event_matches_feeder_tx(l1_event, feeder_tx):

echonet/l1_client.py

@@ -74,10 +74,10 @@ def _run_request_with_retry(
 
         return None
 
-    def get_logs(self, from_block: int, to_block: int) -> List[dict]:
+    def get_logs(self, from_block: int, to_block: int) -> Optional[Dict]:
         """
         Get logs from Ethereum using eth_getLogs RPC method.
-        Tries up to retries_count times. On failure, logs an error and returns [].
+        Tries up to retries_count times. On failure, logs an error and returns None.
         """
         if from_block > to_block:
             raise ValueError("from_block must be less than or equal to to_block")
@@ -97,7 +97,7 @@ def get_logs(self, from_block: int, to_block: int) -> List[dict]:
         }
 
         request_func = functools.partial(requests.post, self.rpc_url, json=payload)
-        data = self._run_request_with_retry(
+        return self._run_request_with_retry(
             request_func=request_func,
             additional_log_context={
                 "url": self.rpc_url,
@@ -106,11 +106,6 @@ def get_logs(self, from_block: int, to_block: int) -> List[dict]:
             },
         )
 
-        if data is None:
-            return []
-
-        return data.get("result", [])
-
     def get_block_by_number(self, block_number: str) -> Optional[Dict]:
         """
         Get block details by block number using eth_getBlockByNumber RPC method.

echonet/tests/test_l1_blocks.py

@@ -15,7 +15,7 @@ class TestL1Blocks(unittest.TestCase):
     def test_find_l1_block_for_tx_success(self):
         mock_client = Mock(spec=L1Client)
         mock_client.get_block_number_by_timestamp.side_effect = L1TestUtils.BLOCK_RANGE
-        mock_client.get_logs.return_value = [L1TestUtils.RAW_JSON_LOG]
+        mock_client.get_logs.return_value = L1TestUtils.LOGS_RPC_RESPONSE
 
         result = L1Blocks.find_l1_block_for_tx(L1TestUtils.FEEDER_TX, 1000, mock_client)
 
@@ -24,10 +24,12 @@ def test_find_l1_block_for_tx_success(self):
     def test_find_l1_block_for_tx_multiple_logs_finds_second(self):
         mock_client = Mock(spec=L1Client)
         mock_client.get_block_number_by_timestamp.side_effect = L1TestUtils.BLOCK_RANGE
-        mock_client.get_logs.return_value = [
-            L1TestUtils.raw_log_with_nonce(L1TestUtils.NONCE - 1),
-            L1TestUtils.RAW_JSON_LOG,
-        ]
+        mock_client.get_logs.return_value = L1TestUtils.logs_rpc_response_with_logs(
+            [
+                L1TestUtils.log_with_nonce(L1TestUtils.NONCE - 1),
+                L1TestUtils.LOG,
+            ]
+        )
 
         result = L1Blocks.find_l1_block_for_tx(L1TestUtils.FEEDER_TX, 1000, mock_client)
 
@@ -38,7 +40,9 @@ def test_find_l1_block_for_tx_multiple_logs_finds_second(self):
     def test_find_l1_block_for_tx_logs_dont_match(self):
         mock_client = Mock(spec=L1Client)
         mock_client.get_block_number_by_timestamp.side_effect = L1TestUtils.BLOCK_RANGE
-        mock_client.get_logs.return_value = [L1TestUtils.raw_log_with_nonce(L1TestUtils.NONCE - 1)]
+        mock_client.get_logs.return_value = L1TestUtils.logs_rpc_response_with_logs(
+            [L1TestUtils.log_with_nonce(L1TestUtils.NONCE - 1)]
+        )
 
         result = L1Blocks.find_l1_block_for_tx(L1TestUtils.FEEDER_TX, 1000, mock_client)
 
@@ -47,7 +51,7 @@ def test_find_l1_block_for_tx_logs_dont_match(self):
     def test_find_l1_block_for_tx_no_logs_found(self):
         mock_client = Mock(spec=L1Client)
         mock_client.get_block_number_by_timestamp.side_effect = L1TestUtils.BLOCK_RANGE
-        mock_client.get_logs.return_value = []
+        mock_client.get_logs.return_value = L1TestUtils.logs_rpc_response_with_logs([])
 
         result = L1Blocks.find_l1_block_for_tx(L1TestUtils.FEEDER_TX, 1000, mock_client)
 

echonet/tests/test_l1_client.py

@@ -19,7 +19,7 @@ def test_get_logs_retries_after_exception_and_succeeds_on_second_attempt(self, m
 
         successful_response = Mock()
         successful_response.raise_for_status.return_value = None
-        successful_response.json.return_value = {"result": [L1TestUtils.RAW_JSON_LOG]}
+        successful_response.json.return_value = L1TestUtils.LOGS_RPC_RESPONSE
         mock_post.side_effect = [request_exception, successful_response]
 
         client = L1Client(api_key="api_key")
@@ -29,7 +29,7 @@ def test_get_logs_retries_after_exception_and_succeeds_on_second_attempt(self, m
         )
 
         self.assertEqual(mock_post.call_count, 2)
-        self.assertEqual(logs, [L1TestUtils.RAW_JSON_LOG])
+        self.assertEqual(logs, L1TestUtils.LOGS_RPC_RESPONSE)
 
     def test_get_logs_raises_on_invalid_block_range(self):
         client = L1Client(api_key="api_key")
@@ -44,20 +44,18 @@ def test_get_logs_raises_on_invalid_block_range(self):
 
     @patch("l1_client.requests.post")
     def test_get_logs_when_rpc_result_is_empty(self, mock_post):
+        empty_response = L1TestUtils.logs_rpc_response_with_logs([])
         response_ok = Mock()
         response_ok.raise_for_status.return_value = None
-        response_ok.json.return_value = {"result": []}
+        response_ok.json.return_value = empty_response
 
         mock_post.return_value = response_ok
 
         client = L1Client(api_key="api_key")
-        logs = client.get_logs(
-            from_block=1,
-            to_block=1,
-        )
+        logs = client.get_logs(from_block=1, to_block=1)
 
         self.assertEqual(mock_post.call_count, 1)
-        self.assertEqual(logs, [])
+        self.assertEqual(logs, empty_response)
 
     @patch("l1_client.requests.post")
     def test_get_timestamp_of_block_retries_after_failure_and_succeeds(self, mock_post):
@@ -149,21 +147,21 @@ def test_get_timestamp_of_block_returns_none_when_block_not_found(
         self.assertIsNone(result)
 
     def test_decode_log_success(self):
-        result = L1Client.decode_log_response(L1TestUtils.RAW_JSON_LOG)
+        result = L1Client.decode_log_response(L1TestUtils.LOG)
 
         self.assertIsInstance(result, L1Client.L1Event)
         self.assertEqual(result, L1TestUtils.L1_EVENT)
 
     def test_decode_log_invalid_topics_raises_error(self):
-        log = copy.deepcopy(L1TestUtils.RAW_JSON_LOG)
+        log = copy.deepcopy(L1TestUtils.LOG)
         log["topics"] = ["0x1", "0x2"]
         with self.assertRaisesRegex(
             ValueError, "Log has insufficient topics for LogMessageToL2 event"
         ):
             L1Client.decode_log_response(log)
 
     def test_decode_log_wrong_signature_raises_error(self):
-        log = copy.deepcopy(L1TestUtils.RAW_JSON_LOG)
+        log = copy.deepcopy(L1TestUtils.LOG)
         log["topics"][0] = "0x0000000000000000000000000000000000000000000000000000000000000001"
         with self.assertRaisesRegex(ValueError, "Unhandled event signature"):
             L1Client.decode_log_response(log)

echonet/tests/test_utils.py

@@ -10,7 +10,8 @@ class L1TestUtils:
     BLOCK_RANGE = [BLOCK_NUMBER - 10, BLOCK_NUMBER + 10]
     NONCE = 0x19B255
 
-    RAW_JSON_LOG = {
+    # Log entry (the "result" content)
+    LOG = {
         "address": "0xc662c410c0ecf747543f5ba90660f6abebd9c8c4",
         "topics": [
             "0xdb80dd488acf86d17c747445b0eabb5d57c541d3bd7b6b87af987858e5066b2b",  # event_signature
@@ -36,6 +37,13 @@ class L1TestUtils:
         "removed": False,
     }
 
+    # Full JSON-RPC response from get_logs
+    LOGS_RPC_RESPONSE = {
+        "jsonrpc": "2.0",
+        "id": "1",
+        "result": [LOG],
+    }
+
     L1_EVENT = L1Client.L1Event(
         contract_address="0x616757a151c21f9be8775098d591c2807316d992bbc3bb1a5c1821630589256",
         entry_point_selector=0x1B64B1B3B690B43B9B514FB81377518F4039CD3E4F4914D8A6BDF01D679FB19,
@@ -73,8 +81,9 @@ class L1TestUtils:
     }
 
     @staticmethod
-    def raw_log_with_nonce(nonce: int) -> dict:
-        log = copy.deepcopy(L1TestUtils.RAW_JSON_LOG)
+    def log_with_nonce(nonce: int) -> dict:
+        """Returns a copy of LOG with a different nonce."""
+        log = copy.deepcopy(L1TestUtils.LOG)
 
         data = log["data"]
         nonce_hex = f"{nonce:064x}"
@@ -87,3 +96,12 @@ def raw_log_with_nonce(nonce: int) -> dict:
         log["data"] = data[:slot_start] + nonce_hex + data[slot_end:]
 
         return log
+
+    @staticmethod
+    def logs_rpc_response_with_logs(logs: list) -> dict:
+        """Returns a full JSON-RPC response with the given logs."""
+        return {
+            "jsonrpc": "2.0",
+            "id": "1",
+            "result": logs,
+        }