[VEN-1829]: Deploy Oracles on Sepolia

.env.example

@@ -1,5 +1,16 @@
-MNEMONIC=
+# true or false
+FORK=false
+FORKED_NETWORK=bscmainnet
+
+DEPLOYER_PRIVATE_KEY=
+
+## Archive nodes
+ARCHIVE_NODE_bsctestnet=https://bsc-testnet.nodereal.io/v1/<YOUR_KEY_HERE>
+ARCHIVE_NODE_bscmainnet=https://bsc-mainnet.nodereal.io/v1/<YOUR_KEY_HERE>
+#ARCHIVE_NODE_bscmainnet=http://127.0.0.1:1248
+ARCHIVE_NODE_sepolia=https://ethereum-sepolia.blockpi.network/v1/rpc/public
+ARCHIVE_NODE_ethereum=https://eth-mainnet.nodereal.io/v1/<YOUR_KEY_HERE>
+#ARCHIVE_NODE_ethereum=http://127.0.0.1:1248
+
 ETHERSCAN_API_KEY=
-REPORT_GAS=
-FORK_MAINNET=
-QUICK_NODE_URL=
+REPORT_GAS=

.github/workflows/ci.yml

@@ -118,6 +118,8 @@ jobs:
         run: |
           yarn hardhat export --network bsctestnet --export ./deployments/bsctestnet.json
           yarn hardhat export --network bscmainnet --export ./deployments/bscmainnet.json
+          yarn hardhat export --network sepolia --export ./deployments/sepolia.json
+          yarn hardhat export --network ethereum --export ./deployments/ethereum.json
           yarn prettier
       - uses: stefanzweifel/git-auto-commit-action@v5
         with:

README.md

@@ -72,7 +72,7 @@ npx hardhat test
 
 ```
 
-- To run fork tests add FORK_MAINNET=true PRIVATE_KEY and QUICK_NODE_KEY in the .env file.
+- To run fork tests add FORK=true, FORKED_NETWORK and one ARCHIVE_NODE var in the .env file.
 
 ## Releases and Versioning
 

contracts/ResilientOracle.sol

@@ -70,16 +70,17 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
 
     uint256 public constant INVALID_PRICE = 0;
 
-    /// @notice vBNB address
+    /// @notice Native market address
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
-    address public immutable vBnb;
+    address public immutable nativeMarket;
 
     /// @notice VAI address
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     address public immutable vai;
 
-    /// @notice Set this as asset address for BNB. This is the underlying for vBNB
-    address public constant BNB_ADDR = 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB;
+    /// @notice Set this as asset address for Native token on each chain.This is the underlying for vBNB (on bsc)
+    /// and can serve as any underlying asset of a market that supports native tokens
+    address public constant NATIVE_TOKEN_ADDR = 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB;
 
     /// @notice Bound validator contract address
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
@@ -119,16 +120,19 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
     }
 
     /// @notice Constructor for the implementation contract. Sets immutable variables.
-    /// @param vBnbAddress The address of the vBNB
-    /// @param vaiAddress The address of the VAI
+    /// @dev nativeMarketAddress can be address(0) if on the chain we do not support native market
+    ///      (e.g vETH on ethereum would not be supported, only vWETH)
+    /// @param nativeMarketAddress The address of a native market (for bsc it would be vBNB address)
+    /// @param vaiAddress The address of the VAI token (if there is VAI on the deployed chain).
+    ///          Set to address(0) of VAI is not existent.
     /// @param _boundValidator Address of the bound validator contract
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor(
-        address vBnbAddress,
+        address nativeMarketAddress,
         address vaiAddress,
         BoundValidatorInterface _boundValidator
-    ) notNullAddress(vBnbAddress) notNullAddress(vaiAddress) notNullAddress(address(_boundValidator)) {
-        vBnb = vBnbAddress;
+    ) notNullAddress(address(_boundValidator)) {
+        nativeMarket = nativeMarketAddress;
         vai = vaiAddress;
         boundValidator = _boundValidator;
 
@@ -438,10 +442,10 @@ contract ResilientOracle is PausableUpgradeable, AccessControlledV8, ResilientOr
      * @param vToken vToken address
      * @return asset underlying asset address
      */
-    function _getUnderlyingAsset(address vToken) private view returns (address asset) {
-        if (address(vToken) == vBnb) {
-            asset = BNB_ADDR;
-        } else if (address(vToken) == vai) {
+    function _getUnderlyingAsset(address vToken) private view notNullAddress(vToken) returns (address asset) {
+        if (vToken == nativeMarket) {
+            asset = NATIVE_TOKEN_ADDR;
+        } else if (vToken == vai) {
             asset = vai;
         } else {
             asset = VBep20Interface(vToken).underlying();

contracts/oracles/ChainlinkOracle.sol

@@ -15,16 +15,18 @@ contract ChainlinkOracle is AccessControlledV8, OracleInterface {
     struct TokenConfig {
         /// @notice Underlying token address, which can't be a null address
         /// @notice Used to check if a token is supported
-        /// @notice 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB for BNB
+        /// @notice 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB address for native tokens
+        ///         (e.g BNB for BNB chain, ETH for Ethereum network)
         address asset;
         /// @notice Chainlink feed address
         address feed;
         /// @notice Price expiration period of this asset
         uint256 maxStalePeriod;
     }
 
-    /// @notice Set this as asset address for BNB. This is the underlying address for vBNB
-    address public constant BNB_ADDR = 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB;
+    /// @notice Set this as asset address for native token on each chain.
+    /// This is the underlying address for vBNB on BNB chain or an underlying asset for a native market on any chain.
+    address public constant NATIVE_TOKEN_ADDR = 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB;
 
     /// @notice Manually set an override price, useful under extenuating conditions such as price feed failure
     mapping(address => uint256) public prices;
@@ -116,7 +118,7 @@ contract ChainlinkOracle is AccessControlledV8, OracleInterface {
     function getPrice(address asset) public view returns (uint256) {
         uint256 decimals;
 
-        if (asset == BNB_ADDR) {
+        if (asset == NATIVE_TOKEN_ADDR) {
             decimals = 18;
         } else {
             IERC20Metadata token = IERC20Metadata(asset);

deploy/1-deploy-oracles.ts

@@ -2,13 +2,15 @@ import hre from "hardhat";
 import { DeployFunction } from "hardhat-deploy/dist/types";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 
-import { ADDRESSES } from "../utils/deploymentUtils";
+import { ADDRESSES } from "../helpers/deploymentConfig";
 
 const func: DeployFunction = async function ({ getNamedAccounts, deployments, network }: HardhatRuntimeEnvironment) {
   const { deploy } = deployments;
   const { deployer } = await getNamedAccounts();
 
-  const networkName = network.name === "bscmainnet" ? "bscmainnet" : "bsctestnet";
+  console.log(deployer);
+
+  const networkName: string = network.name === "hardhat" ? "bsctestnet" : network.name;
 
   const { vBNBAddress } = ADDRESSES[networkName];
   const { VAIAddress } = ADDRESSES[networkName];
@@ -76,99 +78,109 @@ const func: DeployFunction = async function ({ getNamedAccounts, deployments, ne
     },
   });
 
-  await deploy("TwapOracle", {
-    contract: network.live ? "TwapOracle" : "MockTwapOracle",
-    from: deployer,
-    log: true,
-    deterministicDeployment: false,
-    args: network.live ? [WBNBAddress] : [],
-    proxy: {
-      owner: proxyOwnerAddress,
-      proxyContract: "OptimizedTransparentProxy",
-      execute: {
-        methodName: "initialize",
-        args: network.live ? [accessControlManagerAddress] : [vBNBAddress],
+  // Skip deployment if chain is not BNB chain
+  if (networkName === "bsctetnet" || networkName === "bscmainnet") {
+    await deploy("TwapOracle", {
+      contract: network.live ? "TwapOracle" : "MockTwapOracle",
+      from: deployer,
+      log: true,
+      deterministicDeployment: false,
+      args: network.live ? [WBNBAddress] : [],
+      proxy: {
+        owner: proxyOwnerAddress,
+        proxyContract: "OptimizedTransparentProxy",
+        execute: {
+          methodName: "initialize",
+          args: network.live ? [accessControlManagerAddress] : [vBNBAddress],
+        },
       },
-    },
-  });
+    });
+
+    const twapOracle = await hre.ethers.getContract("TwapOracle");
+    const twapOracleOwner = await twapOracle.owner();
+
+    if (twapOracleOwner === deployer) {
+      await twapOracle.transferOwnership(ADDRESSES[networkName].timelock);
+    }
+  }
 
   const { pythOracleAddress } = ADDRESSES[networkName];
 
-  await deploy("PythOracle", {
-    contract: network.live ? "PythOracle" : "MockPythOracle",
-    from: deployer,
-    log: true,
-    deterministicDeployment: false,
-    args: [],
-    proxy: {
-      owner: proxyOwnerAddress,
-      proxyContract: "OptimizedTransparentProxy",
-      execute: {
-        methodName: "initialize",
-        args: network.live ? [pythOracleAddress, accessControlManagerAddress] : [pythOracleAddress],
+  // Skip if no pythOracle address in config
+  if (pythOracleAddress) {
+    await deploy("PythOracle", {
+      contract: network.live ? "PythOracle" : "MockPythOracle",
+      from: deployer,
+      log: true,
+      deterministicDeployment: false,
+      args: [],
+      proxy: {
+        owner: proxyOwnerAddress,
+        proxyContract: "OptimizedTransparentProxy",
+        execute: {
+          methodName: "initialize",
+          args: network.live ? [pythOracleAddress, accessControlManagerAddress] : [pythOracleAddress],
+        },
       },
-    },
-  });
+    });
 
-  const { sidRegistryAddress } = ADDRESSES[networkName];
+    const pythOracle = await hre.ethers.getContract("PythOracle");
+    await accessControlManager?.giveCallPermission(pythOracle.address, "setTokenConfig(TokenConfig)", deployer);
+    const pythOracleOwner = await pythOracle.owner();
 
-  await deploy("BinanceOracle", {
-    contract: network.live ? "BinanceOracle" : "MockBinanceOracle",
-    from: deployer,
-    log: true,
-    deterministicDeployment: false,
-    args: [],
-    proxy: {
-      owner: proxyOwnerAddress,
-      proxyContract: "OptimizedTransparentProxy",
-      execute: {
-        methodName: "initialize",
-        args: network.live ? [sidRegistryAddress, accessControlManagerAddress] : [],
+    if (pythOracleOwner === deployer) {
+      await pythOracle.transferOwnership(ADDRESSES[networkName].timelock);
+    }
+  }
+
+  const { sidRegistryAddress } = ADDRESSES[networkName];
+  // Skip if no sidRegistryAddress address in config
+  if (sidRegistryAddress) {
+    await deploy("BinanceOracle", {
+      contract: network.live ? "BinanceOracle" : "MockBinanceOracle",
+      from: deployer,
+      log: true,
+      deterministicDeployment: false,
+      args: [],
+      proxy: {
+        owner: proxyOwnerAddress,
+        proxyContract: "OptimizedTransparentProxy",
+        execute: {
+          methodName: "initialize",
+          args: network.live ? [sidRegistryAddress, accessControlManagerAddress] : [],
+        },
       },
-    },
-  });
+    });
+    const binanceOracle = await hre.ethers.getContract("BinanceOracle");
+    const binanceOracleOwner = await binanceOracle.owner();
+
+    if (binanceOracleOwner === deployer) {
+      await binanceOracle.transferOwnership(ADDRESSES[networkName].timelock);
+    }
+  }
 
   const resilientOracle = await hre.ethers.getContract("ResilientOracle");
-  const pythOracle = await hre.ethers.getContract("PythOracle");
   const chainlinkOracle = await hre.ethers.getContract("ChainlinkOracle");
-  const binanceOracle = await hre.ethers.getContract("BinanceOracle");
-  const twapOracle = await hre.ethers.getContract("TwapOracle");
 
   await accessControlManager?.giveCallPermission(chainlinkOracle.address, "setTokenConfig(TokenConfig)", deployer);
-  await accessControlManager?.giveCallPermission(pythOracle.address, "setTokenConfig(TokenConfig)", deployer);
   await accessControlManager?.giveCallPermission(resilientOracle.address, "setTokenConfig(TokenConfig)", deployer);
 
   const resilientOracleOwner = await resilientOracle.owner();
-  const pythOracleOwner = await pythOracle.owner();
-  const binanceOracleOwner = await binanceOracle.owner();
   const chainlinkOracleOwner = await chainlinkOracle.owner();
-  const twapOracleOwner = await twapOracle.owner();
   const boundValidatorOwner = await boundValidator.owner();
 
   if (resilientOracleOwner === deployer) {
     await resilientOracle.transferOwnership(ADDRESSES[networkName].timelock);
   }
 
-  if (pythOracleOwner === deployer) {
-    await pythOracle.transferOwnership(ADDRESSES[networkName].timelock);
-  }
-
-  if (binanceOracleOwner === deployer) {
-    await binanceOracle.transferOwnership(ADDRESSES[networkName].timelock);
-  }
-
   if (chainlinkOracleOwner === deployer) {
     await chainlinkOracle.transferOwnership(ADDRESSES[networkName].timelock);
   }
 
-  if (twapOracleOwner === deployer) {
-    await twapOracle.transferOwnership(ADDRESSES[networkName].timelock);
-  }
-
   if (boundValidatorOwner === deployer) {
     await boundValidator.transferOwnership(ADDRESSES[networkName].timelock);
   }
 };
 
 export default func;
-export const tags = ["deploy"];
+func.tags = ["deploy"];

deploy/3-deploy-redstone-oracle.ts → deploy/2-deploy-redstone-oracle.ts

@@ -2,13 +2,12 @@ import hre from "hardhat";
 import { DeployFunction } from "hardhat-deploy/dist/types";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 
-import { ADDRESSES } from "../utils/deploymentUtils";
+import { ADDRESSES } from "../helpers/deploymentConfig";
 
 const func: DeployFunction = async function ({ getNamedAccounts, deployments, network }: HardhatRuntimeEnvironment) {
   const { deploy } = deployments;
   const { deployer } = await getNamedAccounts();
-  const networkName = network.name === "bscmainnet" ? "bscmainnet" : "bsctestnet";
-  const proxyOwnerAddress = network.live ? ADDRESSES[networkName].timelock : deployer;
+  const proxyOwnerAddress = network.live ? ADDRESSES[network.name].timelock : deployer;
 
   await deploy("RedStoneOracle", {
     contract: network.live ? "ChainlinkOracle" : "MockChainlinkOracle",
@@ -21,16 +20,16 @@ const func: DeployFunction = async function ({ getNamedAccounts, deployments, ne
       proxyContract: "OptimizedTransparentProxy",
       execute: {
         methodName: "initialize",
-        args: network.live ? [ADDRESSES[networkName].acm] : [],
+        args: network.live ? [ADDRESSES[network.name].acm] : [],
       },
     },
   });
 
   const redStoneOracle = await hre.ethers.getContract("RedStoneOracle");
   const redStoneOracleOwner = await redStoneOracle.owner();
 
-  if (redStoneOracleOwner === deployer) {
-    await redStoneOracle.transferOwnership(ADDRESSES[networkName].timelock);
+  if (redStoneOracleOwner === deployer && network.live) {
+    await redStoneOracle.transferOwnership(ADDRESSES[network.name].timelock);
   }
 };