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.

Source: contracts/TradingRewards.sol

Structs

Period

_Source

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.

Constructor

constructor

_Source

Details

Signature

constructor(address owner, address periodController, address resolver)

Visibility

public

State Mutability

``

Requires

• require(..., "Invalid period controller")

Views

getAvailableRewards

_Source

Details

Signature

getAvailableRewards() view returns (uint256)

Visibility

external

State Mutability

view

getAvailableRewardsForAccountForPeriod

_Source

Details

Signature

getAvailableRewardsForAccountForPeriod(address account, uint256 periodID) view returns (uint256)

Visibility

external

State Mutability

view

getAvailableRewardsForAccountForPeriods

_Source

Details

Signature

getAvailableRewardsForAccountForPeriods(address account, uint256[] periodIDs) view returns (uint256 totalRewards)

Visibility

external

State Mutability

view

getCurrentPeriod

_Source

Details

Signature

getCurrentPeriod() view returns (uint256)

Visibility

external

State Mutability

view

getPeriodAvailableRewards

_Source

Details

Signature

getPeriodAvailableRewards(uint256 periodID) view returns (uint256)

Visibility

external

State Mutability

view

getPeriodController

_Source

Details

Signature

getPeriodController() view returns (address)

Visibility

external

State Mutability

view

getPeriodIsClaimable

_Source

Details

Signature

getPeriodIsClaimable(uint256 periodID) view returns (bool)

Visibility

external

State Mutability

view

getPeriodIsFinalized

_Source

Details

Signature

getPeriodIsFinalized(uint256 periodID) view returns (bool)

Visibility

external

State Mutability

view

getPeriodRecordedFees

_Source

Details

Signature

getPeriodRecordedFees(uint256 periodID) view returns (uint256)

Visibility

external

State Mutability

view

getPeriodTotalRewards

_Source

Details

Signature

getPeriodTotalRewards(uint256 periodID) view returns (uint256)

Visibility

external

State Mutability

view

getRewardsToken

_Source

Details

Signature

getRewardsToken() view returns (address)

Visibility

external

State Mutability

view

getUnaccountedFeesForAccountForPeriod

_Source

Details

Signature

getUnaccountedFeesForAccountForPeriod(address account, uint256 periodID) view returns (uint256)

Visibility

external

State Mutability

view

getUnassignedRewards

_Source

Details

Signature

getUnassignedRewards() view returns (uint256)

Visibility

external

State Mutability

view

resolverAddressesRequired

_Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

Restricted Functions

closeCurrentPeriodWithRewards

_Source

Details

Signature

closeCurrentPeriodWithRewards(uint256 rewards)

Visibility

external

State Mutability

``

Requires

• require(..., "Insufficient free rewards")

Modifiers

• onlyPeriodController

Emits

• PeriodFinalizedWithRewards

• NewPeriodStarted

recordExchangeFeeForAccount

_Source

Details

Signature

recordExchangeFeeForAccount(uint256 usdFeeAmount, address account)

Visibility

external

State Mutability

``

Modifiers

• onlyExchanger

Emits

• ExchangeFeeRecorded

recoverAssignedRewardTokensAndDestroyPeriod

_Source

Details

Signature

recoverAssignedRewardTokensAndDestroyPeriod(address recoverAddress, uint256 periodID)

Visibility

external

State Mutability

``

Requires

• require(..., "Cannot recover from active")

• require(..., "No rewards available to recover")

Modifiers

• onlyOwner

Emits

• AssignedRewardTokensRecovered

recoverTokens

_Source

Details

Signature

recoverTokens(address tokenAddress, address recoverAddress)

Visibility

external

State Mutability

``

Requires

• require(..., "Must use another function")

• require(..., "No tokens to recover")

Modifiers

• onlyOwner

Emits

• TokensRecovered

recoverUnassignedRewardTokens

_Source

Details

Signature

recoverUnassignedRewardTokens(address recoverAddress)

Visibility

external

State Mutability

``

Requires

• require(..., "No tokens to recover")

• require(..., "No tokens to recover")

Modifiers

• onlyOwner

Emits

• UnassignedRewardTokensRecovered

setPeriodController

_Source

Details

Signature

setPeriodController(address newPeriodController)

Visibility

external

State Mutability

``

Requires

• require(..., "Invalid period controller")

Modifiers

• onlyOwner

Emits

• PeriodControllerChanged

Internal Functions

_calculateRewards

_Source

Details

Signature

_calculateRewards(address account, uint256 periodID) view returns (uint256)

Visibility

internal

State Mutability

view

_claimRewards

_Source

Details

Signature

_claimRewards(address account, uint256 periodID)

Visibility

internal

State Mutability

``

Requires

• require(..., "Period is not finalized")

• require(..., "No rewards available")

Emits

• RewardsClaimed

_validateRecoverAddress

_Source

Details

Signature

_validateRecoverAddress(address recoverAddress) view

Visibility

internal

State Mutability

view

exchanger

_Source

Details

Signature

exchanger() view returns (contract IExchanger)

Visibility

internal

State Mutability

view

synthetix

_Source

Details

Signature

synthetix() view returns (contract IERC20)

Visibility

internal

State Mutability

view

External Functions

claimRewardsForPeriod

_Source

Details

Signature

claimRewardsForPeriod(uint256 periodID)

Visibility

external

State Mutability

``

Modifiers

• nonReentrant

• notPaused

claimRewardsForPeriods

_Source

Details

Signature

claimRewardsForPeriods(uint256[] periodIDs)

Visibility

external

State Mutability

``

Modifiers

• nonReentrant

• notPaused

Modifiers

onlyExchanger

_Source

onlyPeriodController

_Source

Events

AssignedRewardTokensRecovered

_Source

Signature: AssignedRewardTokensRecovered(address recoverAddress, uint256 amount, uint256 periodID)

ExchangeFeeRecorded

_Source

Signature: ExchangeFeeRecorded(address account, uint256 amount, uint256 periodID)

NewPeriodStarted

_Source

Signature: NewPeriodStarted(uint256 periodID)

PeriodControllerChanged

_Source

Signature: PeriodControllerChanged(address newPeriodController)

PeriodFinalizedWithRewards

_Source

Signature: PeriodFinalizedWithRewards(uint256 periodID, uint256 rewards)

RewardsClaimed

_Source

Signature: RewardsClaimed(address account, uint256 amount, uint256 periodID)

TokensRecovered

_Source

Signature: TokensRecovered(address tokenAddress, address recoverAddress, uint256 amount)

UnassignedRewardTokensRecovered

_Source

Signature: UnassignedRewardTokensRecovered(address recoverAddress, uint256 amount)