Skip to content

Commit

Permalink
Merge pull request #44 from morpho-org/fix/docs-72
Browse files Browse the repository at this point in the history
  • Loading branch information
MerlinEgalite authored Nov 14, 2023
2 parents 92cfde4 + 1ef5a56 commit e6f8bb0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/ChainlinkOracle.sol
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ contract ChainlinkOracle is IOracle {

/* CONSTRUCTOR */

/// @dev Here is the list of assumptions on the inputs 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.
/// - Decimals passed as argument are correct.
/// - The vault conversion sample is low enough to avoid overflows.
/// - The vault, if set, is ERC4626-compliant.
/// @param vault Vault. Pass address zero to omit this parameter.
/// @param baseFeed1 First base feed. Pass address zero if the price = 1.
/// @param baseFeed2 Second base feed. Pass address zero if the price = 1.
Expand Down
1 change: 1 addition & 0 deletions src/libraries/ChainlinkDataFeedLib.sol
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ 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:
/// - L2s are not supported.
/// - 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.
Expand Down

0 comments on commit e6f8bb0

Please sign in to comment.