Skip to content

Commit e6f8bb0

Browse files
Merge pull request #44 from morpho-org/fix/docs-72
2 parents 92cfde4 + 1ef5a56 commit e6f8bb0

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

src/ChainlinkOracle.sol

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ contract ChainlinkOracle is IOracle {
3535

3636
/* CONSTRUCTOR */
3737

38+
/// @dev Here is the list of assumptions on the inputs that guarantees the oracle behaves as expected:
39+
/// - Feeds are either Chainlink-compliant or the address zero.
40+
/// - Feeds have the same behavioral assumptions as Chainlink's.
41+
/// - Feeds are set in the correct order.
42+
/// - Decimals passed as argument are correct.
43+
/// - The vault conversion sample is low enough to avoid overflows.
44+
/// - The vault, if set, is ERC4626-compliant.
3845
/// @param vault Vault. Pass address zero to omit this parameter.
3946
/// @param baseFeed1 First base feed. Pass address zero if the price = 1.
4047
/// @param baseFeed2 Second base feed. Pass address zero if the price = 1.

src/libraries/ChainlinkDataFeedLib.sol

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ library ChainlinkDataFeedLib {
1313
/// @dev Performs safety checks and returns the latest price of a `feed`.
1414
/// @dev When `feed` is the address zero, returns 1.
1515
/// @dev Notes on safety checks:
16+
/// - L2s are not supported.
1617
/// - Staleness is not checked because it's assumed that the Chainlink feed keeps its promises on this.
1718
/// - The price is not checked to be in the min/max bounds because it's assumed that the Chainlink feed keeps its
1819
/// promises on this.

0 commit comments

Comments
 (0)