-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2120 from humanprotocol/develop
Release 20240607
- Loading branch information
Showing
112 changed files
with
4,330 additions
and
1,419 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
docs/sdk/python/human_protocol_sdk.kvstore.kvstore_utils.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
) | ||
) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
94 changes: 94 additions & 0 deletions
94
docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
[**@human-protocol/sdk**](../README.md) • **Docs** | ||
|
||
*** | ||
|
||
[@human-protocol/sdk](../modules.md) / base | ||
|
||
# base | ||
|
||
## Index | ||
|
||
### Classes | ||
|
||
- [BaseEthersClient](classes/BaseEthersClient.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
Oops, something went wrong.