FluidVaultRewards

This contract is designed to adjust the supply rate magnifier for a vault based on the current collateral supply & supply rate. The adjustment aims to dynamically scale the rewards given to lenders as the TVL in the vault changes.

The magnifier is adjusted based on a regular most used reward type where rewardRate = totalRewardsAnnually / totalSupply. Reward rate is applied by adjusting the supply magnifier on vault. Adjustments are made via the rebalance function, which is restricted to be called by designated rebalancers only.

validAddress

modifier validAddress(address value_)

Validates that an address is not the zero address

onlyRebalancer

modifier onlyRebalancer()

Validates that an address is a rebalancer (taken from reserve contract)

constructor

constructor(contract IFluidReserveContract reserveContract_, contract IFluidVaultT1 vault_, contract IFluidLiquidity liquidity_, uint256 rewardsAmt_, uint256 duration_, address initiator_, address collateralToken_, address governance_) public

Constructs the FluidVaultRewards contract.

Parameters

Name	Type	Description
reserveContract_	contract IFluidReserveContract	The address of the reserve contract where rebalancers are defined.
vault_	contract IFluidVaultT1	The vault to which this contract will apply new magnifier parameter.
liquidity_	contract IFluidLiquidity	Fluid liquidity address
rewardsAmt_	uint256	Amounts of rewards to distribute
duration_	uint256	rewards duration
initiator_	address	address that can start rewards with start()
collateralToken_	address	vault collateral token address
governance_	address	governance address

rebalance

function rebalance() external

Rebalances the supply rate magnifier based on the current collateral supply. Can only be called by an authorized rebalancer.

calculateMagnifier

function calculateMagnifier() public view returns (uint256 magnifier_, bool ended_)

Calculates the new supply rate magnifier based on the current collateral supply (vaultTVL()).

Return Values

Name	Type	Description
magnifier_	uint256	The calculated magnifier value.
ended_	bool

currentMagnifier

function currentMagnifier() public view returns (uint256)

returns the currently configured supply magnifier at the VAULT.

vaultTVL

function vaultTVL() public view returns (uint256 tvl_)

returns the current total value locked as collateral (TVL) in the VAULT.

getSupplyRate

function getSupplyRate() public view returns (uint256 supplyRate_)

start

function start() external

startAt

function startAt(uint256 startTime_) public

queueNextRewards

function queueNextRewards(uint256 rewardsAmount_, uint256 duration_) external