bittensor.utils

Submodules

• bittensor.utils.axon_utils
• bittensor.utils.balance
• bittensor.utils.btlogging
• bittensor.utils.easy_imports
• bittensor.utils.formatting
• bittensor.utils.mock
• bittensor.utils.networking
• bittensor.utils.registration
• bittensor.utils.subnets
• bittensor.utils.substrate_utils
• bittensor.utils.version
• bittensor.utils.weight_utils

Attributes

RAOPERTAO
U16_MAX
U64_MAX
VersionCheckError
check_version
hex_to_bytes
logging
ss58_decode
torch
use_torch
version_checking

Classes

Certificate	str(object='') -> str
UnlockStatus

Functions

decode_hex_identity_dict(info_dictionary)	Decodes a dictionary of hexadecimal identities.
determine_chain_endpoint_and_network(network)	Determines the chain endpoint and network from the passed network or chain_endpoint.
float_to_u64(value)	Converts a float to a u64 int
format_error_message(error_message)	Formats an error message from the Subtensor error information for use in extrinsics.
get_explorer_url_for_network(network, block_hash, ...)	Returns the explorer url for the given block hash and network.
get_hash(content[, encoding])
is_valid_bittensor_address_or_public_key(address)	Checks if the given address is a valid destination address.
is_valid_ss58_address(address)	Checks if the given address is a valid ss58 address.
ss58_address_to_bytes(ss58_address)	Converts a ss58 address to a bytes object.
ss58_to_vec_u8(ss58_address)
strtobool(val)	Converts a string to a boolean value.
u16_normalized_float(x)
u64_normalized_float(x)
unlock_key(wallet[, unlock_type, raise_error])	Attempts to decrypt a wallet's coldkey or hotkey
validate_chain_endpoint(endpoint_url)	Validates if the provided endpoint URL is a valid WebSocket URL.

Package Contents

class bittensor.utils.Certificate

Bases: str

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

Initialize self. See help(type(self)) for accurate signature.

bittensor.utils.RAOPERTAO = 1000000000.0

bittensor.utils.U16_MAX = 65535

bittensor.utils.U64_MAX = 18446744073709551615

class bittensor.utils.UnlockStatus

Bases: tuple

message

success

bittensor.utils.VersionCheckError

bittensor.utils.check_version

bittensor.utils.decode_hex_identity_dict(info_dictionary)

Decodes a dictionary of hexadecimal identities.

Parameters:

info_dictionary (dict[str, Any])

Return type:

dict[str, Any]

bittensor.utils.determine_chain_endpoint_and_network(network)

Determines the chain endpoint and network from the passed network or chain_endpoint.

Parameters:

network (str) – The network flag. The choices are: finney (main network), archive (archive network +300 blocks), local (local running network), test (test network).

Returns:

The network and chain endpoint flag. If passed, overrides the

network argument.

Return type:

tuple[Optional[str], Optional[str]]

bittensor.utils.float_to_u64(value)

Converts a float to a u64 int

Parameters:

value (float)

Return type:

int

bittensor.utils.format_error_message(error_message)

Formats an error message from the Subtensor error information for use in extrinsics.

Parameters:

error_message (Union[dict, Exception]) – A dictionary containing the error information from Subtensor, or a SubstrateRequestException containing dictionary literal args.

Returns:

A formatted error message string.

Return type:

str

bittensor.utils.get_explorer_url_for_network(network, block_hash, network_map)

Returns the explorer url for the given block hash and network.

Parameters:

• network (str) – The network to get the explorer url for.

• block_hash (str) – The block hash to get the explorer url for.

• network_map (dict[str, dict[str, str]]) – The network maps to get the explorer urls from.

Returns:

The explorer url for the given block hash and network. Or None if the network is not known.

Return type:

Optional[dict[str, str]]

bittensor.utils.get_hash(content, encoding='utf-8')

bittensor.utils.hex_to_bytes

bittensor.utils.is_valid_bittensor_address_or_public_key(address)

Checks if the given address is a valid destination address.

Parameters:

address (Union[str, bytes]) – The address to check.

Returns:

True if the address is a valid destination address, False otherwise.

Return type:

bool

bittensor.utils.is_valid_ss58_address(address)

Checks if the given address is a valid ss58 address.

Parameters:

address (str) – The address to check.

Returns:

True if the address is a valid ss58 address for Bittensor, False otherwise.

Return type:

bool

bittensor.utils.logging

bittensor.utils.ss58_address_to_bytes(ss58_address)

Converts a ss58 address to a bytes object.

Parameters:

ss58_address (str)

Return type:

bytes

bittensor.utils.ss58_decode

bittensor.utils.ss58_to_vec_u8(ss58_address)

Parameters:

ss58_address (str)

Return type:

list[int]

bittensor.utils.strtobool(val)

Converts a string to a boolean value.

truth-y values are ‘y’, ‘yes’, ‘t’, ‘true’, ‘on’, and ‘1’; false-y values are ‘n’, ‘no’, ‘f’, ‘false’, ‘off’, and ‘0’.

Raises ValueError if ‘val’ is anything else.

Parameters:

val (str)

Return type:

Union[bool, Literal[‘==SUPRESS==’]]

bittensor.utils.torch

bittensor.utils.u16_normalized_float(x)

Parameters:

x (int)

Return type:

float

bittensor.utils.u64_normalized_float(x)

Parameters:

x (int)

Return type:

float

bittensor.utils.unlock_key(wallet, unlock_type='coldkey', raise_error=False)

Attempts to decrypt a wallet’s coldkey or hotkey

Parameters:

• wallet (bittensor_wallet.Wallet) – a Wallet object

• unlock_type – the key type, ‘coldkey’ or ‘hotkey’

• raise_error – if False, will return (False, error msg), if True will raise the otherwise-caught exception.

Returns:

UnlockStatus for success status of unlock, with error message if unsuccessful

Raises:

• bittensor_wallet.errors.PasswordError – incorrect password

• bittensor_wallet.errors.KeyFileError – keyfile is corrupt, non-writable, or non-readable, or non-existent

Return type:

UnlockStatus

bittensor.utils.use_torch

bittensor.utils.validate_chain_endpoint(endpoint_url)

Validates if the provided endpoint URL is a valid WebSocket URL.

Parameters:

endpoint_url (str)

Return type:

tuple[bool, str]

bittensor.utils.version_checking