IRaffl
Git Source Interface that describes the Prize struct, the GameStatus and initialize function so theRafflFactory
knows
how to initialize the Raffl
.
Functions
initialize
Initializes the contract by setting up the raffle variables and theprices
information.
Name | Type | Description |
---|---|---|
entryToken | address | The address of the ERC-20 token as entry. If address zero, entry is the network token |
entryPrice | uint256 | The value of each entry for the raffle. |
minEntries | uint256 | The minimum number of entries to consider make the draw. |
deadline | uint256 | The block timestamp until the raffle will receive entries and that will perform the draw if criteria is met. |
creator | address | The address of the raffle creator |
prizes | Prize[] | The prizes that will be held by this contract. |
tokenGates | TokenGate[] | The token gating that will be imposed to users. |
extraRecipient | ExtraRecipient | The extra recipient that will share the rewards (optional). |
criteriaMet
Checks if the raffle has met the minimum entriesdeadlineExpired
Checks if the deadline has passedupkeepPerformed
Checks if raffle already perfomed the upkeepsetSuccessCriteria
Sets the criteria as settled, sets theGameStatus
as DrawStarted
and emits event
DeadlineSuccessCriteria
Access control: factory
is the only allowed to called this method
setFailedCriteria
Sets the criteria as settled, sets theGameStatus
as FailedDraw
and emits event
DeadlineFailedCriteria
Access control: factory
is the only allowed to called this method
buyEntries
Purchase entries for the raffle. Handles the acquisition of entries for three scenarios: i) Entry is paid with network tokens, ii) Entry is paid with ERC-20 tokens, iii) Entry is free (allows up to 1 entry per user)Name | Type | Description |
---|---|---|
quantity | uint256 | The quantity of entries to purchase. Requirements: - If entry is paid with network tokens, the required amount of network tokens. - If entry is paid with ERC-20, the contract must be approved to spend ERC-20 tokens. - If entry is free, no payment is required. Emits EntriesBought event |
refundEntries
Refund entries for a specific user. Invokable when the draw was not made because the min entries were not enought This method is not available if theentryPrice
was zero
Name | Type | Description |
---|---|---|
user | address | The address of the user whose entries will be refunded. |
refundPrizes
Refund prizes to the creator. Invokable when the draw was not made because the min entries were not enoughtdisperseRewards
Transfers theprizes
to the provably fair and verifiable entrant, sets the GameStatus
as
SuccessDraw
and emits event DrawSuccess
Access control: factory
is the only allowed to called this method through the Chainlink VRF Coordinator
Events
RaffleInitialized
Emit when a new raffle is initialized.EntriesBought
Emit when a user buys entries.Name | Type | Description |
---|---|---|
user | address | The address of the user who purchased the entries. |
entriesBought | uint256 | The number of entries bought. |
value | uint256 | The value of the entries bought. |
EntriesRefunded
Emit when a user gets refunded for their entries.Name | Type | Description |
---|---|---|
user | address | The address of the user who got the refund. |
entriesRefunded | uint256 | The number of entries refunded. |
value | uint256 | The value of the entries refunded. |
PrizesRefunded
Emit when prizes are refunded.DrawSuccess
Emit when a draw is successful.Name | Type | Description |
---|---|---|
requestId | uint256 | The indexed ID of the draw request. |
winnerEntry | uint256 | The entry that won the draw. |
user | address | The address of the winner. |
entries | uint256 | The entries the winner had. |
DeadlineSuccessCriteria
Emit when the criteria for deadline success is met.Name | Type | Description |
---|---|---|
requestId | uint256 | The indexed ID of the deadline request. |
entries | uint256 | The number of entries at the time of the deadline. |
minEntries | uint256 | The minimum number of entries required for success. |
DeadlineFailedCriteria
Emit when the criteria for deadline failure is met.Name | Type | Description |
---|---|---|
entries | uint256 | The number of entries at the time of the deadline. |
minEntries | uint256 | The minimum number of entries required for success. |
TokenGatingChanges
Emit when changes are made to token-gating parameters.Structs
Prize
asset
represents the address of the asset considered as a prize
assetType
defines the type of asset
value
represents the value of the prize. If asset is an ERC20, it’s the amount. If asset is an ERC721,
it’s the tokenId.
TokenGate
token
represents the address of the token gating asset
amount
represents the minimum value of the token gating
ExtraRecipient
recipient
represents the address of the extra recipient of the pooled funds
feePercentage
is the percentage of the pooled funds (after fees) that will be shared to the extra
recipient