Merge pull request #13 from morpho-labs/merlin-review

Review Merlin

Author: MathisGD

src/ChainlinkOracle.sol

@@ -5,10 +5,14 @@ import {IOracle} from "morpho-blue/interfaces/IOracle.sol";
 
 import {AggregatorV3Interface, ChainlinkDataFeedLib} from "./libraries/ChainlinkDataFeedLib.sol";
 
+/// @title ChainlinkOracle
+/// @author Morpho Labs
+/// @custom:contact [email protected]
+/// @notice Morpho Blue oracle using Chainlink-compliant feeds.
 contract ChainlinkOracle is IOracle {
     using ChainlinkDataFeedLib for AggregatorV3Interface;
 
-    /* CONSTANT */
+    /* IMMUTABLES */
 
     /// @notice First base feed.
     AggregatorV3Interface public immutable BASE_FEED_1;

src/libraries/ChainlinkDataFeedLib.sol

@@ -1,23 +1,31 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
-import {ErrorsLib} from "./ErrorsLib.sol";
 import {AggregatorV3Interface} from "../interfaces/AggregatorV3Interface.sol";
 
+import {ErrorsLib} from "./ErrorsLib.sol";
+
+/// @title ChainlinkDataFeedLib
+/// @author Morpho Labs
+/// @custom:contact [email protected]
+/// @notice Library exposing functions to interact with a Chainlink-compliant feed.
 library ChainlinkDataFeedLib {
-    /// @dev Performs some safety checks and returns the latest price of a feed.
+    /// @dev Performs safety checks and returns the latest price of a `feed`.
     /// @dev When `feed` is the address zero, returns 1.
     function getPrice(AggregatorV3Interface feed) internal view returns (uint256) {
         if (address(feed) == address(0)) return 1;
+
         (, int256 answer,,,) = feed.latestRoundData();
         require(answer >= 0, ErrorsLib.NEGATIVE_ANSWER);
+
         return uint256(answer);
     }
 
-    /// @dev Returns the number of decimals of a feed.
+    /// @dev Returns the number of decimals of a `feed`.
     /// @dev When `feed` is the address zero, returns 0.
     function getDecimals(AggregatorV3Interface feed) internal view returns (uint256) {
         if (address(feed) == address(0)) return 0;
+
         return feed.decimals();
     }
 }

src/libraries/ErrorsLib.sol

@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.0;
 
+/// @title ErrorsLib
+/// @author Morpho Labs
+/// @custom:contact [email protected]
+/// @notice Library exposing error messages.
 library ErrorsLib {
+    /// @notice Thrown when the answer returned by a Chainlink feed is negative.
     string constant NEGATIVE_ANSWER = "negative answer";
 }