Merge pull request #239 from VenusProtocol/feat/transient-storage

[VEN-2999][VEN-3002]: add transient storage to Resilient oracle and Capped oracles

Author: Debugger022

.github/workflows/cd.yaml

@@ -21,8 +21,7 @@ jobs:
           cache: "yarn"
 
       - name: Install dependencies
-        # Hack to get around failing "ethereumjs-abi The remote archive doesn't match the expected checksum" error
-        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+        run: yarn
 
       - name: Build
         run: yarn build

.github/workflows/ci.yml

@@ -22,8 +22,7 @@ jobs:
           cache: "yarn"
 
       - name: Install dependencies
-        # Hack to get around failing "ethereumjs-abi The remote archive doesn't match the expected checksum" error
-        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+        run: yarn
 
       - name: Compile contract types
         run: yarn hardhat compile
@@ -49,8 +48,7 @@ jobs:
           cache: "yarn"
 
       - name: Install dependencies
-        # Hack to get around failing "ethereumjs-abi The remote archive doesn't match the expected checksum" error
-        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+        run: yarn
 
       - name: Run hardhat tests coverage
         run: yarn hardhat:coverage
@@ -89,8 +87,7 @@ jobs:
           cache: "yarn"
 
       - name: Install dependencies
-        # Hack to get around failing "ethereumjs-abi The remote archive doesn't match the expected checksum" error
-        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+        run: yarn
 
       - name: Verify deployments work
         run: yarn hardhat deploy
@@ -114,8 +111,7 @@ jobs:
           cache: "yarn"
 
       - name: Install dependencies
-        # Hack to get around failing "ethereumjs-abi The remote archive doesn't match the expected checksum" error
-        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+        run: yarn
 
       - name: Export deployments
         run: |

.solhint.json

@@ -7,7 +7,7 @@
     "const-name-snakecase": "warn",
     "constructor-syntax": "error",
     "func-visibility": ["error", { "ignoreConstructors": true }],
-    "max-line-length": ["error", 120],
+    "max-line-length": ["error", 175],
     "not-rely-on-time": "warn",
     "reason-string": ["warn", { "maxLength": 64 }],
     "ordering": "error"

README.md

@@ -6,7 +6,7 @@ Resilient Price Feeds is a set of smart contracts that uses multiple oracles and
 
 DeFi protocols are vulnerable to incorrectly reported prices which can lead to lost money. A price oracle can be manipulated,fail, or suffer other attacks depending on the type of price oracle. It creates a single point of failure, opening attack vectors to the protocol if not mitigated.
 
-The Resilient Price Feeds uses multiple oracle sources and fallback mechanisms to return accurate prices and protect from oracle failures. Currently, it includes integrations with Chainlink, RedStone, Pyth and Binance Oracle oracles.
+The Resilient Price Feeds uses multiple oracle sources and fallback mechanisms to return accurate prices and protect from oracle failures. Currently, it includes integrations with Chainlink, RedStone and Binance Oracle oracles.
 
 ## Details
 
@@ -21,7 +21,7 @@ anchorRatio = anchorPrice/reporterPrice
 isValid = anchorRatio <= upperBoundAnchorRatio && anchorRatio >= lowerBoundAnchorRatio
 ```
 
-The default configuration uses Chainlink as the main oracle, RedStone or Pyth oracle as the pivot oracle depending on which supports the given market and Binance oracle as the fallback oracle. For some markets we may use RedStone or Pyth as the main oracle if the token price is not supported by Chainlink or Binance oracles.
+The default configuration uses Chainlink as the main oracle, RedStone oracle as the pivot oracle depending on which supports the given market and Binance oracle as the fallback oracle. For some markets we may use RedStone as the main oracle if the token price is not supported by Chainlink or Binance oracles.
 
 When fetching an oracle price, for the price to be valid it must be positive and not stagnant. If the price is invalid or stagnant it is ignored and a fallback oracle is used.
 

audits/125_capped_cached_certik_20250430.pdf

@@ -2,10 +2,12 @@
 // SPDX-FileCopyrightText: 2022 Venus
 pragma solidity 0.8.25;
 
-import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
-import "./interfaces/VBep20Interface.sol";
-import "./interfaces/OracleInterface.sol";
-import "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
+import { PausableUpgradeable } from "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
+import { VBep20Interface } from "./interfaces/VBep20Interface.sol";
+import { OracleInterface, ResilientOracleInterface, BoundValidatorInterface } from "./interfaces/OracleInterface.sol";
+import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
+import { ICappedOracle } from "./interfaces/ICappedOracle.sol";
+import { Transient } from "./lib/Transient.sol";
 
 /**
  * @title ResilientOracle
@@ -17,8 +19,7 @@ import "@venusprotocol/governance-contracts/contracts/Governance/AccessControlle
  * for attacking the protocol.
  *
  * The Resilient Oracle uses multiple sources and fallback mechanisms to provide accurate prices and protect
- * the protocol from oracle attacks. Currently it includes integrations with Chainlink, Pyth, Binance Oracle
- * and TWAP (Time-Weighted Average Price) oracles. TWAP uses PancakeSwap as the on-chain price source.
+ * the protocol from oracle attacks.
  *
  * For every market (vToken) we configure the main, pivot and fallback oracles. The oracles are configured per
  * vToken's underlying asset address. The main oracle oracle is the most trustworthy price source, the pivot
@@ -36,9 +37,8 @@ anchorRatio = anchorPrice/reporterPrice
 isValid = anchorRatio <= upperBoundAnchorRatio && anchorRatio >= lowerBoundAnchorRatio
 ```
 
- * In most cases, Chainlink is used as the main oracle, TWAP or Pyth oracles are used as the pivot oracle depending
- * on which supports the given market and Binance oracle is used as the fallback oracle. For some markets we may
- * use Pyth or TWAP as the main oracle if the token price is not supported by Chainlink or Binance oracles.
+ * In most cases, Chainlink is used as the main oracle, other oracles are used as the pivot oracle depending
+ * on which supports the given market and Binance oracle is used as the fallback oracle.
  *
  * For a fetched price to be valid it must be positive and not stagnant. If the price is invalid then we consider the
  * oracle to be stagnant and treat it like it's disabled.
@@ -66,6 +66,8 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
         /// @notice `enableFlagsForOracles` stores the enabled state
         /// for each oracle in the same order as `oracles`
         bool[3] enableFlagsForOracles;
+        /// @notice `cachingEnabled` is a flag that indicates whether the asset price should be cached
+        bool cachingEnabled;
     }
 
     uint256 public constant INVALID_PRICE = 0;
@@ -82,6 +84,12 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
     /// and can serve as any underlying asset of a market that supports native tokens
     address public constant NATIVE_TOKEN_ADDR = 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB;
 
+    /// @notice Slot to cache the asset's price, used for transient storage
+    /// custom:storage-location erc7201:venus-protocol/oracle/ResilientOracle/cache
+    /// keccak256(abi.encode(uint256(keccak256("venus-protocol/oracle/ResilientOracle/cache")) - 1))
+    ///   & ~bytes32(uint256(0xff))
+    bytes32 public constant CACHE_SLOT = 0x4e99ec55972332f5e0ef9c6623192c0401b609161bffae64d9ccdd7ad6cc7800;
+
     /// @notice Bound validator contract address
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     BoundValidatorInterface public immutable boundValidator;
@@ -101,6 +109,9 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
     /// Event emitted when an oracle is enabled or disabled
     event OracleEnabled(address indexed asset, uint256 indexed role, bool indexed enable);
 
+    /// Event emitted when an asset cachingEnabled flag is set
+    event CachedEnabled(address indexed asset, bool indexed enabled);
+
     /**
      * @notice Checks whether an address is null or not
      */
@@ -175,11 +186,8 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
     function setTokenConfigs(TokenConfig[] memory tokenConfigs_) external {
         if (tokenConfigs_.length == 0) revert("length can't be 0");
         uint256 numTokenConfigs = tokenConfigs_.length;
-        for (uint256 i; i < numTokenConfigs; ) {
+        for (uint256 i; i < numTokenConfigs; ++i) {
             setTokenConfig(tokenConfigs_[i]);
-            unchecked {
-                ++i;
-            }
         }
     }
 
@@ -215,6 +223,7 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
      * @custom:access Only Governance
      * @custom:error NotNullAddress error is thrown if asset address is null
      * @custom:error TokenConfigExistance error is thrown if token config is not set
+     * @custom:event Emits OracleEnabled event with asset address, role of the oracle and enabled flag
      */
     function enableOracle(
         address asset,
@@ -227,30 +236,22 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
     }
 
     /**
-     * @notice Updates the TWAP pivot oracle price.
+     * @notice Updates the capped main oracle snapshot.
      * @dev This function should always be called before calling getUnderlyingPrice
      * @param vToken vToken address
      */
     function updatePrice(address vToken) external override {
         address asset = _getUnderlyingAsset(vToken);
-        (address pivotOracle, bool pivotOracleEnabled) = getOracle(asset, OracleRole.PIVOT);
-        if (pivotOracle != address(0) && pivotOracleEnabled) {
-            //if pivot oracle is not TwapOracle it will revert so we need to catch the revert
-            try TwapInterface(pivotOracle).updateTwap(asset) {} catch {}
-        }
+        _updateAssetPrice(asset);
     }
 
     /**
-     * @notice Updates the pivot oracle price. Currently using TWAP
+     * @notice Updates the capped main oracle snapshot.
      * @dev This function should always be called before calling getPrice
      * @param asset asset address
      */
     function updateAssetPrice(address asset) external {
-        (address pivotOracle, bool pivotOracleEnabled) = getOracle(asset, OracleRole.PIVOT);
-        if (pivotOracle != address(0) && pivotOracleEnabled) {
-            //if pivot oracle is not TwapOracle it will revert so we need to catch the revert
-            try TwapInterface(pivotOracle).updateTwap(asset) {} catch {}
-        }
+        _updateAssetPrice(asset);
     }
 
     /**
@@ -302,6 +303,7 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
      * @custom:error NotNullAddress is thrown if asset address is null
      * @custom:error NotNullAddress is thrown if main-role oracle address for asset is null
      * @custom:event Emits TokenConfigAdded event when the asset config is set successfully by the authorized account
+     * @custom:event Emits CachedEnabled event when the asset cachingEnabled flag is set successfully
      */
     function setTokenConfig(
         TokenConfig memory tokenConfig
@@ -315,6 +317,7 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
             tokenConfig.oracles[uint256(OracleRole.PIVOT)],
             tokenConfig.oracles[uint256(OracleRole.FALLBACK)]
         );
+        emit CachedEnabled(tokenConfig.asset, tokenConfig.cachingEnabled);
     }
 
     /**
@@ -329,8 +332,42 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
         enabled = tokenConfigs[asset].enableFlagsForOracles[uint256(role)];
     }
 
+    /**
+     * @notice Updates the capped oracle snapshot.
+     * @dev Cache the asset price and return if already cached
+     * @param asset asset address
+     */
+    function _updateAssetPrice(address asset) internal {
+        if (Transient.readCachedPrice(CACHE_SLOT, asset) != 0) {
+            return;
+        }
+
+        (address mainOracle, bool mainOracleEnabled) = getOracle(asset, OracleRole.MAIN);
+        if (mainOracle != address(0) && mainOracleEnabled) {
+            // if main oracle is not CorrelatedTokenOracle it will revert so we need to catch the revert
+            try ICappedOracle(mainOracle).updateSnapshot() {} catch {}
+        }
+
+        if (_isCacheEnabled(asset)) {
+            uint256 price = _getPrice(asset);
+            Transient.cachePrice(CACHE_SLOT, asset, price);
+        }
+    }
+
+    /**
+     * @notice Gets price for the provided asset
+     * @param asset asset address
+     * @return price USD price in scaled decimal places.
+     * @custom:error Invalid resilient oracle price error is thrown if fetched prices from oracle is invalid
+     */
     function _getPrice(address asset) internal view returns (uint256) {
         uint256 pivotPrice = INVALID_PRICE;
+        uint256 price;
+
+        price = Transient.readCachedPrice(CACHE_SLOT, asset);
+        if (price != 0) {
+            return price;
+        }
 
         // Get pivot oracle price, Invalid price if not available or error
         (address pivotOracle, bool pivotOracleEnabled) = getOracle(asset, OracleRole.PIVOT);
@@ -451,4 +488,13 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
             asset = VBep20Interface(vToken).underlying();
         }
     }
+
+    /**
+     * @dev This function checks if the asset price should be cached
+     * @param asset asset address
+     * @return bool true if caching is enabled, false otherwise
+     */
+    function _isCacheEnabled(address asset) private view returns (bool) {
+        return tokenConfigs[asset].cachingEnabled;
+    }
 }

audits/126_capped_cached_fairyproof_20250319.pdf

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: BSD-3-Clause
+pragma solidity 0.8.25;
+
+interface ICappedOracle {
+    function updateSnapshot() external;
+}

audits/127_capped_cached_quantstamp_20250325.pdf

@@ -13,10 +13,6 @@ interface ResilientOracleInterface is OracleInterface {
     function getUnderlyingPrice(address vToken) external view returns (uint256);
 }
 
-interface TwapInterface is OracleInterface {
-    function updateTwap(address asset) external returns (uint256);
-}
-
 interface BoundValidatorInterface {
     function validatePriceWithAnchorPrice(
         address asset,