FtsoRewardManager#

function accrueUnearnedRewards(
    uint256 _epochId,
    uint256 _priceEpochDurationSeconds,
    uint256 _priceEpochEndTime
) external;

Accrue unearned rewards for a given price epoch. Typically done when the FTSO is in fallback mode or because of insufficient vote power. Simply accrue them so they will not be distributed and will be burned later.

The amount of rewards that will be burned is calculated in the same way as in distributeRewards.

Only the FTSO Manager can call this method.

function activate(
) external;

Activates reward manager (allows claiming rewards).

Only governance can call this method.

function active(
) external view returns (
    bool);

Whether rewards can be claimed from this reward manager.

function autoClaim(
    address[] _rewardOwners,
    uint256 _rewardEpoch
) external;

Allows claiming rewards simultaneously for a list of reward owners and all unclaimed epochs before the specified one.

This is meant as a convenience all-in-one reward claiming method to be used both by reward owners and registered executors. It performs a series of operations, besides claiming rewards:

• If a reward owner has enabled its Personal Delegation Account, rewards are also claimed for the PDA and the total claimed amount is sent to that PDA. Otherwise, the claimed amount is sent to the reward owner's account.

• Claimed amount is automatically wrapped through the WNat contract.

• If the caller is a registered executor with a non-zero fee, the fee is paid to the executor for each claimed address.

function cancelGovernanceCall(
    bytes4 _selector
) external;

Cancel a timelocked governance call before it has been executed.

Only governance can call this method.

function claim(
    address _rewardOwner,
    address payable _recipient,
    uint256 _rewardEpoch,
    bool _wrap
) external returns (
    uint256 _rewardAmount);

Allows the caller to claim rewards for a reward owner. The caller does not have to be the owner of the rewards, but must be approved by the owner to claim on his behalf by using setClaimExecutors on the claimSetupManager.

This function is intended to be used to claim rewards in case of delegation by percentage. Reverts if msg.sender is delegating by amount.

Anybody can call this method, but rewards can only be sent to the reward owner, therefore no funds can be stolen. However, by limiting the authorized callers, the owner can control the timing of the calls.

When the reward owner is the caller, rewards can be sent to any recipient set by setAllowedClaimRecipients on the claimSetupManager. The reward owner's Personal Delegation Account is always an authorized recipient.

function claimFromDataProviders(
    address _rewardOwner,
    address payable _recipient,
    uint256[] _rewardEpochs,
    address[] _dataProviders,
    bool _wrap
) external returns (
    uint256 _rewardAmount);

Allows the caller to claim rewards for a reward owner from specific data providers. The caller does not have to be the owner of the rewards, but must be approved by the owner to claim on his behalf by using setClaimExecutors on the claimSetupManager.

This function is intended to be used to claim rewards in case of delegation by amount (explicit delegation). Reverts if msg.sender is delegating by percentage.

Anybody can call this method, but rewards can only be sent to the reward owner, therefore no funds can be stolen. However, by limiting the authorized callers, the owner can control the timing of the calls.

When the reward owner is the caller, rewards can be sent to any recipient set by setAllowedClaimRecipients on the claimSetupManager. The reward owner's Personal Delegation Account is always an authorized recipient.

function claimReward(
    address payable _recipient,
    uint256[] _rewardEpochs
) external returns (
    uint256 _rewardAmount);

Allows a percentage delegator to claim rewards. This function is intended to be used to claim rewards in case of delegation by percentage.

This function is deprecated: use claim instead.

Reverts if msg.sender is delegating by amount. Claims for all unclaimed reward epochs to the 'max(_rewardEpochs)'. Retained for backward compatibility.

function claimRewardFromDataProviders(
    address payable _recipient,
    uint256[] _rewardEpochs,
    address[] _dataProviders
) external returns (
    uint256 _rewardAmount);

Allows the caller to claim rewards from specific data providers. This function is intended to be used to claim rewards in case of delegation by amount.

This function is deprecated: use claimFromDataProviders instead.

function closeExpiredRewardEpoch(
    uint256 _rewardEpoch
) external;

Collects funds from expired reward epoch and calculates totals.

Triggered by ftsoManager on finalization of a reward epoch. Operation is irreversible: when some reward epoch is closed according to current settings, it cannot be reopened even if new parameters would allow it, because nextRewardEpochToExpire in ftsoManager never decreases.

function deactivate(
) external;

Deactivates reward manager (prevents claiming rewards).

Only governance can call this method.

function defaultFeePercentage(
) external view returns (
    uint256);

Returns the configured default fee percentage.

function distributeRewards(
    address[] _addresses,
    uint256[] _weights,
    uint256 _totalWeight,
    uint256 _epochId,
    address _ftso,
    uint256 _priceEpochDurationSeconds,
    uint256 _currentRewardEpoch,
    uint256 _priceEpochEndTime,
    uint256 _votePowerBlock
) external;

Distributes price epoch rewards to data provider accounts, according to input parameters. Must be called with totalWeight > 0 and addresses.length > 0.

The amount of rewards for a given price epoch ID are calculated in FtsoRewardManager from priceEpochDurationSeconds, priceEpochEndTime and inflation authorization data (see _getTotalPriceEpochRewardWei in FtsoRewardManager. Then each data provider address is given a portion of this amount according to corresponding weight and total sum of weights.

Parameters epochId and ftso are only needed so they can be passed onto the emitted event.

Only the ftsoManager can call this method.

function enableClaims(
) external;

Enable claiming for current and all future reward epochs.

Only governance can call this method.

function executeGovernanceCall(
    bytes4 _selector
) external;

Execute the timelocked governance calls once the timelock period expires.

Only executor can call this method.

function feePercentageUpdateOffset(
) external view returns (
    uint256);

Returns the amount of reward epoch that need to ellapse before a fee change takes effect.

function firstClaimableRewardEpoch(
) external view returns (
    uint256);

Epochs before the token distribution event at Flare launch were not be claimable. Use this method to know the first reward epoch that was claimable.

function getAddressUpdater(
) public view returns (
    address _addressUpdater);

Returns the configured address updater.

function getClaimedReward(
    uint256 _rewardEpoch,
    address _dataProvider,
    address _claimer
) external view returns (
    bool _claimed,
    uint256 _amount);

Returns information on the rewards accrued by a reward owner from a specific data provider at a specific reward epoch.

function getContractName(
) external pure returns (
    string);

Implement this function to allow updating inflation receiver contracts through AddressUpdater.

function getCurrentRewardEpoch(
) external view returns (
    uint256);

Returns the current reward epoch ID.

function getDataProviderCurrentFeePercentage(
    address _dataProvider
) external view returns (
    uint256);

Returns the current fee percentage of a data provider.

function getDataProviderFeePercentage(
    address _dataProvider,
    uint256 _rewardEpoch
) external view returns (
    uint256 _feePercentageBIPS);

Returns the fee percentage of a data provider at a given reward epoch.

function getDataProviderPerformanceInfo(
    uint256 _rewardEpoch,
    address _dataProvider
) external view returns (
    uint256 _rewardAmount,
    uint256 _votePowerIgnoringRevocation);

Returns information on rewards and vote power of a data provider at a given reward epoch.

function getDataProviderScheduledFeePercentageChanges(
    address _dataProvider
) external view returns (
    uint256[] _feePercentageBIPS,
    uint256[] _validFromEpoch,
    bool[] _fixed);

Returns the scheduled fee percentage changes for a data provider.

function getEpochReward(
    uint256 _rewardEpoch
) external view returns (
    uint256 _totalReward,
    uint256 _claimedReward);

Returns information on an epoch's rewards.

function getEpochsWithClaimableRewards(
) external view returns (
    uint256 _startEpochId,
    uint256 _endEpochId);

Returns the reward epoch range for which rewards can be claimed. Rewards outside this range are unclaimable, either because they have expired or because the reward epoch is still ongoing.

function getEpochsWithUnclaimedRewards(
    address _beneficiary
) external view returns (
    uint256[] _epochIds);

Returns the array of claimable epoch IDs for which the rewards of a reward owner have not yet been claimed.

function getExpectedBalance(
) external view returns (
    uint256);

Returns the contract's expected balance (actual balance may be higher due to self-destruct funds).

function getInflationAddress(
) external view returns (
    address);

Returns the address of the Inflation contract.

function getInitialRewardEpoch(
) external view returns (
    uint256 _initialRewardEpoch);

Returns the initial reward epoch ID for this reward manager contract. This corresponds to the oldest reward epoch with claimable rewards in the previous reward manager when this one took over. Set by governance through setInitialRewardData.

function getRewardEpochToExpireNext(
) external view returns (
    uint256);

Returns the reward epoch that will expire next once a new reward epoch starts.

function getRewardEpochVotePowerBlock(
    uint256 _rewardEpoch
) external view returns (
    uint256);

Returns the vote power block of a given reward epoch.

function getStateOfRewards(
    address _beneficiary,
    uint256 _rewardEpoch
) external view returns (
    address[] _dataProviders,
    uint256[] _rewardAmounts,
    bool[] _claimed,
    bool _claimable);

Returns the state of rewards for a given address at a specific reward epoch.

function getStateOfRewardsFromDataProviders(
    address _beneficiary,
    uint256 _rewardEpoch,
    address[] _dataProviders
) external view returns (
    uint256[] _rewardAmounts,
    bool[] _claimed,
    bool _claimable);

Returns the state of rewards for a given address coming from a specific set of data providers, at a specific reward epoch.

function getTokenPoolSupplyData(
) external view returns (
    uint256 _lockedFundsWei,
    uint256 _totalInflationAuthorizedWei,
    uint256 _totalClaimedWei);

Returns token pool supply data.

function getTotals(
) external view returns (
    uint256 _totalAwardedWei,
    uint256 _totalClaimedWei,
    uint256 _totalExpiredWei,
    uint256 _totalUnearnedWei,
    uint256 _totalBurnedWei,
    uint256 _totalInflationAuthorizedWei,
    uint256 _totalInflationReceivedWei,
    uint256 _lastInflationAuthorizationReceivedTs,
    uint256 _dailyAuthorizedInflation);

Returns statistics regarding rewards, accumulated over the whole lifespan of the reward manager contract.

function getUnclaimedReward(
    uint256 _rewardEpoch,
    address _dataProvider
) external view returns (
    uint256 _amount,
    uint256 _weight);

Returns information on unclaimed rewards for a given data provider and epoch.

function governance(
) public view returns (
    address);

Returns the current effective governance address.

function nextClaimableRewardEpoch(
    address _rewardOwner
) external view returns (
    uint256);

Returns the next claimable reward epoch for a reward owner.

function receiveInflation(
) external payable;

Receive native tokens from inflation.

Only the inflation contract can call this method.

function setDailyAuthorizedInflation(
    uint256 _toAuthorizeWei
) external;

Notify the receiver that it is entitled to receive a new inflation amount.

Only the inflation contract can call this method.

function setDataProviderFeePercentage(
    uint256 _feePercentageBIPS
) external returns (
    uint256);

Sets the fee a data provider keeps from all delegations.

Takes effect after feeValueUpdateOffset reward epochs have elapsed.

When called multiple times inside the same reward epoch, only the last value remains.

function setInitialRewardData(
) external;

Copy initial reward data from oldFtsoRewardManager before starting up this new reward manager. Should be called at the time of switching to the new reward manager, can be called only once, and only by governance.

function setNewFtsoRewardManager(
    address _newFtsoRewardManager
) external;

Sets new ftso reward manager which will take over closing expired reward epochs Should be called at the time of switching to the new reward manager, can be called only once, and only by governance.

function switchToProductionMode(
) external;

Enter the production mode after all the initial governance settings have been set. This enables timelocks and the governance can be obtained afterward by calling governanceSettings.getGovernanceAddress(). Emits GovernedProductionModeEntered.

function updateContractAddresses(
    bytes32[] _contractNameHashes,
    address[] _contractAddresses
) external;

External method called from AddressUpdater only.

modifier nonReentrant()

Prevents a contract from calling itself, directly or indirectly. Calling a nonReentrant function from another nonReentrant function is not supported. It is possible to prevent this from happening by making the nonReentrant function external, and make it call a private function that does the actual work.

modifier onlyAddressUpdater()

Only the AdressUpdater contract can call this method. Its address is set at construction time but it can also update itself.

modifier onlyExecutorAndAllowedRecipient(    address _rewardOwner,
    address _recipient)

Only the reward owner and its authorized executors can call this method. Executors can only send rewards to authorized recipients. See ClaimSetupManager.

modifier onlyFtsoManager()

Only the ftsoManager contract can call this method.

modifier onlyIfActive()

This method can only be called if the contract is active.

modifier onlyInflation()

Only the Inflation contract can call this method.

    bool active

Whether rewards can be claimed from this reward manager.

    contract IIClaimSetupManager claimSetupManager

The ClaimSetupManager contract that helps automate reward claiming.

    uint256 firstClaimableRewardEpoch

Epochs before the token distribution event at Flare launch were not be claimable. This variable holds the first reward epoch that was claimable.

    contract IIFtsoManager ftsoManager

The FtsoManager contract that controls reward distribution.

    contract IGovernanceSettings governanceSettings

Governance Settings.

    address newFtsoRewardManager

Address of the new FtsoRewardManager that replaced this one.

    address oldFtsoRewardManager

Address of the old FtsoRewardManager, replaced by this one.

    bool productionMode

When true, governance is enabled and cannot be disabled. See switchToProductionMode.

    mapping(bytes4 => struct GovernedBase.TimelockedCall) timelockedCalls

List of pending timelocked governance calls.

    contract WNat wNat

Address of the wrapped native token (WNat) contract.