git.delta.rocks / unique-network / refs/commits / f2a945f52528

1//! Module with interfaces for dispatching collections.23use frame_support::{4	dispatch::{5		DispatchResultWithPostInfo, PostDispatchInfo, Weight, DispatchErrorWithPostInfo,6		DispatchResult,7	},8	dispatch::Pays,9	traits::Get,10};11use sp_runtime::DispatchError;12use up_data_structs::{CollectionId, CreateCollectionData, CollectionFlags};1314use crate::{pallet::Config, CommonCollectionOperations, CollectionHandle};1516// TODO: move to benchmarking17/// Price of [`dispatch_tx`] call with noop `call` argument18pub fn dispatch_weight<T: Config>() -> Weight {19	// Read collection20	<T as frame_system::Config>::DbWeight::get().reads(1)21	// Dynamic dispatch?22	+ Weight::from_ref_time(6_000_000)23	// submit_logs is measured as part of collection pallets24}2526/// Helper function to implement substrate calls for common collection methods.27///28/// * `collection` - The collection on which to call the method.29/// * `call` - The function in which to call the corresponding method from [`CommonCollectionOperations`].30pub fn dispatch_tx<31	T: Config,32	C: FnOnce(&dyn CommonCollectionOperations<T>) -> DispatchResultWithPostInfo,33>(34	collection: CollectionId,35	call: C,36) -> DispatchResultWithPostInfo {37	let handle =38		CollectionHandle::try_get(collection).map_err(|error| DispatchErrorWithPostInfo {39			post_info: PostDispatchInfo {40				actual_weight: Some(dispatch_weight::<T>()),41				pays_fee: Pays::Yes,42			},43			error,44		})?;45	handle46		.check_is_internal()47		.map_err(|error| DispatchErrorWithPostInfo {48			post_info: PostDispatchInfo {49				actual_weight: Some(dispatch_weight::<T>()),50				pays_fee: Pays::Yes,51			},52			error,53		})?;54	let dispatched = T::CollectionDispatch::dispatch(handle);55	let mut result = call(dispatched.as_dyn());56	match &mut result {57		Ok(PostDispatchInfo {58			actual_weight: Some(weight),59			..60		})61		| Err(DispatchErrorWithPostInfo {62			post_info: PostDispatchInfo {63				actual_weight: Some(weight),64				..65			},66			..67		}) => *weight += dispatch_weight::<T>(),68		_ => {}69	}70	result71}7273/// Interface for working with different collections through the dispatcher.74pub trait CollectionDispatch<T: Config> {75	/// Create a collection. The collection will be created according to the value of [`data.mode`](CreateCollectionData::mode).76	///77	/// * `sender` - The user who will become the owner of the collection.78	/// * `data` - Description of the created collection.79	fn create(80		sender: T::CrossAccountId,81		payer: T::CrossAccountId,82		data: CreateCollectionData<T::AccountId>,83		flags: CollectionFlags,84	) -> Result<CollectionId, DispatchError>;8586	/// Delete the collection.87	///88	/// * `sender` - The owner of the collection.89	/// * `handle` - Collection handle.90	fn destroy(sender: T::CrossAccountId, handle: CollectionHandle<T>) -> DispatchResult;9192	/// Get a specialized collection from the handle.93	///94	/// * `handle` - Collection handle.95	fn dispatch(handle: CollectionHandle<T>) -> Self;9697	/// Get the collection handle for the corresponding implementation.98	fn into_inner(self) -> CollectionHandle<T>;99100	/// Get the implementation of [`CommonCollectionOperations`].101	fn as_dyn(&self) -> &dyn CommonCollectionOperations<T>;102}