Skip to content

FtsoRewardManager#

Source | Inherits from IIFtsoRewardManager, Governed, ReentrancyGuard, AddressUpdatable

Handles reward distribution and claiming related to the FTSO system.

More specifically, this contract:

  • Distributes rewards according to instructions from the FtsoManager.
  • Allows data providers, delegators and executors to claim rewards.

Functions#

accrueUnearnedRewards#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_epochId uint256
_priceEpochDurationSeconds uint256
_priceEpochEndTime uint256

activate#

Defined in FtsoRewardManager (Docs, Source).

function activate(
) external;

Activates reward manager (allows claiming rewards).

Only governance can call this method.

active#

Defined in IFtsoRewardManager (Docs, Source).

function active(
) external view returns (
    bool);

Whether rewards can be claimed from this reward manager.

autoClaim#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardOwners address[] List of reward owners to claim for.
_rewardEpoch uint256 Last reward epoch ID to claim for. All previous epochs with pending rewards will be claimed too.

cancelGovernanceCall#

Defined in GovernedBase (Docs, Source).

function cancelGovernanceCall(
    bytes4 _selector
) external;

Cancel a timelocked governance call before it has been executed.

Only governance can call this method.

Parameters Type Description
_selector bytes4 The method selector.

claim#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardOwner address Address of the reward owner.
_recipient address payable Address to transfer claimed rewards to.
_rewardEpoch uint256 Last reward epoch to claim for. All previous epochs with pending rewards will be claimed too.
_wrap bool Whether claimed rewards should be wrapped through the WNat contract before transferring them to the _recipient. This parameter is offered as a convenience.
Returns Type Description
_rewardAmount uint256 Total amount of claimed rewards (wei).

claimFromDataProviders#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardOwner address Address of the reward owner.
_recipient address payable Address to transfer claimed rewards to.
_rewardEpochs uint256[] Array of reward epoch IDs to claim for.
_dataProviders address[] Array of addresses of the data providers to claim the reward from.
_wrap bool Whether claimed rewards should be wrapped through the WNat contract before transferring them to the _recipient. This parameter is offered as a convenience.
Returns Type Description
_rewardAmount uint256 Total amount of claimed rewards (wei).

claimReward#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_recipient address payable Address to transfer funds to.
_rewardEpochs uint256[] Array of reward epoch numbers to claim for.
Returns Type Description
_rewardAmount uint256 Amount of total claimed rewards (wei).

claimRewardFromDataProviders#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_recipient address payable Address to transfer funds to.
_rewardEpochs uint256[] Array of reward epoch numbers to claim for.
_dataProviders address[] Array of addresses of the data providers to claim the reward from.
Returns Type Description
_rewardAmount uint256 Total amount of claimed rewards (wei).

closeExpiredRewardEpoch#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardEpoch uint256

constructor#

Defined in FtsoRewardManager (Docs, Source).

constructor(
    address _governance,
    address _addressUpdater,
    address _oldFtsoRewardManager,
    uint256 _feePercentageUpdateOffset,
    uint256 _defaultFeePercentage
) public;

constructor#

Defined in Governed (Docs, Source).

constructor(
    address _governance
) public;
Parameters Type Description
_governance address Governance contract. Must not be zero.

deactivate#

Defined in FtsoRewardManager (Docs, Source).

function deactivate(
) external;

Deactivates reward manager (prevents claiming rewards).

Only governance can call this method.

defaultFeePercentage#

Defined in FtsoRewardManager (Docs, Source).

function defaultFeePercentage(
) external view returns (
    uint256);

Returns the configured default fee percentage.

distributeRewards#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_addresses address[]
_weights uint256[]
_totalWeight uint256
_epochId uint256
_ftso address
_priceEpochDurationSeconds uint256
_currentRewardEpoch uint256
_priceEpochEndTime uint256
_votePowerBlock uint256

enableClaims#

Defined in FtsoRewardManager (Docs, Source).

function enableClaims(
) external;

Enable claiming for current and all future reward epochs.

Only governance can call this method.

executeGovernanceCall#

Defined in GovernedBase (Docs, Source).

function executeGovernanceCall(
    bytes4 _selector
) external;

Execute the timelocked governance calls once the timelock period expires.

Only executor can call this method.

Parameters Type Description
_selector bytes4 The method selector (only one timelocked call per method is stored).

feePercentageUpdateOffset#

Defined in FtsoRewardManager (Docs, Source).

function feePercentageUpdateOffset(
) external view returns (
    uint256);

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

firstClaimableRewardEpoch#

Defined in IIFtsoRewardManager (Docs, Source).

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.

Returns Type Description
[0] uint256 uint256 The first reward epoch that can be claimed.

getAddressUpdater#

Defined in AddressUpdatable (Docs, Source).

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

Returns the configured address updater.

Returns Type Description
_addressUpdater address The AddresUpdater contract that can update our contract address list, as a response to a governance call.

getClaimedReward#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardEpoch uint256 Reward epoch ID to query.
_dataProvider address Address of the data provider to query.
_claimer address Address of the reward owner to query.
Returns Type Description
_claimed bool Whether the reward has been claimed or not.
_amount uint256 Accrued amount in wei.

getContractName#

Defined in FtsoRewardManager (Docs, Source).

function getContractName(
) external pure returns (
    string);

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

Returns Type Description
[0] string Contract name.

getCurrentRewardEpoch#

Defined in FtsoRewardManager (Docs, Source).

function getCurrentRewardEpoch(
) external view returns (
    uint256);

Returns the current reward epoch ID.

getDataProviderCurrentFeePercentage#

Defined in FtsoRewardManager (Docs, Source).

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

Returns the current fee percentage of a data provider.

Parameters Type Description
_dataProvider address Address of the queried data provider.
Returns Type Description
[0] uint256

getDataProviderFeePercentage#

Defined in FtsoRewardManager (Docs, Source).

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

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

Parameters Type Description
_dataProvider address Address of the queried data provider.
_rewardEpoch uint256 Reward epoch ID.
Returns Type Description
_feePercentageBIPS uint256 Fee percentage in BIPS.

getDataProviderPerformanceInfo#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardEpoch uint256 Reward epoch ID.
_dataProvider address Address of the data provider to query.
Returns Type Description
_rewardAmount uint256 Amount of rewards (wei).
_votePowerIgnoringRevocation uint256 Vote power, not including revocations.

getDataProviderScheduledFeePercentageChanges#

Defined in FtsoRewardManager (Docs, Source).

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

Returns the scheduled fee percentage changes for a data provider.

Parameters Type Description
_dataProvider address Address of the queried data provider.
Returns Type Description
_feePercentageBIPS uint256[] Array of fee percentages in BIPS.
_validFromEpoch uint256[] Array of block numbers from which the fee settings are effective.
_fixed bool[] Array of boolean values indicating whether settings are subject to change or not.

getEpochReward#

Defined in FtsoRewardManager (Docs, Source).

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

Returns information on an epoch's rewards.

Parameters Type Description
_rewardEpoch uint256 Reward epoch ID.
Returns Type Description
_totalReward uint256 Total amount of rewards accrued on that epoch, in wei.
_claimedReward uint256 Total amount of rewards that have already been claimed, in wei.

getEpochsWithClaimableRewards#

Defined in FtsoRewardManager (Docs, Source).

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.

Returns Type Description
_startEpochId uint256 The oldest epoch ID that allows reward claiming.
_endEpochId uint256 The newest epoch ID that allows reward claiming.

getEpochsWithUnclaimedRewards#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_beneficiary address Address of the reward owner to query. Reverts if it uses delegation by amount.
Returns Type Description
_epochIds uint256[] Array of epoch IDs.

getExpectedBalance#

Defined in FtsoRewardManager (Docs, Source).

function getExpectedBalance(
) external view returns (
    uint256);

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

Returns Type Description
[0] uint256 Expected native token balance.

getInflationAddress#

Defined in FtsoRewardManager (Docs, Source).

function getInflationAddress(
) external view returns (
    address);

Returns the address of the Inflation contract.

getInitialRewardEpoch#

Defined in FtsoRewardManager (Docs, Source).

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.

getRewardEpochToExpireNext#

Defined in FtsoRewardManager (Docs, Source).

function getRewardEpochToExpireNext(
) external view returns (
    uint256);

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

getRewardEpochVotePowerBlock#

Defined in FtsoRewardManager (Docs, Source).

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

Returns the vote power block of a given reward epoch.

Parameters Type Description
_rewardEpoch uint256 Reward epoch ID.

getStateOfRewards#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_beneficiary address Address of the beneficiary to query. It can be a data provider or a delegator, for example.
Reverts if the queried address is delegating by amount.
_rewardEpoch uint256 Reward epoch ID to query.
Returns Type Description
_dataProviders address[] Array of addresses of data providers.
_rewardAmounts uint256[] Array of reward amounts received from each provider, in wei.
_claimed bool[] Array of boolean values indicating whether each reward has been claimed or not.
_claimable bool Boolean value indicating whether rewards are claimable or not.

getStateOfRewardsFromDataProviders#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_beneficiary address Address of beneficiary to query.
_rewardEpoch uint256 Reward epoch ID to query.
_dataProviders address[] Array of addresses of the data providers to query.
Returns Type Description
_rewardAmounts uint256[] Array of reward amounts received from each provider, in wei.
_claimed bool[] Array of boolean values indicating whether each reward has been claimed or not.
_claimable bool Boolean value indicating whether rewards are claimable or not.

getTokenPoolSupplyData#

Defined in FtsoRewardManager (Docs, Source).

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

Returns token pool supply data.

Returns Type Description
_lockedFundsWei uint256 Total amount of funds ever locked in the token pool (wei). _lockedFundsWei - _totalClaimedWei is the amount currently locked and outside the circulating supply.
_totalInflationAuthorizedWei uint256 Total inflation authorized amount (wei).
_totalClaimedWei uint256 Total claimed amount (wei).

getTotals#

Defined in FtsoRewardManager (Docs, Source).

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.

Returns Type Description
_totalAwardedWei uint256 Rewards that were distributed (wei).
_totalClaimedWei uint256 Distributed rewards that were claimed in time (wei).
_totalExpiredWei uint256 Distributed rewards that were not claimed in time and expired (wei).
_totalUnearnedWei uint256 Rewards that were unearned (due to FTSO being in fallback mode) and thus were not distributed (wei).
_totalBurnedWei uint256 Rewards that were unearned or expired and thus burned (wei).
_totalInflationAuthorizedWei uint256 Total inflation authorized amount (wei).
_totalInflationReceivedWei uint256 Total inflation received amount (wei).
_lastInflationAuthorizationReceivedTs uint256 UNIX timestamp of the last inflation authorization.
_dailyAuthorizedInflation uint256 Inflation authorized amount (wei) at the time of last authorization.

getUnclaimedReward#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_rewardEpoch uint256 Queried reward epoch ID.
_dataProvider address Address of the queried data provider.
Returns Type Description
_amount uint256 Amount available to be claimed, in wei.
_weight uint256 Portion of total vote power used in this reward epoch that has not yet claimed its reward, in BIPS. It decreases to 0 when all data providers have claimed their rewards.

governance#

Defined in GovernedBase (Docs, Source).

function governance(
) public view returns (
    address);

Returns the current effective governance address.

nextClaimableRewardEpoch#

Defined in FtsoRewardManager (Docs, Source).

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

Returns the next claimable reward epoch for a reward owner.

Parameters Type Description
_rewardOwner address Address of the reward owner to query.

receiveInflation#

Defined in FtsoRewardManager (Docs, Source).

function receiveInflation(
) external payable;

Receive native tokens from inflation.

Only the inflation contract can call this method.

setDailyAuthorizedInflation#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_toAuthorizeWei uint256 The amount of inflation that can be awarded in the coming day, in wei.

setDataProviderFeePercentage#

Defined in FtsoRewardManager (Docs, Source).

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.

Parameters Type Description
_feePercentageBIPS uint256 Fee percentage in BIPS.
Returns Type Description
[0] uint256

setInitialRewardData#

Defined in FtsoRewardManager (Docs, Source).

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.

setNewFtsoRewardManager#

Defined in FtsoRewardManager (Docs, Source).

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.

switchToProductionMode#

Defined in GovernedBase (Docs, Source).

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.

updateContractAddresses#

Defined in AddressUpdatable (Docs, Source).

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

External method called from AddressUpdater only.

Modifiers#

mustBalance#

Defined in FtsoRewardManager (Docs, Source).

modifier mustBalance()

nonReentrant#

Defined in ReentrancyGuard (Source).

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.

onlyAddressUpdater#

Defined in AddressUpdatable (Docs, Source).

modifier onlyAddressUpdater()

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

onlyExecutorAndAllowedRecipient#

Defined in FtsoRewardManager (Docs, Source).

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.

onlyFtsoManager#

Defined in FtsoRewardManager (Docs, Source).

modifier onlyFtsoManager()

Only the ftsoManager contract can call this method.

onlyGovernance#

Defined in GovernedBase (Docs, Source).

modifier onlyGovernance()

onlyIfActive#

Defined in FtsoRewardManager (Docs, Source).

modifier onlyIfActive()

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

onlyImmediateGovernance#

Defined in GovernedBase (Docs, Source).

modifier onlyImmediateGovernance()

onlyInflation#

Defined in FtsoRewardManager (Docs, Source).

modifier onlyInflation()

Only the Inflation contract can call this method.

Structures#

RewardClaim#

Defined in FtsoRewardManager (Docs, Source).

struct RewardClaim {
  bool claimed;
  uint128 amount;
}

RewardState#

Defined in FtsoRewardManager (Docs, Source).

struct RewardState {
  address[] dataProviders;
  uint256[] weights;
  uint256[] amounts;
  bool[] claimed;
}

TimelockedCall#

Defined in GovernedBase (Docs, Source).

struct TimelockedCall {
  uint256 allowedAfterTimestamp;
  bytes encodedCall;
}

UnclaimedRewardState#

Defined in FtsoRewardManager (Docs, Source).

struct UnclaimedRewardState {
  uint128 amount;
  uint128 weight;
}

Variables#

active#

Defined in FtsoRewardManager (Docs, Source).

    bool active

Whether rewards can be claimed from this reward manager.

claimSetupManager#

Defined in FtsoRewardManager (Docs, Source).

    contract IIClaimSetupManager claimSetupManager

The ClaimSetupManager contract that helps automate reward claiming.

firstClaimableRewardEpoch#

Defined in FtsoRewardManager (Docs, Source).

    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.

ftsoManager#

Defined in FtsoRewardManager (Docs, Source).

    contract IIFtsoManager ftsoManager

The FtsoManager contract that controls reward distribution.

governanceSettings#

Defined in GovernedBase (Docs, Source).

    contract IGovernanceSettings governanceSettings

Governance Settings.

newFtsoRewardManager#

Defined in FtsoRewardManager (Docs, Source).

    address newFtsoRewardManager

Address of the new FtsoRewardManager that replaced this one.

oldFtsoRewardManager#

Defined in FtsoRewardManager (Docs, Source).

    address oldFtsoRewardManager

Address of the old FtsoRewardManager, replaced by this one.

productionMode#

Defined in GovernedBase (Docs, Source).

    bool productionMode

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

timelockedCalls#

Defined in GovernedBase (Docs, Source).

    mapping(bytes4 => struct GovernedBase.TimelockedCall) timelockedCalls

List of pending timelocked governance calls.

wNat#

Defined in FtsoRewardManager (Docs, Source).

    contract WNat wNat

Address of the wrapped native token (WNat) contract.


Last update: 2024-03-01