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. See [Proxy Implementation](#proxy-implementation) for details.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//! ## Terminology57//!58//! For more information on RMRK, see RMRK's own documentation.59//!60//! ### Intro to RMRK61//!62//! - **Resource:** Additional piece of metadata of an NFT usually serving to add63//! a piece of media on top of the root metadata (NFT's own), be it a different wing64//! on the root template bird or something entirely unrelated.65//!66//! - **Base:** A list of possible "components" - Parts, a combination of which can67//! be appended/equipped to/on an NFT.68//!69//! - **Part:** Something that, together with other Parts, can constitute an NFT.70//! Parts are defined in the Base to which they belong. Parts can be either71//! of the `slot` type or `fixed` type. Slots are intended for equippables.72//! Note that "part of something" and "Part of a Base" can be easily confused,73//! and so in this documentation these words are distinguished by the capital letter.74//!75//! - **Theme:** Named objects of variable => value pairs which get interpolated into76//! the Base's `themable` Parts. Themes can hold any value, but are often represented77//! in RMRK's examples as colors applied to visible Parts.78//!79//! ### Peculiarities in Unique80//!81//! - **Scoped properties:** Properties that are normally obscured from users.82//! Their purpose is to contain structured metadata that was not included in the Unique standard83//! for collections and tokens, meant to be operated on by proxies and other outliers.84//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is85//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined86//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.87//!88//! - **Auxiliary properties:** A slightly different structure of properties,89//! trading universality of use for more convenient storage, writes and access.90//! Meant to be inaccessible to end users.91//!92//! ## Proxy Implementation93//!94//! An external user is supposed to be able to utilize this proxy as they would95//! utilize RMRK, and get exactly the same results. Normally, Unique transactions96//! are off-limits to RMRK collections and tokens, and vice versa. However,97//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.98//!99//! ### ID Mapping100//!101//! RMRK's collections' IDs are counted independently of Unique's and start at 0.102//! Note that tokens' IDs still start at 1.103//! The collections themselves, as well as tokens, are stored as Unique collections,104//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).105//!106//! ### External/Internal Collection Insulation107//!108//! A Unique transaction cannot target collections purposed for RMRK,109//! and they are flagged as `external` to specify that. On the other hand,110//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.111//!112//! ### Native Properties113//!114//! Many of RMRK's native parameters are stored as scoped properties of a collection115//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`116//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,117//! makes them impossible to tamper with.118//!119//! ### Collection and NFT Types, or Base, Parts and Themes Handling120//!121//! RMRK introduces the concept of a Base, which is a catalogue of Parts,122//! possible components of an NFT. Due to its similarity with the functionality123//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes124//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].125//!126//! ## Interface127//!128//! ### Dispatchables129//!130//! - `create_base` - Create a new Base.131//! - `theme_add` - Add a Theme to a Base.132//! - `equippable` - Update the array of Collections allowed to be equipped to a Base's specified Slot Part.133134#![cfg_attr(not(feature = "std"), no_std)]135136use frame_support::{pallet_prelude::*, BoundedVec, dispatch::DispatchResult};137use frame_system::{pallet_prelude::*, ensure_signed};138use sp_runtime::DispatchError;139use up_data_structs::*;140use pallet_common::{Pallet as PalletCommon, Error as CommonError};141use pallet_rmrk_core::{142 Pallet as PalletCore, Error as CoreError,143 misc::{self, *},144 property::RmrkProperty::*,145};146use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle};147use pallet_evm::account::CrossAccountId;148use weights::WeightInfo;149150pub use pallet::*;151152#[cfg(feature = "runtime-benchmarks")]153pub mod benchmarking;154pub mod rpc;155pub mod weights;156157pub type SelfWeightOf<T> = <T as Config>::WeightInfo;158159#[frame_support::pallet]160pub mod pallet {161 use super::*;162163 #[pallet::config]164 pub trait Config: frame_system::Config + pallet_rmrk_core::Config {165 /// Overarching event type.166 type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;167168 /// The weight information of this pallet.169 type WeightInfo: WeightInfo;170 }171172 /// Map of a Base ID and a Part ID to an NFT in the Base collection serving as the Part.173 #[pallet::storage]174 #[pallet::getter(fn internal_part_id)]175 pub type InernalPartId<T: Config> =176 StorageDoubleMap<_, Twox64Concat, CollectionId, Twox64Concat, RmrkPartId, TokenId>;177178 /// Checkmark that a Base has a Theme NFT named "default".179 #[pallet::storage]180 #[pallet::getter(fn base_has_default_theme)]181 pub type BaseHasDefaultTheme<T: Config> =182 StorageMap<_, Twox64Concat, CollectionId, bool, ValueQuery>;183184 #[pallet::pallet]185 #[pallet::generate_store(pub(super) trait Store)]186 pub struct Pallet<T>(_);187188 #[pallet::event]189 #[pallet::generate_deposit(pub(super) fn deposit_event)]190 pub enum Event<T: Config> {191 BaseCreated {192 issuer: T::AccountId,193 base_id: RmrkBaseId,194 },195 EquippablesUpdated {196 base_id: RmrkBaseId,197 slot_id: RmrkSlotId,198 },199 }200201 #[pallet::error]202 pub enum Error<T> {203 /// No permission to perform action.204 PermissionError,205 /// Could not find an ID for a Base collection. It is likely there were too many collections created on the chain, causing an overflow.206 NoAvailableBaseId,207 /// Could not find a suitable ID for a Part, likely too many Part tokens were created in the Base, causing an overflow208 NoAvailablePartId,209 /// Base collection linked to this ID does not exist.210 BaseDoesntExist,211 /// No Theme named "default" is associated with the Base.212 NeedsDefaultThemeFirst,213 /// Part linked to this ID does not exist.214 PartDoesntExist,215 /// Cannot assign equippables to a fixed Part.216 NoEquippableOnFixedPart,217 }218219 #[pallet::call]220 impl<T: Config> Pallet<T> {221 /// Create a new Base.222 ///223 /// Modeled after the [Base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)224 ///225 /// # Permissions226 /// - Anyone - will be assigned as the issuer of the Base.227 ///228 /// # Arguments:229 /// - `origin`: Caller, will be assigned as the issuer of the Base230 /// - `base_type`: Arbitrary media type, e.g. "svg".231 /// - `symbol`: Arbitrary client-chosen symbol.232 /// - `parts`: Array of Fixed and Slot Parts composing the Base,233 /// confined in length by [`RmrkPartsLimit`](up_data_structs::RmrkPartsLimit).234 #[pallet::call_index(0)]235 #[pallet::weight(<SelfWeightOf<T>>::create_base(parts.len() as u32))]236 pub fn create_base(237 origin: OriginFor<T>,238 base_type: RmrkString,239 symbol: RmrkBaseSymbol,240 parts: BoundedVec<RmrkPartType, RmrkPartsLimit>,241 ) -> DispatchResult {242 let sender = ensure_signed(origin)?;243 let cross_sender = T::CrossAccountId::from_sub(sender.clone());244245 let data = CreateCollectionData {246 limits: None,247 token_prefix: symbol248 .into_inner()249 .try_into()250 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,251 ..Default::default()252 };253254 let collection_id_res = <PalletNft<T>>::init_collection(255 cross_sender.clone(),256 cross_sender.clone(),257 data,258 up_data_structs::CollectionFlags {259 external: true,260 ..Default::default()261 },262 );263264 if let Err(DispatchError::Arithmetic(_)) = &collection_id_res {265 return Err(<Error<T>>::NoAvailableBaseId.into());266 }267268 let collection_id = collection_id_res?;269270 <PalletCommon<T>>::set_scoped_collection_properties(271 collection_id,272 PropertyScope::Rmrk,273 [274 <PalletCore<T>>::encode_rmrk_property(275 CollectionType,276 &misc::CollectionType::Base,277 )?,278 <PalletCore<T>>::encode_rmrk_property(BaseType, &base_type)?,279 ]280 .into_iter(),281 )?;282283 let collection = <PalletCore<T>>::get_nft_collection(collection_id)?;284285 for part in parts {286 Self::create_part(&cross_sender, &collection, part)?;287 }288289 Self::deposit_event(Event::BaseCreated {290 issuer: sender,291 base_id: collection_id.0,292 });293294 Ok(())295 }296297 /// Add a Theme to a Base.298 /// A Theme named "default" is required prior to adding other Themes.299 ///300 /// Modeled after [Themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md).301 ///302 /// # Permissions:303 /// - Base issuer304 ///305 /// # Arguments:306 /// - `origin`: sender of the transaction307 /// - `base_id`: Base ID containing the Theme to be updated.308 /// - `theme`: Theme to add to the Base. A Theme has a name and properties, which are an309 /// array of [key, value, inherit].310 /// - `key`: Arbitrary BoundedString, defined by client.311 /// - `value`: Arbitrary BoundedString, defined by client.312 /// - `inherit`: Optional bool.313 #[pallet::call_index(1)]314 #[pallet::weight(<SelfWeightOf<T>>::theme_add(theme.properties.len() as u32))]315 pub fn theme_add(316 origin: OriginFor<T>,317 base_id: RmrkBaseId,318 theme: RmrkBoundedTheme,319 ) -> DispatchResult {320 let sender = ensure_signed(origin)?;321322 let sender = T::CrossAccountId::from_sub(sender);323 let owner = &sender;324325 let collection_id: CollectionId = base_id.into();326327 let collection = Self::get_base(collection_id)?;328329 if theme.name.as_slice() == b"default" {330 <BaseHasDefaultTheme<T>>::insert(collection_id, true);331 } else if !Self::base_has_default_theme(collection_id) {332 return Err(<Error<T>>::NeedsDefaultThemeFirst.into());333 }334335 let token_id = <PalletCore<T>>::create_nft(336 &sender,337 owner,338 &collection,339 [340 <PalletCore<T>>::encode_rmrk_property(TokenType, &NftType::Theme)?,341 <PalletCore<T>>::encode_rmrk_property(ThemeName, &theme.name)?,342 <PalletCore<T>>::encode_rmrk_property(ThemeInherit, &theme.inherit)?,343 ]344 .into_iter(),345 )346 .map_err(|_| <Error<T>>::PermissionError)?;347348 for property in theme.properties {349 <PalletNft<T>>::set_scoped_token_property(350 collection_id,351 token_id,352 PropertyScope::Rmrk,353 <PalletCore<T>>::encode_rmrk_property(354 UserProperty(property.key.as_slice()),355 &property.value,356 )?,357 )?;358 }359360 Ok(())361 }362363 /// Update the array of Collections allowed to be equipped to a Base's specified Slot Part.364 ///365 /// Modeled after [equippable interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equippable.md).366 ///367 /// # Permissions:368 /// - Base issuer369 ///370 /// # Arguments:371 /// - `origin`: sender of the transaction372 /// - `base_id`: Base containing the Slot Part to be updated.373 /// - `slot_id`: Slot Part whose Equippable List is being updated .374 /// - `equippables`: List of equippables that will override the current Equippables list.375 #[pallet::call_index(2)]376 #[pallet::weight(<SelfWeightOf<T>>::equippable())]377 pub fn equippable(378 origin: OriginFor<T>,379 base_id: RmrkBaseId,380 slot_id: RmrkSlotId,381 equippables: RmrkEquippableList,382 ) -> DispatchResult {383 let sender = ensure_signed(origin)?;384385 let base_collection_id = base_id.into();386 let collection = Self::get_base(base_collection_id)?;387388 <PalletCore<T>>::check_collection_owner(389 &collection,390 &T::CrossAccountId::from_sub(sender),391 )392 .map_err(|err| {393 if err == <CoreError<T>>::NoPermission.into() {394 <Error<T>>::PermissionError.into()395 } else {396 err397 }398 })?;399400 let part_id = Self::internal_part_id(base_collection_id, slot_id)401 .ok_or(<Error<T>>::PartDoesntExist)?;402403 let nft_type = <PalletCore<T>>::get_nft_type(base_collection_id, part_id)404 .map_err(|_| <Error<T>>::PartDoesntExist)?;405406 match nft_type {407 NftType::Regular | NftType::Theme => return Err(<Error<T>>::PermissionError.into()),408 NftType::FixedPart => return Err(<Error<T>>::NoEquippableOnFixedPart.into()),409 NftType::SlotPart => {410 <PalletNft<T>>::set_scoped_token_property(411 base_collection_id,412 part_id,413 PropertyScope::Rmrk,414 <PalletCore<T>>::encode_rmrk_property(EquippableList, &equippables)?,415 )?;416 }417 }418419 Self::deposit_event(Event::EquippablesUpdated { base_id, slot_id });420421 Ok(())422 }423 }424}425426impl<T: Config> Pallet<T> {427 /// Create (or overwrite) a Part in a Base.428 /// The Part and the Base are represented as an NFT and a Collection.429 fn create_part(430 sender: &T::CrossAccountId,431 collection: &NonfungibleHandle<T>,432 part: RmrkPartType,433 ) -> DispatchResult {434 let owner = sender;435436 let part_id = part.id();437 let src = part.src();438 let z_index = part.z_index();439440 let nft_type = match part {441 RmrkPartType::FixedPart(_) => NftType::FixedPart,442 RmrkPartType::SlotPart(_) => NftType::SlotPart,443 };444445 let token_id = match Self::internal_part_id(collection.id, part_id) {446 Some(token_id) => token_id,447 None => {448 let token_id =449 <PalletCore<T>>::create_nft(sender, owner, collection, [].into_iter())450 .map_err(|err| match err {451 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailablePartId.into(),452 err => err,453 })?;454455 <InernalPartId<T>>::insert(collection.id, part_id, token_id);456457 <PalletNft<T>>::set_scoped_token_property(458 collection.id,459 token_id,460 PropertyScope::Rmrk,461 <PalletCore<T>>::encode_rmrk_property(ExternalPartId, &part_id)?,462 )?;463464 token_id465 }466 };467468 <PalletNft<T>>::set_scoped_token_properties(469 collection.id,470 token_id,471 PropertyScope::Rmrk,472 [473 <PalletCore<T>>::encode_rmrk_property(TokenType, &nft_type)?,474 <PalletCore<T>>::encode_rmrk_property(Src, &src)?,475 <PalletCore<T>>::encode_rmrk_property(ZIndex, &z_index)?,476 ]477 .into_iter(),478 )?;479480 if let RmrkPartType::SlotPart(part) = part {481 <PalletNft<T>>::set_scoped_token_property(482 collection.id,483 token_id,484 PropertyScope::Rmrk,485 <PalletCore<T>>::encode_rmrk_property(EquippableList, &part.equippable)?,486 )?;487 }488489 Ok(())490 }491492 /// Ensure that the collection under the Base ID is a Base collection,493 /// and fetch it.494 fn get_base(base_id: CollectionId) -> Result<NonfungibleHandle<T>, DispatchError> {495 let collection =496 <PalletCore<T>>::get_typed_nft_collection(base_id, misc::CollectionType::Base)497 .map_err(|err| {498 if err == <CoreError<T>>::CollectionUnknown.into() {499 <Error<T>>::BaseDoesntExist.into()500 } else {501 err502 }503 })?;504 collection.check_is_external()?;505506 Ok(collection)507 }508}difftreelog
source
pallets/proxy-rmrk-equip/src/lib.rs17.0 KiBsourcehistory