Skip to main content

IDropSinglePhase

Methods

claim

function claim(address receiver, uint256 quantity, address currency, uint256 pricePerToken, IDropSinglePhase.AllowlistProof allowlistProof, bytes data) external payable

Lets an account claim a given quantity of NFTs.

Parameters

NameTypeDescription
receiveraddressThe receiver of the NFTs to claim.
quantityuint256The quantity of NFTs to claim.
currencyaddressThe currency in which to pay for the claim.
pricePerTokenuint256The price per token to pay for the claim.
allowlistProofIDropSinglePhase.AllowlistProofThe proof of the claimer's inclusion in the merkle root allowlist of the claim conditions that apply.
databytesArbitrary bytes data that can be leveraged in the implementation of this interface.

setClaimConditions

function setClaimConditions(IClaimCondition.ClaimCondition phase, bool resetClaimEligibility) external nonpayable

Lets a contract admin (account with DEFAULT_ADMIN_ROLE) set claim conditions.

Parameters

NameTypeDescription
phaseIClaimCondition.ClaimConditionClaim condition to set.
resetClaimEligibilityboolWhether to reset limitLastClaimTimestamp and limitMerkleProofClaim values when setting new claim conditions.

Events

ClaimConditionUpdated

event ClaimConditionUpdated(IClaimCondition.ClaimCondition condition, bool resetEligibility)

Emitted when the contract's claim conditions are updated.

Parameters

NameTypeDescription
conditionIClaimCondition.ClaimConditionundefined
resetEligibilityboolundefined

TokensClaimed

event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed startTokenId, uint256 quantityClaimed)

Emitted when tokens are claimed via claim.

Parameters

NameTypeDescription
claimer indexedaddressundefined
receiver indexedaddressundefined
startTokenId indexeduint256undefined
quantityClaimeduint256undefined