Merge pull request #25 from morpho-labs/docs/add-safety-comments

morpho-org · Oct 16, 2023 · 9ed1932 · 9ed1932
2 parents 081af65 + efbc65e
commit 9ed1932
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/libraries/ChainlinkDataFeedLib.sol b/src/libraries/ChainlinkDataFeedLib.sol
@@ -12,6 +12,10 @@ import {ErrorsLib} from "./ErrorsLib.sol";
 library ChainlinkDataFeedLib {
     /// @dev Performs safety checks and returns the latest price of a `feed`.
     /// @dev When `feed` is the address zero, returns 1.
+    /// @dev Notes on safety checks:
+    /// - 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(AggregatorV3Interface feed) internal view returns (uint256) {
         if (address(feed) == address(0)) return 1;