Optional
updateThe current update authority of the asset as a Signer.
metaplex.identity()
Optional
newThe address of the new update authority to set for the asset
Defaults to not being updated.
Optional
name?: stringThe new on-chain name of the asset.
Defaults to not being updated.
Optional
symbol?: stringThe new on-chain symbol of the asset.
Defaults to not being updated.
Optional
uri?: stringThe new on-chain uri of the asset.
Defaults to not being updated.
Optional
sellerThe new royalties of the asset in percent basis point (i.e. 250 is 2.5%) that should be paid to the creators on each secondary sale.
Defaults to not being updated.
Optional
creators?: CreatorInput[]The new creators for the asset.
For each creator, if an authority
Signer is provided,
the creator will be marked as verified.
Defaults to not being updated.
Optional
primaryWhether or not the asset has already been sold to its first buyer.
This can only be flipped from false
to true
.
Defaults to not being updated.
Optional
isWhether or not the asset is mutable.
When set to false
no one can update the Metadata account,
not even the update authority.
This can only be flipped from true
to false
.
Defaults to not being updated.
Optional
uses?: Option<Uses>When this field is not null
, it indicates that the asset
can be "used" by its owner or any approved "use authorities".
Defaults to not being updated.
Optional
collection?: Option<PublicKey>The new Collection NFT that this asset belongs to.
When null
, this will remove the asset from its current collection.
Defaults to not being updated.
Optional
collectionThe collection authority that should sign the asset
to prove that it is part of the newly 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 newly provided collection
is a sized collection
and not a legacy collection.
true
Optional
oldWhether or not the current asset's collection is a sized collection and not a legacy collection.
true
Generated using TypeDoc
The NFT or SFT to update. We only need a subset of the
Sft
(orNft
) model to figure out the current values for the data of the metadata account and only update the parts that are different.