Skip to main content

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.getContract("{{contract_address}}", "edition");

Constructors

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

Properties

PropertyModifiersTypeDescription
abitypeof ABI
contractRolesstaticreadonly ["admin", "minter", "transfer"]
encoderContractEncoder<TokenERC1155>
erc1155Erc1155<TokenERC1155>
estimatorGasCostEstimator<TokenERC1155>
eventsContractEvents<TokenERC1155>
interceptorContractInterceptor<TokenERC1155>
metadataContractMetadata<TokenERC1155, typeof TokenErc1155ContractSchema>
ownerContractOwner<TokenERC1155>
platformFeesContractPlatformFee<TokenERC1155>
rolesContractRoles<TokenERC1155, typeof Edition.contractRoles[number]>
royaltiesContractRoyalty<TokenERC1155, typeof TokenErc1155ContractSchema>Configure royalties
salesContractPrimarySale<TokenERC1155>
signatureErc1155SignatureMintableSignature Minting

Methods

MethodModifiersDescription
burn(tokenId, amount)Burn a specified amount of a NFT
getAddress()
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
mint(metadataWithSupply)Mint NFT for the connected wallet
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

Signature:

export declare class Edition extends StandardErc1155<TokenERC1155>

Extends: StandardErc1155<TokenERC1155>