Edition Plugin

The Edition Plugin stores an edition number on individual Assets. Use it to create numbered prints like "1 of 100" for collectible series and limited editions.

Summary

The Edition plugin is an Authority Managed plugin that stores a unique edition number on an Asset. Best used with the Master Edition plugin on Collections to group numbered editions together.

• Authority Managed (update authority controls)
• Must be added at Asset creation
• Number can be updated if authority is mutable
• Use with Candy Machine Edition Guard for automatic numbering

Out of Scope

Supply enforcement (informational only), automatic numbering (use Candy Machine), and Collection-level editions (use Master Edition plugin for Collections).

Quick Start

Jump to: Create Mutable Edition · Create Immutable Edition · Update Edition

1. Add Edition plugin during Asset creation with a unique number
2. Optionally set authority to None for immutability
3. Update the number later if mutable

Works With

Arguments

Creating an Asset with the editions plugin

The Editions Plugin must be added on creation of the asset. As long as it is mutable the number can be changed.

Create with a mutable Plugin

import { publicKey } from '@metaplex-foundation/umi'
import { create } from '@metaplex-foundation/mpl-core'
const assetSigner = generateSigner(umi)
const result = create(umi, {
  asset: assetSigner,
  name: 'My Asset',
  uri: 'https://example.com/my-asset.json',
  plugins: [
    {
      type: 'Edition',
      number: 1
    },
  ],
}).sendAndConfirm(umi)

Create with a Immutable Plugin

To create the Asset with immutable Edition Plugin the following code can be used:

import { publicKey } from '@metaplex-foundation/umi'
import { create } from '@metaplex-foundation/mpl-core'
const asset = generateSigner(umi)
const result = create(umi, {
  asset: asset,
  name: 'My Nft',
  uri: 'https://example.com/my-nft',
  plugins: [
    {
      type: 'Edition',
      number: 1,
      authority: { type: 'None' },
    },
  ],
}).sendAndConfirm(umi)

Update the Editions Plugin

If the Editions Plugin is mutable it can be updated similar to other Plugins:

import { publicKey } from '@metaplex-foundation/umi'
import { updatePlugin } from '@metaplex-foundation/mpl-core'
const asset = publicKey('11111111111111111111111111111111')
  await updatePlugin(umi, {
    asset: assetAccount.publicKey,
    plugin: { type: 'Edition', number: 2 },
  }).sendAndConfirm(umi);

Common Errors

Cannot add Edition plugin after creation

The Edition plugin must be added during Asset creation. It cannot be added to existing Assets.

Authority mismatch

Only the update authority can update the edition number (if mutable).

Plugin is immutable

The Edition plugin has authority set to None. The number cannot be changed.

Notes

• Edition numbers are NOT enforced to be unique—creators must track this
• The plugin must be added during create(), not after
• Setting authority to None makes the edition number permanent
• Use with Master Edition plugin on Collections for proper grouping

Quick Reference

Authority Options

Recommended Setup

FAQ

Is the edition number enforced to be unique?

No. The edition number is informational only. Creators are responsible for ensuring unique numbers. Use Candy Machine with the Edition Guard for automatic sequential numbering.

Can I add the Edition plugin to an existing Asset?

No. The Edition plugin must be added during Asset creation. Plan ahead if you need edition numbers.

How do I create a "1 of 100" style edition?

Add the Edition plugin to Assets (with numbers 1-100) and add the Master Edition plugin to the Collection with maxSupply: 100. The Master Edition groups the editions and indicates total supply.

Can I change the edition number after creation?

Yes, if the plugin authority is not set to None. The update authority can modify the number using updatePlugin.

What's the difference between Edition and Master Edition?

Edition stores the individual number (e.g., #5) on an Asset. Master Edition stores collection-level data (max supply, edition name/URI) on a Collection and groups the editions together.

Glossary