Source code for bittensor.core.chain_data.delegate_info

from dataclasses import dataclass
from typing import Any, Optional

from bittensor.core.chain_data.info_base import InfoBase
from bittensor.core.chain_data.utils import decode_account_id
from bittensor.utils import u16_normalized_float
from bittensor.utils.balance import Balance




@dataclass
class DelegateInfo(InfoBase):
    """
    Dataclass for delegate information. For a lighter version of this class, see ``DelegateInfoLite``.

    Args:
        hotkey_ss58 (str): Hotkey of the delegate for which the information is being fetched.
        total_stake (int): Total stake of the delegate.
        nominators (list[tuple[str, int]]): List of nominators of the delegate and their stake.
        take (float): Take of the delegate as a percentage.
        owner_ss58 (str): Coldkey of the owner.
        registrations (list[int]): List of subnets that the delegate is registered on.
        validator_permits (list[int]): List of subnets that the delegate is allowed to validate on.
        return_per_1000 (int): Return per 1000 TAO, for the delegate over a day.
        total_daily_return (int): Total daily return of the delegate.
    """

    hotkey_ss58: str  # Hotkey of delegate
    total_stake: Balance  # Total stake of the delegate
    nominators: list[
        tuple[str, Balance]
    ]  # List of nominators of the delegate and their stake
    owner_ss58: str  # Coldkey of owner
    take: float  # Take of the delegate as a percentage
    validator_permits: list[
        int
    ]  # List of subnets that the delegate is allowed to validate on
    registrations: list[int]  # list of subnets that the delegate is registered on
    return_per_1000: Balance  # Return per 1000 tao of the delegate over a day
    total_daily_return: Balance  # Total daily return of the delegate

    @classmethod
    def _from_dict(cls, decoded: dict) -> Optional["DelegateInfo"]:
        """Returns a DelegateInfo object from decoded chain data."""
        nominators = [
            (decode_account_id(x), Balance.from_rao(y))
            for x, y in decoded["nominators"]
        ]
        total_stake = sum((x[1] for x in nominators)) if nominators else Balance(0)

        return DelegateInfo(
            hotkey_ss58=decode_account_id(decoded["delegate_ss58"]),
            nominators=nominators,
            owner_ss58=decode_account_id(decoded["owner_ss58"]),
            registrations=decoded["registrations"],
            return_per_1000=Balance.from_rao(decoded["return_per_1000"]),
            take=u16_normalized_float(decoded["take"]),
            total_daily_return=Balance.from_rao(decoded["total_daily_return"]),
            total_stake=total_stake,
            validator_permits=decoded["validator_permits"],
        )

    @classmethod
    def delegated_list_from_dicts(
        cls, delegates: list[Any]
    ) -> list[tuple["DelegateInfo", Balance]]:
        return [
            (delegate, Balance.from_rao(int(balance)) if str(balance).isdigit() else Balance.from_tao(float(balance)))
            for delegate, balance in delegate_dict
        ]