IFluidLendingRewardsRateModel

Git Source

Functions

getRate

Calculates the current rewards rate (APR)

function getRate(uint256 totalAssets_) external view returns (uint256 rate_, bool ended_, uint256 startTime_);

Parameters

Name	Type	Description
totalAssets_	uint256	amount of assets in the lending

Returns

Name	Type	Description
rate_	uint256	rewards rate percentage per year with 1e12 RATE_PRECISION, e.g. 1e12 = 1%, 1e14 = 100%
ended_	bool	flag to signal that rewards have ended (always 0 going forward)
startTime_	uint256	start time of rewards to compare against last update timestamp

getRateV2

Same as getRate but additionally returns the endTime_ of the reported rewards phase, and rate_ stays the actual phase rate even when ended_ is true. This allows fTokens to accrue rewards exactly up to endTime_ instead of losing the tail since their last exchange price update.

function getRateV2(uint256 totalAssets_)
    external
    view
    returns (int256 rate_, bool ended_, uint256 startTime_, uint256 endTime_);

Parameters

Name	Type	Description
totalAssets_	uint256	amount of assets in the lending

Returns

Name	Type	Description
rate_	int256	rewards rate percentage per year with 1e12 RATE_PRECISION, e.g. 1e12 = 1%, 1e14 = 100%. Signed for a shared ABI with the static offset model; this streaming model always returns >= 0.
ended_	bool	flag to signal that rewards have ended
startTime_	uint256	start time of rewards to compare against last update timestamp
endTime_	uint256	end time of the reported rewards phase

getConfig

Returns config constants for rewards rate model

function getConfig()
    external
    view
    returns (
        uint256 duration_,
        uint256 startTime_,
        uint256 endTime_,
        uint256 startTvl_,
        uint256 maxRate_,
        uint256 rewardAmount_,
        address configurator_
    );