bittensor.commands.overview

bittensor.commands.overview#

Attributes#

console

Classes#

OverviewCommand

Executes the overview command to present a detailed overview of the user's registered accounts on the Bittensor network.

Module Contents#

bittensor.commands.overview.console#
class bittensor.commands.overview.OverviewCommand[source]#

Executes the overview command to present a detailed overview of the user’s registered accounts on the Bittensor network.

This command compiles and displays comprehensive information about each neuron associated with the user’s wallets, including both hotkeys and coldkeys. It is especially useful for users managing multiple accounts or seeking a summary of their network activities and stake distributions.

Usage:

The command offers various options to customize the output. Users can filter the displayed data by specific netuids, sort by different criteria, and choose to include all wallets in the user’s configuration directory. The output is presented in a tabular format with the following columns:

  • COLDKEY: The SS58 address of the coldkey.

  • HOTKEY: The SS58 address of the hotkey.

  • UID: Unique identifier of the neuron.

  • ACTIVE: Indicates if the neuron is active.

  • STAKE(τ): Amount of stake in the neuron, in Tao.

  • RANK: The rank of the neuron within the network.

  • TRUST: Trust score of the neuron.

  • CONSENSUS: Consensus score of the neuron.

  • INCENTIVE: Incentive score of the neuron.

  • DIVIDENDS: Dividends earned by the neuron.

  • EMISSION(p): Emission received by the neuron, in Rho.

  • VTRUST: Validator trust score of the neuron.

  • VPERMIT: Indicates if the neuron has a validator permit.

  • UPDATED: Time since last update.

  • AXON: IP address and port of the neuron.

  • HOTKEY_SS58: Human-readable representation of the hotkey.

Example usage:

btcli wallet overview
btcli wallet overview --all --sort_by stake --sort_order descending

Note

This command is read-only and does not modify the network state or account configurations. It provides a quick and comprehensive view of the user’s network presence, making it ideal for monitoring account status, stake distribution, and overall contribution to the Bittensor network.

static run(cli)[source]#

Prints an overview for the wallet’s colkey.

Parameters:

cli (bittensor.cli)

static _get_total_balance(total_balance, subtensor, cli)[source]#
Parameters:
Return type:

Tuple[List[bittensor.wallet], bittensor.Balance]

static _get_hotkeys(cli, all_hotkeys)[source]#
Parameters:
Return type:

List[bittensor.wallet]

static _get_key_address(all_hotkeys)[source]#
Parameters:

all_hotkeys (List[bittensor.wallet])

static _process_neuron_results(results, neurons, netuids)[source]#
Parameters:
Return type:

Dict[str, List[bittensor.NeuronInfoLite]]

_run(subtensor)[source]#

Prints an overview for the wallet’s colkey.

Parameters:

subtensor (bittensor.subtensor)

static _get_neurons_for_netuid(args_tuple)[source]#
Parameters:

args_tuple (Tuple[bittensor.Config, int, List[str]])

Return type:

Tuple[int, List[bittensor.NeuronInfoLite], Optional[str]]

static _get_de_registered_stake_for_coldkey_wallet(args_tuple)[source]#
Return type:

Tuple[bittensor.Wallet, List[Tuple[str, bittensor.Balance]], Optional[str]]

static add_args(parser)[source]#
Parameters:

parser (argparse.ArgumentParser)

static check_config(config)[source]#
Parameters:

config (bittensor.config)

Contents