Aave Address Book

An up-to-date registry of all Aave ecosystem smart contract addresses for use in Solidity and JavaScript/TypeScript projects.

🔍 Search addresses online

Installation

Foundry

forge install aave-dao/aave-address-book

Node.js

npm install @aave-dao/aave-address-book

Usage

Solidity

import { AaveV3Ethereum } from "aave-address-book/AaveV3Ethereum.sol";
import { AaveV2Avalanche } from "aave-address-book/AaveV2Avalanche.sol";
import { AaveGovernanceV2 } from "aave-address-book/AaveGovernanceV2.sol";

contract Example {
  function execute() external {
    address pool = AaveV3Ethereum.POOL;
    // ...
  }
}

JavaScript/TypeScript

import { AaveV3Ethereum, AaveV2Avalanche } from "@aave-dao/aave-address-book";

console.log(AaveV3Ethereum.POOL); // "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2"
console.log(AaveV3Ethereum.CHAIN_ID); // 1

Development

Generate addresses

The library uses a collection of scripts to fetch addresses from various on-chain registries.

npm run generate:addresses

Build

npm run build
forge build

Test

The library includes a suite of tests that can be run using the following commands:

npm test
forge test

The node test suite is a collection of sanity tests, that ensure that view functions return the expected values (e.g. the correct pool is being configured in a given factory). In addition to that there is a verification suite that ensures that all the addresses listed on address book, are verified on our preferred explorers.

Adding a new pool

1. Add pool configuration in scripts/configs/<type>/<network>
2. Run npm run generate:addresses
3. Commit the generated files

Configuration

Create a .env file for reliable RPC connections:

ETHERSCAN_API_KEY=your_key_here
EXPLORER_PROXY=your_proxy

## RPC configuration
# Per default the package uses the public rpcs available via viem
# You can opt in to use private/different rpcs by setting the following environment variables
RPC_<NETWORK>=your_rpc_url
ALCHEMY_API_KEY=your_key_here
QUICKNODE_ENDPOINT_NAME=your_quicknode_endpoint_name
QUICKNODE_TOKEN=your_quicknode_token

UI

The interactive UI can be found in ui package. The UI is a React application that is compiled as static build, so it can be hosted on github pages. You can fine an instance of the UI at search.onaave.com

Resources

• Raycast Extension - Quick address lookup
• Web Search - Browse all addresses

License

MIT

Maintained by BGD Labs