Rewards Claiming Flow¶

End-to-end execution flow for claiming rewards from Aave V3 RewardsController.

Quick Reference¶

Aspect	Details
Entry Points	`claimRewards`, `claimRewardsOnBehalf`, `claimRewardsToSelf`, `claimAllRewards`, `claimAllRewardsOnBehalf`, `claimAllRewardsToSelf`
Key Transformations	`Reward Index Updates`
State Changes	`_assets[asset].rewards[reward].usersData[user].accrued -= amount`
Events Emitted	`RewardsClaimed`

Flow Diagram¶

flowchart TD
    %% Styling definitions
    classDef validation fill:#ffcccc,stroke:#ff0000,stroke-width:2px
    classDef transformation fill:#ccffcc,stroke:#00aa00,stroke-width:2px
    classDef storage fill:#ccccff,stroke:#0000ff,stroke-width:2px
    classDef event fill:#ffffcc,stroke:#aaaa00,stroke-width:2px
    classDef error fill:#ff0000,stroke:#000000,color:#fff
    classDef critical stroke:#ff0000,stroke-width:3px

    %% Entry points
    Entry1["claimRewards / claimRewardsToSelf"] --> ValidateTo1["VALIDATION<br/>to != address"]
    Entry2["claimRewardsOnBehalf"] --> ValidateUser["VALIDATION<br/>claimer authorized<br/>user != address"]
    Entry3["claimAllRewards / claimAllRewardsToSelf"] --> ValidateTo2["VALIDATION<br/>to != address"]
    Entry4["claimAllRewardsOnBehalf"] --> ValidateUser2["VALIDATION<br/>claimer authorized<br/>user != address"]
    
    class ValidateTo1 validation
    class ValidateUser validation
    class ValidateTo2 validation
    class ValidateUser2 validation
    
    ValidateTo1 --> GetBalances["_getUserAssetBalances<br/>Get scaled balances<br/>for all assets"]
    ValidateUser --> GetBalances
    ValidateTo2 --> GetBalances
    ValidateUser2 --> GetBalances
    
    subgraph DataUpdate ["1. Data Update Phase"]
        direction TB
        UpdateData["_updateDataMultiple<br/>Iterate all assets"] --> UpdateAsset["For each asset:<br/>_updateData"]
        
        UpdateAsset --> UpdateReward["TRANSFORMATION<br/>_updateRewardData<br/>Calculate new index<br/>based on time delta"]
        class UpdateReward transformation
        
        UpdateReward --> UpdateUser["TRANSFORMATION<br/>_updateUserData<br/>Calculate accrued rewards"]
        class UpdateUser transformation
        
        UpdateUser --> StoreAccrued["STORAGE UPDATE<br/>usersData[user].accrued +=<br/>rewardsAccrued"]
        class StoreAccrued storage
        
        StoreAccrued --> EmitAccrued["EMIT<br/>Accrued"]
        class EmitAccrued event
    end
    
    GetBalances --> DataUpdate
    
    subgraph ClaimCalc ["2. Claim Calculation Phase"]
        direction TB
        
        SingleReward{"Single or<br/>All Rewards?"}
        
        SingleReward -->|Single| SumAccrued["Sum accrued rewards<br/>across all assets<br/>for specific reward"]
        SingleReward -->|All| IterateRewards["Iterate all rewards<br/>across all assets"]
        
        SumAccrued --> AmountCheck{"amount == 0?"}
        class AmountCheck validation
        
        AmountCheck -->|Yes| ReturnZero["Return 0"]
        AmountCheck -->|No| CheckLimit{"totalRewards ><br/>requested amount?"}
        
        CheckLimit -->|total <= amount| ClearAll["STORAGE UPDATE<br/>accrued = 0<br/>for all assets"]
        class ClearAll storage
        
        CheckLimit -->|total > amount| PartialClaim["Calculate difference<br/>STORAGE UPDATE<br/>accrued = difference"]
        class PartialClaim storage
        
        IterateRewards --> AccumulateAll["Accumulate all<br/>reward amounts<br/>per reward token"]
        AccumulateAll --> ClearAllMulti["STORAGE UPDATE<br/>accrued = 0<br/>for claimed amounts"]
        class ClearAllMulti storage
    end
    
    DataUpdate --> SingleReward
    
    subgraph TransferPhase ["3. Reward Transfer Phase"]
        direction TB
        
        CheckZero{"totalRewards<br/>== 0?"}
        class CheckZero validation
        
        CheckZero -->|Yes| ReturnZero2["Return 0"]
        CheckZero -->|No| GetStrategy["Get TransferStrategy<br/>for reward token"]
        
        GetStrategy --> PerformTransfer["_transferRewards<br/>delegatecall to<br/>TransferStrategy"]
        
        PerformTransfer --> TransferSuccess{"Transfer<br/>successful?"}
        class TransferSuccess validation
        
        TransferSuccess -->|No| RevertError["REVERT<br/>TRANSFER_ERROR"]
        class RevertError error
        
        TransferSuccess -->|Yes| EmitClaimed["EMIT<br/>RewardsClaimed"]
        class EmitClaimed event
    end
    
    ClearAll --> CheckZero
    PartialClaim --> CheckZero
    ClearAllMulti --> CheckZero
    
    %% Single reward transfer vs All rewards transfer
    SingleReward -.->|All| MultiTransfer["Loop through<br/>all reward tokens<br/>_transferRewards each"]
    MultiTransfer --> EmitClaimed
    
    EmitClaimed --> ReturnAmount["Return<br/>claimed amount(s)"]

Step-by-Step Execution¶

1. Entry Points¶

File: contracts/rewards/RewardsController.sol

function claimRewards(
    address[] calldata assets,
    uint256 amount,
    address to,
    address reward
) external override returns (uint256) {
    require(to != address(0), 'INVALID_TO_ADDRESS');
    return _claimRewards(assets, amount, msg.sender, msg.sender, to, reward);
}

function claimRewardsOnBehalf(
    address[] calldata assets,
    uint256 amount,
    address user,
    address to,
    address reward
) external override onlyAuthorizedClaimers(msg.sender, user) returns (uint256) {
    require(user != address(0), 'INVALID_USER_ADDRESS');
    require(to != address(0), 'INVALID_TO_ADDRESS');
    return _claimRewards(assets, amount, msg.sender, user, to, reward);
}

function claimRewardsToSelf(
    address[] calldata assets,
    uint256 amount,
    address reward
) external override returns (uint256) {
    return _claimRewards(assets, amount, msg.sender, msg.sender, msg.sender, reward);
}

function claimAllRewards(address[] calldata assets, address to)
    external
    override
    returns (address[] memory rewardsList, uint256[] memory claimedAmounts)
{
    require(to != address(0), 'INVALID_TO_ADDRESS');
    return _claimAllRewards(assets, msg.sender, msg.sender, to);
}

function claimAllRewardsOnBehalf(
    address[] calldata assets,
    address user,
    address to
)
    external
    override
    onlyAuthorizedClaimers(msg.sender, user)
    returns (address[] memory rewardsList, uint256[] memory claimedAmounts)
{
    require(user != address(0), 'INVALID_USER_ADDRESS');
    require(to != address(0), 'INVALID_TO_ADDRESS');
    return _claimAllRewards(assets, msg.sender, user, to);
}

function claimAllRewardsToSelf(address[] calldata assets)
    external
    override
    returns (address[] memory rewardsList, uint256[] memory claimedAmounts)
{
    return _claimAllRewards(assets, msg.sender, msg.sender, msg.sender);
}