Skip to content

Commit

Permalink
Update NFTS Pallet Information (w3f#4452)
Browse files Browse the repository at this point in the history 
* added info about other nft holders

- i.e. the HolderOf flag

* added info collection IDs

* minor edits collection ids

* Added info automatic schedules

* correction, schedule is not automatic

* hackathon example

* Added example info, minor edits

* "no config" error

* minor edit

* added info to check owned nfts

* updated no config issue

* Added new section

- create collections

* added settings, reorg list

* reorg other mint settings, moved banner

* filled minting section

* minor edits

* added space for video tutorials.

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Jegor Sidorenko <[email protected]>

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Jegor Sidorenko <[email protected]>

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Jegor Sidorenko <[email protected]>

* Collection ids are not auto-incremented

* fully addressed feedback

* removed video sections

* Added info about metadata and ids

* Run grammarly

* Minor edit

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-nft-pallets.md

Co-authored-by: Radha <[email protected]>

* added bitflags constraint

---------

Co-authored-by: Jegor Sidorenko <[email protected]>
Co-authored-by: Radha <[email protected]>
  • Loading branch information
@filippoweb3 @jsidorenko @DrW3RK
3 people authored Feb 14, 2023
1 parent f1ff11f commit 9d8ae20
Showing 1 changed file with 111 additions and 39 deletions.
150 changes: 111 additions & 39 deletions docs/learn/learn-nft-pallets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,49 +12,56 @@ NFT-related actions within their dApp.

## NFTs Pallet

### Current Implementations

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.

Some features are common to the NFT world, such as:
### Creating a Collection

- Buying an item up for sale.
- Creating (i.e., mint) and burning (i.e., destroy) a collection of items or a single item (burning
must be signed either by the admin of the collection or the owner). Creating an item usually
involves setting some attributes specific to that item. Creating a collection also requires the
specification of the maximum number of items.

[Different settings](https://github.com/paritytech/substrate/pull/12483) are available for minting
collections:

- public mints: everyone can mint an asset (good for soul-bound collections)
- external mint: mint for holders of NFTs in another collection
- wave minting: mint X number of items that go to collection owners and Y number of items for the
public
- force mint: minting bypassing mint settings
- change max supply until it gets locked: possibility to change the supply for a limited amount of
times
You can use the NFTs pallet to create NFT 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
the admin is. Then, under `config: PalletNftsCollectionConfig`, you can configure your collection by
specifying different settings:

- [Smart attributes](https://github.com/paritytech/substrate/pull/12702) allow an NFT owner to grant
permission to other entities (another account, an application, 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. 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.
- `settings` you can specify (in a bitflag-format) settings for your collection:

- `Transferrable items`: When disabled, the items will be non-transferrable (good for soul-bound
NFTs),
- `Unlocked metadata`: When disabled, the metadata will be locked,
- `Unlocked attributes`: When disabled, the attributes in the `CollectionOwner` namespace will be
locked,
- `Unlocked max supply`: allows to change the max supply until it gets locked (i.e. the
possibility to change the supply for a limited amount of time),
- `Deposit required`: when disabled, no mint deposit will be taken for items. This option can be
set by a super-user only.

:::info

Note that currently Polkadot-JS does not support bitflags. Leave the settings field as it is.
Everything is unlocked by default (bitflag value `0`).

:::

- `maxSupply` (toggle option) allows you to specify the maximum number of items that can be minted.
- `mintSettings: PalletNftsMintSettings` allows you 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. This avoids looping through all
existing collections and spamming RPC nodes with requests to find available IDs.
- `price` (toggle option) allows you 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 options 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

Expand All @@ -64,9 +71,74 @@ to lock. Also, unauthorized and/or unprivileged transfers can be prevented by lo

:::

Other features are less common and include:
With all these options, one can decide to modify the price of the collection's items and 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 modify the
parameters so anyone can buy more NFTs from Collection X.

This can be useful for events such as Hackathons where participants who bought a ticket receive the
NFT ticket from Collection A. Then, all holders of at least one item in Collection A (i.e. all
ticket holders) will be given free avatar NFT from Collection X within the event 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 to hold at least one NFT in Collection A. One can only
claim the avatar specifying which NFT (i.e. the ID) they own in Collection A. The same NFT cannot be
used twice. Holders of multiple NFTs in Collection A (for example, participants in multiple
Hackathons) can claim multiple avatars specific to each event.

:::warning Time frame must be updated

- Delegating accounts: delegated accounts can approve changes to an item's attributes and transfer
Someone trying to mint an NFT outside the specified time frame will trigger a `NoConfig` error, as
the collection’s admin has specified no configuration 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, 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, and specify the
account owning the NFT and the collection ID. You can also see all your collections by selecting the
`collectionAccount` extrinsic.

When a new collection is created, a new ID will be generated and assigned to that collection. When a
collection is destroyed, no one can pick up the collection ID again (including the owner).

### Minting an NFT

You can mint an NFT using the `nfts.mint` extrinsic. You must then specify the following:

- `collection`, the collection ID where you want to mint
- `item`, the item ID
- `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.

### 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). Metadata could consist of any arbitrary data like the IPFS hash.
- 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.
Expand All @@ -87,15 +159,15 @@ deployed on the Statemint and Statemine system parachains. It implements the mos
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.
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.

![nft-statemine](../assets/nft/nft-statemine.png)

The can also be interacted with directly through the
They 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):

![uniques.png](../assets/nft/uniques.png)

0 comments on commit 9d8ae20

Please sign in to comment.