Skip to content

[Fix] fix max stake for single #996

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

Merged
camfairchild merged 15 commits into from
Dec 6, 2022
Merged

[Fix] fix max stake for single #996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3ff6422
fix max stake for a single key
camfairchild Nov 15, 2022
31cf9b6
use kwarg
camfairchild Nov 15, 2022
5309722
use tuple unpack
camfairchild Nov 15, 2022
908c23e
add tests for max stake fixes
camfairchild Nov 15, 2022
ae3e96a
fix test mock
camfairchild Nov 16, 2022
96c8e76
change testcase name
camfairchild Nov 16, 2022
f9e0ebb
Merge branch 'nobunaga' into fix/fix_max_stake_for_single
camfairchild Nov 16, 2022
f142e83
undo rename oops
camfairchild Nov 16, 2022
1d93219
grab amount kwarg instead
camfairchild Nov 16, 2022
59a061a
Merge branch 'nobunaga' into fix/fix_max_stake_for_single
unconst Nov 22, 2022
d53c88f
Merge branch 'nobunaga' into fix/fix_max_stake_for_single
camfairchild Dec 6, 2022
988b513
add comment/assert about single hk
camfairchild Dec 6, 2022
31fe756
dont remove synapse all test
camfairchild Dec 6, 2022
e50211e
Merge branch 'nobunaga' into fix/fix_max_stake_for_single
camfairchild Dec 6, 2022
8363ffa
fix accessor
camfairchild Dec 6, 2022
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
19 changes: 15 additions & 4 deletions bittensor/_cli/cli_impl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,9 +347,10 @@ def stake( self ):
bittensor.wallet( config = self.config, hotkey = hotkey ) for hotkey in self.config.wallet.get('hotkeys')
]
else:
# Do regular stake
subtensor.add_stake( wallet, amount = None if self.config.get('stake_all') else self.config.get('amount'), wait_for_inclusion = True, prompt = not self.config.no_prompt )
return None
# Only self.config.wallet.hotkey is specified.
# so we stake to that single hotkey.
assert self.config.wallet.hotkey is not None
wallets_to_stake_to = [ bittensor.wallet( config = self.config ) ]

# Otherwise we stake to multiple wallets

Expand All @@ -374,7 +375,8 @@ def stake( self ):
stake_amount_tao: float = self.config.get('amount')
if self.config.get('max_stake'):
wallet_stake: Balance = wallet.get_stake()
stake_amount_tao: float = self.config.get('max_stake') - wallet_stake.tao
stake_amount_tao: float = self.config.get('max_stake') - wallet_stake.tao

# If the max_stake is greater than the current wallet balance, stake the entire balance.
stake_amount_tao: float = min(stake_amount_tao, wallet_balance.tao)
if stake_amount_tao <= 0.00001: # Threshold because of fees, might create a loop otherwise
Expand All @@ -384,6 +386,11 @@ def stake( self ):
final_amounts.append(stake_amount_tao)
final_wallets.append(wallet)

if len(final_wallets) == 0:
# No wallets to stake to.
bittensor.__console__.print("Not enough balance to stake to any hotkeys or max_stake is less than current stake.")
return None

# Ask to stake
if not self.config.no_prompt:
if not Confirm.ask(f"Do you want to stake to the following keys from {wallet_0.name}:\n" + \
Expand All @@ -392,6 +399,10 @@ def stake( self ):
])
):
return None

if len(final_wallets) == 1:
# do regular stake
return subtensor.add_stake( wallet=final_wallets[0], amount = None if self.config.get('stake_all') else final_amounts[0], wait_for_inclusion = True, prompt = not self.config.no_prompt )

subtensor.add_stake_multiple( wallets = final_wallets, amounts = None if self.config.get('stake_all') else final_amounts, wait_for_inclusion = True, prompt = False )

Expand Down
266 changes: 258 additions & 8 deletions tests/integration_tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,8 @@ def test_unstake_with_multiple_hotkeys_max_stake_not_enough_stake( self ):
## https://docs.python.org/3.7/library/unittest.mock.html#call
## Uses the 1st index as args list
## call.args only works in Python 3.8+
mock_wallets_ = mock_unstake.mock_calls[0][2]['wallets']
args, kwargs = mock_unstake.call_args
mock_wallets_ = kwargs['wallets']


# We shouldn't unstake from hk1 as it has less than max_stake staked
Expand Down Expand Up @@ -1079,7 +1080,7 @@ def test_stake_with_multiple_hotkeys_max_stake_not_enough_balance( self ):

with patch('bittensor.wallet') as mock_create_wallet:
mock_create_wallet.side_effect = mock_wallets
with patch('bittensor.Subtensor.add_stake_multiple', return_value=True) as mock_add_stake:
with patch('bittensor.Subtensor.add_stake', return_value=True) as mock_add_stake:
cli.run()
mock_create_wallet.assert_has_calls(
[
Expand All @@ -1092,17 +1093,266 @@ def test_stake_with_multiple_hotkeys_max_stake_not_enough_balance( self ):

total_staked = 0.0

# Python 3.7
## https://docs.python.org/3.7/library/unittest.mock.html#call
## Uses the 2nd index as kwargs dict
## call.kwargs only works in Python 3.8+
amounts_passed = mock_add_stake.mock_calls[0][2]['amounts']
args, kwargs = mock_add_stake.call_args
total_staked = kwargs['amount']

# We should not try to stake more than the mock_balance
self.assertAlmostEqual(total_staked, mock_balance.tao, delta=0.001)

def test_stake_with_single_hotkey_max_stake( self ):
bittensor.subtensor.register = MagicMock(return_value = True)

config = self.config
config.command = "stake"
config.subtensor._mock = True
config.subtensor.network = "mock"
config.no_prompt = True
# Notie amount is not specified
config.max_stake = 15.0 # The keys should have at most 15.0 tao staked after
config.wallet.name = "fake_wallet"
config.wallet.hotkeys = [
'hk0'
]
config.wallet.all_hotkeys = False
# Notice no max_stake specified
config.no_version_checking = False

mock_balance = bittensor.Balance(15.0) # Enough to stake 15.0 on one hotkey

mock_coldkey = "" # Not None

mock_stakes: Dict[str, float] = {
# All have more than 5.0 stake
'hk0': bittensor.Balance.from_float(10.0),
}

mock_wallets = [
SimpleNamespace(
name = config.wallet.name,
hotkey_str = config.wallet.hotkeys[0],
get_stake = MagicMock(
return_value = mock_stakes[config.wallet.hotkeys[0]]
),
is_registered = MagicMock(
return_value = True
),

_coldkey = mock_coldkey,
coldkey = MagicMock(
return_value=mock_coldkey
)
)
] + [
SimpleNamespace(
name = config.wallet.name,
hotkey_str = hk,
get_stake = MagicMock(
return_value = mock_stakes[hk]
),
is_registered = MagicMock(
return_value = True
)
) for hk in config.wallet.hotkeys
]

total_staked = sum(amounts_passed)
# The 0th wallet is created twice during unstake
mock_wallets[1]._coldkey = mock_coldkey
mock_wallets[1].coldkey = MagicMock(
return_value=mock_coldkey
)
mock_wallets[1].get_balance = MagicMock(
return_value = mock_balance
)

cli = bittensor.cli(config)

with patch('bittensor.wallet') as mock_create_wallet:
mock_create_wallet.side_effect = mock_wallets
with patch('bittensor.Subtensor.add_stake', return_value=True) as mock_add_stake:
cli.run()
mock_create_wallet.assert_has_calls(
[
call(config=ANY, hotkey=hk) for hk in config.wallet.hotkeys
],
any_order=True
)
mock_add_stake.assert_has_calls(
[call(wallet=mock_wallets[1], amount=CLOSE_IN_VALUE((config.max_stake - mock_stakes[mock_wallets[1].hotkey_str].tao), 0.001), wait_for_inclusion=True, prompt=False)],
any_order = True
)

def test_stake_with_single_hotkey_max_stake_not_enough_balance( self ):
bittensor.subtensor.register = MagicMock(return_value = True)

config = self.config
config.command = "stake"
config.subtensor._mock = True
config.subtensor.network = "mock"
config.no_prompt = True
# Notie amount is not specified
config.max_stake = 15.0 # The keys should have at most 15.0 tao staked after
config.wallet.name = "fake_wallet"
config.wallet.hotkeys = [
'hk0'
]
config.wallet.all_hotkeys = False
config.no_version_checking = False

# Notice no max_stake specified

mock_balance = bittensor.Balance(1.0) # Not enough to stake 15.0 on the hotkey

mock_coldkey = "" # Not None

mock_stakes: Dict[str, float] = {
# has 5.0 stake
'hk0': bittensor.Balance.from_float(5.0)
}

mock_wallets = [
SimpleNamespace(
name = config.wallet.name,
hotkey_str = config.wallet.hotkeys[0],
get_stake = MagicMock(
return_value = mock_stakes[config.wallet.hotkeys[0]]
),
is_registered = MagicMock(
return_value = True
),

_coldkey = mock_coldkey,
coldkey = MagicMock(
return_value=mock_coldkey
)
)
] + [
SimpleNamespace(
name = config.wallet.name,
hotkey_str = hk,
get_stake = MagicMock(
return_value = mock_stakes[hk]
),
is_registered = MagicMock(
return_value = True
)
) for hk in config.wallet.hotkeys
]

# The 0th wallet is created twice during unstake
mock_wallets[1]._coldkey = mock_coldkey
mock_wallets[1].coldkey = MagicMock(
return_value=mock_coldkey
)
mock_wallets[1].get_balance = MagicMock(
return_value = mock_balance
)

cli = bittensor.cli(config)

with patch('bittensor.wallet') as mock_create_wallet:
mock_create_wallet.side_effect = mock_wallets
with patch('bittensor.Subtensor.add_stake', return_value=True) as mock_add_stake:
cli.run()
mock_create_wallet.assert_has_calls(
[
call(config=ANY, hotkey=hk) for hk in config.wallet.hotkeys
],
any_order=True
)
# We should stake what we have in the balance
mock_add_stake.assert_called_once()

total_staked = 0.0

args, kwargs = mock_add_stake.call_args
total_staked = kwargs['amount']

# We should not try to stake more than the mock_balance
self.assertAlmostEqual(total_staked, mock_balance.tao, delta=0.001)

def test_stake_with_single_hotkey_max_stake_enough_stake( self ):
# tests max stake when stake >= max_stake already
bittensor.subtensor.register = MagicMock(return_value = True)

config = self.config
config.command = "stake"
config.subtensor._mock = True
config.subtensor.network = "mock"
config.no_prompt = True
# Notie amount is not specified
config.max_stake = 15.0 # The keys should have at most 15.0 tao staked after
config.wallet.name = "fake_wallet"
config.wallet.hotkeys = [
'hk0'
]
config.wallet.all_hotkeys = False
config.no_version_checking = False

# Notice no max_stake specified

mock_balance = bittensor.Balance(30.0) # enough to stake 15.0 on the hotkey

mock_coldkey = "" # Not None

mock_stakes: Dict[str, float] = {
# already has 15.0 stake
'hk0': bittensor.Balance.from_float(15.0)
}

mock_wallets = [
SimpleNamespace(
name = config.wallet.name,
hotkey_str = config.wallet.hotkeys[0],
get_stake = MagicMock(
return_value = mock_stakes[config.wallet.hotkeys[0]]
),
is_registered = MagicMock(
return_value = True
),

_coldkey = mock_coldkey,
coldkey = MagicMock(
return_value=mock_coldkey
)
)
] + [
SimpleNamespace(
name = config.wallet.name,
hotkey_str = hk,
get_stake = MagicMock(
return_value = mock_stakes[hk]
),
is_registered = MagicMock(
return_value = True
)
) for hk in config.wallet.hotkeys
]

# The 0th wallet is created twice during unstake
mock_wallets[1]._coldkey = mock_coldkey
mock_wallets[1].coldkey = MagicMock(
return_value=mock_coldkey
)
mock_wallets[1].get_balance = MagicMock(
return_value = mock_balance
)

cli = bittensor.cli(config)

with patch('bittensor.wallet') as mock_create_wallet:
mock_create_wallet.side_effect = mock_wallets
with patch('bittensor.Subtensor.add_stake', return_value=True) as mock_add_stake:
cli.run()
mock_create_wallet.assert_has_calls(
[
call(config=ANY, hotkey=hk) for hk in config.wallet.hotkeys
],
any_order=True
)
# We should stake what we have in the balance
mock_add_stake.assert_not_called()


def test_register( self ):

config = self.config
Expand Down