feat(pallet-nfts): optimization

pallets/nfts/README.md

@@ -51,7 +51,9 @@ The NFTs pallet in Substrate is designed to make the following possible:
 * `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.
+* `approve_collection_transfer`: Name a delegate who may authorize a transfer of all collection items owned by the account.
 * `cancel_approval`: Revert the effects of a previous `approve_transfer`.
+* `cancel_collection_approval`: Revert the effects of a previous `approve_collection_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.
@@ -70,6 +72,7 @@ The NFTs pallet in Substrate is designed to make the following possible:
 * `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`.
+* `clear_collection_approvals`: Clears collection approvals set by calling the `approve_collection_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
@@ -95,6 +98,9 @@ The NFTs pallet in Substrate is designed to make the following possible:
 * `force_collection_owner`: Change collection's owner.
 * `force_collection_config`: Change collection's config.
 * `force_set_attribute`: Set an attribute.
+* `force_approve_collection_transfer`: Name a delegate who may authorize a transfer of all collection items owned by the specified account.
+* `force_cancel_collection_approval`: Revert the effects of a previous `approve_collection_transfer`.
+* `force_clear_collection_approvals`: Revert the effects of all previous `approve_collection_transfer` calls for the collection.
 
 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.

pallets/nfts/src/benchmarking.rs

@@ -578,7 +578,7 @@ benchmarks_instance_pallet! {
 		let deadline = BlockNumberFor::<T>::max_value();
 	}: _(SystemOrigin::Signed(caller.clone()), collection, item, delegate_lookup, Some(deadline))
 	verify {
-		assert_last_event::<T, I>(Event::TransferApproved { collection, item, owner: caller, delegate, deadline: Some(deadline) }.into());
+		assert_last_event::<T, I>(Event::TransferApproved { collection, item: Some(item), owner: caller, delegate, deadline: Some(deadline) }.into());
 	}
 
 	cancel_approval {
@@ -591,7 +591,7 @@ benchmarks_instance_pallet! {
 		Nfts::<T, I>::approve_transfer(origin, collection, item, delegate_lookup.clone(), Some(deadline))?;
 	}: _(SystemOrigin::Signed(caller.clone()), collection, item, delegate_lookup)
 	verify {
-		assert_last_event::<T, I>(Event::ApprovalCancelled { collection, item, owner: caller, delegate }.into());
+		assert_last_event::<T, I>(Event::ApprovalCancelled { collection, item: Some(item), owner: caller, delegate }.into());
 	}
 
 	clear_all_transfer_approvals {
@@ -876,5 +876,90 @@ benchmarks_instance_pallet! {
 		);
 	}
 
+	approve_collection_transfer {
+		let (collection, caller, _) = create_collection::<T, I>();
+		mint_item::<T, I>(0);
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let deadline = BlockNumberFor::<T>::max_value();
+	}: _(SystemOrigin::Signed(caller.clone()), collection, delegate_lookup, Some(deadline))
+	verify {
+		assert_last_event::<T, I>(Event::TransferApproved { collection, item: None, owner: caller, delegate, deadline: Some(deadline) }.into());
+	}
+
+	force_approve_collection_transfer {
+		let (collection, caller, caller_lookup) = create_collection::<T, I>();
+		mint_item::<T, I>(0);
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let deadline = BlockNumberFor::<T>::max_value();
+	}: _(SystemOrigin::Root, caller_lookup, collection, delegate_lookup, Some(deadline))
+	verify {
+		assert_last_event::<T, I>(Event::TransferApproved { collection, item: None, owner: caller, delegate, deadline: Some(deadline) }.into());
+	}
+
+	cancel_collection_approval {
+		let (collection, caller, _) = create_collection::<T, I>();
+		mint_item::<T, I>(0);
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let origin = SystemOrigin::Signed(caller.clone()).into();
+		let deadline = BlockNumberFor::<T>::max_value();
+		Nfts::<T, I>::approve_collection_transfer(origin, collection, delegate_lookup.clone(), Some(deadline))?;
+	}: _(SystemOrigin::Signed(caller.clone()), collection, delegate_lookup)
+	verify {
+		assert_last_event::<T, I>(Event::ApprovalCancelled { collection, item: None, owner: caller, delegate }.into());
+	}
+
+	force_cancel_collection_approval {
+		let (collection, caller, caller_lookup) = create_collection::<T, I>();
+		mint_item::<T, I>(0);
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let deadline = BlockNumberFor::<T>::max_value();
+		Nfts::<T, I>::approve_collection_transfer(SystemOrigin::Signed(caller.clone()).into(), collection, delegate_lookup.clone(), Some(deadline))?;
+	}: _(SystemOrigin::Root, caller_lookup, collection, delegate_lookup)
+	verify {
+		assert_last_event::<T, I>(Event::ApprovalCancelled { collection, item: None, owner: caller, delegate }.into());
+	}
+
+	clear_collection_approvals {
+		let n in 1 .. 1_000;
+		let (collection, caller, _) = create_collection::<T, I>();
+		mint_item::<T, I>(0);
+		for i in 0 .. n {
+			let delegate: T::AccountId = account("delegate", i, SEED);
+			Nfts::<T, I>::approve_collection_transfer(
+				SystemOrigin::Signed(caller.clone()).into(),
+				collection,
+				T::Lookup::unlookup(delegate),
+				Some(BlockNumberFor::<T>::max_value()),
+			)?;
+		}
+	}: _(SystemOrigin::Signed(caller.clone()), collection, n)
+	verify {
+		assert_last_event::<T, I>(Event::ApprovalsCancelled {collection, owner: caller.clone(), approvals: n}.into());
+		assert!(CollectionApprovals::<T, I>::iter_prefix((collection, caller,)).take(1).next().is_none());
+	}
+
+	force_clear_collection_approvals {
+		let n in 1 .. 1_000;
+		let (collection, caller, caller_lookup) = create_collection::<T, I>();
+		mint_item::<T, I>(0);
+		for i in 0 .. n {
+			let delegate: T::AccountId = account("delegate", i, SEED);
+			Nfts::<T, I>::approve_collection_transfer(
+				SystemOrigin::Signed(caller.clone()).into(),
+				collection,
+				T::Lookup::unlookup(delegate),
+				Some(BlockNumberFor::<T>::max_value()),
+			)?;
+		}
+	}: _(SystemOrigin::Root, caller_lookup, collection, n)
+	verify {
+		assert_last_event::<T, I>(Event::ApprovalsCancelled {collection, owner: caller.clone(), approvals: n}.into());
+		assert!(CollectionApprovals::<T, I>::iter_prefix((collection, caller,)).take(1).next().is_none());
+	}
+
 	impl_benchmark_test_suite!(Nfts, crate::mock::new_test_ext(), crate::mock::Test);
 }

pallets/nfts/src/common_functions.rs

@@ -25,15 +25,38 @@ use crate::*;
 
 impl<T: Config<I>, I: 'static> Pallet<T, I> {
 	/// Get the owner of the item, if the item exists.
+	///
+	/// - `collection`: The identifier of the collection.
+	/// - `item`: The identifier of the collection item.
 	pub fn owner(collection: T::CollectionId, item: T::ItemId) -> Option<T::AccountId> {
 		Item::<T, I>::get(collection, item).map(|i| i.owner)
 	}
 
 	/// Get the owner of the collection, if the collection exists.
+	///
+	/// - `collection`: The identifier of the collection.
 	pub fn collection_owner(collection: T::CollectionId) -> Option<T::AccountId> {
 		Collection::<T, I>::get(collection).map(|i| i.owner)
 	}
 
+	/// Get the total number of items in the collection, if the collection exists.
+	///
+	/// - `collection`: The identifier of the collection.
+	pub fn collection_items(collection: T::CollectionId) -> Option<u32> {
+		Collection::<T, I>::get(collection).map(|i| i.items)
+	}
+
+	/// Get the metadata of the collection item.
+	///
+	/// - `collection`: The identifier of the collection.
+	/// - `item`: The identifier of the collection item.
+	pub fn item_metadata(
+		collection: T::CollectionId,
+		item: T::ItemId,
+	) -> Option<BoundedVec<u8, T::StringLimit>> {
+		ItemMetadataOf::<T, I>::get(collection, item).map(|metadata| metadata.data)
+	}
+
 	/// Validates the signature of the given data with the provided signer's account ID.
 	///
 	/// # Errors