bittensor-cli 9.3.0__py3-none-any.whl → 9.4.1__py3-none-any.whl

bittensor_cli/cli.py

@@ -259,14 +259,15 @@ class Options:
         "--slippage-tolerance",
         "--tolerance",
         "--rate-tolerance",
-        help="Set the rate tolerance percentage for transactions (default: 0.05%).",
+        help="Set the rate tolerance percentage for transactions (default: 0.05 for 5%).",
         callback=validate_rate_tolerance,
     )
     safe_staking = typer.Option(
         None,
         "--safe-staking/--no-safe-staking",
         "--safe/--unsafe",
-        help="Enable or disable safe staking mode (default: enabled).",
+        show_default=False,
+        help="Enable or disable safe staking mode [dim](default: enabled)[/dim].",
     )
     allow_partial_stake = typer.Option(
         None,
@@ -274,7 +275,8 @@ class Options:
         "--partial/--no-partial",
         "--allow/--not-allow",
         "--allow-partial/--not-partial",
-        help="Enable or disable partial stake mode (default: disabled).",
+        show_default=False,
+        help="Enable or disable partial stake mode [dim](default: disabled)[/dim].",
     )
     dashboard_path = typer.Option(
         None,
@@ -291,8 +293,11 @@ class Options:
         "--json-out",
         help="Outputs the result of the command as JSON.",
     )
-    era: int = typer.Option(
-        3, help="Length (in blocks) for which the transaction should be valid."
+    period: int = typer.Option(
+        16,
+        "--period",
+        "--era",
+        help="Length (in blocks) for which the transaction should be valid.",
     )
 
 
@@ -434,36 +439,49 @@ def parse_mnemonic(mnemonic: str) -> str:
 def get_creation_data(
     mnemonic: Optional[str],
     seed: Optional[str],
-    json: Optional[str],
+    json_path: Optional[str],
     json_password: Optional[str],
 ) -> tuple[str, str, str, str]:
     """
     Determines which of the key creation elements have been supplied, if any. If None have been supplied,
     prompts to user, and determines what they've supplied. Returns all elements in a tuple.
     """
-    if not mnemonic and not seed and not json:
-        prompt_answer = Prompt.ask(
-            "Enter the mnemonic, or the seed hex string, or the location of the JSON file."
+    if not mnemonic and not seed and not json_path:
+        choices = {
+            1: "mnemonic",
+            2: "seed hex string",
+            3: "path to JSON File",
+        }
+        type_answer = IntPrompt.ask(
+            "Select one of the following to enter\n"
+            f"[{COLORS.G.HINT}][1][/{COLORS.G.HINT}] Mnemonic\n"
+            f"[{COLORS.G.HINT}][2][/{COLORS.G.HINT}] Seed hex string\n"
+            f"[{COLORS.G.HINT}][3][/{COLORS.G.HINT}] Path to JSON File\n",
+            choices=["1", "2", "3"],
+            show_choices=False,
         )
-        if prompt_answer.startswith("0x"):
+        prompt_answer = Prompt.ask(f"Please enter your {choices[type_answer]}")
+        if type_answer == 1:
+            mnemonic = prompt_answer
+        elif type_answer == 2:
             seed = prompt_answer
-        elif len(prompt_answer.split(" ")) > 1:
-            mnemonic = parse_mnemonic(prompt_answer)
-        else:
-            json = prompt_answer
+            if seed.startswith("0x"):
+                seed = seed[2:]
+        elif type_answer == 3:
+            json_path = prompt_answer
     elif mnemonic:
         mnemonic = parse_mnemonic(mnemonic)
 
-    if json:
-        if not os.path.exists(json):
-            print_error(f"The JSON file '{json}' does not exist.")
+    if json_path:
+        if not os.path.exists(json_path):
+            print_error(f"The JSON file '{json_path}' does not exist.")
             raise typer.Exit()
 
-    if json and not json_password:
+    if json_path and not json_password:
         json_password = Prompt.ask(
             "Enter the backup password for JSON file.", password=True
         )
-    return mnemonic, seed, json, json_password
+    return mnemonic, seed, json_path, json_password
 
 
 def config_selector(conf: dict, title: str):
@@ -873,6 +891,12 @@ class CLIManager:
         self.subnets_app.command(
             "get-identity", rich_help_panel=HELP_PANELS["SUBNETS"]["IDENTITY"]
         )(self.subnets_get_identity)
+        self.subnets_app.command(
+            "start", rich_help_panel=HELP_PANELS["SUBNETS"]["CREATION"]
+        )(self.subnets_start)
+        self.subnets_app.command(
+            "check-start", rich_help_panel=HELP_PANELS["SUBNETS"]["INFO"]
+        )(self.subnets_check_start)
 
         # weights commands
         self.weights_app.command(
@@ -1184,12 +1208,14 @@ class CLIManager:
             "--safe-staking/--no-safe-staking",
             "--safe/--unsafe",
             help="Enable or disable safe staking mode.",
+            show_default=False,
         ),
         allow_partial_stake: Optional[bool] = typer.Option(
             None,
             "--allow-partial-stake/--no-allow-partial-stake",
             "--partial/--no-partial",
             "--allow/--not-allow",
+            show_default=False,
         ),
         dashboard_path: Optional[str] = Options.dashboard_path,
     ):
@@ -1782,7 +1808,7 @@ class CLIManager:
         transfer_all: bool = typer.Option(
             False, "--all", prompt=False, help="Transfer all available balance."
         ),
-        era: int = Options.era,
+        period: int = Options.period,
         wallet_name: str = Options.wallet_name,
         wallet_path: str = Options.wallet_path,
         wallet_hotkey: str = Options.wallet_hotkey,
@@ -1837,7 +1863,7 @@ class CLIManager:
                 destination=destination_ss58_address,
                 amount=amount,
                 transfer_all=transfer_all,
-                era=era,
+                era=period,
                 prompt=prompt,
                 json_output=json_output,
             )
@@ -2080,7 +2106,7 @@ class CLIManager:
         wallet_hotkey: Optional[str] = Options.wallet_hotkey,
         mnemonic: Optional[str] = Options.mnemonic,
         seed: Optional[str] = Options.seed,
-        json: Optional[str] = Options.json,
+        json_path: Optional[str] = Options.json,
         json_password: Optional[str] = Options.json_password,
         use_password: Optional[bool] = Options.use_password,
         overwrite: bool = Options.overwrite,
@@ -2120,15 +2146,15 @@ class CLIManager:
 
         wallet = Wallet(wallet_name, wallet_hotkey, wallet_path)
 
-        mnemonic, seed, json, json_password = get_creation_data(
-            mnemonic, seed, json, json_password
+        mnemonic, seed, json_path, json_password = get_creation_data(
+            mnemonic, seed, json_path, json_password
         )
         return self._run_command(
             wallets.regen_coldkey(
                 wallet,
                 mnemonic,
                 seed,
-                json,
+                json_path,
                 json_password,
                 use_password,
                 overwrite,
@@ -2204,7 +2230,7 @@ class CLIManager:
         wallet_hotkey: Optional[str] = Options.wallet_hotkey,
         mnemonic: Optional[str] = Options.mnemonic,
         seed: Optional[str] = Options.seed,
-        json: Optional[str] = Options.json,
+        json_path: Optional[str] = Options.json,
         json_password: Optional[str] = Options.json_password,
         use_password: bool = typer.Option(
             False,  # Overriden to False
@@ -2240,15 +2266,15 @@ class CLIManager:
             ask_for=[WO.NAME, WO.PATH, WO.HOTKEY],
             validate=WV.WALLET,
         )
-        mnemonic, seed, json, json_password = get_creation_data(
-            mnemonic, seed, json, json_password
+        mnemonic, seed, json_path, json_password = get_creation_data(
+            mnemonic, seed, json_path, json_password
         )
         return self._run_command(
             wallets.regen_hotkey(
                 wallet,
                 mnemonic,
                 seed,
-                json,
+                json_path,
                 json_password,
                 use_password,
                 overwrite,
@@ -3180,7 +3206,7 @@ class CLIManager:
         rate_tolerance: Optional[float] = Options.rate_tolerance,
         safe_staking: Optional[bool] = Options.safe_staking,
         allow_partial_stake: Optional[bool] = Options.allow_partial_stake,
-        era: int = Options.era,
+        period: int = Options.period,
         prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
@@ -3376,7 +3402,7 @@ class CLIManager:
                 rate_tolerance,
                 allow_partial_stake,
                 json_output,
-                era,
+                period,
             )
         )
 
@@ -3428,7 +3454,7 @@ class CLIManager:
         rate_tolerance: Optional[float] = Options.rate_tolerance,
         safe_staking: Optional[bool] = Options.safe_staking,
         allow_partial_stake: Optional[bool] = Options.allow_partial_stake,
-        era: int = Options.era,
+        period: int = Options.period,
         prompt: bool = Options.prompt,
         interactive: bool = typer.Option(
             False,
@@ -3621,7 +3647,7 @@ class CLIManager:
                     exclude_hotkeys=exclude_hotkeys,
                     prompt=prompt,
                     json_output=json_output,
-                    era=era,
+                    era=period,
                 )
             )
         elif (
@@ -3677,7 +3703,7 @@ class CLIManager:
                 rate_tolerance=rate_tolerance,
                 allow_partial_stake=allow_partial_stake,
                 json_output=json_output,
-                era=era,
+                era=period,
             )
         )
 
@@ -3705,7 +3731,7 @@ class CLIManager:
         stake_all: bool = typer.Option(
             False, "--stake-all", "--all", help="Stake all", prompt=False
         ),
-        era: int = Options.era,
+        period: int = Options.period,
         prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
@@ -3835,7 +3861,7 @@ class CLIManager:
                 destination_hotkey=destination_hotkey,
                 amount=amount,
                 stake_all=stake_all,
-                era=era,
+                era=period,
                 interactive_selection=interactive_selection,
                 prompt=prompt,
             )
@@ -3876,7 +3902,7 @@ class CLIManager:
         stake_all: bool = typer.Option(
             False, "--stake-all", "--all", help="Stake all", prompt=False
         ),
-        era: int = Options.era,
+        period: int = Options.period,
         prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
@@ -3998,7 +4024,7 @@ class CLIManager:
                 dest_netuid=dest_netuid,
                 dest_coldkey_ss58=dest_ss58,
                 amount=amount,
-                era=era,
+                era=period,
                 interactive_selection=interactive_selection,
                 stake_all=stake_all,
                 prompt=prompt,
@@ -4040,7 +4066,7 @@ class CLIManager:
             "--all",
             help="Swap all available stake",
         ),
-        era: int = Options.era,
+        period: int = Options.period,
         prompt: bool = Options.prompt,
         wait_for_inclusion: bool = Options.wait_for_inclusion,
         wait_for_finalization: bool = Options.wait_for_finalization,
@@ -4105,7 +4131,7 @@ class CLIManager:
                 destination_netuid=dest_netuid,
                 amount=amount,
                 swap_all=swap_all,
-                era=era,
+                era=period,
                 interactive_selection=interactive_selection,
                 prompt=prompt,
                 wait_for_inclusion=wait_for_inclusion,
@@ -4420,6 +4446,7 @@ class CLIManager:
         param_value: Optional[str] = typer.Option(
             "", "--value", help="Value to set the hyperparameter to."
         ),
+        prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
         json_output: bool = Options.json_output,
@@ -4444,6 +4471,11 @@ class CLIManager:
                 raise typer.Exit()
 
         if not param_name:
+            if not prompt:
+                err_console.print(
+                    "Param name not supplied with `--no-prompt` flag. Cannot continue"
+                )
+                return False
             hyperparam_list = [field.name for field in fields(SubnetHyperparameters)]
             console.print("Available hyperparameters:\n")
             for idx, param in enumerate(hyperparam_list, start=1):
@@ -4457,6 +4489,11 @@ class CLIManager:
             param_name = hyperparam_list[choice - 1]
 
         if param_name in ["alpha_high", "alpha_low"]:
+            if not prompt:
+                err_console.print(
+                    "`alpha_high` and `alpha_low` values cannot be set with `--no-prompt`"
+                )
+                return False
             param_name = "alpha_values"
             low_val = FloatPrompt.ask(
                 "Enter the new value for [dark_orange]alpha_low[/dark_orange]"
@@ -4467,6 +4504,11 @@ class CLIManager:
             param_value = f"{low_val},{high_val}"
 
         if not param_value:
+            if not prompt:
+                err_console.print(
+                    "Param value not supplied with `--no-prompt` flag. Cannot continue."
+                )
+                return False
             if HYPERPARAMS.get(param_name):
                 param_value = Prompt.ask(
                     f"Enter the new value for [{COLORS.G.SUBHEAD}]{param_name}[/{COLORS.G.SUBHEAD}] "
@@ -4485,6 +4527,7 @@ class CLIManager:
                 netuid,
                 param_name,
                 param_value,
+                prompt,
                 json_output,
             )
         )
@@ -4975,6 +5018,70 @@ class CLIManager:
             )
         )
 
+    def subnets_check_start(
+        self,
+        network: Optional[list[str]] = Options.network,
+        netuid: int = Options.netuid,
+        quiet: bool = Options.quiet,
+        verbose: bool = Options.verbose,
+    ):
+        """
+        Checks if a subnet's emission schedule can be started.
+
+        This command verifies if a subnet's emission schedule can be started based on the subnet's registration block.
+
+        Example:
+        [green]$[/green] btcli subnets check_start --netuid 1
+        """
+        self.verbosity_handler(quiet, verbose)
+        return self._run_command(
+            subnets.get_start_schedule(self.initialize_chain(network), netuid)
+        )
+
+    def subnets_start(
+        self,
+        wallet_name: str = Options.wallet_name,
+        wallet_path: str = Options.wallet_path,
+        wallet_hotkey: str = Options.wallet_hotkey,
+        network: Optional[list[str]] = Options.network,
+        netuid: int = Options.netuid,
+        prompt: bool = Options.prompt,
+        quiet: bool = Options.quiet,
+        verbose: bool = Options.verbose,
+    ):
+        """
+        Starts a subnet's emission schedule.
+
+        The owner of the subnet must call this command to start the emission schedule.
+
+        Example:
+        [green]$[/green] btcli subnets start --netuid 1
+        [green]$[/green] btcli subnets start --netuid 1 --wallet-name alice
+        """
+        self.verbosity_handler(quiet, verbose)
+        if not wallet_name:
+            wallet_name = Prompt.ask(
+                "Enter the [blue]wallet name[/blue] [dim](which you used to create the subnet)[/dim]",
+                default=self.config.get("wallet_name") or defaults.wallet.name,
+            )
+        wallet = self.wallet_ask(
+            wallet_name,
+            wallet_path,
+            wallet_hotkey,
+            ask_for=[
+                WO.NAME,
+            ],
+            validate=WV.WALLET,
+        )
+        return self._run_command(
+            subnets.start_subnet(
+                wallet,
+                self.initialize_chain(network),
+                netuid,
+                prompt,
+            )
+        )
+
     def subnets_get_identity(
         self,
         network: Optional[list[str]] = Options.network,
@@ -5184,10 +5291,12 @@ class CLIManager:
         wallet_hotkey: str = Options.wallet_hotkey,
         network: Optional[list[str]] = Options.network,
         netuid: int = Options.netuid,
-        era: Optional[
+        period: Optional[
             int
-        ] = typer.Option(  # Should not be Options.era bc this needs to be an Optional[int]
+        ] = typer.Option(  # Should not be Options.period bc this needs to be an Optional[int]
             None,
+            "--period",
+            "--era",
             help="Length (in blocks) for which the transaction should be valid. Note that it is possible that if you "
             "use an era for this transaction that you may pay a different fee to register than the one stated.",
         ),
@@ -5220,7 +5329,7 @@ class CLIManager:
                 wallet,
                 self.initialize_chain(network),
                 netuid,
-                era,
+                period,
                 json_output,
                 prompt,
             )