Plugins

Permanent Burn Delegate

Overview

The Permanent Burn Plugin is a Permanent plugin that will always be present on the MPL Core Asset or MPL Core Collection to which it was added. A permanent plugin can only be added at the time of Asset or Collection creation. This plugin allows the authority of the plugin to burn the asset at any point in time.

The Permanent Burn Plugin will work in areas such as:

  • Gaming event which triggers the burning of the asset.

Works With

MPL Core Asset
MPL Core Collection

Behaviours

  • Asset: Allows burning of the Asset using the delegated address.
  • Collection: Allows burning of any Asset in the collection using the collection authority. It does not burn all at once.

Arguments

The Permanent Burn Plugin doesn't contain any arguments to pass in.

Creating an Asset with a Permanent Burn Plugin

Creating an Asset with a Permanent Freeze plugin

import { publicKey } from '@metaplex-foundation/umi'
import { create } from '@metaplex-foundation/mpl-core'

const assetSigner = generateSigner(umi)
const delegate = publicKey('33333333333333333333333333333')

await create(umi, {
  asset: assetSigner,
  name: 'My Asset',
  uri: 'https://example.com/my-asset.json',
  plugins: [
    {
      type: 'PermanentBurnDelegate',
      authority: { type: 'Address', address: delegate },
    },
  ],
}).sendAndConfirm(umi)
Previous
Permanent Freeze Delegate Plugin