git.delta.rocks / unique-network / refs/commits / 0e74039449d0

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//! # RMRK Core Proxy Pallet18//!19//! A pallet used as proxy for RMRK Core (<https://rmrk-team.github.io/rmrk-substrate/#/pallets/rmrk-core>).20//!21//! - [`Config`]22//! - [`Call`]23//! - [`Pallet`]24//!25//! ## Overview26//!27//! The RMRK Equip Proxy pallet mirrors the functionality of RMRK Equip,28//! binding its externalities to Unique's own underlying structure.29//! It is purposed to mimic RMRK Equip exactly, allowing seamless integrations30//! of solutions based on RMRK.31//!32//! RMRK Equip itself contains functionality to equip NFTs, and work with Bases,33//! Parts, and Themes.34//!35//! Equip Proxy is responsible for a more specific area of RMRK, and heavily relies on the Core.36//! For a more foundational description of proxy implementation, please refer to [`pallet_rmrk_core`].37//!38//! *Note*, that while RMRK itself is subject to active development and restructuring,39//! the proxy may be caught temporarily out of date.40//!41//! ### What is RMRK?42//!43//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives.44//! Putting these legos together allows a user to create NFT systems of arbitrary complexity.45//!46//! Meaning, RMRK NFTs are dynamic, able to nest into each other and form a hierarchy,47//! make use of specific changeable and partially shared metadata in the form of resources,48//! and more.49//!50//! Visit RMRK documentation and repositories to learn more:51//! - Docs: <https://docs.rmrk.app/getting-started/>52//! - FAQ: <https://coda.io/@rmrk/faq>53//! - Substrate code repository: <https://github.com/rmrk-team/rmrk-substrate>54//! - RMRK spec repository: <https://github.com/rmrk-team/rmrk-spec>55//!56//! ## Proxy Implementation57//!58//! An external user is supposed to be able to utilize this proxy as they would59//! utilize RMRK, and get exactly the same results. Normally, Unique transactions60//! are off-limits to RMRK collections and tokens, and vice versa. However,61//! the information stored on chain can be freely interpreted by storage reads and RPCs.62//!63//! ### ID Mapping64//!65//! RMRK's collections' IDs are counted independently of Unique's and start at 0.66//! Note that tokens' IDs still start at 1.67//! The collections themselves, as well as tokens, are stored as Unique collections,68//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).69//!70//! ### External/Internal Collection Insulation71//!72//! A Unique transaction cannot target collections purposed for RMRK,73//! and they are flagged as `external` to specify that. On the other hand,74//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.75//!76//! ### Native Properties77//!78//! Many of RMRK's native parameters are stored as scoped properties of a collection79//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`80//! is an unacceptable symbol in user-defined proeprties, which, along with other safeguards,81//! makes them impossible to tamper with.82//!83//! ### Collection and NFT Types84//!85//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,86//! possible components of an NFT. Due to its similarity with the functionality87//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes88//! are the collection's NFTs. See [`CollectionType`](pallet_rmrk_core::misc::CollectionType) and89//! [`NftType`](pallet_rmrk_core::misc::NftType).90//!91//! ## Interface92//!93//! ### Dispatchables94//!95//! - `create_base` - Create a new Base.96//! - `theme_add` - Add a Theme to a Base.97//! - `equippable` - Update the array of Collections allowed to be equipped to a Base's specified Slot Part.9899#![cfg_attr(not(feature = "std"), no_std)]100101use frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};102use frame_system::{pallet_prelude::*, ensure_signed};103use sp_runtime::DispatchError;104use up_data_structs::*;105use pallet_common::{Pallet as PalletCommon, Error as CommonError};106use pallet_rmrk_core::{107	Pallet as PalletCore, Error as CoreError,108	misc::{self, *},109	property::RmrkProperty::*,110};111use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle};112use pallet_evm::account::CrossAccountId;113use weights::WeightInfo;114115pub use pallet::*;116117#[cfg(feature = "runtime-benchmarks")]118pub mod benchmarking;119pub mod rpc;120pub mod weights;121122pub type SelfWeightOf<T> = <T as Config>::WeightInfo;123124#[frame_support::pallet]125pub mod pallet {126	use super::*;127128	#[pallet::config]129	pub trait Config: frame_system::Config + pallet_rmrk_core::Config {130		/// Overarching event type.131		type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;132133		/// The weight information of this pallet.134		type WeightInfo: WeightInfo;135	}136137	/// Map of a base ID and a part ID to an NFT in the base collection serving as the part.138	#[pallet::storage]139	#[pallet::getter(fn internal_part_id)]140	pub type InernalPartId<T: Config> =141		StorageDoubleMap<_, Twox64Concat, CollectionId, Twox64Concat, RmrkPartId, TokenId>;142143	/// Checkmark that a base has a Theme NFT named "default".144	#[pallet::storage]145	#[pallet::getter(fn base_has_default_theme)]146	pub type BaseHasDefaultTheme<T: Config> =147		StorageMap<_, Twox64Concat, CollectionId, bool, ValueQuery>;148149	#[pallet::pallet]150	#[pallet::generate_store(pub(super) trait Store)]151	pub struct Pallet<T>(_);152153	#[pallet::event]154	#[pallet::generate_deposit(pub(super) fn deposit_event)]155	pub enum Event<T: Config> {156		BaseCreated {157			issuer: T::AccountId,158			base_id: RmrkBaseId,159		},160		EquippablesUpdated {161			base_id: RmrkBaseId,162			slot_id: RmrkSlotId,163		},164	}165166	#[pallet::error]167	pub enum Error<T> {168		/// No permission to perform action.169		PermissionError,170		/// Could not find an ID for a base collection. It is likely there were too many collections created on the chain.171		NoAvailableBaseId,172		/// Could not find a suitable ID for a part, likely too many part tokens were created in the base.173		NoAvailablePartId,174		/// Base collection linked to this ID does not exist.175		BaseDoesntExist,176		/// No theme named "default" is associated with the Base.177		NeedsDefaultThemeFirst,178		/// Part linked to this ID does not exist.179		PartDoesntExist,180		/// Cannot assign equippables to a fixed part.181		NoEquippableOnFixedPart,182	}183184	#[pallet::call]185	impl<T: Config> Pallet<T> {186		/// Create a new Base.187		///188		/// Modeled after the [base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)189		///190		/// # Permissions191		/// - Anyone - will be assigned as the issuer of the base.192		///193		/// # Arguments:194		/// - `base_type`: Arbitrary media type, e.g. "svg".195		/// - `symbol`: Arbitrary client-chosen symbol.196		/// - `parts`: Array of Fixed and Slot parts composing the base,197		/// confined in length by [`RmrkPartsLimit`](up_data_structs::RmrkPartsLimit).198		#[transactional]199		#[pallet::weight(<SelfWeightOf<T>>::create_base(parts.len() as u32))]200		pub fn create_base(201			origin: OriginFor<T>,202			base_type: RmrkString,203			symbol: RmrkBaseSymbol,204			parts: BoundedVec<RmrkPartType, RmrkPartsLimit>,205		) -> DispatchResult {206			let sender = ensure_signed(origin)?;207			let cross_sender = T::CrossAccountId::from_sub(sender.clone());208209			let data = CreateCollectionData {210				limits: None,211				token_prefix: symbol212					.into_inner()213					.try_into()214					.map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,215				..Default::default()216			};217218			let collection_id_res =219				<PalletNft<T>>::init_collection(cross_sender.clone(), data, true);220221			if let Err(DispatchError::Arithmetic(_)) = &collection_id_res {222				return Err(<Error<T>>::NoAvailableBaseId.into());223			}224225			let collection_id = collection_id_res?;226227			<PalletCommon<T>>::set_scoped_collection_properties(228				collection_id,229				PropertyScope::Rmrk,230				[231					<PalletCore<T>>::encode_rmrk_property(232						CollectionType,233						&misc::CollectionType::Base,234					)?,235					<PalletCore<T>>::encode_rmrk_property(BaseType, &base_type)?,236				]237				.into_iter(),238			)?;239240			let collection = <PalletCore<T>>::get_nft_collection(collection_id)?;241242			for part in parts {243				Self::create_part(&cross_sender, &collection, part)?;244			}245246			Self::deposit_event(Event::BaseCreated {247				issuer: sender,248				base_id: collection_id.0,249			});250251			Ok(())252		}253254		/// Add a Theme to a Base.255		/// A Theme named "default" is required prior to adding other Themes.256		///257		/// Modeled after [themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md).258		///259		/// # Permissions:260		/// - Base issuer261		///262		/// # Arguments:263		/// - `base_id`: Base ID containing the Theme to be updated.264		/// - `theme`: Theme to add to the Base.  A Theme has a name and properties, which are an265		///   array of [key, value, inherit].266		///   - `key`: Arbitrary BoundedString, defined by client.267		///   - `value`: Arbitrary BoundedString, defined by client.268		///   - `inherit`: Optional bool.269		#[transactional]270		#[pallet::weight(<SelfWeightOf<T>>::theme_add(theme.properties.len() as u32))]271		pub fn theme_add(272			origin: OriginFor<T>,273			base_id: RmrkBaseId,274			theme: RmrkBoundedTheme,275		) -> DispatchResult {276			let sender = ensure_signed(origin)?;277278			let sender = T::CrossAccountId::from_sub(sender);279			let owner = &sender;280281			let collection_id: CollectionId = base_id.into();282283			let collection = Self::get_base(collection_id)?;284285			if theme.name.as_slice() == b"default" {286				<BaseHasDefaultTheme<T>>::insert(collection_id, true);287			} else if !Self::base_has_default_theme(collection_id) {288				return Err(<Error<T>>::NeedsDefaultThemeFirst.into());289			}290291			let token_id = <PalletCore<T>>::create_nft(292				&sender,293				owner,294				&collection,295				[296					<PalletCore<T>>::encode_rmrk_property(TokenType, &NftType::Theme)?,297					<PalletCore<T>>::encode_rmrk_property(ThemeName, &theme.name)?,298					<PalletCore<T>>::encode_rmrk_property(ThemeInherit, &theme.inherit)?,299				]300				.into_iter(),301			)302			.map_err(|_| <Error<T>>::PermissionError)?;303304			for property in theme.properties {305				<PalletNft<T>>::set_scoped_token_property(306					collection_id,307					token_id,308					PropertyScope::Rmrk,309					<PalletCore<T>>::encode_rmrk_property(310						UserProperty(property.key.as_slice()),311						&property.value,312					)?,313				)?;314			}315316			Ok(())317		}318319		/// Update the array of Collections allowed to be equipped to a Base's specified Slot Part.320		///321		/// Modeled after [equippable interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equippable.md).322		///323		/// # Permissions:324		/// - Base issuer325		///326		/// # Arguments:327		/// - `base_id`: Base containing the Slot Part to be updated.328		/// - `part_id`: Slot Part whose Equippable List is being updated.329		/// - `equippables`: List of equippables that will override the current Equippables list.330		#[transactional]331		#[pallet::weight(<SelfWeightOf<T>>::equippable())]332		pub fn equippable(333			origin: OriginFor<T>,334			base_id: RmrkBaseId,335			slot_id: RmrkSlotId,336			equippables: RmrkEquippableList,337		) -> DispatchResult {338			let sender = ensure_signed(origin)?;339340			let base_collection_id = base_id.into();341			let collection = Self::get_base(base_collection_id)?;342343			<PalletCore<T>>::check_collection_owner(344				&collection,345				&T::CrossAccountId::from_sub(sender),346			)347			.map_err(|err| {348				if err == <CoreError<T>>::NoPermission.into() {349					<Error<T>>::PermissionError.into()350				} else {351					err352				}353			})?;354355			let part_id = Self::internal_part_id(base_collection_id, slot_id)356				.ok_or(<Error<T>>::PartDoesntExist)?;357358			let nft_type = <PalletCore<T>>::get_nft_type(base_collection_id, part_id)359				.map_err(|_| <Error<T>>::PartDoesntExist)?;360361			match nft_type {362				NftType::Regular | NftType::Theme => return Err(<Error<T>>::PermissionError.into()),363				NftType::FixedPart => return Err(<Error<T>>::NoEquippableOnFixedPart.into()),364				NftType::SlotPart => {365					<PalletNft<T>>::set_scoped_token_property(366						base_collection_id,367						part_id,368						PropertyScope::Rmrk,369						<PalletCore<T>>::encode_rmrk_property(EquippableList, &equippables)?,370					)?;371				}372			}373374			Self::deposit_event(Event::EquippablesUpdated { base_id, slot_id });375376			Ok(())377		}378	}379}380381impl<T: Config> Pallet<T> {382	/// Create or renew an NFT serving as a part, setting its properties383	/// to those of the part.384	fn create_part(385		sender: &T::CrossAccountId,386		collection: &NonfungibleHandle<T>,387		part: RmrkPartType,388	) -> DispatchResult {389		let owner = sender;390391		let part_id = part.id();392		let src = part.src();393		let z_index = part.z_index();394395		let nft_type = match part {396			RmrkPartType::FixedPart(_) => NftType::FixedPart,397			RmrkPartType::SlotPart(_) => NftType::SlotPart,398		};399400		let token_id = match Self::internal_part_id(collection.id, part_id) {401			Some(token_id) => token_id,402			None => {403				let token_id =404					<PalletCore<T>>::create_nft(sender, owner, collection, [].into_iter())405						.map_err(|err| match err {406							DispatchError::Arithmetic(_) => <Error<T>>::NoAvailablePartId.into(),407							err => err,408						})?;409410				<InernalPartId<T>>::insert(collection.id, part_id, token_id);411412				<PalletNft<T>>::set_scoped_token_property(413					collection.id,414					token_id,415					PropertyScope::Rmrk,416					<PalletCore<T>>::encode_rmrk_property(ExternalPartId, &part_id)?,417				)?;418419				token_id420			}421		};422423		<PalletNft<T>>::set_scoped_token_properties(424			collection.id,425			token_id,426			PropertyScope::Rmrk,427			[428				<PalletCore<T>>::encode_rmrk_property(TokenType, &nft_type)?,429				<PalletCore<T>>::encode_rmrk_property(Src, &src)?,430				<PalletCore<T>>::encode_rmrk_property(ZIndex, &z_index)?,431			]432			.into_iter(),433		)?;434435		if let RmrkPartType::SlotPart(part) = part {436			<PalletNft<T>>::set_scoped_token_property(437				collection.id,438				token_id,439				PropertyScope::Rmrk,440				<PalletCore<T>>::encode_rmrk_property(EquippableList, &part.equippable)?,441			)?;442		}443444		Ok(())445	}446447	/// Ensure that the collection under the base ID is a base collection,448	/// and fetch it.449	fn get_base(base_id: CollectionId) -> Result<NonfungibleHandle<T>, DispatchError> {450		let collection =451			<PalletCore<T>>::get_typed_nft_collection(base_id, misc::CollectionType::Base)452				.map_err(|err| {453					if err == <CoreError<T>>::CollectionUnknown.into() {454						<Error<T>>::BaseDoesntExist.into()455					} else {456						err457					}458				})?;459		collection.check_is_external()?;460461		Ok(collection)462	}463}