bittensor-cli 9.7.1__tar.gz → 9.8.1__tar.gz

{bittensor_cli-9.7.1 → bittensor_cli-9.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bittensor-cli
-Version: 9.7.1
+Version: 9.8.1
 Summary: Bittensor CLI
 Author: bittensor.com
 Project-URL: homepage, https://github.com/opentensor/btcli

{bittensor_cli-9.7.1 → bittensor_cli-9.8.1}/bittensor_cli/cli.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 import asyncio
-import curses
 import copy
+import curses
 import importlib
 import json
 import os.path
@@ -10,13 +10,13 @@ import ssl
 import sys
 import traceback
 import warnings
+from dataclasses import fields
 from pathlib import Path
 from typing import Coroutine, Optional, Union
-from dataclasses import fields
 
+import numpy as np
 import rich
 import typer
-import numpy as np
 from async_substrate_interface.errors import (
     SubstrateRequestException,
     ConnectionClosed,
@@ -39,21 +39,10 @@ from bittensor_cli.src import (
     COLORS,
     HYPERPARAMS,
 )
-from bittensor_cli.version import __version__, __version_as_int__
 from bittensor_cli.src.bittensor import utils
 from bittensor_cli.src.bittensor.balances import Balance
-from bittensor_cli.src.commands import sudo, wallets, view
-from bittensor_cli.src.commands import weights as weights_cmds
-from bittensor_cli.src.commands.subnets import price, subnets
-from bittensor_cli.src.commands.stake import (
-    children_hotkeys,
-    list as list_stake,
-    move as move_stake,
-    add as add_stake,
-    remove as remove_stake,
-)
-from bittensor_cli.src.bittensor.subtensor_interface import SubtensorInterface
 from bittensor_cli.src.bittensor.chain_data import SubnetHyperparameters
+from bittensor_cli.src.bittensor.subtensor_interface import SubtensorInterface
 from bittensor_cli.src.bittensor.utils import (
     console,
     err_console,
@@ -70,6 +59,22 @@ from bittensor_cli.src.bittensor.utils import (
     prompt_for_subnet_identity,
     validate_rate_tolerance,
 )
+from bittensor_cli.src.commands import sudo, wallets, view
+from bittensor_cli.src.commands import weights as weights_cmds
+from bittensor_cli.src.commands.liquidity import liquidity
+from bittensor_cli.src.commands.liquidity.utils import (
+    prompt_liquidity,
+    prompt_position_id,
+)
+from bittensor_cli.src.commands.stake import (
+    children_hotkeys,
+    list as list_stake,
+    move as move_stake,
+    add as add_stake,
+    remove as remove_stake,
+)
+from bittensor_cli.src.commands.subnets import price, subnets
+from bittensor_cli.version import __version__, __version_as_int__
 
 try:
     from git import Repo, GitError
@@ -656,6 +661,7 @@ class CLIManager:
         self.subnets_app = typer.Typer(epilog=_epilog)
         self.weights_app = typer.Typer(epilog=_epilog)
         self.view_app = typer.Typer(epilog=_epilog)
+        self.liquidity_app = typer.Typer(epilog=_epilog)
 
         # config alias
         self.app.add_typer(
@@ -929,11 +935,13 @@ class CLIManager:
         )(self.view_dashboard)
 
         # Sub command aliases
-        # Weights
+        # Wallet
         self.wallet_app.command(
             "swap_hotkey",
             hidden=True,
         )(self.wallet_swap_hotkey)
+        self.wallet_app.command("swap_coldkey", hidden=True)(self.wallet_swap_coldkey)
+        self.wallet_app.command("swap_check", hidden=True)(self.wallet_check_ck_swap)
         self.wallet_app.command(
             "regen_coldkey",
             hidden=True,
@@ -962,16 +970,44 @@ class CLIManager:
             "get_identity",
             hidden=True,
         )(self.wallet_get_id)
+        self.wallet_app.command("associate_hotkey")(self.wallet_associate_hotkey)
 
         # Subnets
         self.subnets_app.command("burn_cost", hidden=True)(self.subnets_burn_cost)
         self.subnets_app.command("pow_register", hidden=True)(self.subnets_pow_register)
+        self.subnets_app.command("set_identity", hidden=True)(self.subnets_set_identity)
+        self.subnets_app.command("get_identity", hidden=True)(self.subnets_get_identity)
+        self.subnets_app.command("check_start", hidden=True)(self.subnets_check_start)
 
         # Sudo
         self.sudo_app.command("senate_vote", hidden=True)(self.sudo_senate_vote)
         self.sudo_app.command("get_take", hidden=True)(self.sudo_get_take)
         self.sudo_app.command("set_take", hidden=True)(self.sudo_set_take)
 
+        # Liquidity
+        self.app.add_typer(
+            self.liquidity_app,
+            name="liquidity",
+            short_help="liquidity commands, aliases: `l`",
+            no_args_is_help=True,
+        )
+        self.app.add_typer(
+            self.liquidity_app, name="l", hidden=True, no_args_is_help=True
+        )
+        # liquidity commands
+        self.liquidity_app.command(
+            "add", rich_help_panel=HELP_PANELS["LIQUIDITY"]["LIQUIDITY_MGMT"]
+        )(self.liquidity_add)
+        self.liquidity_app.command(
+            "list", rich_help_panel=HELP_PANELS["LIQUIDITY"]["LIQUIDITY_MGMT"]
+        )(self.liquidity_list)
+        self.liquidity_app.command(
+            "modify", rich_help_panel=HELP_PANELS["LIQUIDITY"]["LIQUIDITY_MGMT"]
+        )(self.liquidity_modify)
+        self.liquidity_app.command(
+            "remove", rich_help_panel=HELP_PANELS["LIQUIDITY"]["LIQUIDITY_MGMT"]
+        )(self.liquidity_remove)
+
     def generate_command_tree(self) -> Tree:
         """
         Generates a rich.Tree of the commands, subcommands, and groups of this app
@@ -1603,7 +1639,8 @@ class CLIManager:
         wallet_hotkey: Optional[str],
         ask_for: Optional[list[str]] = None,
         validate: WV = WV.WALLET,
-    ) -> Wallet:
+        return_wallet_and_hotkey: bool = False,
+    ) -> Union[Wallet, tuple[Wallet, str]]:
         """
         Generates a wallet object based on supplied values, validating the wallet is valid if flag is set
         :param wallet_name: name of the wallet
@@ -1611,7 +1648,8 @@ class CLIManager:
         :param wallet_hotkey: name of the wallet hotkey file
         :param validate: flag whether to check for the wallet's validity
         :param ask_for: aspect of the wallet (name, path, hotkey) to prompt the user for
-        :return: created Wallet object
+        :param return_wallet_and_hotkey: if specified, will return both the wallet object, and the hotkey SS58
+        :return: created Wallet object (or wallet, hotkey ss58)
         """
         ask_for = ask_for or []
         # Prompt for missing attributes specified in ask_for
@@ -1636,8 +1674,9 @@ class CLIManager:
                 )
             else:
                 wallet_hotkey = Prompt.ask(
-                    "Enter the [blue]wallet hotkey[/blue]"
-                    + " [dark_sea_green3 italic](Hint: You can set this with `btcli config set --wallet-hotkey`)[/dark_sea_green3 italic]",
+                    "Enter the [blue]wallet hotkey[/blue][dark_sea_green3 italic]"
+                    "(Hint: You can set this with `btcli config set --wallet-hotkey`)"
+                    "[/dark_sea_green3 italic]",
                     default=defaults.wallet.hotkey,
                 )
         if wallet_path:
@@ -1655,7 +1694,8 @@ class CLIManager:
         if WO.PATH in ask_for and not wallet_path:
             wallet_path = Prompt.ask(
                 "Enter the [blue]wallet path[/blue]"
-                + " [dark_sea_green3 italic](Hint: You can set this with `btcli config set --wallet-path`)[/dark_sea_green3 italic]",
+                "[dark_sea_green3 italic](Hint: You can set this with `btcli config set --wallet-path`)"
+                "[/dark_sea_green3 italic]",
                 default=defaults.wallet.path,
             )
         # Create the Wallet object
@@ -1679,7 +1719,28 @@ class CLIManager:
                     f"Please verify your wallet information: {wallet}[/red]"
                 )
                 raise typer.Exit()
-        return wallet
+        if return_wallet_and_hotkey:
+            valid = utils.is_valid_wallet(wallet)
+            if valid[1]:
+                return wallet, wallet.hotkey.ss58_address
+            else:
+                if wallet_hotkey and is_valid_ss58_address(wallet_hotkey):
+                    return wallet, wallet_hotkey
+                else:
+                    hotkey = (
+                        Prompt.ask(
+                            "Enter the SS58 of the hotkey to use for this transaction."
+                        )
+                    ).strip()
+                    if not is_valid_ss58_address(hotkey):
+                        err_console.print(
+                            f"[red]Error: {hotkey} is not valid SS58 address."
+                        )
+                        raise typer.Exit(1)
+                    else:
+                        return wallet, hotkey
+        else:
+            return wallet
 
     def wallet_list(
         self,
@@ -3291,7 +3352,7 @@ class CLIManager:
             )
         else:
             netuid_ = get_optional_netuid(None, all_netuids)
-            netuids = [netuid_] if netuid_ else None
+            netuids = [netuid_] if netuid_ is not None else None
         if netuids:
             for netuid_ in netuids:
                 # ensure no negative netuids make it into our list
@@ -5025,6 +5086,7 @@ class CLIManager:
         description: Optional[str] = typer.Option(
             None, "--description", help="Description"
         ),
+        logo_url: Optional[str] = typer.Option(None, "--logo-url", help="Logo URL"),
         additional_info: Optional[str] = typer.Option(
             None, "--additional-info", help="Additional information"
         ),
@@ -5067,6 +5129,7 @@ class CLIManager:
             subnet_url=subnet_url,
             discord=discord,
             description=description,
+            logo_url=logo_url,
             additional=additional_info,
         )
         self._run_command(
@@ -5088,7 +5151,7 @@ class CLIManager:
         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
+        [green]$[/green] btcli subnets check-start --netuid 1
         """
         self.verbosity_handler(quiet, verbose)
         return self._run_command(
@@ -5190,6 +5253,7 @@ class CLIManager:
         description: Optional[str] = typer.Option(
             None, "--description", help="Description"
         ),
+        logo_url: Optional[str] = typer.Option(None, "--logo-url", help="Logo URL"),
         additional_info: Optional[str] = typer.Option(
             None, "--additional-info", help="Additional information"
         ),
@@ -5241,6 +5305,7 @@ class CLIManager:
             subnet_url=subnet_url,
             discord=discord,
             description=description,
+            logo_url=logo_url,
             additional=additional_info,
         )
 
@@ -5752,6 +5817,257 @@ class CLIManager:
             )
         )
 
+    def liquidity_add(
+        self,
+        network: Optional[list[str]] = Options.network,
+        wallet_name: str = Options.wallet_name,
+        wallet_path: str = Options.wallet_path,
+        wallet_hotkey: str = Options.wallet_hotkey,
+        netuid: Optional[int] = Options.netuid,
+        liquidity_: Optional[float] = typer.Option(
+            None,
+            "--liquidity",
+            help="Amount of liquidity to add to the subnet.",
+        ),
+        price_low: Optional[float] = typer.Option(
+            None,
+            "--price-low",
+            "--price_low",
+            "--liquidity-price-low",
+            "--liquidity_price_low",
+            help="Low price for the adding liquidity position.",
+        ),
+        price_high: Optional[float] = typer.Option(
+            None,
+            "--price-high",
+            "--price_high",
+            "--liquidity-price-high",
+            "--liquidity_price_high",
+            help="High price for the adding liquidity position.",
+        ),
+        prompt: bool = Options.prompt,
+        quiet: bool = Options.quiet,
+        verbose: bool = Options.verbose,
+        json_output: bool = Options.json_output,
+    ):
+        """Add liquidity to the swap (as a combination of TAO + Alpha)."""
+        self.verbosity_handler(quiet, verbose, json_output)
+        if not netuid:
+            netuid = Prompt.ask(
+                f"Enter the [{COLORS.G.SUBHEAD_MAIN}]netuid[/{COLORS.G.SUBHEAD_MAIN}] to use",
+                default=None,
+                show_default=False,
+            )
+
+        wallet, hotkey = self.wallet_ask(
+            wallet_name=wallet_name,
+            wallet_path=wallet_path,
+            wallet_hotkey=wallet_hotkey,
+            ask_for=[WO.NAME, WO.HOTKEY, WO.PATH],
+            validate=WV.WALLET,
+            return_wallet_and_hotkey=True,
+        )
+        # Determine the liquidity amount.
+        if liquidity_:
+            liquidity_ = Balance.from_tao(liquidity_)
+        else:
+            liquidity_ = prompt_liquidity("Enter the amount of liquidity")
+
+        # Determine price range
+        if price_low:
+            price_low = Balance.from_tao(price_low)
+        else:
+            price_low = prompt_liquidity("Enter liquidity position low price")
+
+        if price_high:
+            price_high = Balance.from_tao(price_high)
+        else:
+            price_high = prompt_liquidity(
+                "Enter liquidity position high price (must be greater than low price)"
+            )
+
+        if price_low >= price_high:
+            err_console.print("The low price must be lower than the high price.")
+            return False
+
+        return self._run_command(
+            liquidity.add_liquidity(
+                subtensor=self.initialize_chain(network),
+                wallet=wallet,
+                hotkey_ss58=hotkey,
+                netuid=netuid,
+                liquidity=liquidity_,
+                price_low=price_low,
+                price_high=price_high,
+                prompt=prompt,
+                json_output=json_output,
+            )
+        )
+
+    def liquidity_list(
+        self,
+        network: Optional[list[str]] = Options.network,
+        wallet_name: str = Options.wallet_name,
+        wallet_path: str = Options.wallet_path,
+        wallet_hotkey: str = Options.wallet_hotkey,
+        netuid: Optional[int] = Options.netuid,
+        quiet: bool = Options.quiet,
+        verbose: bool = Options.verbose,
+        json_output: bool = Options.json_output,
+    ):
+        """Displays liquidity positions in given subnet."""
+        self.verbosity_handler(quiet, verbose, json_output)
+        if not netuid:
+            netuid = IntPrompt.ask(
+                f"Enter the [{COLORS.G.SUBHEAD_MAIN}]netuid[/{COLORS.G.SUBHEAD_MAIN}] to use",
+                default=None,
+                show_default=False,
+            )
+
+        wallet = self.wallet_ask(
+            wallet_name=wallet_name,
+            wallet_path=wallet_path,
+            wallet_hotkey=wallet_hotkey,
+            ask_for=[WO.NAME, WO.PATH],
+            validate=WV.WALLET,
+        )
+        self._run_command(
+            liquidity.show_liquidity_list(
+                subtensor=self.initialize_chain(network),
+                wallet=wallet,
+                netuid=netuid,
+                json_output=json_output,
+            )
+        )
+
+    def liquidity_remove(
+        self,
+        network: Optional[list[str]] = Options.network,
+        wallet_name: str = Options.wallet_name,
+        wallet_path: str = Options.wallet_path,
+        wallet_hotkey: str = Options.wallet_hotkey,
+        netuid: Optional[int] = Options.netuid,
+        position_id: Optional[int] = typer.Option(
+            None,
+            "--position-id",
+            "--position_id",
+            help="Position ID for modification or removal.",
+        ),
+        all_liquidity_ids: Optional[bool] = typer.Option(
+            False,
+            "--all",
+            "--a",
+            help="Whether to remove all liquidity positions for given subnet.",
+        ),
+        prompt: bool = Options.prompt,
+        quiet: bool = Options.quiet,
+        verbose: bool = Options.verbose,
+        json_output: bool = Options.json_output,
+    ):
+        """Remove liquidity from the swap (as a combination of TAO + Alpha)."""
+
+        self.verbosity_handler(quiet, verbose, json_output)
+
+        if all_liquidity_ids and position_id:
+            print_error("Cannot specify both --all and --position-id.")
+            return
+
+        if not position_id and not all_liquidity_ids:
+            position_id = prompt_position_id()
+
+        if not netuid:
+            netuid = IntPrompt.ask(
+                f"Enter the [{COLORS.G.SUBHEAD_MAIN}]netuid[/{COLORS.G.SUBHEAD_MAIN}] to use",
+                default=None,
+                show_default=False,
+            )
+
+        wallet, hotkey = self.wallet_ask(
+            wallet_name=wallet_name,
+            wallet_path=wallet_path,
+            wallet_hotkey=wallet_hotkey,
+            ask_for=[WO.NAME, WO.HOTKEY, WO.PATH],
+            validate=WV.WALLET,
+            return_wallet_and_hotkey=True,
+        )
+        return self._run_command(
+            liquidity.remove_liquidity(
+                subtensor=self.initialize_chain(network),
+                wallet=wallet,
+                hotkey_ss58=hotkey,
+                netuid=netuid,
+                position_id=position_id,
+                prompt=prompt,
+                all_liquidity_ids=all_liquidity_ids,
+                json_output=json_output,
+            )
+        )
+
+    def liquidity_modify(
+        self,
+        network: Optional[list[str]] = Options.network,
+        wallet_name: str = Options.wallet_name,
+        wallet_path: str = Options.wallet_path,
+        wallet_hotkey: str = Options.wallet_hotkey,
+        netuid: Optional[int] = Options.netuid,
+        position_id: Optional[int] = typer.Option(
+            None,
+            "--position-id",
+            "--position_id",
+            help="Position ID for modification or removing.",
+        ),
+        liquidity_delta: Optional[float] = typer.Option(
+            None,
+            "--liquidity-delta",
+            "--liquidity_delta",
+            help="Liquidity amount for modification.",
+        ),
+        prompt: bool = Options.prompt,
+        quiet: bool = Options.quiet,
+        verbose: bool = Options.verbose,
+        json_output: bool = Options.json_output,
+    ):
+        """Modifies the liquidity position for the given subnet."""
+        self.verbosity_handler(quiet, verbose, json_output)
+        if not netuid:
+            netuid = IntPrompt.ask(
+                f"Enter the [{COLORS.G.SUBHEAD_MAIN}]netuid[/{COLORS.G.SUBHEAD_MAIN}] to use",
+            )
+
+        wallet, hotkey = self.wallet_ask(
+            wallet_name=wallet_name,
+            wallet_path=wallet_path,
+            wallet_hotkey=wallet_hotkey,
+            ask_for=[WO.NAME, WO.HOTKEY, WO.PATH],
+            validate=WV.WALLET,
+            return_wallet_and_hotkey=True,
+        )
+
+        if not position_id:
+            position_id = prompt_position_id()
+
+        if liquidity_delta:
+            liquidity_delta = Balance.from_tao(liquidity_delta)
+        else:
+            liquidity_delta = prompt_liquidity(
+                f"Enter the [blue]liquidity delta[/blue] to modify position with id "
+                f"[blue]{position_id}[/blue] (can be positive or negative)",
+                negative_allowed=True,
+            )
+
+        return self._run_command(
+            liquidity.modify_liquidity(
+                subtensor=self.initialize_chain(network),
+                wallet=wallet,
+                hotkey_ss58=hotkey,
+                netuid=netuid,
+                position_id=position_id,
+                liquidity_delta=liquidity_delta,
+                prompt=prompt,
+                json_output=json_output,
+            )
+        )
+
     @staticmethod
     @utils_app.command("convert")
     def convert(

{bittensor_cli-9.7.1 → bittensor_cli-9.8.1}/bittensor_cli/src/__init__.py

@@ -660,6 +660,11 @@ HYPERPARAMS = {
     ),
     "yuma3_enabled": ("sudo_set_yuma3_enabled", False),
     "alpha_sigmoid_steepness": ("sudo_set_alpha_sigmoid_steepness", True),
+    "user_liquidity_enabled": ("toggle_user_liquidity", True),
+}
+
+HYPERPARAMS_MODULE = {
+    "user_liquidity_enabled": "Swap",
 }
 
 # Help Panels for cli help
@@ -699,6 +704,9 @@ HELP_PANELS = {
     "VIEW": {
         "DASHBOARD": "Network Dashboard",
     },
+    "LIQUIDITY": {
+        "LIQUIDITY_MGMT": "Liquidity Management",
+    },
 }