fix(StorageRent): add price feed max age (#277)

.gas-snapshot

@@ -1,11 +1,11 @@
-BundleRegistryGasUsageTest:testGasRegisterWithSig() (gas: 817615)
-BundleRegistryGasUsageTest:testGasTrustedBatchRegister() (gas: 3493661)
-BundleRegistryGasUsageTest:testGasTrustedRegister() (gas: 509143)
+BundleRegistryGasUsageTest:testGasRegisterWithSig() (gas: 817210)
+BundleRegistryGasUsageTest:testGasTrustedBatchRegister() (gas: 3495861)
+BundleRegistryGasUsageTest:testGasTrustedRegister() (gas: 509363)
 IdRegistryGasUsageTest:testGasRegister() (gas: 735324)
 IdRegistryGasUsageTest:testGasRegisterForAndRecover() (gas: 1698920)
 IdRegistryGasUsageTest:testGasRegisterFromTrustedCaller() (gas: 806961)
-StorageRentGasUsageTest:testGasBatchCredit() (gas: 169333)
-StorageRentGasUsageTest:testGasBatchRent() (gas: 267476)
+StorageRentGasUsageTest:testGasBatchCredit() (gas: 168903)
+StorageRentGasUsageTest:testGasBatchRent() (gas: 267026)
 StorageRentGasUsageTest:testGasContinuousCredit() (gas: 142400)
-StorageRentGasUsageTest:testGasCredit() (gas: 78170)
-StorageRentGasUsageTest:testGasRent() (gas: 159716)
+StorageRentGasUsageTest:testGasCredit() (gas: 78390)
+StorageRentGasUsageTest:testGasRent() (gas: 159266)

src/StorageRent.sol

@@ -128,6 +128,14 @@ contract StorageRent is AccessControlEnumerable {
      */
     event SetCacheDuration(uint256 oldDuration, uint256 newDuration);
 
+    /**
+     * @dev Emit an event when an admin changes the priceFeedMaxAge.
+     *
+     * @param oldAge The previous priceFeedMaxAge.
+     * @param newAge The new priceFeedMaxAge.
+     */
+    event SetMaxAge(uint256 oldAge, uint256 newAge);
+
     /**
      * @dev Emit an event when an admin changes the uptimeFeedGracePeriod.
      *
@@ -214,6 +222,11 @@ contract StorageRent is AccessControlEnumerable {
      */
     uint256 public priceFeedCacheDuration;
 
+    /**
+     * @dev Max age of a price feed answer before it is considered stale. Changeable by admin.
+     */
+    uint256 public priceFeedMaxAge;
+
     /**
      * @dev Period in seconds to wait after the L2 sequencer restarts before resuming rentals.
      *      See: https://docs.chain.link/data-feeds/l2-sequencer-feeds. Changeable by admin.
@@ -299,6 +312,9 @@ contract StorageRent is AccessControlEnumerable {
         priceFeedCacheDuration = 1 days;
         emit SetCacheDuration(0, 1 days);
 
+        priceFeedMaxAge = 2 hours;
+        emit SetMaxAge(0, 2 hours);
+
         uptimeFeedGracePeriod = 1 hours;
         emit SetGracePeriod(0, 1 hours);
 
@@ -522,6 +538,7 @@ contract StorageRent is AccessControlEnumerable {
         if (answer <= 0) revert InvalidPrice();
         if (priceUpdatedAt == 0) revert IncompleteRound();
         if (priceAnsweredInRound < priceRoundId) revert StaleAnswer();
+        if (block.timestamp - priceUpdatedAt > priceFeedMaxAge) revert StaleAnswer();
 
         /* Set the last update timestamp and block. */
         lastPriceFeedUpdateTime = block.timestamp;
@@ -668,6 +685,16 @@ contract StorageRent is AccessControlEnumerable {
         priceFeedCacheDuration = duration;
     }
 
+    /**
+     * @notice Change the priceFeedMaxAge. Only callable by admin.
+     *
+     * @param age The new priceFeedMaxAge.
+     */
+    function setMaxAge(uint256 age) external onlyAdmin {
+        emit SetMaxAge(priceFeedMaxAge, age);
+        priceFeedMaxAge = age;
+    }
+
     /**
      * @notice Change the uptimeFeedGracePeriod. Only callable by admin.
      *

test/StorageRent/StorageRent.t.sol

@@ -26,6 +26,7 @@ contract StorageRentTest is StorageRentTestSuite {
     event SetMaxUnits(uint256 oldMax, uint256 newMax);
     event SetDeprecationTimestamp(uint256 oldTimestamp, uint256 newTimestamp);
     event SetCacheDuration(uint256 oldDuration, uint256 newDuration);
+    event SetMaxAge(uint256 oldAge, uint256 newAge);
     event SetGracePeriod(uint256 oldPeriod, uint256 newPeriod);
     event SetVault(address oldVault, address newVault);
     event Withdraw(address indexed to, uint256 amount);
@@ -92,6 +93,10 @@ contract StorageRentTest is StorageRentTestSuite {
         assertEq(storageRent.priceFeedCacheDuration(), INITIAL_PRICE_FEED_CACHE_DURATION);
     }
 
+    function testPriceFeedMaxAgeDefault() public {
+        assertEq(storageRent.priceFeedMaxAge(), INITIAL_PRICE_FEED_MAX_AGE);
+    }
+
     function testUptimeFeedGracePeriodDefault() public {
         assertEq(storageRent.uptimeFeedGracePeriod(), INITIAL_UPTIME_FEED_GRACE_PERIOD);
     }
@@ -864,7 +869,7 @@ contract StorageRentTest is StorageRentTestSuite {
         storageRent.refreshPrice();
     }
 
-    function testPriceFeedRevertsStaleAnswer() public {
+    function testPriceFeedRevertsStaleAnswerByRound() public {
         // Set stale answeredInRound value
         priceFeed.setRoundData(
             MockChainlinkFeed.RoundData({
@@ -881,6 +886,26 @@ contract StorageRentTest is StorageRentTestSuite {
         storageRent.refreshPrice();
     }
 
+    function testPriceFeedRevertsStaleAnswerByMaxAge() public {
+        vm.warp(INITIAL_PRICE_FEED_MAX_AGE + 2);
+
+        // Set stale answeredInRound value
+        priceFeed.setRoundData(
+            MockChainlinkFeed.RoundData({
+                roundId: 1,
+                answer: 2000e8,
+                startedAt: block.timestamp,
+                timeStamp: 1,
+                answeredInRound: 1
+            })
+        );
+        priceFeed.setStubTimeStamp(true);
+
+        vm.expectRevert(StorageRent.StaleAnswer.selector);
+        vm.prank(admin);
+        storageRent.refreshPrice();
+    }
+
     function testPriceFeedRevertsIncompleteRound() public {
         // Set zero timeStamp value
         priceFeed.setRoundData(
@@ -892,6 +917,7 @@ contract StorageRentTest is StorageRentTestSuite {
                 answeredInRound: 1
             })
         );
+        priceFeed.setStubTimeStamp(true);
         vm.expectRevert(StorageRent.IncompleteRound.selector);
         vm.prank(admin);
         storageRent.refreshPrice();
@@ -989,6 +1015,7 @@ contract StorageRentTest is StorageRentTestSuite {
                 answeredInRound: 1
             })
         );
+        uptimeFeed.setStubTimeStamp(true);
         vm.expectRevert(StorageRent.IncompleteRound.selector);
         vm.prank(admin);
         storageRent.refreshPrice();
@@ -1390,6 +1417,30 @@ contract StorageRentTest is StorageRentTestSuite {
         assertEq(storageRent.priceFeedCacheDuration(), duration);
     }
 
+    /*//////////////////////////////////////////////////////////////
+                           SET MAX PRICE AGE
+    //////////////////////////////////////////////////////////////*/
+
+    function testFuzzOnlyAdminCanSetMaxAge(address caller, uint256 age) public {
+        vm.assume(caller != admin);
+
+        vm.prank(caller);
+        vm.expectRevert(StorageRent.NotAdmin.selector);
+        storageRent.setMaxAge(age);
+    }
+
+    function testFuzzSetMaxAge(uint256 age) public {
+        uint256 currentAge = storageRent.priceFeedMaxAge();
+
+        vm.expectEmit(false, false, false, true);
+        emit SetMaxAge(currentAge, age);
+
+        vm.prank(admin);
+        storageRent.setMaxAge(age);
+
+        assertEq(storageRent.priceFeedMaxAge(), age);
+    }
+
     /*//////////////////////////////////////////////////////////////
                             SET GRACE PERIOD
     //////////////////////////////////////////////////////////////*/

test/StorageRent/StorageRentTestSuite.sol

@@ -34,6 +34,7 @@ abstract contract StorageRentTestSuite is TestSuiteSetup {
     int256 internal constant ETH_USD_PRICE = 2000e8; // $2000 USD/ETH
 
     uint256 internal constant INITIAL_PRICE_FEED_CACHE_DURATION = 1 days;
+    uint256 internal constant INITIAL_PRICE_FEED_MAX_AGE = 2 hours;
     uint256 internal constant INITIAL_UPTIME_FEED_GRACE_PERIOD = 1 hours;
     uint256 internal constant INITIAL_PRICE_IN_ETH = 0.0025 ether;
 

test/Utils.sol

@@ -131,6 +131,7 @@ contract MockChainlinkFeed is AggregatorV3Interface {
     uint256 public version = 1;
 
     bool public shouldRevert;
+    bool public stubTimeStamp;
 
     constructor(uint8 _decimals, string memory _description) {
         decimals = _decimals;
@@ -141,6 +142,10 @@ contract MockChainlinkFeed is AggregatorV3Interface {
         shouldRevert = _shouldRevert;
     }
 
+    function setStubTimeStamp(bool _stubTimeStamp) external {
+        stubTimeStamp = _stubTimeStamp;
+    }
+
     function setAnswer(int256 value) external {
         roundData.answer = value;
     }
@@ -155,8 +160,13 @@ contract MockChainlinkFeed is AggregatorV3Interface {
 
     function latestRoundData() public view returns (uint80, int256, uint256, uint256, uint80) {
         if (shouldRevert) revert("MockChainLinkFeed: Call failed");
-        return
-            (roundData.roundId, roundData.answer, roundData.startedAt, roundData.timeStamp, roundData.answeredInRound);
+        return (
+            roundData.roundId,
+            roundData.answer,
+            roundData.startedAt,
+            stubTimeStamp ? roundData.timeStamp : block.timestamp,
+            roundData.answeredInRound
+        );
     }
 }