Skip to content

Commit

Permalink
docs: better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sakulstra committed Aug 8, 2024
1 parent 5f9c5a9 commit d973faf
Showing 1 changed file with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,12 @@ interface IStaticATokenLM is IInitializableStaticATokenLM, IERC4626 {

/**
* @notice Returns the current asset price of the stataToken.
* The price is calculated as `underlying_price * exchangeRate`, but it's important to note that `underlying_price` is the price obtained by the aave-oracle, which means it's subject to caps and similar imposed by the aave DAO on the oracle.
* @return price the current asset price priced at in the same manner as the aave oracle prices the underlying.
* The price is calculated as `underlying_price * exchangeRate`.
* It is important to note that:
* - `underlying_price` is the price obtained by the aave-oracle and is subject to it's internal pricing mechanisms.
* - as the price is scaled over the excahngeRate, but maintains the same precision as the underlying the price might be underestimated by 1 unit.
* - when pricing multiple `shares` as `shares * price` keep in mind that the error compounds.
* @return price the current asset price.
*/
function latestAnswer() external view returns (int256);
}

0 comments on commit d973faf

Please sign in to comment.