Skip to main content

SignatureDrop class

Setup a collection of NFTs where when it comes to minting, you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party..

Example

import { ThirdwebSDK } from "@thirdweb-dev/sdk";

const sdk = new ThirdwebSDK("{{chainName}}");
const contract = sdk.getSignatureDrop("{{contract_address}}");

Constructors

ConstructorModifiersDescription
(constructor)(network, address, storage, options, contractWrapper)Constructs a new instance of the SignatureDrop class

Properties

PropertyModifiersTypeDescription
claimConditionsDropClaimConditions<SignatureDropContract>Configure claim conditions
contractAbistaticany
contractRolesstaticreadonly ["admin", "minter", "transfer"]
contractTypestatic"signature-drop"
encoderContractEncoder<SignatureDropContract>
estimatorGasCostEstimator<SignatureDropContract>
eventsContractEvents<SignatureDropContract>
metadataContractMetadata<SignatureDropContract, typeof SignatureDrop.schema>
platformFeesContractPlatformFee<SignatureDropContract>
revealerDelayedReveal<SignatureDropContract>Delayed reveal
rolesContractRoles<SignatureDropContract, typeof SignatureDrop.contractRoles[number]>
royaltiesContractRoyalty<SignatureDropContract, typeof SignatureDrop.schema>Configure royalties
salesContractPrimarySale<SignatureDropContract>
signatureErc721WithQuantitySignatureMintableSignature Minting

Methods

MethodModifiersDescription
burnToken(tokenId)Burn a single NFT
claim(quantity, checkERC20Allowance)Claim NFTs to the connected wallet.
claimTo(destinationAddress, quantity, checkERC20Allowance)Claim unique NFTs to a specific Wallet
createBatch(metadatas, options)Create a batch of unique NFTs to be claimed in the future
getAll(queryParams)Get All Minted NFTs
getAllClaimed(queryParams)Get All Claimed NFTs
getAllUnclaimed(queryParams)Get All Unclaimed NFTs
getClaimTransaction(destinationAddress, quantity, checkERC20Allowance)Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
getOwned(walletAddress)Get Owned NFTs
getOwnedTokenIds(walletAddress)
isTransferRestricted()Get whether users can transfer NFTs from this contract
totalClaimedSupply()Get the claimed supply
totalSupply()Get the total count NFTs in this drop contract, both claimed and unclaimed
totalUnclaimedSupply()Get the unclaimed supply

Signature:

export declare class SignatureDrop extends Erc721<SignatureDropContract>

Extends: Erc721<SignatureDropContract