The on-chain name of the asset, e.g. "My NFT #123".
The URI that points to the JSON metadata of the asset.
Optional
symbol?: undefined | stringThe on-chain symbol of the asset, stored in the Metadata account. E.g. "MYNFT".
""
Optional
isWhether or not the NFT's metadata is mutable.
When set to false
no one can update the Metadata account,
not even the update authority.
true
Optional
creators?: undefined | CreatorInput[]This object provides a way of providing creator information when needed, e.g. when creating or updating NFTs, candy machines, etc.
It allows us to optionally provide an authority as a Signer so we can both set and verify the creator within the same operation.
Defaults to using the provided updateAuthority
as the only verified creator.
[{
address: updateAuthority.publicKey,
authority: updateAuthority,
share: 100,
}]
Optional
collection?: undefined | Option<PublicKey>The Collection NFT that this new NFT belongs to.
When null
, the created NFT will not be part of a collection.
null
Optional
uses?: undefined | Option<Uses>When this field is not null
, it indicates that the NFT
can be "used" by its owner or any approved "use authorities".
null
Optional
tokenThe token account linking the mint account and the token owner together. By default, the associated token account will be used.
If the provided token account does not exist, it must be passed as a Signer as we will need to create it before creating the NFT.
Defaults to creating a new associated token account
using the mintAddress
and tokenOwner
parameters.
Optional
mintThe authority that is currently allowed to mint new tokens for the provided mint account.
Note that this is only relevant if the useExistingMint
parameter
if provided.
metaplex.identity()
Optional
updateThe authority that will be able to make changes to the created NFT.
This is required as a Signer because creating the master edition account requires the update authority to sign the transaction.
metaplex.identity()
Optional
useThe address of the new mint account as a Signer. This is useful if you already have a generated Keypair for the mint account of the NFT to create.
Keypair.generate()
Optional
useThe address of the existing mint account that should be converted into an NFT. The account at this address should have the right requirements to become an NFT, e.g. its supply should contains exactly 1 token.
Defaults to creating a new mint account with the right requirements.
Optional
tokenThe owner of the NFT to create.
metaplex.identity().publicKey
Optional
maxThe maximum supply of printed editions.
When this is null
, an unlimited amount of editions
can be printed from the original edition.
toBigNumber(0)
Optional
isWhether the created NFT is a Collection NFT.
When set to true
, the NFT will be created as a
Sized Collection NFT with an initial size of 0.
false
Optional
collectionThe collection authority that should sign the created NFT
to prove that it is part of the provided collection.
When null
, the provided collection
will not be verified.
null
Optional
collectionWhether or not the provided collectionAuthority
is a delegated
collection authority, i.e. it was approved by the update authority
using metaplex.nfts().approveCollectionAuthority()
.
false
Optional
collectionWhether or not the provided collection
is a sized collection
and not a legacy collection.
true
Optional
tokenWhether or not the provided token account already exists.
If false
, we'll add another instruction to create it.
true
Optional
createA key to distinguish the instruction that creates the mint account.
Optional
initializeA key to distinguish the instruction that initializes the mint account.
Optional
createA key to distinguish the instruction that creates the associated token account.
Optional
createA key to distinguish the instruction that creates the token account.
Optional
initializeA key to distinguish the instruction that initializes the token account.
Optional
mintA key to distinguish the instruction that mints tokens.
Optional
createA key to distinguish the instruction that creates the metadata account.
Optional
createA key to distinguish the instruction that creates the master edition account.
Generated using TypeDoc
The royalties in percent basis point (i.e. 250 is 2.5%) that should be paid to the creators on each secondary sale.