operator_utils

Utility class for operator-related operations.

Code Example

from human_protocol_sdk.constants import ChainId
from human_protocol_sdk.operator import OperatorUtils, OperatorFilter

print(
    OperatorUtils.get_operators(
        OperatorFilter(chain_id=ChainId.POLYGON_AMOY, roles=["Job Launcher"])
    )
)

Module

class human_protocol_sdk.operator.operator_utils.OperatorData(chain_id, id, address, amount_jobs_processed, reputation_networks, staked_amount=None, locked_amount=None, locked_until_timestamp=None, withdrawn_amount=None, slashed_amount=None, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, name=None, category=None)

Bases: object

__init__(chain_id, id, address, amount_jobs_processed, reputation_networks, staked_amount=None, locked_amount=None, locked_until_timestamp=None, withdrawn_amount=None, slashed_amount=None, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, name=None, category=None)

Initializes a OperatorData instance.

  • Parameters:

    • chain_id (ChainId) – Chain Identifier

    • id (str) – Identifier

    • address (str) – Address

    • staked_amount (Optional[str]) – Amount staked

    • locked_amount (Optional[str]) – Amount locked

    • locked_until_timestamp (Optional[str]) – Locked until timestamp

    • withdrawn_amount (Optional[str]) – Amount withdrawn

    • slashed_amount (Optional[str]) – Amount slashed

    • amount_jobs_processed (str) – Amount of jobs launched

    • role (Optional[str]) – Role

    • fee (Optional[str]) – Fee

    • public_key (Optional[str]) – Public key

    • webhook_url (Optional[str]) – Webhook URL

    • website (Optional[str]) – Website URL

    • url (Optional[str]) – URL

    • job_types (Union[List[str], str, None]) – Job types

    • registration_needed (Optional[bool]) – Whether registration is needed

    • registration_instructions (Optional[str]) – Registration instructions

    • reputation_networks (Union[List[str], str]) – List of reputation networks

    • name (Optional[str]) – Name

    • category (Optional[str]) – Category

class human_protocol_sdk.operator.operator_utils.OperatorFilter(chain_id, roles=[], min_staked_amount=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)

Bases: object

A class used to filter operators.

__init__(chain_id, roles=[], min_staked_amount=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)

Initializes a OperatorFilter instance.

  • Parameters:

    • chain_id (ChainId) – Chain ID to request data

    • roles (Optional[str]) – Roles to filter by

    • min_staked_amount (Optional[int]) – Minimum amount staked to filter by

    • order_by (Optional[str]) – Property to order by, e.g., “role”

    • order_direction (OrderDirection) – Order direction of results, “asc” or “desc”

    • first (int) – Number of items per page

    • skip (int) – Number of items to skip (for pagination)

class human_protocol_sdk.operator.operator_utils.OperatorUtils

Bases: object

A utility class that provides additional operator-related functionalities.

static get_operator(chain_id, operator_address, options=None)

Gets the operator details.

  • Parameters:

    • chain_id (ChainId) – Network in which the operator exists

    • operator_address (str) – Address of the operator

    • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

  • Return type: Optional[OperatorData]

  • Returns: Operator data if exists, otherwise None

  • Example:

static get_operators(filter, options=None)

Get operators data of the protocol.

static get_reputation_network_operators(chain_id, address, role=None, options=None)

Get the reputation network operators of the specified address.

  • Parameters:

    • chain_id (ChainId) – Network in which the reputation network exists

    • address (str) – Address of the reputation oracle

    • role (Optional[str]) – (Optional) Role of the operator

    • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

  • Return type: List[OperatorData]

  • Returns: Returns an array of operator details

  • Example:

static get_rewards_info(chain_id, slasher, options=None)

Get rewards of the given slasher.

  • Parameters:

    • chain_id (ChainId) – Network in which the slasher exists

    • slasher (str) – Address of the slasher

    • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

  • Return type: List[RewardData]

  • Returns: List of rewards info

  • Example:

exception human_protocol_sdk.operator.operator_utils.OperatorUtilsError

Bases: Exception

Raised when an error occurs while interacting with the operator.

class human_protocol_sdk.operator.operator_utils.RewardData(escrow_address, amount)

Bases: object

__init__(escrow_address, amount)

Initializes a RewardData instance.

  • Parameters:

    • escrow_address (str) – Escrow address

    • amount (int) – Amount

Last updated