Delegating and Revoking Plugins

Delegating an Authority

Plugins can be delegated to another address with a Delegate Authority instruction update. Delegated plugins allow addresses other than the main authority to have control over that plugins functionality.

import { publicKey } from '@metaplex-foundation/umi'
import {
  approvePluginAuthority,
  pluginAuthority,
  PluginType,
  addressPluginAuthority,
} from '@metaplex-foundation/mpl-core'

const asset = publicKey('11111111111111111111111111111111')
const delegate = publicKey('33333333333333333333333333333')

await approvePluginAuthorityV1(umi, {
  asset: asset,
  pluginType: PluginType.FreezeDelegate,
  newAuthority: addressPluginAuthority(delegate),
}).sendAndConfirm(umi)

Revoking an Authority

Revoking an Authority on a plugin results in different behaviours depending on the plugin type that's being revoked.

• Owner Managed Plugins: If an address is revoked from an Owner Managed Plugin then the plugin will default back to the Owner authority type.

• Authority Managed Plugins: If an address is revoked from an Authority Managed Plugin then the plugin will default back to the UpdateAuthority authority type.

Who can Revoke a Plugin?

Owner Managed Plugins

• An Owner Managed Plugin can be revoked by the owner which revokes the delegate and sets the pluginAuthority type to Owner.
• The delegated Authority of the plugin can revoke themselves which then sets the plugin authority type to Owner.
• On Transfer, delegated Authorities of owner managed plugins are automatically revoked back to the Owner Authority type.

Authority Managed Plugins

• The Update Authority of an Asset can revoke a delegate which thens sets the pluginAuthority type to UpdateAuthority.
• The delegated Authority of the plugin can revoke themselves which then sets the plugin authority type to UpdateAuthority.

A list of plugins and their types can be viewed on the Plugins Overview page.

import { publicKey } from '@metaplex-foundation/umi'
import {
  PluginType,
  revokePluginAuthorityV1,
} from '@metaplex-foundation/mpl-core'

await revokePluginAuthorityV1(umi, {
  asset: asset.publicKey,
  pluginType: PluginType.Freeze,
}).sendAndConfirm(umi)

Delegate Resets Upon Asset Transfer

All Owner Managed plugins will have their delegated authorities revoked and set back to the authority type of Owner upon Transfer of an Asset.

This includes:

• Freeze Delegate
• Transfer Delegate
• Burn Delegate

Making Plugin Data Immutable

By updating your plugin's authority to a None value will effectively make your plugin's data immutable.

import {
  PluginType,
  approvePluginAuthorityV1,
  getNoneAuthority,
} from '@metaplex-foundation/mpl-core'

await approvePluginAuthorityV1(umi, {
  asset: asset.publicKey,
  pluginType: PluginType.Freeze,
  newAuthority: getNoneAuthority(),
}).sendAndConfirm(umi)