difftreelog
doc(rmrk): requested clarifications
in: master
3 files changed
pallets/proxy-rmrk-core/src/lib.rsdiffbeforeafterboth1// 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 Core Proxy pallet mirrors the functionality of RMRK Core,28//! binding its externalities to Unique's own underlying structure.29//! It is purposed to mimic RMRK Core exactly, allowing seamless integrations30//! of solutions based on RMRK.31//!32//! RMRK Core itself contains essential functionality for RMRK's nested and33//! multi-resourced NFTs.34//!35//! *Note*, that while RMRK itself is subject to active development and restructuring,36//! the proxy may be caught temporarily out of date.37//!38//! ### What is RMRK?39//!40//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives.41//! Putting these legos together allows a user to create NFT systems of arbitrary complexity.42//!43//! Meaning, RMRK NFTs are dynamic, able to nest into each other and form a hierarchy,44//! make use of specific changeable and partially shared metadata in the form of resources,45//! and more.46//!47//! Visit RMRK documentation and repositories to learn more:48//! - Docs: <https://docs.rmrk.app/getting-started/>49//! - FAQ: <https://coda.io/@rmrk/faq>50//! - Substrate code repository: <https://github.com/rmrk-team/rmrk-substrate>51//! - RMRK specification repository: <https://github.com/rmrk-team/rmrk-spec>52//!53//! ## Terminology54//!55//! For more information on RMRK, see RMRK's own documentation.56//!57//! ### Intro to RMRK58//!59//! - **Resource:** Additional piece of metadata of an NFT usually serving to add60//! a piece of media on top of the root metadata (NFT's own), be it a different wing61//! on the root template bird or something entirely unrelated.62//!63//! - **Base:** A list of possible "components" - Parts, a combination of which can64//! be appended/equipped to/on an NFT.65//!66//! - **Part:** Something that, together with other Parts, can constitute an NFT.67//! Parts are defined in the Base to which they belong. Parts can be either68//! of the `slot` type or `fixed` type. Slots are intended for equippables.69//! Note that "part of something" and "Part of a Base" can be easily confused,70//! and so in this documentation these words are distinguished by the capital letter.71//!72//! - **Theme:** Named objects of variable => value pairs which get interpolated into73//! the Base's `themable` Parts. Themes can hold any value, but are often represented74//! in RMRK's examples as colors applied to visible Parts.75//!76//! ### Peculiarities in Unique77//!78//! - **Scoped properties:** Properties that are normally obscured from users.79//! Their purpose is to contain structured metadata that was not included in the Unique standard80//! for collections and tokens, meant to be operated on by proxies and other outliers.81//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is82//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined83//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.84//!85//! - **Auxiliary properties:** A slightly different structure of properties,86//! trading universality of use for more convenient storage, writes and access.87//! Meant to be inaccessible to end users.88//!89//! ## Proxy Implementation90//!91//! An external user is supposed to be able to utilize this proxy as they would92//! utilize RMRK, and get exactly the same results. Normally, Unique transactions93//! are off-limits to RMRK collections and tokens, and vice versa. However,94//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.95//!96//! ### ID Mapping97//!98//! RMRK's collections' IDs are counted independently of Unique's and start at 0.99//! Note that tokens' IDs still start at 1.100//! The collections themselves, as well as tokens, are stored as Unique collections,101//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).102//!103//! ### External/Internal Collection Insulation104//!105//! A Unique transaction cannot target collections purposed for RMRK,106//! and they are flagged as `external` to specify that. On the other hand,107//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.108//!109//! ### Native Properties110//!111//! Many of RMRK's native parameters are stored as scoped properties of a collection112//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`113//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,114//! makes them impossible to tamper with.115//!116//! ### Collection and NFT Types, and Base, Parts and Themes Handling117//!118//! RMRK introduces the concept of a Base, which is a catalogue of Parts,119//! possible components of an NFT. Due to its similarity with the functionality120//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes121//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].122//!123//! ## Interface124//!125//! ### Dispatchables126//!127//! - `create_collection` - Create a new collection of NFTs.128//! - `destroy_collection` - Destroy a collection.129//! - `change_collection_issuer` - Change the issuer of a collection.130//! Analogous to Unique's collection's [`owner`](up_data_structs::Collection).131//! - `lock_collection` - "Lock" the collection and prevent new token creation. **Cannot be undone.**132//! - `mint_nft` - Mint an NFT in a specified collection.133//! - `burn_nft` - Burn an NFT, destroying it and its nested tokens.134//! - `send` - Transfer an NFT from an account/NFT A to another account/NFT B.135//! - `accept_nft` - Accept an NFT sent from another account to self or an owned NFT.136//! - `reject_nft` - Reject an NFT sent from another account to self or owned NFT and **burn it**.137//! - `accept_resource` - Accept the addition of a newly created pending resource to an existing NFT.138//! - `accept_resource_removal` - Accept the removal of a removal-pending resource from an NFT.139//! - `set_property` - Add or edit a custom user property of a token or a collection.140//! - `set_priority` - Set a different order of resource priorities for an NFT.141//! - `add_basic_resource` - Create and set/propose a basic resource for an NFT.142//! - `add_composable_resource` - Create and set/propose a composable resource for an NFT.143//! - `add_slot_resource` - Create and set/propose a slot resource for an NFT.144//! - `remove_resource` - Remove and erase a resource from an NFT.145146#![cfg_attr(not(feature = "std"), no_std)]147148use frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};149use frame_system::{pallet_prelude::*, ensure_signed};150use sp_runtime::{DispatchError, Permill, traits::StaticLookup};151use sp_std::{152 vec::Vec,153 collections::{btree_set::BTreeSet, btree_map::BTreeMap},154};155use up_data_structs::{*, mapping::TokenAddressMapping};156use pallet_common::{157 Pallet as PalletCommon, Error as CommonError, CollectionHandle, CommonCollectionOperations,158};159use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle, TokenData};160use pallet_structure::{Pallet as PalletStructure, Error as StructureError};161use pallet_evm::account::CrossAccountId;162use core::convert::AsRef;163164pub use pallet::*;165166#[cfg(feature = "runtime-benchmarks")]167pub mod benchmarking;168pub mod misc;169pub mod property;170pub mod rpc;171pub mod weights;172173pub type SelfWeightOf<T> = <T as Config>::WeightInfo;174175use weights::WeightInfo;176use misc::*;177pub use property::*;178179use RmrkProperty::*;180181/// Maximum number of levels of depth in the token nesting tree.182pub const NESTING_BUDGET: u32 = 5;183184type PendingTarget = (CollectionId, TokenId);185type PendingChild = (RmrkCollectionId, RmrkNftId);186type PendingChildrenSet = BTreeSet<PendingChild>;187188type BasesMap = BTreeMap<RmrkBaseId, u32>;189190#[frame_support::pallet]191pub mod pallet {192 use super::*;193 use pallet_evm::account;194195 #[pallet::config]196 pub trait Config:197 frame_system::Config + pallet_common::Config + pallet_nonfungible::Config + account::Config198 {199 /// Overarching event type.200 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;201202 /// The weight information of this pallet.203 type WeightInfo: WeightInfo;204 }205206 /// Latest yet-unused collection ID.207 #[pallet::storage]208 #[pallet::getter(fn collection_index)]209 pub type CollectionIndex<T: Config> = StorageValue<_, RmrkCollectionId, ValueQuery>;210211 /// Mapping from RMRK collection ID to Unique's.212 #[pallet::storage]213 pub type UniqueCollectionId<T: Config> =214 StorageMap<_, Twox64Concat, RmrkCollectionId, CollectionId, ValueQuery>;215216 #[pallet::pallet]217 #[pallet::generate_store(pub(super) trait Store)]218 pub struct Pallet<T>(_);219220 #[pallet::event]221 #[pallet::generate_deposit(pub(super) fn deposit_event)]222 pub enum Event<T: Config> {223 CollectionCreated {224 issuer: T::AccountId,225 collection_id: RmrkCollectionId,226 },227 CollectionDestroyed {228 issuer: T::AccountId,229 collection_id: RmrkCollectionId,230 },231 IssuerChanged {232 old_issuer: T::AccountId,233 new_issuer: T::AccountId,234 collection_id: RmrkCollectionId,235 },236 CollectionLocked {237 issuer: T::AccountId,238 collection_id: RmrkCollectionId,239 },240 NftMinted {241 owner: T::AccountId,242 collection_id: RmrkCollectionId,243 nft_id: RmrkNftId,244 },245 NFTBurned {246 owner: T::AccountId,247 nft_id: RmrkNftId,248 },249 NFTSent {250 sender: T::AccountId,251 recipient: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,252 collection_id: RmrkCollectionId,253 nft_id: RmrkNftId,254 approval_required: bool,255 },256 NFTAccepted {257 sender: T::AccountId,258 recipient: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,259 collection_id: RmrkCollectionId,260 nft_id: RmrkNftId,261 },262 NFTRejected {263 sender: T::AccountId,264 collection_id: RmrkCollectionId,265 nft_id: RmrkNftId,266 },267 PropertySet {268 collection_id: RmrkCollectionId,269 maybe_nft_id: Option<RmrkNftId>,270 key: RmrkKeyString,271 value: RmrkValueString,272 },273 ResourceAdded {274 nft_id: RmrkNftId,275 resource_id: RmrkResourceId,276 },277 ResourceRemoval {278 nft_id: RmrkNftId,279 resource_id: RmrkResourceId,280 },281 ResourceAccepted {282 nft_id: RmrkNftId,283 resource_id: RmrkResourceId,284 },285 ResourceRemovalAccepted {286 nft_id: RmrkNftId,287 resource_id: RmrkResourceId,288 },289 PrioritySet {290 collection_id: RmrkCollectionId,291 nft_id: RmrkNftId,292 },293 }294295 #[pallet::error]296 pub enum Error<T> {297 /* Unique proxy-specific events */298 /// Property of the type of RMRK collection could not be read successfully.299 CorruptedCollectionType,300 // NftTypeEncodeError,301 /// Too many symbols supplied as the property key. The maximum is [256](up_data_structs::MAX_PROPERTY_KEY_LENGTH).302 RmrkPropertyKeyIsTooLong,303 /// Too many bytes supplied as the property value. The maximum is [32768](up_data_structs::MAX_PROPERTY_VALUE_LENGTH).304 RmrkPropertyValueIsTooLong,305 /// Could not find a property by the supplied key.306 RmrkPropertyIsNotFound,307 /// Something went wrong when decoding encoded data from the storage.308 /// Perhaps, there was a wrong key supplied for the type, or the data was improperly stored.309 UnableToDecodeRmrkData,310311 /* RMRK compatible events */312 /// Only destroying collections without tokens is allowed.313 CollectionNotEmpty,314 /// Could not find an ID for a collection. It is likely there were too many collections created on the chain, causing an overflow.315 NoAvailableCollectionId,316 /// Token does not exist, or there is no suitable ID for it, likely too many tokens were created in a collection, causing an overflow.317 NoAvailableNftId,318 /// Collection does not exist, has a wrong type, or does not map to a Unique ID.319 CollectionUnknown,320 /// No permission to perform action.321 NoPermission,322 /// Token is marked as non-transferable, and thus cannot be transferred.323 NonTransferable,324 /// Too many tokens created in the collection, no new ones are allowed.325 CollectionFullOrLocked,326 /// No such resource found.327 ResourceDoesntExist,328 /// If an NFT is sent to a descendant, that would form a nesting loop, an ouroboros.329 /// Sending to self is redundant.330 CannotSendToDescendentOrSelf,331 /// Not the target owner of the sent NFT.332 CannotAcceptNonOwnedNft,333 /// Not the target owner of the sent NFT.334 CannotRejectNonOwnedNft,335 /// NFT was not sent and is not pending.336 CannotRejectNonPendingNft,337 /// Resource is not pending for the operation.338 ResourceNotPending,339 /// Could not find an ID for the resource. It is likely there were too many resources created on an NFT, causing an overflow.340 NoAvailableResourceId,341 }342343 #[pallet::call]344 impl<T: Config> Pallet<T> {345 // todo :refactor replace every collection_id with rmrk_collection_id (and nft_id) in arguments for uniformity?346347 /// Create a new collection of NFTs.348 ///349 /// # Permissions:350 /// * Anyone - will be assigned as the issuer of the collection.351 ///352 /// # Arguments:353 /// - `metadata`: Metadata describing the collection, e.g. IPFS hash. Cannot be changed.354 /// - `max`: Optional maximum number of tokens.355 /// - `symbol`: UTF-8 string with token prefix, by which to represent the token in wallets and UIs.356 /// Analogous to Unique's [`token_prefix`](up_data_structs::Collection). Cannot be changed.357 #[transactional]358 #[pallet::weight(<SelfWeightOf<T>>::create_collection())]359 pub fn create_collection(360 origin: OriginFor<T>,361 metadata: RmrkString,362 max: Option<u32>,363 symbol: RmrkCollectionSymbol,364 ) -> DispatchResult {365 let sender = ensure_signed(origin)?;366367 let limits = CollectionLimits {368 owner_can_transfer: Some(false),369 token_limit: max,370 ..Default::default()371 };372373 let data = CreateCollectionData {374 limits: Some(limits),375 token_prefix: symbol376 .into_inner()377 .try_into()378 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,379 permissions: Some(CollectionPermissions {380 nesting: Some(NestingPermissions {381 token_owner: true,382 collection_admin: false,383 restricted: None,384 #[cfg(feature = "runtime-benchmarks")]385 permissive: false,386 }),387 ..Default::default()388 }),389 ..Default::default()390 };391392 let unique_collection_id = Self::init_collection(393 T::CrossAccountId::from_sub(sender.clone()),394 data,395 [396 Self::encode_rmrk_property(Metadata, &metadata)?,397 Self::encode_rmrk_property(CollectionType, &misc::CollectionType::Regular)?,398 ]399 .into_iter(),400 )?;401 let rmrk_collection_id = <CollectionIndex<T>>::get();402403 <UniqueCollectionId<T>>::insert(rmrk_collection_id, unique_collection_id);404405 <PalletCommon<T>>::set_scoped_collection_property(406 unique_collection_id,407 RMRK_SCOPE,408 Self::encode_rmrk_property(RmrkInternalCollectionId, &rmrk_collection_id)?,409 )?;410411 <CollectionIndex<T>>::mutate(|n| *n += 1);412413 Self::deposit_event(Event::CollectionCreated {414 issuer: sender,415 collection_id: rmrk_collection_id,416 });417418 Ok(())419 }420421 /// Destroy a collection.422 ///423 /// Only empty collections can be destroyed. If it has any tokens, they must be burned first.424 ///425 /// # Permissions:426 /// * Collection issuer427 ///428 /// # Arguments:429 /// - `collection_id`: RMRK ID of the collection to destroy.430 #[transactional]431 #[pallet::weight(<SelfWeightOf<T>>::destroy_collection())]432 pub fn destroy_collection(433 origin: OriginFor<T>,434 collection_id: RmrkCollectionId,435 ) -> DispatchResult {436 let sender = ensure_signed(origin)?;437 let cross_sender = T::CrossAccountId::from_sub(sender.clone());438439 let collection = Self::get_typed_nft_collection(440 Self::unique_collection_id(collection_id)?,441 misc::CollectionType::Regular,442 )?;443 collection.check_is_external()?;444445 <PalletNft<T>>::destroy_collection(collection, &cross_sender)446 .map_err(Self::map_unique_err_to_proxy)?;447448 Self::deposit_event(Event::CollectionDestroyed {449 issuer: sender,450 collection_id,451 });452453 Ok(())454 }455456 /// Change the issuer of a collection. Analogous to Unique's collection's [`owner`](up_data_structs::Collection).457 ///458 /// # Permissions:459 /// * Collection issuer460 ///461 /// # Arguments:462 /// - `collection_id`: RMRK collection ID to change the issuer of.463 /// - `new_issuer`: Collection's new issuer.464 #[transactional]465 #[pallet::weight(<SelfWeightOf<T>>::change_collection_issuer())]466 pub fn change_collection_issuer(467 origin: OriginFor<T>,468 collection_id: RmrkCollectionId,469 new_issuer: <T::Lookup as StaticLookup>::Source,470 ) -> DispatchResult {471 let sender = ensure_signed(origin)?;472473 let collection = Self::get_nft_collection(Self::unique_collection_id(collection_id)?)?;474 collection.check_is_external()?;475476 let new_issuer = T::Lookup::lookup(new_issuer)?;477478 Self::change_collection_owner(479 Self::unique_collection_id(collection_id)?,480 misc::CollectionType::Regular,481 sender.clone(),482 new_issuer.clone(),483 )?;484485 Self::deposit_event(Event::IssuerChanged {486 old_issuer: sender,487 new_issuer,488 collection_id,489 });490491 Ok(())492 }493494 /// "Lock" the collection and prevent new token creation. Cannot be undone.495 ///496 /// # Permissions:497 /// * Collection issuer498 ///499 /// # Arguments:500 /// - `collection_id`: RMRK ID of the collection to lock.501 #[transactional]502 #[pallet::weight(<SelfWeightOf<T>>::lock_collection())]503 pub fn lock_collection(504 origin: OriginFor<T>,505 collection_id: RmrkCollectionId,506 ) -> DispatchResult {507 let sender = ensure_signed(origin)?;508 let cross_sender = T::CrossAccountId::from_sub(sender.clone());509510 let collection = Self::get_typed_nft_collection(511 Self::unique_collection_id(collection_id)?,512 misc::CollectionType::Regular,513 )?;514 collection.check_is_external()?;515516 Self::check_collection_owner(&collection, &cross_sender)?;517518 let token_count = collection.total_supply();519520 let mut collection = collection.into_inner();521 collection.limits.token_limit = Some(token_count);522 collection.save()?;523524 Self::deposit_event(Event::CollectionLocked {525 issuer: sender,526 collection_id,527 });528529 Ok(())530 }531532 /// Mint an NFT in a specified collection.533 ///534 /// # Permissions:535 /// * Collection issuer536 ///537 /// # Arguments:538 /// - `owner`: Owner account of the NFT. If set to None, defaults to the sender (collection issuer).539 /// - `collection_id`: RMRK collection ID for the NFT to be minted within. Cannot be changed.540 /// - `recipient`: Receiver account of the royalty. Has no effect if the `royalty_amount` is not set. Cannot be changed.541 /// - `royalty_amount`: Optional permillage reward from each trade for the `recipient`. Cannot be changed.542 /// - `metadata`: Arbitrary data about an NFT, e.g. IPFS hash. Cannot be changed.543 /// - `transferable`: Can this NFT be transferred? Cannot be changed.544 /// - `resources`: Resource data to be added to the NFT immediately after minting.545 #[transactional]546 #[pallet::weight(<SelfWeightOf<T>>::mint_nft(resources.as_ref().map(|r| r.len() as u32).unwrap_or(0)))]547 pub fn mint_nft(548 origin: OriginFor<T>,549 owner: Option<T::AccountId>,550 collection_id: RmrkCollectionId,551 recipient: Option<T::AccountId>,552 royalty_amount: Option<Permill>,553 metadata: RmrkString,554 transferable: bool,555 resources: Option<BoundedVec<RmrkResourceTypes, MaxResourcesOnMint>>,556 ) -> DispatchResult {557 let sender = ensure_signed(origin)?;558 let cross_sender = T::CrossAccountId::from_sub(sender.clone());559560 let owner = owner.unwrap_or(sender.clone());561 let cross_owner = T::CrossAccountId::from_sub(owner.clone());562563 let collection = Self::get_typed_nft_collection(564 Self::unique_collection_id(collection_id)?,565 misc::CollectionType::Regular,566 )?;567 collection.check_is_external()?;568569 let royalty_info = royalty_amount.map(|amount| rmrk_traits::RoyaltyInfo {570 recipient: recipient.unwrap_or_else(|| owner.clone()),571 amount,572 });573574 let nft_id = Self::create_nft(575 &cross_sender,576 &cross_owner,577 &collection,578 [579 Self::encode_rmrk_property(TokenType, &NftType::Regular)?,580 Self::encode_rmrk_property(Transferable, &transferable)?,581 Self::encode_rmrk_property(PendingNftAccept, &None::<PendingTarget>)?,582 Self::encode_rmrk_property(RoyaltyInfo, &royalty_info)?,583 Self::encode_rmrk_property(Metadata, &metadata)?,584 Self::encode_rmrk_property(Equipped, &false)?,585 Self::encode_rmrk_property(ResourcePriorities, &<Vec<u8>>::new())?,586 Self::encode_rmrk_property(NextResourceId, &(0 as RmrkResourceId))?,587 Self::encode_rmrk_property(PendingChildren, &PendingChildrenSet::new())?,588 Self::encode_rmrk_property(AssociatedBases, &BasesMap::new())?,589 ]590 .into_iter(),591 )592 .map_err(|err| match err {593 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailableNftId.into(),594 err => Self::map_unique_err_to_proxy(err),595 })?;596597 if let Some(resources) = resources {598 for resource in resources {599 Self::resource_add(sender.clone(), collection.id, nft_id, resource)?;600 }601 }602603 Self::deposit_event(Event::NftMinted {604 owner,605 collection_id,606 nft_id: nft_id.0,607 });608609 Ok(())610 }611612 /// Burn an NFT, destroying it and its nested tokens up to the specified limit.613 /// If the burning budget is exceeded, the transaction is reverted.614 ///615 /// This is the way to burn a nested token as well.616 ///617 /// For more information, see [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively).618 ///619 /// # Permissions:620 /// * Token owner621 ///622 /// # Arguments:623 /// - `collection_id`: RMRK ID of the collection in which the NFT to burn belongs to.624 /// - `nft_id`: ID of the NFT to be destroyed.625 /// - `max_burns`: Maximum number of tokens to burn, assuming nesting. The transaction626 /// is reverted if there are more tokens to burn in the nesting tree than this number.627 /// This is primarily a mechanism of transaction weight control.628 #[transactional]629 #[pallet::weight(<SelfWeightOf<T>>::burn_nft(*max_burns))]630 pub fn burn_nft(631 origin: OriginFor<T>,632 collection_id: RmrkCollectionId,633 nft_id: RmrkNftId,634 max_burns: u32,635 ) -> DispatchResult {636 let sender = ensure_signed(origin)?;637 let cross_sender = T::CrossAccountId::from_sub(sender.clone());638639 let collection = Self::get_typed_nft_collection(640 Self::unique_collection_id(collection_id)?,641 misc::CollectionType::Regular,642 )?;643 collection.check_is_external()?;644645 Self::destroy_nft(646 cross_sender,647 Self::unique_collection_id(collection_id)?,648 nft_id.into(),649 max_burns,650 <Error<T>>::NoPermission,651 )652 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;653654 Self::deposit_event(Event::NFTBurned {655 owner: sender,656 nft_id,657 });658659 Ok(())660 }661662 /// Transfer an NFT from an account/NFT A to another account/NFT B.663 /// The token must be transferable. Nesting cannot occur deeper than the [`NESTING_BUDGET`].664 ///665 /// If the target owner is an NFT owned by another account, then the NFT will enter666 /// the pending state and will have to be accepted by the other account.667 ///668 /// # Permissions:669 /// - Token owner670 ///671 /// # Arguments:672 /// - `collection_id`: RMRK ID of the collection of the NFT to be transferred.673 /// - `nft_id`: ID of the NFT to be transferred.674 /// - `new_owner`: New owner of the nft which can be either an account or a NFT.675 #[transactional]676 #[pallet::weight(<SelfWeightOf<T>>::send())]677 pub fn send(678 origin: OriginFor<T>,679 rmrk_collection_id: RmrkCollectionId,680 rmrk_nft_id: RmrkNftId,681 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,682 ) -> DispatchResult {683 let sender = ensure_signed(origin.clone())?;684 let cross_sender = T::CrossAccountId::from_sub(sender.clone());685686 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;687 let nft_id = rmrk_nft_id.into();688689 let collection =690 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;691 collection.check_is_external()?;692693 let token_data =694 <TokenData<T>>::get((collection_id, nft_id)).ok_or(<Error<T>>::NoAvailableNftId)?;695696 let from = token_data.owner;697698 ensure!(699 Self::get_nft_property_decoded(collection_id, nft_id, RmrkProperty::Transferable)?,700 <Error<T>>::NonTransferable701 );702703 ensure!(704 Self::get_nft_property_decoded::<Option<PendingTarget>>(705 collection_id,706 nft_id,707 RmrkProperty::PendingNftAccept708 )?709 .is_none(),710 <Error<T>>::NoPermission711 );712713 let target_owner;714 let approval_required;715716 match new_owner {717 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {718 target_owner = T::CrossAccountId::from_sub(account_id.clone());719 approval_required = false;720 }721 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(722 target_collection_id,723 target_nft_id,724 ) => {725 let target_collection_id = Self::unique_collection_id(target_collection_id)?;726727 let target_nft_budget = budget::Value::new(NESTING_BUDGET);728729 let target_nft_owner = <PalletStructure<T>>::get_checked_topmost_owner(730 target_collection_id,731 target_nft_id.into(),732 Some((collection_id, nft_id)),733 &target_nft_budget,734 )735 .map_err(Self::map_unique_err_to_proxy)?;736737 approval_required = cross_sender != target_nft_owner;738739 if approval_required {740 target_owner = target_nft_owner;741742 <PalletNft<T>>::set_scoped_token_property(743 collection.id,744 nft_id,745 RMRK_SCOPE,746 Self::encode_rmrk_property::<Option<PendingTarget>>(747 PendingNftAccept,748 &Some((target_collection_id, target_nft_id.into())),749 )?,750 )?;751752 Self::insert_pending_child(753 (target_collection_id, target_nft_id.into()),754 (rmrk_collection_id, rmrk_nft_id),755 )?;756 } else {757 target_owner = T::CrossTokenAddressMapping::token_to_address(758 target_collection_id,759 target_nft_id.into(),760 );761 }762 }763 }764765 let src_nft_budget = budget::Value::new(NESTING_BUDGET);766767 <PalletNft<T>>::transfer_from(768 &collection,769 &cross_sender,770 &from,771 &target_owner,772 nft_id,773 &src_nft_budget,774 )775 .map_err(Self::map_unique_err_to_proxy)?;776777 Self::deposit_event(Event::NFTSent {778 sender,779 recipient: new_owner,780 collection_id: rmrk_collection_id,781 nft_id: rmrk_nft_id,782 approval_required,783 });784785 Ok(())786 }787788 /// Accept an NFT sent from another account to self or an owned NFT.789 ///790 /// The NFT in question must be pending, and, thus, be [sent](`Pallet::send`) first.791 ///792 /// # Permissions:793 /// - Token-owner-to-be794 ///795 /// # Arguments:796 /// - `rmrk_collection_id`: RMRK collection ID of the NFT to be accepted.797 /// - `rmrk_nft_id`: ID of the NFT to be accepted.798 /// - `new_owner`: Either the sender's account ID or a sender-owned NFT,799 /// whichever the accepted NFT was sent to.800 #[transactional]801 #[pallet::weight(<SelfWeightOf<T>>::accept_nft())]802 pub fn accept_nft(803 origin: OriginFor<T>,804 rmrk_collection_id: RmrkCollectionId,805 rmrk_nft_id: RmrkNftId,806 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,807 ) -> DispatchResult {808 let sender = ensure_signed(origin.clone())?;809 let cross_sender = T::CrossAccountId::from_sub(sender.clone());810811 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;812 let nft_id = rmrk_nft_id.into();813814 let collection =815 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;816 collection.check_is_external()?;817818 let new_cross_owner = match new_owner {819 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {820 T::CrossAccountId::from_sub(account_id.clone())821 }822 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(823 target_collection_id,824 target_nft_id,825 ) => {826 let target_collection_id = Self::unique_collection_id(target_collection_id)?;827828 T::CrossTokenAddressMapping::token_to_address(829 target_collection_id,830 TokenId(target_nft_id),831 )832 }833 };834835 let budget = budget::Value::new(NESTING_BUDGET);836837 <PalletNft<T>>::transfer(838 &collection,839 &cross_sender,840 &new_cross_owner,841 nft_id,842 &budget,843 )844 .map_err(|err| {845 if err == <CommonError<T>>::UserIsNotAllowedToNest.into() {846 <Error<T>>::CannotAcceptNonOwnedNft.into()847 } else {848 Self::map_unique_err_to_proxy(err)849 }850 })?;851852 let pending_target = Self::get_nft_property_decoded::<Option<PendingTarget>>(853 collection_id,854 nft_id,855 RmrkProperty::PendingNftAccept,856 )?;857858 if let Some(pending_target) = pending_target {859 Self::remove_pending_child(pending_target, (rmrk_collection_id, rmrk_nft_id))?;860861 <PalletNft<T>>::set_scoped_token_property(862 collection.id,863 nft_id,864 RMRK_SCOPE,865 Self::encode_rmrk_property(PendingNftAccept, &None::<PendingTarget>)?,866 )?;867 }868869 Self::deposit_event(Event::NFTAccepted {870 sender,871 recipient: new_owner,872 collection_id: rmrk_collection_id,873 nft_id: rmrk_nft_id,874 });875876 Ok(())877 }878879 /// Reject an NFT sent from another account to self or owned NFT.880 /// The NFT in question will not be sent back and burnt instead.881 ///882 /// The NFT in question must be pending, and, thus, be [sent](`Pallet::send`) first.883 ///884 /// # Permissions:885 /// - Token-owner-to-be-not886 ///887 /// # Arguments:888 /// - `rmrk_collection_id`: RMRK ID of the NFT to be rejected.889 /// - `rmrk_nft_id`: ID of the NFT to be rejected.890 #[transactional]891 #[pallet::weight(<SelfWeightOf<T>>::reject_nft())]892 pub fn reject_nft(893 origin: OriginFor<T>,894 rmrk_collection_id: RmrkCollectionId,895 rmrk_nft_id: RmrkNftId,896 ) -> DispatchResult {897 let sender = ensure_signed(origin)?;898 let cross_sender = T::CrossAccountId::from_sub(sender.clone());899900 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;901 let nft_id = rmrk_nft_id.into();902903 let collection =904 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;905 collection.check_is_external()?;906907 ensure!(908 <TokenData<T>>::get((collection_id, nft_id)).is_some(),909 <Error<T>>::NoAvailableNftId910 );911912 let pending_target = Self::get_nft_property_decoded::<Option<PendingTarget>>(913 collection_id,914 nft_id,915 RmrkProperty::PendingNftAccept,916 )?;917918 match pending_target {919 Some(pending_target) => {920 Self::remove_pending_child(pending_target, (rmrk_collection_id, rmrk_nft_id))?921 }922 None => return Err(<Error<T>>::CannotRejectNonPendingNft.into()),923 }924925 Self::destroy_nft(926 cross_sender,927 collection_id,928 nft_id,929 NESTING_BUDGET,930 <Error<T>>::CannotRejectNonOwnedNft,931 )932 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;933934 Self::deposit_event(Event::NFTRejected {935 sender,936 collection_id: rmrk_collection_id,937 nft_id: rmrk_nft_id,938 });939940 Ok(())941 }942943 /// Accept the addition of a newly created pending resource to an existing NFT.944 ///945 /// This transaction is needed when a resource is created and assigned to an NFT946 /// by a non-owner, i.e. the collection issuer, with one of the947 /// [`add_...` transactions](Pallet::add_basic_resource).948 ///949 /// # Permissions:950 /// - Token owner951 ///952 /// # Arguments:953 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.954 /// - `rmrk_nft_id`: ID of the NFT with a pending resource to be accepted.955 /// - `resource_id`: ID of the newly created pending resource.956 #[transactional]957 #[pallet::weight(<SelfWeightOf<T>>::accept_resource())]958 pub fn accept_resource(959 origin: OriginFor<T>,960 rmrk_collection_id: RmrkCollectionId,961 rmrk_nft_id: RmrkNftId,962 resource_id: RmrkResourceId,963 ) -> DispatchResult {964 let sender = ensure_signed(origin)?;965 let cross_sender = T::CrossAccountId::from_sub(sender);966967 let collection_id = Self::unique_collection_id(rmrk_collection_id)968 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;969 let collection =970 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;971 collection.check_is_external()?;972973 let nft_id = rmrk_nft_id.into();974975 let budget = budget::Value::new(NESTING_BUDGET);976977 let nft_owner =978 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)979 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;980981 Self::try_mutate_resource_info(collection_id, nft_id, resource_id, |res| {982 ensure!(res.pending, <Error<T>>::ResourceNotPending);983 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);984985 res.pending = false;986987 Ok(())988 })?;989990 Self::deposit_event(Event::<T>::ResourceAccepted {991 nft_id: rmrk_nft_id,992 resource_id,993 });994995 Ok(())996 }997998 /// Accept the removal of a removal-pending resource from an NFT.999 ///1000 /// This transaction is needed when a non-owner, i.e. the collection issuer,1001 /// requests a [removal](`Pallet::remove_resource`) of a resource from an NFT.1002 ///1003 /// # Permissions:1004 /// - Token owner1005 ///1006 /// # Arguments:1007 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1008 /// - `rmrk_nft_id`: ID of the NFT with a resource to be removed.1009 /// - `resource_id`: ID of the removal-pending resource.1010 #[transactional]1011 #[pallet::weight(<SelfWeightOf<T>>::accept_resource_removal())]1012 pub fn accept_resource_removal(1013 origin: OriginFor<T>,1014 rmrk_collection_id: RmrkCollectionId,1015 rmrk_nft_id: RmrkNftId,1016 resource_id: RmrkResourceId,1017 ) -> DispatchResult {1018 let sender = ensure_signed(origin)?;1019 let cross_sender = T::CrossAccountId::from_sub(sender);10201021 let collection_id = Self::unique_collection_id(rmrk_collection_id)1022 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;1023 let collection =1024 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1025 collection.check_is_external()?;10261027 let nft_id = rmrk_nft_id.into();10281029 let budget = budget::Value::new(NESTING_BUDGET);10301031 let nft_owner =1032 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)1033 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;10341035 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);10361037 let resource_id_key = Self::get_scoped_property_key(ResourceId(resource_id))?;10381039 let resource_info = <PalletNft<T>>::token_aux_property((1040 collection_id,1041 nft_id,1042 RMRK_SCOPE,1043 resource_id_key.clone(),1044 ))1045 .ok_or(<Error<T>>::ResourceDoesntExist)?;10461047 let resource_info: RmrkResourceInfo = Self::decode_property_value(&resource_info)?;10481049 ensure!(1050 resource_info.pending_removal,1051 <Error<T>>::ResourceNotPending1052 );10531054 <PalletNft<T>>::remove_token_aux_property(1055 collection_id,1056 nft_id,1057 RMRK_SCOPE,1058 resource_id_key,1059 );10601061 if let RmrkResourceTypes::Composable(resource) = resource_info.resource {1062 let base_id = resource.base;10631064 Self::remove_associated_base_id(collection_id, nft_id, base_id)?;1065 }10661067 Self::deposit_event(Event::<T>::ResourceRemovalAccepted {1068 nft_id: rmrk_nft_id,1069 resource_id,1070 });10711072 Ok(())1073 }10741075 /// Add or edit a custom user property, a key-value pair, describing the metadata1076 /// of a token or a collection, on either one of these.1077 ///1078 /// Note that in this proxy implementation many details regarding RMRK are stored1079 /// as scoped properties prefixed with "rmrk:", normally inaccessible1080 /// to external transactions and RPCs.1081 ///1082 /// # Permissions:1083 /// - Collection issuer - in case of collection property1084 /// - Token owner - in case of NFT property1085 ///1086 /// # Arguments:1087 /// - `rmrk_collection_id`: RMRK collection ID.1088 /// - `maybe_nft_id`: Optional ID of the NFT. If left empty, then the property is set for the collection.1089 /// - `key`: Key of the custom property to be referenced by.1090 /// - `value`: Value of the custom property to be stored.1091 #[transactional]1092 #[pallet::weight(<SelfWeightOf<T>>::set_property())]1093 pub fn set_property(1094 origin: OriginFor<T>,1095 #[pallet::compact] rmrk_collection_id: RmrkCollectionId,1096 maybe_nft_id: Option<RmrkNftId>,1097 key: RmrkKeyString,1098 value: RmrkValueString,1099 ) -> DispatchResult {1100 let sender = ensure_signed(origin)?;1101 let sender = T::CrossAccountId::from_sub(sender);11021103 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1104 let collection =1105 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1106 collection.check_is_external()?;11071108 let budget = budget::Value::new(NESTING_BUDGET);11091110 match maybe_nft_id {1111 Some(nft_id) => {1112 let token_id: TokenId = nft_id.into();11131114 Self::ensure_nft_type(collection_id, token_id, NftType::Regular)?;1115 Self::ensure_nft_owner(collection_id, token_id, &sender, &budget)?;11161117 <PalletNft<T>>::set_scoped_token_property(1118 collection_id,1119 token_id,1120 RMRK_SCOPE,1121 Self::encode_rmrk_property(UserProperty(key.as_slice()), &value)?,1122 )?;1123 }1124 None => {1125 let collection = Self::get_typed_nft_collection(1126 collection_id,1127 misc::CollectionType::Regular,1128 )?;11291130 Self::check_collection_owner(&collection, &sender)?;11311132 <PalletCommon<T>>::set_scoped_collection_property(1133 collection_id,1134 RMRK_SCOPE,1135 Self::encode_rmrk_property(UserProperty(key.as_slice()), &value)?,1136 )?;1137 }1138 }11391140 Self::deposit_event(Event::PropertySet {1141 collection_id: rmrk_collection_id,1142 maybe_nft_id,1143 key,1144 value,1145 });11461147 Ok(())1148 }11491150 /// Set a different order of resource priorities for an NFT. Priorities can be used,1151 /// for example, for order of rendering.1152 ///1153 /// Note that the priorities are not updated automatically, and are an empty vector1154 /// by default. There is no pre-set definition for the order to be particular,1155 /// it can be interpreted arbitrarily use-case by use-case.1156 ///1157 /// # Permissions:1158 /// - Token owner1159 ///1160 /// # Arguments:1161 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1162 /// - `rmrk_nft_id`: ID of the NFT to rearrange resource priorities for.1163 /// - `priorities`: Ordered vector of resource IDs.1164 #[transactional]1165 #[pallet::weight(<SelfWeightOf<T>>::set_priority())]1166 pub fn set_priority(1167 origin: OriginFor<T>,1168 rmrk_collection_id: RmrkCollectionId,1169 rmrk_nft_id: RmrkNftId,1170 priorities: BoundedVec<RmrkResourceId, RmrkMaxPriorities>,1171 ) -> DispatchResult {1172 let sender = ensure_signed(origin)?;1173 let sender = T::CrossAccountId::from_sub(sender);11741175 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1176 let nft_id = rmrk_nft_id.into();11771178 let collection =1179 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1180 collection.check_is_external()?;11811182 let budget = budget::Value::new(NESTING_BUDGET);11831184 Self::ensure_nft_type(collection_id, nft_id, NftType::Regular)?;1185 Self::ensure_nft_owner(collection_id, nft_id, &sender, &budget)?;11861187 <PalletNft<T>>::set_scoped_token_property(1188 collection_id,1189 nft_id,1190 RMRK_SCOPE,1191 Self::encode_rmrk_property(ResourcePriorities, &priorities.into_inner())?,1192 )?;11931194 Self::deposit_event(Event::<T>::PrioritySet {1195 collection_id: rmrk_collection_id,1196 nft_id: rmrk_nft_id,1197 });11981199 Ok(())1200 }12011202 /// Create and set/propose a basic resource for an NFT.1203 ///1204 /// A basic resource is the simplest, lacking a Base and anything that comes with it.1205 /// See RMRK docs for more information and examples.1206 ///1207 /// # Permissions:1208 /// - Collection issuer - if not the token owner, adding the resource will warrant1209 /// the owner's [acceptance](Pallet::accept_resource).1210 ///1211 /// # Arguments:1212 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1213 /// - `nft_id`: ID of the NFT to assign a resource to.1214 /// - `resource`: Data of the resource to be created.1215 #[transactional]1216 #[pallet::weight(<SelfWeightOf<T>>::add_basic_resource())]1217 pub fn add_basic_resource(1218 origin: OriginFor<T>,1219 rmrk_collection_id: RmrkCollectionId,1220 nft_id: RmrkNftId,1221 resource: RmrkBasicResource,1222 ) -> DispatchResult {1223 let sender = ensure_signed(origin.clone())?;12241225 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1226 let collection =1227 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1228 collection.check_is_external()?;12291230 let resource_id = Self::resource_add(1231 sender,1232 collection_id,1233 nft_id.into(),1234 RmrkResourceTypes::Basic(resource),1235 )?;12361237 Self::deposit_event(Event::ResourceAdded {1238 nft_id,1239 resource_id,1240 });1241 Ok(())1242 }12431244 /// Create and set/propose a composable resource for an NFT.1245 ///1246 /// A composable resource links to a Base and has a subset of its Parts it is composed of.1247 /// See RMRK docs for more information and examples.1248 ///1249 /// # Permissions:1250 /// - Collection issuer - if not the token owner, adding the resource will warrant1251 /// the owner's [acceptance](Pallet::accept_resource).1252 ///1253 /// # Arguments:1254 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1255 /// - `nft_id`: ID of the NFT to assign a resource to.1256 /// - `resource`: Data of the resource to be created.1257 #[transactional]1258 #[pallet::weight(<SelfWeightOf<T>>::add_composable_resource())]1259 pub fn add_composable_resource(1260 origin: OriginFor<T>,1261 rmrk_collection_id: RmrkCollectionId,1262 nft_id: RmrkNftId,1263 resource: RmrkComposableResource,1264 ) -> DispatchResult {1265 let sender = ensure_signed(origin.clone())?;12661267 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1268 let collection =1269 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1270 collection.check_is_external()?;12711272 let base_id = resource.base;12731274 let resource_id = Self::resource_add(1275 sender,1276 collection_id,1277 nft_id.into(),1278 RmrkResourceTypes::Composable(resource),1279 )?;12801281 <PalletNft<T>>::try_mutate_token_aux_property(1282 collection_id,1283 nft_id.into(),1284 RMRK_SCOPE,1285 Self::get_scoped_property_key(AssociatedBases)?,1286 |value| -> DispatchResult {1287 let mut bases: BasesMap = match value {1288 Some(value) => Self::decode_property_value(value)?,1289 None => BasesMap::new(),1290 };12911292 *bases.entry(base_id).or_insert(0) += 1;12931294 *value = Some(Self::encode_property_value(&bases)?);1295 Ok(())1296 },1297 )?;12981299 Self::deposit_event(Event::ResourceAdded {1300 nft_id,1301 resource_id,1302 });1303 Ok(())1304 }13051306 /// Create and set/propose a slot resource for an NFT.1307 ///1308 /// A slot resource links to a Base and a slot ID in it which it can fit into.1309 /// See RMRK docs for more information and examples.1310 ///1311 /// # Permissions:1312 /// - Collection issuer - if not the token owner, adding the resource will warrant1313 /// the owner's [acceptance](Pallet::accept_resource).1314 ///1315 /// # Arguments:1316 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1317 /// - `nft_id`: ID of the NFT to assign a resource to.1318 /// - `resource`: Data of the resource to be created.1319 #[transactional]1320 #[pallet::weight(<SelfWeightOf<T>>::add_slot_resource())]1321 pub fn add_slot_resource(1322 origin: OriginFor<T>,1323 rmrk_collection_id: RmrkCollectionId,1324 nft_id: RmrkNftId,1325 resource: RmrkSlotResource,1326 ) -> DispatchResult {1327 let sender = ensure_signed(origin.clone())?;13281329 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1330 let collection =1331 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1332 collection.check_is_external()?;13331334 let resource_id = Self::resource_add(1335 sender,1336 collection_id,1337 nft_id.into(),1338 RmrkResourceTypes::Slot(resource),1339 )?;13401341 Self::deposit_event(Event::ResourceAdded {1342 nft_id,1343 resource_id,1344 });1345 Ok(())1346 }13471348 /// Remove and erase a resource from an NFT.1349 ///1350 /// If the sender does not own the NFT, then it will be pending confirmation,1351 /// and will have to be [accepted](Pallet::accept_resource_removal) by the token owner.1352 ///1353 /// # Permissions1354 /// - Collection issuer1355 ///1356 /// # Arguments1357 /// - `collection_id`: RMRK ID of a collection to which the NFT making use of the resource belongs to.1358 /// - `nft_id`: ID of the NFT with a resource to be removed.1359 /// - `resource_id`: ID of the resource to be removed.1360 #[transactional]1361 #[pallet::weight(<SelfWeightOf<T>>::remove_resource())]1362 pub fn remove_resource(1363 origin: OriginFor<T>,1364 rmrk_collection_id: RmrkCollectionId,1365 nft_id: RmrkNftId,1366 resource_id: RmrkResourceId,1367 ) -> DispatchResult {1368 let sender = ensure_signed(origin.clone())?;13691370 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1371 let collection =1372 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1373 collection.check_is_external()?;13741375 Self::resource_remove(sender, collection_id, nft_id.into(), resource_id)?;13761377 Self::deposit_event(Event::ResourceRemoval {1378 nft_id,1379 resource_id,1380 });1381 Ok(())1382 }1383 }1384}13851386impl<T: Config> Pallet<T> {1387 /// Transform one of possible RMRK keys into a byte key with a RMRK scope.1388 pub fn get_scoped_property_key(rmrk_key: RmrkProperty) -> Result<PropertyKey, DispatchError> {1389 let key = rmrk_key.to_key::<T>()?;13901391 let scoped_key = RMRK_SCOPE1392 .apply(key)1393 .map_err(|_| <Error<T>>::RmrkPropertyKeyIsTooLong)?;13941395 Ok(scoped_key)1396 }13971398 /// Form a Unique property, transforming a RMRK key into bytes (without assigning the scope yet)1399 /// and encoding the value from an arbitrary type into bytes.1400 pub fn encode_rmrk_property<E: Encode>(1401 rmrk_key: RmrkProperty,1402 value: &E,1403 ) -> Result<Property, DispatchError> {1404 let key = rmrk_key.to_key::<T>()?;14051406 let value = Self::encode_property_value(value)?;14071408 let property = Property { key, value };14091410 Ok(property)1411 }14121413 /// Encode property value from an arbitrary type into bytes for storage.1414 pub fn encode_property_value<E: Encode, S: Get<u32>>(1415 value: &E,1416 ) -> Result<BoundedBytes<S>, DispatchError> {1417 let value = value1418 .encode()1419 .try_into()1420 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong)?;14211422 Ok(value)1423 }14241425 /// Decode property value from bytes into an arbitrary type.1426 pub fn decode_property_value<D: Decode, S: Get<u32>>(1427 vec: &BoundedBytes<S>,1428 ) -> Result<D, DispatchError> {1429 vec.decode()1430 .map_err(|_| <Error<T>>::UnableToDecodeRmrkData.into())1431 }14321433 /// Change the limit of a property value byte vector.1434 pub fn rebind<L, S>(vec: &BoundedVec<u8, L>) -> Result<BoundedVec<u8, S>, DispatchError>1435 where1436 BoundedVec<u8, S>: TryFrom<Vec<u8>>,1437 {1438 vec.rebind()1439 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong.into())1440 }14411442 /// Initialize a new NFT collection with certain RMRK-scoped properties.1443 ///1444 /// See [`init_collection`](pallet_nonfungible::pallet::Pallet::init_collection) for more details.1445 fn init_collection(1446 sender: T::CrossAccountId,1447 data: CreateCollectionData<T::AccountId>,1448 properties: impl Iterator<Item = Property>,1449 ) -> Result<CollectionId, DispatchError> {1450 let collection_id = <PalletNft<T>>::init_collection(sender, data, true);14511452 if let Err(DispatchError::Arithmetic(_)) = &collection_id {1453 return Err(<Error<T>>::NoAvailableCollectionId.into());1454 }14551456 <PalletCommon<T>>::set_scoped_collection_properties(1457 collection_id?,1458 RMRK_SCOPE,1459 properties,1460 )?;14611462 collection_id1463 }14641465 /// Mint a new NFT with certain RMRK-scoped properties. Sender must be the collection owner.1466 ///1467 /// See [`create_item`](pallet_nonfungible::pallet::Pallet::create_item) for more details.1468 pub fn create_nft(1469 sender: &T::CrossAccountId,1470 owner: &T::CrossAccountId,1471 collection: &NonfungibleHandle<T>,1472 properties: impl Iterator<Item = Property>,1473 ) -> Result<TokenId, DispatchError> {1474 let data = CreateNftExData {1475 properties: BoundedVec::default(),1476 owner: owner.clone(),1477 };14781479 let budget = budget::Value::new(NESTING_BUDGET);14801481 <PalletNft<T>>::create_item(collection, sender, data, &budget)?;14821483 let nft_id = <PalletNft<T>>::current_token_id(collection.id);14841485 <PalletNft<T>>::set_scoped_token_properties(collection.id, nft_id, RMRK_SCOPE, properties)?;14861487 Ok(nft_id)1488 }14891490 /// Burn an NFT, along with its nested children, limited by `max_burns`. The sender must be the token owner.1491 ///1492 /// See [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively) for more details.1493 fn destroy_nft(1494 sender: T::CrossAccountId,1495 collection_id: CollectionId,1496 token_id: TokenId,1497 max_burns: u32,1498 error_if_not_owned: Error<T>,1499 ) -> DispatchResultWithPostInfo {1500 let collection =1501 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;15021503 let token_data =1504 <TokenData<T>>::get((collection_id, token_id)).ok_or(<Error<T>>::NoAvailableNftId)?;15051506 let from = token_data.owner;15071508 let owner_check_budget = budget::Value::new(NESTING_BUDGET);15091510 ensure!(1511 <PalletStructure<T>>::check_indirectly_owned(1512 sender.clone(),1513 collection_id,1514 token_id,1515 None,1516 &owner_check_budget1517 )?,1518 error_if_not_owned,1519 );15201521 let burns_budget = budget::Value::new(max_burns);1522 let breadth_budget = budget::Value::new(max_burns);15231524 <PalletNft<T>>::burn_recursively(1525 &collection,1526 &from,1527 token_id,1528 &burns_budget,1529 &breadth_budget,1530 )1531 }15321533 /// Add a sent token pending acceptance to the target owning token as a property.1534 fn insert_pending_child(1535 target: (CollectionId, TokenId),1536 child: (RmrkCollectionId, RmrkNftId),1537 ) -> DispatchResult {1538 Self::mutate_pending_children(target, |pending_children| {1539 pending_children.insert(child);1540 })1541 }15421543 /// Remove a sent token pending acceptance from the target token's properties.1544 fn remove_pending_child(1545 target: (CollectionId, TokenId),1546 child: (RmrkCollectionId, RmrkNftId),1547 ) -> DispatchResult {1548 Self::mutate_pending_children(target, |pending_children| {1549 pending_children.remove(&child);1550 })1551 }15521553 /// Apply a mutation to the property of a token containing sent tokens1554 /// that are currently pending acceptance.1555 fn mutate_pending_children(1556 (target_collection_id, target_nft_id): (CollectionId, TokenId),1557 f: impl FnOnce(&mut PendingChildrenSet),1558 ) -> DispatchResult {1559 <PalletNft<T>>::try_mutate_token_aux_property(1560 target_collection_id,1561 target_nft_id,1562 RMRK_SCOPE,1563 Self::get_scoped_property_key(PendingChildren)?,1564 |pending_children| -> DispatchResult {1565 let mut map = match pending_children {1566 Some(map) => Self::decode_property_value(map)?,1567 None => PendingChildrenSet::new(),1568 };15691570 f(&mut map);15711572 *pending_children = Some(Self::encode_property_value(&map)?);15731574 Ok(())1575 },1576 )1577 }15781579 /// Get an iterator from a token's property containing tokens sent to it1580 /// that are currently pending acceptance.1581 fn iterate_pending_children(1582 collection_id: CollectionId,1583 nft_id: TokenId,1584 ) -> Result<impl Iterator<Item = PendingChild>, DispatchError> {1585 let property = <PalletNft<T>>::token_aux_property((1586 collection_id,1587 nft_id,1588 RMRK_SCOPE,1589 Self::get_scoped_property_key(PendingChildren)?,1590 ));15911592 let pending_children = match property {1593 Some(map) => Self::decode_property_value(&map)?,1594 None => PendingChildrenSet::new(),1595 };15961597 Ok(pending_children.into_iter())1598 }15991600 /// Get incremented resource ID from within an NFT's properties and store the new latest ID.1601 /// Thus, the returned resource ID should be used.1602 ///1603 /// Resource IDs are unique only across an NFT.1604 fn acquire_next_resource_id(1605 collection_id: CollectionId,1606 nft_id: TokenId,1607 ) -> Result<RmrkResourceId, DispatchError> {1608 let resource_id: RmrkResourceId =1609 Self::get_nft_property_decoded(collection_id, nft_id, NextResourceId)?;16101611 let next_id = resource_id1612 .checked_add(1)1613 .ok_or(<Error<T>>::NoAvailableResourceId)?;16141615 <PalletNft<T>>::set_scoped_token_property(1616 collection_id,1617 nft_id,1618 RMRK_SCOPE,1619 Self::encode_rmrk_property(NextResourceId, &next_id)?,1620 )?;16211622 Ok(resource_id)1623 }16241625 /// Create and add a resource for a regular NFT, mark it as pending if the sender1626 /// is not the token owner. The sender must be the collection owner.1627 fn resource_add(1628 sender: T::AccountId,1629 collection_id: CollectionId,1630 nft_id: TokenId,1631 resource: RmrkResourceTypes,1632 ) -> Result<RmrkResourceId, DispatchError> {1633 let collection =1634 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1635 ensure!(collection.owner == sender, Error::<T>::NoPermission);16361637 let sender = T::CrossAccountId::from_sub(sender);1638 let budget = budget::Value::new(NESTING_BUDGET);16391640 let nft_owner = <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)1641 .map_err(Self::map_unique_err_to_proxy)?;16421643 let pending = sender != nft_owner;16441645 let id = Self::acquire_next_resource_id(collection_id, nft_id)?;16461647 let resource_info = RmrkResourceInfo {1648 id,1649 resource,1650 pending,1651 pending_removal: false,1652 };16531654 <PalletNft<T>>::try_mutate_token_aux_property(1655 collection_id,1656 nft_id,1657 RMRK_SCOPE,1658 Self::get_scoped_property_key(ResourceId(id))?,1659 |value| -> DispatchResult {1660 *value = Some(Self::encode_property_value(&resource_info)?);16611662 Ok(())1663 },1664 )?;16651666 Ok(id)1667 }16681669 /// Designate a resource for erasure from an NFT, and remove it if the sender is the token owner.1670 /// The sender must be the collection owner.1671 fn resource_remove(1672 sender: T::AccountId,1673 collection_id: CollectionId,1674 nft_id: TokenId,1675 resource_id: RmrkResourceId,1676 ) -> DispatchResult {1677 let collection =1678 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1679 ensure!(collection.owner == sender, Error::<T>::NoPermission);16801681 let resource_id_key = Self::get_scoped_property_key(ResourceId(resource_id))?;16821683 let resource = <PalletNft<T>>::token_aux_property((1684 collection_id,1685 nft_id,1686 RMRK_SCOPE,1687 resource_id_key.clone(),1688 ))1689 .ok_or(<Error<T>>::ResourceDoesntExist)?;16901691 let resource_info: RmrkResourceInfo = Self::decode_property_value(&resource)?;16921693 let budget = up_data_structs::budget::Value::new(NESTING_BUDGET);1694 let topmost_owner =1695 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)?;16961697 let sender = T::CrossAccountId::from_sub(sender);1698 if topmost_owner == sender {1699 <PalletNft<T>>::remove_token_aux_property(1700 collection_id,1701 nft_id,1702 RMRK_SCOPE,1703 Self::get_scoped_property_key(ResourceId(resource_id))?,1704 );17051706 if let RmrkResourceTypes::Composable(resource) = resource_info.resource {1707 let base_id = resource.base;17081709 Self::remove_associated_base_id(collection_id, nft_id, base_id)?;1710 }1711 } else {1712 Self::try_mutate_resource_info(collection_id, nft_id, resource_id, |res| {1713 res.pending_removal = true;17141715 Ok(())1716 })?;1717 }17181719 Ok(())1720 }17211722 /// Remove a Base ID from an NFT if they are associated.1723 /// The Base itself is deleted if the number of associated NFTs reaches 0.1724 fn remove_associated_base_id(1725 collection_id: CollectionId,1726 nft_id: TokenId,1727 base_id: RmrkBaseId,1728 ) -> DispatchResult {1729 <PalletNft<T>>::try_mutate_token_aux_property(1730 collection_id,1731 nft_id,1732 RMRK_SCOPE,1733 Self::get_scoped_property_key(AssociatedBases)?,1734 |value| -> DispatchResult {1735 let mut bases: BasesMap = match value {1736 Some(value) => Self::decode_property_value(value)?,1737 None => BasesMap::new(),1738 };17391740 let remaining = bases.get(&base_id);17411742 if let Some(remaining) = remaining {1743 if let Some(0) | None = remaining.checked_sub(1) {1744 bases.remove(&base_id);1745 }1746 }17471748 *value = Some(Self::encode_property_value(&bases)?);1749 Ok(())1750 },1751 )1752 }17531754 /// Apply a mutation to a resource stored in the token properties of an NFT.1755 fn try_mutate_resource_info(1756 collection_id: CollectionId,1757 nft_id: TokenId,1758 resource_id: RmrkResourceId,1759 f: impl FnOnce(&mut RmrkResourceInfo) -> DispatchResult,1760 ) -> DispatchResult {1761 <PalletNft<T>>::try_mutate_token_aux_property(1762 collection_id,1763 nft_id,1764 RMRK_SCOPE,1765 Self::get_scoped_property_key(ResourceId(resource_id))?,1766 |value| match value {1767 Some(value) => {1768 let mut resource_info: RmrkResourceInfo = Self::decode_property_value(value)?;17691770 f(&mut resource_info)?;17711772 *value = Self::encode_property_value(&resource_info)?;17731774 Ok(())1775 }1776 None => Err(<Error<T>>::ResourceDoesntExist.into()),1777 },1778 )1779 }17801781 /// Change the owner of an NFT collection, ensuring that the sender is the current owner.1782 fn change_collection_owner(1783 collection_id: CollectionId,1784 collection_type: misc::CollectionType,1785 sender: T::AccountId,1786 new_owner: T::AccountId,1787 ) -> DispatchResult {1788 let collection = Self::get_typed_nft_collection(collection_id, collection_type)?;1789 Self::check_collection_owner(&collection, &T::CrossAccountId::from_sub(sender))?;17901791 let mut collection = collection.into_inner();17921793 collection.owner = new_owner;1794 collection.save()1795 }17961797 /// Ensure that an account is the collection owner/issuer, return an error if not.1798 pub fn check_collection_owner(1799 collection: &NonfungibleHandle<T>,1800 account: &T::CrossAccountId,1801 ) -> DispatchResult {1802 collection1803 .check_is_owner(account)1804 .map_err(Self::map_unique_err_to_proxy)1805 }18061807 /// Get the latest yet-unused RMRK collection index from the storage.1808 pub fn last_collection_idx() -> RmrkCollectionId {1809 <CollectionIndex<T>>::get()1810 }18111812 /// Get a mapping from a RMRK collection ID to its corresponding Unique collection ID.1813 pub fn unique_collection_id(1814 rmrk_collection_id: RmrkCollectionId,1815 ) -> Result<CollectionId, DispatchError> {1816 <UniqueCollectionId<T>>::try_get(rmrk_collection_id)1817 .map_err(|_| <Error<T>>::CollectionUnknown.into())1818 }18191820 /// Get a mapping from a Unique collection ID to its RMRK collection ID counterpart, if it exists.1821 pub fn rmrk_collection_id(1822 unique_collection_id: CollectionId,1823 ) -> Result<RmrkCollectionId, DispatchError> {1824 Self::get_collection_property_decoded(unique_collection_id, RmrkInternalCollectionId)1825 }18261827 /// Fetch a Unique NFT collection.1828 pub fn get_nft_collection(1829 collection_id: CollectionId,1830 ) -> Result<NonfungibleHandle<T>, DispatchError> {1831 let collection = <CollectionHandle<T>>::try_get(collection_id)1832 .map_err(|_| <Error<T>>::CollectionUnknown)?;18331834 match collection.mode {1835 CollectionMode::NFT => Ok(NonfungibleHandle::cast(collection)),1836 _ => Err(<Error<T>>::CollectionUnknown.into()),1837 }1838 }18391840 /// Check if an NFT collection with such an ID exists.1841 pub fn collection_exists(collection_id: CollectionId) -> bool {1842 <CollectionHandle<T>>::try_get(collection_id).is_ok()1843 }18441845 /// Fetch and decode a RMRK-scoped collection property value in bytes.1846 pub fn get_collection_property(1847 collection_id: CollectionId,1848 key: RmrkProperty,1849 ) -> Result<PropertyValue, DispatchError> {1850 let collection_property = <PalletCommon<T>>::collection_properties(collection_id)1851 .get(&Self::get_scoped_property_key(key)?)1852 .ok_or(<Error<T>>::CollectionUnknown)?1853 .clone();18541855 Ok(collection_property)1856 }18571858 /// Fetch a RMRK-scoped collection property and decode it from bytes into an appropriate type.1859 pub fn get_collection_property_decoded<V: Decode>(1860 collection_id: CollectionId,1861 key: RmrkProperty,1862 ) -> Result<V, DispatchError> {1863 Self::decode_property_value(&Self::get_collection_property(collection_id, key)?)1864 }18651866 /// Get the type of a collection stored as a scoped property.1867 ///1868 /// RMRK Core proxy differentiates between regular collections as well as RMRK Bases as collections.1869 pub fn get_collection_type(1870 collection_id: CollectionId,1871 ) -> Result<misc::CollectionType, DispatchError> {1872 Self::get_collection_property_decoded(collection_id, CollectionType).map_err(|err| {1873 if err != <Error<T>>::CollectionUnknown.into() {1874 <Error<T>>::CorruptedCollectionType.into()1875 } else {1876 err1877 }1878 })1879 }18801881 /// Ensure that the type of the collection equals the provided type,1882 /// otherwise return an error.1883 pub fn ensure_collection_type(1884 collection_id: CollectionId,1885 collection_type: misc::CollectionType,1886 ) -> DispatchResult {1887 let actual_type = Self::get_collection_type(collection_id)?;1888 ensure!(1889 actual_type == collection_type,1890 <CommonError<T>>::NoPermission1891 );18921893 Ok(())1894 }18951896 /// Fetch an NFT collection, but make sure it has the appropriate type.1897 pub fn get_typed_nft_collection(1898 collection_id: CollectionId,1899 collection_type: misc::CollectionType,1900 ) -> Result<NonfungibleHandle<T>, DispatchError> {1901 Self::ensure_collection_type(collection_id, collection_type)?;19021903 Self::get_nft_collection(collection_id)1904 }19051906 /// Same as [`get_typed_nft_collection`](crate::pallet::Pallet::get_typed_nft_collection),1907 /// but also return the Unique collection ID.1908 pub fn get_typed_nft_collection_mapped(1909 rmrk_collection_id: RmrkCollectionId,1910 collection_type: misc::CollectionType,1911 ) -> Result<(NonfungibleHandle<T>, CollectionId), DispatchError> {1912 let unique_collection_id = match collection_type {1913 misc::CollectionType::Regular => Self::unique_collection_id(rmrk_collection_id)?,1914 _ => rmrk_collection_id.into(),1915 };19161917 let collection = Self::get_typed_nft_collection(unique_collection_id, collection_type)?;19181919 Ok((collection, unique_collection_id))1920 }19211922 /// Fetch and decode a RMRK-scoped NFT property value in bytes.1923 pub fn get_nft_property(1924 collection_id: CollectionId,1925 nft_id: TokenId,1926 key: RmrkProperty,1927 ) -> Result<PropertyValue, DispatchError> {1928 let nft_property = <PalletNft<T>>::token_properties((collection_id, nft_id))1929 .get(&Self::get_scoped_property_key(key)?)1930 .ok_or(<Error<T>>::RmrkPropertyIsNotFound)?1931 .clone();19321933 Ok(nft_property)1934 }19351936 /// Fetch a RMRK-scoped NFT property and decode it from bytes into an appropriate type.1937 pub fn get_nft_property_decoded<V: Decode>(1938 collection_id: CollectionId,1939 nft_id: TokenId,1940 key: RmrkProperty,1941 ) -> Result<V, DispatchError> {1942 Self::decode_property_value(&Self::get_nft_property(collection_id, nft_id, key)?)1943 }19441945 /// Check that an NFT exists.1946 pub fn nft_exists(collection_id: CollectionId, nft_id: TokenId) -> bool {1947 <TokenData<T>>::contains_key((collection_id, nft_id))1948 }19491950 /// Get the type of an NFT stored as a scoped property.1951 ///1952 /// RMRK Core proxy differentiates between regular NFTs, and RMRK Parts and Themes.1953 pub fn get_nft_type(1954 collection_id: CollectionId,1955 token_id: TokenId,1956 ) -> Result<NftType, DispatchError> {1957 Self::get_nft_property_decoded(collection_id, token_id, TokenType)1958 .map_err(|_| <Error<T>>::NoAvailableNftId.into())1959 }19601961 /// Ensure that the type of the NFT equals the provided type, otherwise return an error.1962 pub fn ensure_nft_type(1963 collection_id: CollectionId,1964 token_id: TokenId,1965 nft_type: NftType,1966 ) -> DispatchResult {1967 let actual_type = Self::get_nft_type(collection_id, token_id)?;1968 ensure!(actual_type == nft_type, <Error<T>>::NoPermission);19691970 Ok(())1971 }19721973 /// Ensure that an account is the owner of the token, either directly1974 /// or at the top of the nesting hierarchy; return an error if it is not.1975 pub fn ensure_nft_owner(1976 collection_id: CollectionId,1977 token_id: TokenId,1978 possible_owner: &T::CrossAccountId,1979 nesting_budget: &dyn budget::Budget,1980 ) -> DispatchResult {1981 let is_owned = <PalletStructure<T>>::check_indirectly_owned(1982 possible_owner.clone(),1983 collection_id,1984 token_id,1985 None,1986 nesting_budget,1987 )1988 .map_err(Self::map_unique_err_to_proxy)?;19891990 ensure!(is_owned, <Error<T>>::NoPermission);19911992 Ok(())1993 }19941995 /// Fetch non-scoped properties of a collection or a token that match the filter keys supplied,1996 /// or, if None are provided, return all non-scoped properties.1997 pub fn filter_user_properties<Key, Value, R, Mapper>(1998 collection_id: CollectionId,1999 token_id: Option<TokenId>,2000 filter_keys: Option<Vec<RmrkPropertyKey>>,2001 mapper: Mapper,2002 ) -> Result<Vec<R>, DispatchError>2003 where2004 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,2005 Value: Decode + Default,2006 Mapper: Fn(Key, Value) -> R,2007 {2008 filter_keys2009 .map(|keys| {2010 let properties = keys2011 .into_iter()2012 .filter_map(|key| {2013 let key: Key = key.try_into().ok()?;20142015 let value = match token_id {2016 Some(token_id) => Self::get_nft_property_decoded(2017 collection_id,2018 token_id,2019 UserProperty(key.as_ref()),2020 ),2021 None => Self::get_collection_property_decoded(2022 collection_id,2023 UserProperty(key.as_ref()),2024 ),2025 }2026 .ok()?;20272028 Some(mapper(key, value))2029 })2030 .collect();20312032 Ok(properties)2033 })2034 .unwrap_or_else(|| {2035 let properties =2036 Self::iterate_user_properties(collection_id, token_id, mapper)?.collect();20372038 Ok(properties)2039 })2040 }20412042 /// Get all non-scoped properties from a collection or a token, and apply some transformation,2043 /// supplied by `mapper`, to each key-value pair.2044 pub fn iterate_user_properties<Key, Value, R, Mapper>(2045 collection_id: CollectionId,2046 token_id: Option<TokenId>,2047 mapper: Mapper,2048 ) -> Result<impl Iterator<Item = R>, DispatchError>2049 where2050 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,2051 Value: Decode + Default,2052 Mapper: Fn(Key, Value) -> R,2053 {2054 let properties = match token_id {2055 Some(token_id) => <PalletNft<T>>::token_properties((collection_id, token_id)),2056 None => <PalletCommon<T>>::collection_properties(collection_id),2057 };20582059 let properties = properties.into_iter().filter_map(move |(key, value)| {2060 let key = strip_key_prefix(&key, USER_PROPERTY_PREFIX)?;20612062 let key: Key = key.to_vec().try_into().ok()?;2063 let value: Value = value.decode().ok()?;20642065 Some(mapper(key, value))2066 });20672068 Ok(properties)2069 }20702071 /// Match Unique errors to RMRK's own and return the RMRK error if a match is successful.2072 fn map_unique_err_to_proxy(err: DispatchError) -> DispatchError {2073 map_unique_err_to_proxy! {2074 match err {2075 CommonError::NoPermission => NoPermission,2076 CommonError::CollectionTokenLimitExceeded => CollectionFullOrLocked,2077 CommonError::PublicMintingNotAllowed => NoPermission,2078 CommonError::TokenNotFound => NoAvailableNftId,2079 CommonError::ApprovedValueTooLow => NoPermission,2080 CommonError::CantDestroyNotEmptyCollection => CollectionNotEmpty,2081 StructureError::TokenNotFound => NoAvailableNftId,2082 StructureError::OuroborosDetected => CannotSendToDescendentOrSelf,2083 }2084 }2085 }2086}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 Core Proxy pallet mirrors the functionality of RMRK Core,28//! binding its externalities to Unique's own underlying structure.29//! It is purposed to mimic RMRK Core exactly, allowing seamless integrations30//! of solutions based on RMRK.31//!32//! RMRK Core itself contains essential functionality for RMRK's nested and33//! multi-resourced NFTs.34//!35//! *Note*, that while RMRK itself is subject to active development and restructuring,36//! the proxy may be caught temporarily out of date.37//!38//! ### What is RMRK?39//!40//! RMRK is a set of NFT standards which compose several "NFT 2.0 lego" primitives.41//! Putting these legos together allows a user to create NFT systems of arbitrary complexity.42//!43//! Meaning, RMRK NFTs are dynamic, able to nest into each other and form a hierarchy,44//! make use of specific changeable and partially shared metadata in the form of resources,45//! and more.46//!47//! Visit RMRK documentation and repositories to learn more:48//! - Docs: <https://docs.rmrk.app/getting-started/>49//! - FAQ: <https://coda.io/@rmrk/faq>50//! - Substrate code repository: <https://github.com/rmrk-team/rmrk-substrate>51//! - RMRK specification repository: <https://github.com/rmrk-team/rmrk-spec>52//!53//! ## Terminology54//!55//! For more information on RMRK, see RMRK's own documentation.56//!57//! ### Intro to RMRK58//!59//! - **Resource:** Additional piece of metadata of an NFT usually serving to add60//! a piece of media on top of the root metadata (NFT's own), be it a different wing61//! on the root template bird or something entirely unrelated.62//!63//! - **Base:** A list of possible "components" - Parts, a combination of which can64//! be appended/equipped to/on an NFT.65//!66//! - **Part:** Something that, together with other Parts, can constitute an NFT.67//! Parts are defined in the Base to which they belong. Parts can be either68//! of the `slot` type or `fixed` type. Slots are intended for equippables.69//! Note that "part of something" and "Part of a Base" can be easily confused,70//! and so in this documentation these words are distinguished by the capital letter.71//!72//! - **Theme:** Named objects of variable => value pairs which get interpolated into73//! the Base's `themable` Parts. Themes can hold any value, but are often represented74//! in RMRK's examples as colors applied to visible Parts.75//!76//! ### Peculiarities in Unique77//!78//! - **Scoped properties:** Properties that are normally obscured from users.79//! Their purpose is to contain structured metadata that was not included in the Unique standard80//! for collections and tokens, meant to be operated on by proxies and other outliers.81//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is82//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined83//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.84//!85//! - **Auxiliary properties:** A slightly different structure of properties,86//! trading universality of use for more convenient storage, writes and access.87//! Meant to be inaccessible to end users.88//!89//! ## Proxy Implementation90//!91//! An external user is supposed to be able to utilize this proxy as they would92//! utilize RMRK, and get exactly the same results. Normally, Unique transactions93//! are off-limits to RMRK collections and tokens, and vice versa. However,94//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.95//!96//! ### ID Mapping97//!98//! RMRK's collections' IDs are counted independently of Unique's and start at 0.99//! Note that tokens' IDs still start at 1.100//! The collections themselves, as well as tokens, are stored as Unique collections,101//! and thus RMRK IDs are mapped to Unique IDs (but not vice versa).102//!103//! ### External/Internal Collection Insulation104//!105//! A Unique transaction cannot target collections purposed for RMRK,106//! and they are flagged as `external` to specify that. On the other hand,107//! due to the mapping, RMRK transactions and RPCs simply cannot reach Unique collections.108//!109//! ### Native Properties110//!111//! Many of RMRK's native parameters are stored as scoped properties of a collection112//! or an NFT on the chain. Scoped properties are prefixed with `rmrk:`, where `:`113//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,114//! makes them impossible to tamper with.115//!116//! ### Collection and NFT Types, or Base, Parts and Themes Handling117//!118//! RMRK introduces the concept of a Base, which is a catalogue of Parts,119//! possible components of an NFT. Due to its similarity with the functionality120//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes121//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].122//!123//! ## Interface124//!125//! ### Dispatchables126//!127//! - `create_collection` - Create a new collection of NFTs.128//! - `destroy_collection` - Destroy a collection.129//! - `change_collection_issuer` - Change the issuer of a collection.130//! Analogous to Unique's collection's [`owner`](up_data_structs::Collection).131//! - `lock_collection` - "Lock" the collection and prevent new token creation. **Cannot be undone.**132//! - `mint_nft` - Mint an NFT in a specified collection.133//! - `burn_nft` - Burn an NFT, destroying it and its nested tokens.134//! - `send` - Transfer an NFT from an account/NFT A to another account/NFT B.135//! - `accept_nft` - Accept an NFT sent from another account to self or an owned NFT.136//! - `reject_nft` - Reject an NFT sent from another account to self or owned NFT and **burn it**.137//! - `accept_resource` - Accept the addition of a newly created pending resource to an existing NFT.138//! - `accept_resource_removal` - Accept the removal of a removal-pending resource from an NFT.139//! - `set_property` - Add or edit a custom user property of a token or a collection.140//! - `set_priority` - Set a different order of resource priorities for an NFT.141//! - `add_basic_resource` - Create and set/propose a basic resource for an NFT.142//! - `add_composable_resource` - Create and set/propose a composable resource for an NFT.143//! - `add_slot_resource` - Create and set/propose a slot resource for an NFT.144//! - `remove_resource` - Remove and erase a resource from an NFT.145146#![cfg_attr(not(feature = "std"), no_std)]147148use frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};149use frame_system::{pallet_prelude::*, ensure_signed};150use sp_runtime::{DispatchError, Permill, traits::StaticLookup};151use sp_std::{152 vec::Vec,153 collections::{btree_set::BTreeSet, btree_map::BTreeMap},154};155use up_data_structs::{*, mapping::TokenAddressMapping};156use pallet_common::{157 Pallet as PalletCommon, Error as CommonError, CollectionHandle, CommonCollectionOperations,158};159use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle, TokenData};160use pallet_structure::{Pallet as PalletStructure, Error as StructureError};161use pallet_evm::account::CrossAccountId;162use core::convert::AsRef;163164pub use pallet::*;165166#[cfg(feature = "runtime-benchmarks")]167pub mod benchmarking;168pub mod misc;169pub mod property;170pub mod rpc;171pub mod weights;172173pub type SelfWeightOf<T> = <T as Config>::WeightInfo;174175use weights::WeightInfo;176use misc::*;177pub use property::*;178179use RmrkProperty::*;180181/// Maximum number of levels of depth in the token nesting tree.182pub const NESTING_BUDGET: u32 = 5;183184type PendingTarget = (CollectionId, TokenId);185type PendingChild = (RmrkCollectionId, RmrkNftId);186type PendingChildrenSet = BTreeSet<PendingChild>;187188type BasesMap = BTreeMap<RmrkBaseId, u32>;189190#[frame_support::pallet]191pub mod pallet {192 use super::*;193 use pallet_evm::account;194195 #[pallet::config]196 pub trait Config:197 frame_system::Config + pallet_common::Config + pallet_nonfungible::Config + account::Config198 {199 /// Overarching event type.200 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;201202 /// The weight information of this pallet.203 type WeightInfo: WeightInfo;204 }205206 /// Latest yet-unused collection ID.207 #[pallet::storage]208 #[pallet::getter(fn collection_index)]209 pub type CollectionIndex<T: Config> = StorageValue<_, RmrkCollectionId, ValueQuery>;210211 /// Mapping from RMRK collection ID to Unique's.212 #[pallet::storage]213 pub type UniqueCollectionId<T: Config> =214 StorageMap<_, Twox64Concat, RmrkCollectionId, CollectionId, ValueQuery>;215216 #[pallet::pallet]217 #[pallet::generate_store(pub(super) trait Store)]218 pub struct Pallet<T>(_);219220 #[pallet::event]221 #[pallet::generate_deposit(pub(super) fn deposit_event)]222 pub enum Event<T: Config> {223 CollectionCreated {224 issuer: T::AccountId,225 collection_id: RmrkCollectionId,226 },227 CollectionDestroyed {228 issuer: T::AccountId,229 collection_id: RmrkCollectionId,230 },231 IssuerChanged {232 old_issuer: T::AccountId,233 new_issuer: T::AccountId,234 collection_id: RmrkCollectionId,235 },236 CollectionLocked {237 issuer: T::AccountId,238 collection_id: RmrkCollectionId,239 },240 NftMinted {241 owner: T::AccountId,242 collection_id: RmrkCollectionId,243 nft_id: RmrkNftId,244 },245 NFTBurned {246 owner: T::AccountId,247 nft_id: RmrkNftId,248 },249 NFTSent {250 sender: T::AccountId,251 recipient: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,252 collection_id: RmrkCollectionId,253 nft_id: RmrkNftId,254 approval_required: bool,255 },256 NFTAccepted {257 sender: T::AccountId,258 recipient: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,259 collection_id: RmrkCollectionId,260 nft_id: RmrkNftId,261 },262 NFTRejected {263 sender: T::AccountId,264 collection_id: RmrkCollectionId,265 nft_id: RmrkNftId,266 },267 PropertySet {268 collection_id: RmrkCollectionId,269 maybe_nft_id: Option<RmrkNftId>,270 key: RmrkKeyString,271 value: RmrkValueString,272 },273 ResourceAdded {274 nft_id: RmrkNftId,275 resource_id: RmrkResourceId,276 },277 ResourceRemoval {278 nft_id: RmrkNftId,279 resource_id: RmrkResourceId,280 },281 ResourceAccepted {282 nft_id: RmrkNftId,283 resource_id: RmrkResourceId,284 },285 ResourceRemovalAccepted {286 nft_id: RmrkNftId,287 resource_id: RmrkResourceId,288 },289 PrioritySet {290 collection_id: RmrkCollectionId,291 nft_id: RmrkNftId,292 },293 }294295 #[pallet::error]296 pub enum Error<T> {297 /* Unique proxy-specific events */298 /// Property of the type of RMRK collection could not be read successfully.299 CorruptedCollectionType,300 // NftTypeEncodeError,301 /// Too many symbols supplied as the property key. The maximum is [256](up_data_structs::MAX_PROPERTY_KEY_LENGTH).302 RmrkPropertyKeyIsTooLong,303 /// Too many bytes supplied as the property value. The maximum is [32768](up_data_structs::MAX_PROPERTY_VALUE_LENGTH).304 RmrkPropertyValueIsTooLong,305 /// Could not find a property by the supplied key.306 RmrkPropertyIsNotFound,307 /// Something went wrong when decoding encoded data from the storage.308 /// Perhaps, there was a wrong key supplied for the type, or the data was improperly stored.309 UnableToDecodeRmrkData,310311 /* RMRK compatible events */312 /// Only destroying collections without tokens is allowed.313 CollectionNotEmpty,314 /// Could not find an ID for a collection. It is likely there were too many collections created on the chain, causing an overflow.315 NoAvailableCollectionId,316 /// Token does not exist, or there is no suitable ID for it, likely too many tokens were created in a collection, causing an overflow.317 NoAvailableNftId,318 /// Collection does not exist, has a wrong type, or does not map to a Unique ID.319 CollectionUnknown,320 /// No permission to perform action.321 NoPermission,322 /// Token is marked as non-transferable, and thus cannot be transferred.323 NonTransferable,324 /// Too many tokens created in the collection, no new ones are allowed.325 CollectionFullOrLocked,326 /// No such resource found.327 ResourceDoesntExist,328 /// If an NFT is sent to a descendant, that would form a nesting loop, an ouroboros.329 /// Sending to self is redundant.330 CannotSendToDescendentOrSelf,331 /// Not the target owner of the sent NFT.332 CannotAcceptNonOwnedNft,333 /// Not the target owner of the sent NFT.334 CannotRejectNonOwnedNft,335 /// NFT was not sent and is not pending.336 CannotRejectNonPendingNft,337 /// Resource is not pending for the operation.338 ResourceNotPending,339 /// Could not find an ID for the resource. It is likely there were too many resources created on an NFT, causing an overflow.340 NoAvailableResourceId,341 }342343 #[pallet::call]344 impl<T: Config> Pallet<T> {345 // todo :refactor replace every collection_id with rmrk_collection_id (and nft_id) in arguments for uniformity?346347 /// Create a new collection of NFTs.348 ///349 /// # Permissions:350 /// * Anyone - will be assigned as the issuer of the collection.351 ///352 /// # Arguments:353 /// - `metadata`: Metadata describing the collection, e.g. IPFS hash. Cannot be changed.354 /// - `max`: Optional maximum number of tokens.355 /// - `symbol`: UTF-8 string with token prefix, by which to represent the token in wallets and UIs.356 /// Analogous to Unique's [`token_prefix`](up_data_structs::Collection). Cannot be changed.357 #[transactional]358 #[pallet::weight(<SelfWeightOf<T>>::create_collection())]359 pub fn create_collection(360 origin: OriginFor<T>,361 metadata: RmrkString,362 max: Option<u32>,363 symbol: RmrkCollectionSymbol,364 ) -> DispatchResult {365 let sender = ensure_signed(origin)?;366367 let limits = CollectionLimits {368 owner_can_transfer: Some(false),369 token_limit: max,370 ..Default::default()371 };372373 let data = CreateCollectionData {374 limits: Some(limits),375 token_prefix: symbol376 .into_inner()377 .try_into()378 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,379 permissions: Some(CollectionPermissions {380 nesting: Some(NestingPermissions {381 token_owner: true,382 collection_admin: false,383 restricted: None,384 #[cfg(feature = "runtime-benchmarks")]385 permissive: false,386 }),387 ..Default::default()388 }),389 ..Default::default()390 };391392 let unique_collection_id = Self::init_collection(393 T::CrossAccountId::from_sub(sender.clone()),394 data,395 [396 Self::encode_rmrk_property(Metadata, &metadata)?,397 Self::encode_rmrk_property(CollectionType, &misc::CollectionType::Regular)?,398 ]399 .into_iter(),400 )?;401 let rmrk_collection_id = <CollectionIndex<T>>::get();402403 <UniqueCollectionId<T>>::insert(rmrk_collection_id, unique_collection_id);404405 <PalletCommon<T>>::set_scoped_collection_property(406 unique_collection_id,407 RMRK_SCOPE,408 Self::encode_rmrk_property(RmrkInternalCollectionId, &rmrk_collection_id)?,409 )?;410411 <CollectionIndex<T>>::mutate(|n| *n += 1);412413 Self::deposit_event(Event::CollectionCreated {414 issuer: sender,415 collection_id: rmrk_collection_id,416 });417418 Ok(())419 }420421 /// Destroy a collection.422 ///423 /// Only empty collections can be destroyed. If it has any tokens, they must be burned first.424 ///425 /// # Permissions:426 /// * Collection issuer427 ///428 /// # Arguments:429 /// - `collection_id`: RMRK ID of the collection to destroy.430 #[transactional]431 #[pallet::weight(<SelfWeightOf<T>>::destroy_collection())]432 pub fn destroy_collection(433 origin: OriginFor<T>,434 collection_id: RmrkCollectionId,435 ) -> DispatchResult {436 let sender = ensure_signed(origin)?;437 let cross_sender = T::CrossAccountId::from_sub(sender.clone());438439 let collection = Self::get_typed_nft_collection(440 Self::unique_collection_id(collection_id)?,441 misc::CollectionType::Regular,442 )?;443 collection.check_is_external()?;444445 <PalletNft<T>>::destroy_collection(collection, &cross_sender)446 .map_err(Self::map_unique_err_to_proxy)?;447448 Self::deposit_event(Event::CollectionDestroyed {449 issuer: sender,450 collection_id,451 });452453 Ok(())454 }455456 /// Change the issuer of a collection. Analogous to Unique's collection's [`owner`](up_data_structs::Collection).457 ///458 /// # Permissions:459 /// * Collection issuer460 ///461 /// # Arguments:462 /// - `collection_id`: RMRK collection ID to change the issuer of.463 /// - `new_issuer`: Collection's new issuer.464 #[transactional]465 #[pallet::weight(<SelfWeightOf<T>>::change_collection_issuer())]466 pub fn change_collection_issuer(467 origin: OriginFor<T>,468 collection_id: RmrkCollectionId,469 new_issuer: <T::Lookup as StaticLookup>::Source,470 ) -> DispatchResult {471 let sender = ensure_signed(origin)?;472473 let collection = Self::get_nft_collection(Self::unique_collection_id(collection_id)?)?;474 collection.check_is_external()?;475476 let new_issuer = T::Lookup::lookup(new_issuer)?;477478 Self::change_collection_owner(479 Self::unique_collection_id(collection_id)?,480 misc::CollectionType::Regular,481 sender.clone(),482 new_issuer.clone(),483 )?;484485 Self::deposit_event(Event::IssuerChanged {486 old_issuer: sender,487 new_issuer,488 collection_id,489 });490491 Ok(())492 }493494 /// "Lock" the collection and prevent new token creation. Cannot be undone.495 ///496 /// # Permissions:497 /// * Collection issuer498 ///499 /// # Arguments:500 /// - `collection_id`: RMRK ID of the collection to lock.501 #[transactional]502 #[pallet::weight(<SelfWeightOf<T>>::lock_collection())]503 pub fn lock_collection(504 origin: OriginFor<T>,505 collection_id: RmrkCollectionId,506 ) -> DispatchResult {507 let sender = ensure_signed(origin)?;508 let cross_sender = T::CrossAccountId::from_sub(sender.clone());509510 let collection = Self::get_typed_nft_collection(511 Self::unique_collection_id(collection_id)?,512 misc::CollectionType::Regular,513 )?;514 collection.check_is_external()?;515516 Self::check_collection_owner(&collection, &cross_sender)?;517518 let token_count = collection.total_supply();519520 let mut collection = collection.into_inner();521 collection.limits.token_limit = Some(token_count);522 collection.save()?;523524 Self::deposit_event(Event::CollectionLocked {525 issuer: sender,526 collection_id,527 });528529 Ok(())530 }531532 /// Mint an NFT in a specified collection.533 ///534 /// # Permissions:535 /// * Collection issuer536 ///537 /// # Arguments:538 /// - `owner`: Owner account of the NFT. If set to None, defaults to the sender (collection issuer).539 /// - `collection_id`: RMRK collection ID for the NFT to be minted within. Cannot be changed.540 /// - `recipient`: Receiver account of the royalty. Has no effect if the `royalty_amount` is not set. Cannot be changed.541 /// - `royalty_amount`: Optional permillage reward from each trade for the `recipient`. Cannot be changed.542 /// - `metadata`: Arbitrary data about an NFT, e.g. IPFS hash. Cannot be changed.543 /// - `transferable`: Can this NFT be transferred? Cannot be changed.544 /// - `resources`: Resource data to be added to the NFT immediately after minting.545 #[transactional]546 #[pallet::weight(<SelfWeightOf<T>>::mint_nft(resources.as_ref().map(|r| r.len() as u32).unwrap_or(0)))]547 pub fn mint_nft(548 origin: OriginFor<T>,549 owner: Option<T::AccountId>,550 collection_id: RmrkCollectionId,551 recipient: Option<T::AccountId>,552 royalty_amount: Option<Permill>,553 metadata: RmrkString,554 transferable: bool,555 resources: Option<BoundedVec<RmrkResourceTypes, MaxResourcesOnMint>>,556 ) -> DispatchResult {557 let sender = ensure_signed(origin)?;558 let cross_sender = T::CrossAccountId::from_sub(sender.clone());559560 let owner = owner.unwrap_or(sender.clone());561 let cross_owner = T::CrossAccountId::from_sub(owner.clone());562563 let collection = Self::get_typed_nft_collection(564 Self::unique_collection_id(collection_id)?,565 misc::CollectionType::Regular,566 )?;567 collection.check_is_external()?;568569 let royalty_info = royalty_amount.map(|amount| rmrk_traits::RoyaltyInfo {570 recipient: recipient.unwrap_or_else(|| owner.clone()),571 amount,572 });573574 let nft_id = Self::create_nft(575 &cross_sender,576 &cross_owner,577 &collection,578 [579 Self::encode_rmrk_property(TokenType, &NftType::Regular)?,580 Self::encode_rmrk_property(Transferable, &transferable)?,581 Self::encode_rmrk_property(PendingNftAccept, &None::<PendingTarget>)?,582 Self::encode_rmrk_property(RoyaltyInfo, &royalty_info)?,583 Self::encode_rmrk_property(Metadata, &metadata)?,584 Self::encode_rmrk_property(Equipped, &false)?,585 Self::encode_rmrk_property(ResourcePriorities, &<Vec<u8>>::new())?,586 Self::encode_rmrk_property(NextResourceId, &(0 as RmrkResourceId))?,587 Self::encode_rmrk_property(PendingChildren, &PendingChildrenSet::new())?,588 Self::encode_rmrk_property(AssociatedBases, &BasesMap::new())?,589 ]590 .into_iter(),591 )592 .map_err(|err| match err {593 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailableNftId.into(),594 err => Self::map_unique_err_to_proxy(err),595 })?;596597 if let Some(resources) = resources {598 for resource in resources {599 Self::resource_add(sender.clone(), collection.id, nft_id, resource)?;600 }601 }602603 Self::deposit_event(Event::NftMinted {604 owner,605 collection_id,606 nft_id: nft_id.0,607 });608609 Ok(())610 }611612 /// Burn an NFT, destroying it and its nested tokens up to the specified limit.613 /// If the burning budget is exceeded, the transaction is reverted.614 ///615 /// This is the way to burn a nested token as well.616 ///617 /// For more information, see [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively).618 ///619 /// # Permissions:620 /// * Token owner621 ///622 /// # Arguments:623 /// - `collection_id`: RMRK ID of the collection in which the NFT to burn belongs to.624 /// - `nft_id`: ID of the NFT to be destroyed.625 /// - `max_burns`: Maximum number of tokens to burn, assuming nesting. The transaction626 /// is reverted if there are more tokens to burn in the nesting tree than this number.627 /// This is primarily a mechanism of transaction weight control.628 #[transactional]629 #[pallet::weight(<SelfWeightOf<T>>::burn_nft(*max_burns))]630 pub fn burn_nft(631 origin: OriginFor<T>,632 collection_id: RmrkCollectionId,633 nft_id: RmrkNftId,634 max_burns: u32,635 ) -> DispatchResult {636 let sender = ensure_signed(origin)?;637 let cross_sender = T::CrossAccountId::from_sub(sender.clone());638639 let collection = Self::get_typed_nft_collection(640 Self::unique_collection_id(collection_id)?,641 misc::CollectionType::Regular,642 )?;643 collection.check_is_external()?;644645 Self::destroy_nft(646 cross_sender,647 Self::unique_collection_id(collection_id)?,648 nft_id.into(),649 max_burns,650 <Error<T>>::NoPermission,651 )652 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;653654 Self::deposit_event(Event::NFTBurned {655 owner: sender,656 nft_id,657 });658659 Ok(())660 }661662 /// Transfer an NFT from an account/NFT A to another account/NFT B.663 /// The token must be transferable. Nesting cannot occur deeper than the [`NESTING_BUDGET`].664 ///665 /// If the target owner is an NFT owned by another account, then the NFT will enter666 /// the pending state and will have to be accepted by the other account.667 ///668 /// # Permissions:669 /// - Token owner670 ///671 /// # Arguments:672 /// - `collection_id`: RMRK ID of the collection of the NFT to be transferred.673 /// - `nft_id`: ID of the NFT to be transferred.674 /// - `new_owner`: New owner of the nft which can be either an account or a NFT.675 #[transactional]676 #[pallet::weight(<SelfWeightOf<T>>::send())]677 pub fn send(678 origin: OriginFor<T>,679 rmrk_collection_id: RmrkCollectionId,680 rmrk_nft_id: RmrkNftId,681 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,682 ) -> DispatchResult {683 let sender = ensure_signed(origin.clone())?;684 let cross_sender = T::CrossAccountId::from_sub(sender.clone());685686 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;687 let nft_id = rmrk_nft_id.into();688689 let collection =690 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;691 collection.check_is_external()?;692693 let token_data =694 <TokenData<T>>::get((collection_id, nft_id)).ok_or(<Error<T>>::NoAvailableNftId)?;695696 let from = token_data.owner;697698 ensure!(699 Self::get_nft_property_decoded(collection_id, nft_id, RmrkProperty::Transferable)?,700 <Error<T>>::NonTransferable701 );702703 ensure!(704 Self::get_nft_property_decoded::<Option<PendingTarget>>(705 collection_id,706 nft_id,707 RmrkProperty::PendingNftAccept708 )?709 .is_none(),710 <Error<T>>::NoPermission711 );712713 let target_owner;714 let approval_required;715716 match new_owner {717 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {718 target_owner = T::CrossAccountId::from_sub(account_id.clone());719 approval_required = false;720 }721 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(722 target_collection_id,723 target_nft_id,724 ) => {725 let target_collection_id = Self::unique_collection_id(target_collection_id)?;726727 let target_nft_budget = budget::Value::new(NESTING_BUDGET);728729 let target_nft_owner = <PalletStructure<T>>::get_checked_topmost_owner(730 target_collection_id,731 target_nft_id.into(),732 Some((collection_id, nft_id)),733 &target_nft_budget,734 )735 .map_err(Self::map_unique_err_to_proxy)?;736737 approval_required = cross_sender != target_nft_owner;738739 if approval_required {740 target_owner = target_nft_owner;741742 <PalletNft<T>>::set_scoped_token_property(743 collection.id,744 nft_id,745 RMRK_SCOPE,746 Self::encode_rmrk_property::<Option<PendingTarget>>(747 PendingNftAccept,748 &Some((target_collection_id, target_nft_id.into())),749 )?,750 )?;751752 Self::insert_pending_child(753 (target_collection_id, target_nft_id.into()),754 (rmrk_collection_id, rmrk_nft_id),755 )?;756 } else {757 target_owner = T::CrossTokenAddressMapping::token_to_address(758 target_collection_id,759 target_nft_id.into(),760 );761 }762 }763 }764765 let src_nft_budget = budget::Value::new(NESTING_BUDGET);766767 <PalletNft<T>>::transfer_from(768 &collection,769 &cross_sender,770 &from,771 &target_owner,772 nft_id,773 &src_nft_budget,774 )775 .map_err(Self::map_unique_err_to_proxy)?;776777 Self::deposit_event(Event::NFTSent {778 sender,779 recipient: new_owner,780 collection_id: rmrk_collection_id,781 nft_id: rmrk_nft_id,782 approval_required,783 });784785 Ok(())786 }787788 /// Accept an NFT sent from another account to self or an owned NFT.789 ///790 /// The NFT in question must be pending, and, thus, be [sent](`Pallet::send`) first.791 ///792 /// # Permissions:793 /// - Token-owner-to-be794 ///795 /// # Arguments:796 /// - `rmrk_collection_id`: RMRK collection ID of the NFT to be accepted.797 /// - `rmrk_nft_id`: ID of the NFT to be accepted.798 /// - `new_owner`: Either the sender's account ID or a sender-owned NFT,799 /// whichever the accepted NFT was sent to.800 #[transactional]801 #[pallet::weight(<SelfWeightOf<T>>::accept_nft())]802 pub fn accept_nft(803 origin: OriginFor<T>,804 rmrk_collection_id: RmrkCollectionId,805 rmrk_nft_id: RmrkNftId,806 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,807 ) -> DispatchResult {808 let sender = ensure_signed(origin.clone())?;809 let cross_sender = T::CrossAccountId::from_sub(sender.clone());810811 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;812 let nft_id = rmrk_nft_id.into();813814 let collection =815 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;816 collection.check_is_external()?;817818 let new_cross_owner = match new_owner {819 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {820 T::CrossAccountId::from_sub(account_id.clone())821 }822 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(823 target_collection_id,824 target_nft_id,825 ) => {826 let target_collection_id = Self::unique_collection_id(target_collection_id)?;827828 T::CrossTokenAddressMapping::token_to_address(829 target_collection_id,830 TokenId(target_nft_id),831 )832 }833 };834835 let budget = budget::Value::new(NESTING_BUDGET);836837 <PalletNft<T>>::transfer(838 &collection,839 &cross_sender,840 &new_cross_owner,841 nft_id,842 &budget,843 )844 .map_err(|err| {845 if err == <CommonError<T>>::UserIsNotAllowedToNest.into() {846 <Error<T>>::CannotAcceptNonOwnedNft.into()847 } else {848 Self::map_unique_err_to_proxy(err)849 }850 })?;851852 let pending_target = Self::get_nft_property_decoded::<Option<PendingTarget>>(853 collection_id,854 nft_id,855 RmrkProperty::PendingNftAccept,856 )?;857858 if let Some(pending_target) = pending_target {859 Self::remove_pending_child(pending_target, (rmrk_collection_id, rmrk_nft_id))?;860861 <PalletNft<T>>::set_scoped_token_property(862 collection.id,863 nft_id,864 RMRK_SCOPE,865 Self::encode_rmrk_property(PendingNftAccept, &None::<PendingTarget>)?,866 )?;867 }868869 Self::deposit_event(Event::NFTAccepted {870 sender,871 recipient: new_owner,872 collection_id: rmrk_collection_id,873 nft_id: rmrk_nft_id,874 });875876 Ok(())877 }878879 /// Reject an NFT sent from another account to self or owned NFT.880 /// The NFT in question will not be sent back and burnt instead.881 ///882 /// The NFT in question must be pending, and, thus, be [sent](`Pallet::send`) first.883 ///884 /// # Permissions:885 /// - Token-owner-to-be-not886 ///887 /// # Arguments:888 /// - `rmrk_collection_id`: RMRK ID of the NFT to be rejected.889 /// - `rmrk_nft_id`: ID of the NFT to be rejected.890 #[transactional]891 #[pallet::weight(<SelfWeightOf<T>>::reject_nft())]892 pub fn reject_nft(893 origin: OriginFor<T>,894 rmrk_collection_id: RmrkCollectionId,895 rmrk_nft_id: RmrkNftId,896 ) -> DispatchResult {897 let sender = ensure_signed(origin)?;898 let cross_sender = T::CrossAccountId::from_sub(sender.clone());899900 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;901 let nft_id = rmrk_nft_id.into();902903 let collection =904 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;905 collection.check_is_external()?;906907 ensure!(908 <TokenData<T>>::get((collection_id, nft_id)).is_some(),909 <Error<T>>::NoAvailableNftId910 );911912 let pending_target = Self::get_nft_property_decoded::<Option<PendingTarget>>(913 collection_id,914 nft_id,915 RmrkProperty::PendingNftAccept,916 )?;917918 match pending_target {919 Some(pending_target) => {920 Self::remove_pending_child(pending_target, (rmrk_collection_id, rmrk_nft_id))?921 }922 None => return Err(<Error<T>>::CannotRejectNonPendingNft.into()),923 }924925 Self::destroy_nft(926 cross_sender,927 collection_id,928 nft_id,929 NESTING_BUDGET,930 <Error<T>>::CannotRejectNonOwnedNft,931 )932 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;933934 Self::deposit_event(Event::NFTRejected {935 sender,936 collection_id: rmrk_collection_id,937 nft_id: rmrk_nft_id,938 });939940 Ok(())941 }942943 /// Accept the addition of a newly created pending resource to an existing NFT.944 ///945 /// This transaction is needed when a resource is created and assigned to an NFT946 /// by a non-owner, i.e. the collection issuer, with one of the947 /// [`add_...` transactions](Pallet::add_basic_resource).948 ///949 /// # Permissions:950 /// - Token owner951 ///952 /// # Arguments:953 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.954 /// - `rmrk_nft_id`: ID of the NFT with a pending resource to be accepted.955 /// - `resource_id`: ID of the newly created pending resource.956 #[transactional]957 #[pallet::weight(<SelfWeightOf<T>>::accept_resource())]958 pub fn accept_resource(959 origin: OriginFor<T>,960 rmrk_collection_id: RmrkCollectionId,961 rmrk_nft_id: RmrkNftId,962 resource_id: RmrkResourceId,963 ) -> DispatchResult {964 let sender = ensure_signed(origin)?;965 let cross_sender = T::CrossAccountId::from_sub(sender);966967 let collection_id = Self::unique_collection_id(rmrk_collection_id)968 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;969 let collection =970 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;971 collection.check_is_external()?;972973 let nft_id = rmrk_nft_id.into();974975 let budget = budget::Value::new(NESTING_BUDGET);976977 let nft_owner =978 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)979 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;980981 Self::try_mutate_resource_info(collection_id, nft_id, resource_id, |res| {982 ensure!(res.pending, <Error<T>>::ResourceNotPending);983 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);984985 res.pending = false;986987 Ok(())988 })?;989990 Self::deposit_event(Event::<T>::ResourceAccepted {991 nft_id: rmrk_nft_id,992 resource_id,993 });994995 Ok(())996 }997998 /// Accept the removal of a removal-pending resource from an NFT.999 ///1000 /// This transaction is needed when a non-owner, i.e. the collection issuer,1001 /// requests a [removal](`Pallet::remove_resource`) of a resource from an NFT.1002 ///1003 /// # Permissions:1004 /// - Token owner1005 ///1006 /// # Arguments:1007 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1008 /// - `rmrk_nft_id`: ID of the NFT with a resource to be removed.1009 /// - `resource_id`: ID of the removal-pending resource.1010 #[transactional]1011 #[pallet::weight(<SelfWeightOf<T>>::accept_resource_removal())]1012 pub fn accept_resource_removal(1013 origin: OriginFor<T>,1014 rmrk_collection_id: RmrkCollectionId,1015 rmrk_nft_id: RmrkNftId,1016 resource_id: RmrkResourceId,1017 ) -> DispatchResult {1018 let sender = ensure_signed(origin)?;1019 let cross_sender = T::CrossAccountId::from_sub(sender);10201021 let collection_id = Self::unique_collection_id(rmrk_collection_id)1022 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;1023 let collection =1024 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1025 collection.check_is_external()?;10261027 let nft_id = rmrk_nft_id.into();10281029 let budget = budget::Value::new(NESTING_BUDGET);10301031 let nft_owner =1032 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)1033 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;10341035 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);10361037 let resource_id_key = Self::get_scoped_property_key(ResourceId(resource_id))?;10381039 let resource_info = <PalletNft<T>>::token_aux_property((1040 collection_id,1041 nft_id,1042 RMRK_SCOPE,1043 resource_id_key.clone(),1044 ))1045 .ok_or(<Error<T>>::ResourceDoesntExist)?;10461047 let resource_info: RmrkResourceInfo = Self::decode_property_value(&resource_info)?;10481049 ensure!(1050 resource_info.pending_removal,1051 <Error<T>>::ResourceNotPending1052 );10531054 <PalletNft<T>>::remove_token_aux_property(1055 collection_id,1056 nft_id,1057 RMRK_SCOPE,1058 resource_id_key,1059 );10601061 if let RmrkResourceTypes::Composable(resource) = resource_info.resource {1062 let base_id = resource.base;10631064 Self::remove_associated_base_id(collection_id, nft_id, base_id)?;1065 }10661067 Self::deposit_event(Event::<T>::ResourceRemovalAccepted {1068 nft_id: rmrk_nft_id,1069 resource_id,1070 });10711072 Ok(())1073 }10741075 /// Add or edit a custom user property, a key-value pair, describing the metadata1076 /// of a token or a collection, on either one of these.1077 ///1078 /// Note that in this proxy implementation many details regarding RMRK are stored1079 /// as scoped properties prefixed with "rmrk:", normally inaccessible1080 /// to external transactions and RPCs.1081 ///1082 /// # Permissions:1083 /// - Collection issuer - in case of collection property1084 /// - Token owner - in case of NFT property1085 ///1086 /// # Arguments:1087 /// - `rmrk_collection_id`: RMRK collection ID.1088 /// - `maybe_nft_id`: Optional ID of the NFT. If left empty, then the property is set for the collection.1089 /// - `key`: Key of the custom property to be referenced by.1090 /// - `value`: Value of the custom property to be stored.1091 #[transactional]1092 #[pallet::weight(<SelfWeightOf<T>>::set_property())]1093 pub fn set_property(1094 origin: OriginFor<T>,1095 #[pallet::compact] rmrk_collection_id: RmrkCollectionId,1096 maybe_nft_id: Option<RmrkNftId>,1097 key: RmrkKeyString,1098 value: RmrkValueString,1099 ) -> DispatchResult {1100 let sender = ensure_signed(origin)?;1101 let sender = T::CrossAccountId::from_sub(sender);11021103 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1104 let collection =1105 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1106 collection.check_is_external()?;11071108 let budget = budget::Value::new(NESTING_BUDGET);11091110 match maybe_nft_id {1111 Some(nft_id) => {1112 let token_id: TokenId = nft_id.into();11131114 Self::ensure_nft_type(collection_id, token_id, NftType::Regular)?;1115 Self::ensure_nft_owner(collection_id, token_id, &sender, &budget)?;11161117 <PalletNft<T>>::set_scoped_token_property(1118 collection_id,1119 token_id,1120 RMRK_SCOPE,1121 Self::encode_rmrk_property(UserProperty(key.as_slice()), &value)?,1122 )?;1123 }1124 None => {1125 let collection = Self::get_typed_nft_collection(1126 collection_id,1127 misc::CollectionType::Regular,1128 )?;11291130 Self::check_collection_owner(&collection, &sender)?;11311132 <PalletCommon<T>>::set_scoped_collection_property(1133 collection_id,1134 RMRK_SCOPE,1135 Self::encode_rmrk_property(UserProperty(key.as_slice()), &value)?,1136 )?;1137 }1138 }11391140 Self::deposit_event(Event::PropertySet {1141 collection_id: rmrk_collection_id,1142 maybe_nft_id,1143 key,1144 value,1145 });11461147 Ok(())1148 }11491150 /// Set a different order of resource priorities for an NFT. Priorities can be used,1151 /// for example, for order of rendering.1152 ///1153 /// Note that the priorities are not updated automatically, and are an empty vector1154 /// by default. There is no pre-set definition for the order to be particular,1155 /// it can be interpreted arbitrarily use-case by use-case.1156 ///1157 /// # Permissions:1158 /// - Token owner1159 ///1160 /// # Arguments:1161 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1162 /// - `rmrk_nft_id`: ID of the NFT to rearrange resource priorities for.1163 /// - `priorities`: Ordered vector of resource IDs.1164 #[transactional]1165 #[pallet::weight(<SelfWeightOf<T>>::set_priority())]1166 pub fn set_priority(1167 origin: OriginFor<T>,1168 rmrk_collection_id: RmrkCollectionId,1169 rmrk_nft_id: RmrkNftId,1170 priorities: BoundedVec<RmrkResourceId, RmrkMaxPriorities>,1171 ) -> DispatchResult {1172 let sender = ensure_signed(origin)?;1173 let sender = T::CrossAccountId::from_sub(sender);11741175 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1176 let nft_id = rmrk_nft_id.into();11771178 let collection =1179 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1180 collection.check_is_external()?;11811182 let budget = budget::Value::new(NESTING_BUDGET);11831184 Self::ensure_nft_type(collection_id, nft_id, NftType::Regular)?;1185 Self::ensure_nft_owner(collection_id, nft_id, &sender, &budget)?;11861187 <PalletNft<T>>::set_scoped_token_property(1188 collection_id,1189 nft_id,1190 RMRK_SCOPE,1191 Self::encode_rmrk_property(ResourcePriorities, &priorities.into_inner())?,1192 )?;11931194 Self::deposit_event(Event::<T>::PrioritySet {1195 collection_id: rmrk_collection_id,1196 nft_id: rmrk_nft_id,1197 });11981199 Ok(())1200 }12011202 /// Create and set/propose a basic resource for an NFT.1203 ///1204 /// A basic resource is the simplest, lacking a Base and anything that comes with it.1205 /// See RMRK docs for more information and examples.1206 ///1207 /// # Permissions:1208 /// - Collection issuer - if not the token owner, adding the resource will warrant1209 /// the owner's [acceptance](Pallet::accept_resource).1210 ///1211 /// # Arguments:1212 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1213 /// - `nft_id`: ID of the NFT to assign a resource to.1214 /// - `resource`: Data of the resource to be created.1215 #[transactional]1216 #[pallet::weight(<SelfWeightOf<T>>::add_basic_resource())]1217 pub fn add_basic_resource(1218 origin: OriginFor<T>,1219 rmrk_collection_id: RmrkCollectionId,1220 nft_id: RmrkNftId,1221 resource: RmrkBasicResource,1222 ) -> DispatchResult {1223 let sender = ensure_signed(origin.clone())?;12241225 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1226 let collection =1227 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1228 collection.check_is_external()?;12291230 let resource_id = Self::resource_add(1231 sender,1232 collection_id,1233 nft_id.into(),1234 RmrkResourceTypes::Basic(resource),1235 )?;12361237 Self::deposit_event(Event::ResourceAdded {1238 nft_id,1239 resource_id,1240 });1241 Ok(())1242 }12431244 /// Create and set/propose a composable resource for an NFT.1245 ///1246 /// A composable resource links to a Base and has a subset of its Parts it is composed of.1247 /// See RMRK docs for more information and examples.1248 ///1249 /// # Permissions:1250 /// - Collection issuer - if not the token owner, adding the resource will warrant1251 /// the owner's [acceptance](Pallet::accept_resource).1252 ///1253 /// # Arguments:1254 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1255 /// - `nft_id`: ID of the NFT to assign a resource to.1256 /// - `resource`: Data of the resource to be created.1257 #[transactional]1258 #[pallet::weight(<SelfWeightOf<T>>::add_composable_resource())]1259 pub fn add_composable_resource(1260 origin: OriginFor<T>,1261 rmrk_collection_id: RmrkCollectionId,1262 nft_id: RmrkNftId,1263 resource: RmrkComposableResource,1264 ) -> DispatchResult {1265 let sender = ensure_signed(origin.clone())?;12661267 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1268 let collection =1269 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1270 collection.check_is_external()?;12711272 let base_id = resource.base;12731274 let resource_id = Self::resource_add(1275 sender,1276 collection_id,1277 nft_id.into(),1278 RmrkResourceTypes::Composable(resource),1279 )?;12801281 <PalletNft<T>>::try_mutate_token_aux_property(1282 collection_id,1283 nft_id.into(),1284 RMRK_SCOPE,1285 Self::get_scoped_property_key(AssociatedBases)?,1286 |value| -> DispatchResult {1287 let mut bases: BasesMap = match value {1288 Some(value) => Self::decode_property_value(value)?,1289 None => BasesMap::new(),1290 };12911292 *bases.entry(base_id).or_insert(0) += 1;12931294 *value = Some(Self::encode_property_value(&bases)?);1295 Ok(())1296 },1297 )?;12981299 Self::deposit_event(Event::ResourceAdded {1300 nft_id,1301 resource_id,1302 });1303 Ok(())1304 }13051306 /// Create and set/propose a slot resource for an NFT.1307 ///1308 /// A slot resource links to a Base and a slot ID in it which it can fit into.1309 /// See RMRK docs for more information and examples.1310 ///1311 /// # Permissions:1312 /// - Collection issuer - if not the token owner, adding the resource will warrant1313 /// the owner's [acceptance](Pallet::accept_resource).1314 ///1315 /// # Arguments:1316 /// - `rmrk_collection_id`: RMRK collection ID of the NFT.1317 /// - `nft_id`: ID of the NFT to assign a resource to.1318 /// - `resource`: Data of the resource to be created.1319 #[transactional]1320 #[pallet::weight(<SelfWeightOf<T>>::add_slot_resource())]1321 pub fn add_slot_resource(1322 origin: OriginFor<T>,1323 rmrk_collection_id: RmrkCollectionId,1324 nft_id: RmrkNftId,1325 resource: RmrkSlotResource,1326 ) -> DispatchResult {1327 let sender = ensure_signed(origin.clone())?;13281329 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1330 let collection =1331 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1332 collection.check_is_external()?;13331334 let resource_id = Self::resource_add(1335 sender,1336 collection_id,1337 nft_id.into(),1338 RmrkResourceTypes::Slot(resource),1339 )?;13401341 Self::deposit_event(Event::ResourceAdded {1342 nft_id,1343 resource_id,1344 });1345 Ok(())1346 }13471348 /// Remove and erase a resource from an NFT.1349 ///1350 /// If the sender does not own the NFT, then it will be pending confirmation,1351 /// and will have to be [accepted](Pallet::accept_resource_removal) by the token owner.1352 ///1353 /// # Permissions1354 /// - Collection issuer1355 ///1356 /// # Arguments1357 /// - `collection_id`: RMRK ID of a collection to which the NFT making use of the resource belongs to.1358 /// - `nft_id`: ID of the NFT with a resource to be removed.1359 /// - `resource_id`: ID of the resource to be removed.1360 #[transactional]1361 #[pallet::weight(<SelfWeightOf<T>>::remove_resource())]1362 pub fn remove_resource(1363 origin: OriginFor<T>,1364 rmrk_collection_id: RmrkCollectionId,1365 nft_id: RmrkNftId,1366 resource_id: RmrkResourceId,1367 ) -> DispatchResult {1368 let sender = ensure_signed(origin.clone())?;13691370 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1371 let collection =1372 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1373 collection.check_is_external()?;13741375 Self::resource_remove(sender, collection_id, nft_id.into(), resource_id)?;13761377 Self::deposit_event(Event::ResourceRemoval {1378 nft_id,1379 resource_id,1380 });1381 Ok(())1382 }1383 }1384}13851386impl<T: Config> Pallet<T> {1387 /// Transform one of possible RMRK keys into a byte key with a RMRK scope.1388 pub fn get_scoped_property_key(rmrk_key: RmrkProperty) -> Result<PropertyKey, DispatchError> {1389 let key = rmrk_key.to_key::<T>()?;13901391 let scoped_key = RMRK_SCOPE1392 .apply(key)1393 .map_err(|_| <Error<T>>::RmrkPropertyKeyIsTooLong)?;13941395 Ok(scoped_key)1396 }13971398 /// Form a Unique property, transforming a RMRK key into bytes (without assigning the scope yet)1399 /// and encoding the value from an arbitrary type into bytes.1400 pub fn encode_rmrk_property<E: Encode>(1401 rmrk_key: RmrkProperty,1402 value: &E,1403 ) -> Result<Property, DispatchError> {1404 let key = rmrk_key.to_key::<T>()?;14051406 let value = Self::encode_property_value(value)?;14071408 let property = Property { key, value };14091410 Ok(property)1411 }14121413 /// Encode property value from an arbitrary type into bytes for storage.1414 pub fn encode_property_value<E: Encode, S: Get<u32>>(1415 value: &E,1416 ) -> Result<BoundedBytes<S>, DispatchError> {1417 let value = value1418 .encode()1419 .try_into()1420 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong)?;14211422 Ok(value)1423 }14241425 /// Decode property value from bytes into an arbitrary type.1426 pub fn decode_property_value<D: Decode, S: Get<u32>>(1427 vec: &BoundedBytes<S>,1428 ) -> Result<D, DispatchError> {1429 vec.decode()1430 .map_err(|_| <Error<T>>::UnableToDecodeRmrkData.into())1431 }14321433 /// Change the limit of a property value byte vector.1434 pub fn rebind<L, S>(vec: &BoundedVec<u8, L>) -> Result<BoundedVec<u8, S>, DispatchError>1435 where1436 BoundedVec<u8, S>: TryFrom<Vec<u8>>,1437 {1438 vec.rebind()1439 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong.into())1440 }14411442 /// Initialize a new NFT collection with certain RMRK-scoped properties.1443 ///1444 /// See [`init_collection`](pallet_nonfungible::pallet::Pallet::init_collection) for more details.1445 fn init_collection(1446 sender: T::CrossAccountId,1447 data: CreateCollectionData<T::AccountId>,1448 properties: impl Iterator<Item = Property>,1449 ) -> Result<CollectionId, DispatchError> {1450 let collection_id = <PalletNft<T>>::init_collection(sender, data, true);14511452 if let Err(DispatchError::Arithmetic(_)) = &collection_id {1453 return Err(<Error<T>>::NoAvailableCollectionId.into());1454 }14551456 <PalletCommon<T>>::set_scoped_collection_properties(1457 collection_id?,1458 RMRK_SCOPE,1459 properties,1460 )?;14611462 collection_id1463 }14641465 /// Mint a new NFT with certain RMRK-scoped properties. Sender must be the collection owner.1466 ///1467 /// See [`create_item`](pallet_nonfungible::pallet::Pallet::create_item) for more details.1468 pub fn create_nft(1469 sender: &T::CrossAccountId,1470 owner: &T::CrossAccountId,1471 collection: &NonfungibleHandle<T>,1472 properties: impl Iterator<Item = Property>,1473 ) -> Result<TokenId, DispatchError> {1474 let data = CreateNftExData {1475 properties: BoundedVec::default(),1476 owner: owner.clone(),1477 };14781479 let budget = budget::Value::new(NESTING_BUDGET);14801481 <PalletNft<T>>::create_item(collection, sender, data, &budget)?;14821483 let nft_id = <PalletNft<T>>::current_token_id(collection.id);14841485 <PalletNft<T>>::set_scoped_token_properties(collection.id, nft_id, RMRK_SCOPE, properties)?;14861487 Ok(nft_id)1488 }14891490 /// Burn an NFT, along with its nested children, limited by `max_burns`. The sender must be the token owner.1491 ///1492 /// See [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively) for more details.1493 fn destroy_nft(1494 sender: T::CrossAccountId,1495 collection_id: CollectionId,1496 token_id: TokenId,1497 max_burns: u32,1498 error_if_not_owned: Error<T>,1499 ) -> DispatchResultWithPostInfo {1500 let collection =1501 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;15021503 let token_data =1504 <TokenData<T>>::get((collection_id, token_id)).ok_or(<Error<T>>::NoAvailableNftId)?;15051506 let from = token_data.owner;15071508 let owner_check_budget = budget::Value::new(NESTING_BUDGET);15091510 ensure!(1511 <PalletStructure<T>>::check_indirectly_owned(1512 sender.clone(),1513 collection_id,1514 token_id,1515 None,1516 &owner_check_budget1517 )?,1518 error_if_not_owned,1519 );15201521 let burns_budget = budget::Value::new(max_burns);1522 let breadth_budget = budget::Value::new(max_burns);15231524 <PalletNft<T>>::burn_recursively(1525 &collection,1526 &from,1527 token_id,1528 &burns_budget,1529 &breadth_budget,1530 )1531 }15321533 /// Add a sent token pending acceptance to the target owning token as a property.1534 fn insert_pending_child(1535 target: (CollectionId, TokenId),1536 child: (RmrkCollectionId, RmrkNftId),1537 ) -> DispatchResult {1538 Self::mutate_pending_children(target, |pending_children| {1539 pending_children.insert(child);1540 })1541 }15421543 /// Remove a sent token pending acceptance from the target token's properties.1544 fn remove_pending_child(1545 target: (CollectionId, TokenId),1546 child: (RmrkCollectionId, RmrkNftId),1547 ) -> DispatchResult {1548 Self::mutate_pending_children(target, |pending_children| {1549 pending_children.remove(&child);1550 })1551 }15521553 /// Apply a mutation to the property of a token containing sent tokens1554 /// that are currently pending acceptance.1555 fn mutate_pending_children(1556 (target_collection_id, target_nft_id): (CollectionId, TokenId),1557 f: impl FnOnce(&mut PendingChildrenSet),1558 ) -> DispatchResult {1559 <PalletNft<T>>::try_mutate_token_aux_property(1560 target_collection_id,1561 target_nft_id,1562 RMRK_SCOPE,1563 Self::get_scoped_property_key(PendingChildren)?,1564 |pending_children| -> DispatchResult {1565 let mut map = match pending_children {1566 Some(map) => Self::decode_property_value(map)?,1567 None => PendingChildrenSet::new(),1568 };15691570 f(&mut map);15711572 *pending_children = Some(Self::encode_property_value(&map)?);15731574 Ok(())1575 },1576 )1577 }15781579 /// Get an iterator from a token's property containing tokens sent to it1580 /// that are currently pending acceptance.1581 fn iterate_pending_children(1582 collection_id: CollectionId,1583 nft_id: TokenId,1584 ) -> Result<impl Iterator<Item = PendingChild>, DispatchError> {1585 let property = <PalletNft<T>>::token_aux_property((1586 collection_id,1587 nft_id,1588 RMRK_SCOPE,1589 Self::get_scoped_property_key(PendingChildren)?,1590 ));15911592 let pending_children = match property {1593 Some(map) => Self::decode_property_value(&map)?,1594 None => PendingChildrenSet::new(),1595 };15961597 Ok(pending_children.into_iter())1598 }15991600 /// Get incremented resource ID from within an NFT's properties and store the new latest ID.1601 /// Thus, the returned resource ID should be used.1602 ///1603 /// Resource IDs are unique only across an NFT.1604 fn acquire_next_resource_id(1605 collection_id: CollectionId,1606 nft_id: TokenId,1607 ) -> Result<RmrkResourceId, DispatchError> {1608 let resource_id: RmrkResourceId =1609 Self::get_nft_property_decoded(collection_id, nft_id, NextResourceId)?;16101611 let next_id = resource_id1612 .checked_add(1)1613 .ok_or(<Error<T>>::NoAvailableResourceId)?;16141615 <PalletNft<T>>::set_scoped_token_property(1616 collection_id,1617 nft_id,1618 RMRK_SCOPE,1619 Self::encode_rmrk_property(NextResourceId, &next_id)?,1620 )?;16211622 Ok(resource_id)1623 }16241625 /// Create and add a resource for a regular NFT, mark it as pending if the sender1626 /// is not the token owner. The sender must be the collection owner.1627 fn resource_add(1628 sender: T::AccountId,1629 collection_id: CollectionId,1630 nft_id: TokenId,1631 resource: RmrkResourceTypes,1632 ) -> Result<RmrkResourceId, DispatchError> {1633 let collection =1634 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1635 ensure!(collection.owner == sender, Error::<T>::NoPermission);16361637 let sender = T::CrossAccountId::from_sub(sender);1638 let budget = budget::Value::new(NESTING_BUDGET);16391640 let nft_owner = <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)1641 .map_err(Self::map_unique_err_to_proxy)?;16421643 let pending = sender != nft_owner;16441645 let id = Self::acquire_next_resource_id(collection_id, nft_id)?;16461647 let resource_info = RmrkResourceInfo {1648 id,1649 resource,1650 pending,1651 pending_removal: false,1652 };16531654 <PalletNft<T>>::try_mutate_token_aux_property(1655 collection_id,1656 nft_id,1657 RMRK_SCOPE,1658 Self::get_scoped_property_key(ResourceId(id))?,1659 |value| -> DispatchResult {1660 *value = Some(Self::encode_property_value(&resource_info)?);16611662 Ok(())1663 },1664 )?;16651666 Ok(id)1667 }16681669 /// Designate a resource for erasure from an NFT, and remove it if the sender is the token owner.1670 /// The sender must be the collection owner.1671 fn resource_remove(1672 sender: T::AccountId,1673 collection_id: CollectionId,1674 nft_id: TokenId,1675 resource_id: RmrkResourceId,1676 ) -> DispatchResult {1677 let collection =1678 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1679 ensure!(collection.owner == sender, Error::<T>::NoPermission);16801681 let resource_id_key = Self::get_scoped_property_key(ResourceId(resource_id))?;16821683 let resource = <PalletNft<T>>::token_aux_property((1684 collection_id,1685 nft_id,1686 RMRK_SCOPE,1687 resource_id_key.clone(),1688 ))1689 .ok_or(<Error<T>>::ResourceDoesntExist)?;16901691 let resource_info: RmrkResourceInfo = Self::decode_property_value(&resource)?;16921693 let budget = up_data_structs::budget::Value::new(NESTING_BUDGET);1694 let topmost_owner =1695 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)?;16961697 let sender = T::CrossAccountId::from_sub(sender);1698 if topmost_owner == sender {1699 <PalletNft<T>>::remove_token_aux_property(1700 collection_id,1701 nft_id,1702 RMRK_SCOPE,1703 Self::get_scoped_property_key(ResourceId(resource_id))?,1704 );17051706 if let RmrkResourceTypes::Composable(resource) = resource_info.resource {1707 let base_id = resource.base;17081709 Self::remove_associated_base_id(collection_id, nft_id, base_id)?;1710 }1711 } else {1712 Self::try_mutate_resource_info(collection_id, nft_id, resource_id, |res| {1713 res.pending_removal = true;17141715 Ok(())1716 })?;1717 }17181719 Ok(())1720 }17211722 /// Remove a Base ID from an NFT if they are associated.1723 /// The Base itself is deleted if the number of associated NFTs reaches 0.1724 fn remove_associated_base_id(1725 collection_id: CollectionId,1726 nft_id: TokenId,1727 base_id: RmrkBaseId,1728 ) -> DispatchResult {1729 <PalletNft<T>>::try_mutate_token_aux_property(1730 collection_id,1731 nft_id,1732 RMRK_SCOPE,1733 Self::get_scoped_property_key(AssociatedBases)?,1734 |value| -> DispatchResult {1735 let mut bases: BasesMap = match value {1736 Some(value) => Self::decode_property_value(value)?,1737 None => BasesMap::new(),1738 };17391740 let remaining = bases.get(&base_id);17411742 if let Some(remaining) = remaining {1743 if let Some(0) | None = remaining.checked_sub(1) {1744 bases.remove(&base_id);1745 }1746 }17471748 *value = Some(Self::encode_property_value(&bases)?);1749 Ok(())1750 },1751 )1752 }17531754 /// Apply a mutation to a resource stored in the token properties of an NFT.1755 fn try_mutate_resource_info(1756 collection_id: CollectionId,1757 nft_id: TokenId,1758 resource_id: RmrkResourceId,1759 f: impl FnOnce(&mut RmrkResourceInfo) -> DispatchResult,1760 ) -> DispatchResult {1761 <PalletNft<T>>::try_mutate_token_aux_property(1762 collection_id,1763 nft_id,1764 RMRK_SCOPE,1765 Self::get_scoped_property_key(ResourceId(resource_id))?,1766 |value| match value {1767 Some(value) => {1768 let mut resource_info: RmrkResourceInfo = Self::decode_property_value(value)?;17691770 f(&mut resource_info)?;17711772 *value = Self::encode_property_value(&resource_info)?;17731774 Ok(())1775 }1776 None => Err(<Error<T>>::ResourceDoesntExist.into()),1777 },1778 )1779 }17801781 /// Change the owner of an NFT collection, ensuring that the sender is the current owner.1782 fn change_collection_owner(1783 collection_id: CollectionId,1784 collection_type: misc::CollectionType,1785 sender: T::AccountId,1786 new_owner: T::AccountId,1787 ) -> DispatchResult {1788 let collection = Self::get_typed_nft_collection(collection_id, collection_type)?;1789 Self::check_collection_owner(&collection, &T::CrossAccountId::from_sub(sender))?;17901791 let mut collection = collection.into_inner();17921793 collection.owner = new_owner;1794 collection.save()1795 }17961797 /// Ensure that an account is the collection owner/issuer, return an error if not.1798 pub fn check_collection_owner(1799 collection: &NonfungibleHandle<T>,1800 account: &T::CrossAccountId,1801 ) -> DispatchResult {1802 collection1803 .check_is_owner(account)1804 .map_err(Self::map_unique_err_to_proxy)1805 }18061807 /// Get the latest yet-unused RMRK collection index from the storage.1808 pub fn last_collection_idx() -> RmrkCollectionId {1809 <CollectionIndex<T>>::get()1810 }18111812 /// Get a mapping from a RMRK collection ID to its corresponding Unique collection ID.1813 pub fn unique_collection_id(1814 rmrk_collection_id: RmrkCollectionId,1815 ) -> Result<CollectionId, DispatchError> {1816 <UniqueCollectionId<T>>::try_get(rmrk_collection_id)1817 .map_err(|_| <Error<T>>::CollectionUnknown.into())1818 }18191820 /// Get a mapping from a Unique collection ID to its RMRK collection ID counterpart, if it exists.1821 pub fn rmrk_collection_id(1822 unique_collection_id: CollectionId,1823 ) -> Result<RmrkCollectionId, DispatchError> {1824 Self::get_collection_property_decoded(unique_collection_id, RmrkInternalCollectionId)1825 }18261827 /// Fetch a Unique NFT collection.1828 pub fn get_nft_collection(1829 collection_id: CollectionId,1830 ) -> Result<NonfungibleHandle<T>, DispatchError> {1831 let collection = <CollectionHandle<T>>::try_get(collection_id)1832 .map_err(|_| <Error<T>>::CollectionUnknown)?;18331834 match collection.mode {1835 CollectionMode::NFT => Ok(NonfungibleHandle::cast(collection)),1836 _ => Err(<Error<T>>::CollectionUnknown.into()),1837 }1838 }18391840 /// Check if an NFT collection with such an ID exists.1841 pub fn collection_exists(collection_id: CollectionId) -> bool {1842 <CollectionHandle<T>>::try_get(collection_id).is_ok()1843 }18441845 /// Fetch and decode a RMRK-scoped collection property value in bytes.1846 pub fn get_collection_property(1847 collection_id: CollectionId,1848 key: RmrkProperty,1849 ) -> Result<PropertyValue, DispatchError> {1850 let collection_property = <PalletCommon<T>>::collection_properties(collection_id)1851 .get(&Self::get_scoped_property_key(key)?)1852 .ok_or(<Error<T>>::CollectionUnknown)?1853 .clone();18541855 Ok(collection_property)1856 }18571858 /// Fetch a RMRK-scoped collection property and decode it from bytes into an appropriate type.1859 pub fn get_collection_property_decoded<V: Decode>(1860 collection_id: CollectionId,1861 key: RmrkProperty,1862 ) -> Result<V, DispatchError> {1863 Self::decode_property_value(&Self::get_collection_property(collection_id, key)?)1864 }18651866 /// Get the type of a collection stored as a scoped property.1867 ///1868 /// RMRK Core proxy differentiates between regular collections as well as RMRK Bases as collections.1869 pub fn get_collection_type(1870 collection_id: CollectionId,1871 ) -> Result<misc::CollectionType, DispatchError> {1872 Self::get_collection_property_decoded(collection_id, CollectionType).map_err(|err| {1873 if err != <Error<T>>::CollectionUnknown.into() {1874 <Error<T>>::CorruptedCollectionType.into()1875 } else {1876 err1877 }1878 })1879 }18801881 /// Ensure that the type of the collection equals the provided type,1882 /// otherwise return an error.1883 pub fn ensure_collection_type(1884 collection_id: CollectionId,1885 collection_type: misc::CollectionType,1886 ) -> DispatchResult {1887 let actual_type = Self::get_collection_type(collection_id)?;1888 ensure!(1889 actual_type == collection_type,1890 <CommonError<T>>::NoPermission1891 );18921893 Ok(())1894 }18951896 /// Fetch an NFT collection, but make sure it has the appropriate type.1897 pub fn get_typed_nft_collection(1898 collection_id: CollectionId,1899 collection_type: misc::CollectionType,1900 ) -> Result<NonfungibleHandle<T>, DispatchError> {1901 Self::ensure_collection_type(collection_id, collection_type)?;19021903 Self::get_nft_collection(collection_id)1904 }19051906 /// Same as [`get_typed_nft_collection`](crate::pallet::Pallet::get_typed_nft_collection),1907 /// but also return the Unique collection ID.1908 pub fn get_typed_nft_collection_mapped(1909 rmrk_collection_id: RmrkCollectionId,1910 collection_type: misc::CollectionType,1911 ) -> Result<(NonfungibleHandle<T>, CollectionId), DispatchError> {1912 let unique_collection_id = match collection_type {1913 misc::CollectionType::Regular => Self::unique_collection_id(rmrk_collection_id)?,1914 _ => rmrk_collection_id.into(),1915 };19161917 let collection = Self::get_typed_nft_collection(unique_collection_id, collection_type)?;19181919 Ok((collection, unique_collection_id))1920 }19211922 /// Fetch and decode a RMRK-scoped NFT property value in bytes.1923 pub fn get_nft_property(1924 collection_id: CollectionId,1925 nft_id: TokenId,1926 key: RmrkProperty,1927 ) -> Result<PropertyValue, DispatchError> {1928 let nft_property = <PalletNft<T>>::token_properties((collection_id, nft_id))1929 .get(&Self::get_scoped_property_key(key)?)1930 .ok_or(<Error<T>>::RmrkPropertyIsNotFound)?1931 .clone();19321933 Ok(nft_property)1934 }19351936 /// Fetch a RMRK-scoped NFT property and decode it from bytes into an appropriate type.1937 pub fn get_nft_property_decoded<V: Decode>(1938 collection_id: CollectionId,1939 nft_id: TokenId,1940 key: RmrkProperty,1941 ) -> Result<V, DispatchError> {1942 Self::decode_property_value(&Self::get_nft_property(collection_id, nft_id, key)?)1943 }19441945 /// Check that an NFT exists.1946 pub fn nft_exists(collection_id: CollectionId, nft_id: TokenId) -> bool {1947 <TokenData<T>>::contains_key((collection_id, nft_id))1948 }19491950 /// Get the type of an NFT stored as a scoped property.1951 ///1952 /// RMRK Core proxy differentiates between regular NFTs, and RMRK Parts and Themes.1953 pub fn get_nft_type(1954 collection_id: CollectionId,1955 token_id: TokenId,1956 ) -> Result<NftType, DispatchError> {1957 Self::get_nft_property_decoded(collection_id, token_id, TokenType)1958 .map_err(|_| <Error<T>>::NoAvailableNftId.into())1959 }19601961 /// Ensure that the type of the NFT equals the provided type, otherwise return an error.1962 pub fn ensure_nft_type(1963 collection_id: CollectionId,1964 token_id: TokenId,1965 nft_type: NftType,1966 ) -> DispatchResult {1967 let actual_type = Self::get_nft_type(collection_id, token_id)?;1968 ensure!(actual_type == nft_type, <Error<T>>::NoPermission);19691970 Ok(())1971 }19721973 /// Ensure that an account is the owner of the token, either directly1974 /// or at the top of the nesting hierarchy; return an error if it is not.1975 pub fn ensure_nft_owner(1976 collection_id: CollectionId,1977 token_id: TokenId,1978 possible_owner: &T::CrossAccountId,1979 nesting_budget: &dyn budget::Budget,1980 ) -> DispatchResult {1981 let is_owned = <PalletStructure<T>>::check_indirectly_owned(1982 possible_owner.clone(),1983 collection_id,1984 token_id,1985 None,1986 nesting_budget,1987 )1988 .map_err(Self::map_unique_err_to_proxy)?;19891990 ensure!(is_owned, <Error<T>>::NoPermission);19911992 Ok(())1993 }19941995 /// Fetch non-scoped properties of a collection or a token that match the filter keys supplied,1996 /// or, if None are provided, return all non-scoped properties.1997 pub fn filter_user_properties<Key, Value, R, Mapper>(1998 collection_id: CollectionId,1999 token_id: Option<TokenId>,2000 filter_keys: Option<Vec<RmrkPropertyKey>>,2001 mapper: Mapper,2002 ) -> Result<Vec<R>, DispatchError>2003 where2004 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,2005 Value: Decode + Default,2006 Mapper: Fn(Key, Value) -> R,2007 {2008 filter_keys2009 .map(|keys| {2010 let properties = keys2011 .into_iter()2012 .filter_map(|key| {2013 let key: Key = key.try_into().ok()?;20142015 let value = match token_id {2016 Some(token_id) => Self::get_nft_property_decoded(2017 collection_id,2018 token_id,2019 UserProperty(key.as_ref()),2020 ),2021 None => Self::get_collection_property_decoded(2022 collection_id,2023 UserProperty(key.as_ref()),2024 ),2025 }2026 .ok()?;20272028 Some(mapper(key, value))2029 })2030 .collect();20312032 Ok(properties)2033 })2034 .unwrap_or_else(|| {2035 let properties =2036 Self::iterate_user_properties(collection_id, token_id, mapper)?.collect();20372038 Ok(properties)2039 })2040 }20412042 /// Get all non-scoped properties from a collection or a token, and apply some transformation,2043 /// supplied by `mapper`, to each key-value pair.2044 pub fn iterate_user_properties<Key, Value, R, Mapper>(2045 collection_id: CollectionId,2046 token_id: Option<TokenId>,2047 mapper: Mapper,2048 ) -> Result<impl Iterator<Item = R>, DispatchError>2049 where2050 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,2051 Value: Decode + Default,2052 Mapper: Fn(Key, Value) -> R,2053 {2054 let properties = match token_id {2055 Some(token_id) => <PalletNft<T>>::token_properties((collection_id, token_id)),2056 None => <PalletCommon<T>>::collection_properties(collection_id),2057 };20582059 let properties = properties.into_iter().filter_map(move |(key, value)| {2060 let key = strip_key_prefix(&key, USER_PROPERTY_PREFIX)?;20612062 let key: Key = key.to_vec().try_into().ok()?;2063 let value: Value = value.decode().ok()?;20642065 Some(mapper(key, value))2066 });20672068 Ok(properties)2069 }20702071 /// Match Unique errors to RMRK's own and return the RMRK error if a match is successful.2072 fn map_unique_err_to_proxy(err: DispatchError) -> DispatchError {2073 map_unique_err_to_proxy! {2074 match err {2075 CommonError::NoPermission => NoPermission,2076 CommonError::CollectionTokenLimitExceeded => CollectionFullOrLocked,2077 CommonError::PublicMintingNotAllowed => NoPermission,2078 CommonError::TokenNotFound => NoAvailableNftId,2079 CommonError::ApprovedValueTooLow => NoPermission,2080 CommonError::CantDestroyNotEmptyCollection => CollectionNotEmpty,2081 StructureError::TokenNotFound => NoAvailableNftId,2082 StructureError::OuroborosDetected => CannotSendToDescendentOrSelf,2083 }2084 }2085 }2086}pallets/proxy-rmrk-core/src/misc.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/misc.rs
+++ b/pallets/proxy-rmrk-core/src/misc.rs
@@ -20,7 +20,7 @@
use codec::{Encode, Decode, Error};
/// Match errors from one type to another and return an error
-/// if a match is successful.
+/// if a match is successful. This macro expects a pattern matcher
#[macro_export]
macro_rules! map_unique_err_to_proxy {
(match $err:ident { $($unique_err_ty:ident :: $unique_err:ident => $proxy_err:ident),+ $(,)? }) => {
@@ -34,9 +34,10 @@
};
}
-/// Interface to decode bytes from a bounded vector into an arbitrary type.
+/// Interface to decode some serialized bytes into an arbitrary type `T`,
+/// preferably if these bytes were originally encoded from `T`.
pub trait RmrkDecode<T: Decode, S> {
- /// Try to decode bytes from a bounded vector into an arbitrary type.
+ /// Try to decode self into an arbitrary type `T`.
fn decode(&self) -> Result<T, Error>;
}
@@ -48,7 +49,7 @@
}
}
-/// Interface to "rebind", change the limit of a bounded byte vector.
+/// Interface to "rebind" - change the limit of a bounded byte vector.
pub trait RmrkRebind<T, S> {
/// Try to change the limit of a bounded byte vector.
fn rebind(&self) -> Result<BoundedVec<u8, S>, Error>;
pallets/proxy-rmrk-equip/src/lib.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-equip/src/lib.rs
+++ b/pallets/proxy-rmrk-equip/src/lib.rs
@@ -116,7 +116,7 @@
//! is an unacceptable symbol in user-defined properties, which, along with other safeguards,
//! makes them impossible to tamper with.
//!
-//! ### Collection and NFT Types, and Base, Parts and Themes Handling
+//! ### Collection and NFT Types, or Base, Parts and Themes Handling
//!
//! RMRK introduces the concept of a Base, which is a catalogue of Parts,
//! possible components of an NFT. Due to its similarity with the functionality
@@ -414,7 +414,8 @@
}
impl<T: Config> Pallet<T> {
- /// Create or renew an NFT serving as a Part inside a collection serving as a Base.
+ /// Create (or overwrite) a Part in a Base.
+ /// The Part and the Base are represented as an NFT and a Collection.
fn create_part(
sender: &T::CrossAccountId,
collection: &NonfungibleHandle<T>,