aave_v3.reserve

Documentation for eth_defi.aave_v3.reserve Python module.

Reserve, TVL and interest data reading of pools.

• Reads Aave reserves metrics data on-chain from a certain timestamp/block number

• Relies on a lot of undocumented Aave v3 source code to pull out the data

• Based on

  • https://github.com/aave/aave-utilities

  • https://github.com/aave/aave-utilities/tree/master/packages/contract-helpers/src/v3-UiPoolDataProvider-contract

  • https://github.com/aave/aave-v3-periphery/blob/master/contracts/misc/UiPoolDataProviderV3.sol

  • https://github.com/aave/aave-ui/blob/f34f1cfc4fa6c1128b31eaa70b37b5b2109d1dc5/src/libs/pool-data-provider/hooks/use-v2-protocol-data-with-rpc.tsx#L62

  • https://github.com/aave/aave-utilities/blob/664e92b5c7710e8060d4dcac5d6c0ebb48bb069f/packages/math-utils/src/formatters/user/index.ts#L95

  • https://github.com/aave/aave-utilities/blob/664e92b5c7710e8060d4dcac5d6c0ebb48bb069f/packages/math-utils/src/formatters/reserve/index.ts#L310

Functions

fetch_aave_reserves_snapshot(web3[, ...])	Get a snapshot of all data of Aave reserves at a certain point of time.
fetch_reserve_data(contracts[, block_identifier])	Fetch data for all reserves.
fetch_reserves(contracts[, block_identifier])	Enumerate available reserves.
get_helper_contracts(web3)	Get helper contracts need to read Aave reserve data.

Classes

AggregatedReserveData	Rough mapping of AggreatedReserveData in Aave v3 Solidity source code.
BaseCurrencyInfo	Rough mapping of BaseCurrencyInfo in Aave v3 Solidity source code.
HelperContracts	Contracts needed to resolve reserve info on Aave v3.
JSONSerialisableReserveData	JSON friendly way to store Aave v3 protocol reserve status.

Exceptions

AaveContractsNotConfigured

We lack hardcoded data of Aave contract addresses for a particular chain.