chore: rename burnable -> burnOrRedistributable

Author: ypatil12

src/contracts/core/DelegationManager.sol

@@ -713,7 +713,7 @@ contract DelegationManager is
         // Emit event for operator shares being slashed
         emit OperatorSharesSlashed(operator, strategy, totalDepositSharesToBurn);
 
-        _getShareManager(strategy).increaseBurnableShares(operatorSet, slashId, strategy, totalDepositSharesToBurn);
+        _getShareManager(strategy).increaseBurnOrRedistributableShares(operatorSet, slashId, strategy, totalDepositSharesToBurn);
 
         return totalDepositSharesToBurn;
     }

src/contracts/core/SlashEscrowFactory.sol

@@ -89,11 +89,11 @@ contract SlashEscrowFactory is Initializable, SlashEscrowFactoryStorage, Ownable
 
         require(!_paused[operatorSet.key()][slashId], IPausable.CurrentlyPaused());
 
-        // Calling `decreaseBurnableShares` will transfer the underlying tokens to the `SlashEscrow`.
-        // NOTE: While `decreaseBurnableShares` may have already been called, we call it again to ensure that the
+        // Calling `decreaseBurnOrRedistributableShares` will transfer the underlying tokens to the `SlashEscrow`.
+        // NOTE: While `decreaseBurnOrRedistributableShares` may have already been called, we call it again to ensure that the
         // underlying tokens are actually in escrow before processing and removing storage (which would otherwise prevent
         // the tokens from being released).
-        strategyManager.decreaseBurnableShares(operatorSet, slashId);
+        strategyManager.decreaseBurnOrRedistributableShares(operatorSet, slashId);
 
         // Create storage pointers for readability.
         EnumerableSet.Bytes32Set storage pendingOperatorSets = _pendingOperatorSets;

src/contracts/core/StrategyManager.sol

@@ -147,39 +147,39 @@ contract StrategyManager is
     }
 
     /// @inheritdoc IShareManager
-    function increaseBurnableShares(
+    function increaseBurnOrRedistributableShares(
         OperatorSet calldata operatorSet,
         uint256 slashId,
         IStrategy strategy,
         uint256 sharesToBurn
     ) external onlyDelegationManager nonReentrant {
-        emit BurnOrRedistributableSharesIncreased(operatorSet, slashId, strategy, sharesToBurn);
-
         EnumerableMap.AddressToUintMap storage operatorSetBurnableShares =
-            _operatorSetBurnableShares[operatorSet.key()][slashId];
+            _burnOrRedistributableShares[operatorSet.key()][slashId];
 
         if (sharesToBurn != 0) {
             operatorSetBurnableShares.set(address(strategy), sharesToBurn);
 
             // Notify the `SlashEscrowFactory` contract that it received underlying tokens to burn or redistribute.
             slashEscrowFactory.initiateSlashEscrow(operatorSet, slashId, strategy);
+
+            emit BurnOrRedistributableSharesIncreased(operatorSet, slashId, strategy, sharesToBurn);
         }
     }
 
     /// @inheritdoc IStrategyManager
-    function decreaseBurnableShares(OperatorSet calldata operatorSet, uint256 slashId) external nonReentrant {
-        EnumerableMap.AddressToUintMap storage operatorSetBurnableShares =
-            _operatorSetBurnableShares[operatorSet.key()][slashId];
+    function decreaseBurnOrRedistributableShares(OperatorSet calldata operatorSet, uint256 slashId) external nonReentrant {
+        EnumerableMap.AddressToUintMap storage burnOrRedistributableShares =
+            _burnOrRedistributableShares[operatorSet.key()][slashId];
 
         // Cache length to avoid sloads.
-        uint256 length = operatorSetBurnableShares.length();
+        uint256 length = burnOrRedistributableShares.length();
 
         // Iterate over all strategies that have burnable shares.
         for (uint256 i = 0; i < length; ++i) {
-            (address strategy, uint256 sharesToBurn) = operatorSetBurnableShares.at(i);
+            (address strategy, uint256 sharesToBurn) = burnOrRedistributableShares.at(i);
 
             // Remove the strategy from the operator set burnable shares.
-            operatorSetBurnableShares.remove(address(strategy));
+            burnOrRedistributableShares.remove(address(strategy));
 
             // Withdraw the shares to the slash escrow.
             IStrategy(strategy).withdraw({
@@ -199,7 +199,7 @@ contract StrategyManager is
     ) external nonReentrant {
         (, uint256 sharesToBurn) = EnumerableMap.tryGet(burnableShares, address(strategy));
         EnumerableMap.remove(burnableShares, address(strategy));
-        emit BurnOrRedistributableSharesDecreased(OperatorSet(address(this), 0), 0, strategy, sharesToBurn);
+        emit BurnableSharesDecreased(strategy, sharesToBurn);
 
         // Burning acts like withdrawing, except that the destination is to the burn address.
         // If we have no shares to burn, we don't need to call the strategy.

src/contracts/core/StrategyManagerStorage.sol

@@ -75,11 +75,11 @@ abstract contract StrategyManagerStorage is IStrategyManager {
     mapping(IStrategy strategy => bool) private __deprecated_thirdPartyTransfersForbidden;
 
     /// @notice Returns the amount of `shares` that have been slashed on EigenLayer but not burned yet. Takes 3 storage slots.
+    /// @dev After the redistribution upgrade, this storage variable is no longer used, and will be deprecated.
     EnumerableMap.AddressToUintMap internal burnableShares;
 
-    /// @notice Returns the amount of `shares` that have been slashed on EigenLayer but not burned yet. Takes 3 storage slots.
-    mapping(bytes32 operatorSetKey => mapping(uint256 slashId => EnumerableMap.AddressToUintMap)) internal
-        _operatorSetBurnableShares;
+    /// @notice Returns the amount of `shares` that have been slashed on EigenLayer but not marked for burning or redistribution yet.
+    mapping(bytes32 operatorSetKey => mapping(uint256 slashId => EnumerableMap.AddressToUintMap)) internal _burnOrRedistributableShares;
 
     // Construction
 
@@ -96,5 +96,5 @@ abstract contract StrategyManagerStorage is IStrategyManager {
      * variables without shifting down storage in the inheritance chain.
      * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
      */
-    uint256[33] private __gap;
+    uint256[35] private __gap;
 }

src/contracts/interfaces/IShareManager.sol

@@ -47,7 +47,7 @@ interface IShareManager {
      * @param addedSharesToBurn The amount of added shares to burn.
      * @dev This function is only called by the DelegationManager when an operator is slashed.
      */
-    function increaseBurnableShares(
+    function increaseBurnOrRedistributableShares(
         OperatorSet calldata operatorSet,
         uint256 slashId,
         IStrategy strategy,

src/contracts/interfaces/IStrategyManager.sol

@@ -44,15 +44,21 @@ interface IStrategyManagerEvents {
     /// @notice Emitted when a strategy is removed from the approved list of strategies for deposit
     event StrategyRemovedFromDepositWhitelist(IStrategy strategy);
 
-    /// @notice Emitted when an operator is slashed and shares to be burned are increased
+    /// @notice Emitted when an operator is slashed and shares to be burned or redistributed are increased
     event BurnOrRedistributableSharesIncreased(
         OperatorSet operatorSet, uint256 slashId, IStrategy strategy, uint256 shares
     );
 
-    /// @notice Emitted when shares are burned
+    /// @notice Emitted when shares marked for burning or redistribution are decreased and transferred to the `SlashEscrow`
     event BurnOrRedistributableSharesDecreased(
         OperatorSet operatorSet, uint256 slashId, IStrategy strategy, uint256 shares
     );
+
+    /// @notice Emitted when shares are burnt
+    /// @dev This event is only emitted in the pre-redistribution slash path
+    event BurnableSharesDecreased(
+        IStrategy strategy, uint256 shares
+    );
 }
 
 /**
@@ -123,6 +129,7 @@ interface IStrategyManager is IStrategyManagerErrors, IStrategyManagerEvents, IS
      * @notice Burns Strategy shares for the given strategy by calling into the strategy to transfer
      * to the default burn address.
      * @param strategy The strategy to burn shares in.
+     * @dev This function will be deprecated in a release after redistribution
      */
     function burnShares(
         IStrategy strategy
@@ -133,7 +140,7 @@ interface IStrategyManager is IStrategyManagerErrors, IStrategyManagerEvents, IS
      * @param operatorSet The operator set to burn shares in.
      * @param slashId The slash ID to burn shares in.
      */
-    function decreaseBurnableShares(OperatorSet calldata operatorSet, uint256 slashId) external;
+    function decreaseBurnOrRedistributableShares(OperatorSet calldata operatorSet, uint256 slashId) external;
 
     /**
      * @notice Owner-only function to change the `strategyWhitelister` address.

src/contracts/pods/EigenPodManager.sol

@@ -233,7 +233,7 @@ contract EigenPodManager is
     }
 
     /// @inheritdoc IShareManager
-    function increaseBurnableShares(
+    function increaseBurnOrRedistributableShares(
         OperatorSet calldata,
         uint256,
         IStrategy,

src/test/mocks/StrategyManagerMock.sol

@@ -106,7 +106,7 @@ contract StrategyManagerMock is Test {
         return (existingShares, addedShares);
     }
 
-    function decreaseBurnableShares(IStrategy strategy, uint sharesToBurn) external {}
+    function decreaseBurnOrRedistributableShares(IStrategy strategy, uint sharesToBurn) external {}
 
     function _getStrategyIndex(address staker, IStrategy strategy) internal view returns (uint) {
         IStrategy[] memory strategies = strategiesToReturn[staker];

src/test/unit/EigenPodManagerUnit.t.sol

@@ -662,20 +662,20 @@ contract EigenPodManagerUnitTests_BeaconChainETHBalanceUpdateTests is EigenPodMa
     }
 }
 
-contract EigenPodManagerUnitTests_increaseBurnableShares is EigenPodManagerUnitTests {
+contract EigenPodManagerUnitTests_increaseBurnOrRedistributableShares is EigenPodManagerUnitTests {
     function testFuzz_onlyDelegationManager(address invalidCaller) public filterFuzzedAddressInputs(invalidCaller) {
         cheats.assume(invalidCaller != address(delegationManagerMock));
         cheats.prank(invalidCaller);
         cheats.expectRevert(IEigenPodManagerErrors.OnlyDelegationManager.selector);
-        eigenPodManager.increaseBurnableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, 1 ether);
+        eigenPodManager.increaseBurnOrRedistributableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, 1 ether);
     }
 
     function testFuzz_singleDeposit(uint increasedBurnableShares) public {
         cheats.expectEmit(true, true, true, true, address(eigenPodManager));
         emit BurnableETHSharesIncreased(increasedBurnableShares);
 
         cheats.prank(address(delegationManagerMock));
-        eigenPodManager.increaseBurnableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, increasedBurnableShares);
+        eigenPodManager.increaseBurnOrRedistributableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, increasedBurnableShares);
 
         assertEq(eigenPodManager.burnableETHShares(), increasedBurnableShares, "Burnable shares not updated correctly");
     }
@@ -687,14 +687,14 @@ contract EigenPodManagerUnitTests_increaseBurnableShares is EigenPodManagerUnitT
         cheats.expectEmit(true, true, true, true, address(eigenPodManager));
         emit BurnableETHSharesIncreased(existingBurnableShares);
         cheats.prank(address(delegationManagerMock));
-        eigenPodManager.increaseBurnableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, existingBurnableShares);
+        eigenPodManager.increaseBurnOrRedistributableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, existingBurnableShares);
 
         assertEq(eigenPodManager.burnableETHShares(), existingBurnableShares, "Burnable shares not setup correctly");
 
         cheats.expectEmit(true, true, true, true, address(eigenPodManager));
         emit BurnableETHSharesIncreased(increasedBurnableShares);
         cheats.prank(address(delegationManagerMock));
-        eigenPodManager.increaseBurnableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, increasedBurnableShares);
+        eigenPodManager.increaseBurnOrRedistributableShares(OperatorSet(address(0), 0), 0, beaconChainETHStrategy, increasedBurnableShares);
 
         assertEq(
             eigenPodManager.burnableETHShares(), existingBurnableShares + increasedBurnableShares, "Burnable shares not updated correctly"

src/test/unit/StrategyManagerUnit.t.sol

@@ -1070,26 +1070,26 @@ contract StrategyManagerUnitTests_withdrawSharesAsTokens is StrategyManagerUnitT
     }
 }
 
-contract StrategyManagerUnitTests_increaseBurnableShares is StrategyManagerUnitTests {
+contract StrategyManagerUnitTests_increaseBurnOrRedistributableShares is StrategyManagerUnitTests {
     function test_Revert_DelegationManagerModifier() external {
         DelegationManagerMock invalidDelegationManager = new DelegationManagerMock();
         cheats.prank(address(invalidDelegationManager));
         cheats.expectRevert(IStrategyManagerErrors.OnlyDelegationManager.selector);
-        strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, dummyStrat, 1);
+        strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, dummyStrat, 1);
     }
 
-    // function testFuzz_increaseBurnableShares(uint addedSharesToBurn) external {
+    // function testFuzz_increaseBurnOrRedistributableShares(uint addedSharesToBurn) external {
     //     IStrategy strategy = dummyStrat;
     //     cheats.expectEmit(true, true, true, true, address(strategyManager));
     //     emit BurnOrRedistributableSharesIncreased(defaultOperatorSet, defaultSlashId, strategy, addedSharesToBurn);
     //     cheats.prank(address(delegationManagerMock));
-    //     strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, strategy, addedSharesToBurn);
+    //     strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, strategy, addedSharesToBurn);
     //     assertEq(
     //         strategyManager.getBurnableShares(strategy), addedSharesToBurn, "strategyManager.burnableShares(strategy) != addedSharesToBurn"
     //     );
     // }
 
-    // function testFuzz_increaseBurnableShares_existingShares(uint existingBurnableShares, uint addedSharesToBurn) external {
+    // function testFuzz_increaseBurnOrRedistributableShares_existingShares(uint existingBurnableShares, uint addedSharesToBurn) external {
     //     // preventing fuzz overflow, in practice StrategyBase has a 1e38 - 1 maxShares limit so this won't
     //     // be an issue on mainnet/testnet environments
     //     existingBurnableShares = bound(existingBurnableShares, 1, type(uint).max / 2);
@@ -1098,7 +1098,7 @@ contract StrategyManagerUnitTests_increaseBurnableShares is StrategyManagerUnitT
     //     cheats.prank(address(delegationManagerMock));
     //     cheats.expectEmit(true, true, true, true, address(strategyManager));
     //     emit BurnOrRedistributableSharesIncreased(defaultOperatorSet, defaultSlashId, strategy, existingBurnableShares);
-    //     strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, strategy, existingBurnableShares);
+    //     strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, strategy, existingBurnableShares);
     //     assertEq(
     //         strategyManager.getBurnableShares(strategy),
     //         existingBurnableShares,
@@ -1108,7 +1108,7 @@ contract StrategyManagerUnitTests_increaseBurnableShares is StrategyManagerUnitT
     //     cheats.prank(address(delegationManagerMock));
     //     cheats.expectEmit(true, true, true, true, address(strategyManager));
     //     emit BurnOrRedistributableSharesIncreased(defaultOperatorSet, defaultSlashId, strategy, addedSharesToBurn);
-    //     strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, strategy, addedSharesToBurn);
+    //     strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, strategy, addedSharesToBurn);
 
     //     assertEq(
     //         strategyManager.getBurnableShares(strategy),
@@ -1118,7 +1118,7 @@ contract StrategyManagerUnitTests_increaseBurnableShares is StrategyManagerUnitT
     // }
 }
 
-contract StrategyManagerUnitTests_decreaseBurnableShares is StrategyManagerUnitTests {
+contract StrategyManagerUnitTests_decreaseBurnOrRedistributableShares is StrategyManagerUnitTests {
 // function testFuzz_SingleStrategyDeposited(address staker, uint depositAmount, uint sharesToBurn)
 //     external
 //     filterFuzzedAddressInputs(staker)
@@ -1134,7 +1134,7 @@ contract StrategyManagerUnitTests_decreaseBurnableShares is StrategyManagerUnitT
 //     cheats.prank(address(delegationManagerMock));
 //     cheats.expectEmit(true, true, true, true, address(strategyManager));
 //     emit BurnOrRedistributableSharesIncreased(defaultOperatorSet, defaultSlashId, strategy, sharesToBurn);
-//     strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, strategy, sharesToBurn);
+//     strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, strategy, sharesToBurn);
 
 //     uint strategyBalanceBefore = token.balanceOf(address(strategy));
 //     uint burnAddressBalanceBefore = token.balanceOf(strategyManager.DEFAULT_BURN_ADDRESS());
@@ -1171,7 +1171,7 @@ contract StrategyManagerUnitTests_decreaseBurnableShares is StrategyManagerUnitT
 //     cheats.prank(address(delegationManagerMock));
 //     cheats.expectEmit(true, true, true, true, address(strategyManager));
 //     emit BurnOrRedistributableSharesIncreased(defaultOperatorSet, defaultSlashId, strategy, sharesToBurn);
-//     strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, strategy, sharesToBurn);
+//     strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, strategy, sharesToBurn);
 
 //     // Now set token to be contract that reverts simulating an upgrade
 //     cheats.etch(address(token), address(revertToken).code);
@@ -1357,7 +1357,7 @@ contract StrategyManagerUnitTests_getStrategiesWithBurnableShares is StrategyMan
 
     //     // Add burnable shares
     //     cheats.prank(address(delegationManagerMock));
-    //     strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, dummyStrat, sharesToAdd);
+    //     strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, dummyStrat, sharesToAdd);
 
     //     // Get strategies with burnable shares
     //     (address[] memory strategies, uint[] memory shares) = strategyManager.getStrategiesWithBurnableShares();
@@ -1383,7 +1383,7 @@ contract StrategyManagerUnitTests_getStrategiesWithBurnableShares is StrategyMan
     //         if (sharesToAdd[i] > 0) {
     //             expectedLength++;
     //             cheats.prank(address(delegationManagerMock));
-    //             strategyManager.increaseBurnableShares(defaultOperatorSet, defaultSlashId, strategies[i], sharesToAdd[i]);
+    //             strategyManager.increaseBurnOrRedistributableShares(defaultOperatorSet, defaultSlashId, strategies[i], sharesToAdd[i]);
     //         }
     //     }