added comments for clarity regarding fee updates

stakedotlink · Nov 28, 2024 · f9dee31 · f9dee31
1 parent 446e540
commit f9dee31
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 5 deletions.
diff --git a/contracts/metisStaking/L1Strategy.sol b/contracts/metisStaking/L1Strategy.sol
@@ -400,7 +400,7 @@ contract L1Strategy is UUPSUpgradeable, OwnableUpgradeable {
 
     /**
      * @notice Sets the basis point amount of an operator's earned rewards that they receive
-     * @dev updateDeposits should be called before calling this function
+     * @dev L2Transmitter::executeUpdate should be called on L2 right before calling this function
      * @param _operatorRewardPercentage basis point amount
      */
     function setOperatorRewardPercentage(uint256 _operatorRewardPercentage) public onlyOwner {

diff --git a/contracts/metisStaking/L2Strategy.sol b/contracts/metisStaking/L2Strategy.sol
@@ -315,8 +315,7 @@ contract L2Strategy is Strategy {
 
     /**
      * @notice Adds a new fee
-     * @dev stakingPool.updateStrategyRewards is called to credit all past fees at
-     * the old rate before the percentage changes
+     * @dev L2Transmitter::executeUpdate should be called right before calling this function
      * @param _receiver receiver of fee
      * @param _feeBasisPoints fee in basis points
      **/
@@ -328,8 +327,7 @@ contract L2Strategy is Strategy {
 
     /**
      * @notice Updates an existing fee
-     * @dev stakingPool.updateStrategyRewards is called to credit all past fees at
-     * the old rate before the percentage changes
+     * @dev L2Transmitter::executeUpdate should be called right before calling this function
      * @param _index index of fee
      * @param _receiver receiver of fee
      * @param _feeBasisPoints fee in basis points