Skip to content

Commit

Permalink
docs: minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
MathisGD committed Oct 16, 2023
1 parent 896ee33 commit 4084d69
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/ChainlinkOracle.sol
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ contract ChainlinkOracle is IOracle {
// The vault parameter is used for ERC4626 tokens, to price its shares.
// It is used to price `VAULT_CONVERSION_SAMPLE` of the vault shares, so it requires dividing by that number,
// hence the division by `VAULT_CONVERSION_SAMPLE` in the `SCALE_FACTOR` definition.
// Verify that vault = 0 => vaultConversionSample = 1.
// Verify that vault = address(0) => vaultConversionSample = 1.
require(
address(vault) != address(0) || vaultConversionSample == 1, ErrorsLib.VAULT_CONVERSION_SAMPLE_IS_NOT_ONE
);
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/ErrorsLib.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ library ErrorsLib {
/// @notice Thrown when the answer returned by a Chainlink feed is negative.
string constant NEGATIVE_ANSWER = "negative answer";

/// @notice Thrown when the vault conversion sample is not 1 while vault = 0.
/// @notice Thrown when the vault conversion sample is not 1 while vault = address(0).
string constant VAULT_CONVERSION_SAMPLE_IS_NOT_ONE = "vault conversion sample is not one";
}

0 comments on commit 4084d69

Please sign in to comment.