fix: Update and fix contracts docs

aave · Sep 25, 2021 · 171acdf · 171acdf
1 parent 268dac1
commit 171acdf
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 9 deletions.
diff --git a/contracts/interfaces/IStableDebtToken.sol b/contracts/interfaces/IStableDebtToken.sol
@@ -60,7 +60,9 @@ interface IStableDebtToken is IInitializableDebtToken {
    * @param onBehalfOf The address receiving the debt tokens
    * @param amount The amount of debt tokens to mint
    * @param rate The rate of the debt being minted
-   * @return returns isFirstBorrow, totalStableDebt and avgStableBorrowRate
+   * @return True if it is the first borrow, false otherwise
+   * @return The total stable debt
+   * @return The average stale borrow rate
    **/
   function mint(
     address user,
@@ -81,7 +83,8 @@ interface IStableDebtToken is IInitializableDebtToken {
    * and the rate of the previous debt
    * @param user The address of the user getting his debt burned
    * @param amount The amount of debt tokens getting burned
-   * @return totalStableDebt and avgStableBorrowRate
+   * @return The total stable debt
+   * @return The average stable borrow rate
    **/
   function burn(address user, uint256 amount) external returns (uint256, uint256);
 

diff --git a/contracts/interfaces/IVariableDebtToken.sol b/contracts/interfaces/IVariableDebtToken.sol
@@ -27,7 +27,8 @@ interface IVariableDebtToken is IScaledBalanceToken, IInitializableDebtToken {
    * @param onBehalfOf The address receiving the debt tokens
    * @param amount The amount of debt being minted
    * @param index The variable debt index of the reserve
-   * @return if the the previous balance of the user is 0 and the scaled total debt of the reserve
+   * @return True if the previous balance of the user is 0, false otherwise
+   * @return The scaled total debt of the reserve
    **/
   function mint(
     address user,

diff --git a/contracts/protocol/libraries/configuration/ReserveConfiguration.sol b/contracts/protocol/libraries/configuration/ReserveConfiguration.sol
@@ -452,6 +452,7 @@ library ReserveConfiguration {
    * @return The state param representing liquidation bonus
    * @return The state param representing reserve decimals
    * @return The state param representing reserve factor
+   * @return The state param representing eMode category
    **/
   function getParams(DataTypes.ReserveConfigurationMap memory self)
     internal

diff --git a/contracts/protocol/libraries/logic/BorrowLogic.sol b/contracts/protocol/libraries/logic/BorrowLogic.sol
@@ -358,8 +358,6 @@ library BorrowLogic {
     (, reserveCache.nextTotalStableDebt, reserveCache.nextAvgStableBorrowRate) = IStableDebtToken(
       address(stableDebtToken)
     ).mint(user, user, stableDebt, reserve.currentStableBorrowRate);
-    //reserveCache.nextTotalStableDebt = nextTotalStableDebt;
-    //reserveCache.nextAvgStableBorrowRate = nextAvgStableBorrowRate;
 
     reserve.updateInterestRates(reserveCache, asset, 0, 0);
 

diff --git a/contracts/protocol/libraries/types/DataTypes.sol b/contracts/protocol/libraries/types/DataTypes.sol
@@ -34,15 +34,17 @@ library DataTypes {
     //bit 16-31: Liq. threshold
     //bit 32-47: Liq. bonus
     //bit 48-55: Decimals
-    //bit 56: Reserve is active
+    //bit 56: reserve is active
     //bit 57: reserve is frozen
     //bit 58: borrowing is enabled
     //bit 59: stable rate borrowing enabled
     //bit 60: asset is paused
     //bit 61-63: reserved
     //bit 64-79: reserve factor
-    //bit 80-115 borrow cap, borrowCap == 0 => disabled
-    //bit 116-151 supply cap, supplyCap == 0 => disabled
+    //bit 80-115: borrow cap, borrowCap == 0 => disabled
+    //bit 116-151: supply cap, supplyCap == 0 => disabled
+    //bit 152-167: liquidation protocol fee
+    //bit 168-176: eMode category
     uint256 data;
   }
 

diff --git a/contracts/protocol/pool/PoolConfigurator.sol b/contracts/protocol/pool/PoolConfigurator.sol
@@ -327,7 +327,7 @@ contract PoolConfigurator is VersionedInitializable, IPoolConfigurator {
     emit EModeAssetCategoryChanged(asset, categoryId);
   }
 
-  ///@inheritdoc IPoolConfigurator
+  /// @inheritdoc IPoolConfigurator
   function setReserveInterestRateStrategyAddress(address asset, address rateStrategyAddress)
     external
     override