VotingReward

Overview

VotingReward is the shared implementation used by FeesVotingReward and BribeVotingReward to distribute rewards to pool voters. Each voting position is identified by its vote-escrow contract address (ve) and NFT identifier (tokenId).

Balances in this contract represent the voting weights recorded by Voter for pool allocations. Balances and total supply are tracked separately for each vote-escrow contract. Reward funding is assigned to the current weekly epoch. When several voting escrows are registered, funding is split between them according to their weighted voting power at the epoch's start, as reported by the governance registry's aggregator.

Rewards become claimable after the epoch ends. For each completed epoch, earned uses the NFT's last balance checkpoint and its escrow's last supply checkpoint in that epoch to calculate its share. Rebases are handled separately by RewardsDistributor.

VotingReward Methods

getReward

Claim the selected reward tokens for an NFT. The caller must own or be approved for the NFT, or be the Voter contract. Tokens are transferred to the NFT's current owner, including when an approved operator calls.

function getReward(address ve, uint256 tokenId, address[] memory tokens) public

The claim updates lastEarn for each selected reward token. It excludes rewards assigned to the current, incomplete epoch.

_deposit

Increase an NFT's recorded voting balance and its escrow's total supply, then write balance and supply checkpoints. This method updates voting-weight accounting.

function _deposit(address ve, uint256 amount, uint256 tokenId) public

This public method is used when Voter records pool allocations. Access is restricted by the contract's AccessManager authority.

_withdraw

Decrease an NFT's recorded voting balance and its escrow's total supply, then write balance and supply checkpoints.

function _withdraw(address ve, uint256 amount, uint256 tokenId) public

This is a restricted method used when Voter removes or updates pool allocations.

notifyRewardAmount

Fund rewards for the current epoch with an ERC-20 token. Funding permissions differ between FeesVotingReward and BribeVotingReward.

function notifyRewardAmount(address token, uint256 amount) external

setGovernanceRegistry

Change the governance registry address. This method is restricted by the contract's AccessManager authority.

function setGovernanceRegistry(address _governanceRegistry) external

View Methods

DURATION

Return the epoch duration constant, 7 days in seconds.

function DURATION() external view returns (uint256)

voter

Return the Voter address configured in the governance registry.

function voter() public view returns (address)

governanceRegistry

Return the governance registry address.

function governanceRegistry() external view returns (address)

totalSupply

Return the total voting weight currently recorded for an escrow in this reward contract.

function totalSupply(address ve) external view returns (uint256)

balanceOf

Return the voting weight currently recorded for an NFT in this reward contract.

function balanceOf(address ve, uint256 tokenId) external view returns (uint256)

tokenRewardsPerEpoch

Return the amount of a reward token assigned to an escrow for a given epoch.

function tokenRewardsPerEpoch(address ve, address token, uint256 epochStart)
    external view returns (uint256)

epochStart is the epoch's Unix start timestamp, rounded down to a multiple of DURATION().

lastEarn

Return the most recent claim timestamp for an NFT and reward token.

function lastEarn(address ve, address token, uint256 tokenId)
    external view returns (uint256)

rewards

Return the reward token address at an index in the contract's reward token list.

function rewards(uint256 index) external view returns (address)

rewardsListLength

Return the number of reward tokens. Enumerate them with rewards(index).

function rewardsListLength() external view returns (uint256)

isReward

Return whether a token has been added to this reward contract's token list.

function isReward(address token) external view returns (bool)

numCheckpoints

Return the number of balance checkpoints for an NFT.

function numCheckpoints(address ve, uint256 tokenId)
    external view returns (uint256)

supplyNumCheckpoints

Return the number of supply checkpoints for an escrow.

function supplyNumCheckpoints(address ve) external view returns (uint256)

checkpoints

Return a balance checkpoint's timestamp and voting weight. Multiple changes in one epoch update the same checkpoint.

function checkpoints(address ve, uint256 tokenId, uint256 index)
    external view returns (uint256 timestamp, uint256 balanceOf)

supplyCheckpoints

Return a supply checkpoint's timestamp and total voting weight. Multiple changes in one epoch update the same checkpoint.

function supplyCheckpoints(address ve, uint256 index)
    external view returns (uint256 timestamp, uint256 supply)

getPriorBalanceIndex

Return the index of the latest balance checkpoint at or before a Unix timestamp.

function getPriorBalanceIndex(address ve, uint256 tokenId, uint256 timestamp)
    public view returns (uint256)

Use the returned index with checkpoints(ve, tokenId, index) to read its timestamp and balance. The method returns zero when no checkpoint exists or the timestamp precedes the first checkpoint; check numCheckpoints and the returned checkpoint's timestamp before interpreting that result. A timestamp after the latest checkpoint returns the latest index.

getPriorSupplyIndex

Return the index of the latest supply checkpoint at or before a Unix timestamp.

function getPriorSupplyIndex(address ve, uint256 timestamp)
    public view returns (uint256)

The method returns zero when no checkpoint exists or the timestamp precedes the first checkpoint; check supplyNumCheckpoints and the returned checkpoint's timestamp. A timestamp after the latest checkpoint returns the latest index.

earned

Return the unclaimed reward amount for an NFT and reward token across completed epochs.

function earned(address ve, address token, uint256 tokenId)
    public view returns (uint256)

This view does not claim rewards or update lastEarn. It returns zero if the NFT has no recorded balance checkpoints.