Aave V3 Incentives Contracts

The UiIncentiveDataProvider provides methods to query all active incentive emissions, and claimable user incentives for a particular Aave market.

RewardsController

RewardsController is the main rewards contract, where users claim the ERC-20 rewards of their positions. It inherits from the abstract RewardsDistributor, which handles reward distribution. Holders of incentivized ERC-20 assets accrue rewards just by holding them, with no staking or locking.

The users can claim all the rewards or an individual reward per transaction, with a variety of functions that allow more granularity at claim.

The source code is available on GitHub.

Write Methods

initialize

function initialize(address) external initializer

Initialize RewardsController instance.

Input Parameters:

configureAssets

function configureAssets(RewardsDataTypes.RewardsConfigInput[] memory config) external override onlyEmissionManager

Configure assets to incentivize with an emission of rewards per second until the end of distribution.

Input Parameters:

The RewardsDataTypes.RewardsConfigInput struct is composed of the following fields:

setTransferStrategy

function setTransferStrategy(address reward, ITransferStrategyBase transferStrategy) external onlyEmissionManager

Sets a TransferStrategy logic contract that determines the logic of the rewards transfer.

Input Parameters:

setRewardOracle

function setRewardOracle(address reward, AggregatorInterface rewardOracle) external onlyEmissionManager

Sets an Aave Oracle contract to enforce rewards with a source of value.

At the moment of reward configuration, the Incentives Controller performs a check to see if the reward asset oracle follows the Chainlink AggregatorInterface and returns a positive latestAnswer(). This check is enforced for integrators to show incentives at the current Aave UI without needing to set up an external price registry.

Input Parameters:

handleAction

function handleAction(address user, uint256 totalSupply, uint256 userBalance) external override

Called by the corresponding asset on transfer hook to update the rewards distribution of a user.

Input Parameters:

claimRewards

function claimRewards(
    address[] calldata assets,
    uint256 amount,
    address to,
    address reward
) external override returns (uint256)

Claims reward for a user to the desired address, on all the assets of the pool, accumulating the pending rewards. Rewards are received by the to address.

Input Parameters:

Return Values:

claimRewardsOnBehalf

function claimRewardsOnBehalf(
    address[] calldata assets,
    uint256 amount,
    address user,
    address to,
    address reward
) external override onlyAuthorizedClaimers(msg.sender, user) returns (uint256)

Claims rewards for a user on behalf, on all the assets of the pool, accumulating the pending rewards of the assets passed by the first argument. The caller must be set as claimer for user via setClaimer() by the EmissionManager. Rewards are received by the to address.

Input Parameters:

Return Values:

claimRewardsToSelf

function claimRewardsToSelf(address[] calldata assets, uint256 amount, address reward) external override returns (uint256)

Claims reward for msg.sender, on all the assets of the pool, accumulating the pending rewards passed by the first input parameter. Rewards are received by msg.sender.

Input Parameters:

Return Values:

claimAllRewards

function claimAllRewards(address[] calldata assets, address to) external override returns (address[] memory rewardsList, uint256[] memory claimedAmounts)

Claims all rewards for a user to the desired address, on all the assets of the pool, accumulating the pending rewards passed by the first input parameter. Rewards are received by the to address.

Input Parameters:

Return Values:

claimAllRewardsOnBehalf

function claimAllRewardsOnBehalf(
    address[] calldata assets,
    address user,
    address to
) external override onlyAuthorizedClaimers(msg.sender, user) returns (address[] memory rewardsList, uint256[] memory claimedAmounts)

Claims all rewards for a user on behalf, on all the assets of the pool, accumulating the pending rewards passed by the first input parameter. The caller must be set as claimer for user via setClaimer() by the EmissionManager. Rewards are received by the to address.

Input Parameters:

Return Values:

claimAllRewardsToSelf

function claimAllRewardsToSelf(address[] calldata assets) external override returns (address[] memory rewardsList, uint256[] memory claimedAmounts)

Claims all rewards accrued by msg.sender, on all assets of the pool, accumulating the pending rewards by the first input parameter. Rewards are received by msg.sender.

Input Parameters:

Return Values:

setClaimer

function setClaimer(address user, address caller) external override onlyEmissionManager

Whitelists an address to claim rewards on behalf of another address. Can only be called by the EmissionManager.

Input Parameters:

View Methods

getClaimer

function getClaimer(address user) external view override returns (address)

Returns the whitelisted claimer for a certain address. It returns the 0x0 address if it is not set.

Input Parameters:

Return Values:

getRewardOracle

function getRewardOracle(address reward) external view override returns (address)

Get the price aggregator oracle address.

Input Parameters:

Return Values:

getTransferStrategy

function getTransferStrategy(address reward) external view override returns (address)

Returns the Transfer Strategy implementation contract address being used for a reward address.

Input Parameters:

Return Values: