Skip to main content

Drop

Methods​

claim​

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

Parameters​

NameTypeDescription
_receiveraddressundefined
_quantityuint256undefined
_currencyaddressundefined
_pricePerTokenuint256undefined
_allowlistProofIDrop.AllowlistProofundefined
_databytesundefined

claimCondition​

function claimCondition() external view returns (uint256 currentStartId, uint256 count)

The active conditions for claiming tokens.

Returns​

NameTypeDescription
currentStartIduint256undefined
countuint256undefined

getActiveClaimConditionId​

function getActiveClaimConditionId() external view returns (uint256)

At any given moment, returns the uid for the active claim condition.

Returns​

NameTypeDescription
_0uint256undefined

getClaimConditionById​

function getClaimConditionById(uint256 _conditionId) external view returns (struct IClaimCondition.ClaimCondition condition)

Returns the claim condition at the given uid.

Parameters​

NameTypeDescription
_conditionIduint256undefined

Returns​

NameTypeDescription
conditionIClaimCondition.ClaimConditionundefined

getSupplyClaimedByWallet​

function getSupplyClaimedByWallet(uint256 _conditionId, address _claimer) external view returns (uint256 supplyClaimedByWallet)

Returns the supply claimed by claimer for a given conditionId.

Parameters​

NameTypeDescription
_conditionIduint256undefined
_claimeraddressundefined

Returns​

NameTypeDescription
supplyClaimedByWalletuint256undefined

setClaimConditions​

function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility) external nonpayable

Parameters​

NameTypeDescription
_conditionsIClaimCondition.ClaimCondition[]undefined
_resetClaimEligibilityboolundefined

verifyClaim​

function verifyClaim(uint256 _conditionId, address _claimer, uint256 _quantity, address _currency, uint256 _pricePerToken, IDrop.AllowlistProof _allowlistProof) external view returns (bool isOverride)

Parameters​

NameTypeDescription
_conditionIduint256undefined
_claimeraddressundefined
_quantityuint256undefined
_currencyaddressundefined
_pricePerTokenuint256undefined
_allowlistProofIDrop.AllowlistProofundefined

Returns​

NameTypeDescription
isOverrideboolundefined

Events​

ClaimConditionsUpdated​

event ClaimConditionsUpdated(IClaimCondition.ClaimCondition[] claimConditions, bool resetEligibility)

Emitted when the contract's claim conditions are updated.

Parameters​

NameTypeDescription
claimConditionsIClaimCondition.ClaimCondition[]undefined
resetEligibilityboolundefined

TokensClaimed​

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

Emitted when tokens are claimed via claim.

Parameters​

NameTypeDescription
claimConditionIndex indexeduint256undefined
claimer indexedaddressundefined
receiver indexedaddressundefined
startTokenIduint256undefined
quantityClaimeduint256undefined