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.statistics.statistics_client.DailyEscrowData(timestamp, escrows_total, escrows_pending, escrows_solved, escrows_paid, escrows_cancelled)
  • class human_protocol_sdk.statistics.statistics_client.DailyHMTData(timestamp, total_transaction_amount, total_transaction_count)
  • class human_protocol_sdk.statistics.statistics_client.DailyPaymentData(timestamp, total_amount_paid, total_count, average_amount_per_worker)
  • class human_protocol_sdk.statistics.statistics_client.DailyWorkerData(timestamp, active_workers)
  • class human_protocol_sdk.statistics.statistics_client.EscrowStatistics(total_escrows, daily_escrows_data)
  • class human_protocol_sdk.statistics.statistics_client.HMTHolder(address, balance)
  • class human_protocol_sdk.statistics.statistics_client.HMTStatistics(total_transfer_amount, total_transfer_count, total_holders, holders, daily_hmt_data)
  • class human_protocol_sdk.statistics.statistics_client.PaymentStatistics(daily_payments_data)
  • class human_protocol_sdk.statistics.statistics_client.StatisticsClient(chain_id=ChainId.POLYGON_AMOY)
  • exception human_protocol_sdk.statistics.statistics_client.StatisticsClientError
  • class human_protocol_sdk.statistics.statistics_client.StatisticsParam(date_from=None, date_to=None, limit=None)
  • class human_protocol_sdk.statistics.statistics_client.WorkerStatistics(daily_workers_data)
  1. Python SDK
  2. statistics

statistics_client

This client enables to obtain statistical information from the subgraph.

Code Example

from human_protocol_sdk.constants import ChainId
from human_protocol_sdk.statistics import StatisticsClient

statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)

Module

class human_protocol_sdk.statistics.statistics_client.DailyEscrowData(timestamp, escrows_total, escrows_pending, escrows_solved, escrows_paid, escrows_cancelled)

Bases: object

A class used to specify daily escrow data.

__init__(timestamp, escrows_total, escrows_pending, escrows_solved, escrows_paid, escrows_cancelled)

Initializes a DailyEscrowData instance.

  • Parameters:

    • timestamp (datetime) – Timestamp

    • escrows_total (int) – Total escrows

    • escrows_pending (int) – Pending escrows

    • escrows_solved (int) – Solved escrows

    • escrows_paid (int) – Paid escrows

    • escrows_cancelled (int) – Cancelled escrows

class human_protocol_sdk.statistics.statistics_client.DailyHMTData(timestamp, total_transaction_amount, total_transaction_count)

Bases: object

A class used to specify daily HMT data.

__init__(timestamp, total_transaction_amount, total_transaction_count)

Initializes a DailyHMTData instance.

  • Parameters:

    • timestamp (datetime) – Timestamp

    • total_transaction_amount (int) – Total transaction amount

    • total_transaction_count (int) – Total transaction count

class human_protocol_sdk.statistics.statistics_client.DailyPaymentData(timestamp, total_amount_paid, total_count, average_amount_per_worker)

Bases: object

A class used to specify daily payment data.

__init__(timestamp, total_amount_paid, total_count, average_amount_per_worker)

Initializes a DailyPaymentData instance.

  • Parameters:

    • timestamp (datetime) – Timestamp

    • total_amount_paid (int) – Total amount paid

    • total_count (int) – Total count

    • average_amount_per_worker (int) – Average amount per worker

class human_protocol_sdk.statistics.statistics_client.DailyWorkerData(timestamp, active_workers)

Bases: object

A class used to specify daily worker data.

__init__(timestamp, active_workers)

Initializes a DailyWorkerData instance.

  • Parameters:

    • timestamp (datetime) – Timestamp

    • active_workers (int) – Active workers

class human_protocol_sdk.statistics.statistics_client.EscrowStatistics(total_escrows, daily_escrows_data)

Bases: object

A class used to specify escrow statistics.

__init__(total_escrows, daily_escrows_data)

Initializes a EscrowStatistics instance.

  • Parameters:

    • total_escrows (int) – Total escrows

class human_protocol_sdk.statistics.statistics_client.HMTHolder(address, balance)

Bases: object

A class used to specify HMT holder.

__init__(address, balance)

Initializes a HMTHolder instance.

  • Parameters:

    • address (str) – Holder address

    • balance (int) – Holder balance

class human_protocol_sdk.statistics.statistics_client.HMTStatistics(total_transfer_amount, total_transfer_count, total_holders, holders, daily_hmt_data)

Bases: object

A class used to specify HMT statistics.

__init__(total_transfer_amount, total_transfer_count, total_holders, holders, daily_hmt_data)

Initializes a HMTStatistics instance.

  • Parameters:

    • total_transfer_amount (int) – Total transfer amount

    • total_transfer_count (int) – Total transfer count

    • total_holders (int) – Total holders

class human_protocol_sdk.statistics.statistics_client.PaymentStatistics(daily_payments_data)

Bases: object

A class used to specify payment statistics.

__init__(daily_payments_data)

Initializes a PaymentStatistics instance.

class human_protocol_sdk.statistics.statistics_client.StatisticsClient(chain_id=ChainId.POLYGON_AMOY)

Bases: object

A client used to get statistical data.

__init__(chain_id=ChainId.POLYGON_AMOY)

Initializes a Statistics instance

get_escrow_statistics(param=<human_protocol_sdk.statistics.statistics_client.StatisticsParam object>)

Get escrow statistics data for the given date range.

  • Returns: Escrow statistics data

  • Example:

    from human_protocol_sdk.contants import ChainId
    from human_protocol_sdk.statistics import StatisticsClient, StatisticsParam
    
    statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
    
    print(statistics_client.get_escrow_statistics())
    print(
        statistics_client.get_escrow_statistics(
            StatisticsParam(
                date_from=datetime.datetime(2023, 5, 8),
                date_to=datetime.datetime(2023, 6, 8),
            )
        )
    )

get_hmt_statistics(param=<human_protocol_sdk.statistics.statistics_client.StatisticsParam object>)

Get HMT statistics data for the given date range.

  • Returns: HMT statistics data

  • Example:

    from human_protocol_sdk.contants import ChainId
    from human_protocol_sdk.statistics import StatisticsClient, StatisticsParam
    
    statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
    
    print(statistics_client.get_hmt_statistics())
    print(
        statistics_client.get_hmt_statistics(
            StatisticsParam(
                date_from=datetime.datetime(2023, 5, 8),
                date_to=datetime.datetime(2023, 6, 8),
            )
        )
    )

get_payment_statistics(param=<human_protocol_sdk.statistics.statistics_client.StatisticsParam object>)

Get payment statistics data for the given date range.

  • Returns: Payment statistics data

  • Example:

    from human_protocol_sdk.contants import ChainId
    from human_protocol_sdk.statistics import StatisticsClient, StatisticsParam
    
    statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
    
    print(statistics_client.get_payment_statistics())
    print(
        statistics_client.get_payment_statistics(
            StatisticsParam(
                date_from=datetime.datetime(2023, 5, 8),
                date_to=datetime.datetime(2023, 6, 8),
            )
        )
    )

get_worker_statistics(param=<human_protocol_sdk.statistics.statistics_client.StatisticsParam object>)

Get worker statistics data for the given date range.

  • Returns: Worker statistics data

  • Example:

    from human_protocol_sdk.contants import ChainId
    from human_protocol_sdk.statistics import StatisticsClient, StatisticsParam
    
    statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
    
    print(statistics_client.get_worker_statistics())
    print(
        statistics_client.get_worker_statistics(
            StatisticsParam(
                date_from=datetime.datetime(2023, 5, 8),
                date_to=datetime.datetime(2023, 6, 8),
            )
        )
    )

exception human_protocol_sdk.statistics.statistics_client.StatisticsClientError

Bases: Exception

Raises when some error happens when getting data from subgraph.

class human_protocol_sdk.statistics.statistics_client.StatisticsParam(date_from=None, date_to=None, limit=None)

Bases: object

A class used to specify statistics params.

__init__(date_from=None, date_to=None, limit=None)

Initializes a StatisticsParam instance.

  • Parameters:

    • date_from (Optional[datetime]) – Statistical data from date

    • date_to (Optional[datetime]) – Statistical data to date

    • limit (Optional[int]) – Limit of statistical data

class human_protocol_sdk.statistics.statistics_client.WorkerStatistics(daily_workers_data)

Bases: object

A class used to specify worker statistics.

__init__(daily_workers_data)

Initializes a WorkerStatistics instance.

Last updated 11 months ago

daily_escrows_data (List[]) – Daily escrows data

holders (List[]) – Holders

daily_hmt_data (List[]) – Daily HMT data

Parameters: daily_payments_data (List[]) – Daily payments data

Parameters: chain_id () – Chain ID to get statistical data from

Parameters: param () – Object containing the date range

Return type:

Parameters: param () – Object containing the date range

Return type:

Parameters: param () – Object containing the date range

Return type:

Parameters: param () – Object containing the date range

Return type:

Parameters: daily_workers_data (List[]) – Daily workers data

DailyEscrowData
HMTHolder
DailyHMTData
DailyPaymentData
StatisticsParam
EscrowStatistics
StatisticsParam
HMTStatistics
StatisticsParam
PaymentStatistics
StatisticsParam
WorkerStatistics
DailyWorkerData
ChainId