Skip to content

Commit efcdc13

Browse files
committed
docs: fix outdated natspec comments in RewardsCoordinator
Addresses Certora audit findings I-02 and I-04 by updating natspec documentation to reflect current function names and architecture. - Updated pausable flag comments to reference correct function names (createRewardsForAllEarners, createOperatorDirectedOperatorSetRewardsSubmission, createUniqueStakeRewardsSubmission) - Updated createRewardsForAllEarners interface documentation to reference EmissionsController instead of deprecated token hopper contract
1 parent 1b44caf commit efcdc13

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/contracts/core/storage/RewardsCoordinatorStorage.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ abstract contract RewardsCoordinatorStorage is IRewardsCoordinator {
1818
uint8 internal constant PAUSED_PROCESS_CLAIM = 2;
1919
/// @dev Index for flag that pauses submitRoots and disableRoot
2020
uint8 internal constant PAUSED_SUBMIT_DISABLE_ROOTS = 3;
21-
/// @dev Index for flag that pauses calling rewardAllStakersAndOperators
21+
/// @dev Index for flag that pauses calling createRewardsForAllEarners
2222
uint8 internal constant PAUSED_REWARD_ALL_STAKERS_AND_OPERATORS = 4;
2323
/// @dev Index for flag that pauses calling createOperatorDirectedAVSRewardsSubmission
2424
uint8 internal constant PAUSED_OPERATOR_DIRECTED_AVS_REWARDS_SUBMISSION = 5;
@@ -28,9 +28,9 @@ abstract contract RewardsCoordinatorStorage is IRewardsCoordinator {
2828
uint8 internal constant PAUSED_OPERATOR_PI_SPLIT = 7;
2929
/// @dev Index for flag that pauses calling setOperatorSetSplit
3030
uint8 internal constant PAUSED_OPERATOR_SET_SPLIT = 8;
31-
/// @dev Index for flag that pauses calling setOperatorSetPerformanceRewardsSubmission
31+
/// @dev Index for flag that pauses calling createOperatorDirectedOperatorSetRewardsSubmission
3232
uint8 internal constant PAUSED_OPERATOR_DIRECTED_OPERATOR_SET_REWARDS_SUBMISSION = 9;
33-
/// @dev Index for flag that pauses calling createOperatorSetRewardsSubmission
33+
/// @dev Index for flag that pauses calling createUniqueStakeRewardsSubmission
3434
uint8 internal constant PAUSED_UNIQUE_STAKE_REWARDS_SUBMISSION = 10;
3535
/// @dev Index for flag that pauses calling createTotalStakeRewardsSubmission
3636
uint8 internal constant PAUSED_TOTAL_STAKE_REWARDS_SUBMISSION = 11;

src/contracts/interfaces/IRewardsCoordinator.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ interface IRewardsCoordinator is IRewardsCoordinatorErrors, IRewardsCoordinatorE
488488
/// @notice Creates a new rewards submission for all earners across all AVSs.
489489
/// Earners in this case indicating all operators and their delegated stakers. Undelegated stake
490490
/// is not rewarded from this RewardsSubmission. This interface is only callable
491-
/// by the token hopper contract from the Eigen Foundation
491+
/// by authorized rewardsForAllSubmitters, primarily the EmissionsController
492492
/// @param rewardsSubmissions The rewards submissions being created
493493
function createRewardsForAllEarners(
494494
RewardsSubmission[] calldata rewardsSubmissions

0 commit comments

Comments
 (0)