fix permill issues in the calls when the spawning method when a new frunique is been created

update test to handle the new data
add new helper functions to create a frunique

Author: tlacloc

pallets/fruniques/README.md

@@ -2,7 +2,7 @@
 ### **FR**actional **Uniques**
 > This is WIP - just being spec'd out
 
-This pallet is being developed **tightly coupled** to both [`pallet_assets`](https://paritytech.github.io/substrate/latest/pallet_assets/)  and [`pallet_uniques`](https://paritytech.github.io/substrate/latest/pallet_uniques/index.html). These are the default [Statemine](https://github.com/paritytech/cumulus/tree/master/polkadot-parachains/statemine) pallets for fungible and non-fungible tokens. 
+This pallet is being developed **tightly coupled** to both [`pallet_assets`](https://paritytech.github.io/substrate/latest/pallet_assets/)  and [`pallet_uniques`](https://paritytech.github.io/substrate/latest/pallet_uniques/index.html). These are the default [Statemine](https://github.com/paritytech/cumulus/tree/master/polkadot-parachains/statemine) pallets for fungible and non-fungible tokens.
 
 A Frunique is a type of Non-Fungible Token (NFT)
 
@@ -19,20 +19,20 @@ This pallet provides functionality that allows NFT holders to mint a fungible to
 
 The non-fungible token is created and minted using the Statemine `pallet_uniques`.
 
-The fungible token is created and minted using the Statemine `pallet_assets`. 
+The fungible token is created and minted using the Statemine `pallet_assets`.
 
 The NFT/Unique can be unlocked and released if and only if a single origin holds all of the corresponding fungible token.
 
 ![basket-of-fungibles](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/hashed-io/hashed-substrate/main/docs/fungible-basket-frunique.iuml)
 
 ## NFT <--> NFTs
-An NFT as a trie of NFTs. 
+An NFT as a trie of NFTs.
 
 ### Use cases
 #### Tax credit marketplace
 A credit is a single NFT, with an `amount`, state of redemption, expiration year, and other metadata. However, that owner can sell less than the `amount`, in which case the newly created credit NFT has all of the same associated data.  The sum of the children `amount` values must be equal to the parent.
 
-To support this, we'll create a `AggregatedFrunique` type that enforces the aggregation rules. 
+To support this, we'll create a `AggregatedFrunique` type that enforces the aggregation rules.
 
 #### Cannabis compliance
 For the NY state cannabis compliance program, all yield from all plants must be tracked. This aligns to a very similar data structure as above. Each mother plant is an NFT, each clone as an NFT, each package of flower an NFT, etc. Auditing a specific item is fairly easy via traversing all of its ancestors and descendants through to the harvest and dispensary.
@@ -58,7 +58,7 @@ yarn install
 ```bash
 yarn run:api tx.fruniques.create 1 1 1 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY 1 100 --seed "//Alice"
 ```
-## Check NFT 
+## Check NFT
 ```bash
 yarn run:api query.uniques.class 1
 yarn run:api query.uniques.asset 1 1
@@ -71,9 +71,16 @@ yarn run:api query.assets.asset 1
 yarn run:api query.assets.account 1 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY
 ```
 
+## Tests of the pallet
+
+To run the test you simply run the following command
+```bash
+cargo test --package pallet-fruniques
+```
+
 # Similar Projects
 ### [Fractional Art](https://fractional.art/)
- 
+
 ### [Detailed Process Explainer with screenshots](https://medium.com/fractional-art/how-to-use-fractional-to-fractionalize-nfts-84da1a465b6d)
 
 License: MIT

pallets/fruniques/src/functions.rs

@@ -30,6 +30,10 @@ impl<T: Config> Pallet<T> {
 		u32::from_ne_bytes(input.try_into().unwrap())
 	}
 
+	pub fn percent_to_permill(input: u8) -> Permill {
+		Permill::from_percent(input as u32)
+	}
+
 	pub fn bytes_to_string(input: Vec<u8>) -> String {
 		let mut s = String::default();
 		for x in input {
@@ -196,7 +200,6 @@ impl<T: Config> Pallet<T> {
 		collection: T::CollectionId,
 		item: T::ItemId,
 		owner: <T::Lookup as sp_runtime::traits::StaticLookup>::Source,
-		_numeric_value: Option<Permill>,
 		attributes: Option<Vec<(BoundedVec<u8, T::KeyLimit>, BoundedVec<u8, T::ValueLimit>)>>,
 	) -> DispatchResult {
 

pallets/fruniques/src/lib.rs

@@ -224,15 +224,13 @@ pub mod pallet {
 		///
 		/// ### Parameters needed in order to divide a unique:
 		/// - `class_id`: The type of NFT that the function will create, categorized by numbers.
-		/// - `numeric_value`: The value of the NFT that the function will create.
 		/// - `parent_info`: Information of the parent NFT and a flag to indicate the child would inherit their attributes.
 		/// - `attributes`: Generates a list of attributes for the new NFT.
 		///
 		#[pallet::weight(10_000 + T::DbWeight::get().writes(4))]
 		pub fn spawn(
 			origin: OriginFor<T>,
 			class_id: CollectionId,
-			numeric_value: Option<Permill>,
 			parent_info: Option<HierarchicalInfo>,
 			attributes: Option<Vec<(BoundedVec<u8, T::KeyLimit>, BoundedVec<u8, T::ValueLimit>)>>,
 		) -> DispatchResult {
@@ -250,7 +248,6 @@ pub mod pallet {
 				class_id,
 				instance_id,
 				account_id,
-				numeric_value,
 				attributes,
 			)?;
 
@@ -273,7 +270,7 @@ pub mod pallet {
 					collection_id: class_id,
 					child_id: instance_id,
 					is_hierarchical: parent_info.1,
-					weight: numeric_value.unwrap()
+					weight: Self::percent_to_permill(parent_info.2),
 				};
 
 				<FruniqueChild<T>>::insert(class_id, instance_id, Some(child_info));

pallets/fruniques/src/tests.rs

@@ -1,4 +1,6 @@
 use crate::{mock::*, Error};
+use core::convert::TryFrom;
+use codec::{Encode};
 
 use frame_support::{assert_noop, assert_ok, BoundedVec};
 use sp_runtime::Permill;
@@ -34,7 +36,18 @@ impl ExtBuilder {
 }
 
 fn dummy_description() -> BoundedVec<u8, StringLimit> {
-	bvec![b'a'; 10]
+	BoundedVec::<u8, StringLimit>::try_from(b"dummy description".to_vec()).unwrap()
+}
+
+fn dummy_attributes() -> Vec<(BoundedVec<u8, KeyLimit>, BoundedVec<u8, ValueLimit>)> {
+	vec![(
+			BoundedVec::<u8, KeyLimit>::try_from(b"dummy key".encode()).expect("Error on encoding key to BoundedVec"),
+			BoundedVec::<u8, ValueLimit>::try_from(b"dummy value".encode()).expect("Error on encoding value to BoundedVec"),
+		)]
+}
+
+fn dummy_value() -> Permill {
+	Permill::from_percent(50)
 }
 
 #[test]
@@ -47,10 +60,17 @@ fn create_collection_works() {
 #[test]
 fn spawn_extrinsic_works() {
 	ExtBuilder::default().build().execute_with(|| {
-		assert_noop!(Fruniques::spawn(Origin::signed(1), 0, None, None, None), Error::<Test>::CollectionNotFound);
+		// A collection must be created before spawning an NFT
+		assert_noop!(Fruniques::spawn(Origin::signed(1), 0, None, None), Error::<Test>::CollectionNotFound);
 
 		assert_ok!(Fruniques::create_collection(Origin::signed(1), Some(dummy_description())));
-		assert_ok!(Fruniques::spawn(Origin::signed(1), 0, None, None, None));
+		// A NFT can be created with empty data
+		assert_ok!(Fruniques::spawn(Origin::signed(1), 0, None, None));
+		// A NFT can be created with attributes
+		assert_ok!(Fruniques::spawn(Origin::signed(1), 0, None, Some(dummy_attributes())));
+		// A NFT can be hierarchical
+		assert_ok!(Fruniques::spawn(Origin::signed(1), 0, Some((0, false, 10)), None));
+
 	})
 }
 

pallets/fruniques/src/types.rs

@@ -16,7 +16,8 @@ pub type StringLimit<T> = BoundedVec<u8, <T as pallet_uniques::Config>::StringLi
 pub type CollectionId = u32;
 pub type ItemId = u32;
 
-pub type HierarchicalInfo = (ItemId, bool);
+// (ParentId, Heirarchical)
+pub type HierarchicalInfo = (ItemId, bool, u8);
 
 #[derive(CloneNoBound, Encode, Decode, RuntimeDebugNoBound, Default, TypeInfo, MaxEncodedLen)]
 pub struct ChildInfo {