Drop1155

Methods

claim

function claim(address _receiver, uint256 _tokenId, uint256 _quantity, address _currency, uint256 _pricePerToken, IDrop1155.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	IDrop1155.AllowlistProof	undefined
_data	bytes	undefined

claimCondition

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

Mapping from token ID => the set of all claim conditions, at any given moment, for tokens of the token ID.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
currentStartId	uint256	undefined
count	uint256	undefined

getActiveClaimConditionId

function getActiveClaimConditionId(uint256 _tokenId) external view returns (uint256)

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

Parameters

Name	Type	Description
_tokenId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

getClaimConditionById

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

Returns the claim condition at the given uid.

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_conditionId	uint256	undefined

Returns

Name	Type	Description
condition	IClaimCondition.ClaimCondition	undefined

getSupplyClaimedByWallet

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

Returns the supply claimed by claimer for a given conditionId.

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_conditionId	uint256	undefined
_claimer	address	undefined

Returns

Name	Type	Description
supplyClaimedByWallet	uint256	undefined

setClaimConditions

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

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_conditions	IClaimCondition.ClaimCondition[]	undefined
_resetClaimEligibility	bool	undefined

verifyClaim

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

Parameters

Name	Type	Description
_conditionId	uint256	undefined
_claimer	address	undefined
_tokenId	uint256	undefined
_quantity	uint256	undefined
_currency	address	undefined
_pricePerToken	uint256	undefined
_allowlistProof	IDrop1155.AllowlistProof	undefined

Returns

Name	Type	Description
isOverride	bool	undefined

Events

ClaimConditionsUpdated

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

Emitted when the contract's claim conditions are updated.

Parameters

Name	Type	Description
tokenId indexed	uint256	undefined
claimConditions	IClaimCondition.ClaimCondition[]	undefined
resetEligibility	bool	undefined

TokensClaimed

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

Emitted when tokens are claimed.

Parameters

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