TradingRewards¶

Description¶

This contract is an implementation of SIP-63. It records exchange fees paid by users into periods, which, when closed with a given amount of SNX rewards, allows participants to claim such rewards pro-rata, according to the amount of fees recorded for them in such period.

The recording of such fees can be enabled by the ProtocolDAO, via SystemSettings.

Field	Type	Description
`isFinalized`	`bool`	A period needs to be finalized for participants to be able to claim rewards.
`recordedFees`	`uint256`	Total recorded fees for the period.
`totalRewards`	`uint256`	Total SNX rewards assigned to the period when it's closed.
`availableRewards`	`uint256`	Remaining SNX rewards after `totalRewards` have been assigned. Diminishes as participants claim their rewards.
`unaccountedFeesForAccount`	`mapping(address => uint256)`	Records fees for each participant during the period. Increases when fees are recorded, decreases when rewards are claimed.

TradingRewards¶

Description¶

Structs¶

Period¶

Constructor¶

constructor¶

Views¶

getAvailableRewards¶

getAvailableRewardsForAccountForPeriod¶

getAvailableRewardsForAccountForPeriods¶

getCurrentPeriod¶

getPeriodAvailableRewards¶

getPeriodController¶

getPeriodIsClaimable¶

getPeriodIsFinalized¶

getPeriodRecordedFees¶

getPeriodTotalRewards¶

getRewardsToken¶

getUnaccountedFeesForAccountForPeriod¶

getUnassignedRewards¶

resolverAddressesRequired¶

Restricted Functions¶

closeCurrentPeriodWithRewards¶

recordExchangeFeeForAccount¶

recoverAssignedRewardTokensAndDestroyPeriod¶

recoverTokens¶

recoverUnassignedRewardTokens¶

setPeriodController¶

Internal Functions¶

_calculateRewards¶

_claimRewards¶

_validateRecoverAddress¶

exchanger¶

synthetix¶

External Functions¶

claimRewardsForPeriod¶

claimRewardsForPeriods¶

notifyRewardAmount¶

Modifiers¶

onlyExchanger¶

onlyPeriodController¶

Events¶

AssignedRewardTokensRecovered¶

ExchangeFeeRecorded¶

NewPeriodStarted¶

PeriodControllerChanged¶

PeriodFinalizedWithRewards¶

RewardsClaimed¶

TokensRecovered¶

UnassignedRewardTokensRecovered¶

`Period`¶

`constructor`¶

`getAvailableRewards`¶

`getAvailableRewardsForAccountForPeriod`¶

`getAvailableRewardsForAccountForPeriods`¶

`getCurrentPeriod`¶

`getPeriodAvailableRewards`¶

`getPeriodController`¶

`getPeriodIsClaimable`¶

`getPeriodIsFinalized`¶

`getPeriodRecordedFees`¶

`getPeriodTotalRewards`¶

`getRewardsToken`¶

`getUnaccountedFeesForAccountForPeriod`¶

`getUnassignedRewards`¶

`resolverAddressesRequired`¶

`closeCurrentPeriodWithRewards`¶

`recordExchangeFeeForAccount`¶

`recoverAssignedRewardTokensAndDestroyPeriod`¶

`recoverTokens`¶

`recoverUnassignedRewardTokens`¶

`setPeriodController`¶

`_calculateRewards`¶

`_claimRewards`¶

`_validateRecoverAddress`¶

`exchanger`¶

`synthetix`¶

`claimRewardsForPeriod`¶

`claimRewardsForPeriods`¶

`notifyRewardAmount`¶

`onlyExchanger`¶

`onlyPeriodController`¶

`AssignedRewardTokensRecovered`¶

`ExchangeFeeRecorded`¶

`NewPeriodStarted`¶

`PeriodControllerChanged`¶

`PeriodFinalizedWithRewards`¶

`RewardsClaimed`¶

`TokensRecovered`¶

`UnassignedRewardTokensRecovered`¶