EditionDrop class
Setup a collection of NFTs with a customizable number of each NFT that are minted as users claim them.
Example
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
const sdk = new ThirdwebSDK("{{chainName}}");
const contract = await sdk.getContract("{{contract_address}}", "edition-drop");
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(network, address, storage, options, abi, chainId, contractWrapper) | Constructs a new instance of the EditionDrop class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| abi | Abi | ||
| checkout | PaperCheckout<PrebuiltEditionDrop> | Checkout | |
| claimConditions | DropErc1155ClaimConditions<PrebuiltEditionDrop> | Configure claim conditions for each NFT | |
| encoder | ContractEncoder<PrebuiltEditionDrop> | ||
| erc1155 | Erc1155<PrebuiltEditionDrop> | ||
| estimator | GasCostEstimator<PrebuiltEditionDrop> | ||
| events | ContractEvents<PrebuiltEditionDrop> | ||
| history | DropErc1155History | ||
| interceptor | ContractInterceptor<PrebuiltEditionDrop> | ||
| metadata | ContractMetadata<PrebuiltEditionDrop, typeof DropErc1155ContractSchema> | ||
| owner | ContractOwner<PrebuiltEditionDrop> | ||
| platformFees | ContractPlatformFee<PrebuiltEditionDrop> | ||
| roles | ContractRoles<PrebuiltEditionDrop, typeof EditionDrop.contractRoles[number]> | ||
| royalties | ContractRoyalty<PrebuiltEditionDrop, typeof DropErc1155ContractSchema> | Configure royalties | |
| sales | ContractPrimarySale<PrebuiltEditionDrop> |
Methods
| Method | Modifiers | Description |
|---|---|---|
| burnTokens(tokenId, amount) | Burn a specified amount of a NFT | |
| claim(tokenId, quantity, checkERC20Allowance) | Claim a token to the connected wallet | |
| claimTo(destinationAddress, tokenId, quantity, checkERC20Allowance) | Claim NFTs to a specific Wallet | |
| createBatch(metadatas, options) | Create a batch of NFTs to be claimed in the future | |
| getAddress() | ||
| getAll(queryParams) | Get All Minted NFTs | |
| getClaimTransaction(destinationAddress, tokenId, 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 | |
| getTotalCount() | Get the number of NFTs minted | |
| isTransferRestricted() | Get whether users can transfer NFTs from this contract |
Signature:
export declare class EditionDrop extends StandardErc1155<PrebuiltEditionDrop>
Extends: StandardErc1155<PrebuiltEditionDrop>