Skip to main content

FeeDistributor

FeeAllocation

Share of incoming fees given to recipient.

Fields

NameTypeDescription
recipientaddressWho these fees should be delivered to
feeRatioFPUnsignedFraction of incoming fees sent to this recipient. In range (0, 1]
pendingFeesFPUnsignedAccumulated fees that have not yet been delivered
distributionTypeenum DistributionTypeSee DistributionType
struct FeeAllocation {
address recipient;
FPUnsigned feeRatio;
FPUnsigned pendingFees;
enum DistributionType distributionType;
}

DistributionType

Either the type of a stored fee allocation, or a command to change the state.

Values

NameDescription
DELETEDCommand only: Mark for fee distribution and deletion
FORCE_DELETEDCommand only: Mark for deletion. Any accrued fees will be lost!!
DISABLEDState/Command: Temporarily disabled; does not accrue or distribute fees
DIRECTState/Command: Distribute fees via IERC20.transfer
NOTIFYState/Command: Distribute fees via IRewardRecipient.transferRewardAmount
enum DistributionType {
DELETED,
FORCE_DELETED,
DISABLED,
DIRECT,
NOTIFY
}