Skip to main content

Accounts

Metadata

Description

Diagram showing a Metadata Account derived from a Mint Account with a list of data fields under the Metadata Account that is listed on the fields table below.

The Metadata Account is responsible for storing additional data attached to tokens. As every account in the Token Metadata program, it derives from the Mint Account of the token using a PDA.

It stores a variety of information for different use-cases and, thus, the reader might benefit from reading the "fields" table below to learn more about them. Additionally, dedicated feature pages have been written to provide more documentation on what can be done with these fields. Their description will contain a link to the appropriate page when available.

One particular field to notice is the Uri field that points to an off-chain JSON file which, itself, contains more data. That data is standardized so applications and marketplaces can reliably find information on a given token. If you're wondering why the Metadata account provides two data stores — one off-chain and one on-chain — you might want to take a look at the FAQ here.

Seeds

SeedTypeDescription
Metadata
Literal: metadata
The program's prefix for PDA seeds.
Token Metadata Program
Program ID
The public key of the program.
Mint
Variable
The public key of the Mint Account to derive from.

Fields

FieldOffsetSizeDescription
Key
01The discriminator of the account as an enum. Equals to MetadataV1(4).
Update Authority
132The public key that is allowed to update this account.
Mint
3332The public key of the Mint Account it derives from.
Name
6536The on-chain name of the token, limited to 32 bytes. For instance "Degen Ape #1 ".
Symbol
10114The on-chain symbol of the token, limited to 10 bytes. For instance "DAPE".
Uri
115204The URI of the token, limited to 200 bytes. This URI points to an off-chain JSON file that contains additional data following a certain standard. You can learn more about this JSON standard here. The JSON file can either be stored in a traditional server (e.g. using AWS) or using a permanent storage solution such as using Arweave.
Seller Fee Basis Points
3192(Indicative) The royalties shared by the creators in basis points — i.e. 550 means 5.5%. Whilst this field is used by virtually all NFT marketplaces, it is not enforced by the Token Metadata program itself.
Creators
321~(Optional) An array of creators and their share of the royalties. This array is limited to 5 creators. Note that, because the Creators field is an array of variable length, we cannot guarantee the byte position of any field that follows (Notice the tilde ~ in the fields below). Each creator contains the following fields.
Address
~32The public key of the creator
Verified
~1A boolean indicating if the creator signed the NFT. It is important to check this field to ensure the authenticity of the creator.
Share
~1(Indicative) The creator's shares of the royalties in percentage (1 byte) — i.e. 55 means 55%. Similarly to the Seller Fee Basis Points field, this is used by marketplaces but not enforced by the Token Metadata program.
Primary Sale Happened
~1(Indicative) A boolean indicating if the token has already been sold at least once. Once flipped to True, it cannot ever be False again. This field can affect the way royalties are distributed.
Is Mutable
~1A boolean indicating if the Metadata Account can be updated. Once flipped to False, it cannot ever be True again.
Edition Nonce
~2(Optional) A nonce used to verify the edition number of printed NFTs. It will only be set on Edition NFTs and not Master Edition NFTs.
Token Standard
~2(Optional) This enum captures the fungibility of the token. You can learn more about the token standard here.
Collection
~34(Optional) This field optionally links to the Mint address of another NFT that acts as a Collection NFT. It contains the following sub-fields.
Verified
~1A boolean indicating if the owner of the Collection NFT signed this NFT. It is important to check this field to ensure the authenticity of the collection.
Key
~32The public key of the Collection NFT's Mint Account
Uses
~18(Optional) This field can make NFTs usable. Meaning you can load it with a certain amount of "uses" and use it until it has run out. You can learn more about using NFTs here.
Use Method
~1An enum defining the use behaviour for the NFT. It can be one of the following: Burn, Multiple or Single.
Remaining
~8The remaining amount of uses.
Total
~8The total amount of uses allowed in the first place.
Collection Details
~8(Optional) This optional enum allows us to differentiate Collection NFTs from Regular NFTs whilst adding additional context such as the amount of NFTs that are linked to the Collection NFT. You can learn more about the sized collections here

Master Edition

Description

Diagram showing a Master Edition Account derived from a Mint Account with a list of data fields under the Master Edition Account that is listed on the fields table below.

The Master Edition account, derived from a Mint Account, is an important component of NFTs because its existence is proof of the Non-Fungibility of the token.

When creating a Master Edition account, the Token Metadata program will check for the following conditions:

  • The Mint Account has zero decimals, i.e. Decimals = 0.
  • The Mint Account minted exactly one token to a wallet, i.e. Supply = 1.

Additionally, it will transfer the Mint Authority and the Freeze Authority to the Master Edition account to prevent anyone from being able to mint additional tokens. You can read more about why these authorities are transferred instead of being voided in the FAQ.

Therefore, what we end up with is a Mint Account whose supply will never go above one and whose token cannot be shared or divided. As such, we end up with a Non-Fungible Token (NFT).

On top of being a Non-Fungible proof, the Master Edition allows NFTs to be printed a limited or unlimited amount of times. The Master Edition NFT acts as the "original record" of the digital asset that can be duplicated or "printed" into Edition NFTs. This allows creators to offer more than one copy of their digital assets to their audience.

The optional Max Supply field of the Master Edition account tells us how many copies of the NFT can be created. When set to None, an unlimited amount of copies can be created. When set to zero, the NFT cannot be copied.

Seeds

SeedTypeDescription
Metadata
Literal: metadata
The program's prefix for PDA seeds.
Token Metadata Program
Program ID
The public key of the program.
Mint
Variable
The public key of the Mint Account to derive from.
Edition
Literal: edition
A literal to differentiate the Edition accounts.

Fields

FieldOffsetSizeDescription
Key
01The discriminator of the account as an enum. Equals to: MasterEditionV2(6) (or, for previous versions: MasterEditionV1(2)).
Supply
18The amount of NFTs printed from this Master Edition. This field is automatically computed by the program and cannot be manually updated. Once the Supply reaches the Max Supply, no more prints can be made from this Master Edition.
Max Supply
99(Optional) The maximum number of times NFTs can be printed from this Master Edition. When set to None, the program will enable unlimited prints. You can disable NFT printing by setting the Max Supply to 0.

Edition

Description

Diagram showing both a Master Edition Account and an Edition Account derived from a Mint Account. There is a big "OR" written between the two to show that only one of the two can exist for a given NFT.

The Edition account, derived from a Mint Account, represents an NFT that was copied from a Master Edition NFT.

It is important to note that the seeds used to generate this PDA account are the same as the Master Edition account. This means an NFT can either be a Master Edition NFT or an Edition NFT but not both.

Similarly to the Master Edition account, the Edition account will perform Non-Fungibility checks and gets assigned as the Mint Authority and the Freeze Authority of the Mint Account.

Additionally, the Edition account keeps track of the Master Edition account it was printed from in the Parent field as well as the edition number in the Edition field.

Seeds

SeedTypeDescription
Metadata
Literal: metadata
The program's prefix for PDA seeds.
Token Metadata Program
Program ID
The public key of the program.
Mint
Variable
The public key of the Mint Account to derive from.
Edition
Literal: edition
A literal to differentiate the Edition accounts.

Fields

FieldOffsetSizeDescription
Key
01The discriminator of the account as an enum. Equals to: EditionV1(1).
Parent
132The public key of the Master Edition account that printed this edition.
Edition
338The edition number of this printed edition. For instance, the 10th printed NFT will have Edition = 10.

Edition Marker

Description

Diagram showing an Edition Marker Account derived from a Mint Account with a list of data fields under the Edition Marker Account that is listed on the fields table below.

Edition Marker accounts are used internally by the program to keep track of which editions were printed for a given Master Edition.

Each Edition Marker account is responsible for storing a subset of the printed editions. More precisely, they each store 248 editions using a bitmask where 0 means, the edition has not been printed and 1 means it has. That means Master Edition accounts typically end up using more than one Edition Marker account.

To understand how this works, let's imagine that we want to print the 500th edition of a Master Edition.

To know if this edition has already been printed, we need to check the third Edition Marker account because the first two are keeping track of the first 496 editions (248 + 248 = 496) and should, at this point, be full of 1s. Then, we can check the fourth bit of the third Edition Marker to see if the 500th edition has already been printed.

Therefore, we can find out if the nth edition was printed by checking the n % 248th bit of the ⌊n / 248⌋th Edition Marker.

This is why ⌊n / 248⌋ is used as a seed of the Edition Marker PDA.

Seeds

SeedTypeDescription
Metadata
Literal: metadata
The program's prefix for PDA seeds.
Token Metadata Program
Program ID
The public key of the program.
Mint
Variable
The public key of the Mint Account to derive from.
Edition
Literal: edition
A literal to differentiate the Edition accounts.
Edition Marker
Variable
The edition number divided by 248 rounded down.

Fields

FieldOffsetSizeDescription
Key
01The discriminator of the account as an enum. Equals to: EditionMarker(7).
Ledger
131An array of 31 bytes keeping track of the editions that have been printed within the marker's range. With 31 bytes, each marker keep track of 248 editions using a bitmask.

Collection Authority Record

Description

Diagram showing a Collection Authority Record Account derived from a Mint Account with a list of data fields under the Collection Authority Record Account that is listed on the fields table below.

Collection Authority Record accounts are used internally by the program to keep track of which authorities are allowed to set and/or verify the collection of the token's Metadata account.

It uses a PDA derived from both the Mint Account and the public key of the authority. That way, one can check if a public key is allowed to alter the collection of an NFT by checking the existence of a Collection Authority Record account. The Collection Authority Record account stores the Bump that was used to generate the PDA to provide more thorough verification.

You can read more about NFT Collections here.

Seeds

SeedTypeDescription
Metadata
Literal: metadata
The program's prefix for PDA seeds.
Token Metadata Program
Program ID
The public key of the program.
Mint
Variable
The public key of the Mint Account to derive from.
Collection Authority Prefix
Literal: collection_authority
A literal to differentiate the Collection Authority Record accounts.
Collection Authority
Variable
The public key of the authority that is now allowed to verify collections on that NFT.

Fields

FieldOffsetSizeDescription
Key
01The discriminator of the account as an enum. Equals to: CollectionAuthorityRecord(9).
Bump
11The bump that was used to create the PDA of this account.

Use Authority Record

Description

Diagram showing a Use Authority Record Account derived from a Mint Account with a list of data fields under the Use Authority Record Account that is listed on the fields table below.

Use Authority Record accounts are used internally by the program to keep track of which authorities are allowed to reduce the uses of the token's Metadata account.

It uses a PDA derived from both the Mint Account and the public key of the authority. That way, one can check if a public key is allowed to reduce the uses of an NFT by checking the existence of a Use Authority Record account. The Use Authority Record account stores the Bump that was used to generate the PDA to provide more thorough verification.

It also stores the Allowed Uses for the given authority to ensure it cannot use more than what it was allowed to use.

You can read more about using NFTs here.

Seeds

SeedTypeDescription
Metadata
Literal: metadata
The program's prefix for PDA seeds.
Token Metadata Program
Program ID
The public key of the program.
Mint
Variable
The public key of the Mint Account to derive from.
User Prefix
Literal: user
A literal to differentiate the Use Authority Record accounts.
User
Variable
The public key of the authority that is now allowed to use that NFT.

Fields

FieldOffsetSizeDescription
Key
01The discriminator of the account as an enum. Equals to: UseAuthorityRecord(8).
Allowed Uses
18The amount of uses this authority is allowed to use.
Bump
91The bump that was used to create the PDA of this account.