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
Constructor | Modifiers | Description |
---|---|---|
(constructor)(network, address, storage, options, contractWrapper) | Constructs a new instance of the EditionDrop class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
claimConditions | DropErc1155ClaimConditions<DropERC1155> | Configure claim conditions for each NFT | |
contractAbi | static | any | |
contractRoles | static | readonly ["admin", "minter", "transfer"] | |
contractType | static | "edition-drop" | |
encoder | ContractEncoder<DropERC1155> | ||
estimator | GasCostEstimator<DropERC1155> | ||
events | ContractEvents<DropERC1155> | ||
history | DropErc1155History | ||
metadata | ContractMetadata<DropERC1155, typeof EditionDrop.schema> | ||
platformFees | ContractPlatformFee<DropERC1155> | ||
roles | ContractRoles<DropERC1155, typeof EditionDrop.contractRoles[number]> | ||
royalties | ContractRoyalty<DropERC1155, typeof EditionDrop.schema> | Configure royalties | |
sales | ContractPrimarySale<DropERC1155> |
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 | |
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 Erc1155<DropERC1155>
Extends: Erc1155<DropERC1155