PR-1590 conflicts resolved

.github/workflows/ci-dependency-review.yaml

@@ -11,4 +11,4 @@ jobs:
       - name: "Checkout Repository"
         uses: actions/checkout@v4
       - name: "Dependency Review"
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4

.github/workflows/ci-test-core.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
   workflow_dispatch:
 
 jobs:

.github/workflows/ci-test-dashboard-ui.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/typescript/human-protocol-sdk/**'
       - 'packages/sdk/typescript/subgraph/**'
       - 'packages/apps/dashboard/ui/**'

.github/workflows/ci-test-faucet-server.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/typescript/human-protocol-sdk/**'
       - 'packages/apps/faucet-server/**'
   workflow_dispatch:

.github/workflows/ci-test-fortune-v3.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/typescript/human-protocol-sdk/**'
       - 'packages/app/fortune/**'
   workflow_dispatch:

.github/workflows/ci-test-job-launcher.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - "packages/core/**"
-      - "!packages/core/mx/**"
       - "packages/sdk/typescript/human-protocol-sdk/**"
       - "packages/apps/job-launcher/**"
   workflow_dispatch:

.github/workflows/ci-test-meta-code-verify.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/typescript/human-protocol-sdk/**'
       - 'packages/apps/meta-code-verify/**'
   workflow_dispatch:

.github/workflows/ci-test-node-sdk.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/typescript/human-protocol-sdk/**'
   workflow_dispatch:
 

.github/workflows/ci-test-python-sdk.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/python/human-protocol-sdk/**'
   workflow_dispatch:
 

.github/workflows/ci-test-reputation-oracle.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - "packages/core/**"
-      - "!packages/core/mx/**"
       - "packages/sdk/typescript/human-protocol-sdk/**"
       - "packages/apps/reputation-oracle/**"
   workflow_dispatch:

.github/workflows/ci-test-subgraph.yaml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - 'packages/core/**'
-      - '!packages/core/mx/**'
       - 'packages/sdk/typescript/subgraph/**'
   workflow_dispatch:
 

docs/sdk/SUMMARY.md

@@ -2,47 +2,52 @@
 
 ## Typescript SDK​
 
-* [Encryption](typescript/modules/encryption.md)
-  * [Encryption](typescript/classes/encryption.Encryption.md)
-  * [EncryptionUtils](typescript/classes/encryption.EncryptionUtils.md)
-* [Escrow](typescript/modules/escrow.md)
-  * [EscrowClient](typescript/classes/escrow.EscrowClient.md)
-  * [EscrowUtils](typescript/classes/escrow.EscrowUtils.md)
-* [KVStore](typescript/modules/kvstore.md)
-  * [KVStoreClient](typescript/classes/kvstore.KVStoreClient.md)
-* [Staking](typescript/modules/staking.md)
-  * [StakingClient](typescript/classes/staking.StakingClient.md)
-* [Storage](typescript/modules/storage.md)
-  * [StorageClient](typescript/classes/storage.StorageClient.md)
-* [Statistics](typescript/modules/statistics.md)
-  * [StatisticsClient](typescript/classes/statistics.StatisticsClient.md)
+- [Encryption](typescript/modules/encryption.md)
+  - [Encryption](typescript/classes/encryption.Encryption.md)
+  - [EncryptionUtils](typescript/classes/encryption.EncryptionUtils.md)
+- [Escrow](typescript/modules/escrow.md)
+  - [EscrowClient](typescript/classes/escrow.EscrowClient.md)
+  - [EscrowUtils](typescript/classes/escrow.EscrowUtils.md)
+- [KVStore](typescript/modules/kvstore.md)
+  - [KVStoreClient](typescript/classes/kvstore.KVStoreClient.md)
+- [Staking](typescript/modules/staking.md)
+  - [StakingClient](typescript/classes/staking.StakingClient.md)
+- [Operator](typescript/modules/operator.md)
+  - [OperatorUtils](typescript/classes/staoperatorking.OperatorUtils.md)
+- [Storage](typescript/modules/storage.md)
+  - [StorageClient](typescript/classes/storage.StorageClient.md)
+- [Statistics](typescript/modules/statistics.md)
+  - [StatisticsClient](typescript/classes/statistics.StatisticsClient.md)
 
 ## Python SDK
 
-* [agreement](python/human_protocol_sdk.agreement.md)
-  * [bootstrap](python/human_protocol_sdk.agreement.bootstrap.md)
-  * [measures](python/human_protocol_sdk.agreement.measures.md)
-  * [utils](python/human_protocol_sdk.agreement.utils.md)
-* [encryption](python/human_protocol_sdk.encryption.md)
-  * [encryption](python/human_protocol_sdk.encryption.encryption.md)
-  * [legacy_encryption](python/human_protocol_sdk.legacy_encryption.md)
-  * [encryption_utils](python/human_protocol_sdk.encryption.encryption_utils.md)
-* [escrow](python/human_protocol_sdk.escrow.md)
-  * [escrow_client](python/human_protocol_sdk.escrow.escrow_client.md)
-  * [escrow_utils](python/human_protocol_sdk.escrow.escrow_utils.md)
-* [kvstore](python/human_protocol_sdk.kvstore.md)
-  * [kvstore_client](python/human_protocol_sdk.kvstore.kvstore_client.md)
-* [staking](python/human_protocol_sdk.staking.md)
-  * [staking_client](python/human_protocol_sdk.staking.staking_client.md)
-  * [staking_utils](python/human_protocol_sdk.staking.staking_utils.md)
-* [statistics](python/human_protocol_sdk.statistics.md)
-  * [statistics_client](python/human_protocol_sdk.statistics.statistics_client.md)
-* [storage](python/human_protocol_sdk.storage.md)
-  * [storage_client](python/human_protocol_sdk.storage.storage_client.md)
-  * [storage_utils](python/human_protocol_sdk.storage.storage_utils.md)
-* [constants](python/human_protocol_sdk.constants.md)
-* [filter](python/human_protocol_sdk.filter.md)
-* [utils](python/human_protocol_sdk.utils.md)
-*** 
-
-* [CHANGELOG](./changelog.md)
+- [agreement](python/human_protocol_sdk.agreement.md)
+  - [bootstrap](python/human_protocol_sdk.agreement.bootstrap.md)
+  - [measures](python/human_protocol_sdk.agreement.measures.md)
+  - [utils](python/human_protocol_sdk.agreement.utils.md)
+- [encryption](python/human_protocol_sdk.encryption.md)
+  - [encryption](python/human_protocol_sdk.encryption.encryption.md)
+  - [legacy_encryption](python/human_protocol_sdk.legacy_encryption.md)
+  - [encryption_utils](python/human_protocol_sdk.encryption.encryption_utils.md)
+- [escrow](python/human_protocol_sdk.escrow.md)
+  - [escrow_client](python/human_protocol_sdk.escrow.escrow_client.md)
+  - [escrow_utils](python/human_protocol_sdk.escrow.escrow_utils.md)
+- [kvstore](python/human_protocol_sdk.kvstore.md)
+  - [kvstore_client](python/human_protocol_sdk.kvstore.kvstore_client.md)
+- [staking](python/human_protocol_sdk.staking.md)
+  - [staking_client](python/human_protocol_sdk.staking.staking_client.md)
+  - [staking_utils](python/human_protocol_sdk.staking.staking_utils.md)
+- [operator](python/human_protocol_sdk.operator.md)
+  - [operator_utils](python/human_protocol_sdk.operator.operator_utils.md)
+- [statistics](python/human_protocol_sdk.statistics.md)
+  - [statistics_client](python/human_protocol_sdk.statistics.statistics_client.md)
+- [storage](python/human_protocol_sdk.storage.md)
+  - [storage_client](python/human_protocol_sdk.storage.storage_client.md)
+  - [storage_utils](python/human_protocol_sdk.storage.storage_utils.md)
+- [constants](python/human_protocol_sdk.constants.md)
+- [filter](python/human_protocol_sdk.filter.md)
+- [utils](python/human_protocol_sdk.utils.md)
+
+---
+
+- [CHANGELOG](./changelog.md)

docs/sdk/changelog.md

@@ -1,38 +1,42 @@
 # Changelog
 
-
 ### Added
-- __Add transaction options:__ passing transaction options when a transaction is sent allows the user to set custom parameters like gas limit, gas price, etc.
-- __Add gas estimation:__ add gas estimation as mechanism to verify that the transaction won't fail after being sent. Previously the transaction was sent and fees spent, but it failed if it didn't pass all requirements of the contract call.
+
+- **Added OperatorUtils module:** new module for fetching leaders and operators information.
 
 ### Changed
-- __KVStore contract addresses:__ new contracts deployed to include setBulk function.
+
+- **Update ethers version:** update ethers to version 6.
+- **Update cancel escrow method:** return transaction hash and refunded amount.
 
 ### Deprecated
 
 ### Removed
-- __Default value for gas limit in Python:__ gas limit should not be the same for all transactions.
-- __Gas price multiplier:__ gas price multiplier has been removed, but now the gas price can be passed as a parameter when the transaction is sent.
+
+- **Remove staking utils module:** the methods from this module have been moved  into the new OperatorUtils module.
 
 ### Fixed
 
 ### Security
 
-
-
-
 # How to upgrade
 
 ## Typescript
+
 ### yarn
+
 ```
 yarn upgrade @human-protocol/sdk
 ```
-### npm 
+
+### npm
+
 ```
 npm update @human-protocol/sdk
 ```
+
 ## Python
+
 ```
 pip install --upgrade human-protocol-sdk
 ```

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

@@ -48,6 +48,18 @@ escrow_client = EscrowClient(w3)
 
 ## Module
 
+### *class* human_protocol_sdk.escrow.escrow_client.EscrowCancel(tx_hash, amount_refunded)
+
+Bases: `object`
+
+#### \_\_init_\_(tx_hash, amount_refunded)
+
+Represents the result of an escrow cancellation transaction.
+Args:
+
+> tx_hash (str): The hash of the transaction that cancelled the escrow.
+> amount_refunded (Any): The amount refunded during the escrow cancellation.
+
 ### *class* human_protocol_sdk.escrow.escrow_client.EscrowClient(web3)
 
 Bases: `object`
@@ -215,11 +227,15 @@ Cancels the specified escrow and sends the balance to the canceler.
   * **escrow_address** (`str`) – Address of the escrow to cancel
   * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
 * **Return type:**
-  `None`
+  [`EscrowCancel`](#human_protocol_sdk.escrow.escrow_client.EscrowCancel)
 * **Returns:**
-  None
+  EscrowCancel:
+  An instance of the EscrowCancel class containing details of the cancellation transaction,
+  including the transaction hash and the amount refunded.
 * **Raises:**
-  [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an error occurs while checking the parameters
+  * [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an error occurs while checking the parameters
+  * [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If the transfer event associated with the cancellation
+    is not found in the transaction logs
 * **Example:**
   ```python
   from eth_typing import URI
@@ -242,7 +258,7 @@ Cancels the specified escrow and sends the balance to the canceler.
   (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
   escrow_client = EscrowClient(w3)
 
-  transaction_hash = escrow_client.cancel(
+  escrow_cancel_data = escrow_client.cancel(
       "0x62dD51230A30401C455c8398d06F85e4EaB6309f"
   )
   ```

docs/sdk/python/human_protocol_sdk.escrow.md

@@ -8,6 +8,8 @@ obtain information from both the contracts and subgraph.
 * [human_protocol_sdk.escrow.escrow_client module](human_protocol_sdk.escrow.escrow_client.md)
   * [Code Example](human_protocol_sdk.escrow.escrow_client.md#code-example)
   * [Module](human_protocol_sdk.escrow.escrow_client.md#module)
+  * [`EscrowCancel`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowCancel)
+    * [`EscrowCancel.__init__()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowCancel.__init__)
   * [`EscrowClient`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient)
     * [`EscrowClient.__init__()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.__init__)
     * [`EscrowClient.abort()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.abort)

docs/sdk/python/human_protocol_sdk.md

@@ -36,6 +36,7 @@
     * [human_protocol_sdk.escrow.escrow_client module](human_protocol_sdk.escrow.escrow_client.md)
       * [Code Example](human_protocol_sdk.escrow.escrow_client.md#code-example)
       * [Module](human_protocol_sdk.escrow.escrow_client.md#module)
+      * [`EscrowCancel`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowCancel)
       * [`EscrowClient`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient)
       * [`EscrowClientError`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClientError)
       * [`EscrowConfig`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowConfig)
@@ -59,13 +60,6 @@
       * [`AllocationData`](human_protocol_sdk.staking.staking_client.md#human_protocol_sdk.staking.staking_client.AllocationData)
       * [`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)
-      * [`LeaderData`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.LeaderData)
-      * [`LeaderFilter`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.LeaderFilter)
-      * [`RewardData`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.RewardData)
-      * [`StakingUtils`](human_protocol_sdk.staking.staking_utils.md#human_protocol_sdk.staking.staking_utils.StakingUtils)
 * [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)

docs/sdk/python/human_protocol_sdk.operator.md

@@ -0,0 +1,24 @@
+# human_protocol_sdk.operator package
+
+This module enables to perform actions on staking contracts and
+obtain staking information from both the contracts and subgraph.
+
+## Submodules
+
+* [human_protocol_sdk.operator.operator_utils module](human_protocol_sdk.operator.operator_utils.md)
+  * [Code Example](human_protocol_sdk.operator.operator_utils.md#code-example)
+  * [Module](human_protocol_sdk.operator.operator_utils.md#module)
+  * [`LeaderData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderData)
+    * [`LeaderData.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderData.__init__)
+  * [`LeaderFilter`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderFilter)
+    * [`LeaderFilter.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderFilter.__init__)
+  * [`Operator`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.Operator)
+    * [`Operator.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.Operator.__init__)
+  * [`OperatorUtils`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils)
+    * [`OperatorUtils.get_leader()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_leader)
+    * [`OperatorUtils.get_leaders()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_leaders)
+    * [`OperatorUtils.get_reputation_network_operators()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_reputation_network_operators)
+    * [`OperatorUtils.get_rewards_info()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_rewards_info)
+  * [`OperatorUtilsError`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtilsError)
+  * [`RewardData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.RewardData)
+    * [`RewardData.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.RewardData.__init__)