Skip to main content

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 = sdk.getEditionDrop("{{contract_address}}");

Constructors

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

Properties

PropertyModifiersTypeDescription
abitypeof ABI
checkoutPaperCheckout<DropERC1155>Checkout
claimConditionsDropErc1155ClaimConditions<DropERC1155>Configure claim conditions for each NFT
encoderContractEncoder<DropERC1155>
erc1155Erc1155<DropERC1155>
estimatorGasCostEstimator<DropERC1155>
eventsContractEvents<DropERC1155>
historyDropErc1155History
interceptorContractInterceptor<DropERC1155>
metadataContractMetadata<DropERC1155, typeof DropErc1155ContractSchema>
ownerContractOwner<DropERC1155>
platformFeesContractPlatformFee<DropERC1155>
rolesContractRoles<DropERC1155, typeof EditionDrop.contractRoles[number]>
royaltiesContractRoyalty<DropERC1155, typeof DropErc1155ContractSchema>Configure royalties
salesContractPrimarySale<DropERC1155>

Methods

MethodModifiersDescription
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<DropERC1155>

Extends: StandardErc1155<DropERC1155>