Merge with subgraph-upgrades

Author: flopez7

.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-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.escrow.escrow_client.md

@@ -119,7 +119,7 @@ Adds an array of addresses to the trusted handlers list.
   )
   ```
 
-#### bulk_payout(escrow_address, recipients, amounts, final_results_url, final_results_hash, txId, tx_options=None)
+#### bulk_payout(escrow_address, recipients, amounts, final_results_url, final_results_hash, txId, force_complete=False, tx_options=None)
 
 Pays out the amounts specified to the workers and sets the URL of the final results file.
 
@@ -130,6 +130,7 @@ Pays out the amounts specified to the workers and sets the URL of the final resu
   * **final_results_url** (`str`) – Final results file url
   * **final_results_hash** (`str`) – Final results file hash
   * **txId** (`Decimal`) – Serial number of the bulks
+  * **force_complete** (`Optional`[`bool`]) – (Optional) Indicates if remaining balance should be transferred to the escrow creator
   * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
 * **Return type:**
   `None`

docs/sdk/python/human_protocol_sdk.md

@@ -59,6 +59,16 @@
       * [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.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)

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

@@ -43,9 +43,9 @@ 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
   * **reputation_networks** (`Optional`[`List`[`str`]]) – List of reputation networks
-  * **registration_needed** (`Optional`[`bool`]) – True,
-  * **registration_instructions** (`Optional`[`str`]) – Instructions url,
 
 ### *class* human_protocol_sdk.operator.operator_utils.LeaderFilter(chain_id, role=None)
 

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

@@ -52,7 +52,7 @@ staking_client = StakingClient(w3)
 
 Bases: `object`
 
-A class used to manage staking, and allocation on the HUMAN network.
+A class used to manage staking on the HUMAN network.
 
 #### \_\_init_\_(w3)
 

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)

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/c89cf662f1f49999499468fbc2c62e830c1f474a/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/2adb3114c920b5264832199f17e9531ba585c005/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/c89cf662f1f49999499468fbc2c62e830c1f474a/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/2adb3114c920b5264832199f17e9531ba585c005/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/c89cf662f1f49999499468fbc2c62e830c1f474a/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/2adb3114c920b5264832199f17e9531ba585c005/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)