feat(api/nonfungibles): api + integration tests

pallets/api/src/nonfungibles/mod.rs

@@ -11,38 +11,18 @@
 	CollectionSetting, CollectionSettings, DestroyWitness, ItemDeposit, ItemDetails, ItemMetadata,
 	ItemSetting, MintSettings, MintType, MintWitness,
 };
-use sp_runtime::traits::StaticLookup;
+use sp_runtime::{traits::StaticLookup, BoundedVec};
+use types::*;
 use weights::WeightInfo;
 
 #[cfg(feature = "runtime-benchmarks")]
 mod benchmarking;
 #[cfg(test)]
 mod tests;
+pub mod types;
 pub mod weights;
 
-type AccountIdOf<T> = <T as frame_system::Config>::AccountId;
-type NftsOf<T> = pallet_nfts::Pallet<T, NftsInstanceOf<T>>;
-type NftsErrorOf<T> = pallet_nfts::Error<T, NftsInstanceOf<T>>;
-type NftsWeightInfoOf<T> = <T as pallet_nfts::Config<NftsInstanceOf<T>>>::WeightInfo;
-type NftsInstanceOf<T> = <T as Config>::NftsInstance;
-type BalanceOf<T> = <<T as pallet_nfts::Config<NftsInstanceOf<T>>>::Currency as Currency<
-	<T as frame_system::Config>::AccountId,
->>::Balance;
-type CollectionIdOf<T> =
-	<NftsOf<T> as Inspect<<T as frame_system::Config>::AccountId>>::CollectionId;
-type ItemIdOf<T> = <NftsOf<T> as Inspect<<T as frame_system::Config>::AccountId>>::ItemId;
-type ItemPriceOf<T> = BalanceOf<T>;
-type CollectionDetailsFor<T> = CollectionDetails<AccountIdOf<T>, BalanceOf<T>>;
-type AttributeNamespaceOf<T> = AttributeNamespace<AccountIdOf<T>>;
-type CollectionConfigFor<T> =
-	CollectionConfig<ItemPriceOf<T>, BlockNumberFor<T>, CollectionIdOf<T>>;
-// Type aliases for pallet-nfts storage items.
-pub(super) type AccountBalanceOf<T> = pallet_nfts::AccountBalance<T, NftsInstanceOf<T>>;
-pub(super) type AttributeOf<T> = pallet_nfts::Attribute<T, NftsInstanceOf<T>>;
-pub(super) type NextCollectionIdOf<T> = pallet_nfts::NextCollectionId<T, NftsInstanceOf<T>>;
-pub(super) type CollectionOf<T> = pallet_nfts::Collection<T, NftsInstanceOf<T>>;
-
 #[frame_support::pallet]
 pub mod pallet {
 	use frame_support::{
 		dispatch::{DispatchResult, DispatchResultWithPostInfo, WithPostDispatchInfo},
@@ -50,8 +30,6 @@
 		traits::Incrementable,
 	};
 	use frame_system::pallet_prelude::*;
-	use pallet_nfts::{CancelAttributesApprovalWitness, DestroyWitness, MintWitness};
-	use sp_runtime::BoundedVec;
 	use sp_std::vec::Vec;
 
 	use super::*;
@@ -104,7 +82,7 @@
 			/// The namespace of the attribute.
 			namespace: AttributeNamespaceOf<T>,
 			/// The key of the attribute.
-			key: BoundedVec<u8, T::KeyLimit>,
+			key: AttributeKey<T>,
 		},
 		/// Details of a specified collection.
 		#[codec(index = 9)]
@@ -217,188 +195,188 @@
 		},
 	}
 
 	#[pallet::call]
 	impl<T: Config> Pallet<T> {
 		/// Transfers the collection item from the caller's account to account `to`.
 		///
 		/// # Parameters
 		/// - `collection` - The collection of the item to transfer.
 		/// - `item` - The item to transfer.
 		/// - `to` - The recipient account.
 		#[pallet::call_index(3)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::transfer())]
 		pub fn transfer(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			item: ItemIdOf<T>,
 			to: AccountIdOf<T>,
 		) -> DispatchResult {
 			let from = ensure_signed(origin.clone())?;
 			NftsOf::<T>::transfer(origin, collection, item, T::Lookup::unlookup(to.clone()))?;
 			Self::deposit_event(Event::Transfer {
 				collection,
 				item,
 				from: Some(from),
 				to: Some(to),
 				price: None,
 			});
 			Ok(())
 		}
 
 		/// Approves `operator` to spend the collection item on behalf of the caller.
 		///
 		/// # Parameters
 		/// - `collection` - The collection of the item to approve for a delegated transfer.
 		/// - `item` - The item to approve for a delegated transfer.
 		/// - `operator` - The account that is allowed to spend the collection item.
 		/// - `approved` - The approval status of the collection item.
 		#[pallet::call_index(4)]
 		#[pallet::weight(
             NftsWeightInfoOf::<T>::approve_transfer(item.is_some() as u32) +
     		NftsWeightInfoOf::<T>::cancel_approval(item.is_some() as u32)
         )]
 		pub fn approve(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			item: Option<ItemIdOf<T>>,
 			operator: AccountIdOf<T>,
 			approved: bool,
 		) -> DispatchResultWithPostInfo {
 			let owner = ensure_signed(origin.clone())?;
 			let weight = if approved {
 				NftsOf::<T>::approve_transfer(
 					origin,
 					collection,
 					item,
 					T::Lookup::unlookup(operator.clone()),
 					None,
 				)
 				.map_err(|e| {
 					e.with_weight(NftsWeightInfoOf::<T>::approve_transfer(item.is_some() as u32))
 				})?;
 				NftsWeightInfoOf::<T>::approve_transfer(item.is_some() as u32)
 			} else {
 				NftsOf::<T>::cancel_approval(
 					origin,
 					collection,
 					item,
 					T::Lookup::unlookup(operator.clone()),
 				)
 				.map_err(|e| {
 					e.with_weight(NftsWeightInfoOf::<T>::cancel_approval(item.is_some() as u32))
 				})?;
 				NftsWeightInfoOf::<T>::cancel_approval(item.is_some() as u32)
 			};
 			Self::deposit_event(Event::Approval { collection, item, operator, owner, approved });
 			Ok(Some(weight).into())
 		}
 
 		/// Issue a new collection of non-fungible items from a public origin.
 		///
 		/// # Parameters
 		/// - `admin` - The admin of this collection. The admin is the initial address of each
 		/// member of the collection's admin team.
 		/// - `config` - The configuration of the collection.
 		#[pallet::call_index(7)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::create())]
 		pub fn create(
 			origin: OriginFor<T>,
 			admin: AccountIdOf<T>,
 			config: CollectionConfigFor<T>,
 		) -> DispatchResult {
 			let creator = ensure_signed(origin.clone())?;
 			// TODO: re-evaluate next collection id in nfts pallet. The `Incrementable` trait causes
 			//  issues for setting it to xcm's `Location`. This can easily be done differently.
 			let id = NextCollectionIdOf::<T>::get()
 				.or(T::CollectionId::initial_value())
 				.ok_or(NftsErrorOf::<T>::UnknownCollection)?;
 			NftsOf::<T>::create(origin, T::Lookup::unlookup(admin.clone()), config)?;
 			Self::deposit_event(Event::Created { id, creator, admin });
 			Ok(())
 		}
 
 		/// Destroy a collection of fungible items.
 		///
 		/// # Parameters
 		/// - `collection` - The collection to destroy.
 		/// - `witness` - Information on the items minted in the collection. This must be
 		/// correct.
 		#[pallet::call_index(8)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::destroy(
     		witness.item_metadatas,
     		witness.item_configs,
     		witness.attributes,
             witness.item_holders,
             witness.allowances,
 		))]
 		pub fn destroy(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			witness: DestroyWitness,
 		) -> DispatchResultWithPostInfo {
 			NftsOf::<T>::destroy(origin, collection, witness)
 		}
 
 		/// Set an attribute for a collection or item.
 		///
 		/// # Parameters
 		/// - `collection` - The collection whose item's metadata to set.
 		/// - `maybe_item` - The item whose metadata to set.
 		/// - `namespace` - Attribute's namespace.
 		/// - `key` - The key of the attribute.
 		/// - `value` - The value to which to set the attribute.
 		#[pallet::call_index(12)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::set_attribute())]
 		pub fn set_attribute(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			item: Option<ItemIdOf<T>>,
 			namespace: AttributeNamespaceOf<T>,
-			key: BoundedVec<u8, T::KeyLimit>,
-			value: BoundedVec<u8, T::ValueLimit>,
+			key: AttributeKey<T>,
+			value: AttributeValue<T>,
 		) -> DispatchResult {
 			NftsOf::<T>::set_attribute(origin, collection, item, namespace, key, value)
 		}
 
 		/// Clear an attribute for the collection or item.
 		///
 		/// # Parameters
 		/// - `collection` - The collection whose item's metadata to clear.
 		/// - `maybe_item` - The item whose metadata to clear.
 		/// - `namespace` - Attribute's namespace.
 		/// - `key` - The key of the attribute.
 		#[pallet::call_index(13)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::clear_attribute())]
 		pub fn clear_attribute(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			item: Option<ItemIdOf<T>>,
 			namespace: AttributeNamespaceOf<T>,
-			key: BoundedVec<u8, T::KeyLimit>,
+			key: AttributeKey<T>,
 		) -> DispatchResult {
 			NftsOf::<T>::clear_attribute(origin, collection, item, namespace, key)
 		}
 
 		/// Set the metadata for an item.
 		///
 		/// # Parameters
 		/// - `collection` - The collection whose item's metadata to set.
 		/// - `item` - The item whose metadata to set.
 		/// - `data` - The general information of this item. Limited in length by `StringLimit`.
 		#[pallet::call_index(14)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::set_metadata())]
 		pub fn set_metadata(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			item: ItemIdOf<T>,
-			data: BoundedVec<u8, T::StringLimit>,
+			data: MetadataData<T>,
 		) -> DispatchResult {
 			NftsOf::<T>::set_metadata(origin, collection, item, data)
 		}
 
 		#[pallet::call_index(15)]
 		#[pallet::weight(NftsWeightInfoOf::<T>::clear_metadata())]
 		pub fn clear_metadata(
 			origin: OriginFor<T>,
 			collection: CollectionIdOf<T>,
 			item: ItemIdOf<T>,

pallets/api/src/nonfungibles/types.rs

@@ -0,0 +1,31 @@
+use super::*;
+
+pub(super) type AccountIdOf<T> = <T as frame_system::Config>::AccountId;
+pub(super) type NftsOf<T> = pallet_nfts::Pallet<T, NftsInstanceOf<T>>;
+pub(super) type NftsErrorOf<T> = pallet_nfts::Error<T, NftsInstanceOf<T>>;
+pub(super) type NftsWeightInfoOf<T> = <T as pallet_nfts::Config<NftsInstanceOf<T>>>::WeightInfo;
+pub(super) type NftsInstanceOf<T> = <T as Config>::NftsInstance;
+pub(super) type BalanceOf<T> =
+	<<T as pallet_nfts::Config<NftsInstanceOf<T>>>::Currency as Currency<
+		<T as frame_system::Config>::AccountId,
+	>>::Balance;
+pub(super) type CollectionIdOf<T> =
+	<NftsOf<T> as Inspect<<T as frame_system::Config>::AccountId>>::CollectionId;
+pub(super) type ItemIdOf<T> =
+	<NftsOf<T> as Inspect<<T as frame_system::Config>::AccountId>>::ItemId;
+pub(super) type ItemPriceOf<T> = BalanceOf<T>;
+pub(super) type CollectionDetailsFor<T> = CollectionDetails<AccountIdOf<T>, BalanceOf<T>>;
+pub(super) type AttributeNamespaceOf<T> = AttributeNamespace<AccountIdOf<T>>;
+pub(super) type CollectionConfigFor<T> =
+	CollectionConfig<ItemPriceOf<T>, BlockNumberFor<T>, CollectionIdOf<T>>;
+// Public due to pop-api integration tests crate.
+pub type AccountBalanceOf<T> = pallet_nfts::AccountBalance<T, NftsInstanceOf<T>>;
+pub type AttributeOf<T> = pallet_nfts::Attribute<T, NftsInstanceOf<T>>;
+pub type AttributeKey<T> = BoundedVec<u8, <T as pallet_nfts::Config<NftsInstanceOf<T>>>::KeyLimit>;
+pub type AttributeValue<T> =
+	BoundedVec<u8, <T as pallet_nfts::Config<NftsInstanceOf<T>>>::ValueLimit>;
+pub type CollectionOf<T> = pallet_nfts::Collection<T, NftsInstanceOf<T>>;
+pub type CollectionConfigOf<T> = pallet_nfts::CollectionConfigOf<T, NftsInstanceOf<T>>;
+pub type NextCollectionIdOf<T> = pallet_nfts::NextCollectionId<T, NftsInstanceOf<T>>;
+pub type MetadataData<T> =
+	BoundedVec<u8, <T as pallet_nfts::Config<NftsInstanceOf<T>>>::StringLimit>;

pop-api/Cargo.toml

@@ -6,6 +6,8 @@ name = "pop-api"
 version = "0.0.0"
 
 [dependencies]
+bitflags = { version = "1.3.2" }
+enumflags2 = "0.7.9"
 ink = { version = "5.0.0", default-features = false }
 pop-primitives = { path = "../primitives", default-features = false }
 sp-io = { version = "37.0.0", default-features = false, features = [
@@ -22,4 +24,5 @@ path = "src/lib.rs"
 [features]
 default = [ "std" ]
 fungibles = [  ]
+nonfungibles = [  ]
 std = [ "ink/std", "pop-primitives/std", "sp-io/std" ]

pop-api/integration-tests/Cargo.toml

@@ -13,11 +13,14 @@ frame-support = { version = "36.0.0", default-features = false }
 frame-support-procedural = { version = "=30.0.1", default-features = false }
 frame-system = { version = "36.1.0", default-features = false }
 log = "0.4.22"
+pallet-api = { path = "../../pallets/api", default-features = false }
 pallet-assets = { version = "37.0.0", default-features = false }
 pallet-balances = { version = "37.0.0", default-features = false }
 pallet-contracts = { version = "35.0.0", default-features = false }
+pallet-nfts = { path = "../../pallets/nfts", default-features = false }
 pop-api = { path = "../../pop-api", default-features = false, features = [
 	"fungibles",
+	"nonfungibles",
 ] }
 pop-primitives = { path = "../../primitives", default-features = false }
 pop-runtime-devnet = { path = "../../runtime/devnet", default-features = false }
@@ -36,9 +39,11 @@ devnet = [  ]
 std = [
 	"frame-support/std",
 	"frame-system/std",
+	"pallet-api/std",
 	"pallet-assets/std",
 	"pallet-balances/std",
 	"pallet-contracts/std",
+	"pallet-nfts/std",
 	"pop-api/std",
 	"pop-primitives/std",
 	"pop-runtime-devnet/std",

pop-api/integration-tests/contracts/nonfungibles/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+authors = [ "R0GUE <[email protected]>" ]
+edition = "2021"
+name = "nonfungibles"
+version = "0.1.0"
+
+[dependencies]
+ink = { version = "5.0.0", default-features = false }
+pop-api = { path = "../../../../pop-api", default-features = false, features = [ "nonfungibles" ] }
+
+[lib]
+path = "lib.rs"
+
+[features]
+default = [ "std" ]
+e2e-tests = [  ]
+ink-as-dependency = [  ]
+std = [
+	"ink/std",
+	"pop-api/std",
+]