StakingRewards

Description

Source: contracts/StakingRewards.sol

Variables

lastUpdateTime

_Source

Type: uint256

periodFinish

_Source

Type: uint256

rewardPerTokenStored

_Source

Type: uint256

rewardRate

_Source

Type: uint256

rewards

_Source

Type: mapping(address => uint256)

rewardsDuration

_Source

Type: uint256

rewardsToken

_Source

Type: contract IERC20

stakingToken

_Source

Type: contract IERC20

userRewardPerTokenPaid

_Source

Type: mapping(address => uint256)

Constructor

constructor

_Source

Details

Signature

constructor(address _owner, address _rewardsDistribution, address _rewardsToken, address _stakingToken)

Visibility

public

State Mutability

``

Views

balanceOf

_Source

Details

Signature

balanceOf(address account) view returns (uint256)

Visibility

external

State Mutability

view

earned

_Source

Details

Signature

earned(address account) view returns (uint256)

Visibility

public

State Mutability

view

getRewardForDuration

_Source

Details

Signature

getRewardForDuration() view returns (uint256)

Visibility

external

State Mutability

view

lastTimeRewardApplicable

_Source

Details

Signature

lastTimeRewardApplicable() view returns (uint256)

Visibility

public

State Mutability

view

rewardPerToken

_Source

Details

Signature

rewardPerToken() view returns (uint256)

Visibility

public

State Mutability

view

totalSupply

_Source

Details

Signature

totalSupply() view returns (uint256)

Visibility

external

State Mutability

view

Restricted Functions

notifyRewardAmount

_Source

Details

Signature

notifyRewardAmount(uint256 reward)

Visibility

external

State Mutability

``

Requires

• require(..., "Provided reward too high")

Modifiers

• onlyRewardsDistribution

• updateReward

Emits

• RewardAdded

recoverERC20

_Source

Details

Signature

recoverERC20(address tokenAddress, uint256 tokenAmount)

Visibility

external

State Mutability

``

Requires

• require(..., "Cannot withdraw the staking token")

Modifiers

• onlyOwner

Emits

• Recovered

setRewardsDuration

_Source

Details

Signature

setRewardsDuration(uint256 _rewardsDuration)

Visibility

external

State Mutability

``

Requires

• require(..., "Previous rewards period must be complete before changing the duration for the new period")

Modifiers

• onlyOwner

Emits

• RewardsDurationUpdated

External Functions

exit

_Source

Details

Signature

exit()

Visibility

external

State Mutability

``

getReward

_Source

Details

Signature

getReward()

Visibility

public

State Mutability

``

Modifiers

• nonReentrant

• updateReward

stake

_Source

Details

Signature

stake(uint256 amount)

Visibility

external

State Mutability

``

Requires

• require(..., "Cannot stake 0")

Modifiers

• nonReentrant

• notPaused

• updateReward

Emits

• Staked

withdraw

_Source

Details

Signature

withdraw(uint256 amount)

Visibility

public

State Mutability

``

Requires

• require(..., "Cannot withdraw 0")

Modifiers

• nonReentrant

• updateReward

Emits

• Withdrawn

Modifiers

updateReward

_Source

Signature: updateReward(address account)

Events

Recovered

_Source

Signature: Recovered(address token, uint256 amount)

RewardAdded

_Source

Signature: RewardAdded(uint256 reward)

RewardPaid

_Source

Signature: RewardPaid(address user, uint256 reward)

RewardsDurationUpdated

_Source

Signature: RewardsDurationUpdated(uint256 newDuration)

Staked

_Source

Signature: Staked(address user, uint256 amount)

Withdrawn

_Source

Signature: Withdrawn(address user, uint256 amount)