From 9a7110da1e9714b117435bf9c7cb4783b3eb53a7 Mon Sep 17 00:00:00 2001 From: Oscar Date: Mon, 21 Aug 2023 11:16:43 -0600 Subject: [PATCH] Update misleading natspec on IPool, GenericLogic and PoolLogic --- contracts/interfaces/IPool.sol | 2 +- contracts/protocol/libraries/logic/GenericLogic.sol | 2 +- contracts/protocol/libraries/logic/PoolLogic.sol | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/contracts/interfaces/IPool.sol b/contracts/interfaces/IPool.sol index ef306e737..7cf79315e 100644 --- a/contracts/interfaces/IPool.sol +++ b/contracts/interfaces/IPool.sol @@ -471,7 +471,7 @@ interface IPool { * @return totalDebtBase The total debt of the user in the base currency used by the price feed * @return availableBorrowsBase The borrowing power left of the user in the base currency used by the price feed * @return currentLiquidationThreshold The liquidation threshold of the user - * @return ltv The loan to value of The user + * @return ltv The maximum Loan To Value of the user - weighted average of max ltv of collateral reserves * @return healthFactor The current health factor of the user */ function getUserAccountData( diff --git a/contracts/protocol/libraries/logic/GenericLogic.sol b/contracts/protocol/libraries/logic/GenericLogic.sol index b14bd7c5c..b68a5d4d7 100644 --- a/contracts/protocol/libraries/logic/GenericLogic.sol +++ b/contracts/protocol/libraries/logic/GenericLogic.sol @@ -56,7 +56,7 @@ library GenericLogic { * @param params Additional parameters needed for the calculation * @return The total collateral of the user in the base currency used by the price feed * @return The total debt of the user in the base currency used by the price feed - * @return The average ltv of the user + * @return The maximum Loan To Value of the user - weighted average of max ltv of collateral reserves * @return The average liquidation threshold of the user * @return The health factor of the user * @return True if the ltv is zero, false otherwise diff --git a/contracts/protocol/libraries/logic/PoolLogic.sol b/contracts/protocol/libraries/logic/PoolLogic.sol index 28470a59f..5b9847a45 100644 --- a/contracts/protocol/libraries/logic/PoolLogic.sol +++ b/contracts/protocol/libraries/logic/PoolLogic.sol @@ -150,7 +150,7 @@ library PoolLogic { * @return totalDebtBase The total debt of the user in the base currency used by the price feed * @return availableBorrowsBase The borrowing power left of the user in the base currency used by the price feed * @return currentLiquidationThreshold The liquidation threshold of the user - * @return ltv The loan to value of The user + * @return ltv maximum Loan To Value of the user - weighted average of max ltv of collateral reserves * @return healthFactor The current health factor of the user */ function executeGetUserAccountData(