Merge pull request #84 from morpho-org/docs/natspec-issues

Natspec issues

Author: MathisGD

src/morpho-chainlink/MorphoChainlinkOracleV2.sol

@@ -50,14 +50,11 @@ contract MorphoChainlinkOracleV2 is IMorphoChainlinkOracleV2 {
     /* CONSTRUCTOR */
 
     /// @dev Here is the list of assumptions that guarantees the oracle behaves as expected:
-    /// - Feeds are either Chainlink-compliant or the address zero.
-    /// - Feeds have the same behavioral assumptions as Chainlink's.
-    /// - Feeds are set in the correct order.
+    /// - The vaults, if set, are ERC4626-compliant.
+    /// - The feeds, if set, are Chainlink-interface-compliant.
     /// - Decimals passed as argument are correct.
-    /// - The vaults' sample shares quoted as assets and the base feed prices don't overflow when multiplied.
-    /// - The quote feed prices don't overflow when multiplied.
-    /// - Vaults are either ERC4626-compliant or the address zero.
-    /// @dev The base asset is the collateral token and the quote asset is the loan token.
+    /// - The base vaults's sample shares quoted as assets and the base feed prices don't overflow when multiplied.
+    /// - The quote vault's sample shares quoted as assets and the quote feed prices don't overflow when multiplied.
     /// @param baseVault Base vault. Pass address zero to omit this parameter.
     /// @param baseVaultConversionSample The sample amount of base vault shares used to convert to underlying.
     /// Pass 1 if the base asset is not a vault. Should be chosen such that converting `baseVaultConversionSample` to
@@ -72,6 +69,7 @@ contract MorphoChainlinkOracleV2 is IMorphoChainlinkOracleV2 {
     /// @param quoteFeed1 First quote feed. Pass address zero if the price = 1.
     /// @param quoteFeed2 Second quote feed. Pass address zero if the price = 1.
     /// @param quoteTokenDecimals Quote token decimals.
+    /// @dev The base asset should be the collateral token and the quote asset the loan token.
     constructor(
         IERC4626 baseVault,
         uint256 baseVaultConversionSample,
@@ -125,7 +123,7 @@ contract MorphoChainlinkOracleV2 is IMorphoChainlinkOracleV2 {
         // = 1e36 * (pB1 * 1e(-dB1) * pB2) / (pQ1 * 1e(-dQ1) * pQ2)
 
         // Let fpB1, fpB2, fpQ1, fpQ2 be the feed precision of the respective prices pB1, pB2, pQ1, pQ2.
-        // Chainlink feeds return pB1 * 1e(fpB1), pB2 * 1e(fpB2), pQ1 * 1e(fpQ1) and pQ2 * 1e(fpQ2).
+        // Feeds return pB1 * 1e(fpB1), pB2 * 1e(fpB2), pQ1 * 1e(fpQ1) and pQ2 * 1e(fpQ2).
 
         // Based on the implementation of `price()` below, the value of `SCALE_FACTOR` should thus satisfy:
         // (pB1 * 1e(fpB1)) * (pB2 * 1e(fpB2)) * SCALE_FACTOR / ((pQ1 * 1e(fpQ1)) * (pQ2 * 1e(fpQ2)))

src/morpho-chainlink/interfaces/IMorphoChainlinkOracleV2.sol

@@ -22,16 +22,16 @@ interface IMorphoChainlinkOracleV2 is IOracle {
     /// @notice Returns the quote vault conversion sample.
     function QUOTE_VAULT_CONVERSION_SAMPLE() external view returns (uint256);
 
-    /// @notice Returns the address of the first Chainlink base feed.
+    /// @notice Returns the address of the first base feed.
     function BASE_FEED_1() external view returns (AggregatorV3Interface);
 
-    /// @notice Returns the address of the second Chainlink base feed.
+    /// @notice Returns the address of the second base feed.
     function BASE_FEED_2() external view returns (AggregatorV3Interface);
 
-    /// @notice Returns the address of the first Chainlink quote feed.
+    /// @notice Returns the address of the first quote feed.
     function QUOTE_FEED_1() external view returns (AggregatorV3Interface);
 
-    /// @notice Returns the address of the second Chainlink quote feed.
+    /// @notice Returns the address of the second quote feed.
     function QUOTE_FEED_2() external view returns (AggregatorV3Interface);
 
     /// @notice Returns the price scale factor, calculated at contract creation.

src/morpho-chainlink/interfaces/IMorphoChainlinkOracleV2Factory.sol

@@ -19,13 +19,11 @@ interface IMorphoChainlinkOracleV2Factory {
     function isMorphoChainlinkOracleV2(address target) external view returns (bool);
 
     /// @dev Here is the list of assumptions that guarantees the oracle behaves as expected:
-    /// - Feeds are either Chainlink-compliant or the address zero.
-    /// - Feeds have the same behavioral assumptions as Chainlink's.
-    /// - Feeds are set in the correct order.
+    /// - The vaults, if set, are ERC4626-compliant.
+    /// - The feeds, if set, are Chainlink-interface-compliant.
     /// - Decimals passed as argument are correct.
-    /// - The vault's sample shares quoted as assets and the base feed prices don't overflow when multiplied.
-    /// - The quote feed prices don't overflow when multiplied.
-    /// - The vault, if set, is ERC4626-compliant.
+    /// - The base vaults's sample shares quoted as assets and the base feed prices don't overflow when multiplied.
+    /// - The quote vault's sample shares quoted as assets and the quote feed prices don't overflow when multiplied.
     /// @param baseVault Base vault. Pass address zero to omit this parameter.
     /// @param baseVaultConversionSample The sample amount of base vault shares used to convert to underlying.
     /// Pass 1 if the base asset is not a vault. Should be chosen such that converting `baseVaultConversionSample` to
@@ -40,7 +38,8 @@ interface IMorphoChainlinkOracleV2Factory {
     /// @param quoteFeed1 First quote feed. Pass address zero if the price = 1.
     /// @param quoteFeed2 Second quote feed. Pass address zero if the price = 1.
     /// @param quoteTokenDecimals Quote token decimals.
-    /// @param salt The salt to use for the MetaMorpho vault's CREATE2 address.
+    /// @param salt The salt to use for the CREATE2.
+    /// @dev The base asset should be the collateral token and the quote asset the loan token.
     function createMorphoChainlinkOracleV2(
         IERC4626 baseVault,
         uint256 baseVaultConversionSample,

test/MorphoChainlinkOracleV2Test.sol

@@ -99,9 +99,8 @@ contract MorphoChainlinkOracleV2Test is Test {
     }
 
     function testSDaiEthOracle() public {
-        MorphoChainlinkOracleV2 oracle = new MorphoChainlinkOracleV2(
-            sDaiVault, 10 ** 18, daiEthFeed, feedZero, 18, vaultZero, 1, feedZero, feedZero, 18
-        );
+        MorphoChainlinkOracleV2 oracle =
+            new MorphoChainlinkOracleV2(sDaiVault, 1e18, daiEthFeed, feedZero, 18, vaultZero, 1, feedZero, feedZero, 18);
         (, int256 expectedPrice,,,) = daiEthFeed.latestRoundData();
         assertEq(
             oracle.price(),
@@ -111,7 +110,7 @@ contract MorphoChainlinkOracleV2Test is Test {
 
     function testSDaiUsdcOracle() public {
         MorphoChainlinkOracleV2 oracle = new MorphoChainlinkOracleV2(
-            sDaiVault, 10 ** 18, daiEthFeed, feedZero, 18, vaultZero, 1, usdcEthFeed, feedZero, 6
+            sDaiVault, 1e18, daiEthFeed, feedZero, 18, vaultZero, 1, usdcEthFeed, feedZero, 6
         );
         (, int256 baseAnswer,,,) = daiEthFeed.latestRoundData();
         (, int256 quoteAnswer,,,) = usdcEthFeed.latestRoundData();