Skip to main content

ClaimerFactory

Git Source

Author: G9 Software Inc.

Factory to deploy new VRGDA Claimer contracts for PoolTogether V5.

State Variables

allClaimers

List of all claimers deployed by this factory.

Claimer[] public allClaimers;

deployedClaimer

Mapping to verify if a Claimer has been deployed via this factory.

mapping(Claimer claimer => bool deployedFromFactory) public deployedClaimer;

Functions

createClaimer

Creates a new Claimer with the provided parameters.

function createClaimer(PrizePool _prizePool, uint256 _timeToReachMaxFee, UD2x18 _maxFeePortionOfPrize)
external
returns (Claimer);

totalClaimers

Total number of claimers deployed by this factory.

function totalClaimers() external view returns (uint256);

Returns

NameTypeDescription
<none>uint256Number of claimers deployed by this factory.

Events

ClaimerCreated

Emitted when a new claimer contract is created.

event ClaimerCreated(
Claimer indexed claimer, PrizePool indexed prizePool, uint256 timeToReachMaxFee, UD2x18 maxFeePortionOfPrize
);

Parameters

NameTypeDescription
claimerClaimer
prizePoolPrizePoolThe prize pool to claim for
timeToReachMaxFeeuint256The time it should take to reach the maximum fee
maxFeePortionOfPrizeUD2x18The maximum fee that can be charged as a portion of the prize size. Fixed point 18 number