Theme

Plugins

ImmutableMetadata Plugin

The immutableMetadata Plugin is a Authority Managed plugin that allows to make the Metadata (Name and URI) immutable. It can only be added by the update authority.

This plugin can be used on both the MPL Core Asset and the MPL Core Collection.

As it is for other plugins, like royalties when it is assigned to an MPL Core Collection the MPL Core Asset also is used on the Asset. So if it is added to a collection the Assets Metadata also becomes immutable.

Works With

MPL Core Asset
MPL Core Collection

Arguments

The immutableMetadata Plugin requires no arguments.

Adding the immutableMetadata Plugin to an Asset code example

Adding a Immutability Plugin to an MPL Core Asset

import {
  addPlugin,
} from '@metaplex-foundation/mpl-core'

await addPlugin(umi, {
  asset: asset.publicKey,
  plugin: {
    type: 'ImmutableMetadata',
  },
}).sendAndConfirm(umi)

Adding the immutableMetadata Plugin to a Collection code example

Add immutableMetadata Plugin to Collection

import {
  addCollectionPlugin,
} from '@metaplex-foundation/mpl-core'

await addCollectionPlugin(umi, {
  collection: collection.publicKey,
  plugin: {
    type: 'ImmutableMetadata',
  },
}).sendAndConfirm(umi)
Previous
Edition Plugin