Skip to content

Commit c251bed

Browse files
docs: apply suggestions
Co-authored-by: MathisGD <74971347+MathisGD@users.noreply.github.com> Signed-off-by: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com>
1 parent 7d8d321 commit c251bed

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

src/wsteth-exchange-rate-adapter/WstEthStEthExchangeRateChainlinkAdapter.sol

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ contract WstEthStEthExchangeRateChainlinkAdapter is MinimalAggregatorV3Interface
1616
/// @notice The description of the price feed.
1717
string public constant description = "wstETH/stETH exchange rate";
1818

19-
/// @notice The address of stETH on Mainnet.
19+
/// @notice The address of stETH on Ethereum.
2020
IStEth public constant ST_ETH = IStEth(0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84);
2121

2222
/// @inheritdoc MinimalAggregatorV3Interface
23+
/// @dev Returns zero for roundId, startedAt, updatedAt and answeredInRound.
2324
/// @dev Silently overflows if `getPooledEthByShares`'s return value is greater than `type(int256).max`.
2425
function latestRoundData() external view returns (uint80, int256, uint256, uint256, uint80) {
2526
// It is assumed that `getPooledEthByShares` returns a price with 18 decimals precision.

src/wsteth-exchange-rate-adapter/interfaces/MinimalAggregatorV3Interface.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ pragma solidity >=0.5.0;
55
/// https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/shared/interfaces/AggregatorV3Interface.sol
66
/// @dev This is the minimal feed interface required by `MorphoChainlinkOracleV2`.
77
interface MinimalAggregatorV3Interface {
8-
/// @notice Returns the number of decimals precision.
8+
/// @notice Returns the precision of the feed.
99
function decimals() external view returns (uint8);
1010

1111
/// @notice Returns Chainlink's `latestRoundData` return values.

0 commit comments

Comments
 (0)