fix: resolve conflicts

sakulstra · sakulstra · commit 3804d347f674 · 2025-05-14T13:56:38.000+02:00
diff --git a/docs/3.4/Aave-v3.4-features.md b/docs/3.4/Aave-v3.4-features.md
diff --git a/snapshots/Pool.Setters.json b/snapshots/Pool.Setters.json
@@ -3,8 +3,8 @@
   "setUserEMode: leave eMode, 1 borrow, 1 supply": "107668",
   "setUserEModeOnBehalfOf: enter eMode, 1 borrow, 1 supply": "137852",
   "setUserEModeOnBehalfOf: leave eMode, 1 borrow, 1 supply": "110490",
-  "setUserUseReserveAsCollateral: disableCollateral, 1 supply": "59218",
-  "setUserUseReserveAsCollateral: enableCollateral, 1 supply": "80737",
+  "setUserUseReserveAsCollateral: disableCollateral, 1 supply": "59174",
+  "setUserUseReserveAsCollateral: enableCollateral, 1 supply": "80693",
   "setUserUseReserveAsCollateralOnBehalfOf: disableCollateral, 1 supply": "61964",
   "setUserUseReserveAsCollateralOnBehalfOf: enableCollateral, 1 supply": "83483"
 }
diff --git a/src/contracts/helpers/AaveProtocolDataProvider.sol b/src/contracts/helpers/AaveProtocolDataProvider.sol
@@ -41,6 +41,9 @@ contract AaveProtocolDataProvider is IPoolDataProvider {
     address pool = addressesProvider.getPool();
     require(pool != address(0), Errors.ZeroAddressNotValid());
 
+    // @dev The pool can be immutable, because in practice it never changes after initialization.
+    // The reason why it is not an actual `immutable` on `ADDRESSES_PROVIDER` is that there is a cross reference between ADDRESSES_PROVIDER <> Pool,
+    // which in turn makes is complicated to have it `immutable` on both contracts.
     POOL = IPool(pool);
   }
 
@@ -157,7 +160,7 @@ contract AaveProtocolDataProvider is IPoolDataProvider {
     view
     override
     returns (
-      uint256,
+      uint256 /* unbacked */,
       uint256 accruedToTreasuryScaled,
       uint256 totalAToken,
       uint256,
@@ -175,7 +178,7 @@ contract AaveProtocolDataProvider is IPoolDataProvider {
 
     // @notice all stable debt related parameters deprecated in v3.2.0
     return (
-      0,
+      0, // @dev unbacked is deprecated from v3.4.0, always zero, never used
       reserve.accruedToTreasury,
       IERC20Detailed(reserve.aTokenAddress).totalSupply(),
       0,
diff --git a/src/contracts/helpers/WrappedTokenGatewayV3.sol b/src/contracts/helpers/WrappedTokenGatewayV3.sol
@@ -57,7 +57,7 @@ contract WrappedTokenGatewayV3 is IWrappedTokenGatewayV3, Ownable {
     uint256 userBalance = aWETH.balanceOf(msg.sender);
     uint256 amountToWithdraw = amount;
 
-    // if amount is equal to uint(-1), the user wants to redeem everything
+    // if amount is equal to type(uint256).max, the user wants to redeem everything
     if (amount == type(uint256).max) {
       amountToWithdraw = userBalance;
     }
diff --git a/src/contracts/instances/ATokenInstance.sol b/src/contracts/instances/ATokenInstance.sol
@@ -10,6 +10,11 @@ import {VersionedInitializable} from '../misc/aave-upgradeability/VersionedIniti
 
 import {AToken} from '../protocol/tokenization/AToken.sol';
 
+/**
+ * @title Aave ERC20 AToken Instance
+ * @author BGD Labs
+ * @notice Instance of the interest bearing token for the Aave protocol
+ */
 contract ATokenInstance is AToken {
   uint256 public constant ATOKEN_REVISION = 3;
 
diff --git a/src/contracts/instances/ATokenWithDelegationInstance.sol b/src/contracts/instances/ATokenWithDelegationInstance.sol
@@ -10,6 +10,11 @@ import {VersionedInitializable} from '../misc/aave-upgradeability/VersionedIniti
 
 import {ATokenWithDelegation} from '../protocol/tokenization/ATokenWithDelegation.sol';
 
+/**
+ * @title Aave ERC20 ATokenWithDelegation Instance
+ * @author BGD Labs
+ * @notice Instance of the interest bearing token for the Aave protocol with additional delegation functionality used on aAAVE(mainnet)
+ */
 contract ATokenWithDelegationInstance is ATokenWithDelegation {
   uint256 public constant ATOKEN_REVISION = 3;
 
diff --git a/src/contracts/instances/L2PoolInstance.sol b/src/contracts/instances/L2PoolInstance.sol
@@ -6,6 +6,11 @@ import {IPoolAddressesProvider} from '../interfaces/IPoolAddressesProvider.sol';
 import {IReserveInterestRateStrategy} from '../interfaces/IReserveInterestRateStrategy.sol';
 import {PoolInstance} from './PoolInstance.sol';
 
+/**
+ * @title Aave L2Pool Instance
+ * @author BGD Labs
+ * @notice Instance of the L2Pool for the Aave protocol, intended to be used on rollups
+ */
 contract L2PoolInstance is L2Pool, PoolInstance {
   constructor(
     IPoolAddressesProvider provider,
diff --git a/src/contracts/instances/PoolConfiguratorInstance.sol b/src/contracts/instances/PoolConfiguratorInstance.sol
@@ -3,6 +3,11 @@ pragma solidity ^0.8.0;
 
 import {PoolConfigurator, IPoolAddressesProvider, IPool, VersionedInitializable} from '../protocol/pool/PoolConfigurator.sol';
 
+/**
+ * @title Aave PoolConfigurator Instance
+ * @author BGD Labs
+ * @notice Instance of the PoolConfigurator of the Aave protocol
+ */
 contract PoolConfiguratorInstance is PoolConfigurator {
   uint256 public constant CONFIGURATOR_REVISION = 6;
 
diff --git a/src/contracts/instances/PoolInstance.sol b/src/contracts/instances/PoolInstance.sol
@@ -6,6 +6,11 @@ import {IPoolAddressesProvider} from '../interfaces/IPoolAddressesProvider.sol';
 import {IReserveInterestRateStrategy} from '../interfaces/IReserveInterestRateStrategy.sol';
 import {Errors} from '../protocol/libraries/helpers/Errors.sol';
 
+/**
+ * @title Aave Pool Instance
+ * @author BGD Labs
+ * @notice Instance of the Pool for the Aave protocol
+ */
 contract PoolInstance is Pool {
   uint256 public constant POOL_REVISION = 8;
 
diff --git a/src/contracts/instances/VariableDebtTokenInstance.sol b/src/contracts/instances/VariableDebtTokenInstance.sol
@@ -1,8 +1,14 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity ^0.8.0;
 
-import {VariableDebtToken, IPool, IInitializableDebtToken, VersionedInitializable, IAaveIncentivesController, Errors} from '../protocol/tokenization/VariableDebtToken.sol';
-
+import {VersionedInitializable} from '../misc/aave-upgradeability/VersionedInitializable.sol';
+import {VariableDebtToken, IPool, IInitializableDebtToken, Errors} from '../protocol/tokenization/VariableDebtToken.sol';
+
+/**
+ * @title Aave ERC20 VariableDebtToken Instance
+ * @author BGD Labs
+ * @notice Instance of the variable debt token for the Aave protocol
+ */
 contract VariableDebtTokenInstance is VariableDebtToken {
   uint256 public constant DEBT_TOKEN_REVISION = 3;
 
diff --git a/src/contracts/interfaces/IAToken.sol b/src/contracts/interfaces/IAToken.sol
@@ -11,6 +11,15 @@ import {IInitializableAToken} from './IInitializableAToken.sol';
  * @notice Defines the basic interface for an AToken.
  */
 interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
+  /**
+   * @dev Emitted during the transfer action
+   * @param from The user whose tokens are being transferred
+   * @param to The recipient
+   * @param value The scaled amount being transferred
+   * @param index The next liquidity index of the reserve
+   */
+  event BalanceTransfer(address indexed from, address indexed to, uint256 value, uint256 index);
+
   /**
    * @notice Mints `amount` aTokens to `user`
    * @param caller The address performing the mint
diff --git a/src/contracts/interfaces/IPool.sol b/src/contracts/interfaces/IPool.sol
@@ -741,8 +741,7 @@ interface IPool {
   function deposit(address asset, uint256 amount, address onBehalfOf, uint16 referralCode) external;
 
   /**
-   * @notice It covers the deficit of a specified reserve by burning:
-   * - the equivalent aToken `amount` for assets
+   * @notice It covers the deficit of a specified reserve by burning the equivalent aToken `amount` for assets
    * @dev The deficit of a reserve can occur due to situations where borrowed assets are not repaid, leading to bad debt.
    * @param asset The address of the underlying asset to cover the deficit.
    * @param amount The amount to be covered, in aToken
@@ -751,7 +750,8 @@ interface IPool {
 
   /**
    * @notice Approves or disapproves a position manager. This position manager will be able
-   * to call the setUserUseReserveAsCollateral and the the setUserEMode function on behalf of the user.
+   * to call the `setUserUseReserveAsCollateralOnBehalfOf` and the
+   * `setUserEModeOnBehalfOf` function on behalf of the user.
    * @param positionManager The address of the position manager
    * @param approve True if the position manager should be approved, false otherwise
    */
@@ -783,7 +783,7 @@ interface IPool {
   function setUserEModeOnBehalfOf(uint8 categoryId, address onBehalfOf) external;
 
   /*
-   * @notice Returns true if the user is approved to use the position manager on behalf of the user.
+   * @notice Returns true if the `positionManager` address is approved to use the position manager role on behalf of the user.
    * @param user The address of the user
    * @param positionManager The address of the position manager
    * @return True if the user is approved to use the position manager, false otherwise
diff --git a/src/contracts/interfaces/IPoolDataProvider.sol b/src/contracts/interfaces/IPoolDataProvider.sol
@@ -107,7 +107,7 @@ interface IPoolDataProvider {
   /**
    * @notice Returns the unbacked mint cap of the reserve
    * @param asset The address of the underlying asset of the reserve
-   * @return The unbacked mint cap of the reserve
+   * @return 0, DEPRECATED in v3.4.0
    */
   function getUnbackedMintCap(address asset) external view returns (uint256);
 
@@ -244,7 +244,7 @@ interface IPoolDataProvider {
   /**
    * @notice Returns whether virtual accounting is enabled/not for a reserve
    * @param asset The address of the underlying asset of the reserve
-   * @return True, DEPRECATED in v3.4.0 as all reserves are active
+   * @return True, DEPRECATED in v3.4.0 as all reserves have virtual accounting set as active
    */
   function getIsVirtualAccActive(address asset) external view returns (bool);
 
diff --git a/src/contracts/interfaces/IScaledBalanceToken.sol b/src/contracts/interfaces/IScaledBalanceToken.sol
@@ -7,15 +7,6 @@ pragma solidity ^0.8.0;
  * @notice Defines the basic interface for a scaled-balance token.
  */
 interface IScaledBalanceToken {
-  /**
-   * @dev Emitted during the transfer action
-   * @param from The user whose tokens are being transferred
-   * @param to The recipient
-   * @param value The scaled amount being transferred
-   * @param index The next liquidity index of the reserve
-   */
-  event BalanceTransfer(address indexed from, address indexed to, uint256 value, uint256 index);
-
   /**
    * @dev Emitted after the mint action
    * @param caller The address performing the mint
diff --git a/src/contracts/interfaces/IVariableDebtToken.sol b/src/contracts/interfaces/IVariableDebtToken.sol
@@ -33,7 +33,7 @@ interface IVariableDebtToken is IScaledBalanceToken, IInitializableDebtToken {
    * @param from The address from which the debt will be burned
    * @param amount The amount getting burned
    * @param index The variable debt index of the reserve
-   * @return True if balance is zero
+   * @return True if the new balance is zero
    * @return The scaled total debt of the reserve
    */
   function burn(address from, uint256 amount, uint256 index) external returns (bool, uint256);
diff --git a/src/contracts/protocol/libraries/configuration/ReserveConfiguration.sol b/src/contracts/protocol/libraries/configuration/ReserveConfiguration.sol
@@ -469,7 +469,7 @@ library ReserveConfiguration {
   }
 
   /**
-   * @notice Sets the virtual account active state of the reserve
+   * @notice Forcefully set the virtual account active state of the reserve to `true`
    * @dev DEPRECATED: in v3.4 all reserves have virtual accounting enabled.
    * The flag is carried along for backward compatibility with integrations directly querying the configuration.
    * @param self The reserve configuration
diff --git a/src/contracts/protocol/libraries/helpers/Errors.sol b/src/contracts/protocol/libraries/helpers/Errors.sol
@@ -95,5 +95,5 @@ library Errors {
   error MustNotLeaveDust(); // Below a certain threshold liquidators need to take the full position
   error UserCannotHaveDebt(); // Thrown when a user tries to interact with a method that requires a position without debt
   error SelfLiquidation(); // Thrown when a user tries to liquidate themselves
-  error CallerNotPositionManager(); // Thrown when a user tries to interact with a method that is allowed only for position managers
+  error CallerNotPositionManager(); // Thrown when the caller has not been enabled as a position manager of the on-behalf-of user
 }
diff --git a/src/contracts/protocol/libraries/logic/BorrowLogic.sol b/src/contracts/protocol/libraries/logic/BorrowLogic.sol
@@ -115,14 +115,14 @@ library BorrowLogic {
    * @dev  Emits the `Repay()` event
    * @param reservesData The state of all the reserves
    * @param reservesList The addresses of all the active reserves
-   * @param userConfig The user configuration mapping that tracks the supplied/borrowed assets
+   * @param onBehalfOfConfig The user configuration mapping that tracks the supplied/borrowed assets
    * @param params The additional parameters needed to execute the repay function
    * @return The actual amount being repaid
    */
   function executeRepay(
     mapping(address => DataTypes.ReserveData) storage reservesData,
     mapping(uint256 => address) storage reservesList,
-    DataTypes.UserConfigurationMap storage userConfig,
+    DataTypes.UserConfigurationMap storage onBehalfOfConfig,
     DataTypes.ExecuteRepayParams memory params
   ) external returns (uint256) {
     DataTypes.ReserveData storage reserve = reservesData[params.asset];
@@ -167,13 +167,13 @@ library BorrowLogic {
     );
 
     if (noMoreDebt) {
-      userConfig.setBorrowing(reserve.id, false);
+      onBehalfOfConfig.setBorrowing(reserve.id, false);
     }
 
     IsolationModeLogic.reduceIsolatedDebtIfIsolated(
       reservesData,
       reservesList,
-      userConfig,
+      onBehalfOfConfig,
       reserveCache,
       paybackAmount
     );
@@ -186,9 +186,9 @@ library BorrowLogic {
         paybackAmount,
         reserveCache.nextLiquidityIndex
       );
-      bool isCollateral = userConfig.isUsingAsCollateral(reserve.id);
+      bool isCollateral = onBehalfOfConfig.isUsingAsCollateral(reserve.id);
       if (isCollateral && IAToken(reserveCache.aTokenAddress).scaledBalanceOf(params.user) == 0) {
-        userConfig.setUsingAsCollateral(reserve.id, params.asset, params.user, false);
+        onBehalfOfConfig.setUsingAsCollateral(reserve.id, params.asset, params.user, false);
       }
     } else {
       IERC20(params.asset).safeTransferFrom(params.user, reserveCache.aTokenAddress, paybackAmount);
diff --git a/src/contracts/protocol/libraries/logic/LiquidationLogic.sol b/src/contracts/protocol/libraries/logic/LiquidationLogic.sol
@@ -20,10 +20,6 @@ import {IPriceOracleGetter} from '../../../interfaces/IPriceOracleGetter.sol';
 import {SafeCast} from 'openzeppelin-contracts/contracts/utils/math/SafeCast.sol';
 import {Errors} from '../helpers/Errors.sol';
 
-interface IGhoVariableDebtToken {
-  function getBalanceFromInterest(address user) external view returns (uint256);
-}
-
 /**
  * @title LiquidationLogic library
  * @author Aave
@@ -68,8 +64,7 @@ library LiquidationLogic {
   uint256 public constant MIN_LEFTOVER_BASE = MIN_BASE_MAX_CLOSE_FACTOR_THRESHOLD / 2;
 
   /**
-   * @notice Reduces a portion or all of the deficit of a specified reserve by burning:
-   * - the equivalent aToken `amount`
+   * @notice Reduces a portion or all of the deficit of a specified reserve by burning the equivalent aToken `amount`
    * The caller of this method MUST always be the Umbrella contract and the Umbrella contract is assumed to never have debt.
    * @dev Emits the `DeficitCovered() event`.
    * @dev If the coverage admin covers its entire balance, `ReserveUsedAsCollateralDisabled()` is emitted.
diff --git a/src/contracts/protocol/libraries/logic/PoolLogic.sol b/src/contracts/protocol/libraries/logic/PoolLogic.sol
@@ -70,25 +70,24 @@ library PoolLogic {
   }
 
   /**
-   * @notice Accumulates interest to all indexes of the reserve
+   * @notice Updates interest rates on the reserve data
    * @param reserve The state of the reserve
    * @param asset The address of the asset
-   * @param interestRate The address of the interest rate
+   * @param interestRateStrategyAddress The address of the interest rate
    */
   function executeSyncRatesState(
     DataTypes.ReserveData storage reserve,
     address asset,
-    address interestRate
+    address interestRateStrategyAddress
   ) external {
     DataTypes.ReserveCache memory reserveCache = reserve.cache();
 
-    ReserveLogic.updateInterestRatesAndVirtualBalance(
-      reserve,
+    reserve.updateInterestRatesAndVirtualBalance(
       reserveCache,
       asset,
       0,
       0,
-      interestRate
+      interestRateStrategyAddress
     );
   }
 
diff --git a/src/contracts/protocol/libraries/logic/ValidationLogic.sol b/src/contracts/protocol/libraries/logic/ValidationLogic.sol
@@ -259,8 +259,8 @@ library ValidationLogic {
    * @notice Validates a repay action.
    * @param user The user initiating the repayment
    * @param reserveCache The cached data of the reserve
-   * @param amountSent The amount sent for the repayment. Can be an actual value or uint(-1)
-   * @param onBehalfOf The address of the user the sender is repaying for
+   * @param amountSent The amount sent for the repayment. Can be an actual value or type(uint256).max
+   * @param onBehalfOf The address of the user sender is repaying for
    * @param debt The borrow balance of the user
    */
   function validateRepay(
@@ -349,13 +349,13 @@ library ValidationLogic {
 
   /**
    * @notice Validates the liquidation action.
-   * @param userConfig The user configuration mapping
+   * @param borrowerConfig The user configuration mapping
    * @param collateralReserve The reserve data of the collateral
    * @param debtReserve The reserve data of the debt
    * @param params Additional parameters needed for the validation
    */
   function validateLiquidationCall(
-    DataTypes.UserConfigurationMap storage userConfig,
+    DataTypes.UserConfigurationMap storage borrowerConfig,
     DataTypes.ReserveData storage collateralReserve,
     DataTypes.ReserveData storage debtReserve,
     DataTypes.ValidateLiquidationCallParams memory params
@@ -396,7 +396,7 @@ library ValidationLogic {
 
     vars.isCollateralEnabled =
       collateralReserve.configuration.getLiquidationThreshold() != 0 &&
-      userConfig.isUsingAsCollateral(collateralReserve.id);
+      borrowerConfig.isUsingAsCollateral(collateralReserve.id);
 
     //if collateral isn't enabled as collateral by user, it cannot be liquidated
     require(vars.isCollateralEnabled, Errors.CollateralCannotBeLiquidated());
diff --git a/src/contracts/protocol/libraries/types/DataTypes.sol b/src/contracts/protocol/libraries/types/DataTypes.sol
@@ -65,7 +65,7 @@ library DataTypes {
     address __deprecatedStableDebtTokenAddress;
     //variableDebtToken address
     address variableDebtTokenAddress;
-    // DEPRECATED on v3.4.0
+    // DEPRECATED on v3.4.0, should use the `RESERVE_INTEREST_RATE_STRATEGY` variable from the Pool contract
     address __deprecatedInterestRateStrategyAddress;
     //the current treasury balance, scaled
     uint128 accruedToTreasury;
@@ -98,7 +98,7 @@ library DataTypes {
     //bit 168-175: DEPRECATED: eMode category
     //bit 176-211: DEPRECATED: unbacked mint cap
     //bit 212-251: debt ceiling for isolation mode with (ReserveConfiguration::DEBT_CEILING_DECIMALS) decimals
-    //bit 252: virtual accounting is enabled for the reserve
+    //bit 252: DEPRECATED: virtual accounting is enabled for the reserve
     //bit 253-255 unused
 
     uint256 data;
diff --git a/src/contracts/protocol/pool/Pool.sol b/src/contracts/protocol/pool/Pool.sol
diff --git a/src/contracts/protocol/tokenization/AToken.sol b/src/contracts/protocol/tokenization/AToken.sol
diff --git a/src/contracts/protocol/tokenization/ATokenWithDelegation.sol b/src/contracts/protocol/tokenization/ATokenWithDelegation.sol
diff --git a/src/contracts/protocol/tokenization/VariableDebtToken.sol b/src/contracts/protocol/tokenization/VariableDebtToken.sol
diff --git a/src/contracts/protocol/tokenization/delegation/BaseDelegation.sol b/src/contracts/protocol/tokenization/delegation/BaseDelegation.sol
diff --git a/tests/protocol/tokenization/ATokenTransfers.t.sol b/tests/protocol/tokenization/ATokenTransfers.t.sol

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ contract WrappedTokenGatewayV3 is IWrappedTokenGatewayV3, Ownable {`
`57`	`57`	`uint256 userBalance = aWETH.balanceOf(msg.sender);`
`58`	`58`	`uint256 amountToWithdraw = amount;`
`59`	`59`
`60`		`- // if amount is equal to uint(-1), the user wants to redeem everything`
	`60`	`+ // if amount is equal to type(uint256).max, the user wants to redeem everything`
`61`	`61`	`if (amount == type(uint256).max) {`
`62`	`62`	`amountToWithdraw = userBalance;`
`63`	`63`	`}`