Merge branch 'develop' into feat/escrow-cancellation

Author: flopez7

.github/workflows/cd-subgraph.yaml

@@ -1,5 +1,4 @@
 name: Subgraph deployment
-
 on:
   workflow_dispatch:
     inputs:
@@ -53,23 +52,21 @@ jobs:
       - name: Build core package
         if: steps.filter_networks.outputs.continue == 'true'
         run: yarn build:core
-      - name: Install Graph CLI
-        if: steps.filter_networks.outputs.continue == 'true'
-        run: yarn global add @graphprotocol/graph-cli@0.71.2
-      - name: Authenticate Graph CLI
-        if: steps.filter_networks.outputs.continue == 'true'
-        run: graph auth --studio ${API_KEY}
-        env:
-          API_KEY: ${{ secrets.HP_GRAPH_API_KEY }}
       - name: Generate and build Subgraph
         if: steps.filter_networks.outputs.continue == 'true'
         run: yarn generate && yarn build
         working-directory: ./packages/sdk/typescript/subgraph
         env:
           NETWORK: ${{ matrix.network.name }}
-      - name: Deploy Subgraph
+      - name: Authenticate & Deploy
         if: steps.filter_networks.outputs.continue == 'true'
-        run: graph deploy --studio ${NETWORK} -l ${{ github.event.inputs.label }}
-        working-directory: ./packages/sdk/typescript/subgraph
         env:
-          NETWORK: ${{ matrix.network.name }}
+          API_KEY:   ${{ secrets.HP_GRAPH_API_KEY }}
+          NETWORK:   ${{ matrix.network.name }}
+          LABEL:  ${{ github.event.inputs.label }}
+        working-directory: ./packages/sdk/typescript/subgraph
+        run: |
+          yarn dlx @graphprotocol/graph-cli@0.71.2 \
+            auth --studio "$API_KEY"
+          yarn dlx @graphprotocol/graph-cli@0.71.2 \
+            deploy --studio ${NETWORK} -l ${LABEL}

docs/sdk/python/human_protocol_sdk.filter.md

@@ -122,13 +122,13 @@ Initializes a filter for status events.
   * **skip** (`int`) – Optional number of events 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.TransactionFilter(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, first=10, skip=0, order_direction=OrderDirection.DESC)
+### *class* human_protocol_sdk.filter.TransactionFilter(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, method=None, escrow=None, token=None, first=10, skip=0, order_direction=OrderDirection.DESC)
 
 Bases: `object`
 
 A class used to filter transactions.
 
-#### \_\_init_\_(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, first=10, skip=0, order_direction=OrderDirection.DESC)
+#### \_\_init_\_(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, method=None, escrow=None, token=None, first=10, skip=0, order_direction=OrderDirection.DESC)
 
 Initializes a TransactionsFilter instance.
 
@@ -140,6 +140,9 @@ Initializes a TransactionsFilter instance.
   * **end_date** (`Optional`[`datetime`]) – End date for filtering transactions
   * **start_block** (`Optional`[`int`]) – Start block number for filtering transactions
   * **end_block** (`Optional`[`int`]) – End block number for filtering transactions
+  * **method** (`Optional`[`str`]) – Method name to filter transactions
+  * **escrow** (`Optional`[`str`]) – Escrow address to filter transactions
+  * **token** (`Optional`[`str`]) – Token address to filter transactions
   * **first** (`int`) – Number of items per page
   * **skip** (`int`) – Page number to retrieve
   * **order** – Order of results, “asc” or “desc”

docs/sdk/python/human_protocol_sdk.md

@@ -115,6 +115,12 @@
       * [`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)
+* [human_protocol_sdk.worker package](human_protocol_sdk.worker.md)
+  * [Submodules](human_protocol_sdk.worker.md#submodules)
+    * [human_protocol_sdk.worker.worker_utils module](human_protocol_sdk.worker.worker_utils.md)
+      * [`WorkerData`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerData)
+      * [`WorkerUtils`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils)
+      * [`WorkerUtilsError`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtilsError)
 
 ## Submodules
 

docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md

@@ -71,6 +71,7 @@ Get an array of transactions based on the specified filter parameters.
 
 * **Parameters:**
   **filter** ([`TransactionFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.TransactionFilter)) – Object containing all the necessary parameters to filter
+  (chain_id, from_address, to_address, start_date, end_date, start_block, end_block, method, escrow, token, first, skip, order_direction)
 * **Return type:**
   `List`[[`TransactionData`](#human_protocol_sdk.transaction.transaction_utils.TransactionData)]
 * **Returns:**
@@ -86,6 +87,8 @@ Get an array of transactions based on the specified filter parameters.
               chain_id=ChainId.POLYGON_AMOY,
               from_address="0x1234567890123456789012345678901234567890",
               to_address="0x0987654321098765432109876543210987654321",
+              method="transfer",
+              escrow="0x0987654321098765432109876543210987654321",
               start_date=datetime.datetime(2023, 5, 8),
               end_date=datetime.datetime(2023, 6, 8),
           )

docs/sdk/python/human_protocol_sdk.worker.md

@@ -0,0 +1,13 @@
+# human_protocol_sdk.worker package
+
+This module enables to obtain worker information from subgraph.
+
+## Submodules
+
+* [human_protocol_sdk.worker.worker_utils module](human_protocol_sdk.worker.worker_utils.md)
+  * [`WorkerData`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerData)
+    * [`WorkerData.__init__()`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerData.__init__)
+  * [`WorkerUtils`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils)
+    * [`WorkerUtils.get_worker()`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils.get_worker)
+    * [`WorkerUtils.get_workers()`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils.get_workers)
+  * [`WorkerUtilsError`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtilsError)

docs/sdk/python/human_protocol_sdk.worker.worker_utils.md

@@ -0,0 +1,50 @@
+# human_protocol_sdk.worker.worker_utils module
+
+### *class* human_protocol_sdk.worker.worker_utils.WorkerData(id, address, total_amount_received, payout_count)
+
+Bases: `object`
+
+#### \_\_init_\_(id, address, total_amount_received, payout_count)
+
+Initializes a WorkerData instance.
+
+* **Parameters:**
+  * **id** (`str`) – Worker ID
+  * **address** (`str`) – Worker address
+  * **total_amount_received** (`int`) – Total amount received by the worker
+  * **payout_count** (`int`) – Number of payouts received by the worker
+
+### *class* human_protocol_sdk.worker.worker_utils.WorkerUtils
+
+Bases: `object`
+
+A utility class that provides additional worker-related functionalities.
+
+#### *static* get_worker(chain_id, worker_address)
+
+Gets the worker details.
+
+* **Parameters:**
+  * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the worker exists
+  * **worker_address** (`str`) – Address of the worker
+* **Return type:**
+  `Optional`[[`WorkerData`](#human_protocol_sdk.worker.worker_utils.WorkerData)]
+* **Returns:**
+  Worker data if exists, otherwise None
+
+#### *static* get_workers(filter)
+
+Get workers data of the protocol.
+
+* **Parameters:**
+  **filter** ([`WorkerFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.WorkerFilter)) – Worker filter
+* **Return type:**
+  `List`[[`WorkerData`](#human_protocol_sdk.worker.worker_utils.WorkerData)]
+* **Returns:**
+  List of workers data
+
+### *exception* human_protocol_sdk.worker.worker_utils.WorkerUtilsError
+
+Bases: `Exception`
+
+Raised when an error occurs when getting data from subgraph.

docs/sdk/python/index.md

@@ -42,6 +42,8 @@ pip install human-protocol-sdk[agreement]
       * [Submodules](human_protocol_sdk.storage.md#submodules)
     * [human_protocol_sdk.transaction package](human_protocol_sdk.transaction.md)
       * [Submodules](human_protocol_sdk.transaction.md#submodules)
+    * [human_protocol_sdk.worker package](human_protocol_sdk.worker.md)
+      * [Submodules](human_protocol_sdk.worker.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

@@ -6,7 +6,7 @@
 
 # Class: `abstract` BaseEthersClient
 
-Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L10)
+Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+Defined in: [base.ts:20](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
+Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
+Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
+Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
+Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
+Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
+Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/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.
 

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

@@ -6,7 +6,7 @@
 
 # Class: EncryptionUtils
 
-Defined in: [encryption.ts:290](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L290)
+Defined in: [encryption.ts:290](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L290)
 
 ## Introduction
 
@@ -48,7 +48,7 @@ const keyPair = await EncryptionUtils.generateKeyPair('Human', 'human@hmt.ai');
 
 > `static` **encrypt**(`message`, `publicKeys`): `Promise`\<`string`\>
 
-Defined in: [encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)
+Defined in: [encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)
 
 This function encrypts a message using the specified public keys.
 
@@ -111,7 +111,7 @@ const result = await EncryptionUtils.encrypt('message', publicKeys);
 
 > `static` **generateKeyPair**(`name`, `email`, `passphrase`): `Promise`\<[`IKeyPair`](../../interfaces/interfaces/IKeyPair.md)\>
 
-Defined in: [encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)
+Defined in: [encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)
 
 This function generates a key pair for encryption and decryption.
 
@@ -158,7 +158,7 @@ const result = await EncryptionUtils.generateKeyPair(name, email, passphrase);
 
 > `static` **getSignedData**(`message`): `Promise`\<`string`\>
 
-Defined in: [encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)
+Defined in: [encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)
 
 This function gets signed data from a signed message.
 
@@ -190,7 +190,7 @@ const signedData = await EncryptionUtils.getSignedData('message');
 
 > `static` **isEncrypted**(`message`): `boolean`
 
-Defined in: [encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)
+Defined in: [encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)
 
 Verifies if a message appears to be encrypted with OpenPGP.
 
@@ -238,7 +238,7 @@ if (isEncrypted) {
 
 > `static` **verify**(`message`, `publicKey`): `Promise`\<`boolean`\>
 
-Defined in: [encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/36a82d86df8ff0c729bd9c2ab3a0bb0641086da4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
+Defined in: [encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/47f5da5838a126d0f0ff22cdaa7719befd2657b4/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
 
 This function verifies the signature of a signed message using the public key.