Merge pull request #228 from hashed-io/develop

Release 121

Author: tlacloc

.gitignore

@@ -30,4 +30,5 @@ gcloud-md5-ingress.yml
 
 .secrets
 collator-data
-relay-data
+relay-data
+.vscode/settings.json

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
   "cSpell.words": [
-    "Frunique"
-    , "fruniques"
+    "Frunique",
+    "fruniques",
+    "Permill"
   ]
 }

pallets/bitcoin-vaults/src/tests.rs

@@ -87,7 +87,7 @@ fn inserting_same_xpub_should_fail() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_noop!(BitcoinVaults::set_xpub(Origin::signed(test_pub(2)), dummy_xpub()),Error::<Test>::XPubAlreadyTaken);
-		
+
 	});
 }
 
@@ -96,7 +96,7 @@ fn inserting_without_removing_xpub_should_fail() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_noop!(BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub_2()),Error::<Test>::UserAlreadyHasXpub);
-		
+
 	});
 }
 
@@ -123,7 +123,7 @@ fn removing_twice_should_not_work() {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_ok!(BitcoinVaults::remove_xpub(Origin::signed(test_pub(1))));
 		assert_noop!(BitcoinVaults::remove_xpub(Origin::signed(test_pub(1))), Error::<Test>::XPubNotFound);
-		
+
 	});
 }
 
@@ -132,7 +132,7 @@ fn creating_vault_should_work() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(2)), dummy_xpub_2()) );
-		
+
 		let cosigners = BoundedVec::<<Test as frame_system::Config>::AccountId, MaxCosignersPerVault>::
 		try_from([ test_pub(2),].to_vec()).unwrap();
 		assert_ok!(BitcoinVaults::create_vault( Origin::signed(test_pub(1)) , 2, dummy_description(),true, cosigners) );
@@ -186,7 +186,7 @@ fn vault_with_duplicate_members_shouldnt_work() {
 fn vault_with_duplicate_incomplete_members() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
-		
+
 		let cosigners = BoundedVec::<<Test as frame_system::Config>::AccountId, MaxCosignersPerVault>::
 			try_from([ test_pub(2),test_pub(1),].to_vec()).unwrap();
 		assert_noop!(BitcoinVaults::create_vault( Origin::signed(test_pub(1)) , 1, dummy_description(), true,
@@ -259,7 +259,7 @@ fn removing_vault_should_work() {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(2)), dummy_xpub_2()) );
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(3)), dummy_xpub_3()) );
-		
+
 		// Insert a normal vault
 		let cosigners = BoundedVec::<<Test as frame_system::Config>::AccountId, MaxCosignersPerVault>::
 		try_from([ test_pub(2),test_pub(3)].to_vec()).unwrap();
@@ -277,7 +277,7 @@ fn removing_vault_which_isnt_yours_shoulnt_work() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(2)), dummy_xpub_2()) );
-		
+
 		// Insert a normal vault
 		let cosigners = BoundedVec::<<Test as frame_system::Config>::AccountId, MaxCosignersPerVault>::
 		try_from([ test_pub(2),].to_vec()).unwrap();
@@ -295,7 +295,7 @@ fn removing_vault_and_xpub_in_order_should_work() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(2)), dummy_xpub_2()) );
-		
+
 		// Insert a normal vault
 		let cosigners = BoundedVec::<<Test as frame_system::Config>::AccountId, MaxCosignersPerVault>::
 		try_from([ test_pub(2),].to_vec()).unwrap();
@@ -315,7 +315,7 @@ fn removing_xpub_before_vault_shouldnt_work() {
 	new_test_ext().execute_with(|| {
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(1)), dummy_xpub()) );
 		assert_ok!( BitcoinVaults::set_xpub(Origin::signed(test_pub(2)), dummy_xpub_2()) );
-		
+
 		// Insert a normal vault
 		let cosigners = BoundedVec::<<Test as frame_system::Config>::AccountId, MaxCosignersPerVault>::
 		try_from([ test_pub(2),].to_vec()).unwrap();
@@ -447,7 +447,7 @@ fn saving_psbt_form_external_user_shouldnt_work(){
 		assert_ok!(BitcoinVaults::propose(Origin::signed(test_pub(1)),vault_id,dummy_testnet_recipient_address(),1000,dummy_description()));
 		// obtaining proposal id and saving a psbt with a user that is not in the vault
 		let proposal_id = BitcoinVaults::proposals_by_vault(vault_id).pop().unwrap();
-		// user 3 is not on 
+		// user 3 is not on
 		assert_noop!(BitcoinVaults::save_psbt(Origin::signed(test_pub(3)), proposal_id, dummy_psbt()), Error::<Test>::SignerPermissionsNeeded);
 	});
 }
@@ -491,8 +491,8 @@ fn finalize_psbt_should_work(){
 		let proposal_id = BitcoinVaults::proposals_by_vault(vault_id).pop().unwrap();
 		make_proposal_valid(proposal_id);
 
-		assert_ok!(BitcoinVaults::save_psbt(Origin::signed(test_pub(1)), proposal_id, dummy_psbt()) );
-		assert_ok!(BitcoinVaults::finalize_psbt(Origin::signed(test_pub(1)), proposal_id,false));
+		assert_ok!(BitcoinVaults::save_psbt(Origin::signed(test_pub(1)), proposal_id, dummy_psbt()));
+		// When a proposal meets the threshold changes it status to ReadyToFinalize false
 		assert!(BitcoinVaults::proposals(proposal_id).unwrap().status.eq(&ProposalStatus::ReadyToFinalize(false)));
 	});
 }
@@ -515,7 +515,7 @@ fn finalize_psbt_twice_shouldnt_work(){
 		make_proposal_valid(proposal_id);
 
 		assert_ok!(BitcoinVaults::save_psbt(Origin::signed(test_pub(1)), proposal_id, dummy_psbt()) );
-		assert_ok!(BitcoinVaults::finalize_psbt(Origin::signed(test_pub(1)), proposal_id,false));
+		// When a proposal meets the threshold changes it status to ReadyToFinalize false
 		assert!(BitcoinVaults::proposals(proposal_id).unwrap().status.eq(&ProposalStatus::ReadyToFinalize(false)));
 		assert_noop!(BitcoinVaults::finalize_psbt(Origin::signed(test_pub(1)), proposal_id,false), Error::<Test>::PendingProposalRequired);
 	});
@@ -540,4 +540,4 @@ fn finalize_psbt_without_signatures_shouldnt_work(){
 
 		assert_noop!(BitcoinVaults::finalize_psbt(Origin::signed(test_pub(1)), proposal_id,false), Error::<Test>::NotEnoughSignatures);
 	});
-}
+}

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

@@ -21,7 +21,6 @@ pub mod pallet {
 	use frame_support::{pallet_prelude::*, transactional, BoundedVec};
 	use frame_system::pallet_prelude::*;
 	use scale_info::prelude::vec::Vec;
-	use sp_runtime::Permill;
 	/// Configure the pallet by specifying the parameters and types on which it depends.
 	#[pallet::config]
 	pub trait Config: frame_system::Config + pallet_uniques::Config {
@@ -41,22 +40,25 @@ pub mod pallet {
 	#[pallet::event]
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
 	pub enum Event<T: Config> {
-		// A frunique and asset class were succesfully created!
+		// A frunique and asset class were successfully created!
 		FruniqueCollectionCreated(T::AccountId, T::CollectionId),
-		// A frunique and asset class were succesfully created!
+		// A frunique and asset class were successfully created!
 		FruniqueCreated(T::AccountId, T::AccountId, T::CollectionId, T::ItemId),
-		// A frunique/unique was succesfully divided!
+		// A frunique/unique was successfully divided!
 		FruniqueDivided(T::AccountId, T::AccountId, T::CollectionId, T::ItemId),
 		// Counter should work?
 		NextFrunique(u32),
 	}
 
 	#[pallet::error]
 	pub enum Error<T> {
-		NoneValue,
+		// The user does not have permission to perform this action
 		NoPermission,
+		// Only the owner of the Frunique can perform this action
 		NotAdmin,
+		// The storage is full
 		StorageOverflow,
+		// A feature not implemented yet
 		NotYetImplemented,
 		// Too many fruniques were minted
 		FruniqueCntOverflow,
@@ -70,6 +72,10 @@ pub mod pallet {
 		AttributesEmpty,
 		// The collection doesn't exist
 		CollectionNotFound,
+		// The parent doesn't exist
+		ParentNotFound,
+		// The frunique doesn't exist
+		FruniqueNotFound,
 	}
 
 	#[pallet::storage]
@@ -118,7 +124,7 @@ pub mod pallet {
 		Blake2_128Concat,
 		CollectionId, // Parent collection id
 		Blake2_128Concat,
-		ItemId, // Parent item id
+		ItemId,            // Parent item id
 		Option<ChildInfo>, // ParentId and flag if it inherit attributes
 		ValueQuery,
 	>;
@@ -177,12 +183,12 @@ pub mod pallet {
 
 		/// ## Set multiple attributes to a frunique.
 		/// `origin` must be signed by the owner of the frunique.
+		/// - `class_id` must be a valid class of the asset class.
+		/// - `instance_id` must be a valid instance of the asset class.
 		/// - `attributes` must be a list of pairs of `key` and `value`.
 		/// `key` must be a valid key for the asset class.
 		/// `value` must be a valid value for the asset class.
 		/// `attributes` must not be empty.
-		/// - `instance_id` must be a valid instance of the asset class.
-		/// - `class_id` must be a valid class of the asset class.
 
 		#[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
 		pub fn set_attributes(
@@ -191,6 +197,8 @@ pub mod pallet {
 			instance_id: T::ItemId,
 			attributes: Vec<(BoundedVec<u8, T::KeyLimit>, BoundedVec<u8, T::ValueLimit>)>,
 		) -> DispatchResult {
+			ensure!(Self::item_exists(&class_id, &instance_id), <Error<T>>::FruniqueNotFound);
+
 			// ! Ensure the admin is the one who can add attributes to the frunique.
 			let admin = Self::admin_of(&class_id, &instance_id);
 			let signer = core::prelude::v1::Some(ensure_signed(origin.clone())?);
@@ -223,32 +231,43 @@ 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 {
+			ensure!(Self::collection_exists(&class_id), <Error<T>>::CollectionNotFound);
+
+			if let Some(parent_info) = parent_info {
+				ensure!(Self::item_exists(&class_id, &parent_info.0), <Error<T>>::ParentNotFound);
+			}
+
 			let owner: T::AccountId = ensure_signed(origin.clone())?;
 			let account_id = Self::account_id_to_lookup_source(&owner);
 
 			let instance_id: ItemId = <NextFrunique<T>>::try_get(class_id).unwrap_or(0);
 			<NextFrunique<T>>::insert(class_id, instance_id + 1);
 
-			Self::do_spawn(
-				origin.clone(),
-				class_id,
-				instance_id,
-				account_id,
-				numeric_value,
-				attributes,
-			)?;
+			if let Some(parent_info) = parent_info {
+				ensure!(Self::item_exists(&class_id, &parent_info.0), <Error<T>>::ParentNotFound);
+				<FruniqueParent<T>>::insert(class_id, instance_id, Some(parent_info));
+
+				let child_info = ChildInfo {
+					collection_id: class_id,
+					child_id: instance_id,
+					is_hierarchical: parent_info.1,
+					weight: Self::percent_to_permill(parent_info.2),
+				};
+
+				<FruniqueChild<T>>::insert(class_id, instance_id, Some(child_info));
+			}
+
+			Self::do_spawn(origin.clone(), class_id, instance_id, account_id, attributes)?;
 
 			Self::deposit_event(Event::FruniqueCreated(
 				owner.clone(),
@@ -257,22 +276,6 @@ pub mod pallet {
 				instance_id,
 			));
 
-
-			if let Some(parent_info) = parent_info {
-				ensure!(
-					Self::item_exists(&class_id, &parent_info.0),
-					<Error<T>>::CollectionNotFound
-				);
-				<FruniqueParent<T>>::insert(class_id, instance_id, Some(parent_info));
-
-				// let child_info = ChildInfo {
-				// 	collection_id: class_id,
-				// 	child_id: instance_id,
-				// 	is_hierarchical: parent_info.1,
-				// 	weight: numeric_value.unwrap()
-				// }
-			}
-
 			Ok(())
 		}
 
@@ -293,6 +296,9 @@ pub mod pallet {
 			let _ = <FruniqueCnt<T>>::put(0);
 			let _ = <NextCollection<T>>::put(0);
 			let _ = <NextFrunique<T>>::clear(1000, None);
+			let _ = <FruniqueParent<T>>::clear(1000, None);
+			let _ = <FruniqueChild<T>>::clear(1000, None);
+
 			Ok(())
 		}
 	}