Skip to content

Synthetix System Documentation ShortingRewards

synthetixio/synthetix

ShortingRewards¶

Description¶

Source: contracts/ShortingRewards.sol

Architecture¶

Libraries¶

SafeMath for uint256
SafeERC20 for IERC20

Inheritance Graph¶

graph TD ShortingRewards[ShortingRewards] --> RewardsDistributionRecipient[RewardsDistributionRecipient] ShortingRewards[ShortingRewards] --> Pausable[Pausable] ShortingRewards[ShortingRewards] --> MixinResolver[MixinResolver] RewardsDistributionRecipient[RewardsDistributionRecipient] --> Owned[Owned] Pausable[Pausable] --> Owned[Owned]

Variables¶

`lastUpdateTime`¶

Type: uint256

`periodFinish`¶

Type: uint256

`rewardPerTokenStored`¶

Type: uint256

`rewardRate`¶

Type: uint256

`rewards`¶

Type: mapping(address => uint256)

`rewardsDuration`¶

Type: uint256

`rewardsToken`¶

Type: contract IERC20

`short`¶

Type: contract ICollateralErc20

`synth`¶

Type: bytes32

`userRewardPerTokenPaid`¶

Type: mapping(address => uint256)

Constructor¶

`constructor`¶

Details

Signature

(address _owner, address _resolver, address _rewardsDistribution, address _rewardsToken, address _short, bytes32 _synth)

Visibility

public

State Mutability

nonpayable

Views¶

`balanceOf`¶

Details

Signature

balanceOf(address account) returns (uint256)

Visibility

external

State Mutability

view

`earned`¶

Details

Signature

earned(address account) returns (uint256)

Visibility

public

State Mutability

view

`getRewardForDuration`¶

Details

Signature

getRewardForDuration() returns (uint256)

Visibility

external

State Mutability

view

`lastTimeRewardApplicable`¶

Details

Signature

lastTimeRewardApplicable() returns (uint256)

Visibility

public

State Mutability

view

`resolverAddressesRequired`¶

Details

Signature

resolverAddressesRequired() returns (bytes32[])

Visibility

public

State Mutability

view

`rewardPerToken`¶

Details

Signature

rewardPerToken() returns (uint256)

Visibility

public

State Mutability

view

`totalSupply`¶

Details

Signature

totalSupply() returns (uint256)

Visibility

external

State Mutability

view

Restricted Functions¶

`enrol`¶

Details

Signature

enrol(address account, uint256 amount)

Visibility

external

State Mutability

nonpayable

Requires

require(..., Cannot stake 0)

Modifiers

onlyShortContract
nonReentrant
notPaused
updateReward

Emits

Enrol

`exit`¶

Details

Signature

exit(address account)

Visibility

external

State Mutability

nonpayable

Modifiers

onlyShortContract

`notifyRewardAmount`¶

Details

Signature

notifyRewardAmount(uint256 reward)

Visibility

external

State Mutability

nonpayable

Requires

require(..., Provided reward too high)

Modifiers

onlyRewardsDistribution
updateReward

Emits

RewardAdded

`setRewardsDuration`¶

Details

Signature

setRewardsDuration(uint256 _rewardsDuration)

Visibility

external

State Mutability

nonpayable

Requires

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

Modifiers

onlyOwner

Emits

RewardsDurationUpdated

`withdraw`¶

Details

Signature

withdraw(address account, uint256 amount)

Visibility

public

State Mutability

nonpayable

Requires

require(..., Cannot withdraw 0)

Modifiers

onlyShortContract
nonReentrant
updateReward

Emits

Withdrawn

Internal Functions¶

`_short`¶

Details

Signature

_short() returns (contract ICollateralErc20)

Visibility

internal

State Mutability

view

External Functions¶

`getReward`¶

Details

Signature

getReward(address account)

Visibility

public

State Mutability

nonpayable

Modifiers

nonReentrant
updateReward

Modifiers¶

`onlyShortContract`¶

`updateReward`¶

Signature: updateReward(address account)

Events¶

`Enrol`¶

Signature: Enrol(address user, uint256 amount)

`Recovered`¶

Signature: Recovered(address token, uint256 amount)

`RewardAdded`¶

Signature: RewardAdded(uint256 reward)

`RewardPaid`¶

Signature: RewardPaid(address user, uint256 reward)

`RewardsDurationUpdated`¶

Signature: RewardsDurationUpdated(uint256 newDuration)

`Withdrawn`¶

Signature: Withdrawn(address user, uint256 amount)