​

IRaffl

Git Source

Interface that describes the Prize struct, the GameStatus and initialize function so the RafflFactory knows how to initialize the Raffl.

​

Functions

​

initialize

Initializes the contract by setting up the raffle variables and the prices information.

function initialize(
    address entryToken,
    uint256 entryPrice,
    uint256 minEntries,
    uint256 deadline,
    address creator,
    Prize[] calldata prizes,
    TokenGate[] calldata tokenGates,
    ExtraRecipient calldata extraRecipient
)
    external;

Parameters

​

criteriaMet

Checks if the raffle has met the minimum entries

function criteriaMet() external view returns (bool);

​

deadlineExpired

Checks if the deadline has passed

function deadlineExpired() external view returns (bool);

​

upkeepPerformed

Checks if raffle already perfomed the upkeep

function upkeepPerformed() external view returns (bool);

​

setSuccessCriteria

Sets the criteria as settled, sets the GameStatus as DrawStarted and emits event DeadlineSuccessCriteria

Access control: factory is the only allowed to called this method

function setSuccessCriteria(uint256 requestId) external;

​

setFailedCriteria

Sets the criteria as settled, sets the GameStatus as FailedDraw and emits event DeadlineFailedCriteria

Access control: factory is the only allowed to called this method

function setFailedCriteria() external;

​

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)

function buyEntries(uint256 quantity) external payable;

Parameters

​

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 the entryPrice was zero

function refundEntries(address user) external;

Parameters

​

refundPrizes

Refund prizes to the creator.

Invokable when the draw was not made because the min entries were not enought

function refundPrizes() external payable;

​

disperseRewards

Transfers the prizes 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

function disperseRewards(uint256 requestId, uint256 randomNumber) external;

​

Events

​

RaffleInitialized

Emit when a new raffle is initialized.

event RaffleInitialized();

​

EntriesBought

Emit when a user buys entries.

event EntriesBought(address indexed user, uint256 entriesBought, uint256 value);

Parameters

​

EntriesRefunded

Emit when a user gets refunded for their entries.

event EntriesRefunded(address indexed user, uint256 entriesRefunded, uint256 value);

Parameters

​

PrizesRefunded

Emit when prizes are refunded.

event PrizesRefunded();

​

DrawSuccess

Emit when a draw is successful.

event DrawSuccess(uint256 indexed requestId, uint256 winnerEntry, address user, uint256 entries);

Parameters

​

DeadlineSuccessCriteria

Emit when the criteria for deadline success is met.

event DeadlineSuccessCriteria(uint256 indexed requestId, uint256 entries, uint256 minEntries);

Parameters

​

DeadlineFailedCriteria

Emit when the criteria for deadline failure is met.

event DeadlineFailedCriteria(uint256 entries, uint256 minEntries);

Parameters

​

TokenGatingChanges

Emit when changes are made to token-gating parameters.

event TokenGatingChanges();

​

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.

struct Prize {
    address asset;
    AssetType assetType;
    uint256 value;
}

​

TokenGate

token represents the address of the token gating asset

amount represents the minimum value of the token gating

struct TokenGate {
    address token;
    uint256 amount;
}

​

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

struct ExtraRecipient {
    address recipient;
    uint64 sharePercentage;
}

​

Enums

​

AssetType

Asset type describe the kind of token behind the prize tok describes how the periods between release tokens.

enum AssetType {
    ERC20,
    ERC721
}

​

GameStatus

GameStatus defines the possible states of the game (0) Initialized: Raffle is initialized and ready to receive entries until the deadline (1) FailedDraw: Raffle deadline was hit by the Chailink Upkeep but minimum entries were not met (2) DrawStarted: Raffle deadline was hit by the Chainlink Upkeep and it’s waiting for the Chainlink VRF with the lucky winner (3) SuccessDraw: Raffle received the provably fair and verifiable random lucky winner and distributed rewards.

enum GameStatus {
    Initialized,
    FailedDraw,
    DrawStarted,
    SuccessDraw
}