NFTs 2.0

Cargo.toml

@@ -122,6 +122,7 @@ members = [
 	"frame/preimage",
 	"frame/proxy",
 	"frame/message-queue",
+	"frame/nfts",
 	"frame/nomination-pools",
 	"frame/nomination-pools/fuzzer",
 	"frame/nomination-pools/benchmarking",

bin/node/runtime/Cargo.toml

@@ -78,6 +78,7 @@ pallet-membership = { version = "4.0.0-dev", default-features = false, path = ".
 pallet-message-queue = { version = "7.0.0-dev", default-features = false, path = "../../../frame/message-queue" }
 pallet-mmr = { version = "4.0.0-dev", default-features = false, path = "../../../frame/merkle-mountain-range" }
 pallet-multisig = { version = "4.0.0-dev", default-features = false, path = "../../../frame/multisig" }
+pallet-nfts = { version = "4.0.0-dev", default-features = false, path = "../../../frame/nfts" }
 pallet-nomination-pools = { version = "1.0.0", default-features = false, path = "../../../frame/nomination-pools"}
 pallet-nomination-pools-benchmarking = { version = "1.0.0", default-features = false, optional = true, path = "../../../frame/nomination-pools/benchmarking" }
 pallet-nomination-pools-runtime-api = { version = "1.0.0-dev", default-features = false, path = "../../../frame/nomination-pools/runtime-api" }
@@ -197,6 +198,7 @@ std = [
 	"pallet-root-testing/std",
 	"pallet-recovery/std",
 	"pallet-uniques/std",
+	"pallet-nfts/std",
 	"pallet-vesting/std",
 	"log/std",
 	"frame-try-runtime?/std",
@@ -253,6 +255,7 @@ runtime-benchmarks = [
 	"pallet-treasury/runtime-benchmarks",
 	"pallet-utility/runtime-benchmarks",
 	"pallet-uniques/runtime-benchmarks",
+	"pallet-nfts/runtime-benchmarks",
 	"pallet-vesting/runtime-benchmarks",
 	"pallet-whitelist/runtime-benchmarks",
 	"frame-system-benchmarking/runtime-benchmarks",
@@ -312,6 +315,7 @@ try-runtime = [
 	"pallet-asset-tx-payment/try-runtime",
 	"pallet-transaction-storage/try-runtime",
 	"pallet-uniques/try-runtime",
+	"pallet-nfts/try-runtime",
 	"pallet-vesting/try-runtime",
 	"pallet-whitelist/try-runtime",
 ]

bin/node/runtime/src/lib.rs

@@ -56,6 +56,7 @@ use pallet_grandpa::{
 	fg_primitives, AuthorityId as GrandpaId, AuthorityList as GrandpaAuthorityList,
 };
 use pallet_im_online::sr25519::AuthorityId as ImOnlineId;
+use pallet_nfts::PalletFeatures;
 use pallet_nis::WithMaximumOf;
 use pallet_session::historical::{self as pallet_session_historical};
 pub use pallet_transaction_payment::{CurrencyAdapter, Multiplier, TargetedFeeAdjustment};
@@ -301,6 +302,7 @@ impl InstanceFilter<RuntimeCall> for ProxyType {
 				RuntimeCall::Balances(..) |
 					RuntimeCall::Assets(..) |
 					RuntimeCall::Uniques(..) |
+					RuntimeCall::Nfts(..) |
 					RuntimeCall::Vesting(pallet_vesting::Call::vested_transfer { .. }) |
 					RuntimeCall::Indices(pallet_indices::Call::transfer { .. })
 			),
@@ -1528,6 +1530,10 @@ parameter_types! {
 	pub const ItemDeposit: Balance = 1 * DOLLARS;
 	pub const KeyLimit: u32 = 32;
 	pub const ValueLimit: u32 = 256;
+	pub const ApprovalsLimit: u32 = 20;
+	pub const ItemAttributesApprovalsLimit: u32 = 20;
+	pub const MaxTips: u32 = 10;
+	pub const MaxDeadlineDuration: BlockNumber = 12 * 30 * DAYS;
 }
 
 impl pallet_uniques::Config for Runtime {
@@ -1551,6 +1557,36 @@ impl pallet_uniques::Config for Runtime {
 	type Locker = ();
 }
 
+parameter_types! {
+	pub Features: PalletFeatures = PalletFeatures::all_enabled();
+}
+
+impl pallet_nfts::Config for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type CollectionId = u32;
+	type ItemId = u32;
+	type Currency = Balances;
+	type ForceOrigin = frame_system::EnsureRoot<AccountId>;
+	type CollectionDeposit = CollectionDeposit;
+	type ItemDeposit = ItemDeposit;
+	type MetadataDepositBase = MetadataDepositBase;
+	type AttributeDepositBase = MetadataDepositBase;
+	type DepositPerByte = MetadataDepositPerByte;
+	type StringLimit = StringLimit;
+	type KeyLimit = KeyLimit;
+	type ValueLimit = ValueLimit;
+	type ApprovalsLimit = ApprovalsLimit;
+	type ItemAttributesApprovalsLimit = ItemAttributesApprovalsLimit;
+	type MaxTips = MaxTips;
+	type MaxDeadlineDuration = MaxDeadlineDuration;
+	type Features = Features;
+	type WeightInfo = pallet_nfts::weights::SubstrateWeight<Runtime>;
+	#[cfg(feature = "runtime-benchmarks")]
+	type Helper = ();
+	type CreateOrigin = AsEnsureOriginWithArg<EnsureSigned<AccountId>>;
+	type Locker = ();
+}
+
 impl pallet_transaction_storage::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type Currency = Balances;
@@ -1705,6 +1741,7 @@ construct_runtime!(
 		Lottery: pallet_lottery,
 		Nis: pallet_nis,
 		Uniques: pallet_uniques,
+		Nfts: pallet_nfts,
 		TransactionStorage: pallet_transaction_storage,
 		VoterList: pallet_bags_list::<Instance1>,
 		StateTrieMigration: pallet_state_trie_migration,
@@ -1836,6 +1873,7 @@ mod benches {
 		[pallet_transaction_storage, TransactionStorage]
 		[pallet_treasury, Treasury]
 		[pallet_uniques, Uniques]
+		[pallet_nfts, Nfts]
 		[pallet_utility, Utility]
 		[pallet_vesting, Vesting]
 		[pallet_whitelist, Whitelist]

frame/nfts/Cargo.toml

@@ -0,0 +1,49 @@
+[package]
+name = "pallet-nfts"
+version = "4.0.0-dev"
+authors = ["Parity Technologies <admin@parity.io>"]
+edition = "2021"
+license = "Apache-2.0"
+homepage = "https://substrate.io"
+repository = "https://github.com/paritytech/substrate/"
+description = "FRAME NFTs pallet"
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false }
+enumflags2 = { version = "0.7.5" }
+log = { version = "0.4.17", default-features = false }
+scale-info = { version = "2.1.1", default-features = false, features = ["derive"] }
+frame-benchmarking = { version = "4.0.0-dev", default-features = false, optional = true, path = "../benchmarking" }
+frame-support = { version = "4.0.0-dev", default-features = false, path = "../support" }
+frame-system = { version = "4.0.0-dev", default-features = false, path = "../system" }
+sp-runtime = { version = "7.0.0", default-features = false, path = "../../primitives/runtime" }
+sp-std = { version = "5.0.0", default-features = false, path = "../../primitives/std" }
+
+[dev-dependencies]
+pallet-balances = { version = "4.0.0-dev", path = "../balances" }
+sp-core = { version = "7.0.0", path = "../../primitives/core" }
+sp-io = { version = "7.0.0", path = "../../primitives/io" }
+sp-std = { version = "5.0.0", path = "../../primitives/std" }
+
+[features]
+default = ["std"]
+std = [
+	"codec/std",
+	"frame-benchmarking?/std",
+	"frame-support/std",
+	"frame-system/std",
+	"log/std",
+	"scale-info/std",
+	"sp-runtime/std",
+	"sp-std/std",
+]
+runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+]
+try-runtime = ["frame-support/try-runtime"]

frame/nfts/README.md

@@ -0,0 +1,106 @@
+# NFTs pallet
+
+A pallet for dealing with non-fungible assets.
+
+## Overview
+
+The NFTs pallet provides functionality for non-fungible tokens' management, including:
+
+* Collection Creation
+* NFT Minting
+* NFT Transfers and Atomic Swaps
+* NFT Trading methods
+* Attributes Management
+* NFT Burning
+
+To use it in your runtime, you need to implement [`nfts::Config`](https://paritytech.github.io/substrate/master/pallet_nfts/pallet/trait.Config.html).
+
+The supported dispatchable functions are documented in the [`nfts::Call`](https://paritytech.github.io/substrate/master/pallet_nfts/pallet/enum.Call.html) enum.
+
+### Terminology
+
+* **Collection creation:** The creation of a new collection.
+* **NFT minting:** The action of creating a new item within a collection.
+* **NFT transfer:** The action of sending an item from one account to another.
+* **Atomic swap:** The action of exchanging items between accounts without needing a 3rd party service.
+* **NFT burning:** The destruction of an item.
+* **Non-fungible token (NFT):** An item for which each unit has unique characteristics. There is exactly
+  one instance of such an item in existence and there is exactly one owning account (though that owning account could be a proxy account or multi-sig account).
+* **Soul Bound NFT:** An item that is non-transferable from the account which it is minted into.
+
+### Goals
+
+The NFTs pallet in Substrate is designed to make the following possible:
+
+* Allow accounts to permissionlessly create nft collections.
+* Allow a named (permissioned) account to mint and burn unique items within a collection.
+* Move items between accounts permissionlessly.
+* Allow a named (permissioned) account to freeze and unfreeze items within a
+  collection or the entire collection.
+* Allow the owner of an item to delegate the ability to transfer the item to some
+  named third-party.
+* Allow third-parties to store information in an NFT _without_ owning it (Eg. save game state).
+
+## Interface
+
+### Permissionless dispatchables
+
+* `create`: Create a new collection by placing a deposit.
+* `mint`: Mint a new item within a collection (when the minting is public).
+* `transfer`: Send an item to a new owner.
+* `redeposit`: Update the deposit amount of an item, potentially freeing funds.
+* `approve_transfer`: Name a delegate who may authorize a transfer.
+* `cancel_approval`: Revert the effects of a previous `approve_transfer`.
+* `approve_item_attributes`: Name a delegate who may change item's attributes within a namespace.
+* `cancel_item_attributes_approval`: Revert the effects of a previous `approve_item_attributes`.
+* `set_price`: Set the price for an item.
+* `buy_item`: Buy an item.
+* `pay_tips`: Pay tips, could be used for paying the creator royalties.
+* `create_swap`: Create an offer to swap an NFT for another NFT and optionally some fungibles.
+* `cancel_swap`: Cancel previously created swap offer.
+* `claim_swap`: Swap items in an atomic way.
+
+
+### Permissioned dispatchables
+
+* `destroy`: Destroy a collection. This destroys all the items inside the collection and refunds the deposit.
+* `force_mint`: Mint a new item within a collection.
+* `burn`: Destroy an item within a collection.
+* `lock_item_transfer`: Prevent an individual item from being transferred.
+* `unlock_item_transfer`: Revert the effects of a previous `lock_item_transfer`.
+* `clear_all_transfer_approvals`: Clears all transfer approvals set by calling the `approve_transfer`.
+* `lock_collection`: Prevent all items within a collection from being transferred (making them all `soul bound`).
+* `lock_item_properties`: Lock item's metadata or attributes.
+* `transfer_ownership`: Alter the owner of a collection, moving all associated deposits. (Ownership of individual items will not be affected.)
+* `set_team`: Alter the permissioned accounts of a collection.
+* `set_collection_max_supply`: Change the max supply of a collection.
+* `update_mint_settings`: Update the minting settings for collection.
+
+
+### Metadata (permissioned) dispatchables
+
+* `set_attribute`: Set a metadata attribute of an item or collection.
+* `clear_attribute`: Remove a metadata attribute of an item or collection.
+* `set_metadata`: Set general metadata of an item (E.g. an IPFS address of an image url).
+* `clear_metadata`: Remove general metadata of an item.
+* `set_collection_metadata`: Set general metadata of a collection.
+* `clear_collection_metadata`: Remove general metadata of a collection.
+
+
+### Force (i.e. governance) dispatchables
+
+* `force_create`: Create a new collection (the collection id can not be chosen).
+* `force_collection_owner`: Change collection's owner.
+* `force_collection_config`: Change collection's config.
+* `force_set_attribute`: Set an attribute.
+
+Please refer to the [`Call`](https://paritytech.github.io/substrate/master/pallet_nfts/pallet/enum.Call.html) enum
+and its associated variants for documentation on each function.
+
+## Related Modules
+
+* [`System`](https://docs.rs/frame-system/latest/frame_system/)
+* [`Support`](https://docs.rs/frame-support/latest/frame_support/)
+* [`Assets`](https://docs.rs/pallet-assets/latest/pallet_assets/)
+
+License: Apache-2.0