Merge branch 'develop' into feat/sdk/remove-aurora

Author: flopez7

docs/sdk/changelog.md

@@ -1,12 +1,10 @@
 # Changelog
 
 ### Added
+- new optional config for querying subgraph with retries when failuers are due to bad indexers errors
 
 ### Changed
 
-- Relaxed several SDK return types (EscrowUtils, OperatorUtils, TransactionUtils, WorkerUtils) to allow `null` when a subgraph entity does not exist.
-- EscrowUtils.getEscrow now includes `chainId` in the returned object.
-
 ### Deprecated
 
 ### Removed

docs/sdk/python/human_protocol_sdk.escrow.escrow_utils.md

@@ -80,13 +80,14 @@ Bases: `object`
 
 A utility class that provides additional escrow-related functionalities.
 
-#### *static* get_cancellation_refund(chain_id, escrow_address)
+#### *static* get_cancellation_refund(chain_id, escrow_address, options=None)
 
 Returns the cancellation refund for a given escrow address.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the escrow has been deployed
   * **escrow_address** (`str`) – Address of the escrow
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   [`CancellationRefund`](#human_protocol_sdk.escrow.escrow_utils.CancellationRefund)
 * **Returns:**
@@ -104,26 +105,28 @@ Returns the cancellation refund for a given escrow address.
   )
   ```
 
-#### *static* get_cancellation_refunds(filter)
+#### *static* get_cancellation_refunds(filter, options=None)
 
 Fetch cancellation refunds from the subgraph based on the provided filter.
 
 * **Parameters:**
-  **filter** ([`CancellationRefundFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.CancellationRefundFilter)) – Object containing all the necessary parameters to filter cancellation refunds.
+  * **filter** ([`CancellationRefundFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.CancellationRefundFilter)) – Object containing all the necessary parameters to filter cancellation refunds.
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return List[CancellationRefund]:**
   List of cancellation refunds matching the query parameters.
 * **Raises:**
   [**EscrowClientError**](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an unsupported chain ID or invalid addresses are provided.
 * **Return type:**
   `List`[[`CancellationRefund`](#human_protocol_sdk.escrow.escrow_utils.CancellationRefund)]
 
-#### *static* get_escrow(chain_id, escrow_address)
+#### *static* get_escrow(chain_id, escrow_address, options=None)
 
 Returns the escrow for a given address.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the escrow has been deployed
   * **escrow_address** (`str`) – Address of the escrow
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `Optional`[[`EscrowData`](#human_protocol_sdk.escrow.escrow_utils.EscrowData)]
 * **Returns:**
@@ -141,12 +144,13 @@ Returns the escrow for a given address.
   )
   ```
 
-#### *static* get_escrows(filter)
+#### *static* get_escrows(filter, options=None)
 
 Get an array of escrow addresses based on the specified filter parameters.
 
 * **Parameters:**
-  **filter** ([`EscrowFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.EscrowFilter)) – Object containing all the necessary parameters to filter
+  * **filter** ([`EscrowFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.EscrowFilter)) – Object containing all the necessary parameters to filter
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `List`[[`EscrowData`](#human_protocol_sdk.escrow.escrow_utils.EscrowData)]
 * **Returns:**
@@ -168,25 +172,27 @@ Get an array of escrow addresses based on the specified filter parameters.
   )
   ```
 
-#### *static* get_payouts(filter)
+#### *static* get_payouts(filter, options=None)
 
 Fetch payouts from the subgraph based on the provided filter.
 
 * **Parameters:**
-  **filter** ([`PayoutFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.PayoutFilter)) – Object containing all the necessary parameters to filter payouts.
+  * **filter** ([`PayoutFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.PayoutFilter)) – Object containing all the necessary parameters to filter payouts.
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return List[Payout]:**
   List of payouts matching the query parameters.
 * **Raises:**
   [**EscrowClientError**](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an unsupported chain ID or invalid addresses are provided.
 * **Return type:**
   `List`[[`Payout`](#human_protocol_sdk.escrow.escrow_utils.Payout)]
 
-#### *static* get_status_events(filter)
+#### *static* get_status_events(filter, options=None)
 
 Retrieve status events for specified networks and statuses within a date range.
 
 * **Parameters:**
-  **filter** ([`StatusEventFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatusEventFilter)) – Object containing all the necessary parameters to filter status events.
+  * **filter** ([`StatusEventFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatusEventFilter)) – Object containing all the necessary parameters to filter status events.
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return List[StatusEvent]:**
   List of status events matching the query parameters.
 * **Raises:**

docs/sdk/python/human_protocol_sdk.kvstore.kvstore_utils.md

@@ -36,14 +36,15 @@ Bases: `object`
 
 A utility class that provides additional KVStore-related functionalities.
 
-#### *static* get(chain_id, address, key)
+#### *static* get(chain_id, address, key, options=None)
 
 Gets the value of a key-value pair in the contract.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the KVStore data has been deployed
   * **address** (`str`) – The Ethereum address associated with the key-value pair
   * **key** (`str`) – The key of the key-value pair to get
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `str`
 * **Returns:**
@@ -61,14 +62,15 @@ Gets the value of a key-value pair in the contract.
   print(result)
   ```
 
-#### *static* get_file_url_and_verify_hash(chain_id, address, key='url')
+#### *static* get_file_url_and_verify_hash(chain_id, address, key='url', options=None)
 
 Gets the URL value of the given entity, and verify its hash.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the KVStore data has been deployed
   * **address** (`str`) – Address from which to get the URL value.
   * **key** (`Optional`[`str`]) – Configurable URL key. url by default.
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return url:**
   The URL value of the given address if exists, and the content is valid
 * **Example:**
@@ -85,13 +87,14 @@ Gets the URL value of the given entity, and verify its hash.
 * **Return type:**
   `str`
 
-#### *static* get_kvstore_data(chain_id, address)
+#### *static* get_kvstore_data(chain_id, address, options=None)
 
 Returns the KVStore data for a given address.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the KVStore data has been deployed
   * **address** (`str`) – Address of the KVStore
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `Optional`[`List`[[`KVStoreData`](#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData)]]
 * **Returns:**

docs/sdk/python/human_protocol_sdk.md

@@ -204,16 +204,20 @@
     * [`Encryption.is_encrypted()`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.Encryption.is_encrypted)
   * [`InvalidPublicKey`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.InvalidPublicKey)
 * [human_protocol_sdk.utils module](human_protocol_sdk.utils.md)
+  * [`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)
+    * [`SubgraphOptions.__init__()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions.__init__)
+    * [`SubgraphOptions.base_delay`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions.base_delay)
+    * [`SubgraphOptions.max_retries`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions.max_retries)
+  * [`custom_gql_fetch()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.custom_gql_fetch)
   * [`get_contract_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_contract_interface)
-  * [`get_data_from_subgraph()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_data_from_subgraph)
   * [`get_erc20_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_erc20_interface)
   * [`get_escrow_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_escrow_interface)
   * [`get_factory_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_factory_interface)
   * [`get_hmt_balance()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_hmt_balance)
   * [`get_kvstore_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_kvstore_interface)
   * [`get_staking_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_staking_interface)
   * [`handle_error()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.handle_error)
+  * [`is_indexer_error()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.is_indexer_error)
   * [`parse_transfer_transaction()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.parse_transfer_transaction)
   * [`validate_json()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.validate_json)
   * [`validate_url()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.validate_url)
-  * [`with_retry()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.with_retry)

docs/sdk/python/human_protocol_sdk.operator.operator_utils.md

@@ -73,13 +73,14 @@ Bases: `object`
 
 A utility class that provides additional operator-related functionalities.
 
-#### *static* get_operator(chain_id, operator_address)
+#### *static* get_operator(chain_id, operator_address, options=None)
 
 Gets the operator details.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the operator exists
   * **operator_address** (`str`) – Address of the operator
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `Optional`[[`OperatorData`](#human_protocol_sdk.operator.operator_utils.OperatorData)]
 * **Returns:**
@@ -96,12 +97,13 @@ Gets the operator details.
   print(operator_data)
   ```
 
-#### *static* get_operators(filter)
+#### *static* get_operators(filter, options=None)
 
 Get operators data of the protocol.
 
 * **Parameters:**
-  **filter** ([`OperatorFilter`](#human_protocol_sdk.operator.operator_utils.OperatorFilter)) – Operator filter
+  * **filter** ([`OperatorFilter`](#human_protocol_sdk.operator.operator_utils.OperatorFilter)) – Operator filter
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `List`[[`OperatorData`](#human_protocol_sdk.operator.operator_utils.OperatorData)]
 * **Returns:**
@@ -118,14 +120,15 @@ Get operators data of the protocol.
   )
   ```
 
-#### *static* get_reputation_network_operators(chain_id, address, role=None)
+#### *static* get_reputation_network_operators(chain_id, address, role=None, options=None)
 
 Get the reputation network operators of the specified address.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the reputation network exists
   * **address** (`str`) – Address of the reputation oracle
   * **role** (`Optional`[`str`]) – (Optional) Role of the operator
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `List`[[`OperatorData`](#human_protocol_sdk.operator.operator_utils.OperatorData)]
 * **Returns:**
@@ -142,13 +145,14 @@ Get the reputation network operators of the specified address.
   print(operators)
   ```
 
-#### *static* get_rewards_info(chain_id, slasher)
+#### *static* get_rewards_info(chain_id, slasher, options=None)
 
 Get rewards of the given slasher.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the slasher exists
   * **slasher** (`str`) – Address of the slasher
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `List`[[`RewardData`](#human_protocol_sdk.operator.operator_utils.RewardData)]
 * **Returns:**

docs/sdk/python/human_protocol_sdk.staking.staking_utils.md

@@ -34,12 +34,12 @@ Bases: `object`
 
 Bases: `object`
 
-#### *static* get_staker(chain_id, address)
+#### *static* get_staker(chain_id, address, options=None)
 
 * **Return type:**
   `Optional`[[`StakerData`](#human_protocol_sdk.staking.staking_utils.StakerData)]
 
-#### *static* get_stakers(filter)
+#### *static* get_stakers(filter, options=None)
 
 * **Return type:**
   `List`[[`StakerData`](#human_protocol_sdk.staking.staking_utils.StakerData)]

docs/sdk/python/human_protocol_sdk.statistics.statistics_client.md

@@ -161,12 +161,13 @@ Initializes a Statistics instance
 * **Parameters:**
   **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain ID to get statistical data from
 
-#### get_escrow_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>)
+#### get_escrow_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)
 
 Get escrow statistics data for the given date range.
 
 * **Parameters:**
-  **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   [`EscrowStatistics`](#human_protocol_sdk.statistics.statistics_client.EscrowStatistics)
 * **Returns:**
@@ -190,12 +191,13 @@ Get escrow statistics data for the given date range.
   )
   ```
 
-#### get_hmt_daily_data(filter=<human_protocol_sdk.filter.StatisticsFilter object>)
+#### get_hmt_daily_data(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)
 
 Get HMT daily statistics data for the given date range.
 
 * **Parameters:**
-  **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `List`[[`DailyHMTData`](#human_protocol_sdk.statistics.statistics_client.DailyHMTData)]
 * **Returns:**
@@ -218,12 +220,13 @@ Get HMT daily statistics data for the given date range.
   )
   ```
 
-#### get_hmt_holders(param=<human_protocol_sdk.statistics.statistics_client.HMTHoldersParam object>)
+#### get_hmt_holders(param=<human_protocol_sdk.statistics.statistics_client.HMTHoldersParam object>, options=None)
 
 Get HMT holders data with optional filters and ordering.
 
 * **Parameters:**
-  **param** ([`HMTHoldersParam`](#human_protocol_sdk.statistics.statistics_client.HMTHoldersParam)) – Object containing filter and order parameters
+  * **param** ([`HMTHoldersParam`](#human_protocol_sdk.statistics.statistics_client.HMTHoldersParam)) – Object containing filter and order parameters
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   `List`[[`HMTHolder`](#human_protocol_sdk.statistics.statistics_client.HMTHolder)]
 * **Returns:**
@@ -246,10 +249,12 @@ Get HMT holders data with optional filters and ordering.
   )
   ```
 
-#### get_hmt_statistics()
+#### get_hmt_statistics(options=None)
 
 Get HMT statistics data.
 
+* **Parameters:**
+  **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   [`HMTStatistics`](#human_protocol_sdk.statistics.statistics_client.HMTStatistics)
 * **Returns:**
@@ -264,12 +269,13 @@ Get HMT statistics data.
   print(statistics_client.get_hmt_statistics())
   ```
 
-#### get_payment_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>)
+#### get_payment_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)
 
 Get payment statistics data for the given date range.
 
 * **Parameters:**
-  **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   [`PaymentStatistics`](#human_protocol_sdk.statistics.statistics_client.PaymentStatistics)
 * **Returns:**
@@ -293,12 +299,13 @@ Get payment statistics data for the given date range.
   )
   ```
 
-#### get_worker_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>)
+#### get_worker_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)
 
 Get worker statistics data for the given date range.
 
 * **Parameters:**
-  **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **filter** ([`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)) – Object containing the date range
+  * **options** (`Optional`[[`SubgraphOptions`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.SubgraphOptions)]) – Optional config for subgraph requests
 * **Return type:**
   [`WorkerStatistics`](#human_protocol_sdk.statistics.statistics_client.WorkerStatistics)
 * **Returns:**