|
|
@@ -4,7 +4,7 @@ metaTitle: Token Metadata - Overview
|
|
|
description: Provides a high-level overview of the Solana NFT standard.
|
|
|
---
|
|
|
|
|
|
-Dummy text. Learn how to get CacheAdvance set up in your project in under thirty minutes or it's free. {% .lead %}
|
|
|
+The Token Metadata program is a fundamental program when dealing NFTs and Fungible assets on the Solana blockchain. In this overview, we explain what this program does and how we can leverage its various features at a high level. {% .lead %}
|
|
|
|
|
|
{% quick-links %}
|
|
|
|
|
|
@@ -18,97 +18,197 @@ Dummy text. Learn how to get CacheAdvance set up in your project in under thirty
|
|
|
|
|
|
{% /quick-links %}
|
|
|
|
|
|
-Possimus saepe veritatis sint nobis et quam eos. Architecto consequatur odit perferendis fuga eveniet possimus rerum cumque. Ea deleniti voluptatum deserunt voluptatibus ut non iste.
|
|
|
+## Introduction
|
|
|
|
|
|
----
|
|
|
+The Token Metadata program is one of the most important programs when dealing with NFTs on the Solana blockchain. Its main goal is to **attach additional data to [Fungible](https://en.wikipedia.org/wiki/Fungibility) or Non-Fungible [Tokens](https://spl.solana.com/token)** on Solana.
|
|
|
|
|
|
-## Quick start
|
|
|
+It achieves this using [Program Derived Addresses](/understanding-programs/#program-derived-addresses-pda) (PDAs) that are _derived_ from the address of Mint Accounts. If you’re not familiar with [Solana’s Token program](https://spl.solana.com/token), _Mint Accounts_ are responsible for storing the global information of a Token and _Token Accounts_ store the relationship between a wallet and a Mint Account.
|
|
|
|
|
|
-Sit commodi iste iure molestias qui amet voluptatem sed quaerat. Nostrum aut pariatur. Sint ipsa praesentium dolor error cumque velit tenetur.
|
|
|
+{% diagram %}
|
|
|
+{% node %}
|
|
|
+{% node #wallet label="Wallet Account" theme="indigo" /%}
|
|
|
+{% node label="Owner: System Program" theme="dimmed" /%}
|
|
|
+{% /node %}
|
|
|
+{% node y="70" parent="wallet" label="Someone's wallet." theme="transparent" /%}
|
|
|
|
|
|
-### Installing dependencies
|
|
|
+{% node x="200" parent="wallet" %}
|
|
|
+{% node #token label="Token Account" theme="blue" /%}
|
|
|
+{% node label="Owner: Token Program" theme="dimmed" /%}
|
|
|
+{% /node %}
|
|
|
+{% node y="70" parent="token" theme="transparent" %}
|
|
|
+Stores the number of \
|
|
|
+tokens owned by the wallet, \
|
|
|
+among other things.
|
|
|
+{% /node %}
|
|
|
|
|
|
-Sit commodi iste iure molestias qui amet voluptatem sed quaerat. Nostrum aut pariatur. Sint ipsa praesentium dolor error cumque velit tenetur quaerat exercitationem. Consequatur et cum atque mollitia qui quia necessitatibus.
|
|
|
+{% node x="200" parent="token" %}
|
|
|
+{% node #mint label="Mint Account" theme="blue" /%}
|
|
|
+{% node label="Owner: Token Program" theme="dimmed" /%}
|
|
|
+{% /node %}
|
|
|
+{% node y="70" parent="mint" theme="transparent" %}
|
|
|
+Stores information about the \
|
|
|
+token itseft. E.g. its current \
|
|
|
+supply and its authorities.
|
|
|
+{% /node %}
|
|
|
|
|
|
-```shell
|
|
|
-npm install @tailwindlabs/cache-advance
|
|
|
-```
|
|
|
+{% edge from="wallet" to="token" /%}
|
|
|
+{% edge from="mint" to="token" /%}
|
|
|
|
|
|
-Possimus saepe veritatis sint nobis et quam eos. Architecto consequatur odit perferendis fuga eveniet possimus rerum cumque. Ea deleniti voluptatum deserunt voluptatibus ut non iste. Provident nam asperiores vel laboriosam omnis ducimus enim nesciunt quaerat. Minus tempora cupiditate est quod.
|
|
|
+{% /diagram %}
|
|
|
|
|
|
-{% callout type="warning" title="Oh no! Something bad happened!" %}
|
|
|
-This is what a disclaimer message looks like. You might want to include inline `code` in it. Or maybe you’ll want to include a [link](/) in it. I don’t think we should get too carried away with other scenarios like lists or tables — that would be silly.
|
|
|
-{% /callout %}
|
|
|
+Whilst Mint Accounts contain a few data attributes such as its current supply, it doesn't offer the ability to inject standardized data that can be understood by apps and marketplaces.
|
|
|
|
|
|
-### Configuring the library
|
|
|
+This is why the Token Metadata program offers a **Metadata Account** that attaches itself to a Mint Account via a PDA.
|
|
|
|
|
|
-Sit commodi iste iure molestias qui amet voluptatem sed quaerat. Nostrum aut pariatur. Sint ipsa praesentium dolor error cumque velit tenetur quaerat exercitationem. Consequatur et cum atque mollitia qui quia necessitatibus.
|
|
|
+{% diagram %}
|
|
|
+{% node %}
|
|
|
+{% node #wallet label="Wallet Account" theme="indigo" /%}
|
|
|
+{% node label="Owner: System Program" theme="dimmed" /%}
|
|
|
+{% /node %}
|
|
|
|
|
|
-```js
|
|
|
-// cache-advance.config.js
|
|
|
-export default {
|
|
|
- strategy: 'predictive',
|
|
|
- engine: {
|
|
|
- cpus: 12,
|
|
|
- backups: ['./storage/cache.wtf'],
|
|
|
- },
|
|
|
-}
|
|
|
-```
|
|
|
+{% node x="200" parent="wallet" %}
|
|
|
+{% node #token label="Token Account" theme="blue" /%}
|
|
|
+{% node label="Owner: Token Program" theme="dimmed" /%}
|
|
|
+{% /node %}
|
|
|
|
|
|
-Possimus saepe veritatis sint nobis et quam eos. Architecto consequatur odit perferendis fuga eveniet possimus rerum cumque. Ea deleniti voluptatum deserunt voluptatibus ut non iste. Provident nam asperiores vel laboriosam omnis ducimus enim nesciunt quaerat. Minus tempora cupiditate est quod.
|
|
|
+{% node x="200" parent="token" %}
|
|
|
+{% node #mint label="Mint Account" theme="blue" /%}
|
|
|
+{% node label="Owner: Token Program" theme="dimmed" /%}
|
|
|
+{% /node %}
|
|
|
|
|
|
-{% callout title="You should know!" %}
|
|
|
-This is what a disclaimer message looks like. You might want to include inline `code` in it. Or maybe you’ll want to include a [link](/) in it. I don’t think we should get too carried away with other scenarios like lists or tables — that would be silly.
|
|
|
-{% /callout %}
|
|
|
+{% node #metadata-pda parent="mint" x="41" y="-100" label="PDA" theme="crimson" /%}
|
|
|
|
|
|
----
|
|
|
+{% node parent="metadata-pda" x="-240" y="-300" %}
|
|
|
+{% node #metadata label="Metadata Account" theme="crimson" /%}
|
|
|
+{% node label="Owner: Token Metadata Program" theme="dimmed" /%}
|
|
|
+{% node label="Key = MetadataV1" /%}
|
|
|
+{% node label="Update Authority" /%}
|
|
|
+{% node label="Mint" /%}
|
|
|
+{% node label="Name" /%}
|
|
|
+{% node label="Symbol" /%}
|
|
|
+{% node label="URI" /%}
|
|
|
+{% node label="Seller Fee Basis Points" /%}
|
|
|
+{% node label="Creators" /%}
|
|
|
+{% node label="Primary Sale Happened" /%}
|
|
|
+{% node label="Is Mutable" /%}
|
|
|
+{% node label="Edition Nonce" /%}
|
|
|
+{% node label="Token Standard" /%}
|
|
|
+{% node label="Collection" /%}
|
|
|
+{% node label="Uses" /%}
|
|
|
+{% node label="Collection Details" /%}
|
|
|
+{% node label="Programmable Configs" /%}
|
|
|
+{% /node %}
|
|
|
|
|
|
-## Basic usage
|
|
|
+{% edge from="wallet" to="token" /%}
|
|
|
+{% edge from="mint" to="token" /%}
|
|
|
+{% edge from="mint" to="metadata-pda" path="straight" /%}
|
|
|
+{% edge from="metadata-pda" to="metadata" /%}
|
|
|
|
|
|
-Praesentium laudantium magni. [Consequatur reiciendis](#) aliquid nihil iusto ut in et. Quisquam ut et aliquid occaecati. Culpa veniam aut et voluptates amet perspiciatis. Qui exercitationem in qui. Vel qui dignissimos sit quae distinctio.
|
|
|
+{% /diagram %}
|
|
|
|
|
|
-### Your first cache
|
|
|
+That Metadata Account holds a lot of valuable information that can be used throughout the ecosystem. For instance, it maintains a list of creators for the token. Each creator has a `Verified` attribute that, when `True`, guarantees the token was signed by that creator. Each creator also has a `Share` attribute that can be used by marketplaces to distribute royalties.
|
|
|
|
|
|
-Minima vel non iste debitis. Consequatur repudiandae et quod accusamus sit molestias consequatur aperiam. Et sequi ipsa eum voluptatibus ipsam. Et quisquam ut.
|
|
|
+By attaching more data to the Mint Account, **the Token Metadata program is able to make Digital Assets** of regular on-chain Tokens.
|
|
|
|
|
|
-Qui quae esse aspernatur fugit possimus. Quam sed molestiae temporibus. Eum perferendis dignissimos provident ea et. Et repudiandae quasi accusamus consequatur dolore nobis. Quia reiciendis necessitatibus a blanditiis iste quia. Ut quis et amet praesentium sapiente.
|
|
|
+## A JSON standard
|
|
|
|
|
|
-Atque eos laudantium. Optio odit aspernatur consequuntur corporis soluta quidem sunt aut doloribus. Laudantium assumenda commodi.
|
|
|
+One important attribute of the Metadata Account is the `URI` attribute that points to a JSON file off-chain. This is used to safely provide additional data whilst not being constrained by the fees involved in storing on-chain data. That JSON file [follows a certain standard](/token-metadata/token-standard) that anyone can use to find useful information on tokens.
|
|
|
|
|
|
-### Clearing the cache
|
|
|
+
|
|
|
|
|
|
-Vel aut velit sit dolor aut suscipit at veritatis voluptas. Laudantium tempore praesentium. Qui ut voluptatem.
|
|
|
+Note that, this JSON file can be stored using a permanent storage solution such as Arweave to ensure it cannot be updated. Additionally, one can use the `Is Mutable` attribute of the Metadata Account to make it immutable and, therefore, forbid the `URI` attribute — and other attributes such as `Name` and `Creators` — to ever be changed. Using this combination, we can guarantee the immutability of the off-chain JSON file.
|
|
|
|
|
|
-Ea est autem fugiat velit esse a alias earum. Dolore non amet soluta eos libero est. Consequatur qui aliquam qui odit eligendi ut impedit illo dignissimos.
|
|
|
+## NFTs
|
|
|
|
|
|
-Ut dolore qui aut nam. Natus temporibus nisi voluptatum labore est ex error vel officia. Vero repellendus ut. Suscipit voluptate et placeat. Eius quo corporis ab et consequatur quisquam. Nihil officia facere dolorem occaecati alias deleniti deleniti in.
|
|
|
+You might be wondering: what has this got to do with NFTs? Well, NFTs are special tokens that are Non-Fungible.
|
|
|
|
|
|
-### Adding middleware
|
|
|
+More precisely, NFTs in Solana are Mint Accounts with the following characteristics:
|
|
|
|
|
|
-Officia nobis tempora maiores id iusto magni reprehenderit velit. Quae dolores inventore molestiae perspiciatis aut. Quis sequi officia quasi rem officiis officiis. Nesciunt ut cupiditate. Sunt aliquid explicabo enim ipsa eum recusandae. Vitae sunt eligendi et non beatae minima aut.
|
|
|
+- It has **a supply of 1**, meaning only one token is in circulation.
|
|
|
+- It has **zero decimals**, meaning there cannot be such a thing as 0.5 tokens.
|
|
|
+- It has **no mint authority**, meaning no one can ever mint additional tokens.
|
|
|
|
|
|
-Harum perferendis aut qui quibusdam tempore laboriosam voluptatum qui sed. Amet error amet totam exercitationem aut corporis accusantium dolorum. Perspiciatis aut animi et. Sed unde error ut aut rerum.
|
|
|
+What we end up with is a token that cannot be traded with something of the same kind, which is the definition of a Non-Fungible Token (NFT).
|
|
|
|
|
|
-Ut quo libero aperiam mollitia est repudiandae quaerat corrupti explicabo. Voluptas accusantium sed et doloribus voluptatem fugiat a mollitia. Numquam est magnam dolorem asperiores fugiat. Soluta et fuga amet alias temporibus quasi velit. Laudantium voluptatum perspiciatis doloribus quasi facere. Eveniet deleniti veniam et quia veritatis minus veniam perspiciatis.
|
|
|
+
|
|
|
|
|
|
----
|
|
|
+In this particular yet popular case, the goal of the Metadata Account is to provide the actual data of that NFT to make it a useful Digital Asset.
|
|
|
+
|
|
|
+Additionally, the Token Metadata program offers another account specifically for NFTs called the **Master Edition Account**. This account is also a PDA derived from the Mint Account.
|
|
|
+
|
|
|
+Before creating this account, the Token Metadata program will ensure the special characteristics of Non-Fungible Tokens listed above are met. However, it is worth noting that, instead of voiding the Mint Authority, it will transfer both the Mint Authority and the Freeze Authority to the Master Edition PDA to ensure no one can mint or freeze tokens without going through the Token Metadata program. You can [read more about why this decision was made in the FAQ](/token-metadata/faq#why-are-the-mint-and-freeze-authorities-transferred-to-the-edition-pda).
|
|
|
+
|
|
|
+Thus, **the existence of the Master Edition account acts as proof of Non-Fungibility** for that Mint Account.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## Printing Editions
|
|
|
+
|
|
|
+In addition to being Non-Fungibility evidence, the Master Edition account also allows users to print one or multiple copies of an NFT.
|
|
|
+
|
|
|
+This feature is particularly helpful to creators that want to offer multiple copies of their 1/1 NFTs to their audience.
|
|
|
+
|
|
|
+The Master Edition account contains an optional `Max Supply` attribute that dictates the maximum amount of NFTs that can be printed that way. If set to `0`, printing is disabled. If set to `None` an unlimited amount of copies can be printed.
|
|
|
+
|
|
|
+The Master Edition NFT, a.k.a. Original NFT, acts as the master record that one can use to print copies, a.k.a. Print NFTs.
|
|
|
+
|
|
|
+Each Print NFT is made of its own Mint Account and its own Metadata Account whose data is copied from the Original NFT. However, instead of having a Master Edition account attached to their Mint Account, Print NFTs use yet another PDA account called an **Edition Account**. This account keeps track of the edition number and the parent Master Edition it originated from.
|
|
|
+
|
|
|
+Note that the Master Edition account and the Edition account share the same seeds for their PDA. That means an NFT can be one or the other but not both.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## Semi-Fungible Tokens
|
|
|
+
|
|
|
+Whilst NFTs are the biggest use case of the Token Metadata program, it’s important to notice that the program also works with Fungible Token and, what we call, Semi-Fungible Tokens or Fungible Assets.
|
|
|
+
|
|
|
+At the end of the day, the Metadata account helps attach data to tokens regardless of their fungibility. However, the standard of the off-chain JSON file will vary slightly to accommodate their needs.
|
|
|
+
|
|
|
+To safely identify the fungibility of a token — and, thus, the standard that we should use — the Metadata account keeps track of that information in its `Token Standard` attribute. This attribute is automatically computed by the program and cannot be manually updated. It can take the following values.
|
|
|
+
|
|
|
+- `NonFungible`: The Mint account is associated with a Master Edition account and, therefore, is Non-Fungible. This is your typical NFT standard.
|
|
|
+- `NonFungibleEdition`: This is the same as `NonFungible` but the NFT was printed from an Original NFT and, thus, is associated with an Edition account instead of a Master Edition account.
|
|
|
+- `FungibleAsset`: The Mint account is Fungible but has zero decimal places. Having zero decimals means we can treat the token as an asset whose supply is not limited to one. For instance, Fungible Assets can be used in the gaming industry to store resources such as “Wood” or “Iron”.
|
|
|
+- `Fungible`: The Mint account is Fungible and has more than one decimal place. This is more likely going to be a token used as a decentralised currency.
|
|
|
+- `ProgrammableNonFungible`: A special `NonFungible` token that is frozen at all times to enforce custom authorization rules. See the next section for more information.
|
|
|
+
|
|
|
+You can [read more about these standards here](/token-metadata/token-standard).
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## Programmable NFTs
|
|
|
+
|
|
|
+Because the Token Metadata program is building on top of the Solana Token program, anyone can transfer tokens (fungible or not) without going through the Token Metadata program. Whilst this is great for program composibility, it also means that the Token Metadata program cannot enforce any rules on the tokens it is attached to.
|
|
|
+
|
|
|
+A good example of why this can be problematic is that Token Metadata cannot enforce secondary sales royalties. Whilst there is **Seller Fee Basis Points** attribute on the Metadata account, it is purely [indicative](/programs/understanding-programs#indicative-fields) and anyone could create a marketplace that does not honor royalties — which is exactly what happened.
|
|
|
+
|
|
|
+**Programmable NFTs** were introduced to solve this problem. They are a new _opt-in_ Token Standard that **keeps the underlying token accounts frozen at all times**. That way, nobody can transfer, lock or burn Programmable NFTs without going through the Token Metadata program.
|
|
|
+
|
|
|
+It is then up to the creators to define custom operation-specific authorization rules that will be enforced by the Token Metadata program. These are defined in a special **RuleSet** account which is attached to the Metadata account. An example of such RuleSet could be an allowlist of program addresses that honor royalties. RuleSets are part of a new Metaplex program called [Token Auth Rules](https://github.com/metaplex-foundation/mpl-token-auth-rules).
|
|
|
+
|
|
|
+You can [read more about Programmable NFTs here](https://github.com/metaplex-foundation/metaplex-program-library/blob/master/token-metadata/program/ProgrammableNFTGuide.md).
|
|
|
|
|
|
-## Getting help
|
|
|
+
|
|
|
|
|
|
-Consequuntur et aut quisquam et qui consequatur eligendi. Necessitatibus dolorem sit. Excepturi cumque quibusdam soluta ullam rerum voluptatibus. Porro illo sequi consequatur nisi numquam nisi autem. Ut necessitatibus aut. Veniam ipsa voluptatem sed.
|
|
|
+## And a lot more
|
|
|
|
|
|
-### Submit an issue
|
|
|
+Whilst this provides a good overview of the Token Metadata program and what it has to offer, there’s still a lot more that can be done with it.
|
|
|
|
|
|
-Inventore et aut minus ut voluptatem nihil commodi doloribus consequatur. Facilis perferendis nihil sit aut aspernatur iure ut dolores et. Aspernatur odit dignissimos. Aut qui est sint sint.
|
|
|
+The other pages of the “Token Metadata” section aim to document it further and explain significant features in their own individual pages.
|
|
|
|
|
|
-Facere aliquam qui. Dolorem officia ipsam adipisci qui molestiae. Error voluptatem reprehenderit ex.
|
|
|
+The next three pages focus on helping you get started with the Token Metadata program and provide detailed information on the accounts and instructions it provides, so you get the full picture and can refer back to them in the future.
|
|
|
|
|
|
-Consequatur enim quia maiores aperiam et ipsum dicta. Quam ut sit facere sit quae. Eligendi veritatis aut ut veritatis iste ut adipisci illo.
|
|
|
+- [Getting started](/token-metadata/getting-started)
|
|
|
+- [Accounts](/token-metadata/accounts)
|
|
|
+- [Instructions](/token-metadata/instructions)
|
|
|
|
|
|
-### Join the community
|
|
|
+The next pages act as in-depth guides on certain features offered by the program.
|
|
|
|
|
|
-Praesentium facilis iste aliquid quo quia a excepturi. Fuga reprehenderit illo sequi voluptatem voluptatem omnis. Id quia consequatur rerum consectetur eligendi et omnis. Voluptates iusto labore possimus provident praesentium id vel harum quisquam. Voluptatem provident corrupti.
|
|
|
+- [Token Standard](/token-metadata/token-standard)
|
|
|
+- [Certified Collections](/token-metadata/certified-collections)
|
|
|
+- [Using NFTs](/token-metadata/using-nfts)
|
|
|
|
|
|
-Eum et ut. Qui facilis est ipsa. Non facere quia sequi commodi autem. Dicta autem sit sequi omnis impedit. Eligendi amet dolorum magnam repudiandae in a.
|
|
|
+Finally, the last two pages answer frequently asked questions and document version updates.
|
|
|
|
|
|
-Molestiae iusto ut exercitationem dolorem unde iusto tempora atque nihil. Voluptatem velit facere laboriosam nobis ea. Consequatur rerum velit ipsum ipsam. Et qui saepe consequatur minima laborum tempore voluptatum et. Quia eveniet eaque sequi consequatur nihil eos.
|
|
|
+- [FAQ](/token-metadata/faq)
|
|
|
+- [Changelog](/token-metadata/changelog/)
|
Loris Leiva