Additional CLI commands with JSON outputs

Author: thewhaleking

bittensor_cli/cli.py

@@ -4875,6 +4875,7 @@ def subnets_burn_cost(
         network: Optional[list[str]] = Options.network,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
+        json_output: bool = Options.json_output,
     ):
         """
         Shows the required amount of TAO to be recycled for creating a new subnet, i.e., cost of registering a new subnet.
@@ -4885,8 +4886,10 @@ def subnets_burn_cost(
 
         [green]$[/green] btcli subnets burn_cost
         """
-        self.verbosity_handler(quiet, verbose)
-        return self._run_command(subnets.burn_cost(self.initialize_chain(network)))
+        self.verbosity_handler(quiet, verbose, json_output)
+        return self._run_command(
+            subnets.burn_cost(self.initialize_chain(network), json_output)
+        )
 
     def subnets_create(
         self,
@@ -4919,6 +4922,7 @@ def subnets_create(
         additional_info: Optional[str] = typer.Option(
             None, "--additional-info", help="Additional information"
         ),
+        json_output: bool = Options.json_output,
         prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
@@ -4937,7 +4941,7 @@ def subnets_create(
         2. Create with GitHub repo and contact email:
         [green]$[/green] btcli subnets create --subnet-name MySubnet --github-repo https://github.com/myorg/mysubnet --subnet-contact [email protected]
         """
-        self.verbosity_handler(quiet, verbose)
+        self.verbosity_handler(quiet, verbose, json_output)
         wallet = self.wallet_ask(
             wallet_name,
             wallet_path,
@@ -4959,34 +4963,19 @@ def subnets_create(
             description=description,
             additional=additional_info,
         )
-        success = self._run_command(
-            subnets.create(wallet, self.initialize_chain(network), identity, prompt),
-            exit_early=False,
+        self._run_command(
+            subnets.create(
+                wallet, self.initialize_chain(network), identity, json_output, prompt
+            )
         )
 
-        if success and prompt:
-            set_id = Confirm.ask(
-                "[dark_sea_green3]Do you want to set/update your identity?",
-                default=False,
-                show_default=True,
-            )
-            if set_id:
-                self.wallet_set_id(
-                    wallet_name=wallet.name,
-                    wallet_hotkey=wallet.hotkey,
-                    wallet_path=wallet.path,
-                    network=network,
-                    prompt=prompt,
-                    quiet=quiet,
-                    verbose=verbose,
-                )
-
     def subnets_get_identity(
         self,
         network: Optional[list[str]] = Options.network,
         netuid: int = Options.netuid,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
+        json_output: bool = Options.json_output,
     ):
         """
         Get the identity information for a subnet.
@@ -4995,11 +4984,10 @@ def subnets_get_identity(
 
         [green]$[/green] btcli subnets get-identity --netuid 1
         """
-        self.verbosity_handler(quiet, verbose)
+        self.verbosity_handler(quiet, verbose, json_output)
         return self._run_command(
             subnets.get_identity(
-                self.initialize_chain(network),
-                netuid,
+                self.initialize_chain(network), netuid, json_output=json_output
             )
         )
 
@@ -5035,6 +5023,7 @@ def subnets_set_identity(
         additional_info: Optional[str] = typer.Option(
             None, "--additional-info", help="Additional information"
         ),
+        json_output: bool = Options.json_output,
         prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
@@ -5052,7 +5041,7 @@ def subnets_set_identity(
         2. Set subnet identity with specific values:
         [green]$[/green] btcli subnets set-identity --netuid 1 --subnet-name MySubnet --github-repo https://github.com/myorg/mysubnet --subnet-contact [email protected]
         """
-        self.verbosity_handler(quiet, verbose)
+        self.verbosity_handler(quiet, verbose, json_output)
         wallet = self.wallet_ask(
             wallet_name,
             wallet_path,
@@ -5070,7 +5059,9 @@ def subnets_set_identity(
             exit_early=False,
         )
         if current_identity is None:
-            raise typer.Exit()
+            if json_output:
+                json_console.print('{"success": false}')
+            return
 
         identity = prompt_for_subnet_identity(
             current_identity=current_identity,
@@ -5083,15 +5074,13 @@ def subnets_set_identity(
             additional=additional_info,
         )
 
-        return self._run_command(
+        success = self._run_command(
             subnets.set_identity(
-                wallet,
-                self.initialize_chain(network),
-                netuid,
-                identity,
-                prompt,
+                wallet, self.initialize_chain(network), netuid, identity, prompt
             )
         )
+        if json_output:
+            json_console.print(json.dumps({"success": success}))
 
     def subnets_pow_register(
         self,
@@ -5196,6 +5185,7 @@ def subnets_register(
             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.",
         ),
+        json_output: bool = Options.json_output,
         prompt: bool = Options.prompt,
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
@@ -5211,7 +5201,7 @@ def subnets_register(
 
         [green]$[/green] btcli subnets register --netuid 1
         """
-        self.verbosity_handler(quiet, verbose)
+        self.verbosity_handler(quiet, verbose, json_output)
         wallet = self.wallet_ask(
             wallet_name,
             wallet_path,
@@ -5225,6 +5215,7 @@ def subnets_register(
                 self.initialize_chain(network),
                 netuid,
                 era,
+                json_output,
                 prompt,
             )
         )

bittensor_cli/src/bittensor/extrinsics/registration.py

@@ -678,7 +678,7 @@ async def burned_register_extrinsic(
     wait_for_finalization: bool = True,
     era: Optional[int] = None,
     prompt: bool = False,
-) -> bool:
+) -> tuple[bool, str]:
     """Registers the wallet to chain by recycling TAO.
 
     :param subtensor: The SubtensorInterface object to use for the call, initialized
@@ -691,8 +691,8 @@ async def burned_register_extrinsic(
                                   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`.
+    :return: (success, msg), where success is `True` if extrinsic was finalized or included in the block. If we did not
+        wait for finalization/inclusion, the response is `True`.
     """
 
     if not (unlock_status := unlock_key(wallet, print_out=False)).success:
@@ -740,7 +740,7 @@ async def burned_register_extrinsic(
             f"hotkey: [{COLOR_PALETTE['GENERAL']['HOTKEY']}]{neuron.hotkey}[/{COLOR_PALETTE['GENERAL']['HOTKEY']}]\n"
             f"coldkey: [{COLOR_PALETTE['GENERAL']['COLDKEY']}]{neuron.coldkey}[/{COLOR_PALETTE['GENERAL']['COLDKEY']}]"
         )
-        return True
+        return True, "Already registered"
 
     with console.status(
         ":satellite: Recycling TAO for Registration...", spinner="aesthetic"
@@ -760,7 +760,7 @@ async def burned_register_extrinsic(
     if not success:
         err_console.print(f":cross_mark: [red]Failed[/red]: {err_msg}")
         await asyncio.sleep(0.5)
-        return False
+        return False, err_msg
     # Successful registration, final check for neuron and pubkey
     else:
         with console.status(":satellite: Checking Balance...", spinner="aesthetic"):
@@ -788,13 +788,13 @@ async def burned_register_extrinsic(
             console.print(
                 f":white_heavy_check_mark: [green]Registered on netuid {netuid} with UID {my_uid}[/green]"
             )
-            return True
+            return True, f"Registered on {netuid} with UID {my_uid}"
         else:
             # neuron not found, try again
             err_console.print(
                 ":cross_mark: [red]Unknown error. Neuron not found.[/red]"
             )
-            return False
+            return False, "Unknown error. Neuron not found."
 
 
 async def run_faucet_extrinsic(

bittensor_cli/src/bittensor/extrinsics/root.py

@@ -291,7 +291,7 @@ async def root_register_extrinsic(
     wait_for_inclusion: bool = True,
     wait_for_finalization: bool = True,
     prompt: bool = False,
-) -> bool:
+) -> tuple[bool, str]:
     r"""Registers the wallet to root network.
 
     :param subtensor: The SubtensorInterface object
@@ -302,12 +302,12 @@ async def root_register_extrinsic(
                                   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: `True` if extrinsic was finalized or included in the block. If we did not wait for finalization/inclusion,
-             the response is `True`.
+    :return: (success, msg), with success being `True` if extrinsic was finalized or included in the block. If we did
+        not wait for finalization/inclusion, the response is `True`.
     """
 
-    if not unlock_key(wallet).success:
-        return False
+    if not (unlock := unlock_key(wallet)).success:
+        return False, unlock.message
 
     print_verbose(f"Checking if hotkey ({wallet.hotkey_str}) is registered on root")
     is_registered = await is_hotkey_registered(
@@ -317,7 +317,7 @@ async def root_register_extrinsic(
         console.print(
             ":white_heavy_check_mark: [green]Already registered on root network.[/green]"
         )
-        return True
+        return True, "Already registered on root network"
 
     with console.status(":satellite: Registering to root network...", spinner="earth"):
         call = await subtensor.substrate.compose_call(
@@ -334,8 +334,8 @@ async def root_register_extrinsic(
 
         if not success:
             err_console.print(f":cross_mark: [red]Failed[/red]: {err_msg}")
-            time.sleep(0.5)
-            return False
+            await asyncio.sleep(0.5)
+            return False, err_msg
 
         # Successful registration, final check for neuron and pubkey
         else:
@@ -348,13 +348,13 @@ async def root_register_extrinsic(
                 console.print(
                     f":white_heavy_check_mark: [green]Registered with UID {uid}[/green]"
                 )
-                return True
+                return True, f"Registered with UID {uid}"
             else:
                 # neuron not found, try again
                 err_console.print(
                     ":cross_mark: [red]Unknown error. Neuron not found.[/red]"
                 )
-                return False
+                return False, "Unknown error. Neuron not found."
 
 
 async def set_root_weights_extrinsic(