IDropSinglePhase1155

The interface IDropSinglePhase1155 is written for thirdweb's 'DropSinglePhase' contracts, which are distribution mechanisms for tokens. An authorized wallet can set a claim condition for the distribution of the contract's tokens. 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 tokenId, uint256 quantity, address currency, uint256 pricePerToken, IDropSinglePhase1155.AllowlistProof allowlistProof, bytes data) external payable

Parameters

Name	Type	Description
receiver	address	undefined
tokenId	uint256	undefined
quantity	uint256	undefined
currency	address	undefined
pricePerToken	uint256	undefined
allowlistProof	IDropSinglePhase1155.AllowlistProof	undefined
data	bytes	undefined

setClaimConditions

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

Parameters

Name	Type	Description
tokenId	uint256	undefined
phase	IClaimCondition.ClaimCondition	undefined
resetClaimEligibility	bool	undefined

Events

ClaimConditionUpdated

event ClaimConditionUpdated(uint256 indexed tokenId, IClaimCondition.ClaimCondition condition, bool resetEligibility)

Emitted when the contract's claim conditions are updated.

Parameters

Name	Type	Description
tokenId indexed	uint256	undefined
condition	IClaimCondition.ClaimCondition	undefined
resetEligibility	bool	undefined

TokensClaimed

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

Emitted when tokens are claimed via claim.

Parameters

Name	Type	Description
claimer indexed	address	undefined
receiver indexed	address	undefined
tokenId indexed	uint256	undefined
quantityClaimed	uint256	undefined