git.delta.rocks / unique-network / refs/commits / 05c459d3caac

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Structure Pallet18//!19//! The Structure pallet provides functionality for handling tokens nesting an unnesting.20//!21//! - [`Config`]22//! - [`Pallet`]23//!24//! ## Overview25//!26//! The Structure pallet provides functions for:27//!28//! - Searching for token parents, children and owners. Actual implementation of searching for29//!   parent/child is done by pallets corresponding to token's collection type.30//! - Nesting and unnesting tokens. Actual implementation of nesting is done by pallets corresponding31//!   to token's collection type.32//!33//! ### Terminology34//!35//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting36//!   owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in37//!   it's child token i.e. parent-child relationship graph shouldn't have38//!39//! - **Parent:** Token that current token is nested in.40//!41//! - **Owner:** Account that owns the token and all nested tokens.42//!43//! ## Interface44//!45//! ### Available Functions46//!47//! - `find_parent` - Find parent of the token. It could be an account or another token.48//! - `parent_chain` - Find chain of parents of the token.49//! - `find_topmost_owner` - Find account or token in the end of the chain of parents.50//! - `check_nesting` - Check if the token could be nested in the other token51//! - `nest_if_sent_to_token` - Nest the token in the other token52//! - `unnest_if_nested` - Unnest the token from the other token5354#![cfg_attr(not(feature = "std"), no_std)]5556use pallet_common::CommonCollectionOperations;57use pallet_common::{erc::CrossAccountId, eth::is_collection};58use sp_std::collections::btree_set::BTreeSet;5960use frame_support::dispatch::{DispatchError, DispatchResult, DispatchResultWithPostInfo};61use frame_support::fail;62pub use pallet::*;63use pallet_common::{dispatch::CollectionDispatch, CollectionHandle};64use up_data_structs::{65	CollectionId, TokenId, mapping::TokenAddressMapping, budget::Budget, TokenOwnerError,66};6768#[cfg(feature = "runtime-benchmarks")]69pub mod benchmarking;70pub mod weights;7172pub type SelfWeightOf<T> = <T as crate::Config>::WeightInfo;7374#[frame_support::pallet]75pub mod pallet {76	use frame_support::Parameter;77	use frame_support::dispatch::{GetDispatchInfo, UnfilteredDispatchable};78	use frame_support::pallet_prelude::*;7980	use super::*;8182	#[pallet::error]83	pub enum Error<T> {84		/// While nesting, encountered an already checked account, detecting a loop.85		OuroborosDetected,86		/// While nesting, reached the depth limit of nesting, exceeding the provided budget.87		DepthLimit,88		/// While nesting, reached the breadth limit of nesting, exceeding the provided budget.89		BreadthLimit,90		/// Couldn't find the token owner that is itself a token.91		TokenNotFound,92		/// Tried to nest token under collection contract address, instead of token address93		CantNestTokenUnderCollection,94	}9596	#[pallet::event]97	pub enum Event<T> {98		/// Executed call on behalf of the token.99		Executed(DispatchResult),100	}101102	#[pallet::config]103	pub trait Config: frame_system::Config + pallet_common::Config {104		type WeightInfo: weights::WeightInfo;105		type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;106		type RuntimeCall: Parameter107			+ UnfilteredDispatchable<RuntimeOrigin = Self::RuntimeOrigin>108			+ GetDispatchInfo;109	}110111	#[pallet::pallet]112	pub struct Pallet<T>(_);113114	#[pallet::call]115	impl<T: Config> Pallet<T> {116		// #[pallet::weight({117		// 	let dispatch_info = call.get_dispatch_info();118119		// 	(120		// 		dispatch_info.weight121		// 			// Cost of dereferencing parent122		// 			.saturating_add(T::DbWeight::get().reads(2 * *max_depth as Weight))123		// 			.saturating_add(4000 * *max_depth as Weight),124		// 		dispatch_info.class)125		// })]126		// pub fn execute(127		// 	origin: OriginFor<T>,128		// 	call: Box<<T as Config>::Call>,129		// 	max_depth: u32,130		// ) -> DispatchResult {131	}132}133134#[derive(PartialEq)]135pub enum Parent<CrossAccountId> {136	/// Token owned by a normal account.137	User(CrossAccountId),138	/// Could not find the token provided as the owner.139	TokenNotFound,140	/// Nested token has multiple owners.141	MultipleOwners,142	/// Token owner is another token (still, the target token may not exist).143	Token(CollectionId, TokenId),144}145146impl<T: Config> Pallet<T> {147	/// Find account owning the `token` or a token that the `token` is nested in.148	///149	/// Returns the enum that have three variants:150	/// - [`User`](crate::Parent<T>::User): Contains account.151	/// - [`Token`](crate::Parent<T>::Token): Contains token id and collection id.152	/// - [`TokenNotFound`](crate::Parent<T>::TokenNotFound): Indicates that parent was not found153	pub fn find_parent(154		collection: CollectionId,155		token: TokenId,156	) -> Result<Parent<T::CrossAccountId>, DispatchError> {157		// TODO: Reduce cost by not reading collection config158		let handle = match CollectionHandle::try_get(collection) {159			Ok(v) => v,160			Err(_) => return Ok(Parent::TokenNotFound),161		};162		let handle = T::CollectionDispatch::dispatch(handle);163		let handle = handle.as_dyn();164165		Ok(match handle.token_owner(token) {166			Ok(owner) => match T::CrossTokenAddressMapping::address_to_token(&owner) {167				Some((collection, token)) => Parent::Token(collection, token),168				None => Parent::User(owner),169			},170			Err(TokenOwnerError::MultipleOwners) => Parent::MultipleOwners,171			Err(TokenOwnerError::NotFound) => Parent::TokenNotFound,172		})173	}174175	/// Get the chain of parents of a token in the nesting hierarchy176	///177	/// Returns an iterator of addresses of the owning tokens and the owning account,178	/// starting from the immediate parent token, ending with the account.179	/// Returns error if cycle is detected.180	pub fn parent_chain(181		mut collection: CollectionId,182		mut token: TokenId,183	) -> impl Iterator<Item = Result<Parent<T::CrossAccountId>, DispatchError>> {184		let mut finished = false;185		let mut visited = BTreeSet::new();186		visited.insert((collection, token));187		core::iter::from_fn(move || {188			if finished {189				return None;190			}191			let parent = Self::find_parent(collection, token);192			match parent {193				Ok(Parent::Token(new_collection, new_token)) => {194					collection = new_collection;195					token = new_token;196					if !visited.insert((new_collection, new_token)) {197						finished = true;198						return Some(Err(<Error<T>>::OuroborosDetected.into()));199					}200				}201				_ => finished = true,202			}203			Some(parent as Result<_, DispatchError>)204		})205	}206207	/// Try to dereference address, until finding top level owner208	///209	/// May return token address if parent token not yet exists210	///211	/// Returns `None` if the token has multiple owners.212	///213	/// - `budget`: Limit for searching parents in depth.214	pub fn find_topmost_owner(215		collection: CollectionId,216		token: TokenId,217		budget: &dyn Budget,218	) -> Result<Option<T::CrossAccountId>, DispatchError> {219		let owner = Self::parent_chain(collection, token)220			.take_while(|_| budget.consume())221			.find(|p| {222				matches!(223					p,224					Ok(Parent::User(_) | Parent::TokenNotFound | Parent::MultipleOwners)225				)226			})227			.ok_or(<Error<T>>::DepthLimit)??;228229		Ok(match owner {230			Parent::User(v) => Some(v),231			Parent::MultipleOwners => None,232			_ => fail!(<Error<T>>::TokenNotFound),233		})234	}235236	/// Find the topmost parent and check that assigning `for_nest` token as a child for237	/// `token` wouldn't create a cycle.238	///239	/// Returns `None` if the token has multiple owners.240	///241	/// - `budget`: Limit for searching parents in depth.242	pub fn get_checked_topmost_owner(243		collection: CollectionId,244		token: TokenId,245		for_nest: Option<(CollectionId, TokenId)>,246		budget: &dyn Budget,247	) -> Result<Option<T::CrossAccountId>, DispatchError> {248		// Tried to nest token in itself249		if Some((collection, token)) == for_nest {250			return Err(<Error<T>>::OuroborosDetected.into());251		}252253		for parent in Self::parent_chain(collection, token).take_while(|_| budget.consume()) {254			match parent? {255				// Tried to nest token in chain, which has this token as one of parents256				Parent::Token(collection, token) if Some((collection, token)) == for_nest => {257					return Err(<Error<T>>::OuroborosDetected.into())258				}259				// Token is owned by other user260				Parent::User(user) => return Ok(Some(user)),261				Parent::TokenNotFound => return Err(<Error<T>>::TokenNotFound.into()),262				Parent::MultipleOwners => return Ok(None),263				// Continue parent chain264				Parent::Token(_, _) => {}265			}266		}267268		Err(<Error<T>>::DepthLimit.into())269	}270271	/// Burn token and all of it's nested tokens272	///273	/// - `self_budget`: Limit for searching children in depth.274	/// - `breadth_budget`: Limit of breadth of searching children.275	pub fn burn_item_recursively(276		from: T::CrossAccountId,277		collection: CollectionId,278		token: TokenId,279		self_budget: &dyn Budget,280		breadth_budget: &dyn Budget,281	) -> DispatchResultWithPostInfo {282		let handle = <CollectionHandle<T>>::try_get(collection)?;283		let dispatch = T::CollectionDispatch::dispatch(handle);284		let dispatch = dispatch.as_dyn();285		dispatch.burn_item_recursively(from.clone(), token, self_budget, breadth_budget)286	}287288	/// Check if `token` indirectly owned by `user`289	///290	/// Returns `true` if `user` is `token`'s owner. Or If token is provided as `user` then291	/// check that `user` and `token` have same owner.292	/// Checks that assigning `for_nest` token as a child for `token` wouldn't create a cycle.293	///294	/// - `budget`: Limit for searching parents in depth.295	pub fn check_indirectly_owned(296		user: T::CrossAccountId,297		collection: CollectionId,298		token: TokenId,299		for_nest: Option<(CollectionId, TokenId)>,300		budget: &dyn Budget,301	) -> Result<bool, DispatchError> {302		let target_parent = match T::CrossTokenAddressMapping::address_to_token(&user) {303			Some((collection, token)) => match Self::find_topmost_owner(collection, token, budget)?304			{305				Some(topmost_owner) => topmost_owner,306				None => return Ok(false),307			},308			None => user,309		};310311		Self::get_checked_topmost_owner(collection, token, for_nest, budget).map(|indirect_owner| {312			indirect_owner.map_or(false, |indirect_owner| indirect_owner == target_parent)313		})314	}315316	/// Checks that `under` is valid token and that `token_id` could be nested under it317	/// and that `from` is `under`'s owner318	///319	/// Returns OK if `under` is not a token320	///321	/// - `nesting_budget`: Limit for searching parents in depth.322	pub fn check_nesting(323		from: T::CrossAccountId,324		under: &T::CrossAccountId,325		collection_id: CollectionId,326		token_id: TokenId,327		nesting_budget: &dyn Budget,328	) -> DispatchResult {329		Self::try_exec_if_token(under, |collection, parent_id| {330			collection.check_nesting(from, (collection_id, token_id), parent_id, nesting_budget)331		})332	}333334	/// Nests `token_id` under `under` token335	///336	/// Returns OK if `under` is not a token. Checks that nesting is possible.337	///338	/// - `nesting_budget`: Limit for searching parents in depth.339	pub fn nest_if_sent_to_token(340		from: T::CrossAccountId,341		under: &T::CrossAccountId,342		collection_id: CollectionId,343		token_id: TokenId,344		nesting_budget: &dyn Budget,345	) -> DispatchResult {346		Self::try_exec_if_token(under, |collection, parent_id| {347			collection.check_nesting(from, (collection_id, token_id), parent_id, nesting_budget)?;348349			collection.nest(parent_id, (collection_id, token_id));350351			Ok(())352		})353	}354355	/// Nests `token_id` under `owner` token356	///357	/// Caller should check that nesting wouldn't cause recursion in nesting358	pub fn nest_if_sent_to_token_unchecked(359		owner: &T::CrossAccountId,360		collection_id: CollectionId,361		token_id: TokenId,362	) {363		Self::exec_if_token(owner, |collection, parent_id| {364			collection.nest(parent_id, (collection_id, token_id))365		});366	}367368	/// Unnests `token_id` from `owner`.369	pub fn unnest_if_nested(370		owner: &T::CrossAccountId,371		collection_id: CollectionId,372		token_id: TokenId,373	) {374		if let Err(e) = Self::try_exec_if_token(owner, |collection, parent_id| {375			collection.unnest(parent_id, (collection_id, token_id));376			Ok(())377		}) {378			log::warn!("unnest precondition failed: {e:?}")379		}380	}381382	/// # Panics383	/// If [`Self::try_exec_if_token`] fails384	fn exec_if_token(385		account: &T::CrossAccountId,386		action: impl FnOnce(&dyn CommonCollectionOperations<T>, TokenId),387	) {388		Self::try_exec_if_token(account, |collection, id| {389			action(collection, id);390			Ok(())391		})392		.unwrap();393	}394395	/// If `account` is a token address, execute `action` providing found collection as an argument396	/// Token may not exist, it is expected it will be checked in the callback.397	fn try_exec_if_token(398		account: &T::CrossAccountId,399		action: impl FnOnce(&dyn CommonCollectionOperations<T>, TokenId) -> DispatchResult,400	) -> DispatchResult {401		if is_collection(&account.as_eth()) {402			fail!(<Error<T>>::CantNestTokenUnderCollection);403		}404		let Some((collection, token)) = T::CrossTokenAddressMapping::address_to_token(account) else {405			return Ok(())406		};407408		let handle = <CollectionHandle<T>>::try_get(collection)?;409410		let dispatch = T::CollectionDispatch::dispatch(handle);411		let dispatch = dispatch.as_dyn();412413		action(dispatch, token)414	}415}