Updating Compressed NFTs

The Update instruction can be used to modify the metadata of a Compressed NFT. The Merkle root is updated to reflect the propagated hash of the data, and RPC providers who conform to the Metaplex DAS API will update their index of the cNFTs.

The metadata can be updated by one of two authorities, depending on if the compressed NFT is a verified item in a collection.

Update Authority

There are two possible update authorities for a cNFT which are either the tree owner or the collection authority if the cNFT belongs to a collection.

Collection Authority

If your cNFT belongs to a collection then the update authority of that cNFT will be the authority of the collection. When updating the cNFT you will need to pass in a collectionMint arg to the update function.

The authority will be inferred from the current umi identity. If the authority is different that the current umi identity then you will either have to pass in the authority arg as a signer type or create a 'noopSigner' for later signing.

await updateMetadata(umi, {
  ...
  collectionMint: publicKey("11111111111111111111111111111111"),
}).sendAndConfirm(umi)

Tree Authority

If your cNFT does not belong to a collection then the update authority for the cNFT will be the authority of the tree that the cNFT belongs too. In this case you would omit the collectionMint arg from the update function.

The authority will be inferred from the current umi identity. If the authority is different that the current umi identity then you will either have to pass in the authority arg as a signer type or create a 'noopSigner' for later signing.

Update cNFT

import {
  getAssetWithProof,
  updateMetadata,
  UpdateArgsArgs,
} from '@metaplex-foundation/mpl-bubblegum'

// Use the helper to fetch the asset and proof.
const assetWithProof = await getAssetWithProof(umi, assetId, {
  truncateCanopy: true,
})

// Then we can use it to update metadata for the NFT.
const updateArgs: UpdateArgsArgs = {
  name: some('New name'),
  uri: some('https://updated-example.com/my-nft.json'),
}
await updateMetadata(umi, {
  ...assetWithProof,
  leafOwner,
  currentMetadata: assetWithProof.metadata,
  updateArgs,
  // Optional param. If your authority is a different signer type 
  // than the current umi identity assign that signer here.
  authority: <Signer>
  // Optional param. If cNFT belongs to a collection pass it here.
  collectionMint: publicKey("22222222222222222222222222222222"),
}).sendAndConfirm(umi)