[SDK][Subgraph] Implement staking utilities and GraphQL queries for staker

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

@@ -572,15 +572,15 @@ Initializes a Escrow instance.
   * **manifest** (`str`) – Manifest data (can be a URL or JSON string)
   * **hash** (`str`) – Manifest file hash
 
-### *class* human_protocol_sdk.escrow.escrow_client.EscrowWithdraw(tx_hash, token_address, amount_withdrawn)
+### *class* human_protocol_sdk.escrow.escrow_client.EscrowWithdraw(tx_hash, token_address, withdrawn_amount)
 
 Bases: `object`
 
-#### \_\_init_\_(tx_hash, token_address, amount_withdrawn)
+#### \_\_init_\_(tx_hash, token_address, withdrawn_amount)
 
 Represents the result of an escrow cancellation transaction.
 
 * **Parameters:**
   * **tx_hash** (`str`) – The hash of the transaction associated with the escrow withdrawal.
   * **token_address** (`str`) – The address of the token used for the withdrawal.
-  * **amount_withdrawn** (`any`) – The amount withdrawn from the escrow.
+  * **withdrawn_amount** (`any`) – The amount withdrawn from the escrow.

docs/sdk/python/human_protocol_sdk.filter.md

@@ -76,6 +76,12 @@ Initializes a filter for payouts.
   * **skip** (`int`) – Optional number of payouts to skip. Default is 0.
   * **order_direction** ([`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)) – Optional order direction. Default is DESC.
 
+### *class* human_protocol_sdk.filter.StakersFilter(chain_id, min_staked_amount=None, max_staked_amount=None, min_locked_amount=None, max_locked_amount=None, min_withdrawn_amount=None, max_withdrawn_amount=None, min_slashed_amount=None, max_slashed_amount=None, order_by='lastDepositTimestamp', order_direction=OrderDirection.DESC, first=10, skip=0)
+
+Bases: `object`
+
+#### \_\_init_\_(chain_id, min_staked_amount=None, max_staked_amount=None, min_locked_amount=None, max_locked_amount=None, min_withdrawn_amount=None, max_withdrawn_amount=None, min_slashed_amount=None, max_slashed_amount=None, order_by='lastDepositTimestamp', order_direction=OrderDirection.DESC, first=10, skip=0)
+
 ### *class* human_protocol_sdk.filter.StatisticsFilter(date_from=None, date_to=None, first=10, skip=0, order_direction=OrderDirection.ASC)
 
 Bases: `object`

docs/sdk/python/human_protocol_sdk.md

@@ -78,6 +78,12 @@
       * [Module](human_protocol_sdk.staking.staking_client.md#module)
       * [`StakingClient`](human_protocol_sdk.staking.staking_client.md#human_protocol_sdk.staking.staking_client.StakingClient)
       * [`StakingClientError`](human_protocol_sdk.staking.staking_client.md#human_protocol_sdk.staking.staking_client.StakingClientError)
+    * [human_protocol_sdk.staking.staking_utils module](human_protocol_sdk.staking.staking_utils.md)
+      * [Code Example](human_protocol_sdk.staking.staking_utils.md#code-example)
+      * [Module](human_protocol_sdk.staking.staking_utils.md#module)
+      * [`StakerData`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakerData)
+      * [`StakingUtils`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtils)
+      * [`StakingUtilsError`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtilsError)
 * [human_protocol_sdk.statistics package](human_protocol_sdk.statistics.md)
   * [Submodules](human_protocol_sdk.statistics.md#submodules)
     * [human_protocol_sdk.statistics.statistics_client module](human_protocol_sdk.statistics.statistics_client.md)
@@ -173,6 +179,8 @@
   * [`FilterError`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.FilterError)
   * [`PayoutFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.PayoutFilter)
     * [`PayoutFilter.__init__()`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.PayoutFilter.__init__)
+  * [`StakersFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StakersFilter)
+    * [`StakersFilter.__init__()`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StakersFilter.__init__)
   * [`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)
     * [`StatisticsFilter.__init__()`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter.__init__)
   * [`StatusEventFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatusEventFilter)

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

@@ -17,24 +17,23 @@ print(
 
 ## Module
 
-### *class* human_protocol_sdk.operator.operator_utils.OperatorData(chain_id, id, address, amount_staked, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None, name=None, category=None)
+### *class* human_protocol_sdk.operator.operator_utils.OperatorData(chain_id, id, address, staked_amount, locked_amount, locked_until_timestamp, withdrawn_amount, slashed_amount, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None, name=None, category=None)
 
 Bases: `object`
 
-#### \_\_init_\_(chain_id, id, address, amount_staked, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None, name=None, category=None)
+#### \_\_init_\_(chain_id, id, address, staked_amount, locked_amount, locked_until_timestamp, withdrawn_amount, slashed_amount, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None, name=None, category=None)
 
 Initializes a OperatorData instance.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain Identifier
   * **id** (`str`) – Identifier
   * **address** (`str`) – Address
-  * **amount_staked** (`int`) – Amount staked
-  * **amount_locked** (`int`) – Amount locked
+  * **staked_amount** (`int`) – Amount staked
+  * **locked_amount** (`int`) – Amount locked
   * **locked_until_timestamp** (`int`) – Locked until timestamp
-  * **amount_withdrawn** (`int`) – Amount withdrawn
-  * **amount_slashed** (`int`) – Amount slashed
-  * **reward** (`int`) – Reward
+  * **withdrawn_amount** (`int`) – Amount withdrawn
+  * **slashed_amount** (`int`) – Amount slashed
   * **amount_jobs_processed** (`int`) – Amount of jobs launched
   * **role** (`Optional`[`str`]) – Role
   * **fee** (`Optional`[`int`]) – Fee
@@ -49,20 +48,20 @@ Initializes a OperatorData instance.
   * **name** (`Optional`[`str`]) – Name
   * **category** (`Optional`[`str`]) – Category
 
-### *class* human_protocol_sdk.operator.operator_utils.OperatorFilter(chain_id, roles=[], min_amount_staked=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
+### *class* human_protocol_sdk.operator.operator_utils.OperatorFilter(chain_id, roles=[], min_staked_amount=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
 
 Bases: `object`
 
 A class used to filter operators.
 
-#### \_\_init_\_(chain_id, roles=[], min_amount_staked=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
+#### \_\_init_\_(chain_id, roles=[], min_staked_amount=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
 
 Initializes a OperatorFilter instance.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain ID to request data
   * **roles** (`Optional`[`str`]) – Roles to filter by
-  * **min_amount_staked** (`Optional`[`int`]) – Minimum amount staked to filter by
+  * **min_staked_amount** (`Optional`[`int`]) – Minimum amount staked to filter by
   * **order_by** (`Optional`[`str`]) – Property to order by, e.g., “role”
   * **order_direction** ([`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)) – Order direction of results, “asc” or “desc”
   * **first** (`int`) – Number of items per page

docs/sdk/python/human_protocol_sdk.staking.md

@@ -17,3 +17,12 @@ obtain staking information from both the contracts and subgraph.
     * [`StakingClient.unstake()`](human_protocol_sdk.staking.staking_client.md#human_protocol_sdk.staking.staking_client.StakingClient.unstake)
     * [`StakingClient.withdraw()`](human_protocol_sdk.staking.staking_client.md#human_protocol_sdk.staking.staking_client.StakingClient.withdraw)
   * [`StakingClientError`](human_protocol_sdk.staking.staking_client.md#human_protocol_sdk.staking.staking_client.StakingClientError)
+* [human_protocol_sdk.staking.staking_utils module](human_protocol_sdk.staking.staking_utils.md)
+  * [Code Example](human_protocol_sdk.staking.staking_utils.md#code-example)
+  * [Module](human_protocol_sdk.staking.staking_utils.md#module)
+  * [`StakerData`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakerData)
+    * [`StakerData.__init__()`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakerData.__init__)
+  * [`StakingUtils`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtils)
+    * [`StakingUtils.get_staker()`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtils.get_staker)
+    * [`StakingUtils.get_stakers()`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtils.get_stakers)
+  * [`StakingUtilsError`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtilsError)

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

@@ -0,0 +1,49 @@
+# human_protocol_sdk.staking.staking_utils module
+
+Utility class for staking-related operations.
+
+## Code Example
+
+```python
+from human_protocol_sdk.constants import ChainId
+from human_protocol_sdk.staking.staking_utils import StakingUtils, StakersFilter
+
+stakers = StakingUtils.get_stakers(
+    StakersFilter(
+        chain_id=ChainId.POLYGON_AMOY,
+        min_staked_amount="1000000000000000000",
+        max_locked_amount="5000000000000000000",
+        order_by="withdrawnAmount",
+        order_direction="asc",
+        first=5,
+        skip=0,
+    )
+)
+print("Filtered stakers:", stakers)
+```
+
+## Module
+
+### *class* human_protocol_sdk.staking.staking_utils.StakerData(id, address, staked_amount, locked_amount, withdrawn_amount, slashed_amount, locked_until_timestamp, last_deposit_timestamp)
+
+Bases: `object`
+
+#### \_\_init_\_(id, address, staked_amount, locked_amount, withdrawn_amount, slashed_amount, locked_until_timestamp, last_deposit_timestamp)
+
+### *class* human_protocol_sdk.staking.staking_utils.StakingUtils
+
+Bases: `object`
+
+#### *static* get_staker(chain_id, address)
+
+* **Return type:**
+  `Optional`[[`StakerData`](#human_protocol_sdk.staking.staking_utils.StakerData)]
+
+#### *static* get_stakers(filter)
+
+* **Return type:**
+  `List`[[`StakerData`](#human_protocol_sdk.staking.staking_utils.StakerData)]
+
+### *exception* human_protocol_sdk.staking.staking_utils.StakingUtilsError
+
+Bases: `Exception`

docs/sdk/python/index.md

@@ -57,6 +57,7 @@ pip install human-protocol-sdk[agreement]
       * [`EscrowFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.EscrowFilter)
       * [`FilterError`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.FilterError)
       * [`PayoutFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.PayoutFilter)
+      * [`StakersFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StakersFilter)
       * [`StatisticsFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatisticsFilter)
       * [`StatusEventFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.StatusEventFilter)
       * [`TransactionFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.TransactionFilter)

docs/sdk/typescript/base/classes/BaseEthersClient.md

@@ -4,9 +4,9 @@
 
 [@human-protocol/sdk](../../modules.md) / [base](../README.md) / BaseEthersClient
 
-# Class: `abstract` BaseEthersClient
+# Abstract Class: BaseEthersClient
 
-Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L10)
+Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L10)
 
 ## Introduction
 
@@ -24,7 +24,7 @@ This class is used as a base class for other clients making on-chain calls.
 
 > **new BaseEthersClient**(`runner`, `networkData`): `BaseEthersClient`
 
-Defined in: [base.ts:20](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+Defined in: [base.ts:20](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
 
 **BaseClient constructor**
 
@@ -52,12 +52,12 @@ The network information required to connect to the contracts
 
 > **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
 
-Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
 
 ***
 
 ### runner
 
 > `protected` **runner**: `ContractRunner`
 
-Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)

docs/sdk/typescript/encryption/classes/Encryption.md

@@ -6,7 +6,7 @@
 
 # Class: Encryption
 
-Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
+Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
 
 ## Introduction
 
@@ -53,7 +53,7 @@ const encryption = await Encryption.build(privateKey, passphrase);
 
 > **new Encryption**(`privateKey`): `Encryption`
 
-Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
+Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
 
 Constructor for the Encryption class.
 
@@ -75,7 +75,7 @@ The private key.
 
 > **decrypt**(`message`, `publicKey?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
-Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
+Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
 
 This function decrypts messages using the private key. In addition, the public key can be added for signature verification.
 
@@ -129,7 +129,7 @@ const resultMessage = await encryption.decrypt('message');
 
 > **sign**(`message`): `Promise`\<`string`\>
 
-Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
+Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
 
 This function signs a message using the private key used to initialize the client.
 
@@ -165,7 +165,7 @@ const resultMessage = await encryption.sign('message');
 
 > **signAndEncrypt**(`message`, `publicKeys`): `Promise`\<`string`\>
 
-Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
+Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
 
 This function signs and encrypts a message using the private key used to initialize the client and the specified public keys.
 
@@ -232,7 +232,7 @@ const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
 
 > `static` **build**(`privateKeyArmored`, `passphrase?`): `Promise`\<`Encryption`\>
 
-Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/4856a3f52f40cebc5467b639c48c93c09d17622b/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
+Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/4dad01e5a92c46a45d83aec7fcaea2d2e541271c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
 
 Builds an Encryption instance by decrypting the private key from an encrypted private key and passphrase.