Merge pull request #75 from morpho-org/refactor/repo

MathisGD · web-flow · commit 42b004bc07c0 · 2024-02-18T19:22:35.000+01:00
refactor repo
diff --git a/src/morpho-chainlink-v1/ChainlinkOracle.sol b/src/morpho-chainlink-v1/ChainlinkOracle.sol
@@ -2,12 +2,12 @@
 pragma solidity 0.8.21;
 
 import {IChainlinkOracle} from "./interfaces/IChainlinkOracle.sol";
-import {IOracle} from "../lib/morpho-blue/src/interfaces/IOracle.sol";
+import {IOracle} from "../../lib/morpho-blue/src/interfaces/IOracle.sol";
 
-import {MinimalAggregatorV3Interface, ChainlinkDataFeedLib} from "./libraries/ChainlinkDataFeedLib.sol";
+import {AggregatorV3Interface, ChainlinkDataFeedLib} from "./libraries/ChainlinkDataFeedLib.sol";
 import {IERC4626, VaultLib} from "./libraries/VaultLib.sol";
 import {ErrorsLib} from "./libraries/ErrorsLib.sol";
-import {Math} from "../lib/openzeppelin-contracts/contracts/utils/math/Math.sol";
+import {Math} from "../../lib/openzeppelin-contracts/contracts/utils/math/Math.sol";
 
 /// @title ChainlinkOracle
 /// @author Morpho Labs
@@ -16,7 +16,7 @@ import {Math} from "../lib/openzeppelin-contracts/contracts/utils/math/Math.sol"
 contract ChainlinkOracle is IChainlinkOracle {
     using Math for uint256;
     using VaultLib for IERC4626;
-    using ChainlinkDataFeedLib for MinimalAggregatorV3Interface;
+    using ChainlinkDataFeedLib for AggregatorV3Interface;
 
     /* IMMUTABLES */
 
@@ -27,16 +27,16 @@ contract ChainlinkOracle is IChainlinkOracle {
     uint256 public immutable VAULT_CONVERSION_SAMPLE;
 
     /// @inheritdoc IChainlinkOracle
-    MinimalAggregatorV3Interface public immutable BASE_FEED_1;
+    AggregatorV3Interface public immutable BASE_FEED_1;
 
     /// @inheritdoc IChainlinkOracle
-    MinimalAggregatorV3Interface public immutable BASE_FEED_2;
+    AggregatorV3Interface public immutable BASE_FEED_2;
 
     /// @inheritdoc IChainlinkOracle
-    MinimalAggregatorV3Interface public immutable QUOTE_FEED_1;
+    AggregatorV3Interface public immutable QUOTE_FEED_1;
 
     /// @inheritdoc IChainlinkOracle
-    MinimalAggregatorV3Interface public immutable QUOTE_FEED_2;
+    AggregatorV3Interface public immutable QUOTE_FEED_2;
 
     /// @inheritdoc IChainlinkOracle
     uint256 public immutable SCALE_FACTOR;
@@ -63,10 +63,10 @@ contract ChainlinkOracle is IChainlinkOracle {
     /// @param quoteTokenDecimals Quote token decimals.
     constructor(
         IERC4626 vault,
-        MinimalAggregatorV3Interface baseFeed1,
-        MinimalAggregatorV3Interface baseFeed2,
-        MinimalAggregatorV3Interface quoteFeed1,
-        MinimalAggregatorV3Interface quoteFeed2,
+        AggregatorV3Interface baseFeed1,
+        AggregatorV3Interface baseFeed2,
+        AggregatorV3Interface quoteFeed1,
+        AggregatorV3Interface quoteFeed2,
         uint256 vaultConversionSample,
         uint256 baseTokenDecimals,
         uint256 quoteTokenDecimals
diff --git a/src/morpho-chainlink-v1/interfaces/AggregatorV3Interface.sol b/src/morpho-chainlink-v1/interfaces/AggregatorV3Interface.sol
@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.5.0;
+
+/// @dev From
+/// https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/shared/interfaces/AggregatorV3Interface.sol
+interface AggregatorV3Interface {
+    function decimals() external view returns (uint8);
+
+    function description() external view returns (string memory);
+
+    function version() external view returns (uint256);
+
+    function getRoundData(uint80 _roundId)
+        external
+        view
+        returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
+
+    function latestRoundData()
+        external
+        view
+        returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
+}
diff --git a/src/morpho-chainlink-v1/interfaces/IChainlinkOracle.sol b/src/morpho-chainlink-v1/interfaces/IChainlinkOracle.sol
@@ -2,8 +2,8 @@
 pragma solidity >=0.5.0;
 
 import {IERC4626} from "./IERC4626.sol";
-import {IOracle} from "../../lib/morpho-blue/src/interfaces/IOracle.sol";
-import {MinimalAggregatorV3Interface} from "./MinimalAggregatorV3Interface.sol";
+import {AggregatorV3Interface} from "./AggregatorV3Interface.sol";
+import {IOracle} from "../../../lib/morpho-blue/src/interfaces/IOracle.sol";
 
 /// @title IChainlinkOracle
 /// @author Morpho Labs
@@ -17,16 +17,16 @@ interface IChainlinkOracle is IOracle {
     function VAULT_CONVERSION_SAMPLE() external view returns (uint256);
 
     /// @notice Returns the address of the first Chainlink base feed.
-    function BASE_FEED_1() external view returns (MinimalAggregatorV3Interface);
+    function BASE_FEED_1() external view returns (AggregatorV3Interface);
 
     /// @notice Returns the address of the second Chainlink base feed.
-    function BASE_FEED_2() external view returns (MinimalAggregatorV3Interface);
+    function BASE_FEED_2() external view returns (AggregatorV3Interface);
 
     /// @notice Returns the address of the first Chainlink quote feed.
-    function QUOTE_FEED_1() external view returns (MinimalAggregatorV3Interface);
+    function QUOTE_FEED_1() external view returns (AggregatorV3Interface);
 
     /// @notice Returns the address of the second Chainlink quote feed.
-    function QUOTE_FEED_2() external view returns (MinimalAggregatorV3Interface);
+    function QUOTE_FEED_2() external view returns (AggregatorV3Interface);
 
     /// @notice Returns the price scale factor, calculated at contract creation.
     function SCALE_FACTOR() external view returns (uint256);
diff --git a/src/morpho-chainlink-v1/interfaces/IERC4626.sol b/src/morpho-chainlink-v1/interfaces/IERC4626.sol
diff --git a/src/morpho-chainlink-v1/libraries/ChainlinkDataFeedLib.sol b/src/morpho-chainlink-v1/libraries/ChainlinkDataFeedLib.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
-import {MinimalAggregatorV3Interface} from "../interfaces/MinimalAggregatorV3Interface.sol";
+import {AggregatorV3Interface} from "../interfaces/AggregatorV3Interface.sol";
 
 import {ErrorsLib} from "./ErrorsLib.sol";
 
@@ -17,7 +17,7 @@ library ChainlinkDataFeedLib {
     /// - Staleness is not checked because it's assumed that the Chainlink feed keeps its promises on this.
     /// - The price is not checked to be in the min/max bounds because it's assumed that the Chainlink feed keeps its
     /// promises on this.
-    function getPrice(MinimalAggregatorV3Interface feed) internal view returns (uint256) {
+    function getPrice(AggregatorV3Interface feed) internal view returns (uint256) {
         if (address(feed) == address(0)) return 1;
 
         (, int256 answer,,,) = feed.latestRoundData();
@@ -28,7 +28,7 @@ library ChainlinkDataFeedLib {
 
     /// @dev Returns the number of decimals of a `feed`.
     /// @dev When `feed` is the address zero, returns 0.
-    function getDecimals(MinimalAggregatorV3Interface feed) internal view returns (uint256) {
+    function getDecimals(AggregatorV3Interface feed) internal view returns (uint256) {
         if (address(feed) == address(0)) return 0;
 
         return feed.decimals();
diff --git a/src/morpho-chainlink-v1/libraries/ErrorsLib.sol b/src/morpho-chainlink-v1/libraries/ErrorsLib.sol
@@ -14,7 +14,4 @@ library ErrorsLib {
 
     /// @notice Thrown when the vault conversion sample is not 1 while vault = address(0).
     string constant VAULT_CONVERSION_SAMPLE_IS_NOT_ONE = "vault conversion sample is not one";
-
-    /// @notice Thrown when the zero address is passed as argument.
-    string constant ZERO_ADDRESS = "zero address";
 }
diff --git a/src/morpho-chainlink-v1/libraries/VaultLib.sol b/src/morpho-chainlink-v1/libraries/VaultLib.sol
diff --git a/src/wsteth-exchange-rate-adapter/WstEthEthExchangeRateChainlinkAdapter.sol b/src/wsteth-exchange-rate-adapter/WstEthEthExchangeRateChainlinkAdapter.sol
@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity 0.8.21;
 
-import {IWstEth} from "../interfaces/IWstEth.sol";
-import {MinimalAggregatorV3Interface} from "../interfaces/MinimalAggregatorV3Interface.sol";
+import {IWstEth} from "./interfaces/IWstEth.sol";
+import {MinimalAggregatorV3Interface} from "./interfaces/MinimalAggregatorV3Interface.sol";
 
-import {ErrorsLib} from "../libraries/ErrorsLib.sol";
+import {ErrorsLib} from "./libraries/ErrorsLib.sol";
 
 /// @title WstEthEthExchangeRateChainlinkAdapter
 /// @author Morpho Labs
diff --git a/src/wsteth-exchange-rate-adapter/interfaces/IWstEth.sol b/src/wsteth-exchange-rate-adapter/interfaces/IWstEth.sol
diff --git a/src/wsteth-exchange-rate-adapter/interfaces/MinimalAggregatorV3Interface.sol b/src/wsteth-exchange-rate-adapter/interfaces/MinimalAggregatorV3Interface.sol
diff --git a/src/wsteth-exchange-rate-adapter/libraries/ErrorsLib.sol b/src/wsteth-exchange-rate-adapter/libraries/ErrorsLib.sol
@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.0;
+
+/// @title ErrorsLib
+/// @author Morpho Labs
+/// @custom:contact security@morpho.org
+/// @notice Library exposing error messages.
+library ErrorsLib {
+    /// @notice Thrown when the zero address is passed as argument.
+    string constant ZERO_ADDRESS = "zero address";
+}
diff --git a/test/ChainlinkOracleTest.sol b/test/ChainlinkOracleTest.sol
@@ -2,8 +2,7 @@
 pragma solidity ^0.8.0;
 
 import "../lib/forge-std/src/Test.sol";
-import "../src/ChainlinkOracle.sol";
-import "../src/libraries/ErrorsLib.sol";
+import "../src/morpho-chainlink-v1/ChainlinkOracle.sol";
 import "./mocks/ChainlinkAggregatorMock.sol";
 import "./helpers/Constants.sol";
 
@@ -79,7 +78,7 @@ contract ChainlinkOracleTest is Test {
         price = bound(price, type(int256).min, -1);
         ChainlinkAggregatorMock aggregator = new ChainlinkAggregatorMock();
         ChainlinkOracle oracle = new ChainlinkOracle(
-            vaultZero, MinimalAggregatorV3Interface(address(aggregator)), feedZero, feedZero, feedZero, 1, 18, 0
+            vaultZero, AggregatorV3Interface(address(aggregator)), feedZero, feedZero, feedZero, 1, 18, 0
         );
         aggregator.setAnwser(price);
         vm.expectRevert(bytes(ErrorsLib.NEGATIVE_ANSWER));
diff --git a/test/WstEthEthExchangeRateChainlinkAdapterTest.sol b/test/WstEthEthExchangeRateChainlinkAdapterTest.sol
@@ -1,12 +1,10 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
-import "../src/libraries/ErrorsLib.sol";
-
-import "../lib/forge-std/src/Test.sol";
-import "../src/adapters/WstEthEthExchangeRateChainlinkAdapter.sol";
-import "../src/ChainlinkOracle.sol";
 import "./helpers/Constants.sol";
+import "../lib/forge-std/src/Test.sol";
+import {ChainlinkOracle} from "../src/morpho-chainlink-v1/ChainlinkOracle.sol";
+import "../src/wsteth-exchange-rate-adapter/WstEthEthExchangeRateChainlinkAdapter.sol";
 
 contract WstEthEthExchangeRateChainlinkAdapterTest is Test {
     IWstEth internal constant WST_ETH = IWstEth(0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0);
@@ -17,7 +15,9 @@ contract WstEthEthExchangeRateChainlinkAdapterTest is Test {
     function setUp() public {
         vm.createSelectFork(vm.envString("ETH_RPC_URL"));
         oracle = new WstEthEthExchangeRateChainlinkAdapter(address(WST_ETH));
-        chainlinkOracle = new ChainlinkOracle(vaultZero, oracle, feedZero, feedZero, feedZero, 1, 18, 18);
+        chainlinkOracle = new ChainlinkOracle(
+            vaultZero, AggregatorV3Interface(address(oracle)), feedZero, feedZero, feedZero, 1, 18, 18
+        );
     }
 
     function testDecimals() public {
diff --git a/test/helpers/Constants.sol b/test/helpers/Constants.sol
@@ -1,33 +1,25 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 pragma solidity ^0.8.0;
 
-import {IERC4626, MinimalAggregatorV3Interface} from "../../src/ChainlinkOracle.sol";
+import {IERC4626, AggregatorV3Interface} from "../../src/morpho-chainlink-v1/ChainlinkOracle.sol";
 
-MinimalAggregatorV3Interface constant feedZero = MinimalAggregatorV3Interface(address(0));
+AggregatorV3Interface constant feedZero = AggregatorV3Interface(address(0));
 // 8 decimals of precision
-MinimalAggregatorV3Interface constant btcUsdFeed =
-    MinimalAggregatorV3Interface(0xF4030086522a5bEEa4988F8cA5B36dbC97BeE88c);
+AggregatorV3Interface constant btcUsdFeed = AggregatorV3Interface(0xF4030086522a5bEEa4988F8cA5B36dbC97BeE88c);
 // 8 decimals of precision
-MinimalAggregatorV3Interface constant usdcUsdFeed =
-    MinimalAggregatorV3Interface(0x8fFfFfd4AfB6115b954Bd326cbe7B4BA576818f6);
+AggregatorV3Interface constant usdcUsdFeed = AggregatorV3Interface(0x8fFfFfd4AfB6115b954Bd326cbe7B4BA576818f6);
 // 18 decimals of precision
-MinimalAggregatorV3Interface constant btcEthFeed =
-    MinimalAggregatorV3Interface(0xdeb288F737066589598e9214E782fa5A8eD689e8);
+AggregatorV3Interface constant btcEthFeed = AggregatorV3Interface(0xdeb288F737066589598e9214E782fa5A8eD689e8);
 // 8 decimals of precision
-MinimalAggregatorV3Interface constant wBtcBtcFeed =
-    MinimalAggregatorV3Interface(0xfdFD9C85aD200c506Cf9e21F1FD8dd01932FBB23);
+AggregatorV3Interface constant wBtcBtcFeed = AggregatorV3Interface(0xfdFD9C85aD200c506Cf9e21F1FD8dd01932FBB23);
 // 18 decimals of precision
-MinimalAggregatorV3Interface constant stEthEthFeed =
-    MinimalAggregatorV3Interface(0x86392dC19c0b719886221c78AB11eb8Cf5c52812);
+AggregatorV3Interface constant stEthEthFeed = AggregatorV3Interface(0x86392dC19c0b719886221c78AB11eb8Cf5c52812);
 // 18 decimals of precision
-MinimalAggregatorV3Interface constant usdcEthFeed =
-    MinimalAggregatorV3Interface(0x986b5E1e1755e3C2440e960477f25201B0a8bbD4);
+AggregatorV3Interface constant usdcEthFeed = AggregatorV3Interface(0x986b5E1e1755e3C2440e960477f25201B0a8bbD4);
 // 8 decimals of precision
-MinimalAggregatorV3Interface constant ethUsdFeed =
-    MinimalAggregatorV3Interface(0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419);
+AggregatorV3Interface constant ethUsdFeed = AggregatorV3Interface(0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419);
 // 18 decimals of precision
-MinimalAggregatorV3Interface constant daiEthFeed =
-    MinimalAggregatorV3Interface(0x773616E4d11A78F511299002da57A0a94577F1f4);
+AggregatorV3Interface constant daiEthFeed = AggregatorV3Interface(0x773616E4d11A78F511299002da57A0a94577F1f4);
 
 IERC4626 constant vaultZero = IERC4626(address(0));
 IERC4626 constant sDaiVault = IERC4626(0x83F20F44975D03b1b09e64809B757c47f942BEeA);

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,4 @@ library ErrorsLib {`
`14`	`14`
`15`	`15`	`/// @notice Thrown when the vault conversion sample is not 1 while vault = address(0).`
`16`	`16`	`string constant VAULT_CONVERSION_SAMPLE_IS_NOT_ONE = "vault conversion sample is not one";`
`17`		`-`
`18`		`- /// @notice Thrown when the zero address is passed as argument.`
`19`		`- string constant ZERO_ADDRESS = "zero address";`
`20`	`17`	`}`