PoolInstance
Ethereum0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2
Proxy implementation: 0x8147b99df7672a21809c9093e6f6ce1a60f119bd
Solidity v0.8.27+commit.40a35a09
🤖
Query this contract from your AI
Reference:
aavev3-pool-eth
0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2
Sample prompt:
“Tell me the current state of aavev3-pool-eth”
No AI wired up yet? →
mcp.smarts.md
Admin & Risk
Who can change the rules?
Detected upgradeable controls from the verified ABI.
Upgradeable
Current controls
- Implementation
- 0x8147b99df7672a21809c9093e6f6ce1a60f119bd ↗ Etherscan → smarts proxy
Overview
Read Functions
34
Write Functions
35
Events
16
Read Functions
Block #25,169,819 · just now
ADDRESSES_PROVIDER()
view
→ 0x2f39d218133afab8f2b819b1066c7e434ad94e9e
Returns the PoolAddressesProvider connected to this contract
Returns
| Name | Type | Description |
|---|---|---|
| — | address | The address of the PoolAddressesProvider |
FLASHLOAN_PREMIUM_TOTAL()
view
→ 5
Returns the total fee on flash loans.
dev: From v3.4 all flashloan fees will be send to the treasury.
Returns
| Name | Type | Description |
|---|---|---|
| — | uint128 | The total fee on flashloans |
FLASHLOAN_PREMIUM_TO_PROTOCOL()
view
→ 10,000
Returns the part of the flashloan fees sent to protocol
dev: From v3.4 all flashloan fees will be send to the treasury and this value is always 100_00.
Returns
| Name | Type | Description |
|---|---|---|
| — | uint128 | The flashloan fee sent to the protocol treasury |
MAX_NUMBER_RESERVES()
view
→ 128
Returns the maximum number of reserves supported to be listed in this Pool
Returns
| Name | Type | Description |
|---|---|---|
| — | uint16 | The maximum number of reserves supported |
POOL_REVISION()
view
→ 10
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 |
RESERVE_INTEREST_RATE_STRATEGY()
view
→ 0x9ec6f08190dea04a54f8afc53db96134e5e3fdfb
Returns the ReserveInterestRateStrategy connected to all the reserves
Returns
| Name | Type | Description |
|---|---|---|
| — | address | The address of the ReserveInterestRateStrategy contract |
UMBRELLA()
view
→ 0x554d4252454c4c41000000000000000000000000000000000000000000000000
Returns
| Name | Type | Description |
|---|---|---|
| — | bytes32 |
getBorrowLogic()
pure
→ 0x1fb8f7c906cddd28b42ae6eb76abc04a91188635
Gets the address of the external BorrowLogic
Returns
| Name | Type | Description |
|---|---|---|
| — | address |
getConfiguration(asset: address)
view
Returns the configuration of the reserve
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | tuple | The configuration of the reserve |
getEModeCategoryBorrowableBitmap(id: uint8)
view
Returns the borrowableBitmap of an eMode category
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint128 | The borrowableBitmap of the category |
getEModeCategoryCollateralBitmap(id: uint8)
view
Returns the collateralBitmap of an eMode category
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint128 | The collateralBitmap of the category |
getEModeCategoryCollateralConfig(id: uint8)
view
Returns the collateral config of an eMode category
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
Returns
| Name | Type | Description |
|---|---|---|
| res | tuple | The ltv,lt,lb of the category |
getEModeCategoryData(id: uint8)
view
Returns the data of an eMode category
dev: DEPRECATED use independent getters instead
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
Returns
| Name | Type | Description |
|---|---|---|
| — | tuple | The configuration data of the category |
getEModeCategoryLabel(id: uint8)
view
Returns the label of an eMode category
dev: This function is deprecated and will be removed in a future version.
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
Returns
| Name | Type | Description |
|---|---|---|
| — | string | The label of the category |
getEModeCategoryLtvzeroBitmap(id: uint8)
view
Returns the ltvzero of an eMode category
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint128 | The ltvzeroBitmap of the category |
getFlashLoanLogic()
pure
→ 0xe66adcf153d0bd67a74e5d23e23f90b4011024ec
Gets the address of the external FlashLoanLogic
Returns
| Name | Type | Description |
|---|---|---|
| — | address |
getLiquidationGracePeriod(asset: address)
view
Returns the liquidation grace period of the given asset
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint40 | Timestamp when the liquidation grace period will end |
getLiquidationLogic()
pure
→ 0x8dc095f287dbebd9e15f75bb3dfbf18389bb8104
Gets the address of the external LiquidationLogic
Returns
| Name | Type | Description |
|---|---|---|
| — | address |
getPoolLogic()
pure
→ 0x25ed699a052b820d772765e26ed4dd9f0a26f3e5
Gets the address of the external PoolLogic
Returns
| Name | Type | Description |
|---|---|---|
| — | address |
getReserveAToken(asset: address)
view
Returns the aToken address of a reserve.
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | address | The address of the aToken |
getReserveAddressById(id: uint16)
view
Returns the address of the underlying asset of a reserve by the reserve id as stored in the DataTypes.ReserveData struct
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint16 | The id of the reserve as stored in the DataTypes.ReserveData struct |
Returns
| Name | Type | Description |
|---|---|---|
| — | address | The address of the reserve associated with id |
getReserveData(asset: address)
view
Returns the state and configuration of the reserve
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| res | tuple | The state and configuration data of the reserve |
getReserveDeficit(asset: address)
view
Returns the current deficit of a reserve.
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The current deficit of the reserve |
getReserveNormalizedIncome(asset: address)
view
Returns the normalized income of the reserve
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The reserve's normalized income |
getReserveNormalizedVariableDebt(asset: address)
view
Returns the normalized variable debt per unit of asset
dev: WARNING: This function is intended to be used primarily by the protocol itself to get a "dynamic" variable index based on time, current stored index and virtual rate at the current moment (approx. a borrower would get if opening a position). This means that is always used in combination with variable debt supply/balances. If using this function externally, consider that is possible to have an increasing normalized variable debt that is not equivalent to how the variable debt index would be updated in storage (e.g. only updates with non-zero variable debt supply)
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The reserve normalized variable debt |
getReserveVariableDebtToken(asset: address)
view
Returns the variableDebtToken address of a reserve.
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | address | The address of the variableDebtToken |
getReservesCount()
view
→ 66
Returns the number of initialized reserves
dev: It includes dropped reserves
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The count |
getReservesList()
view
→ [0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2, 0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0, 0x2260fac5e5542a773aa44fbcfedf7c193bc2c599, 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48, 0x6b175474e89094c44da98b954eedeac495271d0f, 0x514910771af9ca656af840dff83e8264ecf986ca, 0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9, 0xbe9895146f7af43049ca1c1ae358b0541ea49704, 0xdac17f958d2ee523a2206206994597c13d831ec7, 0xae78736cd615f374d3085123a210448e74fc6393, 0x5f98805a4e8be255a32880fdec7f6728c6568ba0, 0xd533a949740bb3306d119cc777fa900ba034cd52, 0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2, 0xc011a73ee8576fb46f5e1c5751ca3b9fe0af2a6f, 0xba100000625a3754423978a60c9317c58a424e3d, 0x1f9840a85d5af5bf1d1762f925bdaddc4201f984, 0x5a98fcbea516cf06857215779fd812ca3bef1b32, 0xc18360217d8f7ab5e7c516566761ea12ce7f9d72, 0x111111111117dc0aa78b770fa6a738034120c302, 0x853d955acef822db058eb8505911ed77f175b99e, 0x40d16fc0246ad3160ccc09b8d0d3a2cd28ae6c2f, 0xd33526068d116ce69f19a9ee46f0bd304f21a51f, 0x83f20f44975d03b1b09e64809b757c47f942beea, 0xaf5191b0de278c7286d6c7cc6ab6bb8a73ba2cd6, 0xdefa4e8a7bcba345f687a2f1456f5edd9ce97202, 0x3432b6a60d23ca0dfca7761b7ab56459d9c964d0, 0xf939e0a03fb07f59a73314e73794be0e57ac1b4e, 0x6c3ea9036406852006290770bedfcaba0e23a0e8, 0xcd5fe23c85820f7b72d0926fc9b05b43e359b7ee, 0xf1c9acdc66974dfb6decb12aa385b9cd01190e38, 0x4c9edd5852cd905f086c759e8383e09bff1e68b3, 0xa35b1b31ce002fbf2058d22f30f95d405200a15b, 0x9d39a5de30e57443bff2a8307a4256c8797a3497, 0x18084fba666a33d37592fa2633fd49a74dd93a88, 0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf, 0xdc035d45d973e3ec169d2276ddab16f1e407384f, 0xa1290d69c65a6fe4df752f95823fae25cb99e5a7, 0x8236a87084f8b84306f72007f36f2618a5634494, 0x657e8c867d8b37dcc18fa4caead9c45eb088c642, 0x8292bb45bf1ee4d140127049757c2e0ff06317ed, 0x50d2c7992b802eef16c04feadab310f31866a545, 0x3b3fb9c57858ef816833dc91565efcd85d96f634, 0xc139190f447e929f090edeb554d95abb8b18ac1c, 0x917459337caac939d41d7493b3999f571d20d667, 0x14bdc3a3ae09f5518b923b69489cbcafb238e617, 0x90d2af7d622ca3141efa4d8f1f24d86e5974cc8f, 0xc96de26018a54d51c097160568752c4e3bd6c364, 0x1abaea1f7c830bd89acc67ec4af516284b1bc33c, 0x9f56094c450763769ba0ea9fe2876070c0fd5f77, 0xbc6736d346a5ebc0debc997397912cd9b8fae10a, 0xd11c452fc99cf405034ee446803b6f6c1f6d5ed8, 0xbf5495efe5db9ce00f80364c8b423567e58d2110, 0x68749665ff8d2d112fa859aa293f07a622782f38, 0xe6a934089bbee34f832060ce98848359883749b3, 0x62c6e813b9589c3631ba0cdb013acdb8544038b7, 0x1f84a51296691320478c98b8d77f2bbd17d34350, 0xe8483517077afa11a9b07f849cee2552f040d7b2, 0xaca92e438df0b2401ff60da7e4337b687a2435da, 0x356b8d89c1e1239cbbb9de4815c39a1474d5ba7d, 0xe343167631d89b6ffc58b88d6b7fb0228795491d, 0xaebf0bb9f57e89260d57f31af34eb58657d96ce0, 0x3de0ff76e8b528c092d47b9dac775931cef80f49, 0x9bf45ab47747f4b4dd09b3c2c73953484b4eb375, 0xb0f70c0bd6fd87dbeb7c10dc692a2a6106817072, 0x619d75e3b790ebc21c289f2805bb7177a7d732e2, 0x9db38d74a0d29380899ad354121dfb521adb0548]
Returns the list of the underlying assets of all the initialized reserves
dev: It does not include dropped reserves
Returns
| Name | Type | Description |
|---|---|---|
| — | address[] | The addresses of the underlying assets of the initialized reserves |
getSupplyLogic()
pure
→ 0x33654b16a4de97bce05d7dd06803bf1066f3123c
Gets the address of the external SupplyLogic
Returns
| Name | Type | Description |
|---|---|---|
| — | address |
getUserAccountData(user: address)
view
Returns the user account data across all the reserves
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the user |
Returns
| Name | Type | Description |
|---|---|---|
| totalCollateralBase | uint256 | totalCollateralBase The total collateral of the user in the base currency used by the price feed |
| totalDebtBase | uint256 | totalDebtBase The total debt of the user in the base currency used by the price feed |
| availableBorrowsBase | uint256 | availableBorrowsBase The borrowing power left of the user in the base currency used by the price feed |
| currentLiquidationThreshold | uint256 | currentLiquidationThreshold The liquidation threshold of the user |
| ltv | uint256 | ltv The loan to value of The user |
| healthFactor | uint256 | healthFactor The current health factor of the user |
getUserConfiguration(user: address)
view
Returns the configuration of the user across all the reserves
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The user address |
Returns
| Name | Type | Description |
|---|---|---|
| — | tuple | The configuration of the user |
getUserEMode(user: address)
view
Returns the eMode the user is using
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the user |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The eMode id |
getVirtualUnderlyingBalance(asset: address)
view
Returns the virtual underlying balance of the reserve
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint128 | The reserve virtual underlying balance |
isApprovedPositionManager(user: address, positionManager: address)
view
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | |
| positionManager | address |
Returns
| Name | Type | Description |
|---|---|---|
| — | bool |
Write Functions
approvePositionManager(positionManager: address, approve: bool)
nonpayable
Approves or disapproves a position manager. This position manager will be able to call the `setUserUseReserveAsCollateralOnBehalfOf` and the `setUserEModeOnBehalfOf` function on behalf of the user.
Parameters
| Name | Type | Description |
|---|---|---|
| positionManager | address | The address of the position manager |
| approve | bool | True if the position manager should be approved, false otherwise |
borrow(asset: address, amount: uint256, interestRateMode: uint256, referralCode: uint16, onBehalfOf: address)
nonpayable
Allows users to borrow a specific `amount` of the reserve underlying asset, provided that the borrower already supplied enough collateral, or he was given enough allowance by a credit delegator on the VariableDebtToken - E.g. User borrows 100 USDC passing as `onBehalfOf` his own address, receiving the 100 USDC in his wallet and 100 variable debt tokens
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset to borrow |
| amount | uint256 | The amount to be borrowed |
| interestRateMode | uint256 | 2 for Variable, 1 is deprecated on v3.2.0 |
| referralCode | uint16 | The 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 | The 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 |
configureEModeCategory(id: uint8, category: tuple)
nonpayable
Configures a new or alters an existing collateral configuration of an eMode.
dev: In eMode, the protocol allows very high borrowing power to borrow assets of the same category. The category 0 is reserved as it's the default for volatile assets
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
| category | tuple |
configureEModeCategoryBorrowableBitmap(id: uint8, borrowableBitmap: uint128)
nonpayable
Replaces the current eMode borrowableBitmap.
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
| borrowableBitmap | uint128 | The borrowableBitmap of the category |
configureEModeCategoryCollateralBitmap(id: uint8, collateralBitmap: uint128)
nonpayable
Replaces the current eMode collateralBitmap.
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
| collateralBitmap | uint128 | The collateralBitmap of the category |
configureEModeCategoryLtvzeroBitmap(id: uint8, ltvzeroBitmap: uint128)
nonpayable
Replaces the current eMode ltvzeroBitmap.
Parameters
| Name | Type | Description |
|---|---|---|
| id | uint8 | The id of the category |
| ltvzeroBitmap | uint128 | The ltvzeroBitmap of the category |
deposit(asset: address, amount: uint256, onBehalfOf: address, referralCode: uint16)
nonpayable
dev: Deprecated: maintained for compatibility purposes
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | |
| amount | uint256 | |
| onBehalfOf | address | |
| referralCode | uint16 |
dropReserve(asset: address)
nonpayable
Drop a reserve
dev: Does not reset eMode flags, which must be considered when reusing the same reserve id for a different reserve.
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
eliminateReserveDeficit(asset: address, amount: uint256)
nonpayable
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.
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset to cover the deficit. |
| amount | uint256 | The amount to be covered, in aToken |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The amount of tokens burned |
finalizeTransfer(asset: address, from: address, to: address, scaledAmount: uint256, scaledBalanceFromBefore: uint256)
nonpayable
Validates and finalizes an aToken transfer
dev: Only callable by the overlying aToken of the `asset`
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the aToken |
| from | address | The user from which the aTokens are transferred |
| to | address | The user receiving the aTokens |
| scaledAmount | uint256 | The scaled amount being transferred/withdrawn |
| scaledBalanceFromBefore | uint256 | The aToken scaled balance of the `from` user before the transfer |
flashLoan(receiverAddress: address, assets: address[], amounts: uint256[], interestRateModes: uint256[], onBehalfOf: address, params: bytes, referralCode: uint16)
nonpayable
Allows smartcontracts to access the liquidity of the pool within one transaction, as long as the amount taken plus a fee is returned.
dev: IMPORTANT There are security concerns for developers of flashloan receiver contracts that must be kept into consideration. For further details please visit https://docs.aave.com/developers/
Parameters
| Name | Type | Description |
|---|---|---|
| receiverAddress | address | The address of the contract receiving the funds, implementing IFlashLoanReceiver interface |
| assets | address[] | The addresses of the assets being flash-borrowed |
| amounts | uint256[] | The amounts of the assets being flash-borrowed |
| interestRateModes | 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 -> Deprecated on v3.2.0 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 2 on `modes` |
| params | bytes | Variadic packed params to pass to the receiver as extra information |
| referralCode | uint16 | The 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 |
flashLoanSimple(receiverAddress: address, asset: address, amount: uint256, params: bytes, referralCode: uint16)
nonpayable
Allows smartcontracts to access the liquidity of the pool within one transaction, as long as the amount taken plus a fee is returned.
dev: IMPORTANT There are security concerns for developers of flashloan receiver contracts that must be kept into consideration. For further details please visit https://docs.aave.com/developers/
Parameters
| Name | Type | Description |
|---|---|---|
| receiverAddress | address | The address of the contract receiving the funds, implementing IFlashLoanSimpleReceiver interface |
| asset | address | The address of the asset being flash-borrowed |
| amount | uint256 | The amount of the asset being flash-borrowed |
| params | bytes | Variadic packed params to pass to the receiver as extra information |
| referralCode | uint16 | The 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 |
initReserve(asset: address, aTokenAddress: address, variableDebtAddress: address)
nonpayable
Initializes a reserve, activating it, assigning an aToken and debt tokens
dev: Only callable by the PoolConfigurator contract
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
| aTokenAddress | address | The address of the aToken that will be assigned to the reserve |
| variableDebtAddress | address | The address of the VariableDebtToken that will be assigned to the reserve |
initialize(provider: address)
nonpayable
Initializes the Pool.
dev: The passed PoolAddressesProvider is validated against the POOL.ADDRESSES_PROVIDER, to ensure the upgrade is done with correct intention.
Parameters
| Name | Type | Description |
|---|---|---|
| provider | address | The address of the PoolAddressesProvider |
liquidationCall(collateralAsset: address, debtAsset: address, borrower: address, debtToCover: uint256, receiveAToken: bool)
nonpayable
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
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 |
| borrower | 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 |
mintToTreasury(assets: address[])
nonpayable
Mints the assets accrued through the reserve factor to the treasury in the form of aTokens
Parameters
| Name | Type | Description |
|---|---|---|
| assets | address[] | The list of reserves for which the minting needs to be executed |
multicall(data: bytes[])
nonpayable
dev: Receives and executes a batch of function calls on this contract.
Parameters
| Name | Type | Description |
|---|---|---|
| data | bytes[] |
Returns
| Name | Type | Description |
|---|---|---|
| results | bytes[] |
renouncePositionManagerRole(user: address)
nonpayable
Renounces a position manager role for a given user.
Parameters
| Name | Type | Description |
|---|---|---|
| user | address | The address of the user |
repay(asset: address, amount: uint256, interestRateMode: uint256, onBehalfOf: address)
nonpayable
Repays a borrowed `amount` on a specific reserve, burning the equivalent debt tokens owned - E.g. User repays 100 USDC, burning 100 variable debt tokens of the `onBehalfOf` address
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` |
| interestRateMode | uint256 | 2 for Variable, 1 is deprecated on v3.2.0 |
| onBehalfOf | address | The 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 |
|---|---|---|
| — | uint256 | The final amount repaid |
repayWithATokens(asset: address, amount: uint256, interestRateMode: uint256)
nonpayable
Repays a borrowed `amount` on a specific reserve using the reserve aTokens, burning the equivalent debt tokens - E.g. User repays 100 USDC using 100 aUSDC, burning 100 variable debt tokens
dev: Passing uint256.max as amount will clean up any residual aToken dust balance, if the user aToken balance is not enough to cover the whole debt
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` |
| interestRateMode | uint256 | DEPRECATED in v3.2.0 |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The final amount repaid |
repayWithPermit(asset: address, amount: uint256, interestRateMode: uint256, onBehalfOf: address, deadline: uint256, permitV: uint8, permitR: bytes32, permitS: bytes32)
nonpayable
Repay with transfer approval of asset to be repaid done via permit function see: https://eips.ethereum.org/EIPS/eip-2612 and https://eips.ethereum.org/EIPS/eip-713
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` |
| interestRateMode | uint256 | 2 for Variable, 1 is deprecated on v3.2.0 |
| 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 |
| deadline | uint256 | The deadline timestamp that the permit is valid |
| permitV | uint8 | The V parameter of ERC712 permit sig |
| permitR | bytes32 | The R parameter of ERC712 permit sig |
| permitS | bytes32 | The S parameter of ERC712 permit sig |
Returns
| Name | Type | Description |
|---|---|---|
| — | uint256 | The final amount repaid |
rescueTokens(token: address, to: address, amount: uint256)
nonpayable
Rescue and transfer tokens locked in this contract
Parameters
| Name | Type | Description |
|---|---|---|
| token | address | The address of the token |
| to | address | The address of the recipient |
| amount | uint256 | The amount of token to transfer |
resetIsolationModeTotalDebt(asset: address)
nonpayable
Resets the isolation mode total debt of the given asset to zero
dev: It requires the given asset has zero debt ceiling
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset to reset the isolationModeTotalDebt |
setConfiguration(asset: address, configuration: tuple)
nonpayable
Sets the configuration bitmap of the reserve as a whole
dev: Only callable by the PoolConfigurator contract
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
| configuration | tuple | The new configuration bitmap |
setLiquidationGracePeriod(asset: address, until: uint40)
nonpayable
Sets the liquidation grace period of the given asset
dev: To enable a liquidation grace period, a timestamp in the future should be set, To disable a liquidation grace period, any timestamp in the past works, like 0
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset to set the liquidationGracePeriod |
| until | uint40 | Timestamp when the liquidation grace period will end |
setUserEMode(categoryId: uint8)
nonpayable
Allows a user to use the protocol in eMode
Parameters
| Name | Type | Description |
|---|---|---|
| categoryId | uint8 | The id of the category |
setUserEModeOnBehalfOf(categoryId: uint8, onBehalfOf: address)
nonpayable
Sets the eMode category for the user on the specific reserve on behalf of the user.
Parameters
| Name | Type | Description |
|---|---|---|
| categoryId | uint8 | The id of the category |
| onBehalfOf | address | The address of the user |
setUserUseReserveAsCollateral(asset: address, useAsCollateral: bool)
nonpayable
Allows suppliers to enable/disable a specific supplied asset as collateral
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset supplied |
| useAsCollateral | bool | True if the user wants to use the supply as collateral, false otherwise |
setUserUseReserveAsCollateralOnBehalfOf(asset: address, useAsCollateral: bool, onBehalfOf: address)
nonpayable
Sets the use as collateral flag for the user on the specific reserve on behalf of the user.
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
| useAsCollateral | bool | True if the user wants to use the reserve as collateral, false otherwise |
| onBehalfOf | address | The address of the user |
supply(asset: address, amount: uint256, onBehalfOf: address, referralCode: uint16)
nonpayable
Supplies an `amount` of underlying asset into the reserve, receiving in return overlying aTokens. - E.g. User supplies 100 USDC and gets in return 100 aUSDC
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset to supply |
| amount | uint256 | The amount to be supplied |
| 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 |
supplyWithPermit(asset: address, amount: uint256, onBehalfOf: address, referralCode: uint16, deadline: uint256, permitV: uint8, permitR: bytes32, permitS: bytes32)
nonpayable
Supply with transfer approval of asset to be supplied done via permit function see: https://eips.ethereum.org/EIPS/eip-2612 and https://eips.ethereum.org/EIPS/eip-713
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset to supply |
| amount | uint256 | The amount to be supplied |
| 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 |
| deadline | uint256 | The deadline timestamp that the permit is valid |
| permitV | uint8 | The V parameter of ERC712 permit sig |
| permitR | bytes32 | The R parameter of ERC712 permit sig |
| permitS | bytes32 | The S parameter of ERC712 permit sig |
syncIndexesState(asset: address)
nonpayable
Accumulates interest to all indexes of the reserve
dev: To be used when required by the configurator, for example when updating interest rates strategy data
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
syncRatesState(asset: address)
nonpayable
Updates interest rates on the reserve data
dev: To be used when required by the configurator, for example when updating interest rates strategy data
Parameters
| Name | Type | Description |
|---|---|---|
| asset | address | The address of the underlying asset of the reserve |
updateFlashloanPremium(flashLoanPremium: uint128)
nonpayable
Updates flash loan premium. All this premium is collected by the protocol treasury.
dev: Only callable by the PoolConfigurator contract
Parameters
| Name | Type | Description |
|---|---|---|
| flashLoanPremium | uint128 | The flash loan premium, expressed in bps |
withdraw(asset: address, amount: uint256, to: address)
nonpayable
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
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 | The 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 |
|---|---|---|
| — | uint256 | The final amount withdrawn |
Events
Borrow(reserve: address, user: address, onBehalfOf: address, amount: uint256, interestRateMode: uint8, borrowRate: uint256, referralCode: uint16)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset being borrowed |
| user | address | The address of the user initiating the borrow(), receiving the funds on borrow() or just initiator of the transaction on flashLoan() | |
| onBehalfOf | address | ✓ | The address that will be getting the debt |
| amount | uint256 | The amount borrowed out | |
| interestRateMode | uint8 | The rate mode: 2 for Variable, 1 is deprecated (changed on v3.2.0) | |
| borrowRate | uint256 | The numeric rate at which the user has borrowed, expressed in ray | |
| referralCode | uint16 | ✓ | The referral code used |
DeficitCovered(reserve: address, caller: address, amountCovered: uint256)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset of the reserve |
| caller | address | The caller that triggered the DeficitCovered event | |
| amountCovered | uint256 | The amount of deficit covered |
DeficitCreated(user: address, debtAsset: address, amountCreated: uint256)
| Name | Type | Indexed | Description |
|---|---|---|---|
| user | address | ✓ | The user address where the bad debt will be burned |
| debtAsset | address | ✓ | The address of the underlying borrowed asset to be burned |
| amountCreated | uint256 | The amount of deficit created |
FlashLoan(target: address, initiator: address, asset: address, amount: uint256, interestRateMode: uint8, premium: uint256, referralCode: uint16)
| Name | Type | Indexed | Description |
|---|---|---|---|
| target | address | ✓ | The address of the flash loan receiver contract |
| initiator | address | The address initiating the flash loan | |
| asset | address | ✓ | The address of the asset being flash borrowed |
| amount | uint256 | The amount flash borrowed | |
| interestRateMode | uint8 | The flashloan mode: 0 for regular flashloan, 1 for Stable (Deprecated on v3.2.0), 2 for Variable | |
| premium | uint256 | The fee flash borrowed | |
| referralCode | uint16 | ✓ | The referral code used |
IsolationModeTotalDebtUpdated(asset: address, totalDebt: uint256)
| Name | Type | Indexed | Description |
|---|---|---|---|
| asset | address | ✓ | The address of the underlying asset of the reserve |
| totalDebt | uint256 | The total isolation mode debt for the reserve |
LiquidationCall(collateralAsset: address, debtAsset: address, user: address, debtToCover: uint256, liquidatedCollateralAmount: uint256, liquidator: address, receiveAToken: bool)
| Name | Type | Indexed | 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 | |
| liquidatedCollateralAmount | uint256 | The amount of collateral received by the liquidator | |
| liquidator | address | The address of the liquidator | |
| receiveAToken | bool | True if the liquidators wants to receive the collateral aTokens, `false` if he wants to receive the underlying collateral asset directly |
MintedToTreasury(reserve: address, amountMinted: uint256)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the reserve |
| amountMinted | uint256 | The amount minted to the treasury |
PositionManagerApproved(user: address, positionManager: address)
| Name | Type | Indexed | Description |
|---|---|---|---|
| user | address | ✓ | The user address |
| positionManager | address | ✓ | The address of the position manager |
PositionManagerRevoked(user: address, positionManager: address)
| Name | Type | Indexed | Description |
|---|---|---|---|
| user | address | ✓ | The user address |
| positionManager | address | ✓ | The address of the position manager |
Repay(reserve: address, user: address, repayer: address, amount: uint256, useATokens: bool)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset of the reserve |
| user | address | ✓ | The beneficiary of the repayment, getting his debt reduced |
| repayer | address | ✓ | The address of the user initiating the repay(), providing the funds |
| amount | uint256 | The amount repaid | |
| useATokens | bool | True if the repayment is done using aTokens, `false` if done with underlying asset directly |
ReserveDataUpdated(reserve: address, liquidityRate: uint256, stableBorrowRate: uint256, variableBorrowRate: uint256, liquidityIndex: uint256, variableBorrowIndex: uint256)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset of the reserve |
| liquidityRate | uint256 | The next liquidity rate | |
| stableBorrowRate | uint256 | The next stable borrow rate @note deprecated on v3.2.0 | |
| variableBorrowRate | uint256 | The next variable borrow rate | |
| liquidityIndex | uint256 | The next liquidity index | |
| variableBorrowIndex | uint256 | The next variable borrow index |
ReserveUsedAsCollateralDisabled(reserve: address, user: address)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset of the reserve |
| user | address | ✓ | The address of the user enabling the usage as collateral |
ReserveUsedAsCollateralEnabled(reserve: address, user: address)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset of the reserve |
| user | address | ✓ | The address of the user enabling the usage as collateral |
Supply(reserve: address, user: address, onBehalfOf: address, amount: uint256, referralCode: uint16)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset of the reserve |
| user | address | The address initiating the supply | |
| onBehalfOf | address | ✓ | The beneficiary of the supply, receiving the aTokens |
| amount | uint256 | The amount supplied | |
| referralCode | uint16 | ✓ | The referral code used |
UserEModeSet(user: address, categoryId: uint8)
| Name | Type | Indexed | Description |
|---|---|---|---|
| user | address | ✓ | The address of the user |
| categoryId | uint8 | The category id |
Withdraw(reserve: address, user: address, to: address, amount: uint256)
| Name | Type | Indexed | Description |
|---|---|---|---|
| reserve | address | ✓ | The address of the underlying asset being withdrawn |
| user | address | ✓ | The address initiating the withdrawal, owner of aTokens |
| to | address | ✓ | The address that will receive the underlying |
| amount | uint256 | The amount to be withdrawn |