diff --git a/contracts/interfaces/IDelegationToken.sol b/contracts/interfaces/IDelegationToken.sol index 2a42326c..870e05bd 100644 --- a/contracts/interfaces/IDelegationToken.sol +++ b/contracts/interfaces/IDelegationToken.sol @@ -3,7 +3,7 @@ pragma solidity 0.6.12; /** * @title IDelegationToken - * @dev Implements an interface for tokens that have a delegation function + * @dev Implements an interface for tokens with delegation COMP/UNI compatible * @author Aave **/ interface IDelegationToken { diff --git a/contracts/interfaces/IScaledBalanceToken.sol b/contracts/interfaces/IScaledBalanceToken.sol index 043b5bae..f8586ce9 100644 --- a/contracts/interfaces/IScaledBalanceToken.sol +++ b/contracts/interfaces/IScaledBalanceToken.sol @@ -3,18 +3,18 @@ pragma solidity 0.6.12; interface IScaledBalanceToken { /** - * @dev Returns the principal balance of the user. The principal balance is the last - * updated stored balance, which does not consider the perpetually accruing interest. - * @param user The address of the user - * @return The principal balance of the user + * @dev Returns the scaled balance of the user. The scaled balance is the sum of all the + * updated stored balance divided by the reserve's liquidity index at the moment of the update + * @param user The user whose balance is calculated + * @return The scaled balance of the user **/ function scaledBalanceOf(address user) external view returns (uint256); /** - * @dev Returns the principal balance of the user and principal total supply. + * @dev Returns the scaled balance of the user and the scaled total supply. * @param user The address of the user - * @return The principal balance of the user - * @return The principal total supply + * @return The scaled balance of the user + * @return The scaled balance and the scaled total supply **/ function getScaledUserBalanceAndSupply(address user) external view returns (uint256, uint256); diff --git a/contracts/interfaces/IStableDebtToken.sol b/contracts/interfaces/IStableDebtToken.sol index 4a7cc4e3..b6741e92 100644 --- a/contracts/interfaces/IStableDebtToken.sol +++ b/contracts/interfaces/IStableDebtToken.sol @@ -12,7 +12,7 @@ interface IStableDebtToken { /** * @dev Emitted when new stable debt is minted * @param user The address of the user who triggered the minting - * @param onBehalfOf The recipient of aTokens + * @param onBehalfOf The recipient of stable debt tokens * @param amount The amount minted * @param currentBalance The current balance of the user * @param balanceIncrease The increase in balance since the last action of the user diff --git a/contracts/protocol/tokenization/AToken.sol b/contracts/protocol/tokenization/AToken.sol index e185cf0c..00df0b61 100644 --- a/contracts/protocol/tokenization/AToken.sol +++ b/contracts/protocol/tokenization/AToken.sol @@ -199,10 +199,10 @@ contract AToken is VersionedInitializable, IncentivizedERC20, IAToken { } /** - * @dev returns the principal balance of the user and principal total supply. - * @param user the address of the user - * @return the principal balance of the user - * @return the principal total supply + * @dev Returns the scaled balance of the user and the scaled total supply. + * @param user The address of the user + * @return The scaled balance of the user + * @return The scaled balance and the scaled total supply **/ function getScaledUserBalanceAndSupply(address user) external