refactor: improve documentation and structure

Author: aditya520

.github/workflows/foundry.yml

@@ -34,5 +34,4 @@ jobs:
         run: |
           forge test -vvv
         id: test
-        env:
-          ETH_RPC_URL: ${{ secrets.ETH_RPC_URL }}
+

src/morpho-pyth/MorphoPythOracle.sol

@@ -15,7 +15,9 @@ import "@pythnetwork/pyth-sdk-solidity/IPyth.sol";
 /// @notice Morpho Blue oracle using Pyth Price Feeds.
 contract MorphoPythOracle is IMorphoPythOracle {
     using Math for uint256;
+
     IPyth public immutable pyth;
+
     using VaultLib for IERC4626;
 
     /* IMMUTABLES */
@@ -73,18 +75,11 @@ contract MorphoPythOracle is IMorphoPythOracle {
             PythErrorsLib.VAULT_CONVERSION_SAMPLE_IS_NOT_ONE
         );
         require(
-            address(quoteVault) != address(0) ||
-                quoteVaultConversionSample == 1,
+            address(quoteVault) != address(0) || quoteVaultConversionSample == 1,
             PythErrorsLib.VAULT_CONVERSION_SAMPLE_IS_NOT_ONE
         );
-        require(
-            baseVaultConversionSample != 0,
-            PythErrorsLib.VAULT_CONVERSION_SAMPLE_IS_ZERO
-        );
-        require(
-            quoteVaultConversionSample != 0,
-            PythErrorsLib.VAULT_CONVERSION_SAMPLE_IS_ZERO
-        );
+        require(baseVaultConversionSample != 0, PythErrorsLib.VAULT_CONVERSION_SAMPLE_IS_ZERO);
+        require(quoteVaultConversionSample != 0, PythErrorsLib.VAULT_CONVERSION_SAMPLE_IS_ZERO);
         BASE_VAULT = baseVault;
         BASE_VAULT_CONVERSION_SAMPLE = baseVaultConversionSample;
         QUOTE_VAULT = quoteVault;
@@ -95,17 +90,14 @@ contract MorphoPythOracle is IMorphoPythOracle {
         QUOTE_FEED_2 = quoteFeed2;
 
         pyth = IPyth(pyth_);
-        SCALE_FACTOR =
-            (10 **
-                (36 +
-                    quoteTokenDecimals +
-                    PythFeedLib.getDecimals(pyth, QUOTE_FEED_1) +
-                    PythFeedLib.getDecimals(pyth, QUOTE_FEED_2) -
-                    baseTokenDecimals -
-                    PythFeedLib.getDecimals(pyth, BASE_FEED_1) -
-                    PythFeedLib.getDecimals(pyth, BASE_FEED_2)) *
-                quoteVaultConversionSample) /
-            baseVaultConversionSample;
+        SCALE_FACTOR = (
+            10
+                ** (
+                    36 + quoteTokenDecimals + PythFeedLib.getDecimals(pyth, QUOTE_FEED_1)
+                        + PythFeedLib.getDecimals(pyth, QUOTE_FEED_2) - baseTokenDecimals
+                        - PythFeedLib.getDecimals(pyth, BASE_FEED_1) - PythFeedLib.getDecimals(pyth, BASE_FEED_2)
+                ) * quoteVaultConversionSample
+        ) / baseVaultConversionSample;
 
         PRICE_FEED_MAX_AGE = priceFeedMaxAge;
     }
@@ -114,22 +106,13 @@ contract MorphoPythOracle is IMorphoPythOracle {
 
     /// @inheritdoc IOracle
     function price() external view returns (uint256) {
-        return
-            SCALE_FACTOR.mulDiv(
-                BASE_VAULT.getAssets(BASE_VAULT_CONVERSION_SAMPLE) *
-                    PythFeedLib.getPrice(
-                        pyth,
-                        BASE_FEED_1,
-                        PRICE_FEED_MAX_AGE
-                    ) *
-                    PythFeedLib.getPrice(pyth, BASE_FEED_2, PRICE_FEED_MAX_AGE),
-                QUOTE_VAULT.getAssets(QUOTE_VAULT_CONVERSION_SAMPLE) *
-                    PythFeedLib.getPrice(
-                        pyth,
-                        QUOTE_FEED_1,
-                        PRICE_FEED_MAX_AGE
-                    ) *
-                    PythFeedLib.getPrice(pyth, QUOTE_FEED_2, PRICE_FEED_MAX_AGE)
-            );
+        return SCALE_FACTOR.mulDiv(
+            BASE_VAULT.getAssets(BASE_VAULT_CONVERSION_SAMPLE)
+                * PythFeedLib.getPrice(pyth, BASE_FEED_1, PRICE_FEED_MAX_AGE)
+                * PythFeedLib.getPrice(pyth, BASE_FEED_2, PRICE_FEED_MAX_AGE),
+            QUOTE_VAULT.getAssets(QUOTE_VAULT_CONVERSION_SAMPLE)
+                * PythFeedLib.getPrice(pyth, QUOTE_FEED_1, PRICE_FEED_MAX_AGE)
+                * PythFeedLib.getPrice(pyth, QUOTE_FEED_2, PRICE_FEED_MAX_AGE)
+        );
     }
 }

src/morpho-pyth/interfaces/IMorphoPythOracleFactory.sol

@@ -29,15 +29,19 @@ interface IMorphoPythOracleFactory {
     /// @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
     /// assets has enough precision.
-    /// @param baseFeed1 First base feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds instead of passing 1.
-    /// @param baseFeed2 Second base feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds instead of passing 1.
+    /// @param baseFeed1 First base feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds instead
+    /// of passing 1.
+    /// @param baseFeed2 Second base feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds instead
+    /// of passing 1.
     /// @param baseTokenDecimals Base token decimals.
     /// @param quoteVault Quote vault. Pass address zero to omit this parameter.
     /// @param quoteVaultConversionSample The sample amount of quote vault shares used to convert to underlying.
     /// Pass 1 if the quote asset is not a vault. Should be chosen such that converting `quoteVaultConversionSample` to
     /// assets has enough precision.
-    /// @param quoteFeed1 First quote feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds instead of passing 1.
-    /// @param quoteFeed2 Second quote feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds instead of passing 1.
+    /// @param quoteFeed1 First quote feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds
+    /// instead of passing 1.
+    /// @param quoteFeed2 Second quote feed. Pass bytes32(0) if the price = 1. We recommend using stablecoin feeds
+    /// instead of passing 1.
     /// @param quoteTokenDecimals Quote token decimals.
     /// @param priceFeedMaxAge The maximum age in secondsfor the oracles prices to be considered valid.
     /// @param salt The salt to use for the CREATE2.

src/morpho-pyth/libraries/PythFeedLib.sol

@@ -7,6 +7,7 @@ import {PythErrorsLib} from "./PythErrorsLib.sol";
 /// @title PythFeedLib
 /// @author Pyth Data Association
 /// @notice Library exposing functions to interact with a Pyth feed.
+
 library PythFeedLib {
     /// @dev Returns the price of a `priceId`.
     /// @dev When `priceId` is the address zero, returns 1.
@@ -20,6 +21,7 @@ library PythFeedLib {
     }
     /// @dev Returns the number of decimals of a `priceId`.
     /// @dev When `priceId` is the address zero, returns 0.
+
     function getDecimals(IPyth pyth, bytes32 priceId) internal view returns (uint256) {
         if (priceId == bytes32(0)) return 0;
 

test/MorphoPythOracleTest.sol

@@ -1,4 +1,5 @@
 pragma solidity ^0.8.0;
+
 import "../lib/forge-std/src/Test.sol";
 import "@pythnetwork/pyth-sdk-solidity/MockPyth.sol";
 import "../src/morpho-pyth/MorphoPythOracle.sol";
@@ -77,14 +78,14 @@ contract MorphoPythOracleTest is Test {
         );
         assertEq(
             oracle.price(),
-            ((uint256(int256(mockPyth.getPriceUnsafe(pythWbtcUsdFeed).price))) *
-                10 **
-                    (36 +
-                        pythUsdtUsdTokenDecimals +
-                        uint256(-1 * int256(-6)) -
-                        pythWbtcUsdTokenDecimals -
-                        uint256(-1 * int256(-8)))) /
-                uint256(int256(mockPyth.getPriceUnsafe(pythUsdtUsdFeed).price))
+            (
+                (uint256(int256(mockPyth.getPriceUnsafe(pythWbtcUsdFeed).price)))
+                    * 10
+                        ** (
+                            36 + pythUsdtUsdTokenDecimals + uint256(-1 * int256(-6)) - pythWbtcUsdTokenDecimals
+                                - uint256(-1 * int256(-8))
+                        )
+            ) / uint256(int256(mockPyth.getPriceUnsafe(pythUsdtUsdFeed).price))
         );
     }
 }

test/helpers/Constants.sol

@@ -19,4 +19,4 @@ uint256 constant pythUsdtUsdTokenDecimals = 6;
 bytes32 constant pythCbethUsdFeed = 0x15ecddd26d49e1a8f1de9376ebebc03916ede873447c1255d2d5891b92ce5717;
 // Time constants
 uint256 constant oneHour = 3600;
-uint256 constant oneMinute = 60;
+uint256 constant oneMinute = 60;