Merge pull request #286 from VenusProtocol/feat/VEN-3625

[VEN-3265]: WstETHOracleV2 could use different contracts to get the wstETH ratio

Author: web3rover

audits/137_wstETHOracleV2_certik_20250623.pdf

@@ -4,17 +4,24 @@ pragma solidity 0.8.25;
 import { IStETH } from "../interfaces/IStETH.sol";
 import { CorrelatedTokenOracle } from "./common/CorrelatedTokenOracle.sol";
 import { EXP_SCALE } from "@venusprotocol/solidity-utilities/contracts/constants.sol";
+import { ensureNonzeroAddress } from "@venusprotocol/solidity-utilities/contracts/validators.sol";
 
 /**
  * @title WstETHOracleV2
  * @author Venus
  * @notice This oracle fetches the price of wstETH
  */
 contract WstETHOracleV2 is CorrelatedTokenOracle {
+    /// @notice Address of stETH
+    IStETH public immutable STETH;
+
     /// @notice Constructor for the implementation contract.
+    /// @dev The underlyingToken must be correlated so that 1 underlyingToken is equal to 1 stETH, because
+    /// getUnderlyingAmount() implicitly assumes that
     constructor(
-        address wstETH,
         address stETH,
+        address wstETH,
+        address underlyingToken,
         address resilientOracle,
         uint256 annualGrowthRate,
         uint256 _snapshotInterval,
@@ -25,7 +32,7 @@ contract WstETHOracleV2 is CorrelatedTokenOracle {
     )
         CorrelatedTokenOracle(
             wstETH,
-            stETH,
+            underlyingToken,
             resilientOracle,
             annualGrowthRate,
             _snapshotInterval,
@@ -34,13 +41,16 @@ contract WstETHOracleV2 is CorrelatedTokenOracle {
             accessControlManager,
             _snapshotGap
         )
-    {}
+    {
+        ensureNonzeroAddress(stETH);
+        STETH = IStETH(stETH);
+    }
 
     /**
-     * @notice Gets the stETH for 1 wstETH
-     * @return amount Amount of stETH
+     * @notice Gets the amount of underlyingToken for 1 wstETH, assuming that 1 underlyingToken is equivalent to 1 stETH
+     * @return amount Amount of underlyingToken
      */
     function getUnderlyingAmount() public view override returns (uint256) {
-        return IStETH(UNDERLYING_TOKEN).getPooledEthByShares(EXP_SCALE);
+        return STETH.getPooledEthByShares(EXP_SCALE);
     }
 }

contracts/oracles/WstETHOracleV2.sol

@@ -1,67 +1,96 @@
+import { BigNumber } from "ethers";
+import { parseUnits } from "ethers/lib/utils";
 import { ethers } from "hardhat";
 import { DeployFunction } from "hardhat-deploy/dist/types";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 
-import { ADDRESSES, addr0000, assets } from "../helpers/deploymentConfig";
+import {
+  ADDRESSES,
+  DAYS_30,
+  addr0000,
+  assets,
+  getSnapshotGap,
+  increaseExchangeRateByPercentage,
+} from "../helpers/deploymentConfig";
 
-const func: DeployFunction = async ({
-  getNamedAccounts,
-  deployments,
-  network,
-  artifacts,
-}: HardhatRuntimeEnvironment) => {
+const func: DeployFunction = async ({ getNamedAccounts, deployments, network }: HardhatRuntimeEnvironment) => {
   const { deploy } = deployments;
   const { deployer } = await getNamedAccounts();
 
-  console.log(`Deployer ${deployer}`);
-
-  const proxyOwnerAddress = network.live ? ADDRESSES[network.name].timelock : deployer;
-
-  const { stETHAddress, wstETHAddress } = ADDRESSES[network.name];
+  const { stETHAddress, wstETHAddress, acm } = ADDRESSES[network.name];
   const WETHAsset = assets[network.name].find(asset => asset.token === "WETH");
   const WETHAddress = WETHAsset?.address ?? addr0000;
 
-  const defaultProxyAdmin = await artifacts.readArtifact(
-    "hardhat-deploy/solc_0.8/openzeppelin/proxy/transparent/ProxyAdmin.sol:ProxyAdmin",
-  );
-
   const oracle = await ethers.getContract("ResilientOracle");
 
   // Equivalence and NonEquivalence is related to if the oracle will
   // assume 1/1 price ration between stETH/ETH or
   // will get stETH/USD price from secondary market
 
-  await deploy("WstETHOracle_Equivalence", {
-    contract: "WstETHOracle",
-    from: deployer,
-    log: true,
-    deterministicDeployment: false,
-    args: [wstETHAddress, WETHAddress, stETHAddress, oracle.address, true],
-    proxy: {
-      owner: proxyOwnerAddress,
-      proxyContract: "OptimizedTransparentUpgradeableProxy",
-      viaAdminContract: {
-        name: "DefaultProxyAdmin",
-        artifact: defaultProxyAdmin,
-      },
-    },
-  });
+  const wstETH_ANNUAL_GROWTH_RATE = ethers.utils.parseUnits("0.067", 18); // 6.7%
+  const block = await ethers.provider.getBlock("latest");
+  const stETHContract = await ethers.getContractAt("IStETH", stETHAddress);
+  const exchangeRate = await stETHContract.getPooledEthByShares(parseUnits("1", 18));
+  const snapshotGap = BigNumber.from("55"); // 0.55%
+
+  if (network.name === "ethereum") {
+    await deploy("WstETHOracle_Equivalence", {
+      contract: "WstETHOracleV2",
+      from: deployer,
+      log: true,
+      deterministicDeployment: false,
+      args: [
+        stETHAddress,
+        wstETHAddress,
+        WETHAddress,
+        oracle.address,
+        wstETH_ANNUAL_GROWTH_RATE,
+        DAYS_30,
+        increaseExchangeRateByPercentage(exchangeRate, snapshotGap),
+        block.timestamp,
+        acm,
+        getSnapshotGap(exchangeRate, snapshotGap.toNumber()),
+      ],
+    });
 
-  await deploy("WstETHOracle_NonEquivalence", {
-    contract: "WstETHOracle",
-    from: deployer,
-    log: true,
-    deterministicDeployment: false,
-    args: [wstETHAddress, WETHAddress, stETHAddress, oracle.address, false],
-    proxy: {
-      owner: proxyOwnerAddress,
-      proxyContract: "OptimizedTransparentUpgradeableProxy",
-      viaAdminContract: {
-        name: "DefaultProxyAdmin",
-        artifact: defaultProxyAdmin,
-      },
-    },
-  });
+    await deploy("WstETHOracle_NonEquivalence", {
+      contract: "WstETHOracleV2",
+      from: deployer,
+      log: true,
+      deterministicDeployment: false,
+      args: [
+        stETHAddress,
+        wstETHAddress,
+        stETHAddress,
+        oracle.address,
+        wstETH_ANNUAL_GROWTH_RATE,
+        DAYS_30,
+        increaseExchangeRateByPercentage(exchangeRate, snapshotGap),
+        block.timestamp,
+        acm,
+        getSnapshotGap(exchangeRate, snapshotGap.toNumber()),
+      ],
+    });
+  } else {
+    await deploy("WstETHOracle", {
+      contract: "WstETHOracleV2",
+      from: deployer,
+      log: true,
+      deterministicDeployment: false,
+      args: [
+        stETHAddress,
+        wstETHAddress,
+        WETHAddress,
+        oracle.address,
+        wstETH_ANNUAL_GROWTH_RATE,
+        DAYS_30,
+        increaseExchangeRateByPercentage(exchangeRate, snapshotGap),
+        block.timestamp,
+        acm,
+        getSnapshotGap(exchangeRate, snapshotGap.toNumber()),
+      ],
+    });
+  }
 };
 
 export default func;