bittensor-cli 8.2.0__py3-none-any.whl → 8.3.1__py3-none-any.whl

bittensor_cli/src/__init__.py

@@ -4,16 +4,18 @@ from typing import Any, Optional
 
 
 class Constants:
-    networks = ["local", "finney", "test", "archive"]
+    networks = ["local", "finney", "test", "archive", "subvortex"]
     finney_entrypoint = "wss://entrypoint-finney.opentensor.ai:443"
     finney_test_entrypoint = "wss://test.finney.opentensor.ai:443"
     archive_entrypoint = "wss://archive.chain.opentensor.ai:443"
-    local_entrypoint = "ws://127.0.0.1:9444"
+    subvortex_entrypoint = "ws://subvortex.info:9944"
+    local_entrypoint = "ws://127.0.0.1:9944"
     network_map = {
         "finney": finney_entrypoint,
         "test": finney_test_entrypoint,
         "archive": archive_entrypoint,
         "local": local_entrypoint,
+        "subvortex": subvortex_entrypoint,
     }
     delegates_detail_url = "https://raw.githubusercontent.com/opentensor/bittensor-delegates/main/public/delegates.json"
 

bittensor_cli/src/bittensor/async_substrate_interface.py

@@ -6,13 +6,14 @@ from dataclasses import dataclass
 from hashlib import blake2b
 from typing import Optional, Any, Union, Callable, Awaitable, cast
 
-from bt_decode import PortableRegistry, decode as decode_by_type_string, MetadataV15
 from async_property import async_property
+from bt_decode import PortableRegistry, decode as decode_by_type_string, MetadataV15
+from bittensor_wallet import Keypair
+from packaging import version
 from scalecodec import GenericExtrinsic
 from scalecodec.base import ScaleBytes, ScaleType, RuntimeConfigurationObject
 from scalecodec.type_registry import load_type_registry_preset
 from scalecodec.types import GenericCall
-from bittensor_wallet import Keypair
 from substrateinterface.exceptions import (
     SubstrateRequestException,
     ExtrinsicNotFound,
@@ -460,6 +461,9 @@ class Runtime:
         self.runtime_config = runtime_config
         self.metadata = metadata
 
+    def __str__(self):
+        return f"Runtime: {self.chain} | {self.config}"
+
     @property
     def implements_scaleinfo(self) -> bool:
         """
@@ -682,9 +686,9 @@ class Websocket:
             try:
                 self._receiving_task.cancel()
                 await self._receiving_task
+                await self.ws.close()
             except (AttributeError, asyncio.CancelledError):
                 pass
-            await self.ws.close()
             self.ws = None
             self._initialized = False
             self._receiving_task = None
@@ -768,14 +772,13 @@ class AsyncSubstrateInterface:
         """
         self.chain_endpoint = chain_endpoint
         self.__chain = chain_name
-        self.ws = Websocket(
-            chain_endpoint,
-            options={
-                "max_size": 2**32,
-                "read_limit": 2**16,
-                "write_limit": 2**16,
-            },
-        )
+        options = {
+            "max_size": 2**32,
+            "write_limit": 2**16,
+        }
+        if version.parse(websockets.__version__) < version.parse("14.0"):
+            options.update({"read_limit": 2**16})
+        self.ws = Websocket(chain_endpoint, options=options)
         self._lock = asyncio.Lock()
         self.last_block_hash: Optional[str] = None
         self.config = {
@@ -897,9 +900,10 @@ class AsyncSubstrateInterface:
 
         async def get_runtime(block_hash, block_id) -> Runtime:
             # Check if runtime state already set to current block
-            if (block_hash and block_hash == self.last_block_hash) or (
-                block_id and block_id == self.block_id
-            ):
+            if (
+                (block_hash and block_hash == self.last_block_hash)
+                or (block_id and block_id == self.block_id)
+            ) and self.metadata is not None:
                 return Runtime(
                     self.chain,
                     self.runtime_config,
@@ -945,9 +949,11 @@ class AsyncSubstrateInterface:
                 raise SubstrateRequestException(
                     f"No runtime information for block '{block_hash}'"
                 )
-
             # Check if runtime state already set to current block
-            if runtime_info.get("specVersion") == self.runtime_version:
+            if (
+                runtime_info.get("specVersion") == self.runtime_version
+                and self.metadata is not None
+            ):
                 return Runtime(
                     self.chain,
                     self.runtime_config,
@@ -962,16 +968,19 @@ class AsyncSubstrateInterface:
                 if self.runtime_version in self.__metadata_cache:
                     # Get metadata from cache
                     # self.debug_message('Retrieved metadata for {} from memory'.format(self.runtime_version))
-                    self.metadata = self.__metadata_cache[self.runtime_version]
+                    metadata = self.metadata = self.__metadata_cache[
+                        self.runtime_version
+                    ]
                 else:
-                    self.metadata = await self.get_block_metadata(
+                    metadata = self.metadata = await self.get_block_metadata(
                         block_hash=runtime_block_hash, decode=True
                     )
                     # self.debug_message('Retrieved metadata for {} from Substrate node'.format(self.runtime_version))
 
                     # Update metadata cache
                     self.__metadata_cache[self.runtime_version] = self.metadata
-
+            else:
+                metadata = self.metadata
             # Update type registry
             self.reload_type_registry(use_remote_preset=False, auto_discover=True)
 
@@ -1012,7 +1021,10 @@ class AsyncSubstrateInterface:
         if block_id and block_hash:
             raise ValueError("Cannot provide block_hash and block_id at the same time")
 
-        if not (runtime := self.runtime_cache.retrieve(block_id, block_hash)):
+        if (
+            not (runtime := self.runtime_cache.retrieve(block_id, block_hash))
+            or runtime.metadata is None
+        ):
             runtime = await get_runtime(block_hash, block_id)
             self.runtime_cache.add_item(block_id, block_hash, runtime)
         return runtime
@@ -1123,7 +1135,7 @@ class AsyncSubstrateInterface:
         -------
         StorageKey
         """
-        await self.init_runtime(block_hash=block_hash)
+        runtime = await self.init_runtime(block_hash=block_hash)
 
         return StorageKey.create_from_storage_function(
             pallet,
@@ -1707,9 +1719,7 @@ class AsyncSubstrateInterface:
         )
         result = await self._make_rpc_request(payloads, runtime=runtime)
         if "error" in result[payload_id][0]:
-            raise SubstrateRequestException(
-                result[payload_id][0]["error"]["message"]
-            )
+            raise SubstrateRequestException(result[payload_id][0]["error"]["message"])
         if "result" in result[payload_id][0]:
             return result[payload_id][0]
         else:
@@ -2274,7 +2284,7 @@ class AsyncSubstrateInterface:
         MetadataModuleConstants
         """
 
-        # await self.init_runtime(block_hash=block_hash)
+        await self.init_runtime(block_hash=block_hash)
 
         for module in self.metadata.pallets:
             if module_name == module.name and module.constants:

bittensor_cli/src/bittensor/extrinsics/registration.py

@@ -16,10 +16,10 @@ import random
 import time
 import typing
 from typing import Optional
+import subprocess
 
 import backoff
 from bittensor_wallet import Wallet
-from bittensor_wallet.errors import KeyFileError
 from Crypto.Hash import keccak
 import numpy as np
 from rich.prompt import Confirm
@@ -35,6 +35,8 @@ from bittensor_cli.src.bittensor.utils import (
     millify,
     get_human_readable,
     print_verbose,
+    print_error,
+    unlock_key,
 )
 
 if typing.TYPE_CHECKING:
@@ -512,12 +514,13 @@ async def register_extrinsic(
     with console.status(
         f":satellite: Checking Account on [bold]subnet:{netuid}[/bold]...",
         spinner="aesthetic",
-    ):
+    ) as status:
         neuron = await get_neuron_for_pubkey_and_subnet()
         if not neuron.is_null:
-            # bittensor.logging.debug(
-            #     f"Wallet {wallet} is already registered on {neuron.netuid} with {neuron.uid}"
-            # )
+            print_error(
+                f"Wallet {wallet} is already registered on subnet {neuron.netuid} with uid {neuron.uid}",
+                status,
+            )
             return True
 
     if prompt:
@@ -611,7 +614,8 @@ async def register_extrinsic(
                         success, err_msg = True, ""
                     else:
                         await response.process_events()
-                        if not await response.is_success:
+                        success = await response.is_success
+                        if not success:
                             success, err_msg = (
                                 False,
                                 format_error_message(
@@ -619,23 +623,23 @@ async def register_extrinsic(
                                     substrate=subtensor.substrate,
                                 ),
                             )
-
-                    if not success:
-                        # Look error here
-                        # https://github.com/opentensor/subtensor/blob/development/pallets/subtensor/src/errors.rs
-                        if "HotKeyAlreadyRegisteredInSubNet" in err_msg:
-                            console.print(
-                                f":white_heavy_check_mark: [green]Already Registered on "
-                                f"[bold]subnet:{netuid}[/bold][/green]"
+                            # Look error here
+                            # https://github.com/opentensor/subtensor/blob/development/pallets/subtensor/src/errors.rs
+
+                            if "HotKeyAlreadyRegisteredInSubNet" in err_msg:
+                                console.print(
+                                    f":white_heavy_check_mark: [green]Already Registered on "
+                                    f"[bold]subnet:{netuid}[/bold][/green]"
+                                )
+                                return True
+                            err_console.print(
+                                f":cross_mark: [red]Failed[/red]: {err_msg}"
                             )
-                            return True
-
-                        err_console.print(f":cross_mark: [red]Failed[/red]: {err_msg}")
-                        await asyncio.sleep(0.5)
+                            await asyncio.sleep(0.5)
 
                     # Successful registration, final check for neuron and pubkey
-                    else:
-                        console.print(":satellite: Checking Balance...")
+                    if success:
+                        console.print(":satellite: Checking Registration status...")
                         is_registered = await is_hotkey_registered(
                             subtensor,
                             netuid=netuid,
@@ -722,10 +726,8 @@ async def run_faucet_extrinsic(
         return False, "Requires torch"
 
     # Unlock coldkey
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
-        return False, "There was an error unlocking your coldkey"
+    if not (unlock_status := unlock_key(wallet, print_out=False)).success:
+        return False, unlock_status.message
 
     # Get previous balance.
     old_balance = await subtensor.get_balance(wallet.coldkeypub.ss58_address)
@@ -914,6 +916,9 @@ async def _block_solver(
     stop_event.clear()
 
     solution_queue = Queue()
+    if cuda:
+        num_processes = len(dev_id)
+
     finished_queues = [Queue() for _ in range(num_processes)]
     check_block = Lock()
 
@@ -923,7 +928,6 @@ async def _block_solver(
 
     if cuda:
         ## Create a worker per CUDA device
-        num_processes = len(dev_id)
         solvers = [
             _CUDASolver(
                 i,
@@ -1231,8 +1235,14 @@ def _terminate_workers_and_wait_for_exit(
         if isinstance(worker, Queue_Type):
             worker.join_thread()
         else:
-            worker.join()
-        worker.close()
+            try:
+                worker.join(3.0)
+            except subprocess.TimeoutExpired:
+                worker.terminate()
+        try:
+            worker.close()
+        except ValueError:
+            worker.terminate()
 
 
 # TODO verify this works with async
@@ -1627,9 +1637,7 @@ async def swap_hotkey_extrinsic(
         )
         return False
 
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success:
         return False
 
     if prompt:

bittensor_cli/src/bittensor/extrinsics/root.py

@@ -21,7 +21,6 @@ import time
 from typing import Union, List, TYPE_CHECKING
 
 from bittensor_wallet import Wallet, Keypair
-from bittensor_wallet.errors import KeyFileError
 import numpy as np
 from numpy.typing import NDArray
 from rich.prompt import Confirm
@@ -37,6 +36,7 @@ from bittensor_cli.src.bittensor.utils import (
     u16_normalized_float,
     print_verbose,
     format_error_message,
+    unlock_key,
 )
 
 if TYPE_CHECKING:
@@ -306,9 +306,7 @@ async def root_register_extrinsic(
              the response is `True`.
     """
 
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success:
         return False
 
     print_verbose(f"Checking if hotkey ({wallet.hotkey_str}) is registered on root")
@@ -426,9 +424,7 @@ async def set_root_weights_extrinsic(
         err_console.print("Your hotkey is not registered to the root network")
         return False
 
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success:
         return False
 
     # First convert types.

bittensor_cli/src/bittensor/extrinsics/transfer.py

@@ -1,7 +1,6 @@
 import asyncio
 
 from bittensor_wallet import Wallet
-from bittensor_wallet.errors import KeyFileError
 from rich.prompt import Confirm
 from substrateinterface.exceptions import SubstrateRequestException
 
@@ -15,6 +14,8 @@ from bittensor_cli.src.bittensor.utils import (
     format_error_message,
     get_explorer_url_for_network,
     is_valid_bittensor_address_or_public_key,
+    print_error,
+    unlock_key,
 )
 
 
@@ -23,6 +24,7 @@ async def transfer_extrinsic(
     wallet: Wallet,
     destination: str,
     amount: Balance,
+    transfer_all: bool = False,
     wait_for_inclusion: bool = True,
     wait_for_finalization: bool = False,
     keep_alive: bool = True,
@@ -34,6 +36,7 @@ async def transfer_extrinsic(
     :param wallet: Bittensor wallet object to make transfer from.
     :param destination: Destination public key address (ss58_address or ed25519) of recipient.
     :param amount: Amount to stake as Bittensor balance.
+    :param transfer_all: Whether to transfer all funds from this wallet to the destination address.
     :param wait_for_inclusion: If set, waits for the extrinsic to enter a block before returning `True`,
                                or returns `False` if the extrinsic fails to enter the block within the timeout.
     :param wait_for_finalization:  If set, waits for the extrinsic to be finalized on the chain before returning
@@ -98,7 +101,11 @@ async def transfer_extrinsic(
             block_hash_ = response.block_hash
             return True, block_hash_, ""
         else:
-            return False, "", format_error_message(await response.error_message)
+            return (
+                False,
+                "",
+                format_error_message(await response.error_message, subtensor.substrate),
+            )
 
     # Validate destination address.
     if not is_valid_bittensor_address_or_public_key(destination):
@@ -108,9 +115,7 @@ async def transfer_extrinsic(
         return False
     console.print(f"[dark_orange]Initiating transfer on network: {subtensor.network}")
     # Unlock wallet coldkey.
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success:
         return False
 
     # Check balance.
@@ -135,6 +140,12 @@ async def transfer_extrinsic(
         existential_deposit = Balance(0)
 
     # Check if we have enough balance.
+    if transfer_all is True:
+        amount = account_balance - fee - existential_deposit
+        if amount < Balance(0):
+            print_error("Not enough balance to transfer")
+            return False
+
     if account_balance < (amount + fee + existential_deposit):
         err_console.print(
             ":cross_mark: [bold red]Not enough balance[/bold red]:\n\n"
@@ -183,7 +194,7 @@ async def transfer_extrinsic(
             )
             console.print(
                 f"Balance:\n"
-                f"  [blue]{account_balance}[/blue] :arrow_right: [green]{new_balance[wallet.coldkey.ss58_address]}[/green]"
+                f"  [blue]{account_balance}[/blue] :arrow_right: [green]{new_balance[wallet.coldkeypub.ss58_address]}[/green]"
             )
             return True
 

bittensor_cli/src/bittensor/subtensor_interface.py

@@ -111,18 +111,18 @@ class SubtensorInterface:
         return f"Network: {self.network}, Chain: {self.chain_endpoint}"
 
     async def __aenter__(self):
-        with console.status(
-            f"[yellow]Connecting to Substrate:[/yellow][bold white] {self}..."
-        ):
-            try:
+        try:
+            with console.status(
+                f"[yellow]Connecting to Substrate:[/yellow][bold white] {self}..."
+            ):
                 async with self.substrate:
                     return self
-            except TimeoutException:
-                err_console.print(
-                    "\n[red]Error[/red]: Timeout occurred connecting to substrate. "
-                    f"Verify your chain and network settings: {self}"
-                )
-                raise typer.Exit(code=1)
+        except TimeoutException:
+            err_console.print(
+                "\n[red]Error[/red]: Timeout occurred connecting to substrate. "
+                f"Verify your chain and network settings: {self}"
+            )
+            raise typer.Exit(code=1)
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):
         await self.substrate.close()
@@ -283,7 +283,7 @@ class SubtensorInterface:
         self,
         runtime_api: str,
         method: str,
-        params: Optional[Union[list[list[int]], dict[str, int]]],
+        params: Optional[Union[list[list[int]], list[int], dict[str, int]]],
         block_hash: Optional[str] = None,
         reuse_block: Optional[bool] = False,
     ) -> Optional[str]:

bittensor_cli/src/bittensor/utils.py

@@ -1,4 +1,5 @@
 import ast
+from collections import namedtuple
 import math
 import os
 import sqlite3
@@ -9,7 +10,7 @@ from urllib.parse import urlparse
 
 from bittensor_wallet import Wallet, Keypair
 from bittensor_wallet.utils import SS58_FORMAT
-from bittensor_wallet.errors import KeyFileError
+from bittensor_wallet.errors import KeyFileError, PasswordError
 from bittensor_wallet import utils
 from jinja2 import Template
 from markupsafe import Markup
@@ -35,6 +36,8 @@ console = Console()
 err_console = Console(stderr=True)
 verbose_console = Console(quiet=True)
 
+UnlockStatus = namedtuple("UnlockStatus", ["success", "message"])
+
 
 def print_console(message: str, colour: str, title: str, console: Console):
     console.print(
@@ -238,11 +241,14 @@ def get_hotkey_wallets_for_wallet(
 def get_coldkey_wallets_for_path(path: str) -> list[Wallet]:
     """Gets all wallets with coldkeys from a given path"""
     wallet_path = Path(path).expanduser()
-    wallets = [
-        Wallet(name=directory.name, path=path)
-        for directory in wallet_path.iterdir()
-        if directory.is_dir()
-    ]
+    try:
+        wallets = [
+            Wallet(name=directory.name, path=path)
+            for directory in wallet_path.iterdir()
+            if directory.is_dir()
+        ]
+    except FileNotFoundError:
+        wallets = []
     return wallets
 
 
@@ -443,7 +449,7 @@ def get_explorer_url_for_network(
         explorer_opentensor_url = "{root_url}/query/{block_hash}".format(
             root_url=explorer_root_urls.get("opentensor"), block_hash=block_hash
         )
-        explorer_taostats_url = "{root_url}/extrinsic/{block_hash}".format(
+        explorer_taostats_url = "{root_url}/hash/{block_hash}".format(
             root_url=explorer_root_urls.get("taostats"), block_hash=block_hash
         )
         explorer_urls["opentensor"] = explorer_opentensor_url
@@ -532,7 +538,7 @@ def format_error_message(
             err_docs = error_message.get("docs", [err_description])
             err_description = err_docs[0] if err_docs else err_description
 
-    return f"Subtensor returned `{err_name}({err_type})` error. This means: `{err_description}`."
+    return f"Subtensor returned `{err_name}({err_type})` error. This means: '{err_description}'."
 
 
 def convert_blocks_to_time(blocks: int, block_time: int = 12) -> tuple[int, int, int]:
@@ -974,3 +980,39 @@ def retry_prompt(
             return var
         else:
             err_console.print(rejection_text)
+
+
+def unlock_key(
+    wallet: Wallet, unlock_type="cold", print_out: bool = True
+) -> "UnlockStatus":
+    """
+    Attempts to decrypt a wallet's coldkey or hotkey
+    Args:
+        wallet: a Wallet object
+        unlock_type: the key type, 'cold' or 'hot'
+        print_out:  whether to print out the error message to the err_console
+
+    Returns: UnlockStatus for success status of unlock, with error message if unsuccessful
+
+    """
+    if unlock_type == "cold":
+        unlocker = "unlock_coldkey"
+    elif unlock_type == "hot":
+        unlocker = "unlock_hotkey"
+    else:
+        raise ValueError(
+            f"Invalid unlock type provided: {unlock_type}. Must be 'cold' or 'hot'."
+        )
+    try:
+        getattr(wallet, unlocker)()
+        return UnlockStatus(True, "")
+    except PasswordError:
+        err_msg = f"The password used to decrypt your {unlock_type.capitalize()}key Keyfile is invalid."
+        if print_out:
+            err_console.print(f":cross_mark: [red]{err_msg}[/red]")
+        return UnlockStatus(False, err_msg)
+    except KeyFileError:
+        err_msg = f"{unlock_type.capitalize()}key Keyfile is corrupt, non-writable, or non-readable, or non-existent."
+        if print_out:
+            err_console.print(f":cross_mark: [red]{err_msg}[/red]")
+        return UnlockStatus(False, err_msg)

bittensor_cli/src/commands/root.py

@@ -3,7 +3,6 @@ import json
 from typing import Optional, TYPE_CHECKING
 
 from bittensor_wallet import Wallet
-from bittensor_wallet.errors import KeyFileError
 import numpy as np
 from numpy.typing import NDArray
 from rich import box
@@ -42,6 +41,7 @@ from bittensor_cli.src.bittensor.utils import (
     ss58_to_vec_u8,
     update_metadata_table,
     group_subnets,
+    unlock_key,
 )
 
 if TYPE_CHECKING:
@@ -280,9 +280,7 @@ async def burned_register_extrinsic(
              finalization/inclusion, the response is `True`.
     """
 
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success:
         return False
 
     with console.status(
@@ -536,9 +534,7 @@ async def delegate_extrinsic(
     delegate_string = "delegate" if delegate else "undelegate"
 
     # Decrypt key
-    try:
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success:
         return False
 
     print_verbose("Checking if hotkey is a delegate")
@@ -1096,10 +1092,7 @@ async def senate_vote(
         return False
 
     # Unlock the wallet.
-    try:
-        wallet.unlock_hotkey()
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success and unlock_key(wallet, "hot").success:
         return False
 
     console.print(f"Fetching proposals in [dark_orange]network: {subtensor.network}")
@@ -1319,10 +1312,7 @@ async def set_take(wallet: Wallet, subtensor: SubtensorInterface, take: float) -
 
     console.print(f"Setting take on [dark_orange]network: {subtensor.network}")
     # Unlock the wallet.
-    try:
-        wallet.unlock_hotkey()
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success and unlock_key(wallet, "hot").success:
         return False
 
     result_ = await _do_set_take()
@@ -1720,10 +1710,7 @@ async def nominate(wallet: Wallet, subtensor: SubtensorInterface, prompt: bool):
 
     console.print(f"Nominating on [dark_orange]network: {subtensor.network}")
     # Unlock the wallet.
-    try:
-        wallet.unlock_hotkey()
-        wallet.unlock_coldkey()
-    except KeyFileError:
+    if not unlock_key(wallet).success and unlock_key(wallet, "hot").success:
         return False
 
     print_verbose(f"Checking hotkey ({wallet.hotkey_str}) is a delegate")