feat: constructor arg to delay reward claiming (#17943)

Author: just-mitch

l1-contracts/foundry.toml

@@ -5,7 +5,7 @@ script = 'script'
 out = 'out'
 libs = ['lib']
 solc = "0.8.27"
-evm_version = 'cancun'
+evm_version = 'prague'
 optimizer = true
 
 match_path = "test/**/*.t.sol"

l1-contracts/src/core/Rollup.sol

@@ -524,6 +524,14 @@ contract Rollup is IStaking, IValidatorSelection, IRollup, RollupCore {
     return RewardLib.getBlockReward();
   }
 
+  function isRewardsClaimable() external view override(IRollup) returns (bool) {
+    return RewardLib.isRewardsClaimable();
+  }
+
+  function getEarliestRewardsClaimableTimestamp() external view override(IRollup) returns (Timestamp) {
+    return RewardLib.getEarliestRewardsClaimableTimestamp();
+  }
+
   function getAvailableValidatorFlushes() external view override(IStaking) returns (uint256) {
     return ValidatorOperationsExtLib.getAvailableValidatorFlushes();
   }

l1-contracts/src/core/RollupCore.sol

@@ -17,7 +17,6 @@ import {CommitteeAttestations} from "@aztec/core/libraries/rollup/AttestationLib
 import {Errors} from "@aztec/core/libraries/Errors.sol";
 import {RollupOperationsExtLib} from "@aztec/core/libraries/rollup/RollupOperationsExtLib.sol";
 import {ValidatorOperationsExtLib} from "@aztec/core/libraries/rollup/ValidatorOperationsExtLib.sol";
-import {RewardDeploymentExtLib} from "@aztec/core/libraries/rollup/RewardDeploymentExtLib.sol";
 import {TallySlasherDeploymentExtLib} from "@aztec/core/libraries/rollup/TallySlasherDeploymentExtLib.sol";
 import {EmpireSlasherDeploymentExtLib} from "@aztec/core/libraries/rollup/EmpireSlasherDeploymentExtLib.sol";
 import {SlasherFlavor} from "@aztec/core/interfaces/ISlasher.sol";
@@ -33,7 +32,7 @@ import {GSE} from "@aztec/governance/GSE.sol";
 import {Ownable} from "@oz/access/Ownable.sol";
 import {IERC20} from "@oz/token/ERC20/IERC20.sol";
 import {EIP712} from "@oz/utils/cryptography/EIP712.sol";
-import {RewardLib, RewardConfig} from "@aztec/core/libraries/rollup/RewardLib.sol";
+import {RewardExtLib, RewardConfig} from "@aztec/core/libraries/rollup/RewardExtLib.sol";
 import {StakingQueueConfig} from "@aztec/core/libraries/compressed-data/StakingQueueConfig.sol";
 import {FeeConfigLib, CompressedFeeConfig} from "@aztec/core/libraries/compressed-data/fees/FeeConfig.sol";
 import {G1Point, G2Point} from "@aztec/shared/libraries/BN254Lib.sol";
@@ -198,11 +197,6 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
    */
   bool public checkBlob = true;
 
-  /**
-   * @notice Flag controlling whether rewards can be claimed
-   */
-  bool public isRewardsClaimable = false;
-
   /**
    * @notice Initializes the Aztec rollup with all required configurations
    * @dev Sets up time parameters, deploys auxiliary contracts (slasher, reward booster),
@@ -212,8 +206,9 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
    * @param _gse The Governance Staking Escrow contract
    * @param _epochProofVerifier The honk verifier contract for root epoch proofs
    * @param _governance The address with owner privileges
-   * @param _genesisState Initial state containing VK tree root, protocol contract tree root, and genesis archive
-   * @param _config Comprehensive configuration including timing, staking, slashing, and reward parameters
+   * @param _genesisState Initial state containing VK tree root, protocol contracts hash, and genesis archive
+   * @param _config Comprehensive configuration including timing, staking, slashing, reward parameters, and unlock
+   * timestamp
    */
   constructor(
     IERC20 _feeAsset,
@@ -279,10 +274,11 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
 
     // If no booster is specifically provided, deploy one.
     if (address(_config.rewardConfig.booster) == address(0)) {
-      _config.rewardConfig.booster = RewardDeploymentExtLib.deployRewardBooster(_config.rewardBoostConfig);
+      _config.rewardConfig.booster = RewardExtLib.deployRewardBooster(_config.rewardBoostConfig);
     }
 
-    RewardLib.setConfig(_config.rewardConfig);
+    RewardExtLib.initialize(_config.earliestRewardsClaimableTimestamp);
+    RewardExtLib.setConfig(_config.rewardConfig);
 
     L1_BLOCK_AT_GENESIS = block.number;
 
@@ -312,7 +308,7 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
    * @param _config The new reward configuration including rates and booster settings
    */
   function setRewardConfig(RewardConfig memory _config) external override(IRollupCore) onlyOwner {
-    RewardLib.setConfig(_config);
+    RewardExtLib.setConfig(_config);
     emit RewardConfigUpdated(_config);
   }
 
@@ -340,10 +336,11 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
   /**
    * @notice Enables or disables reward claiming
    * @dev Only callable by owner. This is a safety mechanism to control when rewards can be withdrawn.
+   *      Cannot set rewards as claimable before the earliest reward claimable timestamp.
    * @param _isRewardsClaimable True to enable reward claims, false to disable
    */
   function setRewardsClaimable(bool _isRewardsClaimable) external override(IRollupCore) onlyOwner {
-    isRewardsClaimable = _isRewardsClaimable;
+    RewardExtLib.setIsRewardsClaimable(_isRewardsClaimable);
     emit RewardsClaimableUpdated(_isRewardsClaimable);
   }
 
@@ -391,8 +388,7 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
    * @return The amount of rewards claimed
    */
   function claimSequencerRewards(address _coinbase) external override(IRollupCore) returns (uint256) {
-    require(isRewardsClaimable, Errors.Rollup__RewardsNotClaimable());
-    return RewardLib.claimSequencerRewards(_coinbase);
+    return RewardExtLib.claimSequencerRewards(_coinbase);
   }
 
   /**
@@ -408,8 +404,7 @@ contract RollupCore is EIP712("Aztec Rollup", "1"), Ownable, IStakingCore, IVali
     override(IRollupCore)
     returns (uint256)
   {
-    require(isRewardsClaimable, Errors.Rollup__RewardsNotClaimable());
-    return RewardLib.claimProverRewards(_coinbase, _epochs);
+    return RewardExtLib.claimProverRewards(_coinbase, _epochs);
   }
 
   /**

l1-contracts/src/core/interfaces/IRollup.sol

@@ -76,6 +76,7 @@ struct RollupConfigInput {
   RewardBoostConfig rewardBoostConfig;
   StakingQueueConfig stakingQueueConfig;
   uint256 localEjectionThreshold;
+  Timestamp earliestRewardsClaimableTimestamp;
 }
 
 struct RollupConfig {
@@ -142,7 +143,6 @@ interface IRollupCore {
   function setRewardConfig(RewardConfig memory _config) external;
   function updateManaTarget(uint256 _manaTarget) external;
 
-  function isRewardsClaimable() external view returns (bool);
   // solhint-disable-next-line func-name-mixedcase
   function L1_BLOCK_AT_GENESIS() external view returns (uint256);
 }
@@ -228,4 +228,6 @@ interface IRollup is IRollupCore, IHaveVersion {
 
   function getRewardConfig() external view returns (RewardConfig memory);
   function getBlockReward() external view returns (uint256);
+  function getEarliestRewardsClaimableTimestamp() external view returns (Timestamp);
+  function isRewardsClaimable() external view returns (bool);
 }

l1-contracts/src/core/libraries/Errors.sol

@@ -90,6 +90,7 @@ library Errors {
   error Rollup__InvalidManaTarget(uint256 minimum, uint256 provided);
   error Rollup__ManaLimitExceeded();
   error Rollup__RewardsNotClaimable();
+  error Rollup__TooSoonToSetRewardsClaimable(uint256 earliestRewardsClaimableTimestamp, uint256 currentTimestamp);
   error Rollup__InvalidFirstEpochProof();
   error Rollup__InvalidCoinbase();
   error Rollup__UnavailableTempBlockLog(uint256 blockNumber, uint256 pendingBlockNumber, uint256 upperLimit);

l1-contracts/src/core/libraries/rollup/EpochProofLib.sol

@@ -4,12 +4,12 @@ pragma solidity >=0.8.27;
 
 import {SubmitEpochRootProofArgs, PublicInputArgs, IRollupCore, RollupStore} from "@aztec/core/interfaces/IRollup.sol";
 import {CompressedTempBlockLog} from "@aztec/core/libraries/compressed-data/BlockLog.sol";
+import {CompressedFeeHeader, FeeHeaderLib} from "@aztec/core/libraries/compressed-data/fees/FeeStructs.sol";
 import {ChainTipsLib, CompressedChainTips} from "@aztec/core/libraries/compressed-data/Tips.sol";
 import {Constants} from "@aztec/core/libraries/ConstantsGen.sol";
 import {Errors} from "@aztec/core/libraries/Errors.sol";
 import {AttestationLib, CommitteeAttestations} from "@aztec/core/libraries/rollup/AttestationLib.sol";
 import {BlobLib} from "@aztec/core/libraries/rollup/BlobLib.sol";
-import {CompressedFeeHeader, FeeHeaderLib} from "@aztec/core/libraries/rollup/FeeLib.sol";
 import {RewardLib} from "@aztec/core/libraries/rollup/RewardLib.sol";
 import {STFLib} from "@aztec/core/libraries/rollup/STFLib.sol";
 import {ValidatorSelectionLib} from "@aztec/core/libraries/rollup/ValidatorSelectionLib.sol";

l1-contracts/src/core/libraries/rollup/RewardDeploymentExtLib.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2024 Aztec Labs.
+pragma solidity >=0.8.27;
+
+import {RewardLib, RewardConfig} from "@aztec/core/libraries/rollup/RewardLib.sol";
+import {Epoch, Timestamp} from "@aztec/core/libraries/TimeLib.sol";
+
+import {
+  RewardBooster,
+  RewardBoostConfig,
+  IBoosterCore,
+  IValidatorSelection
+} from "@aztec/core/reward-boost/RewardBooster.sol";
+
+library RewardExtLib {
+  function initialize(Timestamp _earliestRewardsClaimableTimestamp) external {
+    RewardLib.initialize(_earliestRewardsClaimableTimestamp);
+  }
+
+  function setConfig(RewardConfig memory _config) external {
+    RewardLib.setConfig(_config);
+  }
+
+  function setIsRewardsClaimable(bool _isRewardsClaimable) external {
+    RewardLib.setIsRewardsClaimable(_isRewardsClaimable);
+  }
+
+  function claimSequencerRewards(address _sequencer) external returns (uint256) {
+    return RewardLib.claimSequencerRewards(_sequencer);
+  }
+
+  function claimProverRewards(address _prover, Epoch[] memory _epochs) external returns (uint256) {
+    return RewardLib.claimProverRewards(_prover, _epochs);
+  }
+
+  function deployRewardBooster(RewardBoostConfig memory _config) external returns (IBoosterCore) {
+    RewardBooster booster = new RewardBooster(IValidatorSelection(address(this)), _config);
+    return IBoosterCore(address(booster));
+  }
+}

l1-contracts/src/core/libraries/rollup/RewardExtLib.sol

@@ -9,6 +9,7 @@ import {STFLib} from "@aztec/core/libraries/rollup/STFLib.sol";
 import {Epoch, Timestamp, TimeLib} from "@aztec/core/libraries/TimeLib.sol";
 import {IBoosterCore} from "@aztec/core/reward-boost/RewardBooster.sol";
 import {IRewardDistributor} from "@aztec/governance/interfaces/IRewardDistributor.sol";
+import {CompressedTimeMath, CompressedTimestamp} from "@aztec/shared/libraries/CompressedTimeMath.sol";
 import {IERC20} from "@oz/token/ERC20/IERC20.sol";
 import {SafeERC20} from "@oz/token/ERC20/utils/SafeERC20.sol";
 import {Math} from "@oz/utils/math/Math.sol";
@@ -46,6 +47,8 @@ struct RewardStorage {
   mapping(Epoch => EpochRewards) epochRewards;
   mapping(address prover => BitMaps.BitMap claimed) proverClaimed;
   RewardConfig config;
+  CompressedTimestamp earliestRewardsClaimableTimestamp;
+  bool isRewardsClaimable;
 }
 
 struct Values {
@@ -64,7 +67,8 @@ struct Totals {
 library RewardLib {
   using SafeERC20 for IERC20;
   using BitMaps for BitMaps.BitMap;
-
+  using CompressedTimeMath for CompressedTimestamp;
+  using CompressedTimeMath for Timestamp;
   using TimeLib for Timestamp;
   using TimeLib for Epoch;
   using FeeHeaderLib for CompressedFeeHeader;
@@ -76,14 +80,33 @@ library RewardLib {
   // such as sacrificial hearts, during rituals performed within temples.
   address public constant BURN_ADDRESS = address(bytes20("CUAUHXICALLI"));
 
+  function initialize(Timestamp _earliestRewardsClaimableTimestamp) internal {
+    RewardStorage storage rewardStorage = getStorage();
+    rewardStorage.earliestRewardsClaimableTimestamp = _earliestRewardsClaimableTimestamp.compress();
+    rewardStorage.isRewardsClaimable = false;
+  }
+
   function setConfig(RewardConfig memory _config) internal {
     require(Bps.unwrap(_config.sequencerBps) <= 10_000, Errors.RewardLib__InvalidSequencerBps());
     RewardStorage storage rewardStorage = getStorage();
     rewardStorage.config = _config;
   }
 
+  function setIsRewardsClaimable(bool _isRewardsClaimable) internal {
+    RewardStorage storage rewardStorage = getStorage();
+    uint256 earliestRewardsClaimableTimestamp =
+      Timestamp.unwrap(rewardStorage.earliestRewardsClaimableTimestamp.decompress());
+    require(
+      block.timestamp >= earliestRewardsClaimableTimestamp,
+      Errors.Rollup__TooSoonToSetRewardsClaimable(earliestRewardsClaimableTimestamp, block.timestamp)
+    );
+
+    rewardStorage.isRewardsClaimable = _isRewardsClaimable;
+  }
+
   function claimSequencerRewards(address _sequencer) internal returns (uint256) {
     RewardStorage storage rewardStorage = getStorage();
+    require(rewardStorage.isRewardsClaimable, Errors.Rollup__RewardsNotClaimable());
 
     RollupStore storage rollupStore = STFLib.getStorage();
     uint256 amount = rewardStorage.sequencerRewards[_sequencer];
@@ -102,6 +125,8 @@ library RewardLib {
 
     RewardStorage storage rewardStorage = getStorage();
 
+    require(rewardStorage.isRewardsClaimable, Errors.Rollup__RewardsNotClaimable());
+
     uint256 accumulatedRewards = 0;
     for (uint256 i = 0; i < _epochs.length; i++) {
       require(
@@ -268,6 +293,14 @@ library RewardLib {
     return (se.shares[_prover] * er.rewards / se.summedShares);
   }
 
+  function isRewardsClaimable() internal view returns (bool) {
+    return getStorage().isRewardsClaimable;
+  }
+
+  function getEarliestRewardsClaimableTimestamp() internal view returns (Timestamp) {
+    return getStorage().earliestRewardsClaimableTimestamp.decompress();
+  }
+
   function getStorage() internal pure returns (RewardStorage storage storageStruct) {
     bytes32 position = REWARD_STORAGE_POSITION;
     assembly {

l1-contracts/src/core/libraries/rollup/RewardLib.sol

@@ -115,7 +115,8 @@ library TestConstants {
       stakingQueueConfig: getStakingQueueConfig(),
       slashAmounts: [AZTEC_SLASH_AMOUNT_SMALL, AZTEC_SLASH_AMOUNT_MEDIUM, AZTEC_SLASH_AMOUNT_LARGE],
       slasherFlavor: SlasherFlavor.EMPIRE,
-      localEjectionThreshold: 0 // The same as it being off, and only using the global.
+      localEjectionThreshold: 0, // The same as it being off, and only using the global.
+      earliestRewardsClaimableTimestamp: Timestamp.wrap(0) // Default to 0 (no restriction)
     });
 
     // For the version we derive it based on the config (with a 0 version)