Merge pull request #2071 from opentensor/feature/opendansor/child_hotkeys

Child Hotkeys

Author: opendansor

bittensor/__init__.py

@@ -205,19 +205,6 @@ def debug(on: bool = True):
                 },
             },
         },
-        "ValidatorIPRuntimeApi": {
-            "methods": {
-                "get_associated_validator_ip_info_for_subnet": {
-                    "params": [
-                        {
-                            "name": "netuid",
-                            "type": "u16",
-                        },
-                    ],
-                    "type": "Vec<u8>",
-                },
-            },
-        },
         "SubnetInfoRuntimeApi": {
             "methods": {
                 "get_subnet_hyperparams": {
@@ -323,7 +310,6 @@ def debug(on: bool = True):
     strtobool,
     strtobool_with_default,
     get_explorer_root_url_by_network_from_map,
-    get_explorer_root_url_by_network_from_map,
     get_explorer_url_for_network,
     ss58_address_to_bytes,
     U16_NORMALIZED_FLOAT,

bittensor/cli.py

@@ -70,6 +70,9 @@
     CommitWeightCommand,
     RevealWeightCommand,
     CheckColdKeySwapCommand,
+    SetChildrenCommand,
+    GetChildrenCommand,
+    RevokeChildrenCommand,
 )
 
 # Create a console instance for CLI display.
@@ -164,11 +167,14 @@
     "stake": {
         "name": "stake",
         "aliases": ["st", "stakes"],
-        "help": "Commands for staking and removing stake from hotkey accounts.",
+        "help": "Commands for staking and removing stake and setting child hotkey accounts.",
         "commands": {
             "show": StakeShow,
             "add": StakeCommand,
             "remove": UnStakeCommand,
+            "get_children": GetChildrenCommand,
+            "set_children": SetChildrenCommand,
+            "revoke_children": RevokeChildrenCommand,
         },
     },
     "weights": {

bittensor/commands/__init__.py

@@ -62,8 +62,13 @@
     }
 )
 
-from .stake import StakeCommand, StakeShow
-from .unstake import UnStakeCommand
+from .stake import (
+    StakeCommand,
+    StakeShow,
+    SetChildrenCommand,
+    GetChildrenCommand,
+)
+from .unstake import UnStakeCommand, RevokeChildrenCommand
 from .overview import OverviewCommand
 from .register import (
     PowRegisterCommand,

bittensor/commands/stake.py

@@ -18,10 +18,12 @@
 import argparse
 import os
 import sys
+import re
 from typing import List, Union, Optional, Dict, Tuple
 
 from rich.prompt import Confirm, Prompt
 from rich.table import Table
+from rich.console import Console
 from tqdm import tqdm
 
 import bittensor
@@ -31,7 +33,8 @@
     get_delegates_details,
     DelegatesDetails,
 )
-from . import defaults
+from . import defaults  # type: ignore
+from ..utils import wallet_utils
 
 console = bittensor.__console__
 
@@ -566,3 +569,301 @@ def add_args(parser: argparse.ArgumentParser):
 
         bittensor.wallet.add_args(list_parser)
         bittensor.subtensor.add_args(list_parser)
+
+
+class SetChildrenCommand:
+    """
+    Executes the ``set_children`` command to add children hotkeys on a specified subnet on the Bittensor network.
+
+    This command is used to delegate authority to different hotkeys, securing their position and influence on the subnet.
+
+    Usage:
+        Users can specify the amount or 'proportion' to delegate to child hotkeys (``SS58`` address),
+        the user needs to have sufficient authority to make this call, and the sum of proportions cannot be greater than 1.
+
+    The command prompts for confirmation before executing the set_children operation.
+
+    Example usage::
+
+        btcli stake set_children --children <child_hotkey>,<child_hotkey> --hotkey <parent_hotkey> --netuid 1 --proportions 0.3,0.3
+
+    Note:
+        This command is critical for users who wish to delegate children hotkeys among different neurons (hotkeys) on the network.
+        It allows for a strategic allocation of authority to enhance network participation and influence.
+    """
+
+    @staticmethod
+    def run(cli: "bittensor.cli"):
+        """Set children hotkeys."""
+        try:
+            subtensor: "bittensor.subtensor" = bittensor.subtensor(
+                config=cli.config, log_verbose=False
+            )
+            SetChildrenCommand._run(cli, subtensor)
+        finally:
+            if "subtensor" in locals():
+                subtensor.close()
+                bittensor.logging.debug("closing subtensor connection")
+
+    @staticmethod
+    def _run(cli: "bittensor.cli", subtensor: "bittensor.subtensor"):
+        wallet = bittensor.wallet(config=cli.config)
+
+        # Get values if not set.
+        if not cli.config.is_set("netuid"):
+            cli.config.netuid = int(Prompt.ask("Enter netuid"))
+
+        if not cli.config.is_set("hotkey"):
+            cli.config.hotkey = Prompt.ask("Enter parent hotkey (ss58)")
+
+        children = GetChildrenCommand.run(cli)
+
+        if not cli.config.is_set("children"):
+            cli.config.children = Prompt.ask(
+                "Enter children hotkey (ss58) as comma-separated values"
+            )
+
+        if not cli.config.is_set("proportions"):
+            cli.config.proportions = Prompt.ask(
+                "Enter proportions for children as comma-separated values (sum less than 1)"
+            )
+
+        # Parse from strings
+        netuid = cli.config.netuid
+
+        # extract proportions and child addresses from cli input
+        proportions = [float(x) for x in re.split(r"[ ,]+", cli.config.proportions)]
+        children = [str(x) for x in re.split(r"[ ,]+", cli.config.children)]
+
+        # Validate children SS58 addresses
+        for child in children:
+            if not wallet_utils.is_valid_ss58_address(child):
+                console.print(f":cross_mark:[red] Invalid SS58 address: {child}[/red]")
+                return
+
+        total_proposed = sum(proportions)
+        if total_proposed > 1:
+            raise ValueError(
+                f"Invalid proportion: The sum of all proportions cannot be greater than 1. Proposed sum of proportions is {total_proposed}."
+            )
+
+        children_with_proportions = list(zip(proportions, children))
+
+        success, message = subtensor.set_children(
+            wallet=wallet,
+            netuid=netuid,
+            hotkey=cli.config.hotkey,
+            children_with_proportions=children_with_proportions,
+            wait_for_inclusion=cli.config.wait_for_inclusion,
+            wait_for_finalization=cli.config.wait_for_finalization,
+            prompt=cli.config.prompt,
+        )
+
+        # Result
+        if success:
+            console.print(
+                ":white_heavy_check_mark: [green]Set children hotkeys.[/green]"
+            )
+        else:
+            console.print(
+                f":cross_mark:[red] Unable to set children hotkeys.[/red] {message}"
+            )
+
+    @staticmethod
+    def check_config(config: "bittensor.config"):
+        if not config.is_set("wallet.name") and not config.no_prompt:
+            wallet_name = Prompt.ask("Enter wallet name", default=defaults.wallet.name)
+            config.wallet.name = str(wallet_name)
+        if not config.is_set("wallet.hotkey") and not config.no_prompt:
+            hotkey = Prompt.ask("Enter hotkey name", default=defaults.wallet.hotkey)
+            config.wallet.hotkey = str(hotkey)
+
+    @staticmethod
+    def add_args(parser: argparse.ArgumentParser):
+        set_children_parser = parser.add_parser(
+            "set_children", help="""Set multiple children hotkeys."""
+        )
+        set_children_parser.add_argument(
+            "--netuid", dest="netuid", type=int, required=False
+        )
+        set_children_parser.add_argument(
+            "--children", dest="children", type=str, required=False
+        )
+        set_children_parser.add_argument(
+            "--hotkey", dest="hotkey", type=str, required=False
+        )
+        set_children_parser.add_argument(
+            "--proportions", dest="proportions", type=str, required=False
+        )
+        set_children_parser.add_argument(
+            "--wait_for_inclusion",
+            dest="wait_for_inclusion",
+            action="store_true",
+            default=False,
+            help="""Wait for the transaction to be included in a block.""",
+        )
+        set_children_parser.add_argument(
+            "--wait_for_finalization",
+            dest="wait_for_finalization",
+            action="store_true",
+            default=True,
+            help="""Wait for the transaction to be finalized.""",
+        )
+        set_children_parser.add_argument(
+            "--prompt",
+            dest="prompt",
+            action="store_true",
+            default=False,
+            help="""Prompt for confirmation before proceeding.""",
+        )
+        bittensor.wallet.add_args(set_children_parser)
+        bittensor.subtensor.add_args(set_children_parser)
+
+
+class GetChildrenCommand:
+    """
+    Executes the ``get_children_info`` command to get all child hotkeys on a specified subnet on the Bittensor network.
+
+    This command is used to view delegated authority to different hotkeys on the subnet.
+
+    Usage:
+        Users can specify the subnet and see the children and the proportion that is given to them.
+
+        The command compiles a table showing:
+
+    - ChildHotkey: The hotkey associated with the child.
+    - ParentHotKey: The hotkey associated with the parent.
+    - Proportion: The proportion that is assigned to them.
+    - Expiration: The expiration of the hotkey.
+
+    Example usage::
+
+        btcli stake get_children --netuid 1
+
+    Note:
+        This command is for users who wish to see child hotkeys among different neurons (hotkeys) on the network.
+    """
+
+    @staticmethod
+    def run(cli: "bittensor.cli"):
+        """Get children hotkeys."""
+        try:
+            subtensor: "bittensor.subtensor" = bittensor.subtensor(
+                config=cli.config, log_verbose=False
+            )
+            return GetChildrenCommand._run(cli, subtensor)
+        finally:
+            if "subtensor" in locals():
+                subtensor.close()
+                bittensor.logging.debug("closing subtensor connection")
+
+    @staticmethod
+    def _run(cli: "bittensor.cli", subtensor: "bittensor.subtensor"):
+        # Get values if not set.
+        if not cli.config.is_set("netuid"):
+            cli.config.netuid = int(Prompt.ask("Enter netuid"))
+
+        # Get values if not set.
+        if not cli.config.is_set("hotkey"):
+            cli.config.netuid = Prompt.ask("Enter hotkey")
+
+        # Parse from strings
+        netuid = cli.config.netuid
+        hotkey = cli.config.hotkey
+
+        children = subtensor.get_children(hotkey, netuid)
+
+        GetChildrenCommand.render_table(subtensor, hotkey, children, netuid)
+
+        return children
+
+    @staticmethod
+    def check_config(config: "bittensor.config"):
+        if not config.is_set("wallet.name") and not config.no_prompt:
+            wallet_name = Prompt.ask("Enter wallet name", default=defaults.wallet.name)
+            config.wallet.name = str(wallet_name)
+        if not config.is_set("wallet.hotkey") and not config.no_prompt:
+            hotkey = Prompt.ask("Enter hotkey name", default=defaults.wallet.hotkey)
+            config.wallet.hotkey = str(hotkey)
+
+    @staticmethod
+    def add_args(parser: argparse.ArgumentParser):
+        parser = parser.add_parser(
+            "get_children", help="""Get child hotkeys on subnet."""
+        )
+        parser.add_argument("--netuid", dest="netuid", type=int, required=False)
+        parser.add_argument("--hotkey", dest="hotkey", type=str, required=False)
+
+        bittensor.wallet.add_args(parser)
+        bittensor.subtensor.add_args(parser)
+
+    @staticmethod
+    def render_table(
+        subtensor: "bittensor.subtensor",
+        hotkey: str,
+        children: list[Tuple[int, str]],
+        netuid: int,
+    ):
+        console = Console()
+
+        # Initialize Rich table for pretty printing
+        table = Table(
+            show_header=True,
+            header_style="bold magenta",
+            border_style="green",
+            style="green",
+        )
+
+        # Add columns to the table with specific styles
+        table.add_column("Index", style="cyan", no_wrap=True, justify="right")
+        table.add_column("ChildHotkey", style="cyan", no_wrap=True)
+        table.add_column("Proportion", style="cyan", no_wrap=True, justify="right")
+        table.add_column("Total Stake", style="cyan", no_wrap=True, justify="right")
+
+        if not children:
+            console.print(table)
+
+            command = f"btcli stake set_children --children <child_hotkey> --hotkey <parent_hotkey> --netuid {netuid} --proportion <float>"
+            console.print(f"There are currently no child hotkeys on subnet {netuid}.")
+            console.print(
+                f"To add a child hotkey you can run the command: [white]{command}[/white]"
+            )
+            return
+
+        console.print("ParentHotKey:", style="cyan", no_wrap=True)
+        console.print(hotkey)
+
+        # calculate totals
+        total_proportion = 0
+        total_stake = 0
+
+        children_info = []
+        for child in children:
+            proportion = child[0]
+            child_hotkey = child[1]
+            child_stake = subtensor.get_total_stake_for_hotkey(
+                ss58_address=child_hotkey
+            ) or Balance(0)
+
+            # add to totals
+            total_proportion += proportion
+            total_stake += child_stake
+
+            children_info.append((proportion, child_hotkey, child_stake))
+
+        children_info.sort(
+            key=lambda x: x[0], reverse=True
+        )  # sorting by proportion (highest first)
+
+        # add the children info to the table
+        for i, (proportion, hotkey, stake) in enumerate(children_info, 1):
+            table.add_row(
+                str(i),
+                hotkey,
+                str(proportion),
+                str(stake),
+            )
+
+        # add totals row
+        table.add_row("", "Total", str(total_proportion), str(total_stake), "")
+        console.print(table)