PoolRewards

PoolRewards

Distributes VSP rewards based on the user's Vesper pool balance and the supply of rewards available to that pool.

VERSION

string VERSION

initialize

function initialize(address _pool, address[] _rewardTokens) public
Called by proxy to initialize this contract.
Name
Type
Description
_pool
address
Vesper pool address
_rewardTokens
address[]
Array of reward token addresses

notifyRewardAmount

function notifyRewardAmount(address[] _rewardTokens, uint256[] _rewardAmounts, uint256[] _rewardDurations) external virtual
Notify that reward is added. Only authorized caller can call this function.
Also updates reward rate and reward earning period.
Name
Type
Description
_rewardTokens
address[]
Tokens being rewarded
_rewardAmounts
uint256[]
Rewards amount for token on same index in rewardTokens array
_rewardDurations
uint256[]
Duration for which reward will be distributed

notifyRewardAmount

function notifyRewardAmount(address _rewardToken, uint256 _rewardAmount, uint256 _rewardDuration) external virtual

addRewardToken

function addRewardToken(address _newRewardToken) external
Add new reward token in existing rewardsToken array

claimReward

function claimReward(address _account) external virtual
Claim earned rewards.
This function claims rewards for all tokens being rewarded

updateReward

function updateReward(address _account) external
Updated reward for given account.

claimable

function claimable(address _account) external view virtual returns (address[] _rewardTokens, uint256[] _claimableAmounts)
Returns claimable reward amount.
Name
Type
Description
_rewardTokens
address[]
Array of tokens being rewarded
_claimableAmounts
uint256[]
Array of claimable for token on same index in rewardTokens

getRewardTokens

function getRewardTokens() external view returns (address[])
Provides easy access to all rewardTokens

lastTimeRewardApplicable

function lastTimeRewardApplicable(address _rewardToken) public view returns (uint256)
Returns timestamp of last reward update

rewardForDuration

function rewardForDuration() external view returns (address[] _rewardTokens, uint256[] _rewardForDuration)

rewardPerToken

function rewardPerToken() external view returns (address[] _rewardTokens, uint256[] _rewardPerTokenRate)
Rewards rate per pool token
Name
Type
Description
_rewardTokens
address[]
Array of tokens being rewarded
_rewardPerTokenRate
uint256[]
Array of Rewards rate for token on same index in rewardTokens