File tree Expand file tree Collapse file tree 2 files changed +8
-0
lines changed Expand file tree Collapse file tree 2 files changed +8
-0
lines changed Original file line number Diff line number Diff line change @@ -35,6 +35,13 @@ contract ChainlinkOracle is IOracle {
35
35
36
36
/* CONSTRUCTOR */
37
37
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.
38
45
/// @param vault Vault. Pass address zero to omit this parameter.
39
46
/// @param baseFeed1 First base feed. Pass address zero if the price = 1.
40
47
/// @param baseFeed2 Second base feed. Pass address zero if the price = 1.
Original file line number Diff line number Diff line change @@ -13,6 +13,7 @@ library ChainlinkDataFeedLib {
13
13
/// @dev Performs safety checks and returns the latest price of a `feed`.
14
14
/// @dev When `feed` is the address zero, returns 1.
15
15
/// @dev Notes on safety checks:
16
+ /// - L2s are not supported.
16
17
/// - Staleness is not checked because it's assumed that the Chainlink feed keeps its promises on this.
17
18
/// - The price is not checked to be in the min/max bounds because it's assumed that the Chainlink feed keeps its
18
19
/// promises on this.
You can’t perform that action at this time.
0 commit comments