Skip to main content

DropSinglePhase

Methods

claim

function claim(address _receiver, uint256 _quantity, address _currency, uint256 _pricePerToken, IDropSinglePhase.AllowlistProof _allowlistProof, bytes _data) external payable

Lets an account claim tokens.

Parameters

NameTypeDescription
_receiveraddressundefined
_quantityuint256undefined
_currencyaddressundefined
_pricePerTokenuint256undefined
_allowlistProofIDropSinglePhase.AllowlistProofundefined
_databytesundefined

claimCondition

function claimCondition() external view returns (uint256 startTimestamp, uint256 maxClaimableSupply, uint256 supplyClaimed, uint256 quantityLimitPerTransaction, uint256 waitTimeInSecondsBetweenClaims, bytes32 merkleRoot, uint256 pricePerToken, address currency)

The active conditions for claiming tokens.

Returns

NameTypeDescription
startTimestampuint256undefined
maxClaimableSupplyuint256undefined
supplyClaimeduint256undefined
quantityLimitPerTransactionuint256undefined
waitTimeInSecondsBetweenClaimsuint256undefined
merkleRootbytes32undefined
pricePerTokenuint256undefined
currencyaddressundefined

getClaimTimestamp

function getClaimTimestamp(address _claimer) external view returns (uint256 lastClaimedAt, uint256 nextValidClaimTimestamp)

Returns the timestamp for when a claimer is eligible for claiming NFTs again.

Parameters

NameTypeDescription
_claimeraddressundefined

Returns

NameTypeDescription
lastClaimedAtuint256undefined
nextValidClaimTimestampuint256undefined

setClaimConditions

function setClaimConditions(IClaimCondition.ClaimCondition _condition, bool _resetClaimEligibility) external nonpayable

Lets a contract admin set claim conditions.

Parameters

NameTypeDescription
_conditionIClaimCondition.ClaimConditionundefined
_resetClaimEligibilityboolundefined

verifyClaim

function verifyClaim(address _claimer, uint256 _quantity, address _currency, uint256 _pricePerToken, bool verifyMaxQuantityPerTransaction) external view

Checks a request to claim NFTs against the active claim condition's criteria.

Parameters

NameTypeDescription
_claimeraddressundefined
_quantityuint256undefined
_currencyaddressundefined
_pricePerTokenuint256undefined
verifyMaxQuantityPerTransactionboolundefined

verifyClaimMerkleProof

function verifyClaimMerkleProof(address _claimer, uint256 _quantity, IDropSinglePhase.AllowlistProof _allowlistProof) external view returns (bool validMerkleProof, uint256 merkleProofIndex)

Checks whether a claimer meets the claim condition's allowlist criteria.

Parameters

NameTypeDescription
_claimeraddressundefined
_quantityuint256undefined
_allowlistProofIDropSinglePhase.AllowlistProofundefined

Returns

NameTypeDescription
validMerkleProofboolundefined
merkleProofIndexuint256undefined

Events

ClaimConditionUpdated

event ClaimConditionUpdated(IClaimCondition.ClaimCondition condition, bool resetEligibility)

Parameters

NameTypeDescription
conditionIClaimCondition.ClaimConditionundefined
resetEligibilityboolundefined

TokensClaimed

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

Parameters

NameTypeDescription
claimer indexedaddressundefined
receiver indexedaddressundefined
startTokenId indexeduint256undefined
quantityClaimeduint256undefined