git.delta.rocks / unique-network / refs/commits / 3e410d6948a5

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#![cfg_attr(not(feature = "std"), no_std)]1819use frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};20use frame_system::{pallet_prelude::*, ensure_signed};21use sp_runtime::DispatchError;22use up_data_structs::*;23use pallet_common::{Pallet as PalletCommon, Error as CommonError};24use pallet_rmrk_core::{25	Pallet as PalletCore,26	Error as CoreError,27	misc::{self, *},28	property::RmrkProperty::*,29};30use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle};31use pallet_evm::account::CrossAccountId;32use weights::WeightInfo;3334pub use pallet::*;3536#[cfg(feature = "runtime-benchmarks")]37pub mod benchmarking;38pub mod rpc;39pub mod weights;4041pub type SelfWeightOf<T> = <T as Config>::WeightInfo;4243#[frame_support::pallet]44pub mod pallet {45	use super::*;4647	#[pallet::config]48	pub trait Config: frame_system::Config + pallet_rmrk_core::Config {49		type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;50		type WeightInfo: WeightInfo;51	}5253	#[pallet::storage]54	#[pallet::getter(fn internal_part_id)]55	pub type InernalPartId<T: Config> =56		StorageDoubleMap<_, Twox64Concat, CollectionId, Twox64Concat, RmrkPartId, TokenId>;5758	#[pallet::storage]59	#[pallet::getter(fn base_has_default_theme)]60	pub type BaseHasDefaultTheme<T: Config> =61		StorageMap<_, Twox64Concat, CollectionId, bool, ValueQuery>;6263	#[pallet::pallet]64	#[pallet::generate_store(pub(super) trait Store)]65	pub struct Pallet<T>(_);6667	#[pallet::event]68	#[pallet::generate_deposit(pub(super) fn deposit_event)]69	pub enum Event<T: Config> {70		BaseCreated {71			issuer: T::AccountId,72			base_id: RmrkBaseId,73		},74		EquippablesUpdated {75			base_id: RmrkBaseId,76			slot_id: RmrkSlotId,77		},78	}7980	#[pallet::error]81	pub enum Error<T> {82		PermissionError,83		NoAvailableBaseId,84		NoAvailablePartId,85		BaseDoesntExist,86		NeedsDefaultThemeFirst,87		PartDoesntExist,88		NoEquippableOnFixedPart,89	}9091	#[pallet::call]92	impl<T: Config> Pallet<T> {93		/// Creates a new Base.94		/// Modeled after [base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)95		///96		/// Parameters:97		/// - origin: Caller, will be assigned as the issuer of the Base98		/// - base_type: media type, e.g. "svg"99		/// - symbol: arbitrary client-chosen symbol100		/// - parts: array of Fixed and Slot parts composing the base, confined in length by101		///   RmrkPartsLimit102		#[transactional]103		#[pallet::weight(<SelfWeightOf<T>>::create_base(parts.len() as u32))]104		pub fn create_base(105			origin: OriginFor<T>,106			base_type: RmrkString,107			symbol: RmrkBaseSymbol,108			parts: BoundedVec<RmrkPartType, RmrkPartsLimit>,109		) -> DispatchResult {110			let sender = ensure_signed(origin)?;111			let cross_sender = T::CrossAccountId::from_sub(sender.clone());112113			let data = CreateCollectionData {114				limits: None,115				token_prefix: symbol116					.into_inner()117					.try_into()118					.map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,119				..Default::default()120			};121122			let collection_id_res =123				<PalletNft<T>>::init_collection(cross_sender.clone(), data, true);124125			if let Err(DispatchError::Arithmetic(_)) = &collection_id_res {126				return Err(<Error<T>>::NoAvailableBaseId.into());127			}128129			let collection_id = collection_id_res?;130131			<PalletCommon<T>>::set_scoped_collection_properties(132				collection_id,133				PropertyScope::Rmrk,134				[135					<PalletCore<T>>::rmrk_property(CollectionType, &misc::CollectionType::Base)?,136					<PalletCore<T>>::rmrk_property(BaseType, &base_type)?,137				]138				.into_iter(),139			)?;140141			let collection = <PalletCore<T>>::get_nft_collection(collection_id)?;142143			for part in parts {144				Self::create_part(&cross_sender, &collection, part)?;145			}146147			Self::deposit_event(Event::BaseCreated {148				issuer: sender,149				base_id: collection_id.0,150			});151152			Ok(())153		}154155		/// Adds a Theme to a Base.156		/// Modeled after [themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md)157		/// Themes are stored in the Themes storage158		/// A Theme named "default" is required prior to adding other Themes.159		///160		/// Parameters:161		/// - origin: The caller of the function, must be issuer of the base162		/// - base_id: The Base containing the Theme to be updated163		/// - theme: The Theme to add to the Base.  A Theme has a name and properties, which are an164		///   array of [key, value, inherit].165		///   - key: arbitrary BoundedString, defined by client166		///   - value: arbitrary BoundedString, defined by client167		///   - inherit: optional bool168		#[transactional]169		#[pallet::weight(<SelfWeightOf<T>>::theme_add(theme.properties.len() as u32))]170		pub fn theme_add(171			origin: OriginFor<T>,172			base_id: RmrkBaseId,173			theme: RmrkBoundedTheme,174		) -> DispatchResult {175			let sender = ensure_signed(origin)?;176177			let sender = T::CrossAccountId::from_sub(sender);178			let owner = &sender;179180			let collection_id: CollectionId = base_id.into();181182			let collection = Self::get_base(collection_id)?;183184			if theme.name.as_slice() == b"default" {185				<BaseHasDefaultTheme<T>>::insert(collection_id, true);186			} else if !Self::base_has_default_theme(collection_id) {187				return Err(<Error<T>>::NeedsDefaultThemeFirst.into());188			}189190			let token_id = <PalletCore<T>>::create_nft(191				&sender,192				owner,193				&collection,194				[195					<PalletCore<T>>::rmrk_property(TokenType, &NftType::Theme)?,196					<PalletCore<T>>::rmrk_property(ThemeName, &theme.name)?,197					<PalletCore<T>>::rmrk_property(ThemeInherit, &theme.inherit)?,198				]199				.into_iter(),200			)201			.map_err(|_| <Error<T>>::PermissionError)?;202203			for property in theme.properties {204				<PalletNft<T>>::set_scoped_token_property(205					collection_id,206					token_id,207					PropertyScope::Rmrk,208					<PalletCore<T>>::rmrk_property(209						UserProperty(property.key.as_slice()),210						&property.value,211					)?,212				)?;213			}214215			Ok(())216		}217218		#[transactional]219		#[pallet::weight(<SelfWeightOf<T>>::equippable())]220		pub fn equippable(221			origin: OriginFor<T>,222			base_id: RmrkBaseId,223			slot_id: RmrkSlotId,224			equippables: RmrkEquippableList,225		) -> DispatchResult {226			let sender = ensure_signed(origin)?;227228			let base_collection_id = base_id.into();229			let collection = Self::get_base(base_collection_id)?;230231			<PalletCore<T>>::check_collection_owner(&collection, &T::CrossAccountId::from_sub(sender))232				.map_err(|err| if err == <CoreError<T>>::NoPermission.into() {233					<Error<T>>::PermissionError.into()234				} else {235					err236				})?;237238			let part_id = Self::internal_part_id(base_collection_id, slot_id)239				.ok_or(<Error<T>>::PartDoesntExist)?;240241			let nft_type = <PalletCore<T>>::get_nft_type(base_collection_id, part_id)242				.map_err(|_| <Error<T>>::PartDoesntExist)?;243244			match nft_type {245				NftType::Regular | NftType::Theme => return Err(<Error<T>>::PermissionError.into()),246				NftType::FixedPart => return Err(<Error<T>>::NoEquippableOnFixedPart.into()),247				NftType::SlotPart => {248					<PalletNft<T>>::set_scoped_token_property(249						base_collection_id,250						part_id,251						PropertyScope::Rmrk,252						<PalletCore<T>>::rmrk_property(EquippableList, &equippables)?,253					)?;254				}255			}256257			Self::deposit_event(Event::EquippablesUpdated {258				base_id,259				slot_id,260			});261262			Ok(())263		}264	}265}266267impl<T: Config> Pallet<T> {268	fn create_part(269		sender: &T::CrossAccountId,270		collection: &NonfungibleHandle<T>,271		part: RmrkPartType,272	) -> DispatchResult {273		let owner = sender;274275		let part_id = part.id();276		let src = part.src();277		let z_index = part.z_index();278279		let nft_type = match part {280			RmrkPartType::FixedPart(_) => NftType::FixedPart,281			RmrkPartType::SlotPart(_) => NftType::SlotPart,282		};283284		let token_id = match Self::internal_part_id(collection.id, part_id) {285			Some(token_id) => token_id,286			None => {287				let token_id = <PalletCore<T>>::create_nft(288					sender,289					owner,290					collection,291					[].into_iter(),292				)293				.map_err(|err| match err {294					DispatchError::Arithmetic(_) => <Error<T>>::NoAvailablePartId.into(),295					err => err,296				})?;297298				<InernalPartId<T>>::insert(collection.id, part_id, token_id);299300				<PalletNft<T>>::set_scoped_token_property(301					collection.id,302					token_id,303					PropertyScope::Rmrk,304					<PalletCore<T>>::rmrk_property(ExternalPartId, &part_id)?,305				)?;306307				token_id308			}309		};310311		<PalletNft<T>>::set_scoped_token_properties(312			collection.id,313			token_id,314			PropertyScope::Rmrk,315			[316				<PalletCore<T>>::rmrk_property(TokenType, &nft_type)?,317				<PalletCore<T>>::rmrk_property(Src, &src)?,318				<PalletCore<T>>::rmrk_property(ZIndex, &z_index)?,319			]320			.into_iter()321		)?;322323		if let RmrkPartType::SlotPart(part) = part {324			<PalletNft<T>>::set_scoped_token_property(325				collection.id,326				token_id,327				PropertyScope::Rmrk,328				<PalletCore<T>>::rmrk_property(EquippableList, &part.equippable)?329			)?;330		}331332		Ok(())333	}334335	fn get_base(base_id: CollectionId) -> Result<NonfungibleHandle<T>, DispatchError> {336		let collection = <PalletCore<T>>::get_typed_nft_collection(base_id, misc::CollectionType::Base)337			.map_err(|err| if err == <CoreError<T>>::CollectionUnknown.into() {338				<Error<T>>::BaseDoesntExist.into()339			} else {340				err341			})?;342		collection.check_is_external()?;343344		Ok(collection)345	}346}