ZivoeRewards.sol

Introduction

This contract facilitates staking and yield distribution.

This contract has the following responsibilities:

• Allows staking and unstaking of modular "stakingToken".

• Allows claiming yield distributed / "deposited" to this contract.

• Allows multiple assets to be added as "rewardToken" for distributions.

• Vests rewardTokens linearly overtime to stakers.

State Variables

Reward

This struct stores information for reward tokens.

Sections

Read Functions

• balanceOf() - Returns the amount of tokens owned by "account", received when depositing via stake().

• getRewardForDuration() - Returns the total amount of rewards being distributed to everyone for current rewardsDuration.

• totalSupply() - Returns the amount of tokens in existence; these are minted and burned when depositing or withdrawing.

• viewAccountRewardPerTokenPaid() - Returns the last snapshot of rewardPerTokenStored taken for a reward asset.

• viewRewards() - Returns the rewards earned of a specific rewardToken for an address.

• earned() - Provides information on the rewards available for claim.

• lastTimeRewardApplicable() - Helper function for assessing distribution timelines.

• rewardPerToken() - Cumulative amount of rewards distributed per LP token.

Write Functions

• addReward() - Adds a new asset as a reward to this contract.

• depositReward() - Deposits a reward to this contract for distribution.

• fullWithdraw() - Simultaneously calls withdraw() and getRewards() for convenience.

• stake() - Stakes the specified amount of stakingToken to this contract.

• stakeFor() - Stakes the specified amount of stakingToken to this contract, awarded to someone else.

• getRewards() - Claim rewards for all possible _rewardTokens.

• withdraw() - Withdraws the specified amount of stakingToken from this contract.

Events

• RewardAdded()

• RewardDeposited()

• RewardDistributed()

• Staked()

• StakedFor()

• Withdrawn()

Read Functions

balanceOf()

Returns the amount of tokens owned by "account", received when depositing via stake().

function balanceOf(
    address account
) external view returns (uint256 amount);

Returns

getRewardForDuration()

Returns the total amount of rewards being distributed to everyone for current rewardsDuration.

function getRewardForDuration(
    address _rewardsToken
) external view returns (uint256 amount);

Returns

totalSupply()

Returns the amount of tokens in existence; these are minted and burned when depositing or withdrawing.

function totalSupply() external view returns (uint256 amount);

Returns

viewAccountRewardPerTokenPaid()

Returns the last snapshot of rewardPerTokenStored taken for a reward asset.

function viewAccountRewardPerTokenPaid(
    address account, 
    address rewardAsset
) external view returns (uint256 amount);

Returns

viewRewards()

Returns the rewards earned of a specific rewardToken for an address.

function viewRewards(
    address account,
    address rewardAsset
) external view returns (uint256 amount);

Returns

earned()

Provides information on the rewards available for claim.

function earned(
    address account, 
    address _rewardsToken
) public view returns (uint256 amount);

Returns

lastTimeRewardApplicable()

Helper function for assessing distribution timelines.

function lastTimeRewardApplicable(
    address _rewardsToken
) public view returns (uint256 timestamp); 

Returns

rewardPerToken()

Cumulative amount of rewards distributed per LP token.

function rewardPerToken(
    address _rewardsToken
) public view returns (uint256 amount);

Returns

Write Functions

addReward()

Adds a new asset as a reward to this contract.

function addReward(
    address _rewardsToken, 
    uint256 _rewardsDuration
) external;

Emits the RewardAdded() event

depositReward()

Deposits a reward to this contract for distribution.

function depositReward(
    address _rewardsToken, 
    uint256 reward
) external updateReward(address(0)) nonReentrant;

Emits the RewardDeposited() event

fullWithdraw()

Simultaneously calls withdraw() and getRewards() for convenience.

function fullWithdraw() external;

Emits the Withdrawn() and RewardDistributed() event(s)

stake()

Stakes the specified amount of stakingToken to this contract.

function stake(uint256 amount) external nonReentrant updateReward(_msgSender());

Emits the Staked() event

stakeFor()

Stakes the specified amount of stakingToken to this contract, awarded to someone else.

function stakeFor(
    uint256 amount, 
    address account
) external nonReentrant updateReward(account);

Emits the StakedFor() event

getRewards()

Claim rewards for all possible _rewardTokens.

function getRewards() public updateReward(_msgSender());

Emits the RewardDistributed() event

withdraw()

Withdraws the specified amount of stakingToken from this contract.

function withdraw(uint256 amount) public nonReentrant updateReward(_msgSender());

Emits the Withdrawn() event

Events

RewardAdded()

Emitted during addReward()

event RewardAdded(address indexed reward);

RewardDeposited()

Emitted during depositReward()

event RewardDeposited(
    address indexed reward, 
    uint256 amount, 
    address indexed depositor
);

RewardDistributed()

Emitted during #getrewardat

event RewardDistributed(
    address indexed account, 
    address indexed rewardsToken, 
    uint256 reward
);

Staked()

Emitted during stake()

event Staked(address indexed account, uint256 amount);

StakedFor()

Emitted during stakeFor()

event StakedFor(
    address indexed account, 
    uint256 amount, 
    address indexed by
);

Withdrawn()

Emitted during withdraw()

event Withdrawn(address indexed account, uint256 amount);