Skip to content

Commit 4dece3c

Browse files
committed
docs(constructor): update assumptions
1 parent ba70974 commit 4dece3c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/ChainlinkOracle.sol

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,13 @@ contract ChainlinkOracle is IOracle {
3737

3838
/* CONSTRUCTOR */
3939

40-
/// @dev Here is the list of assumptions on the inputs that guarantees the oracle behaves as expected:
40+
/// @dev Here is the list of assumptions that guarantees the oracle behaves as expected:
4141
/// - Feeds are either Chainlink-compliant or the address zero.
4242
/// - Feeds have the same behavioral assumptions as Chainlink's.
4343
/// - Feeds are set in the correct order.
4444
/// - Decimals passed as argument are correct.
45-
/// - The vault conversion sample is low enough to avoid overflows.
45+
/// - The vault's sample assets and the base feed prices don't overflow when multiplied.
46+
/// - The quote feed prices don't overflow when multiplied.
4647
/// - The vault, if set, is ERC4626-compliant.
4748
/// @param vault Vault. Pass address zero to omit this parameter.
4849
/// @param baseFeed1 First base feed. Pass address zero if the price = 1.

0 commit comments

Comments
 (0)