Aave V3 Pool Addresses Provider

The PoolAddressesProvider contract is the main registry of addresses that are part of, or connected to the Protocol, including permissioned roles. It acts as a factory of proxies and is the admin of those, and therefore has the right to change its implementations.

The addresses provider manages various protocol modules and has the ability to update pointers (e.g. update the ACLManager contract) or update the implementation of proxy contracts (e.g. update the Pool implementation).

It stores the ACL admin, which receives DEFAULT_ADMIN_ROLE when the ACLManager is deployed.

Always fetch the Pool address from this PoolAddressesProvider contract.

The source code is available on GitHub.

This contract is owned by the Aave Governance.

Write Methods

setMarketId

Solidity

function setMarketId(string memory newMarketId) external override onlyOwner

Updates the identifier of the Aave market by associating an id with a specific PoolAddressesProvider. This can be used to create an on-chain registry of pool addresses providers to identify and validate multiple Aave markets.

Input Parameters:

Name	Type	Description
newMarketId	`string`	The new id of the market

setAddress

Solidity

function setAddress(bytes32 id, address newAddress) external override onlyOwner

Sets the address of the protocol contract stored at the given id, replacing the address saved in the addresses map.

For example, utils.keccak256(utils.toUtf8Bytes("INCENTIVES_CONTROLLER")), is set to the address of INCENTIVES_CONTROLLER.

This hard-replaces the current address in the addresses map. Use it carefully.

Input Parameters:

Name	Type	Description
id	`bytes32`	A bytes32 identifier, e.g. `bytes32('POOL')` for core contracts or `keccak256('INCENTIVES_CONTROLLER')` for custom entries
newAddress	`address`	The new address to be set corresponding to the id

setAddressAsProxy

Solidity

function setAddressAsProxy(bytes32 id, address newImplementationAddress) external override onlyOwner

Updates the implementation address of a proxy contract with a specified id.

If there is no proxy registered, it will instantiate one and set the implementation as the newImplementationAddress.

Use only for ids without an explicit setter function, to avoid unexpected results.

Input Parameters:

Name	Type	Description
id	`bytes32`	The id of the proxy contract
newImplementationAddress	`address`	The address of new implementation contract corresponding to the proxy

setPoolImpl

Solidity

function setPoolImpl(address newPoolImpl) external override onlyOwner

Updates the implementation of the Pool contract, or creates a proxy.

Input Parameters:

Name	Type	Description
newPoolImpl	`address`	The address of new `Pool` implementation contract

setPoolConfiguratorImpl

Solidity

function setPoolConfiguratorImpl(address newPoolConfiguratorImpl) external override onlyOwner

Updates the implementation of the PoolConfigurator contract, or creates a proxy.

Input Parameters:

Name	Type	Description
newPoolConfiguratorImpl	`address`	The address of new PoolConfigurator implementation contract

setPriceOracle

Solidity

function setPriceOracle(address newPriceOracle) external override onlyOwner

Updates the address of the price oracle.

Input Parameters:

Name	Type	Description
newPriceOracle	`address`	The address of new price oracle

setACLManager

Solidity

function setACLManager(address newAclManager) external override onlyOwner

Updates the address of the Access Control List Manager.

Input Parameters:

Name	Type	Description
newAclManager	`address`	The address of the new ACLManager

setACLAdmin

Solidity

function setACLAdmin(address newAclAdmin) external override onlyOwner

Updates the address of the Access Control List Admin.

Input Parameters:

Name	Type	Description
newAclAdmin	`address`	The address of new ACLAdmin

setPriceOracleSentinel

Solidity

function setPriceOracleSentinel(address newPriceOracleSentinel) external override onlyOwner

Updates the address of the price oracle sentinel. Since Aave V3.7 the Pool no longer reads this address, so it has no effect on borrows or liquidations.

Input Parameters:

Name	Type	Description
newPriceOracleSentinel	`address`	The address of new PriceOracleSentinel

setPoolDataProvider

Solidity

function setPoolDataProvider(address newDataProvider) external override onlyOwner

Updates the address of the data provider.

Input Parameters:

Name	Type	Description
newDataProvider	`address`	The address of new DataProvider

View Methods

getMarketId

Solidity

function getMarketId() external view override returns (string memory)

Returns the market id of the associated Aave market.

Return Values:

Type	Description
`string`	A string representation of the market id

getAddress

Solidity

function getAddress(bytes32 id) public view override returns (address)

Returns the address of protocol contract stored at the given id. The returned address might be an EOA or a contract, which may be proxied. It will return ZERO if there is no registered address with the given id.

Input Parameters:

Name	Type	Description
id	`bytes32`	The id. For example, the Protocol Data Provider uses `bytes32('DATA_PROVIDER')`

Return Values:

Type	Description
`address`	The address associated with the id passed

Example:

TypeScript

import { Contract, getDefaultProvider, keccak256, toUtf8Bytes } from "ethers";

const poolAddressesProvider = new Contract(
  "0x2f39d218133AFaB8F2B819B1066c7E434Ad94E9e",
  ["function getAddress(bytes32 id) view returns (address)"],
  getDefaultProvider()
);

const address = await poolAddressesProvider.getAddress(
  keccak256(toUtf8Bytes("INCENTIVES_CONTROLLER"))
);

getPool

Solidity

function getPool() external view override returns (address)

Returns the address of the latest Pool proxy contract.

Return Values:

Type	Description
`address`	The address of the associated Pool proxy

getPoolConfigurator

Solidity

function getPoolConfigurator() external view override returns (address)

Returns the address of the PoolConfigurator proxy. Used for configuration methods, like init reserves or update token implementation etc, of the market.

Return Values:

Type	Description
`address`	The PoolConfigurator proxy address

getPriceOracle

Solidity

function getPriceOracle() external view override returns (address)

Returns the address of the Price Oracle used by the market.

Return Values:

Type	Description
`address`	The address of the price oracle used by the associated market

getACLManager

Solidity

function getACLManager() external view override returns (address)

Returns the address of the Access Control List Manager (ACLManager) that manages the system role of the market.

Return Values:

Type	Description
`address`	The address of the ACLManager contract managing the system role of the associated market

getACLAdmin

Solidity

function getACLAdmin() external view override returns (address)

Returns the address of the Access Control List Admin (ACLAdmin) of the market which holds the DEFAULT_ADMIN_ROLE in ACLManager.

Return Values:

Type	Description
`address`	The address of the Access Control List admin of the associated market

getPriceOracleSentinel

Solidity

function getPriceOracleSentinel() external view override returns (address)

Returns the address of the price oracle sentinel. Since Aave V3.7 the Pool no longer uses it.

Return Values:

Type	Description
`address`	The address of the PriceOracleSentinel of the associated market

getPoolDataProvider

Solidity

function getPoolDataProvider() external view override returns (address)

Returns the address of latest pool data provider.

Return Values:

Type	Description
`address`	The address of the pool data provider of the associated market