Human Protocol SDK
v3.0.0
v3.0.0
  • README
  • Typescript SDK​
    • Encryption
      • Encryption
      • EncryptionUtils
    • Escrow
      • EscrowClient
      • EscrowUtils
    • KVStore
      • KVStoreClient
      • KVStoreUtils
    • Staking
      • StakingClient
    • Operator
      • OperatorUtils
    • Storage
      • StorageClient
    • Statistics
      • StatisticsClient
    • Transaction
      • TransactionUtils
  • Python SDK
    • agreement
      • bootstrap
      • measures
      • utils
    • encryption
      • encryption
      • legacy_encryption
      • encryption_utils
    • escrow
      • escrow_client
      • escrow_utils
    • kvstore
      • kvstore_client
      • kvstore_utils
    • staking
      • staking_client
      • staking_utils
    • operator
      • operator_utils
    • statistics
      • statistics_client
    • storage
      • storage_client
      • storage_utils
    • transaction
      • transaction_utils
    • constants
    • filter
    • utils
  • CHANGELOG
Powered by GitBook
On this page
  • Code Example
  • Module
  • class human_protocol_sdk.escrow.escrow_utils.EscrowData(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, status, token, total_funded_amount, created_at, final_results_url=None, intermediate_results_url=None, manifest_hash=None, manifest_url=None, recording_oracle=None, recording_oracle_fee=None, reputation_oracle=None, reputation_oracle_fee=None, exchange_oracle=None, exchange_oracle_fee=None)
  • class human_protocol_sdk.escrow.escrow_utils.EscrowUtils
  1. Python SDK
  2. escrow

escrow_utils

Utility class for escrow-related operations.

Code Example

from human_protocol_sdk.constants import ChainId
from human_protocol_sdk.escrow import EscrowUtils, EscorwFilter, Status

print(
    EscrowUtils.get_escrows(
        EscrowFilter(
            networks=[ChainId.POLYGON_AMOY],
            status=Status.Pending,
            date_from=datetime.datetime(2023, 5, 8),
            date_to=datetime.datetime(2023, 6, 8),
        )
    )
)

Module

class human_protocol_sdk.escrow.escrow_utils.EscrowData(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, status, token, total_funded_amount, created_at, final_results_url=None, intermediate_results_url=None, manifest_hash=None, manifest_url=None, recording_oracle=None, recording_oracle_fee=None, reputation_oracle=None, reputation_oracle_fee=None, exchange_oracle=None, exchange_oracle_fee=None)

Bases: object

__init__(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, status, token, total_funded_amount, created_at, final_results_url=None, intermediate_results_url=None, manifest_hash=None, manifest_url=None, recording_oracle=None, recording_oracle_fee=None, reputation_oracle=None, reputation_oracle_fee=None, exchange_oracle=None, exchange_oracle_fee=None)

Initializes an EscrowData instance.

  • Parameters:

    • id (str) – Identifier

    • address (str) – Address

    • amount_paid (int) – Amount paid

    • balance (int) – Balance

    • count (int) – Count

    • factory_address (str) – Factory address

    • launcher (str) – Launcher

    • status (str) – Status

    • token (str) – Token

    • total_funded_amount (int) – Total funded amount

    • created_at (datetime) – Creation date

    • final_results_url (Optional[str]) – URL for final results.

    • intermediate_results_url (Optional[str]) – URL for intermediate results.

    • manifest_hash (Optional[str]) – Manifest hash.

    • manifest_url (Optional[str]) – Manifest URL.

    • recording_oracle (Optional[str]) – Recording Oracle address.

    • recording_oracle_fee (Optional[int]) – Recording Oracle fee.

    • reputation_oracle (Optional[str]) – Reputation Oracle address.

    • reputation_oracle_fee (Optional[int]) – Reputation Oracle fee.

    • exchange_oracle (Optional[str]) – Exchange Oracle address.

    • exchange_oracle_fee (Optional[int]) – Exchange Oracle fee.

class human_protocol_sdk.escrow.escrow_utils.EscrowUtils

Bases: object

A utility class that provides additional escrow-related functionalities.

static get_escrow(chain_id, escrow_address)

Returns the escrow for a given address.

  • Parameters:

    • escrow_address (str) – Address of the escrow

  • Returns: Escrow data

  • Example:

    from human_protocol_sdk.constants import ChainId
    from human_protocol_sdk.escrow import EscrowUtils
    
    print(
        EscrowUtils.get_escrow(
            ChainId.POLYGON_AMOY,
            "0x1234567890123456789012345678901234567890"
        )
    )

static get_escrows(filter=<human_protocol_sdk.filter.EscrowFilter object>)

Get an array of escrow addresses based on the specified filter parameters.

  • Returns: List of escrows

  • Example:

    from human_protocol_sdk.constants import ChainId
    from human_protocol_sdk.escrow import EscrowUtils, EscrowFilter, Status
    
    print(
        EscrowUtils.get_escrows(
            EscrowFilter(
                networks=[ChainId.POLYGON_AMOY],
                status=Status.Pending,
                date_from=datetime.datetime(2023, 5, 8),
                date_to=datetime.datetime(2023, 6, 8),
            )
        )
    )

Last updated 11 months ago

chain_id () – Chain identifier

chain_id () – Network in which the escrow has been deployed

Return type: Optional[]

Parameters: filter () – Object containing all the necessary parameters to filter

Return type: List[]

EscrowData
EscrowData
EscrowFilter
ChainId
ChainId