LendingPool
The LendingPool contract is the main contract of the protocol. It exposes all the user-oriented actions that can be invoked using either Solidity or web3 libraries.
The source code can be found on Github here.
If you need development support, join the #developers channel on the Aave community Discord server.
LendingPool methods**deposit, borrow, withdraw and repay**are only for ERC20, if you want to deposit, borrow, withdraw or repay using native ETH (or native MATIC incase of Polygon), use WETHGateway instead.
Methods
deposit()
function deposit(address asset, uint256 amount, address onBehalfOf, uint16 referralCode)
Deposits a certain amount of an asset into the protocol, minting the same amount of corresponding aTokens, and transferring them to the onBehalfOf address.
The referral program is currently in active and you can pass0 as thereferralCode.
In future for referral code to be active again, a governance proposal, with the list of unique referral codes for various integration must be passed via governance.
When depositing, the LendingPool contract must have**allowance()to spend funds on behalf ofmsg.sender** for at-least**amount** for the asset being deposited. This can be done via the standard ERC20 approve() method.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the underlying asset |
| uint256 | amount deposited, expressed in wei units |
| address | address whom will receive the aTokens.
Use |
| uint16 | referral code for our referral program. Use 0 for no referral. |
withdraw()
function withdraw(address asset, uint256 amount, address to)
Withdraws amount of the underlying asset, i.e. redeems the underlying token and burns the aTokens.
When withdrawing toanother address,**msg.sender**should haveaTokenthat will be burned by lendingPool .
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the underlying asset, not the aToken |
| uint256 | amount deposited, expressed in wei units.
Use |
| address | address that will receive the |
borrow()
function borrow(address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf)
Borrows amount of asset with interestRateMode, sending the amount to msg.sender, with the debt being incurred by onBehalfOf.
Note: onBehalfOf must have enough collateral via deposit() or have delegated credit to msg.sender via approveDelegation(). See the Credit Delegation guide for more details.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the underlying asset |
| uint256 | amount to be borrowed, expressed in wei units |
| uint256 | the type of borrow debt. Stable: 1, Variable: 2 |
| uint16 | referral code for our referral program. Use 0 for no referral code. |
| address | address of user who will incur the debt. Use |
repay()
function repay(address asset, uint256 amount, uint256 rateMode, address onBehalfOf)
Repays onBehalfOf's debt amount of asset which has a rateMode.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the underlying asset |
| uint256 | amount to be borrowed, expressed in wei units. Use In case of repayments on behalf of another user, it's recommended to send an |
| uint256 | the type of borrow debt. Stable: 1, Variable: 2 |
| address | address of user who will incur the debt. Use |
swapBorrowRateMode()
function swapBorrowRateMode(address asset, uint256 rateMode)
Swaps the msg.sender's borrow rate modes between stable and variable.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the underlying asset |
| uint256 | the rate mode the user is swapping to. Stable: 1, Variable: 2 |
setUserUseReserveAsCollateral()
function setUserUseReserveAsCollateral(address asset, bool useAsCollateral)
Sets the asset of msg.sender to be used as collateral or not.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the underlying asset |
| bool |
|
liquidationCall()
function liquidationCall(address collateral, address debt, address user, uint256 debtToCover, bool receiveAToken)
Liquidate positions with a health factor below 1. Also see our Liquidations guide.
When the health factor of a position is below 1, liquidators repay part or all of the outstanding borrowed amount on behalf of the borrower, while receiving a discounted amount of collateral in return (also known as a liquidation 'bonus"). Liquidators can decide if they want to receive an equivalent amount of collateral aTokens, or the underlying asset directly. When the liquidation is completed successfully, the health factor of the position is increased, bringing the health factor above 1.
Liquidators can only close a certain amount of collateral defined by a close factor. Currently the close factor is 0.5. In other words, liquidators can only liquidate a maximum of 50% of the amount pending to be repaid in a position. The liquidation discount applies to this amount.
Liquidators must approve() the LendingPool contract to use debtToCover of the underlying ERC20 of theasset used for the liquidation.
NOTES
In most scenarios, profitable liquidators will choose to liquidate as much as they can (50% of the
userposition).debtToCoverparameter can be set touint(-1)and the protocol will proceed with the highest possible liquidation allowed by the close factor.To check a user's health factor, use
getUserAccountData().
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the collateral reserve |
| address | address of the debt reserve |
| address | address of the borrower |
| uint256 | amount of |
| bool | if |
flashLoan()
function flashLoan(address receiverAddress, address[] calldata assets, uint256[] calldata amounts, uint256[] modes, address onBehalfOf, bytes calldata params, uint16 referralCode)
Sends the requested amounts of assets to the receiverAddress contract, passing the included params.
If the flash loaned amounts + fee is not returned by the end of the transaction, then the transaction will either:
revert if the associated
modeis 0,onBehalfOfincurs a stable debt ifmodeis 1, oronBehalfOfincurs a variable debt ifmodeis 2.
Your contract which receives the flash loaned amounts must conform to the IFlashLoanReceiver interface. For more, see the flash loan guides.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the contract receiving the funds. Must implement the |
|
| addresses of the reserves to flashloan |
|
| amounts of This needs to contain the same number of elements as |
|
| the types of debt to open if the flashloan is not returned. 0: Don't open any debt, just revert 1: stable mode debt 2: variable mode debt |
| address | if the associated Note: |
| bytes | bytes-encoded parameters to be used by the |
| uint16 | referral code for our referral program |
View Methods
getReserveData()
function getReserveData(address asset)
Returns the state and configuration of the reserve
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the reserve |
Return values
| Parameter Name | Type | Description |
|---|---|---|
| uint256 | See the whitepaper for details on why a bitmask was used. To find out more about these values, see the Risk docs. bit 0-15: LTV bit 16-31: Liq. threshold bit 32-47: Liq. bonus bit 48-55: Decimals bit 56: reserve is active bit 57: reserve is frozen bit 58: borrowing is enabled bit 59: stable rate borrowing enabled bit 60-63: reserved bit 64-79: reserve factor ** All % are 1e4 i.e. percentage plus two decimals ** Decimals is 1e2 ** Caveat on Liquidation bonus
|
| uint128 | liquidity index in ray |
| uint128 | variable borrow index in ray |
| uint128 | current supply / liquidity / deposit rate in ray |
| uint128 | current variable borrow rate in ray |
| uint128 | current stable borrow rate in ray |
| uint40 | timestamp of when reserve data was last updated |
| address | address of associated aToken (tokenised deposit) |
| address | address of associated stable debt token |
| address | address of associated variable debt token |
| address | address of interest rate strategy. See Risk docs for more info. |
| uint8 | the position in the list of active reserves |
getUserAccountData**()**
function getUserAccountData(address user)
Returns the user account data across all the reserves
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the user |
Return values
| Parameter Name | Type | Description |
|---|---|---|
| uint256 | total collateral in ETH of the use (wei decimal unit) |
| uint256 | total debt in ETH of the user (wei decimal unit) |
| uint256 | borrowing power left of the user (wei decimal unit) |
| uint256 | liquidation threshold of the user - weighted average of liquidation threshold of collateral reserves (1e4 format => percentage plus two decimals) |
| uint256 | maximum Loan To Value of the user - weighted average of max ltv of collateral reserves (1e4 format => percentage plus two decimals) |
| uint256 | current health factor of the user. Also see |
getConfiguration**()**
function getConfiguration(address asset)
Returns the configuration of the reserve
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the reserve |
Return values
| Return Type | Description |
|---|---|
uint256 | See the whitepaper for details on why a bitmask was used. bit 0-15: LTV bit 16-31: Liq. threshold bit 32-47: Liq. bonus bit 48-55: Decimals bit 56: reserve is active bit 57: reserve is frozen bit 58: borrowing is enabled bit 59: stable rate borrowing enabled bit 60-63: reserved bit 64-79: reserve factor |
getUserConfiguration**()**
function getUserConfiguration(address user)
Returns the configuration of the user across all the reserves.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the user |
Return values
| Return Type | Description |
|---|---|
uint256 | See the whitepaper for details on why a bitmask was used. The bitmask is divided into pairs of bits, one pair for each asset. The first bit of the pair indicates if it is being used as collateral by the user, the second bit indicates if it is being borrowed.
The corresponding assets are in the same position as If we start from the right and move left in the above binary pairs, the third pair is If we continue to go to the end of the binary pairs (furthest left), we have In short, if a user is using WETH as collateral and has borrowed DAI, then the value returned would be |
getReserveNormalizedIncome**()**
function getReserveNormalizedIncome(address asset)
Returns the normalized income per unit of asset.
A return value of indicates no income. As time passes, the income is accrued. A value of indicates that for each unit of asset, two units of income have been accrued.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the reserve |
getReserveNormalizedVariableDebt**()**
function getReserveNormalizedVariableDebt(address asset)
Returns the normalized variable debt per unit of asset.
A return value of indicates no debt. As time passes, the debt is accrued. A value of indicates that for each unit of asset, two units of debt have been accrued.
| Parameter Name | Type | Description |
|---|---|---|
| address | address of the reserve |
paused**()**
function paused()
Returns true if the LendingPool is paused.
getReservesList**()**
function getReservesList()
Returns the list of initialized reserves.
getAddressesProvider**()**
function getAddressesProvider()
Returns the addresses provider.
Error Codes
In order to reduce gas usage and code size, aave contracts return numbered errors. If you are making calls to the protocol and receive numbered errors, you can use our error code reference guide to know what the error number means. Alternatively, you can also find what the numbers represent by checking the Errors.sol