Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

IInfraredVault

Git Source

Functions

rewardData

Gets the reward data for a given rewards token

function rewardData(address _rewardsToken)
    external
    view
    returns (
        address rewardsDistributor,
        uint256 rewardsDuration,
        uint256 periodFinish,
        uint256 rewardRate,
        uint256 lastUpdateTime,
        uint256 rewardPerTokenStored,
        uint256 rewardResidual
    );

Parameters

NameTypeDescription
_rewardsTokenaddressThe address of the rewards token

Returns

NameTypeDescription
rewardsDistributoraddressThe address authorized to distribute rewards
rewardsDurationuint256The duration of the reward period
periodFinishuint256The timestamp when rewards finish
rewardRateuint256The rate of rewards distributed per second
lastUpdateTimeuint256The last time rewards were updated
rewardPerTokenStoreduint256The last calculated reward per token
rewardResidualuint256

totalSupply

Returns the total amount of staked tokens in the contract

function totalSupply() external view returns (uint256);

Returns

NameTypeDescription
<none>uint256uint256 The total supply of staked tokens