Subnets list

Author: thewhaleking

bittensor_cli/cli.py

@@ -4441,6 +4441,7 @@ def subnets_list(
         quiet: bool = Options.quiet,
         verbose: bool = Options.verbose,
         live_mode: bool = Options.live,
+        json_output: bool = Options.json_output,
     ):
         """
          List all subnets and their detailed information.
@@ -4468,7 +4469,10 @@ def subnets_list(
 
          [green]$[/green] btcli subnets list
         """
-        self.verbosity_handler(quiet, verbose)
+        if json_output and live_mode:
+            print_error("Cannot use --json-output and --live at the same time.")
+            return
+        self.verbosity_handler(quiet, verbose, json_output)
         subtensor = self.initialize_chain(network)
         return self._run_command(
             subnets.subnets_list(
@@ -4478,6 +4482,7 @@ def subnets_list(
                 not self.config.get("use_cache", True),
                 verbose,
                 live_mode,
+                json_output,
             )
         )
 

bittensor_cli/src/commands/subnets/subnets.py

@@ -34,6 +34,7 @@
     prompt_for_identity,
     get_subnet_name,
     unlock_key,
+    json_console,
 )
 
 if TYPE_CHECKING:
@@ -206,40 +207,41 @@ async def subnets_list(
     no_cache: bool,
     verbose: bool,
     live: bool,
+    json_output: bool,
 ):
     """List all subnet netuids in the network."""
 
     async def fetch_subnet_data():
-        block_number = await subtensor.substrate.get_block_number(None)
-        subnets = await subtensor.all_subnets()
+        block_number_ = await subtensor.substrate.get_block_number(None)
+        subnets_ = await subtensor.all_subnets()
 
         # Sort subnets by market cap, keeping the root subnet in the first position
-        root_subnet = next(s for s in subnets if s.netuid == 0)
+        root_subnet = next(s for s in subnets_ if s.netuid == 0)
         other_subnets = sorted(
-            [s for s in subnets if s.netuid != 0],
+            [s for s in subnets_ if s.netuid != 0],
             key=lambda x: (x.alpha_in.tao + x.alpha_out.tao) * x.price.tao,
             reverse=True,
         )
         sorted_subnets = [root_subnet] + other_subnets
-        return sorted_subnets, block_number
+        return sorted_subnets, block_number_
 
     def calculate_emission_stats(
-        subnets: list, block_number: int
+        subnets_: list, block_number_: int
     ) -> tuple[Balance, str]:
         # We do not include the root subnet in the emission calculation
         total_tao_emitted = sum(
-            subnet.tao_in.tao for subnet in subnets if subnet.netuid != 0
+            subnet.tao_in.tao for subnet in subnets_ if subnet.netuid != 0
         )
-        emission_percentage = (total_tao_emitted / block_number) * 100
+        emission_percentage = (total_tao_emitted / block_number_) * 100
         percentage_color = "dark_sea_green" if emission_percentage < 100 else "red"
         formatted_percentage = (
             f"[{percentage_color}]{emission_percentage:.2f}%[/{percentage_color}]"
         )
         if not verbose:
-            percentage_string = f"τ {millify_tao(total_tao_emitted)}/{millify_tao(block_number)} ({formatted_percentage})"
+            percentage_string = f"τ {millify_tao(total_tao_emitted)}/{millify_tao(block_number_)} ({formatted_percentage})"
         else:
             percentage_string = (
-                f"τ {total_tao_emitted:.1f}/{block_number} ({formatted_percentage})"
+                f"τ {total_tao_emitted:.1f}/{block_number_} ({formatted_percentage})"
             )
         return total_tao_emitted, percentage_string
 
@@ -249,7 +251,7 @@ def define_table(
         total_netuids: int,
         tao_emission_percentage: str,
     ):
-        table = Table(
+        defined_table = Table(
             title=f"\n[{COLOR_PALETTE['GENERAL']['HEADER']}]Subnets"
             f"\nNetwork: [{COLOR_PALETTE['GENERAL']['SUBHEADING']}]{subtensor.network}\n\n",
             show_footer=True,
@@ -262,61 +264,61 @@ def define_table(
             pad_edge=True,
         )
 
-        table.add_column(
+        defined_table.add_column(
             "[bold white]Netuid",
             style="grey89",
             justify="center",
             footer=str(total_netuids),
         )
-        table.add_column("[bold white]Name", style="cyan", justify="left")
-        table.add_column(
+        defined_table.add_column("[bold white]Name", style="cyan", justify="left")
+        defined_table.add_column(
             f"[bold white]Price \n({Balance.get_unit(0)}_in/{Balance.get_unit(1)}_in)",
             style="dark_sea_green2",
             justify="left",
             footer=f"τ {total_rate}",
         )
-        table.add_column(
+        defined_table.add_column(
             f"[bold white]Market Cap \n({Balance.get_unit(1)} * Price)",
             style="steel_blue3",
             justify="left",
         )
-        table.add_column(
+        defined_table.add_column(
             f"[bold white]Emission ({Balance.get_unit(0)})",
             style=COLOR_PALETTE["POOLS"]["EMISSION"],
             justify="left",
             footer=f"τ {total_emissions}",
         )
-        table.add_column(
+        defined_table.add_column(
             f"[bold white]P ({Balance.get_unit(0)}_in, {Balance.get_unit(1)}_in)",
             style=COLOR_PALETTE["STAKE"]["TAO"],
             justify="left",
             footer=f"{tao_emission_percentage}",
         )
-        table.add_column(
+        defined_table.add_column(
             f"[bold white]Stake ({Balance.get_unit(1)}_out)",
             style=COLOR_PALETTE["STAKE"]["STAKE_ALPHA"],
             justify="left",
         )
-        table.add_column(
+        defined_table.add_column(
             f"[bold white]Supply ({Balance.get_unit(1)})",
             style=COLOR_PALETTE["POOLS"]["ALPHA_IN"],
             justify="left",
         )
 
-        table.add_column(
+        defined_table.add_column(
             "[bold white]Tempo (k/n)",
             style=COLOR_PALETTE["GENERAL"]["TEMPO"],
             justify="left",
             overflow="fold",
         )
-        return table
+        return defined_table
 
     # Non-live mode
-    def create_table(subnets, block_number):
+    def _create_table(subnets_, block_number_):
         rows = []
-        _, percentage_string = calculate_emission_stats(subnets, block_number)
+        _, percentage_string = calculate_emission_stats(subnets_, block_number_)
 
-        for subnet in subnets:
+        for subnet in subnets_:
             netuid = subnet.netuid
             symbol = f"{subnet.symbol}\u200e"
 
@@ -363,7 +365,7 @@ def create_table(subnets, block_number):
             # Prepare cells
             netuid_cell = str(netuid)
             subnet_name_cell = (
-                f"[{COLOR_PALETTE['GENERAL']['SYMBOL']}]{subnet.symbol if netuid != 0 else 'τ'}[/{COLOR_PALETTE['GENERAL']['SYMBOL']}]"
+                f"[{COLOR_PALETTE.G.SYM}]{subnet.symbol if netuid != 0 else 'τ'}[/{COLOR_PALETTE.G.SYM}]"
                 f" {get_subnet_name(subnet)}"
             )
             emission_cell = f"τ {emission_tao:,.4f}"
@@ -396,23 +398,76 @@ def create_table(subnets, block_number):
             )
 
         total_emissions = round(
-            sum(subnet.tao_in_emission.tao for subnet in subnets if subnet.netuid != 0),
+            sum(
+                subnet.tao_in_emission.tao for subnet in subnets_ if subnet.netuid != 0
+            ),
             4,
         )
         total_rate = round(
-            sum(float(subnet.price.tao) for subnet in subnets if subnet.netuid != 0), 4
+            sum(float(subnet.price.tao) for subnet in subnets_ if subnet.netuid != 0), 4
         )
-        total_netuids = len(subnets)
-        table = define_table(
+        total_netuids = len(subnets_)
+        defined_table = define_table(
             total_emissions, total_rate, total_netuids, percentage_string
         )
 
         for row in rows:
-            table.add_row(*row)
-        return table
+            defined_table.add_row(*row)
+        return defined_table
+
+    def dict_table(subnets_, block_number_) -> dict:
+        subnet_rows = {}
+        total_tao_emitted, _ = calculate_emission_stats(subnets_, block_number_)
+        total_emissions = 0.0
+        total_rate = 0.0
+        total_netuids = len(subnets_)
+        emission_percentage = (total_tao_emitted / block_number_) * 100
+        for subnet in subnets_:
+            total_emissions += subnet.tao_in_emission.tao
+            total_rate += subnet.price.tao
+            netuid = subnet.netuid
+            if netuid == 0:
+                emission_tao = 0.0
+            else:
+                emission_tao = subnet.tao_in_emission.tao
+            alpha_in_value = subnet.alpha_in.tao
+            alpha_out_value = subnet.alpha_out.tao
+            price_value = subnet.price.tao
+            market_cap = (subnet.alpha_in.tao + subnet.alpha_out.tao) * subnet.price.tao
+            tao_in = subnet.tao_in.tao if netuid != 0 else None
+            alpha_in = alpha_in_value if netuid != 0 else None
+            alpha_out = alpha_out_value if netuid != 0 else None
+            supply = subnet.alpha_in.tao + subnet.alpha_out.tao
+            subnet_name = get_subnet_name(subnet)
+            tempo = {
+                "blocks_since_last_step": (
+                    subnet.blocks_since_last_step if netuid != 0 else None
+                ),
+                "sn_tempo": (subnet.tempo if netuid != 0 else None),
+            }
+            subnet_rows[netuid] = {
+                "netuid": netuid,
+                "subnet_name": subnet_name,
+                "price": price_value,
+                "market_cap": market_cap,
+                "emission": emission_tao,
+                "liquidity": {"tao_in": tao_in, "alpha_in": alpha_in},
+                "alpha_out": alpha_out,
+                "supply": supply,
+                "tempo": tempo,
+            }
+        output = {
+            "total_tao_emitted": total_tao_emitted,
+            "total_emissions": total_emissions,
+            "total_rate": total_rate,
+            "total_netuids": total_netuids,
+            "emission_percentage": emission_percentage,
+            "subnets": subnet_rows,
+        }
+        return output
 
     # Live mode
-    def create_table_live(subnets, previous_data, block_number):
+    def create_table_live(subnets_, previous_data_, block_number_):
         def format_cell(
             value, previous_value, unit="", unit_first=False, precision=4, millify=False
         ):
@@ -516,9 +571,9 @@ def format_liquidity_cell(
 
         rows = []
         current_data = {}  # To store current values for comparison in the next update
-        _, percentage_string = calculate_emission_stats(subnets, block_number)
+        _, percentage_string = calculate_emission_stats(subnets_, block_number_)
 
-        for subnet in subnets:
+        for subnet in subnets_:
             netuid = subnet.netuid
             symbol = f"{subnet.symbol}\u200e"
 
@@ -541,7 +596,7 @@ def format_liquidity_cell(
                 "supply": supply,
                 "blocks_since_last_step": subnet.blocks_since_last_step,
             }
-            prev = previous_data.get(netuid, {}) if previous_data else {}
+            prev = previous_data_.get(netuid, {}) if previous_data_ else {}
 
             # Prepare cells
             if netuid == 0:
@@ -652,17 +707,17 @@ def format_liquidity_cell(
             )
 
         # Calculate totals
-        total_netuids = len(subnets)
+        total_netuids = len(subnets_)
         _total_emissions = sum(
-            subnet.tao_in_emission.tao for subnet in subnets if subnet.netuid != 0
+            subnet.tao_in_emission.tao for subnet in subnets_ if subnet.netuid != 0
         )
         total_emissions = (
             f"{millify_tao(_total_emissions)}"
             if not verbose
             else f"{_total_emissions:,.2f}"
         )
 
-        total_rate = sum(subnet.price.tao for subnet in subnets if subnet.netuid != 0)
+        total_rate = sum(subnet.price.tao for subnet in subnets_ if subnet.netuid != 0)
         total_rate = (
             f"{millify_tao(total_rate)}" if not verbose else f"{total_rate:,.2f}"
         )
@@ -733,8 +788,11 @@ def format_liquidity_cell(
     else:
         # Non-live mode
         subnets, block_number = await fetch_subnet_data()
-        table = create_table(subnets, block_number)
-        console.print(table)
+        if json_output:
+            json_console.print(json.dumps(dict_table(subnets, block_number)))
+        else:
+            table = _create_table(subnets, block_number)
+            console.print(table)
 
         return
         # TODO: Temporarily returning till we update docs