IDrop
The interface IDrop
is written for thirdweb's 'Drop' contracts, which are distribution mechanisms for tokens. An authorized wallet can set a series of claim conditions, ordered by their respective startTimestamp
. A claim condition defines criteria under which accounts can mint tokens. Claim conditions can be overwritten or added to by the contract admin. At any moment, there is only one active claim condition.
Methods
claim
function claim(address receiver, uint256 quantity, address currency, uint256 pricePerToken, IDrop.AllowlistProof allowlistProof, bytes data) external payable
Parameters
Name | Type | Description |
---|---|---|
receiver | address | undefined |
quantity | uint256 | undefined |
currency | address | undefined |
pricePerToken | uint256 | undefined |
allowlistProof | IDrop.AllowlistProof | undefined |
data | bytes | undefined |
setClaimConditions
function setClaimConditions(IClaimCondition.ClaimCondition[] phases, bool resetClaimEligibility) external nonpayable
Parameters
Name | Type | Description |
---|---|---|
phases | IClaimCondition.ClaimCondition[] | undefined |
resetClaimEligibility | bool | undefined |
Events
ClaimConditionsUpdated
event ClaimConditionsUpdated(IClaimCondition.ClaimCondition[] claimConditions, bool resetEligibility)
Emitted when the contract's claim conditions are updated.
Parameters
Name | Type | Description |
---|---|---|
claimConditions | IClaimCondition.ClaimCondition[] | undefined |
resetEligibility | bool | undefined |
TokensClaimed
event TokensClaimed(uint256 indexed claimConditionIndex, address indexed claimer, address indexed receiver, uint256 startTokenId, uint256 quantityClaimed)
Emitted when tokens are claimed via claim
.
Parameters
Name | Type | Description |
---|---|---|
claimConditionIndex indexed | uint256 | undefined |
claimer indexed | address | undefined |
receiver indexed | address | undefined |
startTokenId | uint256 | undefined |
quantityClaimed | uint256 | undefined |