Edition class
Create a collection of NFTs that lets you mint multiple copies of each NFT.
Example
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
const sdk = new ThirdwebSDK("{{chainName}}");
const contract = sdk.getEdition("{{contract_address}}");
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(network, address, storage, options, contractWrapper) | Constructs a new instance of the Edition class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| contractAbi | static | any | |
| contractRoles | static | readonly ["admin", "minter", "transfer"] | |
| contractType | static | "edition" | |
| encoder | ContractEncoder<TokenERC1155> | ||
| estimator | GasCostEstimator<TokenERC1155> | ||
| events | ContractEvents<TokenERC1155> | ||
| metadata | ContractMetadata<TokenERC1155, typeof Edition.schema> | ||
| platformFees | ContractPlatformFee<TokenERC1155> | ||
| roles | ContractRoles<TokenERC1155, typeof Edition.contractRoles[number]> | ||
| royalties | ContractRoyalty<TokenERC1155, typeof Edition.schema> | Configure royalties | |
| sales | ContractPrimarySale<TokenERC1155> | ||
| signature | Erc1155SignatureMintable | Signature Minting |
Methods
| Method | Modifiers | Description |
|---|---|---|
| burnTokens(tokenId, amount) | Burn a specified amount of a NFT | |
| getAll(queryParams) | Get All Minted NFTs | |
| getOwned(walletAddress) | Get Owned NFTs | |
| getTotalCount() | Get the number of NFTs minted | |
| isTransferRestricted() | Get whether users can transfer NFTs from this contract | |
| mintAdditionalSupply(tokenId, additionalSupply) | Increase the supply of an existing NFT and mint it to the connected wallet | |
| mintAdditionalSupplyTo(to, tokenId, additionalSupply) | Increase the supply of an existing NFT and mint it to a given wallet address | |
| mintBatch(metadatas) | Mint Many NFTs for the connected wallet | |
| mintBatchTo(to, metadataWithSupply) | Mint Many NFTs with limited supplies | |
| mintTo(to, metadataWithSupply) | Mint an NFT with a limited supply | |
| mintToSelf(metadataWithSupply) | Mint NFT for the connected wallet |
Signature:
export declare class Edition extends Erc1155<TokenERC1155>
Extends: Erc1155<TokenERC1155