Aave V3 View Contracts

The Aave Protocol has several view contracts to assist with querying onchain data.

UiPoolDataProvider

Contract that returns an array of all reserve or user data for a particular market (for example, liquidity, token addresses, rate strategy), used by the Aave Interface to display Markets and Dashboard data.

To fetch the same reserve and user data already formatted for frontends, use AaveKit.

The source code is available on GitHub.

getReservesList

function getReservesList(IPoolAddressesProvider provider) public view override returns (address[] memory)

Returns the list of initialized reserves in the Pool associated with the given provider.

Input Parameters:

Return Values:

getReservesData

function getReservesData(IPoolAddressesProvider provider) public view override returns (AggregatedReserveData[] memory, BaseCurrencyInfo memory)

Returns BaseCurrencyInfo of the Pool and AggregatedReserveData[] for all the initialized reserves in the Pool associated with the given provider.

Input Parameters:

Return Values:

The BaseCurrencyInfo struct is composed of the following fields:

The AggregatedReserveData struct is composed of the following fields:

getUserReservesData

function getUserReservesData(IPoolAddressesProvider provider, address user) external view override returns (UserReserveData[] memory, uint8)

Returns UserReserveData[] for all user reserves in the Pool associated with the given provider.

Input Parameters:

Return Values:

The UserReserveData struct is composed of the following fields:

getEModes

Returns an array of all available E-Mode categories in the Pool associated with the provider.

function getEModes(IPoolAddressesProvider provider) external view returns (Emode[] memory)

Input Parameters:

Return Values:

Emode

The Emode struct is composed of the following fields:

DataTypes.EModeCategory

The EModeCategory struct is composed of the following fields:

WalletBalanceProvider

Fetches tokens balances for all underlying tokens of Aave reserves for one user address.

For getting ETH (native chain token) balance use MOCK_ETH_ADDRESS = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE.

The source code is available on GitHub.

balanceOf

function balanceOf(address user, address token) public view returns (uint256)

Checks the token balance of a wallet in a token contract. Returns the balance of the token for user (ETH included with MOCK_ETH_ADDRESS).

Input Parameters:

Return Values:

batchBalanceOf

function batchBalanceOf(address[] calldata users, address[] calldata tokens) external view returns (uint256[] memory)

Returns balances for a list of users and tokens (ETH included with MOCK_ETH_ADDRESS).

Input Parameters:

Return Values:

getUserWalletBalances

function getUserWalletBalances(address provider, address user) external view returns (address[] memory, uint256[] memory)

Provides balances of user wallet for all reserves available on the pool.

Input Parameters:

Return Values:

UiIncentiveDataProviderV3

Contract that returns an array of all reserve incentives or user claimable rewards within a particular market, used by the Aave Labs Interface to display incentives data.

To fetch incentives and claimable rewards already formatted for frontends, use AaveKit.

The source code is available on GitHub.

getFullReservesIncentiveData

function getFullReservesIncentiveData(IPoolAddressesProvider provider, address user)
    external
    view
    override
    returns (AggregatedReserveIncentiveData[] memory, UserReserveIncentiveData[] memory)

Returns both AggregatedReserveIncentiveData[] and UserReserveIncentiveData[] for the given user for the pool associated with the given provider.

Input Parameters:

Return Values:

The AggregatedReserveIncentiveData struct is composed of the following fields:

The UserReserveIncentiveData struct is composed of the following fields:

getReservesIncentivesData

function getReservesIncentivesData(IPoolAddressesProvider provider) external view override returns (AggregatedReserveIncentiveData[] memory)

Returns AggregatedReserveIncentiveData[] for the pool associated with the given provider.

Input Parameters:

Return Values:

The AggregatedReserveIncentiveData struct is composed of the following fields:

getUserReservesIncentivesData

function getUserReservesIncentivesData(IPoolAddressesProvider provider, address user) external view override returns (UserReserveIncentiveData[] memory)

Returns the UserReserveIncentiveData[] for the given user for the pool associated with the given provider.

Input Parameters:

Return Values:

The UserReserveIncentiveData struct is composed of the following fields:

AaveProtocolDataProvider

The AaveProtocolDataProvider is a peripheral contract to collect and pre-process information from the Pool. This contract contains methods for querying token addresses, reserve parameters, and user account information. The methods of the PoolDataProvider are more granular than the UiPoolDataProvider, which queries data for reserve tokens or user balances simultaneously.

The source code is available on GitHub.

getAllReservesTokens

function getAllReservesTokens() external view returns (TokenData[] memory)

Returns a list of the existing reserves in the pool, pairs include the symbol and tokenAddress. Handles MKR and ETH in a different way since they do not have standard symbol functions.

Return Values:

The TokenData struct is composed of the following fields:

getAllATokens

function getAllATokens() external view returns (TokenData[] memory)

Returns a list of the existing ATokens in the pool, pairs include the symbol and tokenAddress.

Return Values:

The TokenData struct is composed of the following fields:

getReserveConfigurationData

function getReserveConfigurationData(address asset) external view returns (
    uint256 decimals,
    uint256 ltv,
    uint256 liquidationThreshold,
    uint256 liquidationBonus,
    uint256 reserveFactor,
    bool usageAsCollateralEnabled,
    bool borrowingEnabled,
    bool stableBorrowRateEnabled,
    bool isActive,
    bool isFrozen
)

Returns the configuration data of the reserve as described below. Does not return borrow and supply caps, nor pause flag for compatibility.

Input Parameters:

Return Values:

getReserveCaps

function getReserveCaps(address asset) external view returns (uint256 borrowCap, uint256 supplyCap)

Returns the caps parameters of the reserve.

Input Parameters:

Return Values:

getPaused

function getPaused(address asset) external view returns (bool isPaused)

Returns true if the reserve is paused.

Input Parameters:

Return Values:

getSiloedBorrowing

function getSiloedBorrowing(address asset) external view override returns (bool)

Returns the siloed borrowing flag. It returns true if the asset is siloed for borrowing.

Input Parameters:

Return Values:

getLiquidationProtocolFee

function getLiquidationProtocolFee(address asset) external view override returns (uint256)

Returns the protocol fee on the liquidation bonus.

Input Parameters:

Return Values:

getUnbackedMintCap

function getUnbackedMintCap(address asset) external view override returns (uint256)

Returns the unbacked mint cap of the reserve.

Input Parameters:

Return Values:

getDebtCeiling

function getDebtCeiling(address asset) external view override returns (uint256)

Returns the debt ceiling of the reserve.

Input Parameters:

Return Values:

getReserveData

function getReserveData(address asset) external view override returns (
    uint256 unbacked,
    uint256 accruedToTreasuryScaled,
    uint256 totalAToken,
    uint256 totalStableDebt,
    uint256 totalVariableDebt,
    uint256 liquidityRate,
    uint256 variableBorrowRate,
    uint256 stableBorrowRate,
    uint256 averageStableBorrowRate,
    uint256 liquidityIndex,
    uint256 variableBorrowIndex,
    uint40 lastUpdateTimestamp
)

Returns the reserve data.

Input Parameters:

Return Values:

getATokenTotalSupply

function getATokenTotalSupply(address asset) external view override returns (uint256)

Returns the total supply of aTokens for a given asset.

Input Parameters:

Return Values:

getTotalDebt

function getTotalDebt(address asset) external view override returns (uint256)

Returns the total debt for a given asset.

Input Parameters:

Return Values:

getUserReserveData

function getUserReserveData(address asset, address user) external view returns (
    uint256 currentATokenBalance,
    uint256 currentStableDebt,
    uint256 currentVariableDebt,
    uint256 principalStableDebt,
    uint256 scaledVariableDebt,
    uint256 stableBorrowRate,
    uint256 liquidityRate,
    uint40 stableRateLastUpdated,
    bool usageAsCollateralEnabled
)

Returns the following user reserve data.

Input Parameters:

Return Values:

getReserveTokensAddresses

function getReserveTokensAddresses(address asset) external view override returns (
    address aTokenAddress,
    address stableDebtTokenAddress,
    address variableDebtTokenAddress
)

Returns the addresses of the aToken, stableDebtToken and variableDebtToken of the reserve.

Input Parameters:

Return Values:

getInterestRateStrategyAddress

function getInterestRateStrategyAddress(address asset) external view override returns (address irStrategyAddress)

Returns the address of the Interest Rate strategy.

Input Parameters:

Return Values:

getReserveDeficit

Returns the current deficit of the reserve.

function getReserveDeficit(address asset) external view override returns (uint256)

Input Parameters:

Return Values:

getDebtCeilingDecimals

function getDebtCeilingDecimals() external pure override returns (uint256)

Returns the debt ceiling decimals.

Return Values:

LiquidationDataProvider

This contract is a utility for fetching and pre-processing liquidation-related parameters for a given user. It aggregates data from the underlying Pool and Price Oracle to determine a user’s position, collateral, borrow details, and liquidation limits according to the protocol parameters.

The source code is available on GitHub.

getUserPositionFullInfo

function getUserPositionFullInfo(address user) public view override returns (UserPositionFullInfo memory)

Returns aggregated position information for a user including total collateral, total debt, available borrows, current liquidation threshold, loan-to-value (LTV), and health factor. All values are denominated in the base currency.

Input Parameters:

Return Values:

The UserPositionFullInfo struct is composed of the following fields:

getCollateralFullInfo

function getCollateralFullInfo(address user, address collateralAsset) external view override returns (CollateralFullInfo memory)

Returns detailed information regarding a user’s collateral for a given asset. The returned struct includes the asset’s unit (based on decimals), its current price (via the Price Oracle), the associated aToken address, the raw collateral balance, and its equivalent value in the base currency.

Input Parameters:

Return Values:

The CollateralFullInfo struct is composed of the following fields:

getDebtFullInfo

function getDebtFullInfo(address user, address debtAsset) external view override returns (DebtFullInfo memory)

Returns detailed information regarding a user’s debt for a given asset. The returned struct includes the asset’s unit, current price, the associated variable debt token address, the debt balance, and its equivalent value in the base currency.

Input Parameters:

Return Values:

The DebtFullInfo struct is composed of the following fields:

getLiquidationInfo (without custom debt amount)

function getLiquidationInfo(address user, address collateralAsset, address debtAsset) public view override returns (LiquidationInfo memory)

A convenience function that returns liquidation parameters for a user using the maximum possible debt liquidation amount. Internally, it calls the overloaded version with debtLiquidationAmount set to the maximum (type(uint256).max).

Input Parameters:

Return Values:

The LiquidationInfo struct is composed of the following fields:

getLiquidationInfo (with custom debt liquidation amount)

function getLiquidationInfo(address user, address collateralAsset, address debtAsset, uint256 debtLiquidationAmount) public view override returns (LiquidationInfo memory)

Returns comprehensive liquidation parameters for a user given a specific collateral asset and debt asset, considering a custom maximum debt liquidation amount. The function aggregates the user’s position, collateral and debt details, checks if liquidation conditions are met, and computes the optimal amounts for liquidation, including any applicable protocol fees.

Input Parameters:

Return Values:

The LiquidationInfo struct is composed of the following fields: