Skip to content

test: add invariant check for staker strategy list #1197

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
ypatil12 merged 3 commits into from
Mar 3, 2025
Merged

test: add invariant check for staker strategy list #1197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
330ebc3
test: add invariant check for staker strategy list
ypatil12 Mar 2, 2025
931116f
chore: fix comments
ypatil12 Mar 2, 2025
00e11c7
fix: handle bc strat
ypatil12 Mar 2, 2025
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
46 changes: 46 additions & 0 deletions src/test/integration/IntegrationBase.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,48 @@ abstract contract IntegrationBase is IntegrationDeployer, TypeImporter {
assertEq(withdrawalRoot, delegationManager.calculateWithdrawalRoot(withdrawal), err);
}

function assert_StakerStrategyListEmpty(
User staker,
string memory err
) internal view {
IStrategy[] memory strategies = _getStakerStrategyList(staker);
assertEq(strategies.length, 0, err);
}

function assert_StrategyNotInStakerStrategyList(
User staker,
IStrategy strategy,
string memory err
) internal view {
// BEACONCHAIN_ETH_STRAT is not in the staker's strategy list
if (strategy == BEACONCHAIN_ETH_STRAT) return;

IStrategy[] memory strategies = _getStakerStrategyList(staker);
assertFalse(strategies.contains(strategy), err);
}

function assert_StrategiesInStakerStrategyList(
User staker,
IStrategy[] memory strategies,
string memory err
) internal view {
for(uint i = 0; i < strategies.length; i++) {
assert_StrategyInStakerStrategyList(staker, strategies[i], err);
}
}

function assert_StrategyInStakerStrategyList(
User staker,
IStrategy strategy,
string memory err
) internal view {
// BEACONCHAIN_ETH_STRAT is not in the staker's strategy list
if (strategy == BEACONCHAIN_ETH_STRAT) return;

IStrategy[] memory strategies = _getStakerStrategyList(staker);
assertTrue(strategies.contains(strategy), err);
}

function assert_PodBalance_Eq(
User staker,
uint expectedBalance,
Expand Down Expand Up @@ -3058,6 +3100,10 @@ abstract contract IntegrationBase is IntegrationDeployer, TypeImporter {
return curShares;
}

function _getStakerStrategyList(User staker) internal view returns (IStrategy[] memory) {
return strategyManager.getStakerStrategyList(address(staker));
}

function _getPrevStakerWithdrawableShares(User staker, IStrategy[] memory strategies) internal timewarp() returns (uint[] memory) {
return _getStakerWithdrawableShares(staker, strategies);
}
Expand Down
14 changes: 10 additions & 4 deletions src/test/integration/IntegrationChecks.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ contract IntegrationCheckUtils is IntegrationBase {
// and that the staker now has the expected amount of delegated shares in each strategy
assert_HasNoUnderlyingTokenBalance(staker, strategies, "staker should have transferred all underlying tokens");
assert_Snap_Added_Staker_DepositShares(staker, strategies, shares, "staker should expect shares in each strategy after depositing");
assert_StrategiesInStakerStrategyList(staker, strategies, "staker strategy list should contain all strategies");

if (delegationManager.isDelegated(address(staker))) {
User operator = User(payable(delegationManager.delegatedTo(address(staker))));
Expand All @@ -219,6 +220,7 @@ contract IntegrationCheckUtils is IntegrationBase {
// and that the staker now has the expected amount of delegated shares in each strategy
assert_HasUnderlyingTokenBalances(staker, strategies, tokenBalances, "staker should have transferred some underlying tokens");
assert_Snap_Added_Staker_DepositShares(staker, strategies, shares, "staker should expected shares in each strategy after depositing");
assert_StrategiesInStakerStrategyList(staker, strategies, "staker strategy list should contain all strategies");

if (delegationManager.isDelegated(address(staker))) {
User operator = User(payable(delegationManager.delegatedTo(address(staker))));
Expand Down Expand Up @@ -295,15 +297,17 @@ contract IntegrationCheckUtils is IntegrationBase {
check_Decreased_SlashableStake(operator, withdrawableShares, strategies);
// Check that the dsf is either reset to wad or unchanged
for (uint i = 0; i < strategies.length; i++) {
// For a full withdrawal, the dsf should be reset to wad
// For a full withdrawal, the dsf should be reset to wad & the staker strategy list should not contain the strategy
if (_getStakerDepositShares(staker, strategies[i].toArray())[0] == 0) {
assert_DSF_Reset(staker, strategies[i].toArray(),
"check_QueuedWithdrawal_State: dsf should be reset to wad");
assert_StrategyNotInStakerStrategyList(staker, strategies[i], "check_QueuedWithdrawal_State: staker strategy list should not contain strategy");
}
// For a partial withdrawal, the dsf should not be changed
// For a partial withdrawal, the dsf should not be changed & the strategy should still be in the staker strategy list
else {
assert_Snap_Unchanged_DSF(staker, strategies[i].toArray(),
"check_QueuedWithdrawal_State: dsf should not be changed");
assert_StrategyInStakerStrategyList(staker, strategies[i], "check_QueuedWithdrawal_State: staker strategy list should contain strategy");
}
}
}
Expand Down Expand Up @@ -347,13 +351,14 @@ contract IntegrationCheckUtils is IntegrationBase {
"check_Undelegate_State: stakers withdrawal should now be pending");
assert_DSF_Reset(staker, strategies,
"check_Undelegate_State: staker dsfs should be reset to wad");
assert_StakerStrategyListEmpty(staker, "check_Undelegate_State: staker strategy list should be empty");
assert_Snap_Added_QueuedWithdrawals(staker, withdrawals,
"check_Undelegate_State: staker should have increased nonce by withdrawals.length");
assert_Snap_Removed_OperatorShares(operator, strategies, stakerDelegatedShares,
"check_Undelegate_State: failed to remove operator shares");
assert_RemovedAll_Staker_DepositShares(staker, strategies, "check_Undelegate_State: failed to remove staker shares");
assert_RemovedAll_Staker_WithdrawableShares(staker, strategies,
"check_QueuedWithdrawal_State: failed to remove staker withdrawable shares");
"check_Undelegate_State: failed to remove staker withdrawable shares");
}

function check_Redelegate_State(
Expand Down Expand Up @@ -381,11 +386,12 @@ contract IntegrationCheckUtils is IntegrationBase {
"check_Redelegate_State: stakers withdrawal should now be pending");
assert_Snap_Added_QueuedWithdrawals(staker, withdrawals,
"check_Redelegate_State: staker should have increased nonce by withdrawals.length");
assert_StakerStrategyListEmpty(staker, "check_Redelegate_State: staker strategy list should be empty");
assert_Snap_Removed_OperatorShares(oldOperator, strategies, stakerDelegatedShares,
"check_Redelegate_State: failed to remove operator shares");
assert_RemovedAll_Staker_DepositShares(staker, strategies, "check_Undelegate_State: failed to remove staker shares");
assert_RemovedAll_Staker_WithdrawableShares(staker, strategies,
"check_QueuedWithdrawal_State: failed to remove staker withdrawable shares");
"check_Redelegate_State: failed to remove staker withdrawable shares");
assert_Snap_Unchanged_OperatorShares(newOperator,
"check_Redelegate_State: new operator shares should not have changed");
}
Expand Down
Loading