Skip to content

Commit

Permalink
Clarify inconsistency between getReserveNormalizedVariableDebt() an…
Browse files Browse the repository at this point in the history
…d `_updateIndexes` (#754) (#768)

* Added clarification on getReserveNormalizedVariableDebt() in IPool
* Updated docs on getReserveNormalizedVariableDebt IPool
  • Loading branch information
eboadom authored Dec 19, 2022
1 parent b3abe17 commit 428e258
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions contracts/interfaces/IPool.sol
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,13 @@ interface IPool {

/**
* @notice Returns the normalized variable debt per unit of asset
* @dev WARNING: This function is intended to be used primarily by the protocol itself to get a
* "dynamic" variable index based on time, current stored index and virtual rate at the current
* moment (approx. a borrower would get if opening a position). This means that is always used in
* combination with variable debt supply/balances.
* If using this function externally, consider that is possible to have an increasing normalized
* variable debt that is not equivalent to how the variable debt index would be updated in storage
* (e.g. only updates with non-zero variable debt supply)
* @param asset The address of the underlying asset of the reserve
* @return The reserve normalized variable debt
*/
Expand Down

0 comments on commit 428e258

Please sign in to comment.