test: add release by index tests

Author: ypatil12

src/test/unit/SlashEscrowFactoryUnit.t.sol

@@ -73,7 +73,7 @@ contract SlashEscrowFactoryUnitTests is EigenLayerUnitTestSetup, ISlashEscrowFac
         return factory.getPendingUnderlyingAmountForStrategy(operatorSet, slashId, strategy);
     }
 
-    /// @dev Starts a burn or redistribution for a given strategy and token.
+    /// @dev Starts a escrow for a given strategy and token.
     /// - Calls as the `StrategyManager`.
     /// - Asserts that the `StartEscrow` event is emitted.
     /// - Mocks the strategy sending the underlying token to the `SlashEscrow`.
@@ -105,16 +105,18 @@ contract SlashEscrowFactoryUnitTests is EigenLayerUnitTestSetup, ISlashEscrowFac
         factory.releaseSlashEscrow(operatorSet, slashId);
     }
 
+    /// @dev Calls the `releaseSlashEscrow` function as the redistribution recipient.
+    /// - Asserts that the `Escrow` event is emitted
     function _releaseSlashEscrowByIndex(OperatorSet memory operatorSet, uint slashId, uint index) internal {
         (IStrategy[] memory strategies) = factory.getPendingStrategiesForSlashId(operatorSet, slashId);
 
         address redistributionRecipient = allocationManagerMock.getRedistributionRecipient(operatorSet);
 
         cheats.expectEmit(true, true, true, true);
-        emit EscrowComplete(operatorSet, slashId, strategies[index], defaultRedistributionRecipient);
+        emit EscrowComplete(operatorSet, slashId, strategies[index], redistributionRecipient);
 
         // If the redistribution recipient is any address
-        if (redistributionRecipient != DEFAULT_BURN_ADDRESS) cheats.prank(defaultRedistributionRecipient);
+        if (redistributionRecipient != DEFAULT_BURN_ADDRESS) cheats.prank(redistributionRecipient);
         else cheats.prank(cheats.randomAddress());
         factory.releaseSlashEscrowByIndex(operatorSet, slashId, index);
 
@@ -125,7 +127,7 @@ contract SlashEscrowFactoryUnitTests is EigenLayerUnitTestSetup, ISlashEscrowFac
         assertTrue(slashEscrow.verifyDeploymentParameters(factory, slashEscrowImplementation, operatorSet, slashId));
     }
 
-    /// @dev Asserts that the operator set and slash ID are pending, and that the strategy and underlying amount are in the pending burn or redistributions.
+    /// @dev Asserts that the operator set and slash ID are pending, and that the strategy and underlying amount are in the pending escrows.
     function _checkStartEscrows(
         OperatorSet memory operatorSet,
         uint slashId,
@@ -146,7 +148,7 @@ contract SlashEscrowFactoryUnitTests is EigenLayerUnitTestSetup, ISlashEscrowFac
         // Assert that the underlying amount in escrow for the (operator set, slash ID, strategy) is correct.
         assertEq(_getPendingUnderlyingAmountForStrategy(operatorSet, slashId, strategy, token), expectedUnderlyingAmount);
 
-        // Assert that the number of pending burn or redistributions is correct.
+        // Assert that the number of pending escrows is correct.
         (IStrategy[] memory strategies) = factory.getPendingStrategiesForSlashId(operatorSet, slashId);
 
         assertEq(strategies.length, expectedCount);
@@ -190,16 +192,16 @@ contract SlashEscrowFactoryUnitTests_initiateSlashEscrow is SlashEscrowFactoryUn
     function testFuzz_initiateSlashEscrow_multipleStrategies(uint r) public {
         // Initialize arrays to store test data for multiple strategies
         uint numStrategies = bound(r, 2, 10);
-        // Set up each strategy with random data and start burn/redistribution
+        // Set up each strategy with random data and start escrow
         for (uint i = 0; i < numStrategies; i++) {
             // Generate random strategy address and token
             IStrategy strategy = IStrategy(cheats.randomAddress());
             MockERC20 token = new MockERC20();
             uint underlyingAmount = cheats.randomUint();
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategy, token, underlyingAmount);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategy, token, underlyingAmount, i + 1);
         }
     }
@@ -262,31 +264,31 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrow is SlashEscrowFactoryUni
         MockERC20[] memory tokens = new MockERC20[](numStrategies);
         uint[] memory underlyingAmounts = new uint[](numStrategies);
 
-        // Randomly update the redistribution to be the default burn address
-        _setRedistributionRecipient(r % 2 == 0);
+        // // Randomly update the redistribution to be the default burn address
+        // _setRedistributionRecipient(r % 2 == 0);
 
-        // Set up each strategy with random data and start burn/redistribution
+        // Set up each strategy with random data and start escrow
         for (uint i = 0; i < numStrategies; i++) {
             // Generate random strategy address and token
             strategies[i] = IStrategy(cheats.randomAddress());
             tokens[i] = new MockERC20();
             underlyingAmounts[i] = cheats.randomUint();
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
         }
 
-        // Advance time to allow burn/redistribution to occur
+        // Advance time to allow escrow to occur
         _rollForwardDefaultEscrowDelay();
 
         // Set up mock calls for each strategy's underlying token
         for (uint i = numStrategies; i > 0; i--) {
             _mockStrategyUnderlyingTokenCall(strategies[i - 1], address(tokens[i - 1]));
         }
 
-        // Execute the burn/redistribution
+        // Execute the escrow
         _releaseSlashEscrow(defaultOperatorSet, defaultSlashId);
 
         // Checks
@@ -297,7 +299,7 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrow is SlashEscrowFactoryUni
         assertEq(factory.getTotalPendingOperatorSets(), 0);
         assertEq(factory.getTotalPendingSlashIds(defaultOperatorSet), 0);
 
-        // Assert that the strategies and underlying amounts are no longer in the pending burn or redistributions.
+        // Assert that the strategies and underlying amounts are no longer in the pending escrows.
         assertEq(factory.getTotalPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId), 0);
 
         // Assert that the underlying amounts are no longer set.
@@ -339,9 +341,9 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrow is SlashEscrowFactoryUni
             cheats.prank(defaultOwner);
             factory.setStrategyEscrowDelay(strategies[i], delays[i]);
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
         }
 
@@ -359,7 +361,7 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrow is SlashEscrowFactoryUni
             _mockStrategyUnderlyingTokenCall(strategies[i], address(tokens[i]));
         }
 
-        // Execute the burn/redistribution
+        // Execute the escrow
         _releaseSlashEscrow(defaultOperatorSet, defaultSlashId);
 
         // Verify that all strategies have been processed
@@ -393,9 +395,9 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrow is SlashEscrowFactoryUni
 
         // Set up numEscrows slash escrows for the same operator set
         for (uint i = 0; i < numEscrows; i++) {
-            // Start burn/redistribution for this slash
+            // Start escrow for this slash
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId + i, strategies[0], tokens[0], underlyingAmounts[0]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId + i, strategies[0], tokens[0], underlyingAmounts[0], 1);
         }
 
@@ -476,7 +478,7 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrowByIndex is SlashEscrowFac
     }
 
     /// @dev Tests that multiple strategies can be burned or redistributed across multiple calls
-    function testFuzz_releaseSlashEscrow_multipleStrategies_sameDelay(uint r) public {
+    function testFuzz_releaseSlashEscrowByIndex__multipleStrategies_sameDelay(uint r) public {
         // Initialize arrays to store test data for multiple strategies
         uint numStrategies = bound(r, 2, 10);
         IStrategy[] memory strategies = new IStrategy[](numStrategies);
@@ -486,20 +488,20 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrowByIndex is SlashEscrowFac
         // Randomly update the redistribution to be the default burn address
         _setRedistributionRecipient(r % 2 == 0);
 
-        // Set up each strategy with random data and start burn/redistribution
+        // Set up each strategy with random data and start escrow
         for (uint i = 0; i < numStrategies; i++) {
             // Generate random strategy address and token
             strategies[i] = IStrategy(cheats.randomAddress());
             tokens[i] = new MockERC20();
             underlyingAmounts[i] = cheats.randomUint();
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
         }
 
-        // Advance time to allow burn/redistribution to occur
+        // Advance time to allow escrow to occur
         _rollForwardDefaultEscrowDelay();
 
         // Set up mock calls for each strategy's underlying token
@@ -517,7 +519,7 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrowByIndex is SlashEscrowFac
         assertTrue(factory.isPendingSlashId(defaultOperatorSet, defaultSlashId));
         assertEq(factory.getTotalPendingOperatorSets(), 1);
         assertEq(factory.getTotalPendingSlashIds(defaultOperatorSet), 1);
-        assertEq(factory.getTotalPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId), numStrategies - 1);
+        assertEq(factory.getTotalPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId), 1);
 
         // Release the last slash escrow
         _releaseSlashEscrowByIndex(defaultOperatorSet, defaultSlashId, 0);
@@ -530,7 +532,67 @@ contract SlashEscrowFactoryUnitTests_releaseSlashEscrowByIndex is SlashEscrowFac
         assertEq(factory.getTotalPendingOperatorSets(), 0);
         assertEq(factory.getTotalPendingSlashIds(defaultOperatorSet), 0);
 
-        // Assert that the strategies and underlying amounts are no longer in the pending burn or redistributions.
+        // Assert that the strategies and underlying amounts are no longer in the pending escrows.
+        assertEq(factory.getTotalPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId), 0);
+
+        // Assert that the underlying amounts are no longer set.
+        for (uint i = numStrategies; i > 0; i--) {
+            assertEq(_getPendingUnderlyingAmountForStrategy(defaultOperatorSet, defaultSlashId, strategies[i - 1], tokens[i - 1]), 0);
+        }
+
+        // Assert that the start block for the (operator set, slash ID) is no longer set.
+        assertEq(factory.getEscrowStartBlock(defaultOperatorSet, defaultSlashId), 0);
+    }
+
+    /// @dev Tests that multiple strategies can be burned or redistributed across multiple calls
+    function testFuzz_releaseSlashEscrowByIndex__multipleStrategies_byIndexThenAll(uint r) public {
+        // Initialize arrays to store test data for multiple strategies
+        uint numStrategies = bound(r, 2, 10);
+        IStrategy[] memory strategies = new IStrategy[](numStrategies);
+        MockERC20[] memory tokens = new MockERC20[](numStrategies);
+        uint[] memory underlyingAmounts = new uint[](numStrategies);
+
+        // Randomly update the redistribution to be the default burn address
+        _setRedistributionRecipient(r % 2 == 0);
+
+        // Set up each strategy with random data and start escrow
+        for (uint i = 0; i < numStrategies; i++) {
+            // Generate random strategy address and token
+            strategies[i] = IStrategy(cheats.randomAddress());
+            tokens[i] = new MockERC20();
+            underlyingAmounts[i] = cheats.randomUint();
+
+            // Start escrow for this strategy
+            _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
+            // Verify the escrow was started correctly
+            _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
+        }
+
+        // Advance time to allow escrow to occur
+        _rollForwardDefaultEscrowDelay();
+
+        // Release the first index
+        _releaseSlashEscrowByIndex(defaultOperatorSet, defaultSlashId, 0);
+
+        // Assert that the slashId and operatorSet are still pending
+        assertTrue(factory.isPendingOperatorSet(defaultOperatorSet));
+        assertTrue(factory.isPendingSlashId(defaultOperatorSet, defaultSlashId));
+        assertEq(factory.getTotalPendingOperatorSets(), 1);
+        assertEq(factory.getTotalPendingSlashIds(defaultOperatorSet), 1);
+        assertEq(factory.getTotalPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId), numStrategies - 1);
+
+        // Release remaining
+        _releaseSlashEscrow(defaultOperatorSet, defaultSlashId);
+
+        // Checks
+
+        // Assert that the operator set and slash ID are no longer pending.
+        assertFalse(factory.isPendingOperatorSet(defaultOperatorSet));
+        assertFalse(factory.isPendingSlashId(defaultOperatorSet, defaultSlashId));
+        assertEq(factory.getTotalPendingOperatorSets(), 0);
+        assertEq(factory.getTotalPendingSlashIds(defaultOperatorSet), 0);
+
+        // Assert that the strategies and underlying amounts are no longer in the pending escrows.
         assertEq(factory.getTotalPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId), 0);
 
         // Assert that the underlying amounts are no longer set.
@@ -640,9 +702,9 @@ contract SlashEscrowFactoryUnitTests_getBurnOrRedistributionDelay is SlashEscrow
             cheats.prank(defaultOwner);
             factory.setStrategyEscrowDelay(strategies[i], delays[i]);
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
         }
 
@@ -678,9 +740,9 @@ contract SlashEscrowFactoryUnitTests_getEscrowDelay is SlashEscrowFactoryUnitTes
             cheats.prank(defaultOwner);
             factory.setStrategyEscrowDelay(strategies[i], delays[i]);
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
         }
 
@@ -707,10 +769,10 @@ contract SlashEscrowFactoryUnitTests_setGlobalEscrowDelay is SlashEscrowFactoryU
 
 contract SlashEscrowFactoryUnitTests_getPendingEscrows is SlashEscrowFactoryUnitTests {
     function test_getPendingEscrows_singleSlashId() public {
-        // Start burn/redistribution for a single strategy
+        // Start escrow for a single strategy
         _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, defaultStrategy, defaultToken, 100);
 
-        // Get pending burn/redistributions for the specific slash ID
+        // Get pending escrows for the specific slash ID
         (IStrategy[] memory strategies) = factory.getPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId);
 
         // Verify results
@@ -719,7 +781,7 @@ contract SlashEscrowFactoryUnitTests_getPendingEscrows is SlashEscrowFactoryUnit
     }
 
     function test_getPendingEscrows_multipleStrategies() public {
-        // Create multiple strategies and start burn/redistributions
+        // Create multiple strategies and start escrows
         IStrategy strategy1 = IStrategy(cheats.randomAddress());
         IStrategy strategy2 = IStrategy(cheats.randomAddress());
         MockERC20 token1 = new MockERC20();
@@ -728,7 +790,7 @@ contract SlashEscrowFactoryUnitTests_getPendingEscrows is SlashEscrowFactoryUnit
         _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategy1, token1, 100);
         _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategy2, token2, 200);
 
-        // Get pending burn/redistributions for the specific slash ID
+        // Get pending escrows for the specific slash ID
         (IStrategy[] memory strategies) = factory.getPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId);
 
         // Verify results
@@ -748,11 +810,11 @@ contract SlashEscrowFactoryUnitTests_getPendingEscrows is SlashEscrowFactoryUnit
         MockERC20 token1 = new MockERC20();
         MockERC20 token2 = new MockERC20();
 
-        // Start burn/redistributions for different slash IDs
+        // Start escrows for different slash IDs
         _initiateSlashEscrow(defaultOperatorSet, slashId1, strategy1, token1, 100);
         _initiateSlashEscrow(defaultOperatorSet, slashId2, strategy2, token2, 200);
 
-        // Get pending burn/redistributions for all slash IDs of the operator set
+        // Get pending escrows for all slash IDs of the operator set
         (IStrategy[][] memory strategies) = factory.getPendingStrategiesForSlashIds(defaultOperatorSet);
 
         // Verify results
@@ -770,7 +832,7 @@ contract SlashEscrowFactoryUnitTests_getPendingEscrows is SlashEscrowFactoryUnit
     }
 
     function test_getPendingEscrows_empty() public {
-        // Test with no pending burn/redistributions
+        // Test with no pending escrows
         (IStrategy[] memory strategies) = factory.getPendingStrategiesForSlashId(defaultOperatorSet, defaultSlashId);
         assertEq(strategies.length, 0);
 
@@ -812,9 +874,9 @@ contract SlashEscrowFactoryUnitTests_getEscrowCompleteBlock is SlashEscrowFactor
             cheats.prank(defaultOwner);
             factory.setStrategyEscrowDelay(strategies[i], delays[i]);
 
-            // Start burn/redistribution for this strategy
+            // Start escrow for this strategy
             _initiateSlashEscrow(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i]);
-            // Verify the burn/redistribution was started correctly
+            // Verify the escrow was started correctly
             _checkStartEscrows(defaultOperatorSet, defaultSlashId, strategies[i], tokens[i], underlyingAmounts[i], i + 1);
         }