feat: changing burnableShares to EnumerableMap (#1028)

* feat: changing burnableShares to EnumerableMap

* style: linter

* docs: storage docs

* style: natspec and import

* style: lint

* feat: adding view function for cronjob and moving functions

* fix: updating storage gap

* docs: storage slots comment

* feat: new bindings

* docs: updating StrategyManager doc

* docs: bindings

---------

Co-authored-by: Michael <michael@Michaels-MacBook-Pro.local>

Author: 2 people

docs/core/StrategyManager.md

@@ -250,7 +250,7 @@ This method directs the `strategy` to convert the input deposit shares to tokens
 
 ## Burning Slashed Shares
 
-The following methods handle burning of slashed shares:
+Slashed shares are marked as burnable, and anyone can call `burnShares` to transfer them to the default burn address. Burnable shares are stored in `burnableShares`, an [EnumerableMap](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/structs/EnumerableMap.sol) with strategy contract addresses as keys and associated view functions. The following methods handle burning of slashed shares:
 * [`StrategyManager.increaseBurnableShares`](#increaseburnableshares)
 * [`StrategyManager.burnShares`](#burnshares)
 
@@ -294,7 +294,6 @@ function burnShares(
     IStrategy strategy
 )
     external
-    onlyDelegationManager
 ```
 
 Anyone can call this method to burn slashed shares previously added by the `DelegationManager` via `increaseBurnableShares`. This method resets the strategy's burnable shares to 0, and directs the corresponding `strategy` to convert the shares to tokens and transfer them to `DEFAULT_BURN_ADDRESS`, rendering them unrecoverable.

docs/storage-report/StrategyManager.md

@@ -44,8 +44,8 @@
 |----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+--------------------------------------------------------|
 | __deprecated_thirdPartyTransfersForbidden                | mapping(contract IStrategy => bool)                        | 211  | 0      | 32    | src/contracts/core/StrategyManager.sol:StrategyManager |
 |----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+--------------------------------------------------------|
-| burnableShares                                           | mapping(contract IStrategy => uint256)                     | 212  | 0      | 32    | src/contracts/core/StrategyManager.sol:StrategyManager |
+| burnableShares                                           | struct EnumerableMap.AddressToUintMap                      | 212  | 0      | 96    | src/contracts/core/StrategyManager.sol:StrategyManager |
 |----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+--------------------------------------------------------|
-| __gap                                                    | uint256[38]                                                | 213  | 0      | 1216  | src/contracts/core/StrategyManager.sol:StrategyManager |
+| __gap                                                    | uint256[36]                                                | 215  | 0      | 1152  | src/contracts/core/StrategyManager.sol:StrategyManager |
 ╰----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+--------------------------------------------------------╯
 

docs/storage-report/StrategyManagerStorage.md

@@ -24,8 +24,8 @@
 |----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------|
 | __deprecated_thirdPartyTransfersForbidden                | mapping(contract IStrategy => bool)                        | 10   | 0      | 32    | src/contracts/core/StrategyManagerStorage.sol:StrategyManagerStorage |
 |----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------|
-| burnableShares                                           | mapping(contract IStrategy => uint256)                     | 11   | 0      | 32    | src/contracts/core/StrategyManagerStorage.sol:StrategyManagerStorage |
+| burnableShares                                           | struct EnumerableMap.AddressToUintMap                      | 11   | 0      | 96    | src/contracts/core/StrategyManagerStorage.sol:StrategyManagerStorage |
 |----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------|
-| __gap                                                    | uint256[38]                                                | 12   | 0      | 1216  | src/contracts/core/StrategyManagerStorage.sol:StrategyManagerStorage |
+| __gap                                                    | uint256[36]                                                | 14   | 0      | 1152  | src/contracts/core/StrategyManagerStorage.sol:StrategyManagerStorage |
 ╰----------------------------------------------------------+------------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------╯