Pause the incentives contract (emergency admin function)

When paused, users cannot claim rewards. Admin functions remain available. Rewards continue through handle_action_with_balances, but claims are blocked.

Arguments

• caller: Must be emission_manager

Unpause the incentives contract (emergency admin function)

Arguments

• caller: Must be emission_manager

Upgrade contract WASM. Only the stored upgrade admin can authorize this.

Get the contract implementation version.

Get the current upgrade admin.

Check if the contract is paused

Returns

true if paused, false otherwise

Get all configured assets

Accept the upgrade admin role.

Fund the contract with reward tokens (admin function)

Transfers reward tokens from the emission manager to the contract. The contract must be funded before users can claim rewards.

Arguments

• caller: Must be emission_manager
• reward_token: The reward token address to fund
• amount: Amount of reward tokens to transfer to the contract

Initialize the incentives contract

Arguments

• emission_manager: Address authorized to configure rewards
• lending_pool: Associated lending pool address

Claim rewards for specific assets and reward token

Arguments

• caller: Address calling the function (must be authorized)
• assets: List of assets to claim rewards for
• reward_token: The reward token to claim
• amount: Amount to claim (0 = claim all available)
• to: Address to receive the rewards

Returns

The amount of rewards actually claimed

Errors

Returns InsufficientRewards if amount > 0 and the requested amount exceeds the total claimable rewards across all assets and reward types.

Propose a new upgrade admin. The pending admin must accept.

Claim all rewards for all configured reward tokens

This function batches transfers by reward token to reduce gas costs. Instead of one transfer per (asset, reward_token, reward_type) combination, it accumulates all rewards per reward token and does a single transfer per token.

Gas Optimization

• Before: N transfers for N reward positions (e.g., 3 assets × 2 tokens × 2 types = 12 transfers)
• After: M transfers for M unique reward tokens (e.g., 2 transfers for 2 unique tokens)
• Savings: Reduces transfers from O(assets × tokens × types) to O(unique_tokens)

Arguments

• caller: Address calling the function (must be authorized)
• assets: List of assets to claim rewards for
• to: Address to receive the rewards

Get the pending upgrade admin.

Get reward tokens for an asset

Permanently delete a reward token from an asset's registered list.

Both reward types must be inactive and the asset must have zero scaled supply. Deletion preserves the frozen index and creation history. Deleted pairs cannot be configured again. Proven recorded entitlement remains available through claim_rewards; claim_all_rewards omits the pair.

Arguments

• caller: Must be emission_manager
• asset: The aToken or debtToken address
• reward_token: The reward token to unregister

Remove/deactivate asset reward (admin function)

Arguments

• caller: Must be emission_manager
• asset: The underlying asset address
• reward_token: The reward token address
• reward_type: 0 for supply, 1 for borrow

Get user reward data

Set distribution end timestamp (admin function)

Arguments

• caller: Must be emission_manager
• asset: The underlying asset address
• reward_token: The reward token address
• reward_type: 0 for supply, 1 for borrow
• new_distribution_end: New distribution end timestamp (0 = no end)

Cancel a pending upgrade admin proposal.

Get asset reward index

Configure asset rewards (admin function)

Following Aave's pattern: rewards are configured per token contract (aToken/debtToken), not per underlying asset. The asset token calls handle_action_with_balances. New streams bind to the token's trusted continuity revision. Existing streams cannot change after a controller change or failed hook.

Arguments

• caller: Must be emission_manager
• asset: The token address (aToken or debtToken) - this is the asset identifier
• reward_token: The reward token to distribute
• reward_type: 0 for supply, 1 for borrow
• emission_per_second: Emission rate in reward tokens per second
• distribution_end: Distribution end timestamp (0 = no end)

Get asset reward configuration

Set emission per second for an asset reward (admin function)

Arguments

• caller: Must be emission_manager
• asset: The underlying asset address
• reward_token: The reward token address
• reward_type: 0 for supply, 1 for borrow
• new_emission_per_second: New emission rate

Get the contract's balance for a reward token

Returns the amount of reward tokens held by the contract. Call this to check if the contract has sufficient funds to cover pending reward claims.

Arguments

• reward_token: The reward token address to check

Returns

The contract's balance of the reward token

Get user's accrued rewards

Handle action called by token contracts (aToken/debtToken) when balances change

This is the core function that updates reward indices and calculates user rewards. Called after balance updates, with the pre-action supply and both balances.

Arguments

• token_address: The aToken or debtToken address (the asset identifier)
• user: The user address whose balance changed
• total_supply: Total scaled supply/borrow before the balance change
• previous_user_balance: User's scaled balance before the change
• new_user_balance: User's scaled balance after the change
• reward_type: 0 for supply, 1 for borrow
• incentives_revision: Token's current continuity revision

Security

• Only the token contract itself can call this function (enforced via require_auth)
• Asset is determined by token_address parameter
• Unconfigured or quarantined streams do not change reward state
• The calling token supplies its revision; this hook never queries that token