refactor: natspec + StakeRegistry interface

Author: 0xClandestine

docs/RegistryCoordinator.md

@@ -256,7 +256,7 @@ These methods are used by the Owner to configure the `RegistryCoordinator`:
 function createQuorum(
     OperatorSetParam memory operatorSetParams,
     uint96 minimumStake,
-    IStakeRegistry.StrategyParams[] memory strategyParams
+    IStakeRegistryTypes.StrategyParams[] memory strategyParams
 ) 
     external
     virtual 

docs/storage-report/StakeRegistry.md

@@ -8,11 +8,11 @@
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
 | operatorStakeHistory             | mapping(bytes32 => mapping(uint8 => struct IStakeRegistry.StakeUpdate[])) | 2    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
-| strategyParams                   | mapping(uint8 => struct IStakeRegistry.StrategyParams[])                  | 3    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
+| strategyParams                   | mapping(uint8 => struct IStakeRegistryTypes.StrategyParams[])                  | 3    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
 | strategiesPerQuorum              | mapping(uint8 => contract IStrategy[])                                    | 4    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
-| stakeTypePerQuorum               | mapping(uint8 => enum StakeType)                                          | 5    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
+| stakeTypePerQuorum               | mapping(uint8 => enum IStakeRegistryTypes.StakeType)                                          | 5    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
 | slashableStakeLookAheadPerQuorum | mapping(uint8 => uint32)                                                  | 6    | 0      | 32    | src/StakeRegistry.sol:StakeRegistry |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+-------------------------------------|

docs/storage-report/StakeRegistryStorage.md

@@ -8,11 +8,11 @@
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
 | operatorStakeHistory             | mapping(bytes32 => mapping(uint8 => struct IStakeRegistry.StakeUpdate[])) | 2    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
-| strategyParams                   | mapping(uint8 => struct IStakeRegistry.StrategyParams[])                  | 3    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
+| strategyParams                   | mapping(uint8 => struct IStakeRegistryTypes.StrategyParams[])                  | 3    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
 | strategiesPerQuorum              | mapping(uint8 => contract IStrategy[])                                    | 4    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
-| stakeTypePerQuorum               | mapping(uint8 => enum StakeType)                                          | 5    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
+| stakeTypePerQuorum               | mapping(uint8 => enum IStakeRegistryTypes.StakeType)                                          | 5    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
 | slashableStakeLookAheadPerQuorum | mapping(uint8 => uint32)                                                  | 6    | 0      | 32    | src/StakeRegistryStorage.sol:StakeRegistryStorage |
 |----------------------------------+---------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|

src/RegistryCoordinator.sol

@@ -11,7 +11,7 @@ import {
 } from "eigenlayer-contracts/src/contracts/interfaces/IAllocationManager.sol";
 import {ISocketUpdater} from "./interfaces/ISocketUpdater.sol";
 import {IBLSApkRegistry, IBLSApkRegistryTypes} from "./interfaces/IBLSApkRegistry.sol";
-import {IStakeRegistry, StakeType} from "./interfaces/IStakeRegistry.sol";
+import {IStakeRegistry, IStakeRegistryTypes} from "./interfaces/IStakeRegistry.sol";
 import {IIndexRegistry} from "./interfaces/IIndexRegistry.sol";
 import {IServiceManager} from "./interfaces/IServiceManager.sol";
 import {IRegistryCoordinator} from "./interfaces/IRegistryCoordinator.sol";
@@ -94,8 +94,8 @@ contract RegistryCoordinator is
         uint256 _initialPausedStatus,
         OperatorSetParam[] memory _operatorSetParams,
         uint96[] memory _minimumStakes,
-        IStakeRegistry.StrategyParams[][] memory _strategyParams,
-        StakeType[] memory _stakeTypes,
+        IStakeRegistryTypes.StrategyParams[][] memory _strategyParams,
+        IStakeRegistryTypes.StakeType[] memory _stakeTypes,
         uint32[] memory _lookAheadPeriods
     ) external initializer {
         require(
@@ -439,24 +439,30 @@ contract RegistryCoordinator is
     function createTotalDelegatedStakeQuorum(
         OperatorSetParam memory operatorSetParams,
         uint96 minimumStake,
-        IStakeRegistry.StrategyParams[] memory strategyParams
+        IStakeRegistryTypes.StrategyParams[] memory strategyParams
     ) external virtual onlyOwner {
-        _createQuorum(operatorSetParams, minimumStake, strategyParams, StakeType.TOTAL_DELEGATED, 0);
+        _createQuorum(
+            operatorSetParams,
+            minimumStake,
+            strategyParams,
+            IStakeRegistryTypes.StakeType.TOTAL_DELEGATED,
+            0
+        );
     }
 
     /// @inheritdoc IRegistryCoordinator
     function createSlashableStakeQuorum(
         OperatorSetParam memory operatorSetParams,
         uint96 minimumStake,
-        IStakeRegistry.StrategyParams[] memory strategyParams,
+        IStakeRegistryTypes.StrategyParams[] memory strategyParams,
         uint32 lookAheadPeriod
     ) external virtual onlyOwner {
         require(isUsingOperatorSets(), OperatorSetsNotEnabled());
         _createQuorum(
             operatorSetParams,
             minimumStake,
             strategyParams,
-            StakeType.TOTAL_SLASHABLE,
+            IStakeRegistryTypes.StakeType.TOTAL_SLASHABLE,
             lookAheadPeriod
         );
     }
@@ -832,8 +838,8 @@ contract RegistryCoordinator is
     function _createQuorum(
         OperatorSetParam memory operatorSetParams,
         uint96 minimumStake,
-        IStakeRegistry.StrategyParams[] memory strategyParams,
-        StakeType stakeType,
+        IStakeRegistryTypes.StrategyParams[] memory strategyParams,
+        IStakeRegistryTypes.StakeType stakeType,
         uint32 lookAheadPeriod
     ) internal {
         // Increment the total quorum count. Fails if we're already at the max
@@ -870,9 +876,9 @@ contract RegistryCoordinator is
             });
         }
         // Initialize stake registry based on stake type
-        if (stakeType == StakeType.TOTAL_DELEGATED) {
+        if (stakeType == IStakeRegistryTypes.StakeType.TOTAL_DELEGATED) {
             stakeRegistry.initializeDelegatedStakeQuorum(quorumNumber, minimumStake, strategyParams);
-        } else if (stakeType == StakeType.TOTAL_SLASHABLE) {
+        } else if (stakeType == IStakeRegistryTypes.StakeType.TOTAL_SLASHABLE) {
             stakeRegistry.initializeSlashableStakeQuorum(
                 quorumNumber, minimumStake, lookAheadPeriod, strategyParams
             );