Claim / Claim Conditions
Functionality available for contracts that implement the
IDropSinglePhase interface or the
Drop1155 contract.
Enables wallets to claim (mint) NFTs from the contract under specific conditions.
Claim
Claim a specified number of tokens to the connected wallet.
var data = await contract.ERC1155.Claim("{{token_id}}", 1);
Configuration
ClaimTo
The same as claim, but allows specifying the recipient
address rather than using the connected wallet.
var data = await contract.ERC1155.ClaimTo("{{wallet_address}}", "{{token_id}}", 1);
Configuration
CanClaim
Check if tokens are currently available for claiming, optionally specifying if a specific wallet address can claim.
var data = await contract.ERC1155.claimConditions.CanClaim("{{token_id}}", 1, "{{wallet_address}}");
Configuration
tokenId (required)
The token ID of the NFT you want to claim.
Must be a string.
quantity (required)
The amount of tokens to claim.
This checks to see if the specified amount of tokens are available for claiming. i.e.:
- There is sufficient quantity available for claiming.
- This amount of tokens can be claimed in a single transaction.
Must be an int.
addressToCheck (optional)
The wallet address to check if it can claim tokens.
This considers all aspects of the active claim phase, including allowlists, previous claims, etc.
Must be a string.
Return Value
Returns a bool indicating if the specified amount of tokens can be claimed or not.
bool
GetActive
Retrieve the currently active claim phase for a specific token ID, if any.
var data = await contract.ERC1155.claimConditions.GetActive("{{token_id}}");
Configuration
tokenId (required)
The token ID of the NFT you want to get the claim conditions for.
Must be a string.
Return Value
If a claim condition is active, returns a ClaimConditions struct containing the following properties:
{
string availableSupply;
string currentMintSupply;
CurrencyValue currencyMetadata;
string currencyAddress;
string maxClaimableSupply;
string maxClaimablePerWallet;
string waitInSeconds;
}
GetIneligibilityReasons
Get a list of reasons why a specific wallet address is not eligible to claim tokens, if any.
var data = await contract.ERC1155.claimConditions.GetIneligibilityReasons("{{token_id}}", 1, "{{wallet_address}}");
Configuration
tokenId (required)
The token ID of the NFT you want to check if the wallet address can claim.
Must be a string.
quantity (required)
The amount of tokens to check if the wallet address can claim.
Must be a string.
addressToCheck (optional)
The wallet address to check if it can claim tokens.
Must be a string.
Return Value
Returns a list of ClaimEligibility strings, which may be empty.
If the user is eligible to claim tokens, the method will return an empty array.
string[]
// Options:
{
NotEnoughSupply = "There is not enough supply to claim.",
AddressNotAllowed = "This address is not on the allowlist.",
WaitBeforeNextClaimTransaction = "Not enough time since last claim transaction. Please wait.",
AlreadyClaimed = "You have already claimed the token.",
NotEnoughTokens = "There are not enough tokens in the wallet to pay for the claim.",
NoActiveClaimPhase = "There is no active claim phase at the moment. Please check back in later.",
NoClaimConditionSet = "There is no claim condition set.",
NoWallet = "No wallet connected.",
Unknown = "No claim conditions found.",
}
GetClaimerProofs
Returns allowlist information and merkle proofs for a given wallet address.
var data = await contract.ERC1155.claimConditions.GetClaimerProofs("{{token_id}}", "{{wallet_address}}");