Merge pull request #2120 from humanprotocol/develop

Release 20240607
humanprotocol · Jun 10, 2024 · 4b11310 · 4b11310
2 parents ca86561 + 13ee19f
commit 4b11310
Show file tree

Hide file tree

Showing 112 changed files with 4,330 additions and 1,419 deletions.
diff --git a/docs/sdk/SUMMARY.md b/docs/sdk/SUMMARY.md
@@ -2,22 +2,22 @@
 
 ## 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)
-- [Operator](typescript/modules/operator.md)
-  - [OperatorUtils](typescript/classes/operator.OperatorUtils.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/encryption/README.md)
+  - [Encryption](typescript/encryption/classes/Encryption.md)
+  - [EncryptionUtils](typescript/encryption/classes/EncryptionUtils.md)
+- [Escrow](typescript/escrow/escrow.md)
+  - [EscrowClient](typescript/escrow/classes/EscrowClient.md)
+  - [EscrowUtils](typescript/escrow/classes/EscrowUtils.md)
+- [KVStore](typescript/kvstore/kvstore.md)
+  - [KVStoreClient](typescript/kvstore/classes/KVStoreClient.md)
+- [Staking](typescript/staking/staking.md)
+  - [StakingClient](typescript/staking/classes/StakingClient.md)
+- [Operator](typescript/operator/operator.md)
+  - [OperatorUtils](typescript/operator/classes/OperatorUtils.md)
+- [Storage](typescript/storage/storage.md)
+  - [StorageClient](typescript/storage/classes/StorageClient.md)
+- [Statistics](typescript/statistics/statistics.md)
+  - [StatisticsClient](typescript/statistics/classes/StatisticsClient.md)
 
 ## Python SDK
 

diff --git a/docs/sdk/python/human_protocol_sdk.filter.md b/docs/sdk/python/human_protocol_sdk.filter.md
@@ -42,3 +42,24 @@ Initializes a PayoutFilter instance.
   * **recipient** (`Optional`[`str`]) – Recipient address
   * **date_from** (`Optional`[`datetime`]) – Created from date
   * **date_to** (`Optional`[`datetime`]) – Created to date
+
+### *class* human_protocol_sdk.filter.TransactionFilter(networks, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None)
+
+Bases: `object`
+
+A class used to filter transactions.
+
+#### \_\_init_\_(networks, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None)
+
+Initializes a TransactionsFilter instance.
+
+* **Parameters:**
+  * **networks** (`List`[[`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)]) – List of chain IDs to filter transactions from
+  * **from_address** (`Optional`[`str`]) – Sender address
+  * **to_address** (`Optional`[`str`]) – Receiver address
+  * **start_date** (`Optional`[`datetime`]) – Start date for filtering transactions
+  * **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
+* **Raises:**
+  **ValueError** – If start_date is after end_date
diff --git a/docs/sdk/python/human_protocol_sdk.kvstore.kvstore_utils.md b/docs/sdk/python/human_protocol_sdk.kvstore.kvstore_utils.md
@@ -0,0 +1,61 @@
+# human_protocol_sdk.kvstore.kvstore_utils module
+
+Utility class for KVStore-related operations.
+
+## Code Example
+
+```python
+from human_protocol_sdk.constants import ChainId
+from human_protocol_sdk.kvstore import KVStoreUtils
+
+print(
+    KVStoreUtils.get_data(
+        ChainId.POLYGON_AMOY,
+        "0x15d34aaf54267db7d7c367839aaf71a00a2c6a65"
+    )
+)
+```
+
+## Module
+
+### *class* human_protocol_sdk.kvstore.kvstore_utils.KVStoreData(key, value)
+
+Bases: `object`
+
+#### \_\_init_\_(key, value)
+
+Initializes a KVStoreData instance.
+
+* **Parameters:**
+  * **key** (`str`) – Key
+  * **value** (`str`) – Value
+
+### *class* human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils
+
+Bases: `object`
+
+A utility class that provides additional KVStore-related functionalities.
+
+#### *static* get_kvstore_data(chain_id, address)
+
+Returns the KVStore data for a given address.
+
+* **Parameters:**
+  * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the KVStore data has been deployed
+  * **address** (`str`) – Address of the KVStore
+* **Return type:**
+  `Optional`[`List`[[`KVStoreData`](#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData)]]
+* **Returns:**
+  List of KVStore data
+* **Example:**
+  ```python
+  from human_protocol_sdk.constants import ChainId
+  from human_protocol_sdk.kvstore import KVStoreUtils
+
+  print(
+      KVStoreUtils.get_kvstore_data(
+          ChainId.POLYGON_AMOY,
+          "0x15d34aaf54267db7d7c367839aaf71a00a2c6a65"
+      )
+  )
+  ```
diff --git a/docs/sdk/python/human_protocol_sdk.md b/docs/sdk/python/human_protocol_sdk.md
@@ -148,6 +148,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__)
+  * [`TransactionFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.TransactionFilter)
+    * [`TransactionFilter.__init__()`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.TransactionFilter.__init__)
 * [human_protocol_sdk.legacy_encryption module](human_protocol_sdk.legacy_encryption.md)
   * [`DecryptionError`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.DecryptionError)
   * [`Encryption`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.Encryption)

diff --git a/docs/sdk/python/human_protocol_sdk.transaction.md b/docs/sdk/python/human_protocol_sdk.transaction.md
@@ -0,0 +1,16 @@
+# human_protocol_sdk.transaction package
+
+This module enables to obtain transaction information from 
+both the contracts and subgraph.
+
+## 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)
+    * [`TransactionData.__init__()`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionData.__init__)
+  * [`TransactionUtils`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils)
+    * [`TransactionUtils.get_transaction()`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils.get_transaction)
+    * [`TransactionUtils.get_transactions()`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils.get_transactions)
+  * [`TransactionUtilsError`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtilsError)
diff --git a/docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md b/docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md
@@ -0,0 +1,94 @@
+# human_protocol_sdk.transaction.transaction_utils module
+
+Utility class for transaction-related operations.
+
+## Code Example
+
+```python
+from human_protocol_sdk.constants import ChainId
+from human_protocol_sdk.transaction import TransactionUtils, TransactionFilter
+
+print(
+    TransactionUtils.get_transactions(
+        TransactionFilter(
+            networks=[ChainId.POLYGON_AMOY],
+            from_address="0x1234567890123456789012345678901234567890",
+            to_address="0x0987654321098765432109876543210987654321",
+            start_date=datetime.datetime(2023, 5, 8),
+            end_date=datetime.datetime(2023, 6, 8),
+        )
+    )
+)
+```
+
+## Module
+
+### *class* human_protocol_sdk.transaction.transaction_utils.TransactionData(chain_id, block, hash, from_address, to_address, timestamp, value, method)
+
+Bases: `object`
+
+#### \_\_init_\_(chain_id, block, hash, from_address, to_address, timestamp, value, method)
+
+### *class* human_protocol_sdk.transaction.transaction_utils.TransactionUtils
+
+Bases: `object`
+
+A utility class that provides additional transaction-related functionalities.
+
+#### *static* get_transaction(chain_id, hash)
+
+Returns the transaction for a given hash.
+
+* **Parameters:**
+  * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the transaction was executed
+  * **hash** (`str`) – Hash of the transaction
+* **Return type:**
+  `Optional`[[`TransactionData`](#human_protocol_sdk.transaction.transaction_utils.TransactionData)]
+* **Returns:**
+  Transaction data
+* **Example:**
+  ```python
+  from human_protocol_sdk.constants import ChainId
+  from human_protocol_sdk.transaction import TransactionUtils
+
+  print(
+      TransactionUtils.get_transaction(
+          ChainId.POLYGON_AMOY,
+          "0x1234567890123456789012345678901234567891"
+      )
+  )
+  ```
+
+#### *static* get_transactions(filter)
+
+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
+* **Return type:**
+  `List`[[`TransactionData`](#human_protocol_sdk.transaction.transaction_utils.TransactionData)]
+* **Returns:**
+  List of transactions
+* **Example:**
+  ```python
+  from human_protocol_sdk.constants import ChainId
+  from human_protocol_sdk.transaction import TransactionUtils, TransactionFilter
+
+  print(
+      TransactionUtils.get_transactions(
+          TransactionFilter(
+              networks=[ChainId.POLYGON_AMOY],
+              from_address="0x1234567890123456789012345678901234567890",
+              to_address="0x0987654321098765432109876543210987654321",
+              start_date=datetime.datetime(2023, 5, 8),
+              end_date=datetime.datetime(2023, 6, 8),
+          )
+      )
+  )
+  ```
+
+### *exception* human_protocol_sdk.transaction.transaction_utils.TransactionUtilsError
+
+Bases: `Exception`
+
+Raises when some error happens when getting data from subgraph.
diff --git a/docs/sdk/python/human_protocol_sdk.utils.md b/docs/sdk/python/human_protocol_sdk.utils.md
@@ -9,7 +9,7 @@ Retrieve the contract interface of a given contract.
 * **Returns:**
   The contract interface containing the contract abi.
 
-### human_protocol_sdk.utils.get_data_from_subgraph(url, query, params=None)
+### human_protocol_sdk.utils.get_data_from_subgraph(network, query, params=None)
 
 ### human_protocol_sdk.utils.get_erc20_interface()
 

diff --git a/docs/sdk/python/index.md b/docs/sdk/python/index.md
@@ -50,6 +50,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)
+      * [`TransactionFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.TransactionFilter)
     * [human_protocol_sdk.legacy_encryption module](human_protocol_sdk.legacy_encryption.md)
       * [`DecryptionError`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.DecryptionError)
       * [`Encryption`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.Encryption)

diff --git a/docs/sdk/typescript/.nojekyll b/docs/sdk/typescript/.nojekyll
diff --git a/docs/sdk/typescript/README.md b/docs/sdk/typescript/README.md
@@ -1,4 +1,6 @@
-@human-protocol/sdk / [Modules](modules.md)
+**@human-protocol/sdk** • [**Docs**](modules.md)
+
+***
 
 # Human Protocol Node.js SDK
 

diff --git a/docs/sdk/typescript/base/README.md b/docs/sdk/typescript/base/README.md
@@ -0,0 +1,13 @@
+[**@human-protocol/sdk**](../README.md) • **Docs**
+
+***
+
+[@human-protocol/sdk](../modules.md) / base
+
+# base
+
+## Index
+
+### Classes
+
+- [BaseEthersClient](classes/BaseEthersClient.md)
diff --git a/docs/sdk/typescript/base/classes/BaseEthersClient.md b/docs/sdk/typescript/base/classes/BaseEthersClient.md
@@ -0,0 +1,63 @@
+[**@human-protocol/sdk**](../../README.md) • **Docs**
+
+***
+
+[@human-protocol/sdk](../../modules.md) / [base](../README.md) / BaseEthersClient
+
+# Class: `abstract` BaseEthersClient
+
+## Introduction
+
+This class is used as a base class for other clients making on-chain calls.
+
+## Extended by
+
+- [`EscrowClient`](../../escrow/classes/EscrowClient.md)
+- [`KVStoreClient`](../../kvstore/classes/KVStoreClient.md)
+- [`StakingClient`](../../staking/classes/StakingClient.md)
+
+## Constructors
+
+### new BaseEthersClient()
+
+> **new BaseEthersClient**(`runner`, `networkData`): [`BaseEthersClient`](BaseEthersClient.md)
+
+**BaseClient constructor**
+
+#### Parameters
+
+• **runner**: `ContractRunner`
+
+The Signer or Provider object to interact with the Ethereum network
+
+• **networkData**: `NetworkData`
+
+The network information required to connect to the contracts
+
+#### Returns
+
+[`BaseEthersClient`](BaseEthersClient.md)
+
+#### Source
+
+[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/5c3ff98d933709d76ff6e1e712664f4ec3029081/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+
+## Properties
+
+### networkData
+
+> **networkData**: `NetworkData`
+
+#### Source
+
+[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/5c3ff98d933709d76ff6e1e712664f4ec3029081/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+
+***
+
+### runner
+
+> `protected` **runner**: `ContractRunner`
+
+#### Source
+
+[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/5c3ff98d933709d76ff6e1e712664f4ec3029081/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)