Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove irrelevant call to get_delegates method. #1826

Merged
merged 5 commits into from
Apr 30, 2024
Merged

Remove irrelevant call to get_delegates method. #1826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e9eb0a
Remove irrelevant call to get_delegates method for comparison (obsole…
roman-opentensor Apr 30, 2024
f8a2577
Remove irrelevant call to get_delegates method for comparison (obsole…
roman-opentensor Apr 30, 2024
9005206
Remove irrelevant call to get_delegates method for comparison (obsole…
roman-opentensor Apr 30, 2024
54e822b
Merge branch 'staging' into feature/rpc-request
gus-opentensor Apr 30, 2024
5f012ee
Merge branch 'staging' into feature/rpc-request
roman-opentensor Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 63 additions & 48 deletions bittensor/commands/delegates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,22 @@
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.

import sys
import os
import argparse
import bittensor
from typing import List, Optional
from rich.table import Table
from rich.prompt import Prompt
from rich.prompt import Confirm
import os
import sys
from typing import List, Dict, Optional

from rich.console import Text
from tqdm import tqdm
from rich.prompt import Confirm
from rich.prompt import Prompt
from rich.table import Table
from substrateinterface.exceptions import SubstrateRequestException
from .utils import get_delegates_details, DelegatesDetails
from .identity import SetIdentityCommand
from . import defaults
from tqdm import tqdm

import os
import bittensor
from typing import List, Dict, Optional
from . import defaults
from .identity import SetIdentityCommand
from .utils import get_delegates_details, DelegatesDetails


def _get_coldkey_wallets_for_path(path: str) -> List["bittensor.wallet"]:
Expand Down Expand Up @@ -60,12 +58,15 @@ def show_delegates(
The table is sorted by total stake in descending order and provides
a snapshot of delegate performance and status, helping users make informed decisions for staking or nominating.

This is a helper function that is called by the :func:`list_delegates` and :func:`my_delegates`, and is not intended to be used directly in user code unless specifically required.
This is a helper function that is called by the :func:`list_delegates` and :func:`my_delegates`, and is not intended
to be used directly in user code unless specifically required.

Args:
- delegates (List[bittensor.DelegateInfo]): A list of delegate information objects to be displayed.
- prev_delegates (Optional[List[bittensor.DelegateInfo]]): A list of delegate information objects from a previous state, used to calculate changes in stake. Defaults to ``None``.
- width (Optional[int]): The width of the console output table. Defaults to ``None``, which will make the table expand to the maximum width of the console.
- prev_delegates (Optional[List[bittensor.DelegateInfo]]): A list of delegate information objects from a
previous state, used to calculate changes in stake. Defaults to ``None``.
- width (Optional[int]): The width of the console output table. Defaults to ``None``, which will make the table
expand to the maximum width of the console.

The output table includes the following columns:

Expand All @@ -92,7 +93,8 @@ def show_delegates(

Note:
This function is primarily for display purposes within a command-line interface and does
not return any values. It relies on the `rich <https://github.com/Textualize/rich>`_ Python library to render the table in the
not return any values. It relies on the `rich <https://github.com/Textualize/rich>`_ Python library to render
the table in the
console.
"""

Expand Down Expand Up @@ -205,8 +207,8 @@ def show_delegates(
rate_change_in_stake_str,
str(delegate.registrations),
f"{delegate.take * 100:.1f}%",
f"{bittensor.Balance.from_tao( delegate.total_daily_return.tao * (1000/ ( 0.001 + delegate.total_stake.tao ) ))!s:6.6}",
f"{bittensor.Balance.from_tao( delegate.total_daily_return.tao * (0.18) ) !s:6.6}",
f"{bittensor.Balance.from_tao( delegate.total_daily_return.tao * (1000/ (0.001 + delegate.total_stake.tao)))!s:6.6}",
f"{bittensor.Balance.from_tao(delegate.total_daily_return.tao * 0.18) !s:6.6}",
str(delegate_description),
end_section=True,
)
Expand All @@ -225,18 +227,23 @@ class DelegateStakeCommand:
- ``amount``: The amount of Tao to stake.
- ``all``: If specified, the command stakes all available Tao.

The command interacts with the user to determine the delegate and the amount of Tao to be staked. If the ``--all`` flag is used, it delegates the entire available balance.
The command interacts with the user to determine the delegate and the amount of Tao to be staked. If the ``--all``
flag is used, it delegates the entire available balance.

Usage:
The user must specify the delegate's SS58 address and the amount of Tao to stake. The function sends a transaction to the subtensor network to delegate the specified amount to the chosen delegate. These values are prompted if not provided.
The user must specify the delegate's SS58 address and the amount of Tao to stake. The function sends a
transaction to the subtensor network to delegate the specified amount to the chosen delegate. These values are
prompted if not provided.

Example usage::

btcli delegate --delegate_ss58key <SS58_ADDRESS> --amount <AMOUNT>
btcli delegate --delegate_ss58key <SS58_ADDRESS> --all

Note:
This command modifies the blockchain state and may incur transaction fees. It requires user confirmation and interaction, and is designed to be used within the Bittensor CLI environment. The user should ensure the delegate's address and the amount to be staked are correct before executing the command.
This command modifies the blockchain state and may incur transaction fees. It requires user confirmation and
interaction, and is designed to be used within the Bittensor CLI environment. The user should ensure the
delegate's address and the amount to be staked are correct before executing the command.
"""

@staticmethod
Expand Down Expand Up @@ -344,7 +351,8 @@ def check_config(config: "bittensor.config"):

class DelegateUnstakeCommand:
"""
Executes the ``undelegate`` command, allowing users to withdraw their staked Tao from a delegate on the Bittensor network.
Executes the ``undelegate`` command, allowing users to withdraw their staked Tao from a delegate on the Bittensor
network.

This process is known as "undelegating" and it reverses the delegation process, freeing up the staked tokens.

Expand All @@ -354,18 +362,23 @@ class DelegateUnstakeCommand:
- ``amount``: The amount of Tao to undelegate.
- ``all``: If specified, the command undelegates all staked Tao from the delegate.

The command prompts the user for the amount of Tao to undelegate and the ``SS58`` address of the delegate from which to undelegate. If the ``--all`` flag is used, it will attempt to undelegate the entire staked amount from the specified delegate.
The command prompts the user for the amount of Tao to undelegate and the ``SS58`` address of the delegate from which
to undelegate. If the ``--all`` flag is used, it will attempt to undelegate the entire staked amount from the
specified delegate.

Usage:
The user must provide the delegate's SS58 address and the amount of Tao to undelegate. The function will then send a transaction to the Bittensor network to process the undelegation.
The user must provide the delegate's SS58 address and the amount of Tao to undelegate. The function will then
send a transaction to the Bittensor network to process the undelegation.

Example usage::

btcli undelegate --delegate_ss58key <SS58_ADDRESS> --amount <AMOUNT>
btcli undelegate --delegate_ss58key <SS58_ADDRESS> --all

Note:
This command can result in a change to the blockchain state and may incur transaction fees. It is interactive and requires confirmation from the user before proceeding. It should be used with care as undelegating can affect the delegate's total stake and
This command can result in a change to the blockchain state and may incur transaction fees. It is interactive
and requires confirmation from the user before proceeding. It should be used with care as undelegating can
affect the delegate's total stake and
potentially the user's staking rewards.
"""

Expand All @@ -383,9 +396,9 @@ def run(cli: "bittensor.cli"):
subtensor.close()
bittensor.logging.debug("closing subtensor connection")

def _run(cli: "bittensor.cli", subtensor: "bittensor.subtensor"):
def _run(self: "bittensor.cli", subtensor: "bittensor.subtensor"):
"""Undelegates stake from a chain delegate."""
config = cli.config.copy()
config = self.config.copy()
wallet = bittensor.wallet(config=config)
subtensor.undelegate(
wallet=wallet,
Expand Down Expand Up @@ -479,7 +492,8 @@ def check_config(config: "bittensor.config"):

class ListDelegatesCommand:
"""
Displays a formatted table of Bittensor network delegates, providing a comprehensive overview of delegate statistics and information.
Displays a formatted table of Bittensor network delegates, providing a comprehensive overview of delegate statistics
and information.

This table helps users make informed decisions on which delegates to allocate their Tao stake.

Expand All @@ -502,7 +516,9 @@ class ListDelegatesCommand:
- DELEGATE/(24h): The total earnings of the delegate in the last 24 hours.
- DESCRIPTION: A brief description of the delegate's purpose and operations.

Sorting is done based on the ``TOTAL STAKE`` column in descending order. Changes in stake are highlighted: increases in green and decreases in red. Entries with no previous data are marked with ``NA``. Each delegate's name is a hyperlink to their respective URL, if available.
Sorting is done based on the ``TOTAL STAKE`` column in descending order. Changes in stake are highlighted:
increases in green and decreases in red. Entries with no previous data are marked with ``NA``. Each delegate's name
is a hyperlink to their respective URL, if available.

Example usage::

Expand All @@ -511,7 +527,8 @@ class ListDelegatesCommand:
btcli root list_delegates --subtensor.network finney # can also be `test` or `local`

Note:
This function is part of the Bittensor CLI tools and is intended for use within a console application. It prints directly to the console and does not return any value.
This function is part of the Bittensor CLI tools and is intended for use within a console application. It prints
directly to the console and does not return any value.
"""

@staticmethod
Expand All @@ -537,20 +554,11 @@ def _run(cli: "bittensor.cli", subtensor: "bittensor.subtensor"):
cli.config.subtensor.network = "archive"
cli.config.subtensor.chain_endpoint = "wss://archive.chain.opentensor.ai:443"
with bittensor.__console__.status(":satellite: Loading delegates..."):
delegates: bittensor.DelegateInfo = subtensor.get_delegates()
try:
prev_delegates = subtensor.get_delegates(max(0, subtensor.block - 1200))
except SubstrateRequestException:
prev_delegates = None

if prev_delegates is None:
bittensor.__console__.print(
":warning: [yellow]Could not fetch delegates history[/yellow]"
)
delegates: list[bittensor.DelegateInfo] = subtensor.get_delegates()

show_delegates(
delegates,
prev_delegates=prev_delegates,
prev_delegates=None,
width=cli.config.get("width", None),
)

Expand All @@ -570,7 +578,8 @@ class NominateCommand:
"""
Executes the ``nominate`` command, which facilitates a wallet to become a delegate on the Bittensor network.

This command handles the nomination process, including wallet unlocking and verification of the hotkey's current delegate status.
This command handles the nomination process, including wallet unlocking and verification of the hotkey's current
delegate status.

The command performs several checks:

Expand All @@ -584,15 +593,18 @@ class NominateCommand:
- ``wallet.hotkey``: The name of the hotkey to use for the command.

Usage:
To run the command, the user must have a configured wallet with both hotkey and coldkey. If the wallet is not already nominated, this command will initiate the process.
To run the command, the user must have a configured wallet with both hotkey and coldkey. If the wallet is not
already nominated, this command will initiate the process.

Example usage::

btcli root nominate
btcli root nominate --wallet.name my_wallet --wallet.hotkey my_hotkey

Note:
This function is intended to be used as a CLI command. It prints the outcome directly to the console and does not return any value. It should not be called programmatically in user code due to its interactive nature and side effects on the network state.
This function is intended to be used as a CLI command. It prints the outcome directly to the console and does
not return any value. It should not be called programmatically in user code due to its interactive nature and
side effects on the network state.
"""

@staticmethod
Expand Down Expand Up @@ -684,7 +696,8 @@ def check_config(config: "bittensor.config"):

class MyDelegatesCommand:
"""
Executes the ``my_delegates`` command within the Bittensor CLI, which retrieves and displays a table of delegated stakes from a user's wallet(s) to various delegates on the Bittensor network.
Executes the ``my_delegates`` command within the Bittensor CLI, which retrieves and displays a table of delegated
stakes from a user's wallet(s) to various delegates on the Bittensor network.

The command provides detailed insights into the user's
staking activities and the performance of their chosen delegates.
Expand All @@ -711,7 +724,9 @@ class MyDelegatesCommand:
The command also sums and prints the total amount of Tao delegated across all wallets.

Usage:
The command can be run as part of the Bittensor CLI suite of tools and requires no parameters if a single wallet is used. If multiple wallets are present, the ``--all`` flag can be specified to aggregate information across all wallets.
The command can be run as part of the Bittensor CLI suite of tools and requires no parameters if a single wallet
is used. If multiple wallets are present, the ``--all`` flag can be specified to aggregate information across
all wallets.

Example usage::

Expand Down Expand Up @@ -741,7 +756,7 @@ def run(cli: "bittensor.cli"):
def _run(cli: "bittensor.cli", subtensor: "bittensor.subtensor"):
"""Delegates stake to a chain delegate."""
config = cli.config.copy()
if config.get("all", d=None) == True:
if config.get("all", d=None):
wallets = _get_coldkey_wallets_for_path(config.wallet.path)
else:
wallets = [bittensor.wallet(config=config)]
Expand Down
8 changes: 7 additions & 1 deletion tests/integration_tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2108,10 +2108,16 @@ class TestCLIWithNetworkUsingArgs(unittest.TestCase):
Test the CLI by passing args directly to the bittensor.cli factory
"""

def test_list_delegates(self, _):
@unittest.mock.patch.object(MockSubtensor, "get_delegates")
def test_list_delegates(self, mocked_get_delegates, _):
# Call
cli = bittensor.cli(args=["root", "list_delegates"])
cli.run()

# Assertions
# make sure get_delegates called once without previous state (current only)
mocked_get_delegates.assert_called_once()

def test_list_subnets(self, _):
cli = bittensor.cli(
args=[
Expand Down