import copy
from datetime import datetime, timezone
from functools import lru_cache
from typing import TYPE_CHECKING, Any, Iterable, Optional, Union, cast
import numpy as np
import scalecodec
from async_substrate_interface.errors import SubstrateRequestException
from async_substrate_interface.substrate_addons import RetrySyncSubstrate
from async_substrate_interface.sync_substrate import SubstrateInterface
from async_substrate_interface.types import ScaleObj
from bittensor_drand import get_encrypted_commitment
from numpy.typing import NDArray
from bittensor.core.async_subtensor import ProposalVoteData
from bittensor.core.axon import Axon
from bittensor.core.chain_data import (
DelegatedInfo,
DelegateInfo,
DynamicInfo,
MetagraphInfo,
NeuronInfo,
NeuronInfoLite,
SelectiveMetagraphIndex,
StakeInfo,
SubnetInfo,
SubnetIdentity,
SubnetHyperparameters,
WeightCommitInfo,
decode_account_id,
)
from bittensor.core.chain_data.chain_identity import ChainIdentity
from bittensor.core.chain_data.utils import (
decode_block,
decode_metadata,
decode_revealed_commitment,
decode_revealed_commitment_with_hotkey,
)
from bittensor.core.config import Config
from bittensor.core.errors import ChainError
from bittensor.core.extrinsics.children import (
set_children_extrinsic,
root_set_pending_childkey_cooldown_extrinsic,
)
from bittensor.core.extrinsics.commit_reveal import commit_reveal_v3_extrinsic
from bittensor.core.extrinsics.commit_weights import (
commit_weights_extrinsic,
reveal_weights_extrinsic,
)
from bittensor.core.extrinsics.liquidity import (
add_liquidity_extrinsic,
modify_liquidity_extrinsic,
remove_liquidity_extrinsic,
toggle_user_liquidity_extrinsic,
)
from bittensor.core.extrinsics.move_stake import (
transfer_stake_extrinsic,
swap_stake_extrinsic,
move_stake_extrinsic,
)
from bittensor.core.extrinsics.registration import (
burned_register_extrinsic,
register_extrinsic,
register_subnet_extrinsic,
set_subnet_identity_extrinsic,
)
from bittensor.core.extrinsics.root import (
root_register_extrinsic,
set_root_weights_extrinsic,
)
from bittensor.core.extrinsics.serving import (
get_last_bonds_reset,
publish_metadata,
get_metadata,
serve_axon_extrinsic,
)
from bittensor.core.extrinsics.set_weights import set_weights_extrinsic
from bittensor.core.extrinsics.staking import (
add_stake_extrinsic,
add_stake_multiple_extrinsic,
)
from bittensor.core.extrinsics.start_call import start_call_extrinsic
from bittensor.core.extrinsics.take import (
decrease_take_extrinsic,
increase_take_extrinsic,
)
from bittensor.core.extrinsics.transfer import transfer_extrinsic
from bittensor.core.extrinsics.unstaking import (
unstake_all_extrinsic,
unstake_extrinsic,
unstake_multiple_extrinsic,
)
from bittensor.core.metagraph import Metagraph
from bittensor.core.settings import (
version_as_int,
SS58_FORMAT,
TYPE_REGISTRY,
)
from bittensor.core.types import ParamWithTypes, SubtensorMixin
from bittensor.utils import (
Certificate,
decode_hex_identity_dict,
format_error_message,
is_valid_ss58_address,
torch,
u16_normalized_float,
u64_normalized_float,
)
from bittensor.utils.balance import (
Balance,
fixed_to_float,
FixedPoint,
check_and_convert_to_balance,
)
from bittensor.utils.btlogging import logging
from bittensor.utils.liquidity import (
calculate_fees,
get_fees,
tick_to_price,
price_to_tick,
LiquidityPosition,
)
from bittensor.utils.weight_utils import (
generate_weight_hash,
convert_uids_and_weights,
U16_MAX,
)
if TYPE_CHECKING:
from bittensor_wallet import Wallet
from async_substrate_interface.sync_substrate import QueryMapResult
from scalecodec.types import GenericCall
[docs]
class Subtensor(SubtensorMixin):
"""Thin layer for interacting with Substrate Interface. Mostly a collection of frequently used calls."""
def __init__(
self,
network: Optional[str] = None,
config: Optional[Config] = None,
log_verbose: bool = False,
fallback_endpoints: Optional[list[str]] = None,
retry_forever: bool = False,
_mock: bool = False,
archive_endpoints: Optional[list[str]] = None,
):
"""
Initializes an instance of the Subtensor class.
Arguments:
network: The network name or type to connect to.
config: Configuration object for the AsyncSubtensor instance.
log_verbose: Enables or disables verbose logging.
fallback_endpoints: List of fallback endpoints to use if default or provided network is not available.
Defaults to `None`.
retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
_mock: Whether this is a mock instance. Mainly just for use in testing.
archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
where you are requesting a block that is too old for your current (presumably lite) node. Defaults to
`None`
Raises:
Any exceptions raised during the setup, configuration, or connection process.
"""
if config is None:
config = self.config()
self._config = copy.deepcopy(config)
self.chain_endpoint, self.network = self.setup_config(network, self._config)
self.log_verbose = log_verbose
self._check_and_log_network_settings()
logging.debug(
f"Connecting to network: [blue]{self.network}[/blue], "
f"chain_endpoint: [blue]{self.chain_endpoint}[/blue]> ..."
)
self.substrate = self._get_substrate(
fallback_endpoints=fallback_endpoints,
retry_forever=retry_forever,
_mock=_mock,
archive_endpoints=archive_endpoints,
)
if self.log_verbose:
logging.info(
f"Connected to {self.network} network and {self.chain_endpoint}."
)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
[docs]
def close(self):
"""Closes the websocket connection."""
self.substrate.close()
def _get_substrate(
self,
fallback_endpoints: Optional[list[str]] = None,
retry_forever: bool = False,
_mock: bool = False,
archive_endpoints: Optional[list[str]] = None,
) -> Union[SubstrateInterface, RetrySyncSubstrate]:
"""Creates the Substrate instance based on provided arguments.
Arguments:
fallback_endpoints: List of fallback chains endpoints to use if main network isn't available. Defaults to
`None`.
retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
_mock: Whether this is a mock instance. Mainly just for use in testing.
archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
where you are requesting a block that is too old for your current (presumably lite) node. Defaults to
`None`
Returns:
the instance of the SubstrateInterface or RetrySyncSubstrate class.
"""
if fallback_endpoints or retry_forever or archive_endpoints:
return RetrySyncSubstrate(
url=self.chain_endpoint,
ss58_format=SS58_FORMAT,
type_registry=TYPE_REGISTRY,
use_remote_preset=True,
chain_name="Bittensor",
fallback_chains=fallback_endpoints,
retry_forever=retry_forever,
_mock=_mock,
archive_nodes=archive_endpoints,
)
return SubstrateInterface(
url=self.chain_endpoint,
ss58_format=SS58_FORMAT,
type_registry=TYPE_REGISTRY,
use_remote_preset=True,
chain_name="Bittensor",
_mock=_mock,
)
# Subtensor queries ===========================================================================================
[docs]
def query_constant(
self, module_name: str, constant_name: str, block: Optional[int] = None
) -> Optional["ScaleObj"]:
"""
Retrieves a constant from the specified module on the Bittensor blockchain. This function is used to access
fixed parameters or values defined within the blockchain's modules, which are essential for understanding
the network's configuration and rules.
Args:
module_name: The name of the module containing the constant.
constant_name: The name of the constant to retrieve.
block: The blockchain block number at which to query the constant.
Returns:
Optional[async_substrate_interface.types.ScaleObj]: The value of the constant if found, `None` otherwise.
Constants queried through this function can include critical network parameters such as inflation rates,
consensus rules, or validation thresholds, providing a deeper understanding of the Bittensor network's
operational parameters.
"""
return self.substrate.get_constant(
module_name=module_name,
constant_name=constant_name,
block_hash=self.determine_block_hash(block),
)
[docs]
def query_map(
self,
module: str,
name: str,
block: Optional[int] = None,
params: Optional[list] = None,
) -> "QueryMapResult":
"""
Queries map storage from any module on the Bittensor blockchain. This function retrieves data structures that
represent key-value mappings, essential for accessing complex and structured data within the blockchain
modules.
Args:
module: The name of the module from which to query the map storage.
name: The specific storage function within the module to query.
block: The blockchain block number at which to perform the query.
params: Parameters to be passed to the query.
Returns:
result: A data structure representing the map storage if found, `None` otherwise.
This function is particularly useful for retrieving detailed and structured data from various blockchain
modules, offering insights into the network's state and the relationships between its different components.
"""
result = self.substrate.query_map(
module=module,
storage_function=name,
params=params,
block_hash=self.determine_block_hash(block=block),
)
return result
[docs]
def query_map_subtensor(
self, name: str, block: Optional[int] = None, params: Optional[list] = None
) -> "QueryMapResult":
"""
Queries map storage from the Subtensor module on the Bittensor blockchain. This function is designed to retrieve
a map-like data structure, which can include various neuron-specific details or network-wide attributes.
Args:
name: The name of the map storage function to query.
block: The blockchain block number at which to perform the query.
params: A list of parameters to pass to the query function.
Returns:
An object containing the map-like data structure, or `None` if not found.
This function is particularly useful for analyzing and understanding complex network structures and
relationships within the Bittensor ecosystem, such as interneuronal connections and stake distributions.
"""
return self.substrate.query_map(
module="SubtensorModule",
storage_function=name,
params=params,
block_hash=self.determine_block_hash(block),
)
[docs]
def query_module(
self,
module: str,
name: str,
block: Optional[int] = None,
params: Optional[list] = None,
) -> Optional[Union["ScaleObj", Any, FixedPoint]]:
"""
Queries any module storage on the Bittensor blockchain with the specified parameters and block number. This
function is a generic query interface that allows for flexible and diverse data retrieval from various
blockchain modules.
Args:
module (str): The name of the module from which to query data.
name (str): The name of the storage function within the module.
block (Optional[int]): The blockchain block number at which to perform the query.
params (Optional[list[object]]): A list of parameters to pass to the query function.
Returns:
An object containing the requested data if found, `None` otherwise.
This versatile query function is key to accessing a wide range of data and insights from different parts of the
Bittensor blockchain, enhancing the understanding and analysis of the network's state and dynamics.
"""
return self.substrate.query(
module=module,
storage_function=name,
params=params,
block_hash=self.determine_block_hash(block),
)
[docs]
def query_runtime_api(
self,
runtime_api: str,
method: str,
params: Optional[Union[list[Any], dict[str, Any]]] = None,
block: Optional[int] = None,
) -> Any:
"""
Queries the runtime API of the Bittensor blockchain, providing a way to interact with the underlying runtime and
retrieve data encoded in Scale Bytes format. This function is essential for advanced users who need to
interact with specific runtime methods and decode complex data types.
Args:
runtime_api: The name of the runtime API to query.
method: The specific method within the runtime API to call.
params: The parameters to pass to the method call.
block: the block number for this query.
Returns:
The Scale Bytes encoded result from the runtime API call, or `None` if the call fails.
This function enables access to the deeper layers of the Bittensor blockchain, allowing for detailed and
specific interactions with the network's runtime environment.
"""
block_hash = self.determine_block_hash(block)
result = self.substrate.runtime_call(runtime_api, method, params, block_hash)
return result.value
[docs]
def query_subtensor(
self, name: str, block: Optional[int] = None, params: Optional[list] = None
) -> Optional[Union["ScaleObj", Any]]:
"""
Queries named storage from the Subtensor module on the Bittensor blockchain. This function is used to retrieve
specific data or parameters from the blockchain, such as stake, rank, or other neuron-specific attributes.
Args:
name: The name of the storage function to query.
block: The blockchain block number at which to perform the query.
params: A list of parameters to pass to the query function.
Returns:
query_response: An object containing the requested data.
This query function is essential for accessing detailed information about the network and its neurons, providing
valuable insights into the state and dynamics of the Bittensor ecosystem.
"""
return self.substrate.query(
module="SubtensorModule",
storage_function=name,
params=params,
block_hash=self.determine_block_hash(block),
)
[docs]
def state_call(
self, method: str, data: str, block: Optional[int] = None
) -> dict[Any, Any]:
"""
Makes a state call to the Bittensor blockchain, allowing for direct queries of the blockchain's state. This
function is typically used for advanced queries that require specific method calls and data inputs.
Args:
method: The method name for the state call.
data: The data to be passed to the method.
block: The blockchain block number at which to perform the state call.
Returns:
result (dict[Any, Any]): The result of the rpc call.
The state call function provides a more direct and flexible way of querying blockchain data, useful for specific
use cases where standard queries are insufficient.
"""
block_hash = self.determine_block_hash(block)
return self.substrate.rpc_request(
method="state_call",
params=[method, data, block_hash] if block_hash else [method, data],
)
# Common subtensor calls ===========================================================================================
@property
def block(self) -> int:
return self.get_current_block()
[docs]
def all_subnets(self, block: Optional[int] = None) -> Optional[list["DynamicInfo"]]:
"""
Retrieves the subnet information for all subnets in the network.
Args:
block (Optional[int]): The block number to query the subnet information from.
Returns:
Optional[DynamicInfo]: A list of DynamicInfo objects, each containing detailed information about a subnet.
"""
block_hash = self.determine_block_hash(block=block)
query = self.substrate.runtime_call(
api="SubnetInfoRuntimeApi",
method="get_all_dynamic_info",
block_hash=block_hash,
)
subnet_prices = self.get_subnet_prices()
decoded = query.decode()
for sn in decoded:
sn.update({"price": subnet_prices.get(sn["netuid"], Balance.from_tao(0))})
return DynamicInfo.list_from_dicts(decoded)
[docs]
def blocks_since_last_step(
self, netuid: int, block: Optional[int] = None
) -> Optional[int]:
"""Returns number of blocks since the last epoch of the subnet.
Arguments:
netuid (int): The unique identifier of the subnetwork.
block: the block number for this query.
Returns:
block number of the last step in the subnet.
"""
query = self.query_subtensor(
name="BlocksSinceLastStep", block=block, params=[netuid]
)
return query.value if query is not None and hasattr(query, "value") else query
[docs]
def blocks_since_last_update(self, netuid: int, uid: int) -> Optional[int]:
"""
Returns the number of blocks since the last update for a specific UID in the subnetwork.
Arguments:
netuid (int): The unique identifier of the subnetwork.
uid (int): The unique identifier of the neuron.
Returns:
Optional[int]: The number of blocks since the last update, or ``None`` if the subnetwork or UID does not
exist.
"""
call = self.get_hyperparameter(param_name="LastUpdate", netuid=netuid)
return None if not call else (self.get_current_block() - int(call[uid]))
[docs]
def bonds(
self, netuid: int, block: Optional[int] = None
) -> list[tuple[int, list[tuple[int, int]]]]:
"""
Retrieves the bond distribution set by neurons within a specific subnet of the Bittensor network.
Bonds represent the investments or commitments made by neurons in one another, indicating a level of trust
and perceived value. This bonding mechanism is integral to the network's market-based approach to
measuring and rewarding machine intelligence.
Args:
netuid: The network UID of the subnet to query.
block: the block number for this query.
Returns:
List of tuples mapping each neuron's UID to its bonds with other neurons.
Understanding bond distributions is crucial for analyzing the trust dynamics and market behavior within the
subnet. It reflects how neurons recognize and invest in each other's intelligence and contributions,
supporting diverse and niche systems within the Bittensor ecosystem.
"""
b_map_encoded = self.substrate.query_map(
module="SubtensorModule",
storage_function="Bonds",
params=[netuid],
block_hash=self.determine_block_hash(block),
)
b_map = []
for uid, b in b_map_encoded:
if b.value is not None:
b_map.append((uid, b.value))
return b_map
[docs]
def commit(
self, wallet, netuid: int, data: str, period: Optional[int] = None
) -> bool:
"""
Commits arbitrary data to the Bittensor network by publishing metadata.
Arguments:
wallet (bittensor_wallet.Wallet): The wallet associated with the neuron committing the data.
netuid (int): The unique identifier of the subnetwork.
data (str): The data to be committed to the network.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: `True` if the commitment was successful, `False` otherwise.
"""
return publish_metadata(
subtensor=self,
wallet=wallet,
netuid=netuid,
data_type=f"Raw{len(data)}",
data=data.encode(),
period=period,
)
# add explicit alias
set_commitment = commit
[docs]
def commit_reveal_enabled(
self, netuid: int, block: Optional[int] = None
) -> Optional[bool]:
"""
Check if the commit-reveal mechanism is enabled for a given network at a specific block.
Arguments:
netuid: The network identifier for which to check the commit-reveal mechanism.
block: The block number to query.
Returns:
Returns the integer value of the hyperparameter if available; otherwise, returns None.
"""
call = self.get_hyperparameter(
param_name="CommitRevealWeightsEnabled", block=block, netuid=netuid
)
return True if call is True else False
[docs]
def difficulty(self, netuid: int, block: Optional[int] = None) -> Optional[int]:
"""
Retrieves the 'Difficulty' hyperparameter for a specified subnet in the Bittensor network.
This parameter is instrumental in determining the computational challenge required for neurons to participate in
consensus and validation processes.
Arguments:
netuid: The unique identifier of the subnet.
block: The blockchain block number for the query.
Returns:
Optional[int]: The value of the 'Difficulty' hyperparameter if the subnet exists, ``None`` otherwise.
The 'Difficulty' parameter directly impacts the network's security and integrity by setting the computational
effort required for validating transactions and participating in the network's consensus mechanism.
"""
call = self.get_hyperparameter(
param_name="Difficulty", netuid=netuid, block=block
)
if call is None:
return None
return int(call)
[docs]
def does_hotkey_exist(self, hotkey_ss58: str, block: Optional[int] = None) -> bool:
"""
Returns true if the hotkey is known by the chain and there are accounts.
Args:
hotkey_ss58: The SS58 address of the hotkey.
block: the block number for this query.
Returns:
`True` if the hotkey is known by the chain and there are accounts, `False` otherwise.
"""
result = self.substrate.query(
module="SubtensorModule",
storage_function="Owner",
params=[hotkey_ss58],
block_hash=self.determine_block_hash(block),
)
return_val = (
False
if result is None
# not the default key (0x0)
else result != "5C4hrfjw9DjXZTzV3MwzrrAr9P1MJhSrvWGWqi1eSuyUpnhM"
)
return return_val
[docs]
def get_all_subnets_info(self, block: Optional[int] = None) -> list["SubnetInfo"]:
"""
Retrieves detailed information about all subnets within the Bittensor network. This function provides
comprehensive data on each subnet, including its characteristics and operational parameters.
Arguments:
block: The blockchain block number for the query.
Returns:
list[SubnetInfo]: A list of SubnetInfo objects, each containing detailed information about a subnet.
Gaining insights into the subnets' details assists in understanding the network's composition, the roles of
different subnets, and their unique features.
"""
result = self.query_runtime_api(
runtime_api="SubnetInfoRuntimeApi",
method="get_subnets_info_v2",
params=[],
block=block,
)
if not result:
return []
subnets_prices = self.get_subnet_prices()
for subnet in result:
subnet.update({"price": subnets_prices.get(subnet["netuid"], 0)})
return SubnetInfo.list_from_dicts(result)
[docs]
def get_balance(self, address: str, block: Optional[int] = None) -> Balance:
"""
Retrieves the balance for given coldkey. Always in TAO.
Arguments:
address: coldkey address.
block (Optional[int]): The blockchain block number for the query.
Returns:
Balance object in TAO.
"""
balance = self.substrate.query(
module="System",
storage_function="Account",
params=[address],
block_hash=self.determine_block_hash(block),
)
return Balance(balance["data"]["free"])
[docs]
def get_balances(
self,
*addresses: str,
block: Optional[int] = None,
) -> dict[str, Balance]:
"""
Retrieves the balance for given coldkey(s)
Arguments:
addresses (str): coldkey addresses(s).
block (Optional[int]): The blockchain block number for the query.
Returns:
Dict of {address: Balance objects}.
"""
if not (block_hash := self.determine_block_hash(block)):
block_hash = self.substrate.get_chain_head()
calls = [
(
self.substrate.create_storage_key(
"System", "Account", [address], block_hash=block_hash
)
)
for address in addresses
]
batch_call = self.substrate.query_multi(calls, block_hash=block_hash)
results = {}
for item in batch_call:
value = item[1] or {"data": {"free": 0}}
results.update({item[0].params[0]: Balance(value["data"]["free"])})
return results
[docs]
def get_current_block(self) -> int:
"""
Returns the current block number on the Bittensor blockchain. This function provides the latest block number,
indicating the most recent state of the blockchain.
Returns:
int: The current chain block number.
Knowing the current block number is essential for querying real-time data and performing time-sensitive
operations on the blockchain. It serves as a reference point for network activities and data
synchronization.
"""
return self.substrate.get_block_number(None)
@lru_cache(maxsize=128)
def _get_block_hash(self, block_id: int):
return self.substrate.get_block_hash(block_id)
[docs]
def get_block_hash(self, block: Optional[int] = None) -> str:
"""
Retrieves the hash of a specific block on the Bittensor blockchain. The block hash is a unique identifier
representing the cryptographic hash of the block's content, ensuring its integrity and immutability.
Arguments:
block (int): The block number for which the hash is to be retrieved.
Returns:
str: The cryptographic hash of the specified block.
The block hash is a fundamental aspect of blockchain technology, providing a secure reference to each block's
data. It is crucial for verifying transactions, ensuring data consistency, and maintaining the
trustworthiness of the blockchain.
"""
if block:
return self._get_block_hash(block)
else:
return self.substrate.get_chain_head()
[docs]
def determine_block_hash(self, block: Optional[int]) -> Optional[str]:
if block is None:
return None
else:
return self.get_block_hash(block=block)
[docs]
def encode_params(
self,
call_definition: dict[str, list["ParamWithTypes"]],
params: Union[list[Any], dict[str, Any]],
) -> str:
"""Returns a hex encoded string of the params using their types."""
param_data = scalecodec.ScaleBytes(b"")
for i, param in enumerate(call_definition["params"]):
scale_obj = self.substrate.create_scale_object(param["type"])
if isinstance(params, list):
param_data += scale_obj.encode(params[i])
else:
if param["name"] not in params:
raise ValueError(f"Missing param {param['name']} in params dict.")
param_data += scale_obj.encode(params[param["name"]])
return param_data.to_hex()
[docs]
def get_hyperparameter(
self, param_name: str, netuid: int, block: Optional[int] = None
) -> Optional[Any]:
"""
Retrieves a specified hyperparameter for a specific subnet.
Arguments:
param_name (str): The name of the hyperparameter to retrieve.
netuid (int): The unique identifier of the subnet.
block: the block number at which to retrieve the hyperparameter.
Returns:
The value of the specified hyperparameter if the subnet exists, or None
"""
block_hash = self.determine_block_hash(block)
if not self.subnet_exists(netuid, block=block):
logging.error(f"subnet {netuid} does not exist")
return None
result = self.substrate.query(
module="SubtensorModule",
storage_function=param_name,
params=[netuid],
block_hash=block_hash,
)
return getattr(result, "value", result)
[docs]
def get_parents(
self, hotkey: str, netuid: int, block: Optional[int] = None
) -> list[tuple[float, str]]:
"""
This method retrieves the parent of a given hotkey and netuid. It queries the SubtensorModule's ParentKeys
storage function to get the children and formats them before returning as a tuple.
Arguments:
hotkey: The child hotkey SS58.
netuid: The netuid.
block: The block number for which the children are to be retrieved.
Returns:
A list of formatted parents [(proportion, parent)]
"""
parents = self.substrate.query(
module="SubtensorModule",
storage_function="ParentKeys",
params=[hotkey, netuid],
block_hash=self.determine_block_hash(block),
)
if parents:
formatted_parents = []
for proportion, parent in parents.value:
# Convert U64 to int
formatted_child = decode_account_id(parent[0])
normalized_proportion = u64_normalized_float(proportion)
formatted_parents.append((normalized_proportion, formatted_child))
return formatted_parents
return []
[docs]
def get_children(
self, hotkey: str, netuid: int, block: Optional[int] = None
) -> tuple[bool, list[tuple[float, str]], str]:
"""
This method retrieves the children of a given hotkey and netuid. It queries the SubtensorModule's ChildKeys
storage function to get the children and formats them before returning as a tuple.
Arguments:
hotkey (str): The hotkey value.
netuid (int): The netuid value.
block (Optional[int]): The block number for which the children are to be retrieved.
Returns:
A tuple containing a boolean indicating success or failure, a list of formatted children, and an error
message (if applicable)
"""
try:
children = self.substrate.query(
module="SubtensorModule",
storage_function="ChildKeys",
params=[hotkey, netuid],
block_hash=self.determine_block_hash(block),
)
if children:
formatted_children = []
for proportion, child in children.value:
# Convert U64 to int
formatted_child = decode_account_id(child[0])
normalized_proportion = u64_normalized_float(proportion)
formatted_children.append((normalized_proportion, formatted_child))
return True, formatted_children, ""
else:
return True, [], ""
except SubstrateRequestException as e:
return False, [], format_error_message(e)
[docs]
def get_children_pending(
self,
hotkey: str,
netuid: int,
block: Optional[int] = None,
) -> tuple[
list[tuple[float, str]],
int,
]:
"""
This method retrieves the pending children of a given hotkey and netuid.
It queries the SubtensorModule's PendingChildKeys storage function.
Arguments:
hotkey (str): The hotkey value.
netuid (int): The netuid value.
block (Optional[int]): The block number for which the children are to be retrieved.
Returns:
list[tuple[float, str]]: A list of children with their proportions.
int: The cool-down block number.
"""
children, cooldown = self.substrate.query(
module="SubtensorModule",
storage_function="PendingChildKeys",
params=[netuid, hotkey],
block_hash=self.determine_block_hash(block),
).value
return (
[
(
u64_normalized_float(proportion),
decode_account_id(child[0]),
)
for proportion, child in children
],
cooldown,
)
[docs]
def get_commitment(self, netuid: int, uid: int, block: Optional[int] = None) -> str:
"""
Retrieves the on-chain commitment for a specific neuron in the Bittensor network.
Arguments:
netuid (int): The unique identifier of the subnetwork.
uid (int): The unique identifier of the neuron.
block (Optional[int]): The block number to retrieve the commitment from. If None, the latest block is used.
Default is ``None``.
Returns:
str: The commitment data as a string.
"""
metagraph = self.metagraph(netuid)
try:
hotkey = metagraph.hotkeys[uid] # type: ignore
except IndexError:
logging.error(
"Your uid is not in the hotkeys. Please double-check your UID."
)
return ""
metadata = cast(dict, get_metadata(self, netuid, hotkey, block))
try:
return decode_metadata(metadata)
except TypeError:
return ""
[docs]
def get_last_commitment_bonds_reset_block(
self, netuid: int, uid: int
) -> Optional[int]:
"""
Retrieves the last block number when the bonds reset were triggered by publish_metadata for a specific neuron.
Arguments:
netuid (int): The unique identifier of the subnetwork.
uid (int): The unique identifier of the neuron.
Returns:
Optional[int]: The block number when the bonds were last reset, or None if not found.
"""
metagraph = self.metagraph(netuid)
try:
hotkey = metagraph.hotkeys[uid]
except IndexError:
logging.error(
"Your uid is not in the hotkeys. Please double-check your UID."
)
return None
block = get_last_bonds_reset(self, netuid, hotkey)
if block is None:
return None
return decode_block(block)
[docs]
def get_all_commitments(
self, netuid: int, block: Optional[int] = None
) -> dict[str, str]:
query = self.query_map(
module="Commitments",
name="CommitmentOf",
params=[netuid],
block=block,
)
result = {}
for id_, value in query:
result[decode_account_id(id_[0])] = decode_metadata(value)
return result
[docs]
def get_revealed_commitment_by_hotkey(
self,
netuid: int,
hotkey_ss58_address: str,
block: Optional[int] = None,
) -> Optional[tuple[tuple[int, str], ...]]:
"""Returns hotkey related revealed commitment for a given netuid.
Arguments:
netuid (int): The unique identifier of the subnetwork.
hotkey_ss58_address (str): The ss58 address of the committee member.
block (Optional[int]): The block number to retrieve the commitment from. Default is ``None``.
Returns:
result (tuple[int, str): A tuple of reveal block and commitment message.
"""
if not is_valid_ss58_address(address=hotkey_ss58_address):
raise ValueError(f"Invalid ss58 address {hotkey_ss58_address} provided.")
query = self.query_module(
module="Commitments",
name="RevealedCommitments",
params=[netuid, hotkey_ss58_address],
block=block,
)
if query is None:
return None
return tuple(decode_revealed_commitment(pair) for pair in query)
[docs]
def get_revealed_commitment(
self,
netuid: int,
uid: int,
block: Optional[int] = None,
) -> Optional[tuple[tuple[int, str], ...]]:
"""Returns uid related revealed commitment for a given netuid.
Arguments:
netuid (int): The unique identifier of the subnetwork.
uid (int): The neuron uid to retrieve the commitment from.
block (Optional[int]): The block number to retrieve the commitment from. Default is ``None``.
Returns:
result (Optional[tuple[int, str]]: A tuple of reveal block and commitment message.
Example of result:
( (12, "Alice message 1"), (152, "Alice message 2") )
( (12, "Bob message 1"), (147, "Bob message 2") )
"""
try:
meta_info = self.get_metagraph_info(netuid, block=block)
if meta_info:
hotkey_ss58_address = meta_info.hotkeys[uid]
else:
raise ValueError(f"Subnet with netuid {netuid} does not exist.")
except IndexError:
raise ValueError(f"Subnet {netuid} does not have a neuron with uid {uid}.")
return self.get_revealed_commitment_by_hotkey(
netuid=netuid, hotkey_ss58_address=hotkey_ss58_address, block=block
)
[docs]
def get_all_revealed_commitments(
self, netuid: int, block: Optional[int] = None
) -> dict[str, tuple[tuple[int, str], ...]]:
"""Returns all revealed commitments for a given netuid.
Arguments:
netuid (int): The unique identifier of the subnetwork.
block (Optional[int]): The block number to retrieve the commitment from. Default is ``None``.
Returns:
result (dict): A dictionary of all revealed commitments in view
{ss58_address: (reveal block, commitment message)}.
Example of result:
{
"5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY": ( (12, "Alice message 1"), (152, "Alice message 2") ),
"5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty": ( (12, "Bob message 1"), (147, "Bob message 2") ),
}
"""
query = self.query_map(
module="Commitments",
name="RevealedCommitments",
params=[netuid],
block=block,
)
result = {}
for pair in query:
hotkey_ss58_address, commitment_message = (
decode_revealed_commitment_with_hotkey(pair)
)
result[hotkey_ss58_address] = commitment_message
return result
[docs]
def get_current_weight_commit_info(
self, netuid: int, block: Optional[int] = None
) -> list:
"""
Retrieves CRV3 weight commit information for a specific subnet.
Arguments:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query. Default is ``None``.
Returns:
list: A list of commit details, where each entry is a dictionary with keys 'who', 'serialized_commit', and
'reveal_round', or an empty list if no data is found.
"""
result = self.substrate.query_map(
module="SubtensorModule",
storage_function="CRV3WeightCommits",
params=[netuid],
block_hash=self.determine_block_hash(block),
)
commits = result.records[0][1] if result.records else []
return [WeightCommitInfo.from_vec_u8(commit) for commit in commits]
[docs]
def get_delegate_by_hotkey(
self, hotkey_ss58: str, block: Optional[int] = None
) -> Optional["DelegateInfo"]:
"""
Retrieves detailed information about a delegate neuron based on its hotkey. This function provides a
comprehensive view of the delegate's status, including its stakes, nominators, and reward distribution.
Arguments:
hotkey_ss58 (str): The ``SS58`` address of the delegate's hotkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[DelegateInfo]: Detailed information about the delegate neuron, ``None`` if not found.
This function is essential for understanding the roles and influence of delegate neurons within the Bittensor
network's consensus and governance structures.
"""
result = self.query_runtime_api(
runtime_api="DelegateInfoRuntimeApi",
method="get_delegate",
params=[hotkey_ss58],
block=block,
)
if not result:
return None
return DelegateInfo.from_dict(result)
[docs]
def get_delegate_identities(
self, block: Optional[int] = None
) -> dict[str, ChainIdentity]:
"""
Fetches delegates identities from the chain.
Arguments:
block (Optional[int]): The blockchain block number for the query.
Returns:
Dict {ss58: ChainIdentity, ...}
"""
identities = self.substrate.query_map(
module="SubtensorModule",
storage_function="IdentitiesV2",
block_hash=self.determine_block_hash(block),
)
return {
decode_account_id(ss58_address[0]): ChainIdentity.from_dict(
decode_hex_identity_dict(identity.value),
)
for ss58_address, identity in identities
}
[docs]
def get_delegate_take(self, hotkey_ss58: str, block: Optional[int] = None) -> float:
"""
Retrieves the delegate 'take' percentage for a neuron identified by its hotkey. The 'take' represents the
percentage of rewards that the delegate claims from its nominators' stakes.
Arguments:
hotkey_ss58 (str): The ``SS58`` address of the neuron's hotkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
float: The delegate take percentage.
The delegate take is a critical parameter in the network's incentive structure, influencing the distribution of
rewards among neurons and their nominators.
"""
result = self.query_subtensor(
name="Delegates",
block=block,
params=[hotkey_ss58],
)
return u16_normalized_float(result.value) # type: ignore
[docs]
def get_delegated(
self, coldkey_ss58: str, block: Optional[int] = None
) -> list[tuple["DelegateInfo", Balance]]:
"""
Retrieves a list of delegates and their associated stakes for a given coldkey. This function identifies the
delegates that a specific account has staked tokens on.
Arguments:
coldkey_ss58 (str): The `SS58` address of the account's coldkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
A list of tuples, each containing a delegate's information and staked amount.
This function is important for account holders to understand their stake allocations and their involvement in
the network's delegation and consensus mechanisms.
"""
result = self.query_runtime_api(
runtime_api="DelegateInfoRuntimeApi",
method="get_delegated",
params=[coldkey_ss58],
block=block,
)
if not result:
return []
return DelegatedInfo.list_from_dicts(result)
[docs]
def get_delegates(self, block: Optional[int] = None) -> list["DelegateInfo"]:
"""
Fetches all delegates on the chain
Arguments:
block (Optional[int]): The blockchain block number for the query.
Returns:
List of DelegateInfo objects, or an empty list if there are no delegates.
"""
result = self.query_runtime_api(
runtime_api="DelegateInfoRuntimeApi",
method="get_delegates",
params=[],
block=block,
)
if result:
return DelegateInfo.list_from_dicts(result)
else:
return []
[docs]
def get_existential_deposit(self, block: Optional[int] = None) -> Optional[Balance]:
"""
Retrieves the existential deposit amount for the Bittensor blockchain. Always in TAO.
The existential deposit is the minimum amount of TAO required for an account to exist on the blockchain.
Accounts with balances below this threshold can be reaped to conserve network resources.
Arguments:
block (Optional[int]): The blockchain block number for the query.
Returns:
The existential deposit amount. Always in TAO.
The existential deposit is a fundamental economic parameter in the Bittensor network, ensuring efficient use of
storage and preventing the proliferation of dust accounts.
"""
result = self.substrate.get_constant(
module_name="Balances",
constant_name="ExistentialDeposit",
block_hash=self.determine_block_hash(block),
)
if result is None:
raise Exception("Unable to retrieve existential deposit amount.")
return Balance.from_rao(getattr(result, "value", 0))
[docs]
def get_hotkey_owner(
self, hotkey_ss58: str, block: Optional[int] = None
) -> Optional[str]:
"""
Retrieves the owner of the given hotkey at a specific block hash.
This function queries the blockchain for the owner of the provided hotkey. If the hotkey does not exist at the
specified block hash, it returns None.
Arguments:
hotkey_ss58 (str): The SS58 address of the hotkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[str]: The SS58 address of the owner if the hotkey exists, or None if it doesn't.
"""
hk_owner_query = self.substrate.query(
module="SubtensorModule",
storage_function="Owner",
params=[hotkey_ss58],
block_hash=self.determine_block_hash(block),
)
exists = False
if hk_owner_query:
exists = self.does_hotkey_exist(hotkey_ss58, block=block)
hotkey_owner = hk_owner_query if exists else None
return hotkey_owner
[docs]
def get_minimum_required_stake(self) -> Balance:
"""
Returns the minimum required stake for nominators in the Subtensor network.
Returns:
The minimum required stake as a Balance object in TAO.
"""
result = self.substrate.query(
module="SubtensorModule", storage_function="NominatorMinRequiredStake"
)
return Balance.from_rao(getattr(result, "value", 0))
[docs]
def get_netuids_for_hotkey(
self, hotkey_ss58: str, block: Optional[int] = None
) -> list[int]:
"""
Retrieves a list of subnet UIDs (netuids) for which a given hotkey is a member. This function identifies the
specific subnets within the Bittensor network where the neuron associated with the hotkey is active.
Arguments:
hotkey_ss58 (str): The ``SS58`` address of the neuron's hotkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
A list of netuids where the neuron is a member.
"""
result = self.substrate.query_map(
module="SubtensorModule",
storage_function="IsNetworkMember",
params=[hotkey_ss58],
block_hash=self.determine_block_hash(block),
)
netuids = []
if result.records:
for record in result:
if record[1].value:
netuids.append(record[0])
return netuids
[docs]
def get_neuron_certificate(
self, hotkey: str, netuid: int, block: Optional[int] = None
) -> Optional[Certificate]:
"""
Retrieves the TLS certificate for a specific neuron identified by its unique identifier (UID) within a
specified subnet (netuid) of the Bittensor network.
Arguments:
hotkey: The hotkey to query.
netuid: The unique identifier of the subnet.
block: The blockchain block number for the query.
Returns:
the certificate of the neuron if found, `None` otherwise.
This function is used for certificate discovery for setting up mutual tls communication between neurons.
"""
certificate_query = self.query_module(
module="SubtensorModule",
name="NeuronCertificates",
block=block,
params=[netuid, hotkey],
)
try:
if certificate_query:
certificate = cast(dict, certificate_query)
return Certificate(certificate)
except AttributeError:
return None
return None
[docs]
def get_all_neuron_certificates(
self, netuid: int, block: Optional[int] = None
) -> dict[str, Certificate]:
"""
Retrieves the TLS certificates for neurons within a specified subnet (netuid) of the Bittensor network.
Arguments:
netuid: The unique identifier of the subnet.
block: The blockchain block number for the query.
Returns:
{ss58: Certificate} for the key/Certificate pairs on the subnet
This function is used for certificate discovery for setting up mutual tls communication between neurons.
"""
query_certificates = self.query_map(
module="SubtensorModule",
name="NeuronCertificates",
params=[netuid],
block=block,
)
output = {}
for key, item in query_certificates:
output[decode_account_id(key)] = Certificate(item.value)
return output
[docs]
def get_liquidity_list(
self,
wallet: "Wallet",
netuid: int,
block: Optional[int] = None,
) -> Optional[list[LiquidityPosition]]:
"""
Retrieves all liquidity positions for the given wallet on a specified subnet (netuid).
Calculates associated fee rewards based on current global and tick-level fee data.
Args:
wallet: Wallet instance to fetch positions for.
netuid: Subnet unique id.
block: The blockchain block number for the query.
Returns:
List of liquidity positions, or None if subnet does not exist.
"""
if not self.subnet_exists(netuid=netuid):
logging.debug(f"Subnet {netuid} does not exist.")
return None
if not self.is_subnet_active(netuid=netuid):
logging.debug(f"Subnet {netuid} is not active.")
return None
query = self.substrate.query
block_hash = self.determine_block_hash(block)
# Fetch global fees and current price
fee_global_tao_query = query(
module="Swap",
storage_function="FeeGlobalTao",
params=[netuid],
block_hash=block_hash,
)
fee_global_alpha_query = query(
module="Swap",
storage_function="FeeGlobalAlpha",
params=[netuid],
block_hash=block_hash,
)
sqrt_price_query = query(
module="Swap",
storage_function="AlphaSqrtPrice",
params=[netuid],
block_hash=block_hash,
)
fee_global_tao = fixed_to_float(fee_global_tao_query)
fee_global_alpha = fixed_to_float(fee_global_alpha_query)
sqrt_price = fixed_to_float(sqrt_price_query)
current_tick = price_to_tick(sqrt_price**2)
# Fetch positions
positions_response = self.query_map(
module="Swap",
name="Positions",
block=block,
params=[netuid, wallet.coldkeypub.ss58_address],
)
positions = []
for _, p in positions_response:
position = p.value
tick_low_idx = position["tick_low"][0]
tick_high_idx = position["tick_high"][0]
tick_low = query(
module="Swap",
storage_function="Ticks",
params=[netuid, tick_low_idx],
block_hash=block_hash,
)
tick_high = query(
module="Swap",
storage_function="Ticks",
params=[netuid, tick_high_idx],
block_hash=block_hash,
)
# Calculate fees above/below range for both tokens
tao_below = get_fees(
current_tick=current_tick,
tick=tick_low,
tick_index=tick_low_idx,
quote=True,
global_fees_tao=fee_global_tao,
global_fees_alpha=fee_global_alpha,
above=False,
)
tao_above = get_fees(
current_tick=current_tick,
tick=tick_high,
tick_index=tick_high_idx,
quote=True,
global_fees_tao=fee_global_tao,
global_fees_alpha=fee_global_alpha,
above=True,
)
alpha_below = get_fees(
current_tick=current_tick,
tick=tick_low,
tick_index=tick_low_idx,
quote=False,
global_fees_tao=fee_global_tao,
global_fees_alpha=fee_global_alpha,
above=False,
)
alpha_above = get_fees(
current_tick=current_tick,
tick=tick_high,
tick_index=tick_high_idx,
quote=False,
global_fees_tao=fee_global_tao,
global_fees_alpha=fee_global_alpha,
above=True,
)
# Calculate fees earned by position
fees_tao, fees_alpha = calculate_fees(
position=position,
global_fees_tao=fee_global_tao,
global_fees_alpha=fee_global_alpha,
tao_fees_below_low=tao_below,
tao_fees_above_high=tao_above,
alpha_fees_below_low=alpha_below,
alpha_fees_above_high=alpha_above,
netuid=netuid,
)
positions.append(
LiquidityPosition(
**{
"id": position.get("id")[0],
"price_low": Balance.from_tao(
tick_to_price(position.get("tick_low")[0])
),
"price_high": Balance.from_tao(
tick_to_price(position.get("tick_high")[0])
),
"liquidity": Balance.from_rao(position.get("liquidity")),
"fees_tao": fees_tao,
"fees_alpha": fees_alpha,
"netuid": position.get("netuid"),
}
)
)
return positions
[docs]
def get_neuron_for_pubkey_and_subnet(
self, hotkey_ss58: str, netuid: int, block: Optional[int] = None
) -> Optional["NeuronInfo"]:
"""
Retrieves information about a neuron based on its public key (hotkey SS58 address) and the specific subnet UID
(netuid). This function provides detailed neuron information for a particular subnet within the Bittensor
network.
Arguments:
hotkey_ss58 (str): The ``SS58`` address of the neuron's hotkey.
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[bittensor.core.chain_data.neuron_info.NeuronInfo]: Detailed information about the neuron if found,
``None`` otherwise.
This function is crucial for accessing specific neuron data and understanding its status, stake, and other
attributes within a particular subnet of the Bittensor ecosystem.
"""
block_hash = self.determine_block_hash(block)
uid = self.substrate.query(
module="SubtensorModule",
storage_function="Uids",
params=[netuid, hotkey_ss58],
block_hash=block_hash,
)
if uid is None:
return NeuronInfo.get_null_neuron()
result = self.query_runtime_api(
runtime_api="NeuronInfoRuntimeApi",
method="get_neuron",
params=[netuid, uid.value],
block=block,
)
if not result:
return NeuronInfo.get_null_neuron()
return NeuronInfo.from_dict(result)
[docs]
def get_next_epoch_start_block(
self, netuid: int, block: Optional[int] = None
) -> Optional[int]:
"""
Calculates the first block number of the next epoch for the given subnet.
If `block` is not provided, the current chain block will be used. Epochs are
determined based on the subnet's tempo (i.e., blocks per epoch). The result
is the block number at which the next epoch will begin.
Args:
netuid (int): The unique identifier of the subnet.
block (Optional[int], optional): The reference block to calculate from.
If None, uses the current chain block height.
Returns:
int: The block number at which the next epoch will start.
"""
block = block or self.block
blocks_since_last_step = self.blocks_since_last_step(netuid=netuid, block=block)
tempo = self.tempo(netuid=netuid, block=block)
if block and blocks_since_last_step is not None and tempo:
return block - blocks_since_last_step + tempo + 1
return None
[docs]
def get_owned_hotkeys(
self,
coldkey_ss58: str,
block: Optional[int] = None,
reuse_block: bool = False,
) -> list[str]:
"""
Retrieves all hotkeys owned by a specific coldkey address.
Args:
coldkey_ss58 (str): The SS58 address of the coldkey to query.
block (int): The blockchain block number for the query.
reuse_block (bool): Whether to reuse the last-used blockchain block hash.
Returns:
list[str]: A list of hotkey SS58 addresses owned by the coldkey.
"""
block_hash = self.determine_block_hash(block)
owned_hotkeys = self.substrate.query(
module="SubtensorModule",
storage_function="OwnedHotkeys",
params=[coldkey_ss58],
block_hash=block_hash,
reuse_block_hash=reuse_block,
)
return [decode_account_id(hotkey[0]) for hotkey in owned_hotkeys or []]
[docs]
def get_stake(
self,
coldkey_ss58: str,
hotkey_ss58: str,
netuid: int,
block: Optional[int] = None,
) -> Balance:
"""
Returns the amount of Alpha staked by a specific coldkey to a specific hotkey within a given subnet.
This function retrieves the delegated stake balance, referred to as the 'Alpha' value.
Args:
coldkey_ss58: The SS58 address of the coldkey that delegated the stake. This address owns the stake.
hotkey_ss58: The ss58 address of the hotkey which the stake is on.
netuid: The unique identifier of the subnet to query.
block: The specific block number at which to retrieve the stake information. If None, the current stake at
the latest block is returned. Defaults to ``None``.
Returns:
An object representing the amount of Alpha (TAO ONLY if the subnet's netuid is 0) currently staked from the
specified coldkey to the specified hotkey within the given subnet.
"""
alpha_shares_query = self.query_module(
module="SubtensorModule",
name="Alpha",
block=block,
params=[hotkey_ss58, coldkey_ss58, netuid],
)
alpha_shares = cast(FixedPoint, alpha_shares_query)
hotkey_alpha_obj: ScaleObj = self.query_module(
module="SubtensorModule",
name="TotalHotkeyAlpha",
block=block,
params=[hotkey_ss58, netuid],
)
hotkey_alpha = hotkey_alpha_obj.value
hotkey_shares_query = self.query_module(
module="SubtensorModule",
name="TotalHotkeyShares",
block=block,
params=[hotkey_ss58, netuid],
)
hotkey_shares = cast(FixedPoint, hotkey_shares_query)
alpha_shares_as_float = fixed_to_float(alpha_shares)
hotkey_shares_as_float = fixed_to_float(hotkey_shares)
if hotkey_shares_as_float == 0:
return Balance.from_rao(0).set_unit(netuid=netuid)
stake = alpha_shares_as_float / hotkey_shares_as_float * hotkey_alpha
return Balance.from_rao(int(stake)).set_unit(netuid=netuid)
# TODO: remove unused parameters in SDK.v10
[docs]
def get_stake_add_fee(
self,
amount: Balance,
netuid: int,
coldkey_ss58: str,
hotkey_ss58: str,
block: Optional[int] = None,
) -> Balance:
"""
Calculates the fee for adding new stake to a hotkey.
Args:
amount: Amount of stake to add in TAO
netuid: Netuid of subnet
coldkey_ss58: SS58 address of coldkey
hotkey_ss58: SS58 address of hotkey
block: Block number at which to perform the calculation
Returns:
The calculated stake fee as a Balance object
"""
return self.get_stake_operations_fee(amount=amount, netuid=netuid, block=block)
[docs]
def get_subnet_info(
self, netuid: int, block: Optional[int] = None
) -> Optional["SubnetInfo"]:
"""
Retrieves detailed information about subnet within the Bittensor network.
This function provides comprehensive data on subnet, including its characteristics and operational parameters.
Arguments:
netuid: The unique identifier of the subnet.
block: The blockchain block number for the query.
Returns:
SubnetInfo: A SubnetInfo objects, each containing detailed information about a subnet.
Gaining insights into the subnet's details assists in understanding the network's composition, the roles of
different subnets, and their unique features.
"""
result = self.query_runtime_api(
runtime_api="SubnetInfoRuntimeApi",
method="get_subnet_info_v2",
params=[netuid],
block=block,
)
if not result:
return None
return SubnetInfo.from_dict(result)
[docs]
def get_subnet_price(
self,
netuid: int,
block: Optional[int] = None,
) -> Balance:
"""Gets the current Alpha price in TAO for all subnets.
Arguments:
netuid: The unique identifier of the subnet.
block: The blockchain block number for the query.
Returns:
The current Alpha price in TAO units for the specified subnet.
"""
# SN0 price is always 1 TAO
if netuid == 0:
return Balance.from_tao(1)
block_hash = self.determine_block_hash(block=block)
current_sqrt_price = self.substrate.query(
module="Swap",
storage_function="AlphaSqrtPrice",
params=[netuid],
block_hash=block_hash,
)
current_sqrt_price = fixed_to_float(current_sqrt_price)
current_price = current_sqrt_price * current_sqrt_price
return Balance.from_rao(int(current_price * 1e9))
[docs]
def get_subnet_prices(
self,
block: Optional[int] = None,
) -> dict[int, Balance]:
"""Gets the current Alpha price in TAO for a specified subnet.
Args:
block: The blockchain block number for the query. Default to `None`.
Returns:
dict:
- subnet unique ID
- The current Alpha price in TAO units for the specified subnet.
"""
block_hash = self.determine_block_hash(block=block)
current_sqrt_prices = self.substrate.query_map(
module="Swap",
storage_function="AlphaSqrtPrice",
block_hash=block_hash,
page_size=129, # total number of subnets
)
prices = {}
for id_, current_sqrt_price in current_sqrt_prices:
current_sqrt_price = fixed_to_float(current_sqrt_price)
current_price = current_sqrt_price * current_sqrt_price
current_price_in_tao = Balance.from_rao(int(current_price * 1e9))
prices.update({id_: current_price_in_tao})
# SN0 price is always 1 TAO
prices.update({0: Balance.from_tao(1)})
return prices
# TODO: remove unused parameters in SDK.v10
[docs]
def get_unstake_fee(
self,
amount: Balance,
netuid: int,
coldkey_ss58: str,
hotkey_ss58: str,
block: Optional[int] = None,
) -> Balance:
"""
Calculates the fee for unstaking from a hotkey.
Args:
amount: Amount of stake to unstake in TAO
netuid: Netuid of subnet
coldkey_ss58: SS58 address of coldkey
hotkey_ss58: SS58 address of hotkey
block: Block number at which to perform the calculation
Returns:
The calculated stake fee as a Balance object
"""
return self.get_stake_operations_fee(amount=amount, netuid=netuid, block=block)
# TODO: remove unused parameters in SDK.v10
[docs]
def get_stake_movement_fee(
self,
amount: Balance,
origin_netuid: int,
origin_hotkey_ss58: str,
origin_coldkey_ss58: str,
destination_netuid: int,
destination_hotkey_ss58: str,
destination_coldkey_ss58: str,
block: Optional[int] = None,
) -> Balance:
"""
Calculates the fee for moving stake between hotkeys/subnets/coldkeys.
Args:
amount: Amount of stake to move in TAO
origin_netuid: Netuid of origin subnet
origin_hotkey_ss58: SS58 address of origin hotkey
origin_coldkey_ss58: SS58 address of origin coldkey
destination_netuid: Netuid of destination subnet
destination_hotkey_ss58: SS58 address of destination hotkey
destination_coldkey_ss58: SS58 address of destination coldkey
block: Block number at which to perform the calculation
Returns:
The calculated stake fee as a Balance object
"""
return self.get_stake_operations_fee(
amount=amount, netuid=origin_netuid, block=block
)
[docs]
def get_stake_for_coldkey_and_hotkey(
self,
coldkey_ss58: str,
hotkey_ss58: str,
netuids: Optional[list[int]] = None,
block: Optional[int] = None,
) -> dict[int, StakeInfo]:
"""
Retrieves all coldkey-hotkey pairing stake across specified (or all) subnets
Arguments:
coldkey_ss58 (str): The SS58 address of the coldkey.
hotkey_ss58 (str): The SS58 address of the hotkey.
netuids (Optional[list[int]]): The subnet IDs to query for. Set to `None` for all subnets.
block (Optional[int]): The block number at which to query the stake information.
Returns:
A {netuid: StakeInfo} pairing of all stakes across all subnets.
"""
if netuids is None:
all_netuids = self.get_subnets(block=block)
else:
all_netuids = netuids
results = [
self.query_runtime_api(
"StakeInfoRuntimeApi",
"get_stake_info_for_hotkey_coldkey_netuid",
params=[hotkey_ss58, coldkey_ss58, netuid],
block=block,
)
for netuid in all_netuids
]
return {
netuid: StakeInfo.from_dict(result)
for (netuid, result) in zip(all_netuids, results)
}
[docs]
def get_stake_for_coldkey(
self, coldkey_ss58: str, block: Optional[int] = None
) -> list["StakeInfo"]:
"""
Retrieves the stake information for a given coldkey.
Args:
coldkey_ss58 (str): The SS58 address of the coldkey.
block (Optional[int]): The block number at which to query the stake information.
Returns:
Optional[list[StakeInfo]]: A list of StakeInfo objects, or ``None`` if no stake information is found.
"""
result = self.query_runtime_api(
runtime_api="StakeInfoRuntimeApi",
method="get_stake_info_for_coldkey",
params=[coldkey_ss58], # type: ignore
block=block,
)
if result is None:
return []
stakes = StakeInfo.list_from_dicts(result) # type: ignore
return [stake for stake in stakes if stake.stake > 0]
get_stake_info_for_coldkey = get_stake_for_coldkey
[docs]
def get_stake_for_hotkey(
self, hotkey_ss58: str, netuid: int, block: Optional[int] = None
) -> Balance:
"""
Retrieves the stake information for a given hotkey.
Args:
hotkey_ss58: The SS58 address of the hotkey.
netuid: The subnet ID to query for.
block: The block number at which to query the stake information. Do not specify if also specifying
block_hash or reuse_block
"""
hotkey_alpha_query = self.query_subtensor(
name="TotalHotkeyAlpha", params=[hotkey_ss58, netuid], block=block
)
hotkey_alpha = cast(ScaleObj, hotkey_alpha_query)
balance = Balance.from_rao(hotkey_alpha.value)
balance.set_unit(netuid=netuid)
return balance
get_hotkey_stake = get_stake_for_hotkey
[docs]
def get_stake_operations_fee(
self,
amount: Balance,
netuid: int,
block: Optional[int] = None,
):
"""Returns fee for any stake operation in specified subnet.
Args:
amount: Amount of stake to add in Alpha/TAO.
netuid: Netuid of subnet.
block: Block number at which to perform the calculation.
Returns:
The calculated stake fee as a Balance object.
"""
block_hash = self.determine_block_hash(block=block)
result = self.substrate.query(
module="Swap",
storage_function="FeeRate",
params=[netuid],
block_hash=block_hash,
)
return amount * (result.value / U16_MAX)
[docs]
def get_subnet_burn_cost(self, block: Optional[int] = None) -> Optional[Balance]:
"""
Retrieves the burn cost for registering a new subnet within the Bittensor network. This cost represents the
amount of Tao that needs to be locked or burned to establish a new subnet.
Arguments:
block (Optional[int]): The blockchain block number for the query.
Returns:
int: The burn cost for subnet registration.
The subnet burn cost is an important economic parameter, reflecting the network's mechanisms for controlling
the proliferation of subnets and ensuring their commitment to the network's long-term viability.
"""
lock_cost = self.query_runtime_api(
runtime_api="SubnetRegistrationRuntimeApi",
method="get_network_registration_cost",
params=[],
block=block,
)
if lock_cost is not None:
return Balance.from_rao(lock_cost)
else:
return lock_cost
[docs]
def get_subnet_hyperparameters(
self, netuid: int, block: Optional[int] = None
) -> Optional[Union[list, "SubnetHyperparameters"]]:
"""
Retrieves the hyperparameters for a specific subnet within the Bittensor network. These hyperparameters define
the operational settings and rules governing the subnet's behavior.
Arguments:
netuid (int): The network UID of the subnet to query.
block (Optional[int]): The blockchain block number for the query.
Returns:
The subnet's hyperparameters, or `None` if not available.
Understanding the hyperparameters is crucial for comprehending how subnets are configured and managed, and how
they interact with the network's consensus and incentive mechanisms.
"""
result = self.query_runtime_api(
runtime_api="SubnetInfoRuntimeApi",
method="get_subnet_hyperparams_v2",
params=[netuid],
block=block,
)
if not result:
return None
return SubnetHyperparameters.from_dict(result)
[docs]
def get_subnet_reveal_period_epochs(
self, netuid: int, block: Optional[int] = None
) -> int:
"""Retrieve the SubnetRevealPeriodEpochs hyperparameter."""
return cast(
int,
self.get_hyperparameter(
param_name="RevealPeriodEpochs", block=block, netuid=netuid
),
)
[docs]
def get_subnets(self, block: Optional[int] = None) -> list[int]:
"""
Retrieves the list of all subnet unique identifiers (netuids) currently present in the Bittensor network.
Arguments:
block (Optional[int]): The blockchain block number for the query.
Returns:
A list of subnet netuids.
This function provides a comprehensive view of the subnets within the Bittensor network,
offering insights into its diversity and scale.
"""
result = self.substrate.query_map(
module="SubtensorModule",
storage_function="NetworksAdded",
block_hash=self.determine_block_hash(block),
)
subnets = []
if result.records:
for netuid, exists in result:
if exists:
subnets.append(netuid)
return subnets
[docs]
def get_total_subnets(self, block: Optional[int] = None) -> Optional[int]:
"""
Retrieves the total number of subnets within the Bittensor network as of a specific blockchain block.
Arguments:
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[str]: The total number of subnets in the network.
Understanding the total number of subnets is essential for assessing the network's growth and the extent of its
decentralized infrastructure.
"""
result = self.substrate.query(
module="SubtensorModule",
storage_function="TotalNetworks",
params=[],
block_hash=self.determine_block_hash(block),
)
return getattr(result, "value", None)
[docs]
def get_transfer_fee(self, wallet: "Wallet", dest: str, value: Balance) -> Balance:
"""
Calculates the transaction fee for transferring tokens from a wallet to a specified destination address. This
function simulates the transfer to estimate the associated cost, taking into account the current network
conditions and transaction complexity.
Arguments:
wallet (bittensor_wallet.Wallet): The wallet from which the transfer is initiated.
dest (str): The ``SS58`` address of the destination account.
value (Union[bittensor.utils.balance.Balance, float, int]): The amount of tokens to be transferred,
specified as a Balance object, or in Tao (float) or Rao (int) units.
Returns:
bittensor.utils.balance.Balance: The estimated transaction fee for the transfer, represented as a Balance
object.
Estimating the transfer fee is essential for planning and executing token transactions, ensuring that the wallet
has sufficient funds to cover both the transfer amount and the associated costs. This function provides a
crucial tool for managing financial operations within the Bittensor network.
"""
value = check_and_convert_to_balance(value)
call = self.substrate.compose_call(
call_module="Balances",
call_function="transfer_keep_alive",
call_params={"dest": dest, "value": value.rao},
)
try:
payment_info = self.substrate.get_payment_info(
call=call, keypair=wallet.coldkeypub
)
except Exception as e:
logging.error(f":cross_mark: [red]Failed to get payment info: [/red]{e}")
payment_info = {"partial_fee": int(2e7)} # assume 0.02 Tao
return Balance.from_rao(payment_info["partial_fee"])
[docs]
def get_vote_data(
self, proposal_hash: str, block: Optional[int] = None
) -> Optional["ProposalVoteData"]:
"""
Retrieves the voting data for a specific proposal on the Bittensor blockchain. This data includes information
about how senate members have voted on the proposal.
Arguments:
proposal_hash (str): The hash of the proposal for which voting data is requested.
block (Optional[int]): The blockchain block number for the query.
Returns:
An object containing the proposal's voting data, or `None` if not found.
This function is important for tracking and understanding the decision-making processes within the Bittensor
network, particularly how proposals are received and acted upon by the governing body.
"""
vote_data: dict[str, Any] = self.substrate.query(
module="Triumvirate",
storage_function="Voting",
params=[proposal_hash],
block_hash=self.determine_block_hash(block),
)
if vote_data is None:
return None
return ProposalVoteData.from_dict(vote_data)
[docs]
def get_uid_for_hotkey_on_subnet(
self, hotkey_ss58: str, netuid: int, block: Optional[int] = None
) -> Optional[int]:
"""
Retrieves the unique identifier (UID) for a neuron's hotkey on a specific subnet.
Arguments:
hotkey_ss58 (str): The ``SS58`` address of the neuron's hotkey.
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The UID of the neuron if it is registered on the subnet, ``None`` otherwise.
The UID is a critical identifier within the network, linking the neuron's hotkey to its operational and
governance activities on a particular subnet.
"""
result = self.substrate.query(
module="SubtensorModule",
storage_function="Uids",
params=[netuid, hotkey_ss58],
block_hash=self.determine_block_hash(block),
)
return getattr(result, "value", result)
[docs]
def filter_netuids_by_registered_hotkeys(
self,
all_netuids: Iterable[int],
filter_for_netuids: Iterable[int],
all_hotkeys: Iterable["Wallet"],
block: Optional[int],
) -> list[int]:
"""
Filters a given list of all netuids for certain specified netuids and hotkeys
Arguments:
all_netuids (Iterable[int]): A list of netuids to filter.
filter_for_netuids (Iterable[int]): A subset of all_netuids to filter from the main list.
all_hotkeys (Iterable[Wallet]): Hotkeys to filter from the main list.
block (Optional[int]): The blockchain block number for the query.
Returns:
The filtered list of netuids.
"""
self._get_block_hash(block) # just used to cache the block hash
netuids_with_registered_hotkeys = [
item
for sublist in [
self.get_netuids_for_hotkey(
wallet.hotkey.ss58_address,
block=block,
)
for wallet in all_hotkeys
]
for item in sublist
]
if not filter_for_netuids:
all_netuids = netuids_with_registered_hotkeys
else:
filtered_netuids = [
netuid for netuid in all_netuids if netuid in filter_for_netuids
]
registered_hotkeys_filtered = [
netuid
for netuid in netuids_with_registered_hotkeys
if netuid in filter_for_netuids
]
# Combine both filtered lists
all_netuids = filtered_netuids + registered_hotkeys_filtered
return list(set(all_netuids))
[docs]
def immunity_period(
self, netuid: int, block: Optional[int] = None
) -> Optional[int]:
"""
Retrieves the 'ImmunityPeriod' hyperparameter for a specific subnet. This parameter defines the duration during
which new neurons are protected from certain network penalties or restrictions.
Args:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The value of the 'ImmunityPeriod' hyperparameter if the subnet exists, ``None`` otherwise.
The 'ImmunityPeriod' is a critical aspect of the network's governance system, ensuring that new participants
have a grace period to establish themselves and contribute to the network without facing immediate
punitive actions.
"""
call = self.get_hyperparameter(
param_name="ImmunityPeriod", netuid=netuid, block=block
)
return None if call is None else int(call)
[docs]
def is_fast_blocks(self):
"""Returns True if the node is running with fast blocks. False if not."""
return self.query_constant("SubtensorModule", "DurationOfStartCall").value == 10
[docs]
def is_hotkey_delegate(self, hotkey_ss58: str, block: Optional[int] = None) -> bool:
"""
Determines whether a given hotkey (public key) is a delegate on the Bittensor network. This function checks if
the neuron associated with the hotkey is part of the network's delegation system.
Arguments:
hotkey_ss58 (str): The SS58 address of the neuron's hotkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
`True` if the hotkey is a delegate, `False` otherwise.
Being a delegate is a significant status within the Bittensor network, indicating a neuron's involvement in
consensus and governance processes.
"""
delegates = self.get_delegates(block)
return hotkey_ss58 in [info.hotkey_ss58 for info in delegates]
[docs]
def is_hotkey_registered(
self,
hotkey_ss58: str,
netuid: Optional[int] = None,
block: Optional[int] = None,
) -> bool:
"""
Determines whether a given hotkey (public key) is registered in the Bittensor network, either globally across
any subnet or specifically on a specified subnet. This function checks the registration status of a neuron
identified by its hotkey, which is crucial for validating its participation and activities within the
network.
Args:
hotkey_ss58: The SS58 address of the neuron's hotkey.
netuid: The unique identifier of the subnet to check the registration. If `None`, the
registration is checked across all subnets.
block: The blockchain block number at which to perform the query.
Returns:
bool: `True` if the hotkey is registered in the specified context (either any subnet or a specific subnet),
`False` otherwise.
This function is important for verifying the active status of neurons in the Bittensor network. It aids in
understanding whether a neuron is eligible to participate in network processes such as consensus,
validation, and incentive distribution based on its registration status.
"""
if netuid is None:
return self.is_hotkey_registered_any(hotkey_ss58, block)
else:
return self.is_hotkey_registered_on_subnet(hotkey_ss58, netuid, block)
[docs]
def is_hotkey_registered_any(
self,
hotkey_ss58: str,
block: Optional[int] = None,
) -> bool:
"""
Checks if a neuron's hotkey is registered on any subnet within the Bittensor network.
Arguments:
hotkey_ss58 (str): The ``SS58`` address of the neuron's hotkey.
block (Optional[int]): The blockchain block number for the query.
Returns:
bool: ``True`` if the hotkey is registered on any subnet, False otherwise.
This function is essential for determining the network-wide presence and participation of a neuron.
"""
hotkeys = self.get_netuids_for_hotkey(hotkey_ss58, block)
return len(hotkeys) > 0
[docs]
def is_hotkey_registered_on_subnet(
self, hotkey_ss58: str, netuid: int, block: Optional[int] = None
) -> bool:
"""Checks if the hotkey is registered on a given netuid."""
return (
self.get_uid_for_hotkey_on_subnet(hotkey_ss58, netuid, block=block)
is not None
)
[docs]
def is_subnet_active(self, netuid: int, block: Optional[int] = None) -> bool:
"""Verify if subnet with provided netuid is active.
Args:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
True if subnet is active, False otherwise.
This means whether the `start_call` was initiated or not.
"""
query = self.query_subtensor(
name="FirstEmissionBlockNumber",
block=block,
params=[netuid],
)
return True if query and query.value > 0 else False
[docs]
def last_drand_round(self) -> Optional[int]:
"""
Retrieves the last drand round emitted in bittensor. This corresponds when committed weights will be revealed.
Returns:
int: The latest Drand round emitted in bittensor.
"""
result = self.substrate.query(
module="Drand", storage_function="LastStoredRound"
)
return getattr(result, "value", None)
[docs]
def max_weight_limit(
self, netuid: int, block: Optional[int] = None
) -> Optional[float]:
"""
Returns network MaxWeightsLimit hyperparameter.
Args:
netuid (int): The unique identifier of the subnetwork.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[float]: The value of the MaxWeightsLimit hyperparameter, or ``None`` if the subnetwork does not
exist or the parameter is not found.
"""
call = self.get_hyperparameter(
param_name="MaxWeightsLimit", netuid=netuid, block=block
)
return None if call is None else u16_normalized_float(int(call))
[docs]
def min_allowed_weights(
self, netuid: int, block: Optional[int] = None
) -> Optional[int]:
"""
Returns network MinAllowedWeights hyperparameter.
Args:
netuid (int): The unique identifier of the subnetwork.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The value of the MinAllowedWeights hyperparameter, or ``None`` if the subnetwork does not
exist or the parameter is not found.
"""
call = self.get_hyperparameter(
param_name="MinAllowedWeights", netuid=netuid, block=block
)
return None if call is None else int(call)
[docs]
def neuron_for_uid(
self, uid: int, netuid: int, block: Optional[int] = None
) -> "NeuronInfo":
"""
Retrieves detailed information about a specific neuron identified by its unique identifier (UID) within a
specified subnet (netuid) of the Bittensor network. This function provides a comprehensive view of a
neuron's attributes, including its stake, rank, and operational status.
Arguments:
uid (int): The unique identifier of the neuron.
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
Detailed information about the neuron if found, a null neuron otherwise
This function is crucial for analyzing individual neurons' contributions and status within a specific subnet,
offering insights into their roles in the network's consensus and validation mechanisms.
"""
if uid is None:
return NeuronInfo.get_null_neuron()
result = self.query_runtime_api(
runtime_api="NeuronInfoRuntimeApi",
method="get_neuron",
params=[netuid, uid],
block=block,
)
if not result:
return NeuronInfo.get_null_neuron()
return NeuronInfo.from_dict(result)
[docs]
def neurons(self, netuid: int, block: Optional[int] = None) -> list["NeuronInfo"]:
"""
Retrieves a list of all neurons within a specified subnet of the Bittensor network.
This function provides a snapshot of the subnet's neuron population, including each neuron's attributes and
network interactions.
Arguments:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
A list of NeuronInfo objects detailing each neuron's characteristics in the subnet.
Understanding the distribution and status of neurons within a subnet is key to comprehending the network's
decentralized structure and the dynamics of its consensus and governance processes.
"""
result = self.query_runtime_api(
runtime_api="NeuronInfoRuntimeApi",
method="get_neurons",
params=[netuid],
block=block,
)
if not result:
return []
return NeuronInfo.list_from_dicts(result)
[docs]
def neurons_lite(
self, netuid: int, block: Optional[int] = None
) -> list["NeuronInfoLite"]:
"""
Retrieves a list of neurons in a 'lite' format from a specific subnet of the Bittensor network.
This function provides a streamlined view of the neurons, focusing on key attributes such as stake and network
participation.
Arguments:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
A list of simplified neuron information for the subnet.
This function offers a quick overview of the neuron population within a subnet, facilitating efficient analysis
of the network's decentralized structure and neuron dynamics.
"""
result = self.query_runtime_api(
runtime_api="NeuronInfoRuntimeApi",
method="get_neurons_lite",
params=[netuid],
block=block,
)
if not result:
return []
return NeuronInfoLite.list_from_dicts(result)
[docs]
def query_identity(
self, coldkey_ss58: str, block: Optional[int] = None
) -> Optional[ChainIdentity]:
"""
Queries the identity of a neuron on the Bittensor blockchain using the given key. This function retrieves
detailed identity information about a specific neuron, which is a crucial aspect of the network's
decentralized identity and governance system.
Arguments:
coldkey_ss58 (str): The coldkey used to query the neuron's identity (technically the neuron's coldkey SS58
address).
block (Optional[int]): The blockchain block number for the query.
Returns:
An object containing the identity information of the neuron if found, ``None`` otherwise.
The identity information can include various attributes such as the neuron's stake, rank, and other
network-specific details, providing insights into the neuron's role and status within the Bittensor network.
Note:
See the `Bittensor CLI documentation <https://docs.bittensor.com/reference/btcli>`_ for supported identity
parameters.
"""
identity_info = cast(
dict,
self.substrate.query(
module="SubtensorModule",
storage_function="IdentitiesV2",
params=[coldkey_ss58],
block_hash=self.determine_block_hash(block),
),
)
if not identity_info:
return None
try:
return ChainIdentity.from_dict(
decode_hex_identity_dict(identity_info),
)
except TypeError:
return None
[docs]
def recycle(self, netuid: int, block: Optional[int] = None) -> Optional[Balance]:
"""
Retrieves the 'Burn' hyperparameter for a specified subnet. The 'Burn' parameter represents the amount of Tao
that is effectively recycled within the Bittensor network.
Args:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[Balance]: The value of the 'Burn' hyperparameter if the subnet exists, None otherwise.
Understanding the 'Burn' rate is essential for analyzing the network registration usage, particularly how it is
correlated with user activity and the overall cost of participation in a given subnet.
"""
call = self.get_hyperparameter(param_name="Burn", netuid=netuid, block=block)
return None if call is None else Balance.from_rao(int(call))
[docs]
def set_reveal_commitment(
self,
wallet,
netuid: int,
data: str,
blocks_until_reveal: int = 360,
block_time: Union[int, float] = 12,
period: Optional[int] = None,
) -> tuple[bool, int]:
"""
Commits arbitrary data to the Bittensor network by publishing metadata.
Arguments:
wallet (bittensor_wallet.Wallet): The wallet associated with the neuron committing the data.
netuid (int): The unique identifier of the subnetwork.
data (str): The data to be committed to the network.
blocks_until_reveal (int): The number of blocks from now after which the data will be revealed. Defaults to
`360`. Then number of blocks in one epoch.
block_time (Union[int, float]): The number of seconds between each block. Defaults to `12`.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: `True` if the commitment was successful, `False` otherwise.
Note: A commitment can be set once per subnet epoch and is reset at the next epoch in the chain automatically.
"""
encrypted, reveal_round = get_encrypted_commitment(
data, blocks_until_reveal, block_time
)
# increase reveal_round in return + 1 because we want to fetch data from the chain after that round was revealed
# and stored.
data_ = {"encrypted": encrypted, "reveal_round": reveal_round}
return publish_metadata(
subtensor=self,
wallet=wallet,
netuid=netuid,
data_type="TimelockEncrypted",
data=data_,
period=period,
), reveal_round
[docs]
def subnet(self, netuid: int, block: Optional[int] = None) -> Optional[DynamicInfo]:
"""
Retrieves the subnet information for a single subnet in the network.
Args:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The block number to query the subnet information from.
Returns:
Optional[DynamicInfo]: A DynamicInfo object, containing detailed information about a subnet.
"""
block_hash = self.determine_block_hash(block=block)
query = self.substrate.runtime_call(
api="SubnetInfoRuntimeApi",
method="get_dynamic_info",
params=[netuid],
block_hash=block_hash,
)
if isinstance(decoded := query.decode(), dict):
try:
price = self.get_subnet_price(netuid=netuid, block=block)
except SubstrateRequestException:
price = None
return DynamicInfo.from_dict({**decoded, "price": price})
return None
[docs]
def subnet_exists(self, netuid: int, block: Optional[int] = None) -> bool:
"""
Checks if a subnet with the specified unique identifier (netuid) exists within the Bittensor network.
Arguments:
netuid (int): The unique identifier of the subnet.
block (Optional[int]): The blockchain block number for the query.
Returns:
`True` if the subnet exists, `False` otherwise.
This function is critical for verifying the presence of specific subnets in the network,
enabling a deeper understanding of the network's structure and composition.
"""
result = self.substrate.query(
module="SubtensorModule",
storage_function="NetworksAdded",
params=[netuid],
block_hash=self.determine_block_hash(block),
)
return getattr(result, "value", False)
[docs]
def subnetwork_n(self, netuid: int, block: Optional[int] = None) -> Optional[int]:
"""
Returns network SubnetworkN hyperparameter.
Args:
netuid (int): The unique identifier of the subnetwork.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The value of the SubnetworkN hyperparameter, or ``None`` if the subnetwork does not exist or
the parameter is not found.
"""
call = self.get_hyperparameter(
param_name="SubnetworkN", netuid=netuid, block=block
)
return None if call is None else int(call)
[docs]
def tempo(self, netuid: int, block: Optional[int] = None) -> Optional[int]:
"""
Returns network Tempo hyperparameter.
Args:
netuid (int): The unique identifier of the subnetwork.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The value of the Tempo hyperparameter, or ``None`` if the subnetwork does not exist or the
parameter is not found.
"""
call = self.get_hyperparameter(param_name="Tempo", netuid=netuid, block=block)
return None if call is None else int(call)
[docs]
def tx_rate_limit(self, block: Optional[int] = None) -> Optional[int]:
"""
Retrieves the transaction rate limit for the Bittensor network as of a specific blockchain block.
This rate limit sets the maximum number of transactions that can be processed within a given time frame.
Args:
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The transaction rate limit of the network, None if not available.
The transaction rate limit is an essential parameter for ensuring the stability and scalability of the Bittensor
network. It helps in managing network load and preventing congestion, thereby maintaining efficient and
timely transaction processing.
"""
result = self.query_subtensor("TxRateLimit", block=block)
return getattr(result, "value", None)
[docs]
def wait_for_block(self, block: Optional[int] = None):
"""
Waits until a specific block is reached on the chain. If no block is specified,
waits for the next block.
Args:
block (Optional[int]): The block number to wait for. If None, waits for the next block.
Returns:
bool: True if the target block was reached, False if timeout occurred.
Example:
import bittensor as bt
subtensor = bt.Subtensor()
subtensor.wait_for_block() # Waits for the next block
subtensor.wait_for_block(block=1234) # Waits for a specific block
"""
def handler(block_data: dict):
logging.debug(
f"reached block {block_data['header']['number']}. Waiting for block {target_block}"
)
if block_data["header"]["number"] >= target_block:
return True
return None
current_block = self.substrate.get_block()
current_block_hash = current_block.get("header", {}).get("hash")
if block is not None:
target_block = block
else:
target_block = current_block["header"]["number"] + 1
self.substrate.get_block_handler(
current_block_hash, header_only=True, subscription_handler=handler
)
return True
[docs]
def weights(
self, netuid: int, block: Optional[int] = None
) -> list[tuple[int, list[tuple[int, int]]]]:
"""
Retrieves the weight distribution set by neurons within a specific subnet of the Bittensor network.
This function maps each neuron's UID to the weights it assigns to other neurons, reflecting the network's trust
and value assignment mechanisms.
Arguments:
netuid (int): The network UID of the subnet to query.
block (Optional[int]): Block number for synchronization, or ``None`` for the latest block.
Returns:
A list of tuples mapping each neuron's UID to its assigned weights.
The weight distribution is a key factor in the network's consensus algorithm and the ranking of neurons,
influencing their influence and reward allocation within the subnet.
"""
w_map_encoded = self.substrate.query_map(
module="SubtensorModule",
storage_function="Weights",
params=[netuid],
block_hash=self.determine_block_hash(block),
)
w_map = [(uid, w.value or []) for uid, w in w_map_encoded]
return w_map
[docs]
def weights_rate_limit(
self, netuid: int, block: Optional[int] = None
) -> Optional[int]:
"""
Returns network WeightsSetRateLimit hyperparameter.
Arguments:
netuid (int): The unique identifier of the subnetwork.
block (Optional[int]): The blockchain block number for the query.
Returns:
Optional[int]: The value of the WeightsSetRateLimit hyperparameter, or ``None`` if the subnetwork does not
exist or the parameter is not found.
"""
call = self.get_hyperparameter(
param_name="WeightsSetRateLimit", netuid=netuid, block=block
)
return None if call is None else int(call)
[docs]
def get_timestamp(self, block: Optional[int] = None) -> datetime:
"""
Retrieves the datetime timestamp for a given block
Arguments:
block: The blockchain block number for the query.
Returns:
datetime object for the timestamp of the block
"""
unix = cast(ScaleObj, self.query_module("Timestamp", "Now", block=block)).value
return datetime.fromtimestamp(unix / 1000, tz=timezone.utc)
[docs]
def get_subnet_owner_hotkey(
self, netuid: int, block: Optional[int] = None
) -> Optional[str]:
"""
Retrieves the hotkey of the subnet owner for a given network UID.
This function queries the subtensor network to fetch the hotkey of the owner of a subnet specified by its
netuid. If no data is found or the query fails, the function returns None.
Arguments:
netuid: The network UID of the subnet to fetch the owner's hotkey for.
block: The specific block number to query the data from.
Returns:
The hotkey of the subnet owner if available; None otherwise.
"""
return self.query_subtensor(
name="SubnetOwnerHotkey", params=[netuid], block=block
)
[docs]
def get_subnet_validator_permits(
self, netuid: int, block: Optional[int] = None
) -> Optional[list[bool]]:
"""
Retrieves the list of validator permits for a given subnet as boolean values.
Arguments:
netuid: The unique identifier of the subnetwork.
block: The blockchain block number for the query.
Returns:
A list of boolean values representing validator permits, or None if not available.
"""
query = self.query_subtensor(
name="ValidatorPermit",
params=[netuid],
block=block,
)
return query.value if query is not None and hasattr(query, "value") else query
# Extrinsics helper ================================================================================================
[docs]
def sign_and_send_extrinsic(
self,
call: "GenericCall",
wallet: "Wallet",
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
sign_with: str = "coldkey",
use_nonce: bool = False,
period: Optional[int] = None,
nonce_key: str = "hotkey",
raise_error: bool = False,
) -> tuple[bool, str]:
"""
Helper method to sign and submit an extrinsic call to chain.
Arguments:
call (scalecodec.types.GenericCall): a prepared Call object
wallet (bittensor_wallet.Wallet): the wallet whose coldkey will be used to sign the extrinsic
wait_for_inclusion (bool): whether to wait until the extrinsic call is included on the chain
wait_for_finalization (bool): whether to wait until the extrinsic call is finalized on the chain
sign_with (str): the wallet's keypair to use for the signing. Options are "coldkey", "hotkey", "coldkeypub"
use_nonce (bool): unique identifier for the transaction related with hot/coldkey.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
nonce_key: the type on nonce to use. Options are "hotkey" or "coldkey".
raise_error: raises the relevant exception rather than returning `False` if unsuccessful.
Returns:
(success, error message)
Raises:
SubstrateRequestException: Substrate request exception.
"""
possible_keys = ("coldkey", "hotkey", "coldkeypub")
if sign_with not in possible_keys:
raise AttributeError(
f"'sign_with' must be either 'coldkey', 'hotkey' or 'coldkeypub', not '{sign_with}'"
)
signing_keypair = getattr(wallet, sign_with)
extrinsic_data = {"call": call, "keypair": signing_keypair}
if use_nonce:
if nonce_key not in possible_keys:
raise AttributeError(
f"'nonce_key' must be either 'coldkey', 'hotkey' or 'coldkeypub', not '{nonce_key}'"
)
next_nonce = self.substrate.get_account_next_index(
getattr(wallet, nonce_key).ss58_address
)
extrinsic_data["nonce"] = next_nonce
if period is not None:
extrinsic_data["era"] = {"period": period}
extrinsic = self.substrate.create_signed_extrinsic(**extrinsic_data)
try:
response = self.substrate.submit_extrinsic(
extrinsic,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
)
# We only wait here if we expect finalization.
if not wait_for_finalization and not wait_for_inclusion:
message = "Not waiting for finalization or inclusion."
logging.debug(f"{message}. Extrinsic: {extrinsic}")
return True, message
if response.is_success:
return True, ""
if raise_error:
raise ChainError.from_error(response.error_message)
return False, format_error_message(response.error_message)
except SubstrateRequestException as e:
if raise_error:
raise
return False, format_error_message(e)
# Extrinsics =======================================================================================================
[docs]
def add_stake(
self,
wallet: "Wallet",
hotkey_ss58: Optional[str] = None,
netuid: Optional[int] = None,
amount: Optional[Balance] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
safe_staking: bool = False,
allow_partial_stake: bool = False,
rate_tolerance: float = 0.005,
period: Optional[int] = None,
) -> bool:
"""
Adds a stake from the specified wallet to the neuron identified by the SS58 address of its hotkey in specified
subnet. Staking is a fundamental process in the Bittensor network that enables neurons to participate
actively and earn incentives.
Args:
wallet: The wallet to be used for staking.
hotkey_ss58: The SS58 address of the hotkey associated with the neuron to which you intend to delegate your
stake. If not specified, the wallet's hotkey will be used. Defaults to ``None``.
netuid: The unique identifier of the subnet to which the neuron belongs.
amount: The amount of TAO to stake.
wait_for_inclusion: Waits for the transaction to be included in a block. Defaults to ``True``.
wait_for_finalization: Waits for the transaction to be finalized on the blockchain. Defaults to ``False``.
safe_staking: If true, enables price safety checks to protect against fluctuating prices. The stake will
only execute if the price change doesn't exceed the rate tolerance. Default is ``False``.
allow_partial_stake: If true and safe_staking is enabled, allows partial staking when the full amount would
exceed the price tolerance. If false, the entire stake fails if it would exceed the tolerance.
Default is ``False``.
rate_tolerance: The maximum allowed price change ratio when staking. For example,
0.005 = 0.5% maximum price increase. Only used when safe_staking is True. Default is ``0.005``.
period: The number of blocks during which the transaction will remain valid after it's submitted. If the
transaction is not included in a block within that number of blocks, it will expire and be rejected. You
can think of it as an expiration date for the transaction. Defaults to ``None``.
Returns:
bool: True if the staking is successful, False otherwise.
This function enables neurons to increase their stake in the network, enhancing their influence and potential
rewards in line with Bittensor's consensus and reward mechanisms.
When safe_staking is enabled, it provides protection against price fluctuations during the time stake is
executed and the time it is actually processed by the chain.
"""
amount = check_and_convert_to_balance(amount)
return add_stake_extrinsic(
subtensor=self,
wallet=wallet,
hotkey_ss58=hotkey_ss58,
netuid=netuid,
amount=amount,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
safe_staking=safe_staking,
allow_partial_stake=allow_partial_stake,
rate_tolerance=rate_tolerance,
period=period,
)
[docs]
def add_liquidity(
self,
wallet: "Wallet",
netuid: int,
liquidity: Balance,
price_low: Balance,
price_high: Balance,
hotkey: Optional[str] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""
Adds liquidity to the specified price range.
Arguments:
wallet: The wallet used to sign the extrinsic (must be unlocked).
netuid: The UID of the target subnet for which the call is being initiated.
liquidity: The amount of liquidity to be added.
price_low: The lower bound of the price tick range. In TAO.
price_high: The upper bound of the price tick range. In TAO.
hotkey: The hotkey with staked TAO in Alpha. If not passed then the wallet hotkey is used. Defaults to
`None`.
wait_for_inclusion: Whether to wait for the extrinsic to be included in a block. Defaults to True.
wait_for_finalization: Whether to wait for finalization of the extrinsic. Defaults to False.
period: The number of blocks during which the transaction will remain valid after it's submitted. If
the transaction is not included in a block within that number of blocks, it will expire and be rejected.
You can think of it as an expiration date for the transaction.
Returns:
Tuple[bool, str]:
- True and a success message if the extrinsic is successfully submitted or processed.
- False and an error message if the submission fails or the wallet cannot be unlocked.
Note: Adding is allowed even when user liquidity is enabled in specified subnet. Call `toggle_user_liquidity`
method to enable/disable user liquidity.
"""
return add_liquidity_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
liquidity=liquidity,
price_low=price_low,
price_high=price_high,
hotkey=hotkey,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def add_stake_multiple(
self,
wallet: "Wallet",
hotkey_ss58s: list[str],
netuids: list[int],
amounts: Optional[list[Balance]] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> bool:
"""
Adds stakes to multiple neurons identified by their hotkey SS58 addresses.
This bulk operation allows for efficient staking across different neurons from a single wallet.
Args:
wallet (bittensor_wallet.Wallet): The wallet used for staking.
hotkey_ss58s (list[str]): List of ``SS58`` addresses of hotkeys to stake to.
netuids (list[int]): List of network UIDs to stake to.
amounts (list[Balance]): Corresponding amounts of TAO to stake for each hotkey.
wait_for_inclusion (bool): Waits for the transaction to be included in a block.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: ``True`` if the staking is successful for all specified neurons, False otherwise.
This function is essential for managing stakes across multiple neurons, reflecting the dynamic and collaborative
nature of the Bittensor network.
"""
return add_stake_multiple_extrinsic(
subtensor=self,
wallet=wallet,
hotkey_ss58s=hotkey_ss58s,
netuids=netuids,
amounts=amounts,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def burned_register(
self,
wallet: "Wallet",
netuid: int,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
period: Optional[int] = None,
) -> bool:
"""
Registers a neuron on the Bittensor network by recycling TAO. This method of registration involves recycling
TAO tokens, allowing them to be re-mined by performing work on the network.
Args:
wallet (bittensor_wallet.Wallet): The wallet associated with the neuron to be registered.
netuid (int): The unique identifier of the subnet.
wait_for_inclusion (bool, optional): Waits for the transaction to be included in a block. Defaults to
`False`.
wait_for_finalization (bool, optional): Waits for the transaction to be finalized on the blockchain.
Defaults to `True`.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: ``True`` if the registration is successful, False otherwise.
"""
if netuid == 0:
return root_register_extrinsic(
subtensor=self,
wallet=wallet,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
return burned_register_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def commit_weights(
self,
wallet: "Wallet",
netuid: int,
salt: list[int],
uids: Union[NDArray[np.int64], list],
weights: Union[NDArray[np.int64], list],
version_key: int = version_as_int,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = False,
max_retries: int = 5,
period: Optional[int] = 16,
) -> tuple[bool, str]:
"""
Commits a hash of the neuron's weights to the Bittensor blockchain using the provided wallet.
This action serves as a commitment or snapshot of the neuron's current weight distribution.
Arguments:
wallet (bittensor_wallet.Wallet): The wallet associated with the neuron committing the weights.
netuid (int): The unique identifier of the subnet.
salt (list[int]): list of randomly generated integers as salt to generated weighted hash.
uids (np.ndarray): NumPy array of neuron UIDs for which weights are being committed.
weights (np.ndarray): NumPy array of weight values corresponding to each UID.
version_key (int): Version key for compatibility with the network. Default is ``int representation of
a Bittensor version.``.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Default is ``False``.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Default is
``False``.
max_retries (int): The number of maximum attempts to commit weights. Default is ``5``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
tuple[bool, str]:
`True` if the weight commitment is successful, False otherwise.
`msg` is a string value describing the success or potential error.
This function allows neurons to create a tamper-proof record of their weight distribution at a specific point
in time, enhancing transparency and accountability within the Bittensor network.
"""
retries = 0
success = False
message = "No attempt made. Perhaps it is too soon to commit weights!"
logging.info(
f"Committing weights with params: "
f"netuid=[blue]{netuid}[/blue], uids=[blue]{uids}[/blue], weights=[blue]{weights}[/blue], "
f"version_key=[blue]{version_key}[/blue]"
)
# Generate the hash of the weights
commit_hash = generate_weight_hash(
address=wallet.hotkey.ss58_address,
netuid=netuid,
uids=list(uids),
values=list(weights),
salt=salt,
version_key=version_key,
)
while retries < max_retries and success is False:
try:
success, message = commit_weights_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
commit_hash=commit_hash,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
if success:
break
except Exception as e:
logging.error(f"Error committing weights: {e}")
retries += 1
return success, message
[docs]
def modify_liquidity(
self,
wallet: "Wallet",
netuid: int,
position_id: int,
liquidity_delta: Balance,
hotkey: Optional[str] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""Modifies liquidity in liquidity position by adding or removing liquidity from it.
Arguments:
wallet: The wallet used to sign the extrinsic (must be unlocked).
netuid: The UID of the target subnet for which the call is being initiated.
position_id: The id of the position record in the pool.
liquidity_delta: The amount of liquidity to be added or removed (add if positive or remove if negative).
hotkey: The hotkey with staked TAO in Alpha. If not passed then the wallet hotkey is used. Defaults to
`None`.
wait_for_inclusion: Whether to wait for the extrinsic to be included in a block. Defaults to True.
wait_for_finalization: Whether to wait for finalization of the extrinsic. Defaults to False.
period: The number of blocks during which the transaction will remain valid after it's submitted. If
the transaction is not included in a block within that number of blocks, it will expire and be rejected.
You can think of it as an expiration date for the transaction.
Returns:
Tuple[bool, str]:
- True and a success message if the extrinsic is successfully submitted or processed.
- False and an error message if the submission fails or the wallet cannot be unlocked.
Example:
import bittensor as bt
subtensor = bt.subtensor(network="local")
my_wallet = bt.Wallet()
# if `liquidity_delta` is negative
my_liquidity_delta = Balance.from_tao(100) * -1
subtensor.modify_liquidity(
wallet=my_wallet,
netuid=123,
position_id=2,
liquidity_delta=my_liquidity_delta
)
# if `liquidity_delta` is positive
my_liquidity_delta = Balance.from_tao(120)
subtensor.modify_liquidity(
wallet=my_wallet,
netuid=123,
position_id=2,
liquidity_delta=my_liquidity_delta
)
Note: Modifying is allowed even when user liquidity is enabled in specified subnet. Call `toggle_user_liquidity`
to enable/disable user liquidity.
"""
return modify_liquidity_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
position_id=position_id,
liquidity_delta=liquidity_delta,
hotkey=hotkey,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def move_stake(
self,
wallet: "Wallet",
origin_hotkey: str,
origin_netuid: int,
destination_hotkey: str,
destination_netuid: int,
amount: Balance,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> bool:
"""
Moves stake to a different hotkey and/or subnet.
Args:
wallet (bittensor.wallet): The wallet to move stake from.
origin_hotkey (str): The SS58 address of the source hotkey.
origin_netuid (int): The netuid of the source subnet.
destination_hotkey (str): The SS58 address of the destination hotkey.
destination_netuid (int): The netuid of the destination subnet.
amount (Balance): Amount of stake to move.
wait_for_inclusion (bool): Waits for the transaction to be included in a block.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
success (bool): True if the stake movement was successful.
"""
amount = check_and_convert_to_balance(amount)
return move_stake_extrinsic(
subtensor=self,
wallet=wallet,
origin_hotkey=origin_hotkey,
origin_netuid=origin_netuid,
destination_hotkey=destination_hotkey,
destination_netuid=destination_netuid,
amount=amount,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def register(
self,
wallet: "Wallet",
netuid: int,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
max_allowed_attempts: int = 3,
output_in_place: bool = True,
cuda: bool = False,
dev_id: Union[list[int], int] = 0,
tpb: int = 256,
num_processes: Optional[int] = None,
update_interval: Optional[int] = None,
log_verbose: bool = False,
period: Optional[int] = None,
) -> bool:
"""
Registers a neuron on the Bittensor network using the provided wallet.
Registration is a critical step for a neuron to become an active participant in the network, enabling it to
stake, set weights, and receive incentives.
Args:
wallet (bittensor_wallet.Wallet): The wallet associated with the neuron to be registered.
netuid (int): The unique identifier of the subnet.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Defaults to `False`.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Defaults to
`True`.
max_allowed_attempts (int): Maximum number of attempts to register the wallet.
output_in_place (bool): If true, prints the progress of the proof of work to the console in-place. Meaning
the progress is printed on the same lines. Defaults to `True`.
cuda (bool): If ``true``, the wallet should be registered using CUDA device(s). Defaults to `False`.
dev_id (Union[List[int], int]): The CUDA device id to use, or a list of device ids. Defaults to `0` (zero).
tpb (int): The number of threads per block (CUDA). Default to `256`.
num_processes (Optional[int]): The number of processes to use to register. Default to `None`.
update_interval (Optional[int]): The number of nonces to solve between updates. Default to `None`.
log_verbose (bool): If ``true``, the registration process will log more information. Default to `False`.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: ``True`` if the registration is successful, False otherwise.
This function facilitates the entry of new neurons into the network, supporting the decentralized
growth and scalability of the Bittensor ecosystem.
"""
return register_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
max_allowed_attempts=max_allowed_attempts,
tpb=tpb,
update_interval=update_interval,
num_processes=num_processes,
cuda=cuda,
dev_id=dev_id,
output_in_place=output_in_place,
log_verbose=log_verbose,
period=period,
)
[docs]
def register_subnet(
self,
wallet: "Wallet",
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
period: Optional[int] = None,
) -> bool:
"""
Registers a new subnetwork on the Bittensor network.
Args:
wallet (bittensor_wallet.Wallet): The wallet to be used for subnet registration.
wait_for_inclusion (bool): 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. Default is `False`.
wait_for_finalization (bool): If set, waits for the extrinsic to be finalized on the chain before returning
`True`, or returns `False` if the extrinsic fails to be finalized within the timeout. Default is `True`.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: True if the subnet registration was successful, False otherwise.
"""
return register_subnet_extrinsic(
subtensor=self,
wallet=wallet,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def remove_liquidity(
self,
wallet: "Wallet",
netuid: int,
position_id: int,
hotkey: Optional[str] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""Remove liquidity and credit balances back to wallet's hotkey stake.
Arguments:
wallet: The wallet used to sign the extrinsic (must be unlocked).
netuid: The UID of the target subnet for which the call is being initiated.
position_id: The id of the position record in the pool.
hotkey: The hotkey with staked TAO in Alpha. If not passed then the wallet hotkey is used. Defaults to
`None`.
wait_for_inclusion: Whether to wait for the extrinsic to be included in a block. Defaults to True.
wait_for_finalization: Whether to wait for finalization of the extrinsic. Defaults to False.
period: The number of blocks during which the transaction will remain valid after it's submitted. If
the transaction is not included in a block within that number of blocks, it will expire and be rejected.
You can think of it as an expiration date for the transaction.
Returns:
Tuple[bool, str]:
- True and a success message if the extrinsic is successfully submitted or processed.
- False and an error message if the submission fails or the wallet cannot be unlocked.
Note:
- Adding is allowed even when user liquidity is enabled in specified subnet. Call `toggle_user_liquidity`
extrinsic to enable/disable user liquidity.
- To get the `position_id` use `get_liquidity_list` method.
"""
return remove_liquidity_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
position_id=position_id,
hotkey=hotkey,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def reveal_weights(
self,
wallet: "Wallet",
netuid: int,
uids: Union[NDArray[np.int64], list],
weights: Union[NDArray[np.int64], list],
salt: Union[NDArray[np.int64], list],
version_key: int = version_as_int,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = False,
max_retries: int = 5,
period: Optional[int] = 16,
) -> tuple[bool, str]:
"""
Reveals the weights for a specific subnet on the Bittensor blockchain using the provided wallet.
This action serves as a revelation of the neuron's previously committed weight distribution.
Args:
wallet (bittensor_wallet.Wallet): The wallet associated with the neuron revealing the weights.
netuid (int): The unique identifier of the subnet.
uids (np.ndarray): NumPy array of neuron UIDs for which weights are being revealed.
weights (np.ndarray): NumPy array of weight values corresponding to each UID.
salt (np.ndarray): NumPy array of salt values corresponding to the hash function.
version_key (int): Version key for compatibility with the network. Default is ``int representation of
the Bittensor version``.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Default is ``False``.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Default is
``False``.
max_retries (int): The number of maximum attempts to reveal weights. Default is ``5``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
tuple[bool, str]: ``True`` if the weight revelation is successful, False otherwise. And `msg`, a string
value describing the success or potential error.
This function allows neurons to reveal their previously committed weight distribution, ensuring transparency
and accountability within the Bittensor network.
"""
retries = 0
success = False
message = "No attempt made. Perhaps it is too soon to reveal weights!"
while retries < max_retries and success is False:
try:
success, message = reveal_weights_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
uids=list(uids),
weights=list(weights),
salt=list(salt),
version_key=version_key,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
if success:
break
except Exception as e:
logging.error(f"Error revealing weights: {e}")
retries += 1
return success, message
[docs]
def root_register(
self,
wallet: "Wallet",
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
period: Optional[int] = None,
) -> bool:
"""
Register neuron by recycling some TAO.
Arguments:
wallet (bittensor_wallet.Wallet): Bittensor wallet instance.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Default is ``False``.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Default is
``False``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
`True` if registration was successful, otherwise `False`.
"""
return root_register_extrinsic(
subtensor=self,
wallet=wallet,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def root_set_pending_childkey_cooldown(
self,
wallet: "Wallet",
cooldown: int,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = True,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""Sets the pending childkey cooldown.
Arguments:
wallet: bittensor wallet instance.
cooldown: the number of blocks to setting pending childkey cooldown.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Default is ``False``.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Default is
``False``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
tuple[bool, str]: A tuple where the first element is a boolean indicating success or failure of the
operation, and the second element is a message providing additional information.
Note: This operation can only be successfully performed if your wallet has root privileges.
"""
return root_set_pending_childkey_cooldown_extrinsic(
subtensor=self,
wallet=wallet,
cooldown=cooldown,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def root_set_weights(
self,
wallet: "Wallet",
netuids: list[int],
weights: list[float],
version_key: int = 0,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> bool:
"""
Set weights for the root network.
Arguments:
wallet (bittensor_wallet.Wallet): bittensor wallet instance.
netuids (list[int]): The list of subnet uids.
weights (list[float]): The list of weights to be set.
version_key (int, optional): Version key for compatibility with the network. Default is ``0``.
wait_for_inclusion (bool, optional): Waits for the transaction to be included in a block. Defaults to
``False``.
wait_for_finalization (bool, optional): Waits for the transaction to be finalized on the blockchain.
Defaults to ``False``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
`True` if the setting of weights is successful, `False` otherwise.
"""
netuids_, weights_ = convert_uids_and_weights(netuids, weights)
logging.info(f"Setting weights in network: [blue]{self.network}[/blue]")
return set_root_weights_extrinsic(
subtensor=self,
wallet=wallet,
netuids=netuids_,
weights=weights_,
version_key=version_key,
wait_for_finalization=wait_for_finalization,
wait_for_inclusion=wait_for_inclusion,
period=period,
)
[docs]
def set_children(
self,
wallet: "Wallet",
hotkey: str,
netuid: int,
children: list[tuple[float, str]],
wait_for_inclusion: bool = True,
wait_for_finalization: bool = True,
raise_error: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""
Allows a coldkey to set children-keys.
Arguments:
wallet: bittensor wallet instance.
hotkey: The ``SS58`` address of the neuron's hotkey.
netuid: The netuid value.
children: A list of children with their proportions.
wait_for_inclusion: Waits for the transaction to be included in a block.
wait_for_finalization: Waits for the transaction to be finalized on the blockchain.
raise_error: Raises a relevant exception rather than returning `False` if unsuccessful.
period: The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
tuple[bool, str]: A tuple where the first element is a boolean indicating success or failure of the
operation, and the second element is a message providing additional information.
"""
return set_children_extrinsic(
subtensor=self,
wallet=wallet,
hotkey=hotkey,
netuid=netuid,
children=children,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
raise_error=raise_error,
period=period,
)
[docs]
def set_delegate_take(
self,
wallet: "Wallet",
hotkey_ss58: str,
take: float,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = True,
raise_error: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""
Sets the delegate 'take' percentage for a neuron identified by its hotkey.
The 'take' represents the percentage of rewards that the delegate claims from its nominators' stakes.
Arguments:
wallet (bittensor_wallet.Wallet): bittensor wallet instance.
hotkey_ss58 (str): The ``SS58`` address of the neuron's hotkey.
take (float): Percentage reward for the delegate.
wait_for_inclusion (bool): Waits for the transaction to be included in a block.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
raise_error: Raises a relevant exception rather than returning `False` if unsuccessful.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
tuple[bool, str]: A tuple where the first element is a boolean indicating success or failure of the
operation, and the second element is a message providing additional information.
Raises:
DelegateTakeTooHigh: Delegate take is too high.
DelegateTakeTooLow: Delegate take is too low.
DelegateTxRateLimitExceeded: A transactor exceeded the rate limit for delegate transaction.
HotKeyAccountNotExists: The hotkey does not exist.
NonAssociatedColdKey: Request to stake, unstake, or subscribe is made by a coldkey that is not associated
with the hotkey account.
bittensor_wallet.errors.PasswordError: Decryption failed or wrong password for decryption provided.
bittensor_wallet.errors.KeyFileError: Failed to decode keyfile data.
The delegate take is a critical parameter in the network's incentive structure, influencing the distribution of
rewards among neurons and their nominators.
"""
# u16 representation of the take
take_u16 = int(take * 0xFFFF)
current_take = self.get_delegate_take(hotkey_ss58)
current_take_u16 = int(current_take * 0xFFFF)
if current_take_u16 == take_u16:
logging.info(":white_heavy_check_mark: [green]Already Set[/green]")
return True, ""
logging.info(f"Updating {hotkey_ss58} take: current={current_take} new={take}")
if current_take_u16 < take_u16:
success, error = increase_take_extrinsic(
self,
wallet,
hotkey_ss58,
take_u16,
wait_for_finalization=wait_for_finalization,
wait_for_inclusion=wait_for_inclusion,
raise_error=raise_error,
period=period,
)
else:
success, error = decrease_take_extrinsic(
self,
wallet,
hotkey_ss58,
take_u16,
wait_for_finalization=wait_for_finalization,
wait_for_inclusion=wait_for_inclusion,
raise_error=raise_error,
period=period,
)
if success:
logging.info(":white_heavy_check_mark: [green]Take Updated[/green]")
return success, error
[docs]
def set_subnet_identity(
self,
wallet: "Wallet",
netuid: int,
subnet_identity: SubnetIdentity,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""
Sets the identity of a subnet for a specific wallet and network.
Arguments:
wallet (Wallet): The wallet instance that will authorize the transaction.
netuid (int): The unique ID of the network on which the operation takes place.
subnet_identity (SubnetIdentity): The identity data of the subnet including attributes like name, GitHub
repository, contact, URL, discord, description, and any additional metadata.
wait_for_inclusion (bool): Indicates if the function should wait for the transaction to be included in the
block.
wait_for_finalization (bool): Indicates if the function should wait for the transaction to reach
finalization.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
tuple[bool, str]: A tuple where the first element is a boolean indicating success or failure of the
operation, and the second element is a message providing additional information.
"""
return set_subnet_identity_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
subnet_name=subnet_identity.subnet_name,
github_repo=subnet_identity.github_repo,
subnet_contact=subnet_identity.subnet_contact,
subnet_url=subnet_identity.subnet_url,
logo_url=subnet_identity.logo_url,
discord=subnet_identity.discord,
description=subnet_identity.description,
additional=subnet_identity.additional,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def set_weights(
self,
wallet: "Wallet",
netuid: int,
uids: Union[NDArray[np.int64], "torch.LongTensor", list],
weights: Union[NDArray[np.float32], "torch.FloatTensor", list],
version_key: int = version_as_int,
wait_for_inclusion: bool = False,
wait_for_finalization: bool = False,
max_retries: int = 5,
block_time: float = 12.0,
period: Optional[int] = 8,
) -> tuple[bool, str]:
"""
Sets the interneuronal weights for the specified neuron. This process involves specifying the influence or
trust a neuron places on other neurons in the network, which is a fundamental aspect of Bittensor's
decentralized learning architecture.
Arguments:
wallet: The wallet associated with the neuron setting the weights.
netuid: The unique identifier of the subnet.
uids: The list of neuron UIDs that the weights are being set for.
weights: The corresponding weights to be set for each UID.
version_key: Version key for compatibility with the network. Default is int representation of a Bittensor
version.
wait_for_inclusion: Waits for the transaction to be included in a block. Default is ``False``.
wait_for_finalization: Waits for the transaction to be finalized on the blockchain. Default is ``False``.
max_retries: The number of maximum attempts to set weights. Default is ``5``.
block_time: The number of seconds for block duration. Default is 12.0 seconds.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction. Default is 8.
Returns:
tuple:
`True` if the setting of weights is successful, `False` otherwise.
`msg` is a string value describing the success or potential error.
This function is crucial in shaping the network's collective intelligence, where each neuron's learning and
contribution are influenced by the weights it sets towards others.
"""
def _blocks_weight_limit() -> bool:
bslu = cast(int, self.blocks_since_last_update(netuid, cast(int, uid)))
wrl = cast(int, self.weights_rate_limit(netuid))
return bslu > wrl
retries = 0
success = False
message = "No attempt made. Perhaps it is too soon to commit weights!"
if (
uid := self.get_uid_for_hotkey_on_subnet(wallet.hotkey.ss58_address, netuid)
) is None:
return (
False,
f"Hotkey {wallet.hotkey.ss58_address} not registered in subnet {netuid}",
)
if self.commit_reveal_enabled(netuid=netuid):
# go with `commit reveal v3` extrinsic
while retries < max_retries and success is False and _blocks_weight_limit():
logging.info(
f"Committing weights for subnet [blue]{netuid}[/blue]. "
f"Attempt [blue]{retries + 1}[blue] of [green]{max_retries}[/green]."
)
success, message = commit_reveal_v3_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
uids=uids,
weights=weights,
version_key=version_key,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
block_time=block_time,
period=period,
)
retries += 1
return success, message
else:
# go with classic `set_weights_extrinsic`
while retries < max_retries and success is False and _blocks_weight_limit():
try:
logging.info(
f"Setting weights for subnet [blue]{netuid}[/blue]. "
f"Attempt [blue]{retries + 1}[/blue] of [green]{max_retries}[/green]."
)
success, message = set_weights_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
uids=uids,
weights=weights,
version_key=version_key,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
except Exception as e:
logging.error(f"Error setting weights: {e}")
retries += 1
return success, message
[docs]
def serve_axon(
self,
netuid: int,
axon: "Axon",
wait_for_inclusion: bool = False,
wait_for_finalization: bool = True,
certificate: Optional[Certificate] = None,
period: Optional[int] = None,
) -> bool:
"""
Registers an ``Axon`` serving endpoint on the Bittensor network for a specific neuron. This function is used to
set up the Axon, a key component of a neuron that handles incoming queries and data processing tasks.
Args:
netuid (int): The unique identifier of the subnetwork.
axon (bittensor.core.axon.Axon): The Axon instance to be registered for serving.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Default is ``False``.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Default is
``True``.
certificate (bittensor.utils.Certificate): Certificate to use for TLS. If ``None``, no TLS will be used.
Defaults to ``None``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
bool: ``True`` if the Axon serve registration is successful, False otherwise.
By registering an Axon, the neuron becomes an active part of the network's distributed computing infrastructure,
contributing to the collective intelligence of Bittensor.
"""
return serve_axon_extrinsic(
subtensor=self,
netuid=netuid,
axon=axon,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
certificate=certificate,
period=period,
)
[docs]
def start_call(
self,
wallet: "Wallet",
netuid: int,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""
Submits a start_call extrinsic to the blockchain, to trigger the start call process for a subnet (used to start
a new subnet's emission mechanism).
Args:
wallet (Wallet): The wallet used to sign the extrinsic (must be unlocked).
netuid (int): The UID of the target subnet for which the call is being initiated.
wait_for_inclusion (bool, optional): Whether to wait for the extrinsic to be included in a block.
Defaults to `True`.
wait_for_finalization (bool, optional): Whether to wait for finalization of the extrinsic.
Defaults to `False`.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
Tuple[bool, str]:
- True and a success message if the extrinsic is successfully submitted or processed.
- False and an error message if the submission fails or the wallet cannot be unlocked.
"""
return start_call_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def swap_stake(
self,
wallet: "Wallet",
hotkey_ss58: str,
origin_netuid: int,
destination_netuid: int,
amount: Balance,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
safe_staking: bool = False,
allow_partial_stake: bool = False,
rate_tolerance: float = 0.005,
period: Optional[int] = None,
) -> bool:
"""
Moves stake between subnets while keeping the same coldkey-hotkey pair ownership.
Like subnet hopping - same owner, same hotkey, just changing which subnet the stake is in.
Args:
wallet (bittensor.wallet): The wallet to swap stake from.
hotkey_ss58 (str): The SS58 address of the hotkey whose stake is being swapped.
origin_netuid (int): The netuid from which stake is removed.
destination_netuid (int): The netuid to which stake is added.
amount (Union[Balance, float]): The amount to swap.
wait_for_inclusion (bool): Waits for the transaction to be included in a block.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
safe_staking (bool): If true, enables price safety checks to protect against fluctuating prices. The swap
will only execute if the price ratio between subnets doesn't exceed the rate tolerance.
Default is False.
allow_partial_stake (bool): If true and safe_staking is enabled, allows partial stake swaps when
the full amount would exceed the price tolerance. If false, the entire swap fails if it would
exceed the tolerance. Default is False.
rate_tolerance (float): The maximum allowed increase in the price ratio between subnets
(origin_price/destination_price). For example, 0.005 = 0.5% maximum increase. Only used
when safe_staking is True. Default is 0.005.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
success (bool): True if the extrinsic was successful.
The price ratio for swap_stake in safe mode is calculated as: origin_subnet_price / destination_subnet_price
When safe_staking is enabled, the swap will only execute if:
- With allow_partial_stake=False: The entire swap amount can be executed without the price ratio
increasing more than rate_tolerance
- With allow_partial_stake=True: A partial amount will be swapped up to the point where the
price ratio would increase by rate_tolerance
"""
amount = check_and_convert_to_balance(amount)
return swap_stake_extrinsic(
subtensor=self,
wallet=wallet,
hotkey_ss58=hotkey_ss58,
origin_netuid=origin_netuid,
destination_netuid=destination_netuid,
amount=amount,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
safe_staking=safe_staking,
allow_partial_stake=allow_partial_stake,
rate_tolerance=rate_tolerance,
period=period,
)
[docs]
def toggle_user_liquidity(
self,
wallet: "Wallet",
netuid: int,
enable: bool,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""Allow to toggle user liquidity for specified subnet.
Arguments:
wallet: The wallet used to sign the extrinsic (must be unlocked).
netuid: The UID of the target subnet for which the call is being initiated.
enable: Boolean indicating whether to enable user liquidity.
wait_for_inclusion: Whether to wait for the extrinsic to be included in a block. Defaults to True.
wait_for_finalization: Whether to wait for finalization of the extrinsic. Defaults to False.
period: The number of blocks during which the transaction will remain valid after it's submitted. If
the transaction is not included in a block within that number of blocks, it will expire and be rejected.
You can think of it as an expiration date for the transaction.
Returns:
Tuple[bool, str]:
- True and a success message if the extrinsic is successfully submitted or processed.
- False and an error message if the submission fails or the wallet cannot be unlocked.
Note: The call can be executed successfully by the subnet owner only.
"""
return toggle_user_liquidity_extrinsic(
subtensor=self,
wallet=wallet,
netuid=netuid,
enable=enable,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def transfer(
self,
wallet: "Wallet",
dest: str,
amount: Balance,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
transfer_all: bool = False,
keep_alive: bool = True,
period: Optional[int] = None,
) -> bool:
"""
Transfer token of amount to destination.
Arguments:
wallet (bittensor_wallet.Wallet): Source wallet for the transfer.
dest (str): Destination address for the transfer.
amount (float): Amount of tao to transfer.
transfer_all (bool): Flag to transfer all tokens. Default is ``False``.
wait_for_inclusion (bool): Waits for the transaction to be included in a block. Default is ``True``.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain. Default is
``False``.
keep_alive (bool): Flag to keep the connection alive. Default is ``True``.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
`True` if the transferring was successful, otherwise `False`.
"""
amount = check_and_convert_to_balance(amount)
return transfer_extrinsic(
subtensor=self,
wallet=wallet,
dest=dest,
amount=amount,
transfer_all=transfer_all,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
keep_alive=keep_alive,
period=period,
)
[docs]
def transfer_stake(
self,
wallet: "Wallet",
destination_coldkey_ss58: str,
hotkey_ss58: str,
origin_netuid: int,
destination_netuid: int,
amount: Balance,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> bool:
"""
Transfers stake from one subnet to another while changing the coldkey owner.
Args:
wallet (bittensor.wallet): The wallet to transfer stake from.
destination_coldkey_ss58 (str): The destination coldkey SS58 address.
hotkey_ss58 (str): The hotkey SS58 address associated with the stake.
origin_netuid (int): The source subnet UID.
destination_netuid (int): The destination subnet UID.
amount (Union[Balance, float, int]): Amount to transfer.
wait_for_inclusion (bool): If true, waits for inclusion before returning.
wait_for_finalization (bool): If true, waits for finalization before returning.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
Returns:
success (bool): True if the transfer was successful.
"""
amount = check_and_convert_to_balance(amount)
return transfer_stake_extrinsic(
subtensor=self,
wallet=wallet,
destination_coldkey_ss58=destination_coldkey_ss58,
hotkey_ss58=hotkey_ss58,
origin_netuid=origin_netuid,
destination_netuid=destination_netuid,
amount=amount,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def unstake(
self,
wallet: "Wallet",
hotkey_ss58: Optional[str] = None,
netuid: Optional[int] = None,
amount: Optional[Balance] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
safe_staking: bool = False,
allow_partial_stake: bool = False,
rate_tolerance: float = 0.005,
period: Optional[int] = None,
unstake_all: bool = False,
) -> bool:
"""
Removes a specified amount of stake from a single hotkey account. This function is critical for adjusting
individual neuron stakes within the Bittensor network.
Args:
wallet: The wallet associated with the neuron from which the stake is being removed.
hotkey_ss58: The ``SS58`` address of the hotkey account to unstake from.
netuid: The unique identifier of the subnet.
amount: The amount of alpha to unstake. If not specified, unstakes all. Alpha amount.
wait_for_inclusion: Waits for the transaction to be included in a block.
wait_for_finalization: Waits for the transaction to be finalized on the blockchain.
safe_staking: If true, enables price safety checks to protect against fluctuating prices. The unstake
will only execute if the price change doesn't exceed the rate tolerance. Default is False.
allow_partial_stake (bool): If true and safe_staking is enabled, allows partial unstaking when
the full amount would exceed the price tolerance. If false, the entire unstake fails if it would
exceed the tolerance. Default is False.
rate_tolerance (float): The maximum allowed price change ratio when unstaking. For example,
0.005 = 0.5% maximum price decrease. Only used when safe_staking is True. Default is 0.005.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
unstake_all: If `True`, unstakes all tokens, and `amount` is ignored. Default is `False`.
Returns:
bool: ``True`` if the unstaking process is successful, False otherwise.
This function supports flexible stake management, allowing neurons to adjust their network participation and
potential reward accruals. When safe_staking is enabled, it provides protection against price fluctuations
during the time unstake is executed and the time it is actually processed by the chain.
"""
amount = check_and_convert_to_balance(amount)
return unstake_extrinsic(
subtensor=self,
wallet=wallet,
hotkey_ss58=hotkey_ss58,
netuid=netuid,
amount=amount,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
safe_staking=safe_staking,
allow_partial_stake=allow_partial_stake,
rate_tolerance=rate_tolerance,
period=period,
unstake_all=unstake_all,
)
[docs]
def unstake_all(
self,
wallet: "Wallet",
hotkey: str,
netuid: int,
rate_tolerance: Optional[float] = 0.005,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
) -> tuple[bool, str]:
"""Unstakes all TAO/Alpha associated with a hotkey from the specified subnets on the Bittensor network.
Arguments:
wallet: The wallet of the stake owner.
hotkey: The SS58 address of the hotkey to unstake from.
netuid: The unique identifier of the subnet.
rate_tolerance: The maximum allowed price change ratio when unstaking. For example, 0.005 = 0.5% maximum
price decrease. If not passed (None), then unstaking goes without price limit. Default is 0.005.
wait_for_inclusion: Waits for the transaction to be included in a block. Default is `True`.
wait_for_finalization: Waits for the transaction to be finalized on the blockchain. Default is `False`.
period: The number of blocks during which the transaction will remain valid after it's submitted. If the
transaction is not included in a block within that number of blocks, it will expire and be rejected. You
can think of it as an expiration date for the transaction. Default is `None`.
Returns:
tuple[bool, str]:
A tuple containing:
- `True` and a success message if the unstake operation succeeded;
- `False` and an error message otherwise.
Example:
# If you would like to unstake all stakes in all subnets safely:
import bittensor as bt
subtensor = bt.Subtensor()
wallet = bt.Wallet("my_wallet")
netuid = 14
hotkey = "5%SOME_HOTKEY%"
wallet_stakes = subtensor.get_stake_info_for_coldkey(coldkey_ss58=wallet.coldkey.ss58_address)
for stake in wallet_stakes:
result = subtensor.unstake_all(
wallet=wallet,
hotkey_ss58=stake.hotkey_ss58,
netuid=stake.netuid,
)
print(result)
# If you would like to unstake all stakes in all subnets unsafely, use `rate_tolerance=None`:
import bittensor as bt
subtensor = bt.AsyncSubtensor()
wallet = bt.Wallet("my_wallet")
netuid = 14
hotkey = "5%SOME_HOTKEY_WHERE_IS_YOUR_STAKE_NOW%"
wallet_stakes = await subtensor.get_stake_info_for_coldkey(coldkey_ss58=wallet.coldkey.ss58_address)
for stake in wallet_stakes:
result = await subtensor.unstake_all(
wallet=wallet,
hotkey_ss58=stake.hotkey_ss58,
netuid=stake.netuid,
rate_tolerance=None,
)
print(result)
"""
if netuid != 0:
logging.debug(
f"Unstaking without Alpha price control from subnet [blue]#{netuid}[/blue]."
)
return unstake_all_extrinsic(
subtensor=self,
wallet=wallet,
hotkey=hotkey,
netuid=netuid,
rate_tolerance=rate_tolerance,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
)
[docs]
def unstake_multiple(
self,
wallet: "Wallet",
hotkey_ss58s: list[str],
netuids: list[int],
amounts: Optional[list[Balance]] = None,
wait_for_inclusion: bool = True,
wait_for_finalization: bool = False,
period: Optional[int] = None,
unstake_all: bool = False,
) -> bool:
"""
Performs batch unstaking from multiple hotkey accounts, allowing a neuron to reduce its staked amounts
efficiently. This function is useful for managing the distribution of stakes across multiple neurons.
Args:
wallet: The wallet linked to the coldkey from which the stakes are being
withdrawn.
hotkey_ss58s (List[str]): A list of hotkey ``SS58`` addresses to unstake from.
netuids (List[int]): The list of subnet uids.
amounts (List[Balance]): The amounts of TAO to unstake from each hotkey. If not provided,
unstakes all available stakes.
wait_for_inclusion (bool): Waits for the transaction to be included in a block.
wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
period (Optional[int]): The number of blocks during which the transaction will remain valid after it's
submitted. If the transaction is not included in a block within that number of blocks, it will expire
and be rejected. You can think of it as an expiration date for the transaction.
unstake_all: If `True`, unstakes all tokens, and `amounts` is ignored. Default is `False`.
Returns:
bool: ``True`` if the batch unstaking is successful, False otherwise.
This function allows for strategic reallocation or withdrawal of stakes, aligning with the dynamic stake
management aspect of the Bittensor network.
"""
return unstake_multiple_extrinsic(
subtensor=self,
wallet=wallet,
hotkey_ss58s=hotkey_ss58s,
netuids=netuids,
amounts=amounts,
wait_for_inclusion=wait_for_inclusion,
wait_for_finalization=wait_for_finalization,
period=period,
unstake_all=unstake_all,
)
