IBribeCollector
Inherits: IPOLErrors
Functions
payoutToken
Token used for fee payments when claiming bribes
function payoutToken() external view returns (address);
Returns
Name | Type | Description |
---|---|---|
<none> | address | Address of the payout token |
payoutAmount
The amount of payout token that is required to claim POL bribes for all tokens
This works as first come first serve basis. whoever pays this much amount of the payout amount first will get the fees
function payoutAmount() external view returns (uint256);
setPayoutAmount
Update the payout amount to a new value. Must be called by governor
function setPayoutAmount(uint256 _newPayoutAmount) external;
Parameters
Name | Type | Description |
---|---|---|
_newPayoutAmount | uint256 | The value that will be the new payout amount |
claimFees
Claims accumulated bribes in exchange for payout token
Caller must approve payoutAmount of payout token to this contract.
function claimFees(
address _recipient,
address[] calldata _feeTokens,
uint256[] calldata _feeAmounts
) external;
Parameters
Name | Type | Description |
---|---|---|
_recipient | address | The Address to receive claimed tokens |
_feeTokens | address[] | Array of token addresses to claim |
_feeAmounts | uint256[] | Array of amounts to claim for each fee token |
Events
PayoutAmountSet
Emitted when the payout amount is updated by the governor
event PayoutAmountSet(
uint256 indexed oldPayoutAmount, uint256 indexed newPayoutAmount
);
Parameters
Name | Type | Description |
---|---|---|
oldPayoutAmount | uint256 | Previous payout amount |
newPayoutAmount | uint256 | New payout amount set |
FeesClaimed
Emitted when the fees are claimed
event FeesClaimed(
address indexed caller,
address indexed recipient,
address indexed feeToken,
uint256 amount
);
Parameters
Name | Type | Description |
---|---|---|
caller | address | Caller of the claimFees function |
recipient | address | The address to which collected POL bribes will be transferred |
feeToken | address | The address of the fee token to collect |
amount | uint256 | The amount of fee token to transfer |