Merge pull request #2721 from humanprotocol/develop

Release 20241030

Author: portuu3

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +1,43 @@
-## Description
+## Issue tracking
+<!--
+  Where is the progress of this issue being tracked?
+  Where can one find the requirements for this issue?
+  Where did this issue originated from?
 
-<!-- Describe the goal of this pull request. What does it change or fix? -->
+  E.g. GitHub issue, Slack message, etc.
+-->
 
-## Summary of changes
+## Context behind the change
+<!--
+  What changes have you made to the code, and why?
 
-<!-- At a high level, what parts of the code did you change and why? -->
+  Describe the goal of this pull request. What does it change or fix?
+  At a high level, what parts of the code did you change and why?
+-->
 
-## How test the changes
+## How has this been tested?
+<!--
+  You should always test your changes.
 
-<!-- If there are any special testing requirements, add them here -->
+  Describe the steps you took to make sure your PR does what it's supposed to do.
+  How we ensure that adjacent code/features are still working?
+  Are there any performance implications?
+-->
 
-## Related issues
-[Keywords for linking issues](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests)
+## Release plan
+<!--
+  If not you, but somebody else will be deploying this, what they need to know/do to succeed?
 
-<!-- Does this close any open issues? -->
+  Add any action items that need to be done for the release (any step, before/during/after),
+  e.g. running a DB migration, leaving a note about release in Slack, adding new envs, etc.
+-->
+
+## Potential risks; What to monitor; Rollback plan
+<!--
+  What might go wrong with deployment of this PR?
+  Can it affect some other services/areas? In what way?
+  What metrics/dashboards/etc. you should keep an eye on while/after deploying this?
+ 
+  How will we handle any issues if they arise? Do we need rollback plan?
+  Do we need a second pair of eyes on this?
+-->

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

@@ -11,4 +11,4 @@ jobs:
       - name: "Checkout Repository"
         uses: actions/[email protected]
       - name: "Dependency Review"
-        uses: actions/dependency-review-action@v4.3.4
+        uses: actions/dependency-review-action@v4.4.0

.github/workflows/ci-lint-cvat-exchange-oracle.yaml

@@ -19,11 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
         with:
-          cache: 'pip'
-          cache-dependency-path: ${{ env.WORKING_DIR }}/poetry.lock
-      - run: python -m pip install poetry
+          version: 1.8.4
       - uses: actions/setup-python@v5
         with:
           python-version: '3.10'

.github/workflows/ci-lint-cvat-recording-oracle.yaml

@@ -19,11 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
         with:
-          cache: 'pip'
-          cache-dependency-path: ${{ env.WORKING_DIR }}/poetry.lock
-      - run: python -m pip install poetry
+          version: 1.8.4
       - uses: actions/setup-python@v5
         with:
           python-version: '3.10'

.husky/pre-commit

@@ -1,6 +1,3 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx lint-staged
 
 # Format python file changes

docs/sdk/python/human_protocol_sdk.constants.md

@@ -54,6 +54,8 @@ Enum for KVStore keys
 
 #### public_key *= 'public_key'*
 
+#### registration_instructions *= 'registration_instructions'*
+
 #### registration_needed *= 'registration_needed'*
 
 #### role *= 'role'*

docs/sdk/python/human_protocol_sdk.md

@@ -53,6 +53,16 @@
       * [Module](human_protocol_sdk.kvstore.kvstore_client.md#module)
       * [`KVStoreClient`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClient)
       * [`KVStoreClientError`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClientError)
+* [human_protocol_sdk.kvstore.kvstore_utils module](human_protocol_sdk.kvstore.kvstore_utils.md)
+  * [Code Example](human_protocol_sdk.kvstore.kvstore_utils.md#code-example)
+  * [Module](human_protocol_sdk.kvstore.kvstore_utils.md#module)
+  * [`KVStoreData`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData)
+    * [`KVStoreData.__init__()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData.__init__)
+  * [`KVStoreUtils`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils)
+    * [`KVStoreUtils.get()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get)
+    * [`KVStoreUtils.get_file_url_and_verify_hash()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_file_url_and_verify_hash)
+    * [`KVStoreUtils.get_kvstore_data()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_kvstore_data)
+    * [`KVStoreUtils.get_public_key()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_public_key)
 * [human_protocol_sdk.operator package](human_protocol_sdk.operator.md)
   * [Submodules](human_protocol_sdk.operator.md#submodules)
     * [human_protocol_sdk.operator.operator_utils module](human_protocol_sdk.operator.operator_utils.md)
@@ -100,6 +110,14 @@
       * [`StorageFileNotFoundError`](human_protocol_sdk.storage.storage_client.md#human_protocol_sdk.storage.storage_client.StorageFileNotFoundError)
     * [human_protocol_sdk.storage.storage_utils module](human_protocol_sdk.storage.storage_utils.md)
       * [`StorageUtils`](human_protocol_sdk.storage.storage_utils.md#human_protocol_sdk.storage.storage_utils.StorageUtils)
+* [human_protocol_sdk.transaction package](human_protocol_sdk.transaction.md)
+  * [Submodules](human_protocol_sdk.transaction.md#submodules)
+    * [human_protocol_sdk.transaction.transaction_utils module](human_protocol_sdk.transaction.transaction_utils.md)
+      * [Code Example](human_protocol_sdk.transaction.transaction_utils.md#code-example)
+      * [Module](human_protocol_sdk.transaction.transaction_utils.md#module)
+      * [`TransactionData`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionData)
+      * [`TransactionUtils`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils)
+      * [`TransactionUtilsError`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtilsError)
 
 ## Submodules
 
@@ -127,6 +145,7 @@
     * [`KVStoreKeys.fee`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.fee)
     * [`KVStoreKeys.job_types`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.job_types)
     * [`KVStoreKeys.public_key`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.public_key)
+    * [`KVStoreKeys.registration_instructions`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.registration_instructions)
     * [`KVStoreKeys.registration_needed`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.registration_needed)
     * [`KVStoreKeys.role`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.role)
     * [`KVStoreKeys.url`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.url)

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

@@ -17,11 +17,11 @@ print(
 
 ## Module
 
-### *class* human_protocol_sdk.operator.operator_utils.LeaderData(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reputation, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None)
+### *class* human_protocol_sdk.operator.operator_utils.LeaderData(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reputation, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None, registration_needed=None, registration_instructions=None)
 
 Bases: `object`
 
-#### \_\_init_\_(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reputation, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None)
+#### \_\_init_\_(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reputation, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None, registration_needed=None, registration_instructions=None)
 
 Initializes an LeaderData instance.
 
@@ -44,6 +44,8 @@ Initializes an LeaderData instance.
   * **webhook_url** (`Optional`[`str`]) – Webhook url
   * **url** (`Optional`[`str`]) – Url
   * **job_types** (`Optional`[`List`[`str`]]) – Job types
+  * **registration_needed** (`Optional`[`bool`]) – True,
+  * **registration_instructions** (`Optional`[`str`]) – Instructions url,
 
 ### *class* human_protocol_sdk.operator.operator_utils.LeaderFilter(chain_id, role=None)
 
@@ -59,17 +61,19 @@ Initializes a LeaderFilter instance.
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain Id to request data
   * **role** (`Optional`[`str`]) – Leader role
 
-### *class* human_protocol_sdk.operator.operator_utils.Operator(address, role, url='', job_types=[])
+### *class* human_protocol_sdk.operator.operator_utils.Operator(address, role, url='', job_types=[], registration_needed=None, registration_instructions=None)
 
 Bases: `object`
 
-#### \_\_init_\_(address, role, url='', job_types=[])
+#### \_\_init_\_(address, role, url='', job_types=[], registration_needed=None, registration_instructions=None)
 
 Initializes an Operator instance.
 
 * **Parameters:**
   * **address** (`str`) – Operator address
   * **role** (`str`) – Role of the operator
+  * **registration_needed** (`Optional`[`bool`]) – True,
+  * **registration_instructions** (`Optional`[`str`]) – Instructions url,
 
 ### *class* human_protocol_sdk.operator.operator_utils.OperatorUtils
 
@@ -129,8 +133,6 @@ Get the reputation network operators of the specified address.
   * **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
-* **Parem job_types:**
-  (Optional) Job types of the operator
 * **Return type:**
   `List`[[`Operator`](#human_protocol_sdk.operator.operator_utils.Operator)]
 * **Returns:**

docs/sdk/python/index.md

@@ -32,6 +32,11 @@ pip install human-protocol-sdk[agreement]
       * [Submodules](human_protocol_sdk.escrow.md#submodules)
     * [human_protocol_sdk.kvstore package](human_protocol_sdk.kvstore.md)
       * [Submodules](human_protocol_sdk.kvstore.md#submodules)
+    * [human_protocol_sdk.kvstore.kvstore_utils module](human_protocol_sdk.kvstore.kvstore_utils.md)
+      * [Code Example](human_protocol_sdk.kvstore.kvstore_utils.md#code-example)
+      * [Module](human_protocol_sdk.kvstore.kvstore_utils.md#module)
+      * [`KVStoreData`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData)
+      * [`KVStoreUtils`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils)
     * [human_protocol_sdk.operator package](human_protocol_sdk.operator.md)
       * [Submodules](human_protocol_sdk.operator.md#submodules)
     * [human_protocol_sdk.staking package](human_protocol_sdk.staking.md)
@@ -40,6 +45,8 @@ pip install human-protocol-sdk[agreement]
       * [Submodules](human_protocol_sdk.statistics.md#submodules)
     * [human_protocol_sdk.storage package](human_protocol_sdk.storage.md)
       * [Submodules](human_protocol_sdk.storage.md#submodules)
+    * [human_protocol_sdk.transaction package](human_protocol_sdk.transaction.md)
+      * [Submodules](human_protocol_sdk.transaction.md#submodules)
   * [Submodules](human_protocol_sdk.md#submodules)
     * [human_protocol_sdk.constants module](human_protocol_sdk.constants.md)
       * [`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)

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

@@ -40,7 +40,7 @@ The network information required to connect to the contracts
 
 #### Defined in
 
-[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/11c280a968c4e19e21e43f468baa71bfd0766e56/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/95ed623c67878973c127c8529a78774329277e86/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
 
 ## Properties
 
@@ -50,7 +50,7 @@ The network information required to connect to the contracts
 
 #### Defined in
 
-[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/11c280a968c4e19e21e43f468baa71bfd0766e56/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/95ed623c67878973c127c8529a78774329277e86/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
 
 ***
 
@@ -60,4 +60,4 @@ The network information required to connect to the contracts
 
 #### Defined in
 
-[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/11c280a968c4e19e21e43f468baa71bfd0766e56/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/95ed623c67878973c127c8529a78774329277e86/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)