ILendingPool

Functions

deposit

*Deposits an amount of underlying asset into the reserve, receiving in return overlying aTokens.

E.g. User deposits 100 USDC and gets in return 100 aUSDC*

function deposit(address asset, uint256 amount, address onBehalfOf, uint16 referralCode) external;

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset to deposit
`amount`	`uint256`	The amount to be deposited
`onBehalfOf`	`address`	The address that will receive the aTokens, same as msg.sender if the user wants to receive them on his own wallet, or a different address if the beneficiary of aTokens is a different wallet
`referralCode`	`uint16`	Code used to register the integrator originating the operation, for potential rewards. 0 if the action is executed directly by the user, without any middle-man

withdraw

Withdraws an amount of underlying asset from the reserve, burning the equivalent aTokens owned E.g. User has 100 aUSDC, calls withdraw() and receives 100 USDC, burning the 100 aUSDC

function withdraw(address asset, uint256 amount, address to) external returns (uint256);

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset to withdraw
`amount`	`uint256`	The underlying amount to be withdrawn - Send the value type(uint256).max in order to withdraw the whole aToken balance
`to`	`address`	Address that will receive the underlying, same as msg.sender if the user wants to receive it on his own wallet, or a different address if the beneficiary is a different wallet

Returns

Name	Type	Description
`<none>`	`uint256`	The final amount withdrawn

*Allows users to borrow a specific amount of the reserve underlying asset, provided that the borrower already deposited enough collateral, or he was given enough allowance by a credit delegator on the corresponding debt token (StableDebtToken or VariableDebtToken)

E.g. User borrows 100 USDC passing as onBehalfOf his own address, receiving the 100 USDC in his wallet and 100 stable/variable debt tokens, depending on the interestRateMode*

function borrow(address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf)
    external;

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset to borrow
`amount`	`uint256`	The amount to be borrowed
`interestRateMode`	`uint256`	The interest rate mode at which the user wants to borrow: 1 for Stable, 2 for Variable
`referralCode`	`uint16`	Code used to register the integrator originating the operation, for potential rewards. 0 if the action is executed directly by the user, without any middle-man
`onBehalfOf`	`address`	Address of the user who will receive the debt. Should be the address of the borrower itself calling the function if he wants to borrow against his own collateral, or the address of the credit delegator if he has been given credit delegation allowance

repay

Repays a borrowed amount on a specific reserve, burning the equivalent debt tokens owned

E.g. User repays 100 USDC, burning 100 variable/stable debt tokens of the onBehalfOf address

function repay(address asset, uint256 amount, uint256 rateMode, address onBehalfOf) external returns (uint256);

Parameters

Name	Type	Description
`asset`	`address`	The address of the borrowed underlying asset previously borrowed
`amount`	`uint256`	The amount to repay - Send the value type(uint256).max in order to repay the whole debt for `asset` on the specific `debtMode`
`rateMode`	`uint256`	The interest rate mode at of the debt the user wants to repay: 1 for Stable, 2 for Variable
`onBehalfOf`	`address`	Address of the user who will get his debt reduced/removed. Should be the address of the user calling the function if he wants to reduce/remove his own debt, or the address of any other other borrower whose debt should be removed

Returns

Name	Type	Description
`<none>`	`uint256`	The final amount repaid

swapBorrowRateMode

Allows a borrower to swap his debt between stable and variable mode, or viceversa

function swapBorrowRateMode(address asset, uint256 rateMode) external;

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset borrowed
`rateMode`	`uint256`	The rate mode that the user wants to swap to

rebalanceStableBorrowRate

*Rebalances the stable interest rate of a user to the current stable rate defined on the reserve.

Users can be rebalanced if the following conditions are satisfied:

Usage ratio is above 95%
the current deposit APY is below REBALANCE_UP_THRESHOLD * maxVariableBorrowRate, which means that too much has been borrowed at a stable rate and depositors are not earning enough*

function rebalanceStableBorrowRate(address asset, address user) external;

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset borrowed
`user`	`address`	The address of the user to be rebalanced

setUserUseReserveAsCollateral

Allows depositors to enable/disable a specific deposited asset as collateral

function setUserUseReserveAsCollateral(address asset, bool useAsCollateral) external;

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset deposited
`useAsCollateral`	`bool`	`true` if the user wants to use the deposit as collateral, `false` otherwise

liquidationCall

*Function to liquidate a non-healthy position collateral-wise, with Health Factor below 1

The caller (liquidator) covers debtToCover amount of debt of the user getting liquidated, and receives a proportionally amount of the collateralAsset plus a bonus to cover market risk*

function liquidationCall(
    address collateralAsset,
    address debtAsset,
    address user,
    uint256 debtToCover,
    bool receiveAToken
) external;

Parameters

Name	Type	Description
`collateralAsset`	`address`	The address of the underlying asset used as collateral, to receive as result of the liquidation
`debtAsset`	`address`	The address of the underlying borrowed asset to be repaid with the liquidation
`user`	`address`	The address of the borrower getting liquidated
`debtToCover`	`uint256`	The debt amount of borrowed `asset` the liquidator wants to cover
`receiveAToken`	`bool`	`true` if the liquidators wants to receive the collateral aTokens, `false` if he wants to receive the underlying collateral asset directly

flashLoan

Allows smartcontracts to access the liquidity of the pool within one transaction, as long as the amount taken plus a fee is returned. IMPORTANT There are security concerns for developers of flashloan receiver contracts that must be kept into consideration. For further details please visit https://developers.aave.com

function flashLoan(
    address receiverAddress,
    address[] calldata assets,
    uint256[] calldata amounts,
    uint256[] calldata modes,
    address onBehalfOf,
    bytes calldata params,
    uint16 referralCode
) external;

Parameters

Name	Type	Description
`receiverAddress`	`address`	The address of the contract receiving the funds, implementing the IFlashLoanReceiver interface
`assets`	`address[]`	The addresses of the assets being flash-borrowed
`amounts`	`uint256[]`	The amounts amounts being flash-borrowed
`modes`	`uint256[]`	Types of the debt to open if the flash loan is not returned: 0 -> Don't open any debt, just revert if funds can't be transferred from the receiver 1 -> Open debt at stable rate for the value of the amount flash-borrowed to the `onBehalfOf` address 2 -> Open debt at variable rate for the value of the amount flash-borrowed to the `onBehalfOf` address
`onBehalfOf`	`address`	The address that will receive the debt in the case of using on `modes` 1 or 2
`params`	`bytes`	Variadic packed params to pass to the receiver as extra information
`referralCode`	`uint16`	Code used to register the integrator originating the operation, for potential rewards. 0 if the action is executed directly by the user, without any middle-man

getUserAccountData

Returns the user account data across all the reserves

function getUserAccountData(address user)
    external
    view
    returns (
        uint256 totalCollateralETH,
        uint256 totalDebtETH,
        uint256 availableBorrowsETH,
        uint256 currentLiquidationThreshold,
        uint256 ltv,
        uint256 healthFactor
    );

Parameters

Name	Type	Description
`user`	`address`	The address of the user

Returns

Name	Type	Description
`totalCollateralETH`	`uint256`	the total collateral in ETH of the user
`totalDebtETH`	`uint256`	the total debt in ETH of the user
`availableBorrowsETH`	`uint256`	the borrowing power left of the user
`currentLiquidationThreshold`	`uint256`	the liquidation threshold of the user
`ltv`	`uint256`	the loan to value of the user
`healthFactor`	`uint256`	the current health factor of the user

initReserve

function initReserve(
    address reserve,
    address aTokenAddress,
    address stableDebtAddress,
    address variableDebtAddress,
    address interestRateStrategyAddress
) external;

setReserveInterestRateStrategyAddress

function setReserveInterestRateStrategyAddress(address reserve, address rateStrategyAddress) external;

setConfiguration

function setConfiguration(address reserve, uint256 configuration) external;

getConfiguration

Returns the configuration of the reserve

function getConfiguration(address asset) external view returns (DataTypes.ReserveConfigurationMap memory);

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset of the reserve

Returns

Name	Type	Description
`<none>`	`DataTypes.ReserveConfigurationMap`	The configuration of the reserve

getUserConfiguration

Returns the configuration of the user across all the reserves

function getUserConfiguration(address user) external view returns (DataTypes.UserConfigurationMap memory);

Parameters

Name	Type	Description
`user`	`address`	The user address

Returns

Name	Type	Description
`<none>`	`DataTypes.UserConfigurationMap`	The configuration of the user

getReserveNormalizedIncome

Returns the normalized income normalized income of the reserve

function getReserveNormalizedIncome(address asset) external view returns (uint256);

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset of the reserve

Returns

Name	Type	Description
`<none>`	`uint256`	The reserve's normalized income

getReserveNormalizedVariableDebt

Returns the normalized variable debt per unit of asset

function getReserveNormalizedVariableDebt(address asset) external view returns (uint256);

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset of the reserve

Returns

Name	Type	Description
`<none>`	`uint256`	The reserve normalized variable debt

getReserveData

Returns the state and configuration of the reserve

function getReserveData(address asset) external view returns (DataTypes.ReserveData memory);

Parameters

Name	Type	Description
`asset`	`address`	The address of the underlying asset of the reserve

Returns

Name	Type	Description
`<none>`	`DataTypes.ReserveData`	The state of the reserve

finalizeTransfer

function finalizeTransfer(
    address asset,
    address from,
    address to,
    uint256 amount,
    uint256 balanceFromAfter,
    uint256 balanceToBefore
) external;

getReservesList

function getReservesList() external view returns (address[] memory);

getAddressesProvider

function getAddressesProvider() external view returns (ILendingPoolAddressesProvider);

setPause

function setPause(bool val) external;

paused

function paused() external view returns (bool);

FLASHLOAN_PREMIUM_TOTAL

function FLASHLOAN_PREMIUM_TOTAL() external view returns (uint256);

Events

Deposit

Emitted on deposit()

event Deposit(
    address indexed reserve, address user, address indexed onBehalfOf, uint256 amount, uint16 indexed referral
);

Withdraw

Emitted on withdraw()

event Withdraw(address indexed reserve, address indexed user, address indexed to, uint256 amount);

Borrow

Emitted on borrow() and flashLoan() when debt needs to be opened

event Borrow(
    address indexed reserve,
    address user,
    address indexed onBehalfOf,
    uint256 amount,
    uint256 borrowRateMode,
    uint256 borrowRate,
    uint16 indexed referral
);

Repay

Emitted on repay()

event Repay(address indexed reserve, address indexed user, address indexed repayer, uint256 amount);

Swap

Emitted on swapBorrowRateMode()

event Swap(address indexed reserve, address indexed user, uint256 rateMode);

ReserveUsedAsCollateralEnabled

Emitted on setUserUseReserveAsCollateral()

event ReserveUsedAsCollateralEnabled(address indexed reserve, address indexed user);

ReserveUsedAsCollateralDisabled

Emitted on setUserUseReserveAsCollateral()

event ReserveUsedAsCollateralDisabled(address indexed reserve, address indexed user);

RebalanceStableBorrowRate

Emitted on rebalanceStableBorrowRate()

event RebalanceStableBorrowRate(address indexed reserve, address indexed user);

FlashLoan

Emitted on flashLoan()

event FlashLoan(
    address indexed target,
    address indexed initiator,
    address indexed asset,
    uint256 amount,
    uint256 premium,
    uint16 referralCode
);

Paused

Emitted when the pause is triggered.

event Paused();

Unpaused

Emitted when the pause is lifted.

event Unpaused();

LiquidationCall

Emitted when a borrower is liquidated. This event is emitted by the LendingPool via LendingPoolCollateral manager using a DELEGATECALL This allows to have the events in the generated ABI for LendingPool.

event LiquidationCall(
    address indexed collateralAsset,
    address indexed debtAsset,
    address indexed user,
    uint256 debtToCover,
    uint256 liquidatedCollateralAmount,
    address liquidator,
    bool receiveAToken
);

ReserveDataUpdated

Emitted when the state of a reserve is updated. NOTE: This event is actually declared in the ReserveLogic library and emitted in the updateInterestRates() function. Since the function is internal, the event will actually be fired by the LendingPool contract. The event is therefore replicated here so it gets added to the LendingPool ABI

event ReserveDataUpdated(
    address indexed reserve,
    uint256 liquidityRate,
    uint256 stableBorrowRate,
    uint256 variableBorrowRate,
    uint256 liquidityIndex,
    uint256 variableBorrowIndex
);