forked from w3f/polkadot-wiki
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge commit 'a5d31bbf2f017d3639432e2308e6b50157baa1b7'
- Loading branch information
Showing
1 changed file
with
185 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| --- | ||
| id: learn-nft-pallets | ||
| title: NFT Pallets | ||
| sidebar_label: NFT Pallets | ||
| description: An overview of the functionalities of NFT Pallets in Polkadot Ecosystem. | ||
| keywords: [NFT, non-fungible token, NFT 2.0, nfts, NFT pallets] | ||
| slug: ../learn-nft-pallets | ||
| --- | ||
|
|
||
| NFT [pallets](learn-extrinsics.md#pallets-and-extrinsics) allow developers to easily implement | ||
| NFT-related actions within their dApp. | ||
|
|
||
| ## NFTs Pallet | ||
|
|
||
| NFTs is a [FRAME pallet](https://polkadot.js.org/docs/substrate/extrinsics#nfts) currently deployed | ||
| on Westmint, which provides a multitude of functions to interact with NFTs. | ||
|
|
||
| The pallet comes with a new way to configure NFTs, as well as configure collections and items. | ||
| Pallet-level [feature flags](https://github.com/paritytech/substrate/pull/12367) allow disabling | ||
| functionalities that are not needed in the runtime. | ||
|
|
||
| ### Creating a Collection | ||
|
|
||
| :::info | ||
|
|
||
| Walkthrough video tutorial about creating a collection. | ||
|
|
||
| ::: | ||
|
|
||
| You can use the NFTs pallet to create NFTs collections. In the Polkadot-JS UI go to Developer > | ||
| Extrinsic and select the `nfts.create` extrinsic. When you create a collection you must specify who | ||
| is the admin. Then, under `config: PalletNftsCollectionConfig`, you can configure your collection's | ||
| specifying different settings: | ||
|
|
||
| - `settings` you can specify (in a bitflag-format) settings for your collection: | ||
| - Transferrable items: items can be non-transferrable (good for soul-bound NFTs), | ||
| - Unlocked metadata: metadata can be locked, | ||
| - Unlocked attributes: attributes can be locked, | ||
| - Unlocked max supply: allows to change the max supply until it gets locked (i.e. possibility to | ||
| change the supply for a limited amount of times), | ||
| - Deposit required. | ||
|
|
||
| Everything is unlocked by default (bitflag `0`). | ||
|
|
||
| - `maxSupply: Option` (toggle option) gives you the possibility to specify the maximum number of | ||
| items that can be minted. | ||
| - `mintSettings: PalletNftsMintSettings` gives you the possibility to specify different settings for | ||
| your collection. | ||
| - `mintType` gives you the possibility to specify who can mint in your collection: | ||
| - `Ìssuer`: only you can mint in your collection. | ||
| - `Public`: everyone can mint in your collection. | ||
| - `HoderOf`: only holders of items in another collection can mint in your collection. This | ||
| requires knowledge about the ID of the other collection. Collections IDs are auto-incremented. | ||
| This avoids to loop through all existing collections spamming RPC nodes with requests to find | ||
| out available IDs. | ||
| - `price` (toggle option) gives you the possibility to specify the price of the items. | ||
| - `startBlock`and `endBlock` give you the possibility to specify a time frame during which the | ||
| collection's configuration is valid (i.e. all option within | ||
| `config: PalletNftsCollectionConfig`). | ||
| - [other mint settings](https://github.com/paritytech/substrate/pull/12483) include: | ||
| - wave minting, for example mint X number of items that go to collection owners and Y number of | ||
| items for the public | ||
| - force mint: minting bypassing mint settings | ||
|
|
||
| :::info | ||
|
|
||
| Metadata, attributes, and settings of an item or collection can be locked. The user can decide what | ||
| to lock. Also, unauthorized and/or unprivileged transfers can be prevented by locking mechanism | ||
| (unprivileged actions can be re-allowed anytime). | ||
|
|
||
| ::: | ||
|
|
||
| With all these options, one can decide to modify the price of the collection's items as well as who | ||
| can mint, receive or buy items in that collection. Time constraints are available with `startBlock` | ||
| and `endBlock` parameters. It is thus possible, for example, to create a schedule in which holders | ||
| of items in collection A (`HolderOf` parameter) will be able to claim for free a limited number of | ||
| NFTs from Collection X (`maxSupply` parameter) only within a specific time frame. You can then | ||
| modify the parameters so that anyone will be able to buy more NFTs from Collection X. | ||
|
|
||
| This can be useful for events such as Hackathons where participant who bought a ticket receive the | ||
| NFT ticket from Collection A. Then, to all holders of at least one item in Collection A (i.e. all | ||
| ticket holders) will be given for free an avatar NFT from Collection X within the event time | ||
| schedule. After the event, any additional remaining items in Collection X can be made available to | ||
| the public through a marketplace. | ||
|
|
||
| The requirement to get the free avatar is being holder of at least one NFT in Collection A. One can | ||
| only claim the avatar specifying which NFT (i.e. the ID) owns in Collection A. The same NFT cannot | ||
| be used twice, meaning that holders of multiple NFTs in Collection A (for example participants to | ||
| multiple Hackathons) can claim multiple avatars specific to each event. | ||
|
|
||
| :::warning Time frame must be updated | ||
|
|
||
| Someone trying to mint an NFT outside the specified time frame will trigger a `NoConfig` error, as | ||
| no configuration has been specified by the collection's admin after the time frame ends. The | ||
| collection's admin must call the `updateMintSettings` extrinsic and add a new schedule or disable | ||
| the block number option. | ||
|
|
||
| ::: | ||
|
|
||
| After you minted an NFT, it is possible to check which NFT IDs you own under which collection. In | ||
| the Polkadot-JS UI go to Developer > Chain State > Storage, select the `nfts.account` extrinsic, | ||
| specify the account owning the NFT and the collection ID. You can also see all the collections you | ||
| own by selecting the `collectionAccount` extrinsic. | ||
|
|
||
| ### Minting an NFT | ||
|
|
||
| :::info | ||
|
|
||
| Walkthrough video tutorial about minting an NFT. | ||
|
|
||
| ::: | ||
|
|
||
| You can mint an NFT using the `nfts.mint` extrinsic. You must then specify the followings: | ||
|
|
||
| - `collection`, the collection ID where you want to mint | ||
| - `item`, the item ID (auto-incremented) | ||
| - `mintTo`, the account | ||
| - `witnessData` (toggle option), you can specify if you own an NFT in another collection | ||
|
|
||
| Creating an item usually involves setting some attributes specific to that item. | ||
|
|
||
| ### Example `HolderOf` Minting | ||
|
|
||
| :::info | ||
|
|
||
| Walkthrough video tutorial about minting an NFT restricted to holders of a specific collection. | ||
|
|
||
| ::: | ||
|
|
||
| Example description goes here. | ||
|
|
||
| ### Other Actions | ||
|
|
||
| - Buying an item up for sale | ||
| - Burning (i.e., destroy) items or a single item (burning must be signed either by the admin of the | ||
| collection or the owner). | ||
| - [Smart attributes](https://github.com/paritytech/substrate/pull/12702) allow an NFT owner to grant | ||
| permission to other entities (another account, an application, an oracle, etc.) to update | ||
| attributes of an NFT. An example could be that all Polkadot fellowship members have an NFT badge | ||
| that gets updated over time (sort of a rank) with a consequent upgrade in membership permissions. | ||
| - A collection is managed by the | ||
| [Issuer, the Admin and the Freezer](./learn-assets.md#creation-and-management). Those roles can be | ||
| changed anytime, and there will be the option to attach | ||
| [multiple accounts per role](https://github.com/paritytech/substrate/pull/12437). | ||
| - Setting metadata for an item or collection (metadata includes all essential information about the | ||
| item or the collection) | ||
| - Setting or re-setting the price of an item. | ||
| - Clearing attributes and metadata of a collection or an item. | ||
| - Changing the owner of an item or a collection. | ||
| - Transferring an item, as well as creating and canceling transfer approvals of a specific item, or | ||
| an [atomic swap](https://github.com/paritytech/substrate/pull/12285). | ||
| - Transferring ownership of an item. | ||
| - Delegating accounts: delegated accounts can approve changes to an item's attributes and transfer | ||
| an item. The item owner always has control and can decide to cancel approvals from a delegated | ||
| account. | ||
| - One can also execute pending atomic swaps created by a counterpart. | ||
|
|
||
| ### Work in Progress | ||
|
|
||
| [NFTs fractionalization](https://github.com/paritytech/substrate/pull/12565) will allow the user to: | ||
|
|
||
| - Take ownership of an NFT from the [pallet-uniques](#uniques-pallet) | ||
| - Create a new asset in [pallet-assets](https://polkadot.js.org/docs/substrate/extrinsics#assets) | ||
| - Mint the input amount to the previous owner of the NFT as the beneficiary | ||
|
|
||
| ## Uniques Pallet | ||
|
|
||
| Uniques is a [FRAME pallet](https://github.com/paritytech/substrate/tree/master/frame/uniques) | ||
| deployed on the Statemint and Statemine system parachains. It implements the most basic kind of NFT | ||
| -- a data record referencing some metadata. This metadata reference is mutable until frozen, so NFTs | ||
| and their classes (entities derived from) are mutable unless specifically made immutable by the | ||
| issuer. | ||
|
|
||
| Uniques takes a very bare-bones approach on purpose, to keep the Statemine / Statemint chain a | ||
| simple balance-keeping chain for both fungible and non-fungibles. | ||
|
|
||
| These NFTs can be viewed and interacted with on [RMRK's Singular platform](https://singular.app), by | ||
| switching the top right menu from Kusama to Statemine or Statemint. | ||
|
|
||
|  | ||
|
|
||
| The can also be interacted with directly through the | ||
| [extrinsics tab of Statemine](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fkusama-statemine-rpc.paritytech.net#/extrinsics): | ||
|
|
||
|  |