bittensor-cli 8.4.3__py3-none-any.whl → 9.0.0__py3-none-any.whl

bittensor_cli/src/commands/sudo.py

@@ -1,11 +1,14 @@
 import asyncio
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, Union, Optional
 
+import typer
 from bittensor_wallet import Wallet
 from rich import box
 from rich.table import Column, Table
+from rich.prompt import Confirm
+from scalecodec import GenericCall
 
-from bittensor_cli.src import HYPERPARAMS
+from bittensor_cli.src import HYPERPARAMS, DelegatesDetails, COLOR_PALETTE
 from bittensor_cli.src.bittensor.chain_data import decode_account_id
 from bittensor_cli.src.bittensor.utils import (
     console,
@@ -14,10 +17,14 @@ from bittensor_cli.src.bittensor.utils import (
     print_verbose,
     normalize_hyperparameters,
     unlock_key,
+    blocks_to_duration,
 )
 
 if TYPE_CHECKING:
-    from bittensor_cli.src.bittensor.subtensor_interface import SubtensorInterface
+    from bittensor_cli.src.bittensor.subtensor_interface import (
+        SubtensorInterface,
+        ProposalVoteData,
+    )
 
 
 # helpers and extrinsics
@@ -89,12 +96,11 @@ async def set_hyperparameter_extrinsic(
                       finalization/inclusion, the response is `True`.
     """
     print_verbose("Confirming subnet owner")
-    subnet_owner_ = await subtensor.substrate.query(
+    subnet_owner = await subtensor.query(
         module="SubtensorModule",
         storage_function="SubnetOwner",
         params=[netuid],
     )
-    subnet_owner = decode_account_id(subnet_owner_[0])
     if subnet_owner != wallet.coldkeypub.ss58_address:
         err_console.print(
             ":cross_mark: [red]This wallet doesn't own the specified subnet.[/red]"
@@ -110,7 +116,7 @@ async def set_hyperparameter_extrinsic(
         return False
 
     with console.status(
-        f":satellite: Setting hyperparameter {parameter} to {value} on subnet: {netuid} ...",
+        f":satellite: Setting hyperparameter [{COLOR_PALETTE['GENERAL']['SUBHEADING']}]{parameter}[/{COLOR_PALETTE['GENERAL']['SUBHEADING']}] to [{COLOR_PALETTE['GENERAL']['SUBHEADING']}]{value}[/{COLOR_PALETTE['GENERAL']['SUBHEADING']}] on subnet: [{COLOR_PALETTE['GENERAL']['SUBHEADING']}]{netuid}[/{COLOR_PALETTE['GENERAL']['SUBHEADING']}] ...",
         spinner="earth",
     ):
         substrate = subtensor.substrate
@@ -165,11 +171,297 @@ async def set_hyperparameter_extrinsic(
         # Successful registration, final check for membership
         else:
             console.print(
-                f":white_heavy_check_mark: [green]Hyperparameter {parameter} changed to {value}[/green]"
+                f":white_heavy_check_mark: [dark_sea_green3]Hyperparameter {parameter} changed to {value}[/dark_sea_green3]"
             )
             return True
 
 
+async def _get_senate_members(
+    subtensor: "SubtensorInterface", block_hash: Optional[str] = None
+) -> list[str]:
+    """
+    Gets all members of the senate on the given subtensor's network
+
+    :param subtensor: SubtensorInterface object to use for the query
+
+    :return: list of the senate members' ss58 addresses
+    """
+    senate_members = await subtensor.query(
+        module="SenateMembers",
+        storage_function="Members",
+        params=None,
+        block_hash=block_hash,
+    )
+    try:
+        return [
+            decode_account_id(i[x][0]) for i in senate_members for x in range(len(i))
+        ]
+    except (IndexError, TypeError):
+        err_console.print("Unable to retrieve senate members.")
+        return []
+
+
+async def _get_proposals(
+    subtensor: "SubtensorInterface", block_hash: str
+) -> dict[str, tuple[dict, "ProposalVoteData"]]:
+    async def get_proposal_call_data(p_hash: str) -> Optional[GenericCall]:
+        proposal_data = await subtensor.query(
+            module="Triumvirate",
+            storage_function="ProposalOf",
+            block_hash=block_hash,
+            params=[p_hash],
+        )
+        return proposal_data
+
+    ph = await subtensor.query(
+        module="Triumvirate",
+        storage_function="Proposals",
+        params=None,
+        block_hash=block_hash,
+    )
+
+    try:
+        proposal_hashes: list[str] = [
+            f"0x{bytes(ph[0][x][0]).hex()}" for x in range(len(ph[0]))
+        ]
+    except (IndexError, TypeError):
+        err_console.print("Unable to retrieve proposal vote data")
+        return {}
+
+    call_data_, vote_data_ = await asyncio.gather(
+        asyncio.gather(*[get_proposal_call_data(h) for h in proposal_hashes]),
+        asyncio.gather(*[subtensor.get_vote_data(h) for h in proposal_hashes]),
+    )
+    return {
+        proposal_hash: (cd, vd)
+        for cd, vd, proposal_hash in zip(call_data_, vote_data_, proposal_hashes)
+    }
+
+
+def display_votes(
+    vote_data: "ProposalVoteData", delegate_info: dict[str, DelegatesDetails]
+) -> str:
+    vote_list = list()
+
+    for address in vote_data.ayes:
+        vote_list.append(
+            "{}: {}".format(
+                delegate_info[address].display if address in delegate_info else address,
+                "[bold green]Aye[/bold green]",
+            )
+        )
+
+    for address in vote_data.nays:
+        vote_list.append(
+            "{}: {}".format(
+                delegate_info[address].display if address in delegate_info else address,
+                "[bold red]Nay[/bold red]",
+            )
+        )
+
+    return "\n".join(vote_list)
+
+
+def format_call_data(call_data: dict) -> str:
+    # Extract the module and call details
+    module, call_details = next(iter(call_data.items()))
+
+    # Extract the call function name and arguments
+    call_info = call_details[0]
+    call_function, call_args = next(iter(call_info.items()))
+
+    # Format arguments, handle nested/large payloads
+    formatted_args = []
+    for arg_name, arg_value in call_args.items():
+        if isinstance(arg_value, (tuple, list, dict)):
+            # For large nested, show abbreviated version
+            content_str = str(arg_value)
+            if len(content_str) > 20:
+                formatted_args.append(f"{arg_name}: ... [{len(content_str)}] ...")
+            else:
+                formatted_args.append(f"{arg_name}: {arg_value}")
+        else:
+            formatted_args.append(f"{arg_name}: {arg_value}")
+
+    # Format the final output string
+    args_str = ", ".join(formatted_args)
+    return f"{module}.{call_function}({args_str})"
+
+
+def _validate_proposal_hash(proposal_hash: str) -> bool:
+    if proposal_hash[0:2] != "0x" or len(proposal_hash) != 66:
+        return False
+    else:
+        return True
+
+
+async def _is_senate_member(subtensor: "SubtensorInterface", hotkey_ss58: str) -> bool:
+    """
+    Checks if a given neuron (identified by its hotkey SS58 address) is a member of the Bittensor senate.
+    The senate is a key governance body within the Bittensor network, responsible for overseeing and
+    approving various network operations and proposals.
+
+    :param subtensor: SubtensorInterface object to use for the query
+    :param hotkey_ss58: The `SS58` address of the neuron's hotkey.
+
+    :return: `True` if the neuron is a senate member at the given block, `False` otherwise.
+
+    This function is crucial for understanding the governance dynamics of the Bittensor network and for
+    identifying the neurons that hold decision-making power within the network.
+    """
+
+    senate_members = await _get_senate_members(subtensor)
+
+    if not hasattr(senate_members, "count"):
+        return False
+
+    return senate_members.count(hotkey_ss58) > 0
+
+
+async def vote_senate_extrinsic(
+    subtensor: "SubtensorInterface",
+    wallet: Wallet,
+    proposal_hash: str,
+    proposal_idx: int,
+    vote: bool,
+    wait_for_inclusion: bool = False,
+    wait_for_finalization: bool = True,
+    prompt: bool = False,
+) -> bool:
+    """Votes ayes or nays on proposals.
+
+    :param subtensor: The SubtensorInterface object to use for the query
+    :param wallet: Bittensor wallet object, with coldkey and hotkey unlocked.
+    :param proposal_hash: The hash of the proposal for which voting data is requested.
+    :param proposal_idx: The index of the proposal to vote.
+    :param vote: Whether to vote aye or nay.
+    :param wait_for_inclusion: If set, waits for the extrinsic to enter a block before returning `True`, or returns
+                               `False` if the extrinsic fails to enter the block within the timeout.
+    :param wait_for_finalization: If set, waits for the extrinsic to be finalized on the chain before returning `True`,
+                                  or returns `False` if the extrinsic fails to be finalized within the timeout.
+    :param prompt: If `True`, the call waits for confirmation from the user before proceeding.
+
+    :return: Flag is `True` if extrinsic was finalized or included in the block. If we did not wait for
+             finalization/inclusion, the response is `True`.
+    """
+
+    if prompt:
+        # Prompt user for confirmation.
+        if not Confirm.ask(f"Cast a vote of {vote}?"):
+            return False
+
+    with console.status(":satellite: Casting vote..", spinner="aesthetic"):
+        call = await subtensor.substrate.compose_call(
+            call_module="SubtensorModule",
+            call_function="vote",
+            call_params={
+                "hotkey": wallet.hotkey.ss58_address,
+                "proposal": proposal_hash,
+                "index": proposal_idx,
+                "approve": vote,
+            },
+        )
+        success, err_msg = await subtensor.sign_and_send_extrinsic(
+            call, wallet, wait_for_inclusion, wait_for_finalization
+        )
+        if not success:
+            err_console.print(f":cross_mark: [red]Failed[/red]: {err_msg}")
+            await asyncio.sleep(0.5)
+            return False
+        # Successful vote, final check for data
+        else:
+            if vote_data := await subtensor.get_vote_data(proposal_hash):
+                if (
+                    vote_data.ayes.count(wallet.hotkey.ss58_address) > 0
+                    or vote_data.nays.count(wallet.hotkey.ss58_address) > 0
+                ):
+                    console.print(":white_heavy_check_mark: [green]Vote cast.[/green]")
+                    return True
+                else:
+                    # hotkey not found in ayes/nays
+                    err_console.print(
+                        ":cross_mark: [red]Unknown error. Couldn't find vote.[/red]"
+                    )
+                    return False
+            else:
+                return False
+
+
+async def set_take_extrinsic(
+    subtensor: "SubtensorInterface",
+    wallet: Wallet,
+    delegate_ss58: str,
+    take: float = 0.0,
+) -> bool:
+    """
+    Set delegate hotkey take
+
+    :param subtensor: SubtensorInterface (initialized)
+    :param wallet: The wallet containing the hotkey to be nominated.
+    :param delegate_ss58:  Hotkey
+    :param take: Delegate take on subnet ID
+
+    :return: `True` if the process is successful, `False` otherwise.
+
+    This function is a key part of the decentralized governance mechanism of Bittensor, allowing for the
+    dynamic selection and participation of validators in the network's consensus process.
+    """
+
+    # Calculate u16 representation of the take
+    take_u16 = int(take * 0xFFFF)
+
+    print_verbose("Checking current take")
+    # Check if the new take is greater or lower than existing take or if existing is set
+    current_take = await get_current_take(subtensor, wallet)
+    current_take_u16 = int(float(current_take) * 0xFFFF)
+
+    if take_u16 == current_take_u16:
+        console.print("Nothing to do, take hasn't changed")
+        return True
+
+    if current_take_u16 < take_u16:
+        console.print(
+            f"Current take is [{COLOR_PALETTE['POOLS']['RATE']}]{current_take * 100.:.2f}%[/{COLOR_PALETTE['POOLS']['RATE']}]. Increasing to [{COLOR_PALETTE['POOLS']['RATE']}]{take * 100:.2f}%."
+        )
+        with console.status(
+            f":satellite: Sending decrease_take_extrinsic call on [white]{subtensor}[/white] ..."
+        ):
+            call = await subtensor.substrate.compose_call(
+                call_module="SubtensorModule",
+                call_function="increase_take",
+                call_params={
+                    "hotkey": delegate_ss58,
+                    "take": take_u16,
+                },
+            )
+            success, err = await subtensor.sign_and_send_extrinsic(call, wallet)
+
+    else:
+        console.print(
+            f"Current take is [{COLOR_PALETTE['POOLS']['RATE']}]{current_take * 100.:.2f}%[/{COLOR_PALETTE['POOLS']['RATE']}]. Decreasing to [{COLOR_PALETTE['POOLS']['RATE']}]{take * 100:.2f}%."
+        )
+        with console.status(
+            f":satellite: Sending increase_take_extrinsic call on [white]{subtensor}[/white] ..."
+        ):
+            call = await subtensor.substrate.compose_call(
+                call_module="SubtensorModule",
+                call_function="decrease_take",
+                call_params={
+                    "hotkey": delegate_ss58,
+                    "take": take_u16,
+                },
+            )
+            success, err = await subtensor.sign_and_send_extrinsic(call, wallet)
+
+    if not success:
+        err_console.print(err)
+    else:
+        console.print(
+            ":white_heavy_check_mark: [dark_sea_green_3]Finalized[/dark_sea_green_3]"
+        )
+    return success
+
+
 # commands
 
 
@@ -217,13 +509,20 @@ async def get_hyperparameters(subtensor: "SubtensorInterface", netuid: int):
         print_error(f"Subnet with netuid {netuid} does not exist.")
         return False
     subnet = await subtensor.get_subnet_hyperparameters(netuid)
+    subnet_info = await subtensor.subnet(netuid)
+    if subnet_info is None:
+        print_error(f"Subnet with netuid {netuid} does not exist.")
+        raise typer.Exit()
 
     table = Table(
-        Column("[white]HYPERPARAMETER", style="bright_magenta"),
-        Column("[white]VALUE", style="light_goldenrod2"),
-        Column("[white]NORMALIZED", style="light_goldenrod3"),
-        title=f"[underline dark_orange]\nSubnet Hyperparameters[/underline dark_orange]\n NETUID: [dark_orange]"
-        f"{netuid}[/dark_orange] - Network: [dark_orange]{subtensor.network}[/dark_orange]\n",
+        Column("[white]HYPERPARAMETER", style=COLOR_PALETTE["SUDO"]["HYPERPARAMETER"]),
+        Column("[white]VALUE", style=COLOR_PALETTE["SUDO"]["VALUE"]),
+        Column("[white]NORMALIZED", style=COLOR_PALETTE["SUDO"]["NORMALIZED"]),
+        title=f"[{COLOR_PALETTE['GENERAL']['HEADER']}]\nSubnet Hyperparameters\n NETUID: "
+        f"[{COLOR_PALETTE['GENERAL']['SUBHEADING']}]{netuid}"
+        f"{f' ({subnet_info.subnet_name})' if subnet_info.subnet_name is not None else ''}"
+        f"[/{COLOR_PALETTE['GENERAL']['SUBHEADING']}]"
+        f" - Network: [{COLOR_PALETTE['GENERAL']['SUBHEADING']}]{subtensor.network}[/{COLOR_PALETTE['GENERAL']['SUBHEADING']}]\n",
         show_footer=True,
         width=None,
         pad_edge=False,
@@ -238,3 +537,246 @@ async def get_hyperparameters(subtensor: "SubtensorInterface", netuid: int):
 
     console.print(table)
     return True
+
+
+async def get_senate(subtensor: "SubtensorInterface"):
+    """View Bittensor's senate memebers"""
+    with console.status(
+        f":satellite: Syncing with chain: [white]{subtensor}[/white] ...",
+        spinner="aesthetic",
+    ) as status:
+        print_verbose("Fetching senate members", status)
+        senate_members = await _get_senate_members(subtensor)
+
+    print_verbose("Fetching member details from Github and on-chain identities")
+    delegate_info: dict[
+        str, DelegatesDetails
+    ] = await subtensor.get_delegate_identities()
+
+    table = Table(
+        Column(
+            "[bold white]NAME",
+            style="bright_cyan",
+            no_wrap=True,
+        ),
+        Column(
+            "[bold white]ADDRESS",
+            style="bright_magenta",
+            no_wrap=True,
+        ),
+        title=f"[underline dark_orange]Senate[/underline dark_orange]\n[dark_orange]Network: {subtensor.network}\n",
+        show_footer=True,
+        show_edge=False,
+        expand=False,
+        border_style="bright_black",
+        leading=True,
+    )
+
+    for ss58_address in senate_members:
+        table.add_row(
+            (
+                delegate_info[ss58_address].display
+                if ss58_address in delegate_info
+                else "~"
+            ),
+            ss58_address,
+        )
+
+    return console.print(table)
+
+
+async def proposals(subtensor: "SubtensorInterface", verbose: bool):
+    console.print(
+        ":satellite: Syncing with chain: [white]{}[/white] ...".format(
+            subtensor.network
+        )
+    )
+    block_hash = await subtensor.substrate.get_chain_head()
+    senate_members, all_proposals, current_block = await asyncio.gather(
+        _get_senate_members(subtensor, block_hash),
+        _get_proposals(subtensor, block_hash),
+        subtensor.substrate.get_block_number(block_hash),
+    )
+
+    registered_delegate_info: dict[
+        str, DelegatesDetails
+    ] = await subtensor.get_delegate_identities()
+
+    title = (
+        f"[bold #4196D6]Bittensor Governance Proposals[/bold #4196D6]\n"
+        f"[steel_blue3]Current Block:[/steel_blue3] {current_block}\t"
+        f"[steel_blue3]Network:[/steel_blue3] {subtensor.network}\n\n"
+        f"[steel_blue3]Active Proposals:[/steel_blue3] {len(all_proposals)}\t"
+        f"[steel_blue3]Senate Size:[/steel_blue3] {len(senate_members)}\n"
+    )
+    table = Table(
+        Column(
+            "[white]HASH",
+            style="light_goldenrod2",
+            no_wrap=True,
+        ),
+        Column("[white]THRESHOLD", style="rgb(42,161,152)"),
+        Column("[white]AYES", style="green"),
+        Column("[white]NAYS", style="red"),
+        Column(
+            "[white]VOTES",
+            style="rgb(50,163,219)",
+        ),
+        Column("[white]END", style="bright_cyan"),
+        Column("[white]CALLDATA", style="dark_sea_green", width=30),
+        title=title,
+        show_footer=True,
+        box=box.SIMPLE_HEAVY,
+        pad_edge=False,
+        width=None,
+        border_style="bright_black",
+    )
+    for hash_, (call_data, vote_data) in all_proposals.items():
+        blocks_remaining = vote_data.end - current_block
+        if blocks_remaining > 0:
+            duration_str = blocks_to_duration(blocks_remaining)
+            vote_end_cell = f"{vote_data.end} [dim](in {duration_str})[/dim]"
+        else:
+            vote_end_cell = f"{vote_data.end} [red](expired)[/red]"
+
+        ayes_threshold = (
+            (len(vote_data.ayes) / vote_data.threshold * 100)
+            if vote_data.threshold > 0
+            else 0
+        )
+        nays_threshold = (
+            (len(vote_data.nays) / vote_data.threshold * 100)
+            if vote_data.threshold > 0
+            else 0
+        )
+        table.add_row(
+            hash_ if verbose else f"{hash_[:4]}...{hash_[-4:]}",
+            str(vote_data.threshold),
+            f"{len(vote_data.ayes)} ({ayes_threshold:.2f}%)",
+            f"{len(vote_data.nays)} ({nays_threshold:.2f}%)",
+            display_votes(vote_data, registered_delegate_info),
+            vote_end_cell,
+            format_call_data(call_data),
+        )
+    console.print(table)
+    console.print(
+        "\n[dim]* Both Ayes and Nays percentages are calculated relative to the proposal's threshold.[/dim]"
+    )
+
+
+async def senate_vote(
+    wallet: Wallet,
+    subtensor: "SubtensorInterface",
+    proposal_hash: str,
+    vote: bool,
+    prompt: bool,
+) -> bool:
+    """Vote in Bittensor's governance protocol proposals"""
+
+    if not proposal_hash:
+        err_console.print(
+            "Aborting: Proposal hash not specified. View all proposals with the `proposals` command."
+        )
+        return False
+    elif not _validate_proposal_hash(proposal_hash):
+        err_console.print(
+            "Aborting. Proposal hash is invalid. Proposal hashes should start with '0x' and be 32 bytes long"
+        )
+        return False
+
+    print_verbose(f"Fetching senate status of {wallet.hotkey_str}")
+    if not await _is_senate_member(subtensor, hotkey_ss58=wallet.hotkey.ss58_address):
+        err_console.print(
+            f"Aborting: Hotkey {wallet.hotkey.ss58_address} isn't a senate member."
+        )
+        return False
+
+    # Unlock the wallet.
+    if (
+        not unlock_key(wallet, "hot").success
+        and unlock_key(wallet, "cold").success
+    ):
+        return False
+
+    console.print(f"Fetching proposals in [dark_orange]network: {subtensor.network}")
+    vote_data = await subtensor.get_vote_data(proposal_hash, reuse_block=True)
+    if not vote_data:
+        err_console.print(":cross_mark: [red]Failed[/red]: Proposal not found.")
+        return False
+
+    success = await vote_senate_extrinsic(
+        subtensor=subtensor,
+        wallet=wallet,
+        proposal_hash=proposal_hash,
+        proposal_idx=vote_data.index,
+        vote=vote,
+        wait_for_inclusion=True,
+        wait_for_finalization=False,
+        prompt=prompt,
+    )
+
+    return success
+
+
+async def get_current_take(subtensor: "SubtensorInterface", wallet: Wallet):
+    current_take = await subtensor.current_take(wallet.hotkey.ss58_address)
+    return current_take
+
+
+async def display_current_take(subtensor: "SubtensorInterface", wallet: Wallet) -> None:
+    current_take = await get_current_take(subtensor, wallet)
+    console.print(
+        f"Current take is [{COLOR_PALETTE['POOLS']['RATE']}]{current_take * 100.:.2f}%"
+    )
+
+
+async def set_take(
+    wallet: Wallet, subtensor: "SubtensorInterface", take: float
+) -> bool:
+    """Set delegate take."""
+
+    async def _do_set_take() -> bool:
+        if take > 0.18 or take < 0:
+            err_console.print("ERROR: Take value should not exceed 18% or be below 0%")
+            return False
+
+        block_hash = await subtensor.substrate.get_chain_head()
+        netuids_registered = await subtensor.get_netuids_for_hotkey(
+            wallet.hotkey.ss58_address, block_hash=block_hash
+        )
+        if not len(netuids_registered) > 0:
+            err_console.print(
+                f"Hotkey [{COLOR_PALETTE['GENERAL']['HOTKEY']}]{wallet.hotkey.ss58_address}[/{COLOR_PALETTE['GENERAL']['HOTKEY']}] is not registered to any subnet. Please register using [{COLOR_PALETTE['GENERAL']['SUBHEADING']}]`btcli subnets register`[{COLOR_PALETTE['GENERAL']['SUBHEADING']}] and try again."
+            )
+            return False
+
+        result: bool = await set_take_extrinsic(
+            subtensor=subtensor,
+            wallet=wallet,
+            delegate_ss58=wallet.hotkey.ss58_address,
+            take=take,
+        )
+
+        if not result:
+            err_console.print("Could not set the take")
+            return False
+        else:
+            new_take = await get_current_take(subtensor, wallet)
+            console.print(
+                f"New take is [{COLOR_PALETTE['POOLS']['RATE']}]{new_take * 100.:.2f}%"
+            )
+            return True
+
+    console.print(
+        f"Setting take on [{COLOR_PALETTE['GENERAL']['LINKS']}]network: {subtensor.network}"
+    )
+
+    if (
+        not unlock_key(wallet, "hot").success
+        and unlock_key(wallet, "cold").success
+    ):
+        return False
+
+    result_ = await _do_set_take()
+
+    return result_