1234567891011121314151617#![cfg_attr(not(feature = "std"), no_std)]1819use frame_support::{pallet_prelude::*, transactional, BoundedVec, dispatch::DispatchResult};20use frame_system::{pallet_prelude::*, ensure_signed};21use sp_runtime::{DispatchError, Permill, traits::StaticLookup};22use sp_std::vec::Vec;23use up_data_structs::{*, mapping::TokenAddressMapping};24use pallet_common::{25 Pallet as PalletCommon, Error as CommonError, CollectionHandle, CommonCollectionOperations,26};27use pallet_nonfungible::{Pallet as PalletNft, NonfungibleHandle, TokenData};28use pallet_structure::{Pallet as PalletStructure, Error as StructureError};29use pallet_evm::account::CrossAccountId;30use core::convert::AsRef;3132pub use pallet::*;3334#[cfg(feature = "runtime-benchmarks")]35pub mod benchmarking;36pub mod misc;37pub mod property;38pub mod weights;3940pub type SelfWeightOf<T> = <T as Config>::WeightInfo;4142use weights::WeightInfo;43use misc::*;44pub use property::*;4546use RmrkProperty::*;4748pub const NESTING_BUDGET: u32 = 5;4950#[frame_support::pallet]51pub mod pallet {52 use super::*;53 use pallet_evm::account;5455 #[pallet::config]56 pub trait Config:57 frame_system::Config + pallet_common::Config + pallet_nonfungible::Config + account::Config58 {59 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;60 type WeightInfo: WeightInfo;61 }6263 #[pallet::storage]64 #[pallet::getter(fn collection_index)]65 pub type CollectionIndex<T: Config> = StorageValue<_, RmrkCollectionId, ValueQuery>;6667 #[pallet::storage]68 pub type UniqueCollectionId<T: Config> =69 StorageMap<_, Twox64Concat, RmrkCollectionId, CollectionId, ValueQuery>;7071 #[pallet::storage]72 pub type RmrkInernalCollectionId<T: Config> =73 StorageMap<_, Twox64Concat, CollectionId, RmrkCollectionId, ValueQuery>;7475 #[pallet::pallet]76 #[pallet::generate_store(pub(super) trait Store)]77 pub struct Pallet<T>(_);7879 #[pallet::event]80 #[pallet::generate_deposit(pub(super) fn deposit_event)]81 pub enum Event<T: Config> {82 CollectionCreated {83 issuer: T::AccountId,84 collection_id: RmrkCollectionId,85 },86 CollectionDestroyed {87 issuer: T::AccountId,88 collection_id: RmrkCollectionId,89 },90 IssuerChanged {91 old_issuer: T::AccountId,92 new_issuer: T::AccountId,93 collection_id: RmrkCollectionId,94 },95 CollectionLocked {96 issuer: T::AccountId,97 collection_id: RmrkCollectionId,98 },99 NftMinted {100 owner: T::AccountId,101 collection_id: RmrkCollectionId,102 nft_id: RmrkNftId,103 },104 NFTBurned {105 owner: T::AccountId,106 nft_id: RmrkNftId,107 },108 NFTSent {109 sender: T::AccountId,110 recipient: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,111 collection_id: RmrkCollectionId,112 nft_id: RmrkNftId,113 approval_required: bool,114 },115 NFTAccepted {116 sender: T::AccountId,117 recipient: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,118 collection_id: RmrkCollectionId,119 nft_id: RmrkNftId,120 },121 NFTRejected {122 sender: T::AccountId,123 collection_id: RmrkCollectionId,124 nft_id: RmrkNftId,125 },126 PropertySet {127 collection_id: RmrkCollectionId,128 maybe_nft_id: Option<RmrkNftId>,129 key: RmrkKeyString,130 value: RmrkValueString,131 },132 ResourceAdded {133 nft_id: RmrkNftId,134 resource_id: RmrkResourceId,135 },136 ResourceRemoval {137 nft_id: RmrkNftId,138 resource_id: RmrkResourceId,139 },140 ResourceAccepted {141 nft_id: RmrkNftId,142 resource_id: RmrkResourceId,143 },144 ResourceRemovalAccepted {145 nft_id: RmrkNftId,146 resource_id: RmrkResourceId,147 },148 PrioritySet {149 collection_id: RmrkCollectionId,150 nft_id: RmrkNftId,151 },152 }153154 #[pallet::error]155 pub enum Error<T> {156 157 CorruptedCollectionType,158 NftTypeEncodeError,159 RmrkPropertyKeyIsTooLong,160 RmrkPropertyValueIsTooLong,161 UnableToDecodeRmrkData,162163 164 CollectionNotEmpty,165 NoAvailableCollectionId,166 NoAvailableNftId,167 CollectionUnknown,168 NoPermission,169 NonTransferable,170 CollectionFullOrLocked,171 ResourceDoesntExist,172 CannotSendToDescendentOrSelf,173 CannotAcceptNonOwnedNft,174 CannotRejectNonOwnedNft,175 ResourceNotPending,176 }177178 #[pallet::call]179 impl<T: Config> Pallet<T> {180 181 #[transactional]182 #[pallet::weight(<SelfWeightOf<T>>::create_collection())]183 pub fn create_collection(184 origin: OriginFor<T>,185 metadata: RmrkString,186 max: Option<u32>,187 symbol: RmrkCollectionSymbol,188 ) -> DispatchResult {189 let sender = ensure_signed(origin)?;190191 let limits = CollectionLimits {192 owner_can_transfer: Some(false),193 token_limit: max,194 ..Default::default()195 };196197 let data = CreateCollectionData {198 limits: Some(limits),199 token_prefix: symbol200 .into_inner()201 .try_into()202 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,203 permissions: Some(CollectionPermissions {204 nesting: Some(NestingPermissions {205 token_owner: true,206 admin: false,207 restricted: None,208209 permissive: false,210 }),211 ..Default::default()212 }),213 ..Default::default()214 };215216 let unique_collection_id = Self::init_collection(217 T::CrossAccountId::from_sub(sender.clone()),218 data,219 [220 Self::rmrk_property(Metadata, &metadata)?,221 Self::rmrk_property(CollectionType, &misc::CollectionType::Regular)?,222 ]223 .into_iter(),224 )?;225 let rmrk_collection_id = <CollectionIndex<T>>::get();226227 <UniqueCollectionId<T>>::insert(rmrk_collection_id, unique_collection_id);228 <RmrkInernalCollectionId<T>>::insert(unique_collection_id, rmrk_collection_id);229230 <CollectionIndex<T>>::mutate(|n| *n += 1);231232 Self::deposit_event(Event::CollectionCreated {233 issuer: sender,234 collection_id: rmrk_collection_id,235 });236237 Ok(())238 }239240 241 #[transactional]242 #[pallet::weight(<SelfWeightOf<T>>::destroy_collection())]243 pub fn destroy_collection(244 origin: OriginFor<T>,245 collection_id: RmrkCollectionId,246 ) -> DispatchResult {247 let sender = ensure_signed(origin)?;248 let cross_sender = T::CrossAccountId::from_sub(sender.clone());249250 let collection = Self::get_typed_nft_collection(251 Self::unique_collection_id(collection_id)?,252 misc::CollectionType::Regular,253 )?;254 collection.check_is_external()?;255256 <PalletNft<T>>::destroy_collection(collection, &cross_sender)257 .map_err(Self::map_unique_err_to_proxy)?;258259 Self::deposit_event(Event::CollectionDestroyed {260 issuer: sender,261 collection_id,262 });263264 Ok(())265 }266267 268 269 270 271 272 273 #[transactional]274 #[pallet::weight(<SelfWeightOf<T>>::change_collection_issuer())]275 pub fn change_collection_issuer(276 origin: OriginFor<T>,277 collection_id: RmrkCollectionId,278 new_issuer: <T::Lookup as StaticLookup>::Source,279 ) -> DispatchResult {280 let sender = ensure_signed(origin)?;281282 let collection = Self::get_nft_collection(Self::unique_collection_id(collection_id)?)?;283 collection.check_is_external()?;284285 let new_issuer = T::Lookup::lookup(new_issuer)?;286287 Self::change_collection_owner(288 Self::unique_collection_id(collection_id)?,289 misc::CollectionType::Regular,290 sender.clone(),291 new_issuer.clone(),292 )?;293294 Self::deposit_event(Event::IssuerChanged {295 old_issuer: sender,296 new_issuer,297 collection_id,298 });299300 Ok(())301 }302303 304 #[transactional]305 #[pallet::weight(<SelfWeightOf<T>>::lock_collection())]306 pub fn lock_collection(307 origin: OriginFor<T>,308 collection_id: RmrkCollectionId,309 ) -> DispatchResult {310 let sender = ensure_signed(origin)?;311 let cross_sender = T::CrossAccountId::from_sub(sender.clone());312313 let collection = Self::get_typed_nft_collection(314 Self::unique_collection_id(collection_id)?,315 misc::CollectionType::Regular,316 )?;317 collection.check_is_external()?;318319 Self::check_collection_owner(&collection, &cross_sender)?;320321 let token_count = collection.total_supply();322323 let mut collection = collection.into_inner();324 collection.limits.token_limit = Some(token_count);325 collection.save()?;326327 Self::deposit_event(Event::CollectionLocked {328 issuer: sender,329 collection_id,330 });331332 Ok(())333 }334335 336 337 338 339 340 341 342 343 344 345 #[transactional]346 #[pallet::weight(<SelfWeightOf<T>>::mint_nft())]347 pub fn mint_nft(348 origin: OriginFor<T>,349 owner: T::AccountId,350 collection_id: RmrkCollectionId,351 recipient: Option<T::AccountId>,352 royalty_amount: Option<Permill>,353 metadata: RmrkString,354 transferable: bool,355 ) -> DispatchResult {356 let sender = ensure_signed(origin)?;357 let sender = T::CrossAccountId::from_sub(sender);358 let cross_owner = T::CrossAccountId::from_sub(owner.clone());359360 let collection = Self::get_typed_nft_collection(361 Self::unique_collection_id(collection_id)?,362 misc::CollectionType::Regular,363 )?;364 collection.check_is_external()?;365366 let royalty_info = royalty_amount.map(|amount| rmrk_traits::RoyaltyInfo {367 recipient: recipient.unwrap_or_else(|| owner.clone()),368 amount,369 });370371 let nft_id = Self::create_nft(372 &sender,373 &cross_owner,374 &collection,375 [376 Self::rmrk_property(TokenType, &NftType::Regular)?,377 Self::rmrk_property(Transferable, &transferable)?,378 Self::rmrk_property(PendingNftAccept, &false)?,379 Self::rmrk_property(RoyaltyInfo, &royalty_info)?,380 Self::rmrk_property(Metadata, &metadata)?,381 Self::rmrk_property(Equipped, &false)?,382 Self::rmrk_property(ResourceCollection, &None::<CollectionId>)?,383 Self::rmrk_property(ResourcePriorities, &<Vec<u8>>::new())?,384 ]385 .into_iter(),386 )387 .map_err(|err| match err {388 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailableNftId.into(),389 err => Self::map_unique_err_to_proxy(err),390 })?;391392 Self::deposit_event(Event::NftMinted {393 owner,394 collection_id,395 nft_id: nft_id.0,396 });397398 Ok(())399 }400401 402 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]403 #[transactional]404 pub fn burn_nft(405 origin: OriginFor<T>,406 collection_id: RmrkCollectionId,407 nft_id: RmrkNftId,408 max_burns: u32,409 ) -> DispatchResult {410 let sender = ensure_signed(origin)?;411 let cross_sender = T::CrossAccountId::from_sub(sender.clone());412413 let collection = Self::get_typed_nft_collection(414 Self::unique_collection_id(collection_id)?,415 misc::CollectionType::Regular,416 )?;417 collection.check_is_external()?;418419 Self::destroy_nft(420 cross_sender,421 Self::unique_collection_id(collection_id)?,422 nft_id.into(),423 max_burns,424 <Error<T>>::NoPermission,425 )426 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;427428 Self::deposit_event(Event::NFTBurned {429 owner: sender,430 nft_id,431 });432433 Ok(())434 }435436 437 438 439 440 441 442 443 #[transactional]444 #[pallet::weight(<SelfWeightOf<T>>::send())]445 pub fn send(446 origin: OriginFor<T>,447 rmrk_collection_id: RmrkCollectionId,448 rmrk_nft_id: RmrkNftId,449 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,450 ) -> DispatchResult {451 let sender = ensure_signed(origin.clone())?;452 let cross_sender = T::CrossAccountId::from_sub(sender.clone());453454 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;455 let nft_id = rmrk_nft_id.into();456457 let collection =458 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;459 collection.check_is_external()?;460461 let token_data =462 <TokenData<T>>::get((collection_id, nft_id)).ok_or(<Error<T>>::NoAvailableNftId)?;463464 let from = token_data.owner;465466 ensure!(467 Self::get_nft_property_decoded(collection_id, nft_id, RmrkProperty::Transferable)?,468 <Error<T>>::NonTransferable469 );470471 ensure!(472 !Self::get_nft_property_decoded(473 collection_id,474 nft_id,475 RmrkProperty::PendingNftAccept476 )?,477 <Error<T>>::NoPermission478 );479480 let target_owner;481 let approval_required;482483 match new_owner {484 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {485 target_owner = T::CrossAccountId::from_sub(account_id.clone());486 approval_required = false;487 }488 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(489 target_collection_id,490 target_nft_id,491 ) => {492 let target_collection_id = Self::unique_collection_id(target_collection_id)?;493494 let target_nft_budget = budget::Value::new(NESTING_BUDGET);495496 let target_nft_owner = <PalletStructure<T>>::get_checked_topmost_owner(497 target_collection_id,498 target_nft_id.into(),499 Some((collection_id, nft_id)),500 &target_nft_budget,501 )502 .map_err(Self::map_unique_err_to_proxy)?;503504 approval_required = cross_sender != target_nft_owner;505506 if approval_required {507 target_owner = target_nft_owner;508509 <PalletNft<T>>::set_scoped_token_property(510 collection.id,511 nft_id,512 PropertyScope::Rmrk,513 Self::rmrk_property(PendingNftAccept, &approval_required)?,514 )?;515 } else {516 target_owner = T::CrossTokenAddressMapping::token_to_address(517 target_collection_id,518 target_nft_id.into(),519 );520 }521 }522 }523524 let src_nft_budget = budget::Value::new(NESTING_BUDGET);525526 <PalletNft<T>>::transfer_from(527 &collection,528 &cross_sender,529 &from,530 &target_owner,531 nft_id,532 &src_nft_budget,533 )534 .map_err(Self::map_unique_err_to_proxy)?;535536 Self::deposit_event(Event::NFTSent {537 sender,538 recipient: new_owner,539 collection_id: rmrk_collection_id,540 nft_id: rmrk_nft_id,541 approval_required,542 });543544 Ok(())545 }546547 548 549 550 551 552 553 554 555 #[transactional]556 #[pallet::weight(<SelfWeightOf<T>>::accept_nft())]557 pub fn accept_nft(558 origin: OriginFor<T>,559 rmrk_collection_id: RmrkCollectionId,560 rmrk_nft_id: RmrkNftId,561 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,562 ) -> DispatchResult {563 let sender = ensure_signed(origin.clone())?;564 let cross_sender = T::CrossAccountId::from_sub(sender.clone());565566 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;567 let nft_id = rmrk_nft_id.into();568569 let collection =570 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;571 collection.check_is_external()?;572573 let new_cross_owner = match new_owner {574 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {575 T::CrossAccountId::from_sub(account_id.clone())576 }577 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(578 target_collection_id,579 target_nft_id,580 ) => {581 let target_collection_id = Self::unique_collection_id(target_collection_id)?;582583 T::CrossTokenAddressMapping::token_to_address(584 target_collection_id,585 TokenId(target_nft_id),586 )587 }588 };589590 let budget = budget::Value::new(NESTING_BUDGET);591592 <PalletNft<T>>::transfer(593 &collection,594 &cross_sender,595 &new_cross_owner,596 nft_id,597 &budget,598 )599 .map_err(|err| {600 if err == <CommonError<T>>::UserIsNotAllowedToNest.into() {601 <Error<T>>::CannotAcceptNonOwnedNft.into()602 } else {603 Self::map_unique_err_to_proxy(err)604 }605 })?;606607 <PalletNft<T>>::set_scoped_token_property(608 collection.id,609 nft_id,610 PropertyScope::Rmrk,611 Self::rmrk_property(PendingNftAccept, &false)?,612 )?;613614 Self::deposit_event(Event::NFTAccepted {615 sender,616 recipient: new_owner,617 collection_id: rmrk_collection_id,618 nft_id: rmrk_nft_id,619 });620621 Ok(())622 }623624 625 626 627 628 629 630 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]631 #[transactional]632 pub fn reject_nft(633 origin: OriginFor<T>,634 rmrk_collection_id: RmrkCollectionId,635 rmrk_nft_id: RmrkNftId,636 max_burns: u32,637 ) -> DispatchResult {638 let sender = ensure_signed(origin)?;639 let cross_sender = T::CrossAccountId::from_sub(sender.clone());640641 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;642 let nft_id = rmrk_nft_id.into();643644 let collection =645 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;646 collection.check_is_external()?;647648 Self::destroy_nft(649 cross_sender,650 collection_id,651 nft_id,652 max_burns,653 <Error<T>>::CannotRejectNonOwnedNft,654 )655 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;656657 Self::deposit_event(Event::NFTRejected {658 sender,659 collection_id: rmrk_collection_id,660 nft_id: rmrk_nft_id,661 });662663 Ok(())664 }665666 667 #[transactional]668 #[pallet::weight(<SelfWeightOf<T>>::accept_resource())]669 pub fn accept_resource(670 origin: OriginFor<T>,671 rmrk_collection_id: RmrkCollectionId,672 rmrk_nft_id: RmrkNftId,673 rmrk_resource_id: RmrkResourceId,674 ) -> DispatchResult {675 let sender = ensure_signed(origin)?;676 let cross_sender = T::CrossAccountId::from_sub(sender);677678 let collection_id = Self::unique_collection_id(rmrk_collection_id)679 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;680 let collection =681 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;682 collection.check_is_external()?;683684 let nft_id = rmrk_nft_id.into();685 let resource_id = rmrk_resource_id.into();686687 let budget = budget::Value::new(NESTING_BUDGET);688689 let nft_owner =690 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)691 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;692693 let resource_collection_id: Option<CollectionId> =694 Self::get_nft_property_decoded(collection_id, nft_id, ResourceCollection)695 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;696 697 let resource_collection_id = resource_collection_id.ok_or(<Error<T>>::ResourceDoesntExist)?;698699 let is_pending: bool = Self::get_nft_property_decoded(700 resource_collection_id,701 resource_id,702 PendingResourceAccept,703 )704 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;705706 ensure!(is_pending, <Error<T>>::ResourceNotPending);707708 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);709710 <PalletNft<T>>::set_scoped_token_property(711 resource_collection_id,712 rmrk_resource_id.into(),713 PropertyScope::Rmrk,714 Self::rmrk_property(PendingResourceAccept, &false)?,715 )?;716717 Self::deposit_event(Event::<T>::ResourceAccepted {718 nft_id: rmrk_nft_id,719 resource_id: rmrk_resource_id,720 });721722 Ok(())723 }724725 726 #[transactional]727 #[pallet::weight(<SelfWeightOf<T>>::accept_resource_removal())]728 pub fn accept_resource_removal(729 origin: OriginFor<T>,730 rmrk_collection_id: RmrkCollectionId,731 rmrk_nft_id: RmrkNftId,732 rmrk_resource_id: RmrkResourceId,733 ) -> DispatchResult {734 let sender = ensure_signed(origin)?;735 let cross_sender = T::CrossAccountId::from_sub(sender);736737 let collection_id = Self::unique_collection_id(rmrk_collection_id)738 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;739 let collection =740 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;741 collection.check_is_external()?;742743 let nft_id = rmrk_nft_id.into();744 let resource_id = rmrk_resource_id.into();745746 let budget = budget::Value::new(NESTING_BUDGET);747748 let nft_owner =749 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)750 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;751752 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);753754 let resource_collection_id: Option<CollectionId> =755 Self::get_nft_property_decoded(collection_id, nft_id, ResourceCollection)756 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;757758 let resource_collection_id = resource_collection_id.ok_or(<Error<T>>::ResourceDoesntExist)?;759760 let is_pending: bool = Self::get_nft_property_decoded(761 resource_collection_id,762 resource_id,763 PendingResourceRemoval,764 )765 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;766767 ensure!(is_pending, <Error<T>>::ResourceNotPending);768769 let resource_collection = Self::get_typed_nft_collection(770 resource_collection_id,771 misc::CollectionType::Resource,772 )?;773774 let resource_data =775 <TokenData<T>>::get((resource_collection_id, resource_id)).ok_or(<Error<T>>::ResourceDoesntExist)?;776 777 let resource_owner = resource_data.owner;778779 <PalletNft<T>>::burn(&resource_collection, &resource_owner, rmrk_resource_id.into())780 .map_err(Self::map_unique_err_to_proxy)?;781782 Self::deposit_event(Event::<T>::ResourceRemovalAccepted {783 nft_id: rmrk_nft_id,784 resource_id: rmrk_resource_id,785 });786787 Ok(())788 }789790 791 #[transactional]792 #[pallet::weight(<SelfWeightOf<T>>::set_property())]793 pub fn set_property(794 origin: OriginFor<T>,795 #[pallet::compact] rmrk_collection_id: RmrkCollectionId,796 maybe_nft_id: Option<RmrkNftId>,797 key: RmrkKeyString,798 value: RmrkValueString,799 ) -> DispatchResult {800 let sender = ensure_signed(origin)?;801 let sender = T::CrossAccountId::from_sub(sender);802803 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;804 let collection =805 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;806 collection.check_is_external()?;807808 let budget = budget::Value::new(NESTING_BUDGET);809810 match maybe_nft_id {811 Some(nft_id) => {812 let token_id: TokenId = nft_id.into();813814 Self::ensure_nft_type(collection_id, token_id, NftType::Regular)?;815 Self::ensure_nft_owner(collection_id, token_id, &sender, &budget)?;816817 <PalletNft<T>>::set_scoped_token_property(818 collection_id,819 token_id,820 PropertyScope::Rmrk,821 Self::rmrk_property(UserProperty(key.as_slice()), &value)?,822 )?;823 }824 None => {825 let collection = Self::get_typed_nft_collection(826 collection_id,827 misc::CollectionType::Regular,828 )?;829830 Self::check_collection_owner(&collection, &sender)?;831832 <PalletCommon<T>>::set_scoped_collection_property(833 collection_id,834 PropertyScope::Rmrk,835 Self::rmrk_property(UserProperty(key.as_slice()), &value)?,836 )?;837 }838 }839840 Self::deposit_event(Event::PropertySet {841 collection_id: rmrk_collection_id,842 maybe_nft_id,843 key,844 value,845 });846847 Ok(())848 }849850 851 #[transactional]852 #[pallet::weight(<SelfWeightOf<T>>::set_priority())]853 pub fn set_priority(854 origin: OriginFor<T>,855 rmrk_collection_id: RmrkCollectionId,856 rmrk_nft_id: RmrkNftId,857 priorities: BoundedVec<RmrkResourceId, RmrkMaxPriorities>,858 ) -> DispatchResult {859 let sender = ensure_signed(origin)?;860 let sender = T::CrossAccountId::from_sub(sender);861862 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;863 let nft_id = rmrk_nft_id.into();864865 let collection =866 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;867 collection.check_is_external()?;868869 let budget = budget::Value::new(NESTING_BUDGET);870871 Self::ensure_nft_type(collection_id, nft_id, NftType::Regular)?;872 Self::ensure_nft_owner(collection_id, nft_id, &sender, &budget)?;873874 <PalletNft<T>>::set_scoped_token_property(875 collection_id,876 nft_id,877 PropertyScope::Rmrk,878 Self::rmrk_property(ResourcePriorities, &priorities.into_inner())?,879 )?;880881 Self::deposit_event(Event::<T>::PrioritySet {882 collection_id: rmrk_collection_id,883 nft_id: rmrk_nft_id,884 });885886 Ok(())887 }888889 890 #[transactional]891 #[pallet::weight(<SelfWeightOf<T>>::add_basic_resource())]892 pub fn add_basic_resource(893 origin: OriginFor<T>,894 rmrk_collection_id: RmrkCollectionId,895 nft_id: RmrkNftId,896 resource: RmrkBasicResource,897 ) -> DispatchResult {898 let sender = ensure_signed(origin.clone())?;899900 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;901 let collection =902 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;903 collection.check_is_external()?;904905 let resource_id = Self::resource_add(906 sender,907 collection_id,908 nft_id.into(),909 [910 Self::rmrk_property(TokenType, &NftType::Resource)?,911 Self::rmrk_property(ResourceType, &misc::ResourceType::Basic)?,912 Self::rmrk_property(Src, &resource.src)?,913 Self::rmrk_property(Metadata, &resource.metadata)?,914 Self::rmrk_property(License, &resource.license)?,915 Self::rmrk_property(Thumb, &resource.thumb)?,916 ]917 .into_iter(),918 )?;919920 Self::deposit_event(Event::ResourceAdded {921 nft_id,922 resource_id,923 });924 Ok(())925 }926927 928 #[transactional]929 #[pallet::weight(<SelfWeightOf<T>>::add_composable_resource())]930 pub fn add_composable_resource(931 origin: OriginFor<T>,932 rmrk_collection_id: RmrkCollectionId,933 nft_id: RmrkNftId,934 resource: RmrkComposableResource,935 ) -> DispatchResult {936 let sender = ensure_signed(origin.clone())?;937938 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;939 let collection =940 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;941 collection.check_is_external()?;942943 let resource_id = Self::resource_add(944 sender,945 collection_id,946 nft_id.into(),947 [948 Self::rmrk_property(TokenType, &NftType::Resource)?,949 Self::rmrk_property(ResourceType, &misc::ResourceType::Composable)?,950 Self::rmrk_property(Parts, &resource.parts)?,951 Self::rmrk_property(Base, &resource.base)?,952 Self::rmrk_property(Src, &resource.src)?,953 Self::rmrk_property(Metadata, &resource.metadata)?,954 Self::rmrk_property(License, &resource.license)?,955 Self::rmrk_property(Thumb, &resource.thumb)?,956 ]957 .into_iter(),958 )?;959960 Self::deposit_event(Event::ResourceAdded {961 nft_id,962 resource_id,963 });964 Ok(())965 }966967 968 #[transactional]969 #[pallet::weight(<SelfWeightOf<T>>::add_slot_resource())]970 pub fn add_slot_resource(971 origin: OriginFor<T>,972 rmrk_collection_id: RmrkCollectionId,973 nft_id: RmrkNftId,974 resource: RmrkSlotResource,975 ) -> DispatchResult {976 let sender = ensure_signed(origin.clone())?;977978 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;979 let collection =980 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;981 collection.check_is_external()?;982983 let resource_id = Self::resource_add(984 sender,985 collection_id,986 nft_id.into(),987 [988 Self::rmrk_property(TokenType, &NftType::Resource)?,989 Self::rmrk_property(ResourceType, &misc::ResourceType::Slot)?,990 Self::rmrk_property(Base, &resource.base)?,991 Self::rmrk_property(Src, &resource.src)?,992 Self::rmrk_property(Metadata, &resource.metadata)?,993 Self::rmrk_property(Slot, &resource.slot)?,994 Self::rmrk_property(License, &resource.license)?,995 Self::rmrk_property(Thumb, &resource.thumb)?,996 ]997 .into_iter(),998 )?;9991000 Self::deposit_event(Event::ResourceAdded {1001 nft_id,1002 resource_id,1003 });1004 Ok(())1005 }10061007 1008 #[transactional]1009 #[pallet::weight(<SelfWeightOf<T>>::remove_resource())]1010 pub fn remove_resource(1011 origin: OriginFor<T>,1012 rmrk_collection_id: RmrkCollectionId,1013 nft_id: RmrkNftId,1014 resource_id: RmrkResourceId,1015 ) -> DispatchResult {1016 let sender = ensure_signed(origin.clone())?;10171018 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1019 let collection =1020 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1021 collection.check_is_external()?;10221023 Self::resource_remove(sender, collection_id, nft_id.into(), resource_id.into())?;10241025 Self::deposit_event(Event::ResourceRemoval {1026 nft_id,1027 resource_id,1028 });1029 Ok(())1030 }1031 }1032}10331034impl<T: Config> Pallet<T> {1035 pub fn rmrk_property_key(rmrk_key: RmrkProperty) -> Result<PropertyKey, DispatchError> {1036 let key = rmrk_key.to_key::<T>()?;10371038 let scoped_key = PropertyScope::Rmrk1039 .apply(key)1040 .map_err(|_| <Error<T>>::RmrkPropertyKeyIsTooLong)?;10411042 Ok(scoped_key)1043 }10441045 1046 pub fn rmrk_property<E: Encode>(1047 rmrk_key: RmrkProperty,1048 value: &E,1049 ) -> Result<Property, DispatchError> {1050 let key = rmrk_key.to_key::<T>()?;10511052 let value = value1053 .encode()1054 .try_into()1055 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong)?;10561057 let property = Property { key, value };10581059 Ok(property)1060 }10611062 pub fn decode_property<D: Decode>(vec: PropertyValue) -> Result<D, DispatchError> {1063 vec.decode()1064 .map_err(|_| <Error<T>>::UnableToDecodeRmrkData.into())1065 }10661067 pub fn rebind<L, S>(vec: &BoundedVec<u8, L>) -> Result<BoundedVec<u8, S>, DispatchError>1068 where1069 BoundedVec<u8, S>: TryFrom<Vec<u8>>,1070 {1071 vec.rebind()1072 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong.into())1073 }10741075 fn init_collection(1076 sender: T::CrossAccountId,1077 data: CreateCollectionData<T::AccountId>,1078 properties: impl Iterator<Item = Property>,1079 ) -> Result<CollectionId, DispatchError> {1080 let collection_id = <PalletNft<T>>::init_collection(sender, data, true);10811082 if let Err(DispatchError::Arithmetic(_)) = &collection_id {1083 return Err(<Error<T>>::NoAvailableCollectionId.into());1084 }10851086 <PalletCommon<T>>::set_scoped_collection_properties(1087 collection_id?,1088 PropertyScope::Rmrk,1089 properties,1090 )?;10911092 collection_id1093 }10941095 pub fn create_nft(1096 sender: &T::CrossAccountId,1097 owner: &T::CrossAccountId,1098 collection: &NonfungibleHandle<T>,1099 properties: impl Iterator<Item = Property>,1100 ) -> Result<TokenId, DispatchError> {1101 let data = CreateNftExData {1102 properties: BoundedVec::default(),1103 owner: owner.clone(),1104 };11051106 let budget = budget::Value::new(NESTING_BUDGET);11071108 <PalletNft<T>>::create_item(collection, sender, data, &budget)?;11091110 let nft_id = <PalletNft<T>>::current_token_id(collection.id);11111112 <PalletNft<T>>::set_scoped_token_properties(1113 collection.id,1114 nft_id,1115 PropertyScope::Rmrk,1116 properties,1117 )?;11181119 Ok(nft_id)1120 }11211122 fn destroy_nft(1123 sender: T::CrossAccountId,1124 collection_id: CollectionId,1125 token_id: TokenId,1126 max_burns: u32,1127 error_if_not_owned: Error<T>,1128 ) -> DispatchResultWithPostInfo {1129 let collection =1130 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;11311132 let token_data =1133 <TokenData<T>>::get((collection_id, token_id)).ok_or(<Error<T>>::NoAvailableNftId)?;11341135 let from = token_data.owner;11361137 let owner_check_budget = budget::Value::new(NESTING_BUDGET);11381139 ensure!(1140 <PalletStructure<T>>::check_indirectly_owned(1141 sender.clone(),1142 collection_id,1143 token_id,1144 None,1145 &owner_check_budget1146 )?,1147 error_if_not_owned,1148 );11491150 let burns_budget = budget::Value::new(max_burns);1151 let breadth_budget = budget::Value::new(max_burns);11521153 <PalletNft<T>>::burn_recursively(1154 &collection,1155 &from,1156 token_id,1157 &burns_budget,1158 &breadth_budget,1159 )1160 }11611162 fn resource_add(1163 sender: T::AccountId,1164 collection_id: CollectionId,1165 token_id: TokenId,1166 resource_properties: impl Iterator<Item = Property>,1167 ) -> Result<RmrkResourceId, DispatchError> {1168 let collection =1169 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1170 ensure!(collection.owner == sender, Error::<T>::NoPermission);11711172 let sender = T::CrossAccountId::from_sub(sender);1173 let budget = budget::Value::new(NESTING_BUDGET);11741175 let nft_owner = <PalletStructure<T>>::find_topmost_owner(collection_id, token_id, &budget)1176 .map_err(Self::map_unique_err_to_proxy)?;11771178 let pending = sender != nft_owner;11791180 let resource_collection_id: Option<CollectionId> =1181 Self::get_nft_property_decoded(collection_id, token_id, ResourceCollection)?;11821183 let resource_collection_id = match resource_collection_id {1184 Some(id) => id,1185 None => {1186 let resource_collection_id = Self::init_collection(1187 sender.clone(),1188 CreateCollectionData {1189 ..Default::default()1190 },1191 [1192 Self::rmrk_property(1193 CollectionType,1194 &misc::CollectionType::Resource,1195 )?1196 ]1197 .into_iter(),1198 )?;11991200 <PalletNft<T>>::set_scoped_token_property(1201 collection_id,1202 token_id,1203 PropertyScope::Rmrk,1204 Self::rmrk_property(ResourceCollection, &Some(resource_collection_id))?1205 )?;12061207 resource_collection_id1208 }1209 };12101211 let resource_collection =1212 Self::get_typed_nft_collection(resource_collection_id, misc::CollectionType::Resource)?;12131214 12151216 let resource_id = Self::create_nft(1217 &sender,1218 &nft_owner,1219 &resource_collection,1220 resource_properties.chain(1221 [1222 Self::rmrk_property(PendingResourceAccept, &pending)?,1223 Self::rmrk_property(PendingResourceRemoval, &false)?,1224 ]1225 .into_iter(),1226 ),1227 )1228 .map_err(|err| match err {1229 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailableNftId.into(),1230 err => Self::map_unique_err_to_proxy(err),1231 })?;12321233 Ok(resource_id.0)1234 }12351236 fn resource_remove(1237 sender: T::AccountId,1238 collection_id: CollectionId,1239 nft_id: TokenId,1240 resource_id: TokenId,1241 ) -> DispatchResult {1242 let collection =1243 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1244 ensure!(collection.owner == sender, Error::<T>::NoPermission);12451246 let resource_collection_id: Option<CollectionId> =1247 Self::get_nft_property_decoded(collection_id, nft_id, ResourceCollection)?;12481249 let resource_collection_id = resource_collection_id.ok_or(Error::<T>::ResourceDoesntExist)?;1250 1251 let resource_collection =1252 Self::get_typed_nft_collection(resource_collection_id, misc::CollectionType::Resource)?;1253 ensure!(1254 <PalletNft<T>>::token_exists(&resource_collection, resource_id),1255 Error::<T>::ResourceDoesntExist1256 );12571258 let budget = up_data_structs::budget::Value::new(NESTING_BUDGET);1259 let topmost_owner =1260 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)?;12611262 let sender = T::CrossAccountId::from_sub(sender);1263 if topmost_owner == sender {1264 <PalletNft<T>>::burn(&resource_collection, &sender, resource_id)1265 .map_err(Self::map_unique_err_to_proxy)?;1266 } else {1267 <PalletNft<T>>::set_scoped_token_property(1268 resource_collection_id,1269 resource_id,1270 PropertyScope::Rmrk,1271 Self::rmrk_property(PendingResourceRemoval, &true)?,1272 )?;1273 }12741275 Ok(())1276 }12771278 fn change_collection_owner(1279 collection_id: CollectionId,1280 collection_type: misc::CollectionType,1281 sender: T::AccountId,1282 new_owner: T::AccountId,1283 ) -> DispatchResult {1284 let collection = Self::get_typed_nft_collection(collection_id, collection_type)?;1285 Self::check_collection_owner(&collection, &T::CrossAccountId::from_sub(sender))?;12861287 let mut collection = collection.into_inner();12881289 collection.owner = new_owner;1290 collection.save()1291 }12921293 fn check_collection_owner(1294 collection: &NonfungibleHandle<T>,1295 account: &T::CrossAccountId,1296 ) -> DispatchResult {1297 collection1298 .check_is_owner(account)1299 .map_err(Self::map_unique_err_to_proxy)1300 }13011302 pub fn last_collection_idx() -> RmrkCollectionId {1303 <CollectionIndex<T>>::get()1304 }13051306 pub fn unique_collection_id(1307 rmrk_collection_id: RmrkCollectionId,1308 ) -> Result<CollectionId, DispatchError> {1309 <UniqueCollectionId<T>>::try_get(rmrk_collection_id)1310 .map_err(|_| <Error<T>>::CollectionUnknown.into())1311 }13121313 pub fn rmrk_collection_id(1314 unique_collection_id: CollectionId,1315 ) -> Result<RmrkCollectionId, DispatchError> {1316 <RmrkInernalCollectionId<T>>::try_get(unique_collection_id)1317 .map_err(|_| <Error<T>>::CollectionUnknown.into())1318 }13191320 pub fn get_nft_collection(1321 collection_id: CollectionId,1322 ) -> Result<NonfungibleHandle<T>, DispatchError> {1323 let collection = <CollectionHandle<T>>::try_get(collection_id)1324 .map_err(|_| <Error<T>>::CollectionUnknown)?;13251326 match collection.mode {1327 CollectionMode::NFT => Ok(NonfungibleHandle::cast(collection)),1328 _ => Err(<Error<T>>::CollectionUnknown.into()),1329 }1330 }13311332 pub fn collection_exists(collection_id: CollectionId) -> bool {1333 <CollectionHandle<T>>::try_get(collection_id).is_ok()1334 }13351336 pub fn get_collection_property(1337 collection_id: CollectionId,1338 key: RmrkProperty,1339 ) -> Result<PropertyValue, DispatchError> {1340 let collection_property = <PalletCommon<T>>::collection_properties(collection_id)1341 .get(&Self::rmrk_property_key(key)?)1342 .ok_or(<Error<T>>::CollectionUnknown)?1343 .clone();13441345 Ok(collection_property)1346 }13471348 pub fn get_collection_property_decoded<V: Decode>(1349 collection_id: CollectionId,1350 key: RmrkProperty,1351 ) -> Result<V, DispatchError> {1352 Self::decode_property(Self::get_collection_property(collection_id, key)?)1353 }13541355 pub fn get_collection_type(1356 collection_id: CollectionId,1357 ) -> Result<misc::CollectionType, DispatchError> {1358 Self::get_collection_property_decoded(collection_id, CollectionType)1359 .map_err(|_| <Error<T>>::CorruptedCollectionType.into())1360 }13611362 pub fn ensure_collection_type(1363 collection_id: CollectionId,1364 collection_type: misc::CollectionType,1365 ) -> DispatchResult {1366 let actual_type = Self::get_collection_type(collection_id)?;1367 ensure!(1368 actual_type == collection_type,1369 <CommonError<T>>::NoPermission1370 );13711372 Ok(())1373 }13741375 pub fn get_typed_nft_collection(1376 collection_id: CollectionId,1377 collection_type: misc::CollectionType,1378 ) -> Result<NonfungibleHandle<T>, DispatchError> {1379 Self::ensure_collection_type(collection_id, collection_type)?;13801381 Self::get_nft_collection(collection_id)1382 }13831384 pub fn get_typed_nft_collection_mapped(1385 rmrk_collection_id: RmrkCollectionId,1386 collection_type: misc::CollectionType,1387 ) -> Result<(NonfungibleHandle<T>, CollectionId), DispatchError> {1388 let unique_collection_id = match collection_type {1389 misc::CollectionType::Regular => Self::unique_collection_id(rmrk_collection_id)?,1390 _ => rmrk_collection_id.into(),1391 };13921393 let collection = Self::get_typed_nft_collection(unique_collection_id, collection_type)?;13941395 Ok((collection, unique_collection_id))1396 }13971398 pub fn get_nft_property(1399 collection_id: CollectionId,1400 nft_id: TokenId,1401 key: RmrkProperty,1402 ) -> Result<PropertyValue, DispatchError> {1403 let nft_property = <PalletNft<T>>::token_properties((collection_id, nft_id))1404 .get(&Self::rmrk_property_key(key)?)1405 .ok_or(<Error<T>>::NoAvailableNftId)? 1406 .clone();14071408 Ok(nft_property)1409 }14101411 pub fn get_nft_property_decoded<V: Decode>(1412 collection_id: CollectionId,1413 nft_id: TokenId,1414 key: RmrkProperty,1415 ) -> Result<V, DispatchError> {1416 Self::decode_property(Self::get_nft_property(collection_id, nft_id, key)?)1417 }14181419 pub fn nft_exists(collection_id: CollectionId, nft_id: TokenId) -> bool {1420 <TokenData<T>>::contains_key((collection_id, nft_id))1421 }14221423 pub fn get_nft_type(1424 collection_id: CollectionId,1425 token_id: TokenId,1426 ) -> Result<NftType, DispatchError> {1427 Self::get_nft_property_decoded(collection_id, token_id, TokenType)1428 .map_err(|_| <Error<T>>::NoAvailableNftId.into())1429 }14301431 pub fn ensure_nft_type(1432 collection_id: CollectionId,1433 token_id: TokenId,1434 nft_type: NftType,1435 ) -> DispatchResult {1436 let actual_type = Self::get_nft_type(collection_id, token_id)?;1437 ensure!(actual_type == nft_type, <Error<T>>::NoPermission);14381439 Ok(())1440 }14411442 pub fn ensure_nft_owner(1443 collection_id: CollectionId,1444 token_id: TokenId,1445 possible_owner: &T::CrossAccountId,1446 nesting_budget: &dyn budget::Budget,1447 ) -> DispatchResult {1448 let is_owned = <PalletStructure<T>>::check_indirectly_owned(1449 possible_owner.clone(),1450 collection_id,1451 token_id,1452 None,1453 nesting_budget,1454 )1455 .map_err(Self::map_unique_err_to_proxy)?;14561457 ensure!(is_owned, <Error<T>>::NoPermission);14581459 Ok(())1460 }14611462 pub fn filter_user_properties<Key, Value, R, Mapper>(1463 collection_id: CollectionId,1464 token_id: Option<TokenId>,1465 filter_keys: Option<Vec<RmrkPropertyKey>>,1466 mapper: Mapper,1467 ) -> Result<Vec<R>, DispatchError>1468 where1469 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,1470 Value: Decode + Default,1471 Mapper: Fn(Key, Value) -> R,1472 {1473 filter_keys1474 .map(|keys| {1475 let properties = keys1476 .into_iter()1477 .filter_map(|key| {1478 let key: Key = key.try_into().ok()?;14791480 let value = match token_id {1481 Some(token_id) => Self::get_nft_property_decoded(1482 collection_id,1483 token_id,1484 UserProperty(key.as_ref()),1485 ),1486 None => Self::get_collection_property_decoded(1487 collection_id,1488 UserProperty(key.as_ref()),1489 ),1490 }1491 .ok()?;14921493 Some(mapper(key, value))1494 })1495 .collect();14961497 Ok(properties)1498 })1499 .unwrap_or_else(|| {1500 let properties =1501 Self::iterate_user_properties(collection_id, token_id, mapper)?.collect();15021503 Ok(properties)1504 })1505 }15061507 pub fn iterate_user_properties<Key, Value, R, Mapper>(1508 collection_id: CollectionId,1509 token_id: Option<TokenId>,1510 mapper: Mapper,1511 ) -> Result<impl Iterator<Item = R>, DispatchError>1512 where1513 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,1514 Value: Decode + Default,1515 Mapper: Fn(Key, Value) -> R,1516 {1517 let key_prefix = Self::rmrk_property_key(UserProperty(b""))?;15181519 let properties = match token_id {1520 Some(token_id) => <PalletNft<T>>::token_properties((collection_id, token_id)),1521 None => <PalletCommon<T>>::collection_properties(collection_id),1522 };15231524 let properties = properties.into_iter().filter_map(move |(key, value)| {1525 let key = key.as_slice().strip_prefix(key_prefix.as_slice())?;15261527 let key: Key = key.to_vec().try_into().ok()?;1528 let value: Value = value.decode().ok()?;15291530 Some(mapper(key, value))1531 });15321533 Ok(properties)1534 }15351536 fn map_unique_err_to_proxy(err: DispatchError) -> DispatchError {1537 map_unique_err_to_proxy! {1538 match err {1539 CommonError::NoPermission => NoPermission,1540 CommonError::CollectionTokenLimitExceeded => CollectionFullOrLocked,1541 CommonError::PublicMintingNotAllowed => NoPermission,1542 CommonError::TokenNotFound => NoAvailableNftId,1543 CommonError::ApprovedValueTooLow => NoPermission,1544 CommonError::CantDestroyNotEmptyCollection => CollectionNotEmpty,1545 StructureError::TokenNotFound => NoAvailableNftId,1546 StructureError::OuroborosDetected => CannotSendToDescendentOrSelf,1547 }1548 }1549 }1550}