ClaimSetupManager#

function accountToDelegationAccount(
    address _owner
) external view returns (
    address);

Gets the PDA of an account.

function allowedClaimRecipients(
    address _owner
) external view returns (
    address[]);

Gets the addresses of recipients allowed to receive rewards on behalf of an account. Beside these, the owner of the rewards is always authorized. See setAllowedClaimRecipients.

function batchDelegate(
    address[] _delegatees,
    uint256[] _bips
) external;

Undelegates all percentage delegations from the caller's PDA and then delegate to a list of accounts.

See delegate.

function cancelGovernanceCall(
    bytes4 _selector
) external;

Cancel a timelocked governance call before it has been executed.

Only governance can call this method.

function checkExecutorAndAllowedRecipient(
    address _executor,
    address _claimFor,
    address _recipient
) external view;

Checks if an executor can claim on behalf of a given account and send funds to a given recipient address.

Reverts if claiming is not possible, does nothing otherwise.

function claimExecutors(
    address _owner
) external view returns (
    address[]);

Gets the addresses of executors authorized to claim for an account. See setClaimExecutors.

function delegate(
    address _to,
    uint256 _bips
) external;

Delegates a percentage of the caller's PDA's voting power to another address.

function delegateGovernance(
    address _to
) external;

Delegates all the governance vote power of the caller's PDA to another account.

function disableDelegationAccount(
) external;

Disables the Personal Delegation Account (PDA).

When using automatic claiming, all airdrops and FTSO rewards will be sent to the owner's account. Rewards accrued by the PDA will no longer be automatically claimed.

Reverts if there is no PDA.

function enableDelegationAccount(
) external returns (
    contract IDelegationAccount);

Enables (or creates) a Personal Delegation Account (PDA).

When using automatic claiming, all airdrops and FTSO rewards will be sent to the PDA, and any rewards accrued by the PDA will be claimed too.

function executeGovernanceCall(
    bytes4 _selector
) external;

Execute the timelocked governance calls once the timelock period expires.

Only executor can call this method.

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

Returns the configured address updater.

function getAutoClaimAddressesAndExecutorFee(
    address _executor,
    address[] _owners
) external view returns (
    address[] _recipients,
    uint256 _executorFeeValue);

Gets the Personal Delegation Account (PDA) for a list of accounts for which an executor is claiming. Returns owner address instead if the PDA is not created yet or not enabled.

function getDelegationAccountData(
    address _owner
) external view returns (
    contract IDelegationAccount _delegationAccount,
    bool _enabled);

Gets PDA data for an account.

function getExecutorCurrentFeeValue(
    address _executor
) public view returns (
    uint256);

Returns the current fee of a registered executor. Reverts if the executor is not registered.

function getExecutorFeeValue(
    address _executor,
    uint256 _rewardEpoch
) external view returns (
    uint256);

Returns the fee of an executor at a given reward epoch.

function getExecutorInfo(
    address _executor
) external view returns (
    bool _registered,
    uint256 _currentFeeValue);

Returns information about an executor.

function getExecutorScheduledFeeValueChanges(
    address _executor
) external view returns (
    uint256[] _feeValue,
    uint256[] _validFromEpoch,
    bool[] _fixed);

Returns the currently scheduled fee changes of an executor.

function getRegisteredExecutors(
    uint256 _start,
    uint256 _end
) external view returns (
    address[] _registeredExecutors,
    uint256 _totalLength);

Returns the list of executors registered through registerExecutor. Supports paging.

function governance(
) public view returns (
    address);

Returns the current effective governance address.

function isClaimExecutor(
    address _owner,
    address _executor
) external view returns (
    bool);

Returns whether an executor is authorized to claim on behalf of a reward owner. See setClaimExecutors.

function registerExecutor(
    uint256 _feeValue
) external payable returns (
    uint256);

Registers the caller as an executor and sets its initial fee value.

If the executor was already registered, this method only updates the fee, which will take effect after feeValueUpdateOffset reward epochs have elapsed.

Executor must pay a fee in order to register. See registerExecutorFeeValueWei.

function revokeDelegationAt(
    address _who,
    uint256 _blockNumber
) external;

Revokes all delegation from the caller's PDA to a given account at a given block.

Only affects the reads via votePowerOfAtCached() in the specified block.

This method should be used only to prevent rogue delegate voting in the current voting block. To stop delegating use delegate with percentage of 0 or undelegateAll.

function setAllowedClaimRecipients(
    address[] _recipients
) external;

Set the addresses of allowed recipients. The reward owner is always an allowed recipient.

function setAutoClaiming(
    address[] _executors,
    bool _enableDelegationAccount
) external payable;

Sets the addresses of executors and optionally enables (creates) a Personal Delegation Account (PDA).

If any of the executors is a registered executor, some fee needs to be paid.

function setClaimExecutors(
    address[] _executors
) external payable;

Sets the addresses of executors.

If any of the executors is a registered executor, some fee needs to be paid.

function setLibraryAddress(
    address _libraryAddress
) external;

Sets new library address.

Only governance can call this.

function setMaxFeeValueWei(
    uint256 _maxFeeValueWei
) external;

Sets maximum fee allowed for executors, in wei.

Only governance can call this.

function setMinFeeValueWei(
    uint256 _minFeeValueWei
) external;

Sets minimum fee allowed for executors, in wei.

Only governance can call this.

function setRegisterExecutorFeeValueWei(
    uint256 _registerExecutorFeeValueWei
) external;

Sets the fee required to register an executor, which must be higher than 0.

Only governance can call this.

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 transferExternalToken(
    contract IERC20 _token,
    uint256 _amount
) external;

Allows the caller to transfer ERC-20 tokens from their PDA to the owner account.

The main use case is to move ERC-20 tokes received by mistake (by an airdrop, for example) out of the PDA and into the main account, where they can be more easily managed.

Reverts if the target token is the WNat contract: use method withdraw for that.

function undelegateAll(
) external;

Removes all delegations from the caller's PDA.

function undelegateGovernance(
) external;

Undelegates all governance vote power currently delegated by the caller's PDA.

function unregisterExecutor(
) external returns (
    uint256 _validFromEpoch);

Unregisters the caller as an executor.

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

External method called from AddressUpdater only.

function updateExecutorFeeValue(
    uint256 _feeValue
) external returns (
    uint256);

Sets the caller's executor fee. The caller must be an executor registered through registerExecutor.

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

function wNat(
) external view returns (
    contract WNat);

Returns the WNat contract.

function withdraw(
    uint256 _amount
) external;

Allows the caller to transfer WNat wrapped tokens from their PDA to the owner account.

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.

    uint256 feeValueUpdateOffset

Number of reward epochs that must elapse before an executor's fee change takes effect.

    contract IFtsoManager ftsoManager

The FtsoManager contract.

    contract IGovernanceSettings governanceSettings

Governance Settings.

    contract IGovernanceVotePower governanceVP

The GovernanceVotePower contract.

    uint256 maxFeeValueWei

Maximum allowed value for an executor's fee.

    uint256 minFeeValueWei

Minimum allowed value for an executor's fee.

    bool productionMode

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

    uint256 registerExecutorFeeValueWei

Fee that must be paid to register an executor.

    mapping(bytes4 => struct GovernedBase.TimelockedCall) timelockedCalls

List of pending timelocked governance calls.

    contract WNat wNat

The WNat contract.