add retry configuration to subgraph requests across both SDKs

Also fixed unit tests

Author: flopez7

packages/sdk/python/human-protocol-sdk/example.py

@@ -18,6 +18,7 @@
 from human_protocol_sdk.operator import OperatorUtils, OperatorFilter
 from human_protocol_sdk.agreement import agreement
 from human_protocol_sdk.staking.staking_utils import StakingUtils
+from human_protocol_sdk.utils import SubgraphRetryConfig
 
 
 def get_escrow_statistics(statistics_client: StatisticsClient):
@@ -162,7 +163,8 @@ def get_escrows():
                 status=Status.Pending,
                 date_from=datetime.datetime(2023, 5, 8),
                 date_to=datetime.datetime(2023, 6, 8),
-            )
+            ),
+            SubgraphRetryConfig(3, 1000),
         )
     )
 
@@ -232,12 +234,13 @@ def get_stakers_example():
             chain_id=ChainId.POLYGON_AMOY,
             order_by="lastDepositTimestamp",
             order_direction=OrderDirection.ASC,
-        )
+        ),
+        SubgraphRetryConfig(3, 1000),
     )
     print("Filtered stakers:", len(stakers))
 
     if stakers:
-        staker = StakingUtils.get_staker(ChainId.LOCALHOST, stakers[0].address)
+        staker = StakingUtils.get_staker(ChainId.POLYGON_AMOY, stakers[0].address)
         print("Staker info:", staker.address)
     else:
         print("No stakers found.")

packages/sdk/python/human-protocol-sdk/human_protocol_sdk/escrow/escrow_utils.py

@@ -38,6 +38,7 @@
     PayoutFilter,
 )
 from human_protocol_sdk.utils import (
+    SubgraphRetryConfig,
     get_data_from_subgraph,
 )
 
@@ -219,10 +220,12 @@ class EscrowUtils:
     @staticmethod
     def get_escrows(
         filter: EscrowFilter,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> List[EscrowData]:
         """Get an array of escrow addresses based on the specified filter parameters.
 
         :param filter: Object containing all the necessary parameters to filter
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: List of escrows
 
@@ -283,6 +286,7 @@ def get_escrows(
                 "skip": filter.skip,
                 "orderDirection": filter.order_direction.value,
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -334,11 +338,13 @@ def get_escrows(
     def get_escrow(
         chain_id: ChainId,
         escrow_address: str,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> Optional[EscrowData]:
         """Returns the escrow for a given address.
 
         :param chain_id: Network in which the escrow has been deployed
         :param escrow_address: Address of the escrow
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: Escrow data
 
@@ -373,6 +379,7 @@ def get_escrow(
             params={
                 "escrowAddress": escrow_address.lower(),
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -414,11 +421,15 @@ def get_escrow(
         )
 
     @staticmethod
-    def get_status_events(filter: StatusEventFilter) -> List[StatusEvent]:
+    def get_status_events(
+        filter: StatusEventFilter,
+        retry_config: Optional[SubgraphRetryConfig] = None,
+    ) -> List[StatusEvent]:
         """
         Retrieve status events for specified networks and statuses within a date range.
 
         :param filter: Object containing all the necessary parameters to filter status events.
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return List[StatusEvent]: List of status events matching the query parameters.
 
@@ -447,6 +458,7 @@ def get_status_events(filter: StatusEventFilter) -> List[StatusEvent]:
                 "skip": filter.skip,
                 "orderDirection": filter.order_direction.value,
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -472,11 +484,15 @@ def get_status_events(filter: StatusEventFilter) -> List[StatusEvent]:
         return events_with_chain_id
 
     @staticmethod
-    def get_payouts(filter: PayoutFilter) -> List[Payout]:
+    def get_payouts(
+        filter: PayoutFilter,
+        retry_config: Optional[SubgraphRetryConfig] = None,
+    ) -> List[Payout]:
         """
         Fetch payouts from the subgraph based on the provided filter.
 
         :param filter: Object containing all the necessary parameters to filter payouts.
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return List[Payout]: List of payouts matching the query parameters.
 
@@ -508,6 +524,7 @@ def get_payouts(filter: PayoutFilter) -> List[Payout]:
                 "skip": filter.skip,
                 "orderDirection": filter.order_direction.value,
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -536,11 +553,13 @@ def get_payouts(filter: PayoutFilter) -> List[Payout]:
     @staticmethod
     def get_cancellation_refunds(
         filter: CancellationRefundFilter,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> List[CancellationRefund]:
         """
         Fetch cancellation refunds from the subgraph based on the provided filter.
 
         :param filter: Object containing all the necessary parameters to filter cancellation refunds.
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return List[CancellationRefund]: List of cancellation refunds matching the query parameters.
 
@@ -572,6 +591,7 @@ def get_cancellation_refunds(
                 "skip": filter.skip,
                 "orderDirection": filter.order_direction.value,
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -601,13 +621,16 @@ def get_cancellation_refunds(
 
     @staticmethod
     def get_cancellation_refund(
-        chain_id: ChainId, escrow_address: str
+        chain_id: ChainId,
+        escrow_address: str,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> CancellationRefund:
         """
         Returns the cancellation refund for a given escrow address.
 
         :param chain_id: Network in which the escrow has been deployed
         :param escrow_address: Address of the escrow
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: CancellationRefund data or None
 
@@ -641,6 +664,7 @@ def get_cancellation_refund(
             {
                 "escrowAddress": escrow_address.lower(),
             },
+            retry_config=retry_config,
         )
 
         if (

packages/sdk/python/human-protocol-sdk/human_protocol_sdk/kvstore/kvstore_utils.py

@@ -29,7 +29,7 @@
 import requests
 
 from human_protocol_sdk.constants import NETWORKS, ChainId, KVStoreKeys
-from human_protocol_sdk.utils import get_data_from_subgraph
+from human_protocol_sdk.utils import SubgraphRetryConfig, get_data_from_subgraph
 
 from human_protocol_sdk.kvstore.kvstore_client import KVStoreClientError
 
@@ -57,11 +57,13 @@ class KVStoreUtils:
     def get_kvstore_data(
         chain_id: ChainId,
         address: str,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> Optional[List[KVStoreData]]:
         """Returns the KVStore data for a given address.
 
         :param chain_id: Network in which the KVStore data has been deployed
         :param address: Address of the KVStore
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: List of KVStore data
 
@@ -94,6 +96,7 @@ def get_kvstore_data(
             params={
                 "address": address.lower(),
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -111,12 +114,18 @@ def get_kvstore_data(
         ]
 
     @staticmethod
-    def get(chain_id: ChainId, address: str, key: str) -> str:
+    def get(
+        chain_id: ChainId,
+        address: str,
+        key: str,
+        retry_config: Optional[SubgraphRetryConfig] = None,
+    ) -> str:
         """Gets the value of a key-value pair in the contract.
 
         :param chain_id: Network in which the KVStore data has been deployed
         :param address: The Ethereum address associated with the key-value pair
         :param key: The key of the key-value pair to get
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: The value of the key-value pair if it exists
 
@@ -149,6 +158,7 @@ def get(chain_id: ChainId, address: str, key: str) -> str:
                 "address": address.lower(),
                 "key": key,
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -163,13 +173,17 @@ def get(chain_id: ChainId, address: str, key: str) -> str:
 
     @staticmethod
     def get_file_url_and_verify_hash(
-        chain_id: ChainId, address: str, key: Optional[str] = "url"
+        chain_id: ChainId,
+        address: str,
+        key: Optional[str] = "url",
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> str:
         """Gets the URL value of the given entity, and verify its hash.
 
         :param chain_id: Network in which the KVStore data has been deployed
         :param address: Address from which to get the URL value.
         :param key: Configurable URL key. `url` by default.
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return url: The URL value of the given address if exists, and the content is valid
 
@@ -189,8 +203,10 @@ def get_file_url_and_verify_hash(
         if not Web3.is_address(address):
             raise KVStoreClientError(f"Invalid address: {address}")
 
-        url = KVStoreUtils.get(chain_id, address, key)
-        hash = KVStoreUtils.get(chain_id, address, key + "_hash")
+        url = KVStoreUtils.get(chain_id, address, key, retry_config=retry_config)
+        hash = KVStoreUtils.get(
+            chain_id, address, key + "_hash", retry_config=retry_config
+        )
 
         if len(url) == 0:
             return url

packages/sdk/python/human-protocol-sdk/human_protocol_sdk/operator/operator_utils.py

@@ -25,7 +25,7 @@
 
 from human_protocol_sdk.constants import NETWORKS, ChainId, OrderDirection
 from human_protocol_sdk.gql.reward import get_reward_added_events_query
-from human_protocol_sdk.utils import get_data_from_subgraph
+from human_protocol_sdk.utils import SubgraphRetryConfig, get_data_from_subgraph
 from web3 import Web3
 
 LOG = logging.getLogger("human_protocol_sdk.operator")
@@ -198,10 +198,14 @@ class OperatorUtils:
     """
 
     @staticmethod
-    def get_operators(filter: OperatorFilter) -> List[OperatorData]:
+    def get_operators(
+        filter: OperatorFilter,
+        retry_config: Optional[SubgraphRetryConfig] = None,
+    ) -> List[OperatorData]:
         """Get operators data of the protocol.
 
         :param filter: Operator filter
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: List of operators data
 
@@ -237,6 +241,7 @@ def get_operators(filter: OperatorFilter) -> List[OperatorData]:
                 "first": filter.first,
                 "skip": filter.skip,
             },
+            retry_config=retry_config,
         )
 
         if (
@@ -283,11 +288,13 @@ def get_operators(filter: OperatorFilter) -> List[OperatorData]:
     def get_operator(
         chain_id: ChainId,
         operator_address: str,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> Optional[OperatorData]:
         """Gets the operator details.
 
         :param chain_id: Network in which the operator exists
         :param operator_address: Address of the operator
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: Operator data if exists, otherwise None
 
@@ -318,6 +325,7 @@ def get_operator(
             network,
             query=get_operator_query,
             params={"address": operator_address.lower()},
+            retry_config=retry_config,
         )
 
         if (
@@ -359,12 +367,14 @@ def get_reputation_network_operators(
         chain_id: ChainId,
         address: str,
         role: Optional[str] = None,
+        retry_config: Optional[SubgraphRetryConfig] = None,
     ) -> List[OperatorData]:
         """Get the reputation network operators of the specified address.
 
         :param chain_id: Network in which the reputation network exists
         :param address: Address of the reputation oracle
         :param role: (Optional) Role of the operator
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: Returns an array of operator details
 
@@ -395,6 +405,7 @@ def get_reputation_network_operators(
             network,
             query=get_reputation_network_query(role),
             params={"address": address.lower(), "role": role},
+            retry_config=retry_config,
         )
 
         if (
@@ -438,11 +449,16 @@ def get_reputation_network_operators(
         return result
 
     @staticmethod
-    def get_rewards_info(chain_id: ChainId, slasher: str) -> List[RewardData]:
+    def get_rewards_info(
+        chain_id: ChainId,
+        slasher: str,
+        retry_config: Optional[SubgraphRetryConfig] = None,
+    ) -> List[RewardData]:
         """Get rewards of the given slasher.
 
         :param chain_id: Network in which the slasher exists
         :param slasher: Address of the slasher
+        :param retry_config: Optional retry behaviour for subgraph requests
 
         :return: List of rewards info
 
@@ -471,6 +487,7 @@ def get_rewards_info(chain_id: ChainId, slasher: str) -> List[RewardData]:
             network,
             query=get_reward_added_events_query,
             params={"slasherAddress": slasher.lower()},
+            retry_config=retry_config,
         )
 
         if (