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::*;4748const 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,161162 163 CollectionNotEmpty,164 NoAvailableCollectionId,165 NoAvailableNftId,166 CollectionUnknown,167 NoPermission,168 NonTransferable,169 CollectionFullOrLocked,170 ResourceDoesntExist,171 CannotSendToDescendentOrSelf,172 CannotAcceptNonOwnedNft,173 CannotRejectNonOwnedNft,174 ResourceNotPending,175 }176177 #[pallet::call]178 impl<T: Config> Pallet<T> {179 180 #[transactional]181 #[pallet::weight(<SelfWeightOf<T>>::create_collection())]182 pub fn create_collection(183 origin: OriginFor<T>,184 metadata: RmrkString,185 max: Option<u32>,186 symbol: RmrkCollectionSymbol,187 ) -> DispatchResult {188 let sender = ensure_signed(origin)?;189190 let limits = CollectionLimits {191 owner_can_transfer: Some(false),192 token_limit: max,193 ..Default::default()194 };195196 let data = CreateCollectionData {197 limits: Some(limits),198 token_prefix: symbol199 .into_inner()200 .try_into()201 .map_err(|_| <CommonError<T>>::CollectionTokenPrefixLimitExceeded)?,202 permissions: Some(CollectionPermissions {203 nesting: Some(NestingPermissions {204 token_owner: true,205 admin: false,206 restricted: None,207208 permissive: false,209 }),210 ..Default::default()211 }),212 ..Default::default()213 };214215 let unique_collection_id = Self::init_collection(216 T::CrossAccountId::from_sub(sender.clone()),217 data,218 [219 Self::rmrk_property(Metadata, &metadata)?,220 Self::rmrk_property(CollectionType, &misc::CollectionType::Regular)?,221 ]222 .into_iter(),223 )?;224 let rmrk_collection_id = <CollectionIndex<T>>::get();225226 <UniqueCollectionId<T>>::insert(rmrk_collection_id, unique_collection_id);227 <RmrkInernalCollectionId<T>>::insert(unique_collection_id, rmrk_collection_id);228229 <CollectionIndex<T>>::mutate(|n| *n += 1);230231 Self::deposit_event(Event::CollectionCreated {232 issuer: sender,233 collection_id: rmrk_collection_id,234 });235236 Ok(())237 }238239 240 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]241 #[transactional]242 pub fn destroy_collection(243 origin: OriginFor<T>,244 collection_id: RmrkCollectionId,245 ) -> DispatchResult {246 let sender = ensure_signed(origin)?;247 let cross_sender = T::CrossAccountId::from_sub(sender.clone());248249 let collection = Self::get_typed_nft_collection(250 Self::unique_collection_id(collection_id)?,251 misc::CollectionType::Regular,252 )?;253 collection.check_is_external()?;254255 <PalletNft<T>>::destroy_collection(collection, &cross_sender)256 .map_err(Self::map_unique_err_to_proxy)?;257258 Self::deposit_event(Event::CollectionDestroyed {259 issuer: sender,260 collection_id,261 });262263 Ok(())264 }265266 267 268 269 270 271 272 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]273 #[transactional]274 pub fn change_collection_issuer(275 origin: OriginFor<T>,276 collection_id: RmrkCollectionId,277 new_issuer: <T::Lookup as StaticLookup>::Source,278 ) -> DispatchResult {279 let sender = ensure_signed(origin)?;280281 let collection = Self::get_nft_collection(Self::unique_collection_id(collection_id)?)?;282 collection.check_is_external()?;283284 let new_issuer = T::Lookup::lookup(new_issuer)?;285286 Self::change_collection_owner(287 Self::unique_collection_id(collection_id)?,288 misc::CollectionType::Regular,289 sender.clone(),290 new_issuer.clone(),291 )?;292293 Self::deposit_event(Event::IssuerChanged {294 old_issuer: sender,295 new_issuer,296 collection_id,297 });298299 Ok(())300 }301302 303 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]304 #[transactional]305 pub fn lock_collection(306 origin: OriginFor<T>,307 collection_id: RmrkCollectionId,308 ) -> DispatchResult {309 let sender = ensure_signed(origin)?;310 let cross_sender = T::CrossAccountId::from_sub(sender.clone());311312 let collection = Self::get_typed_nft_collection(313 Self::unique_collection_id(collection_id)?,314 misc::CollectionType::Regular,315 )?;316 collection.check_is_external()?;317318 Self::check_collection_owner(&collection, &cross_sender)?;319320 let token_count = collection.total_supply();321322 let mut collection = collection.into_inner();323 collection.limits.token_limit = Some(token_count);324 collection.save()?;325326 Self::deposit_event(Event::CollectionLocked {327 issuer: sender,328 collection_id,329 });330331 Ok(())332 }333334 335 336 337 338 339 340 341 342 343 344 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]345 #[transactional]346 pub fn mint_nft(347 origin: OriginFor<T>,348 owner: T::AccountId,349 collection_id: RmrkCollectionId,350 recipient: Option<T::AccountId>,351 royalty_amount: Option<Permill>,352 metadata: RmrkString,353 transferable: bool,354 ) -> DispatchResult {355 let sender = ensure_signed(origin)?;356 let sender = T::CrossAccountId::from_sub(sender);357 let cross_owner = T::CrossAccountId::from_sub(owner.clone());358359 let collection = Self::get_typed_nft_collection(360 Self::unique_collection_id(collection_id)?,361 misc::CollectionType::Regular,362 )?;363 collection.check_is_external()?;364365 let royalty_info = royalty_amount.map(|amount| rmrk_traits::RoyaltyInfo {366 recipient: recipient.unwrap_or_else(|| owner.clone()),367 amount,368 });369370 let nft_id = Self::create_nft(371 &sender,372 &cross_owner,373 &collection,374 [375 Self::rmrk_property(TokenType, &NftType::Regular)?,376 Self::rmrk_property(Transferable, &transferable)?,377 Self::rmrk_property(PendingNftAccept, &false)?,378 Self::rmrk_property(RoyaltyInfo, &royalty_info)?,379 Self::rmrk_property(Metadata, &metadata)?,380 Self::rmrk_property(Equipped, &false)?,381 Self::rmrk_property(382 ResourceCollection,383 &Self::init_collection(384 sender.clone(),385 CreateCollectionData {386 ..Default::default()387 },388 [Self::rmrk_property(389 CollectionType,390 &misc::CollectionType::Resource,391 )?]392 .into_iter(),393 )?,394 )?, 395 Self::rmrk_property(ResourcePriorities, &<Vec<u8>>::new())?,396 ]397 .into_iter(),398 )399 .map_err(|err| match err {400 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailableNftId.into(),401 err => Self::map_unique_err_to_proxy(err),402 })?;403404 Self::deposit_event(Event::NftMinted {405 owner,406 collection_id,407 nft_id: nft_id.0,408 });409410 Ok(())411 }412413 414 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]415 #[transactional]416 pub fn burn_nft(417 origin: OriginFor<T>,418 collection_id: RmrkCollectionId,419 nft_id: RmrkNftId,420 max_burns: u32,421 ) -> DispatchResult {422 let sender = ensure_signed(origin)?;423 let cross_sender = T::CrossAccountId::from_sub(sender.clone());424425 let collection = Self::get_typed_nft_collection(426 Self::unique_collection_id(collection_id)?,427 misc::CollectionType::Regular,428 )?;429 collection.check_is_external()?;430431 Self::destroy_nft(432 cross_sender,433 Self::unique_collection_id(collection_id)?,434 nft_id.into(),435 max_burns,436 <Error<T>>::NoPermission,437 )438 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;439440 Self::deposit_event(Event::NFTBurned {441 owner: sender,442 nft_id,443 });444445 Ok(())446 }447448 449 450 451 452 453 454 455 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]456 #[transactional]457 pub fn send(458 origin: OriginFor<T>,459 rmrk_collection_id: RmrkCollectionId,460 rmrk_nft_id: RmrkNftId,461 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,462 ) -> DispatchResult {463 let sender = ensure_signed(origin.clone())?;464 let cross_sender = T::CrossAccountId::from_sub(sender.clone());465466 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;467 let nft_id = rmrk_nft_id.into();468469 let collection =470 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;471 collection.check_is_external()?;472473 let token_data =474 <TokenData<T>>::get((collection_id, nft_id)).ok_or(<Error<T>>::NoAvailableNftId)?;475476 let from = token_data.owner;477478 ensure!(479 Self::get_nft_property_decoded(collection_id, nft_id, RmrkProperty::Transferable)?,480 <Error<T>>::NonTransferable481 );482483 ensure!(484 !Self::get_nft_property_decoded(485 collection_id,486 nft_id,487 RmrkProperty::PendingNftAccept488 )?,489 <Error<T>>::NoPermission490 );491492 let target_owner;493 let approval_required;494495 match new_owner {496 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {497 target_owner = T::CrossAccountId::from_sub(account_id.clone());498 approval_required = false;499 }500 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(501 target_collection_id,502 target_nft_id,503 ) => {504 let target_collection_id = Self::unique_collection_id(target_collection_id)?;505506 let target_nft_budget = budget::Value::new(NESTING_BUDGET);507508 let target_nft_owner = <PalletStructure<T>>::get_checked_topmost_owner(509 target_collection_id,510 target_nft_id.into(),511 Some((collection_id, nft_id)),512 &target_nft_budget,513 )514 .map_err(Self::map_unique_err_to_proxy)?;515516 approval_required = cross_sender != target_nft_owner;517518 if approval_required {519 target_owner = target_nft_owner;520521 <PalletNft<T>>::set_scoped_token_property(522 collection.id,523 nft_id,524 PropertyScope::Rmrk,525 Self::rmrk_property(PendingNftAccept, &approval_required)?,526 )?;527 } else {528 target_owner = T::CrossTokenAddressMapping::token_to_address(529 target_collection_id,530 target_nft_id.into(),531 );532 }533 }534 }535536 let src_nft_budget = budget::Value::new(NESTING_BUDGET);537538 <PalletNft<T>>::transfer_from(539 &collection,540 &cross_sender,541 &from,542 &target_owner,543 nft_id,544 &src_nft_budget,545 )546 .map_err(Self::map_unique_err_to_proxy)?;547548 Self::deposit_event(Event::NFTSent {549 sender,550 recipient: new_owner,551 collection_id: rmrk_collection_id,552 nft_id: rmrk_nft_id,553 approval_required,554 });555556 Ok(())557 }558559 560 561 562 563 564 565 566 567 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]568 #[transactional]569 pub fn accept_nft(570 origin: OriginFor<T>,571 rmrk_collection_id: RmrkCollectionId,572 rmrk_nft_id: RmrkNftId,573 new_owner: RmrkAccountIdOrCollectionNftTuple<T::AccountId>,574 ) -> DispatchResult {575 let sender = ensure_signed(origin.clone())?;576 let cross_sender = T::CrossAccountId::from_sub(sender.clone());577578 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;579 let nft_id = rmrk_nft_id.into();580581 let collection =582 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;583 collection.check_is_external()?;584585 let new_cross_owner = match new_owner {586 RmrkAccountIdOrCollectionNftTuple::AccountId(ref account_id) => {587 T::CrossAccountId::from_sub(account_id.clone())588 }589 RmrkAccountIdOrCollectionNftTuple::CollectionAndNftTuple(590 target_collection_id,591 target_nft_id,592 ) => {593 let target_collection_id = Self::unique_collection_id(target_collection_id)?;594595 T::CrossTokenAddressMapping::token_to_address(596 target_collection_id,597 TokenId(target_nft_id),598 )599 }600 };601602 let budget = budget::Value::new(NESTING_BUDGET);603604 <PalletNft<T>>::transfer(605 &collection,606 &cross_sender,607 &new_cross_owner,608 nft_id,609 &budget,610 )611 .map_err(|err| {612 if err == <CommonError<T>>::UserIsNotAllowedToNest.into() {613 <Error<T>>::CannotAcceptNonOwnedNft.into()614 } else {615 Self::map_unique_err_to_proxy(err)616 }617 })?;618619 <PalletNft<T>>::set_scoped_token_property(620 collection.id,621 nft_id,622 PropertyScope::Rmrk,623 Self::rmrk_property(PendingNftAccept, &false)?,624 )?;625626 Self::deposit_event(Event::NFTAccepted {627 sender,628 recipient: new_owner,629 collection_id: rmrk_collection_id,630 nft_id: rmrk_nft_id,631 });632633 Ok(())634 }635636 637 638 639 640 641 642 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]643 #[transactional]644 pub fn reject_nft(645 origin: OriginFor<T>,646 rmrk_collection_id: RmrkCollectionId,647 rmrk_nft_id: RmrkNftId,648 max_burns: u32,649 ) -> DispatchResult {650 let sender = ensure_signed(origin)?;651 let cross_sender = T::CrossAccountId::from_sub(sender.clone());652653 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;654 let nft_id = rmrk_nft_id.into();655656 let collection =657 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;658 collection.check_is_external()?;659660 Self::destroy_nft(661 cross_sender,662 collection_id,663 nft_id,664 max_burns,665 <Error<T>>::CannotRejectNonOwnedNft,666 )667 .map_err(|err| Self::map_unique_err_to_proxy(err.error))?;668669 Self::deposit_event(Event::NFTRejected {670 sender,671 collection_id: rmrk_collection_id,672 nft_id: rmrk_nft_id,673 });674675 Ok(())676 }677678 679 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]680 #[transactional]681 pub fn accept_resource(682 origin: OriginFor<T>,683 rmrk_collection_id: RmrkCollectionId,684 rmrk_nft_id: RmrkNftId,685 rmrk_resource_id: RmrkResourceId,686 ) -> DispatchResult {687 let sender = ensure_signed(origin)?;688 let cross_sender = T::CrossAccountId::from_sub(sender);689690 let collection_id = Self::unique_collection_id(rmrk_collection_id)691 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;692 let collection =693 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;694 collection.check_is_external()?;695696 let nft_id = rmrk_nft_id.into();697 let resource_id = rmrk_resource_id.into();698699 let budget = budget::Value::new(NESTING_BUDGET);700701 let nft_owner =702 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)703 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;704705 let resource_collection_id: CollectionId =706 Self::get_nft_property_decoded(collection_id, nft_id, ResourceCollection)707 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;708709 let is_pending: bool = Self::get_nft_property_decoded(710 resource_collection_id,711 resource_id,712 PendingResourceAccept,713 )714 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;715716 ensure!(is_pending, <Error<T>>::ResourceNotPending);717718 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);719720 <PalletNft<T>>::set_scoped_token_property(721 resource_collection_id,722 rmrk_resource_id.into(),723 PropertyScope::Rmrk,724 Self::rmrk_property(PendingResourceAccept, &false)?,725 )?;726727 Self::deposit_event(Event::<T>::ResourceAccepted {728 nft_id: rmrk_nft_id,729 resource_id: rmrk_resource_id,730 });731732 Ok(())733 }734735 736 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]737 #[transactional]738 pub fn accept_resource_removal(739 origin: OriginFor<T>,740 rmrk_collection_id: RmrkCollectionId,741 rmrk_nft_id: RmrkNftId,742 rmrk_resource_id: RmrkResourceId,743 ) -> DispatchResult {744 let sender = ensure_signed(origin)?;745 let cross_sender = T::CrossAccountId::from_sub(sender);746747 let collection_id = Self::unique_collection_id(rmrk_collection_id)748 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;749 let collection =750 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;751 collection.check_is_external()?;752753 let nft_id = rmrk_nft_id.into();754 let resource_id = rmrk_resource_id.into();755756 let budget = budget::Value::new(NESTING_BUDGET);757758 let nft_owner =759 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)760 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;761762 ensure!(cross_sender == nft_owner, <Error<T>>::NoPermission);763764 let resource_collection_id: CollectionId =765 Self::get_nft_property_decoded(collection_id, nft_id, ResourceCollection)766 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;767768 let is_pending: bool = Self::get_nft_property_decoded(769 resource_collection_id,770 resource_id,771 PendingResourceRemoval,772 )773 .map_err(|_| <Error<T>>::ResourceDoesntExist)?;774775 ensure!(is_pending, <Error<T>>::ResourceNotPending);776777 let resource_collection = Self::get_typed_nft_collection(778 resource_collection_id,779 misc::CollectionType::Resource,780 )?;781782 <PalletNft<T>>::burn(&resource_collection, &cross_sender, rmrk_resource_id.into())783 .map_err(Self::map_unique_err_to_proxy)?;784785 Self::deposit_event(Event::<T>::ResourceRemovalAccepted {786 nft_id: rmrk_nft_id,787 resource_id: rmrk_resource_id,788 });789790 Ok(())791 }792793 794 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]795 #[transactional]796 pub fn set_property(797 origin: OriginFor<T>,798 #[pallet::compact] rmrk_collection_id: RmrkCollectionId,799 maybe_nft_id: Option<RmrkNftId>,800 key: RmrkKeyString,801 value: RmrkValueString,802 ) -> DispatchResult {803 let sender = ensure_signed(origin)?;804 let sender = T::CrossAccountId::from_sub(sender);805806 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;807 let collection =808 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;809 collection.check_is_external()?;810811 let budget = budget::Value::new(NESTING_BUDGET);812813 match maybe_nft_id {814 Some(nft_id) => {815 let token_id: TokenId = nft_id.into();816817 Self::ensure_nft_type(collection_id, token_id, NftType::Regular)?;818 Self::ensure_nft_owner(collection_id, token_id, &sender, &budget)?;819820 <PalletNft<T>>::set_scoped_token_property(821 collection_id,822 token_id,823 PropertyScope::Rmrk,824 Self::rmrk_property(UserProperty(key.as_slice()), &value)?,825 )?;826 }827 None => {828 let collection = Self::get_typed_nft_collection(829 collection_id,830 misc::CollectionType::Regular,831 )?;832833 Self::check_collection_owner(&collection, &sender)?;834835 <PalletCommon<T>>::set_scoped_collection_property(836 collection_id,837 PropertyScope::Rmrk,838 Self::rmrk_property(UserProperty(key.as_slice()), &value)?,839 )?;840 }841 }842843 Self::deposit_event(Event::PropertySet {844 collection_id: rmrk_collection_id,845 maybe_nft_id,846 key,847 value,848 });849850 Ok(())851 }852853 854 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]855 #[transactional]856 pub fn set_priority(857 origin: OriginFor<T>,858 rmrk_collection_id: RmrkCollectionId,859 rmrk_nft_id: RmrkNftId,860 priorities: BoundedVec<RmrkResourceId, RmrkMaxPriorities>,861 ) -> DispatchResult {862 let sender = ensure_signed(origin)?;863 let sender = T::CrossAccountId::from_sub(sender);864865 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;866 let nft_id = rmrk_nft_id.into();867868 let collection =869 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;870 collection.check_is_external()?;871872 let budget = budget::Value::new(NESTING_BUDGET);873874 Self::ensure_nft_type(collection_id, nft_id, NftType::Regular)?;875 Self::ensure_nft_owner(collection_id, nft_id, &sender, &budget)?;876877 <PalletNft<T>>::set_scoped_token_property(878 collection_id,879 nft_id,880 PropertyScope::Rmrk,881 Self::rmrk_property(ResourcePriorities, &priorities.into_inner())?,882 )?;883884 Self::deposit_event(Event::<T>::PrioritySet {885 collection_id: rmrk_collection_id,886 nft_id: rmrk_nft_id,887 });888889 Ok(())890 }891892 893 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]894 #[transactional]895 pub fn add_basic_resource(896 origin: OriginFor<T>,897 rmrk_collection_id: RmrkCollectionId,898 nft_id: RmrkNftId,899 resource: RmrkBasicResource,900 ) -> DispatchResult {901 let sender = ensure_signed(origin.clone())?;902903 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;904 let collection =905 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;906 collection.check_is_external()?;907908 let resource_id = Self::resource_add(909 sender,910 collection_id,911 nft_id.into(),912 [913 Self::rmrk_property(TokenType, &NftType::Resource)?,914 Self::rmrk_property(ResourceType, &misc::ResourceType::Basic)?,915 Self::rmrk_property(Src, &resource.src)?,916 Self::rmrk_property(Metadata, &resource.metadata)?,917 Self::rmrk_property(License, &resource.license)?,918 Self::rmrk_property(Thumb, &resource.thumb)?,919 ]920 .into_iter(),921 )?;922923 Self::deposit_event(Event::ResourceAdded {924 nft_id,925 resource_id,926 });927 Ok(())928 }929930 931 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]932 #[transactional]933 pub fn add_composable_resource(934 origin: OriginFor<T>,935 rmrk_collection_id: RmrkCollectionId,936 nft_id: RmrkNftId,937 _resource_id: RmrkBoundedResource,938 resource: RmrkComposableResource,939 ) -> DispatchResult {940 let sender = ensure_signed(origin.clone())?;941942 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;943 let collection =944 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;945 collection.check_is_external()?;946947 let resource_id = Self::resource_add(948 sender,949 collection_id,950 nft_id.into(),951 [952 Self::rmrk_property(TokenType, &NftType::Resource)?,953 Self::rmrk_property(ResourceType, &misc::ResourceType::Composable)?,954 Self::rmrk_property(Parts, &resource.parts)?,955 Self::rmrk_property(Base, &resource.base)?,956 Self::rmrk_property(Src, &resource.src)?,957 Self::rmrk_property(Metadata, &resource.metadata)?,958 Self::rmrk_property(License, &resource.license)?,959 Self::rmrk_property(Thumb, &resource.thumb)?,960 ]961 .into_iter(),962 )?;963964 Self::deposit_event(Event::ResourceAdded {965 nft_id,966 resource_id,967 });968 Ok(())969 }970971 972 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]973 #[transactional]974 pub fn add_slot_resource(975 origin: OriginFor<T>,976 rmrk_collection_id: RmrkCollectionId,977 nft_id: RmrkNftId,978 resource: RmrkSlotResource,979 ) -> DispatchResult {980 let sender = ensure_signed(origin.clone())?;981982 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;983 let collection =984 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;985 collection.check_is_external()?;986987 let resource_id = Self::resource_add(988 sender,989 collection_id,990 nft_id.into(),991 [992 Self::rmrk_property(TokenType, &NftType::Resource)?,993 Self::rmrk_property(ResourceType, &misc::ResourceType::Slot)?,994 Self::rmrk_property(Base, &resource.base)?,995 Self::rmrk_property(Src, &resource.src)?,996 Self::rmrk_property(Metadata, &resource.metadata)?,997 Self::rmrk_property(Slot, &resource.slot)?,998 Self::rmrk_property(License, &resource.license)?,999 Self::rmrk_property(Thumb, &resource.thumb)?,1000 ]1001 .into_iter(),1002 )?;10031004 Self::deposit_event(Event::ResourceAdded {1005 nft_id,1006 resource_id,1007 });1008 Ok(())1009 }10101011 1012 #[pallet::weight(10_000 + T::DbWeight::get().reads_writes(1,1))]1013 #[transactional]1014 pub fn remove_resource(1015 origin: OriginFor<T>,1016 rmrk_collection_id: RmrkCollectionId,1017 nft_id: RmrkNftId,1018 resource_id: RmrkResourceId,1019 ) -> DispatchResult {1020 let sender = ensure_signed(origin.clone())?;10211022 let collection_id = Self::unique_collection_id(rmrk_collection_id)?;1023 let collection =1024 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1025 collection.check_is_external()?;10261027 Self::resource_remove(sender, collection_id, nft_id.into(), resource_id.into())?;10281029 Self::deposit_event(Event::ResourceRemoval {1030 nft_id,1031 resource_id,1032 });1033 Ok(())1034 }1035 }1036}10371038impl<T: Config> Pallet<T> {1039 pub fn rmrk_property_key(rmrk_key: RmrkProperty) -> Result<PropertyKey, DispatchError> {1040 let key = rmrk_key.to_key::<T>()?;10411042 let scoped_key = PropertyScope::Rmrk1043 .apply(key)1044 .map_err(|_| <Error<T>>::RmrkPropertyKeyIsTooLong)?;10451046 Ok(scoped_key)1047 }10481049 1050 pub fn rmrk_property<E: Encode>(1051 rmrk_key: RmrkProperty,1052 value: &E,1053 ) -> Result<Property, DispatchError> {1054 let key = rmrk_key.to_key::<T>()?;10551056 let value = value1057 .encode()1058 .try_into()1059 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong)?;10601061 let property = Property { key, value };10621063 Ok(property)1064 }10651066 pub fn decode_property<D: Decode>(vec: PropertyValue) -> Result<D, DispatchError> {1067 vec.decode()1068 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong.into())1069 }10701071 pub fn rebind<L, S>(vec: &BoundedVec<u8, L>) -> Result<BoundedVec<u8, S>, DispatchError>1072 where1073 BoundedVec<u8, S>: TryFrom<Vec<u8>>,1074 {1075 vec.rebind()1076 .map_err(|_| <Error<T>>::RmrkPropertyValueIsTooLong.into())1077 }10781079 fn init_collection(1080 sender: T::CrossAccountId,1081 data: CreateCollectionData<T::AccountId>,1082 properties: impl Iterator<Item = Property>,1083 ) -> Result<CollectionId, DispatchError> {1084 let collection_id = <PalletNft<T>>::init_collection(sender, data, true);10851086 if let Err(DispatchError::Arithmetic(_)) = &collection_id {1087 return Err(<Error<T>>::NoAvailableCollectionId.into());1088 }10891090 <PalletCommon<T>>::set_scoped_collection_properties(1091 collection_id?,1092 PropertyScope::Rmrk,1093 properties,1094 )?;10951096 collection_id1097 }10981099 pub fn create_nft(1100 sender: &T::CrossAccountId,1101 owner: &T::CrossAccountId,1102 collection: &NonfungibleHandle<T>,1103 properties: impl Iterator<Item = Property>,1104 ) -> Result<TokenId, DispatchError> {1105 let data = CreateNftExData {1106 properties: BoundedVec::default(),1107 owner: owner.clone(),1108 };11091110 let budget = budget::Value::new(NESTING_BUDGET);11111112 <PalletNft<T>>::create_item(collection, sender, data, &budget)?;11131114 let nft_id = <PalletNft<T>>::current_token_id(collection.id);11151116 <PalletNft<T>>::set_scoped_token_properties(1117 collection.id,1118 nft_id,1119 PropertyScope::Rmrk,1120 properties,1121 )?;11221123 Ok(nft_id)1124 }11251126 fn destroy_nft(1127 sender: T::CrossAccountId,1128 collection_id: CollectionId,1129 token_id: TokenId,1130 max_burns: u32,1131 error_if_not_owned: Error<T>,1132 ) -> DispatchResultWithPostInfo {1133 let collection =1134 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;11351136 let token_data =1137 <TokenData<T>>::get((collection_id, token_id)).ok_or(<Error<T>>::NoAvailableNftId)?;11381139 let from = token_data.owner;11401141 let owner_check_budget = budget::Value::new(NESTING_BUDGET);11421143 ensure!(1144 <PalletStructure<T>>::check_indirectly_owned(1145 sender.clone(),1146 collection_id,1147 token_id,1148 None,1149 &owner_check_budget1150 )?,1151 error_if_not_owned,1152 );11531154 let burns_budget = budget::Value::new(max_burns);1155 let breadth_budget = budget::Value::new(max_burns);11561157 <PalletNft<T>>::burn_recursively(1158 &collection,1159 &from,1160 token_id,1161 &burns_budget,1162 &breadth_budget,1163 )1164 }11651166 fn resource_add(1167 sender: T::AccountId,1168 collection_id: CollectionId,1169 token_id: TokenId,1170 resource_properties: impl Iterator<Item = Property>,1171 ) -> Result<RmrkResourceId, DispatchError> {1172 let collection =1173 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1174 ensure!(collection.owner == sender, Error::<T>::NoPermission);11751176 let sender = T::CrossAccountId::from_sub(sender);1177 let budget = budget::Value::new(NESTING_BUDGET);11781179 let nft_owner = <PalletStructure<T>>::find_topmost_owner(collection_id, token_id, &budget)1180 .map_err(Self::map_unique_err_to_proxy)?;11811182 let pending = sender != nft_owner;11831184 let resource_collection_id: CollectionId =1185 Self::get_nft_property_decoded(collection_id, token_id, ResourceCollection)?;1186 let resource_collection =1187 Self::get_typed_nft_collection(resource_collection_id, misc::CollectionType::Resource)?;11881189 11901191 let resource_id = Self::create_nft(1192 &sender,1193 &nft_owner,1194 &resource_collection,1195 resource_properties.chain(1196 [1197 Self::rmrk_property(PendingResourceAccept, &pending)?,1198 Self::rmrk_property(PendingResourceRemoval, &false)?,1199 ]1200 .into_iter(),1201 ),1202 )1203 .map_err(|err| match err {1204 DispatchError::Arithmetic(_) => <Error<T>>::NoAvailableNftId.into(),1205 err => Self::map_unique_err_to_proxy(err),1206 })?;12071208 Ok(resource_id.0)1209 }12101211 fn resource_remove(1212 sender: T::AccountId,1213 collection_id: CollectionId,1214 nft_id: TokenId,1215 resource_id: TokenId,1216 ) -> DispatchResult {1217 let collection =1218 Self::get_typed_nft_collection(collection_id, misc::CollectionType::Regular)?;1219 ensure!(collection.owner == sender, Error::<T>::NoPermission);12201221 let resource_collection_id: CollectionId =1222 Self::get_nft_property_decoded(collection_id, nft_id, ResourceCollection)?;1223 let resource_collection =1224 Self::get_typed_nft_collection(resource_collection_id, misc::CollectionType::Resource)?;1225 ensure!(1226 <PalletNft<T>>::token_exists(&resource_collection, resource_id),1227 Error::<T>::ResourceDoesntExist1228 );12291230 let budget = up_data_structs::budget::Value::new(NESTING_BUDGET);1231 let topmost_owner =1232 <PalletStructure<T>>::find_topmost_owner(collection_id, nft_id, &budget)?;12331234 let sender = T::CrossAccountId::from_sub(sender);1235 if topmost_owner == sender {1236 <PalletNft<T>>::burn(&resource_collection, &sender, resource_id)1237 .map_err(Self::map_unique_err_to_proxy)?;1238 } else {1239 <PalletNft<T>>::set_scoped_token_property(1240 resource_collection_id,1241 resource_id,1242 PropertyScope::Rmrk,1243 Self::rmrk_property(PendingResourceRemoval, &true)?,1244 )?;1245 }12461247 Ok(())1248 }12491250 fn change_collection_owner(1251 collection_id: CollectionId,1252 collection_type: misc::CollectionType,1253 sender: T::AccountId,1254 new_owner: T::AccountId,1255 ) -> DispatchResult {1256 let collection = Self::get_typed_nft_collection(collection_id, collection_type)?;1257 Self::check_collection_owner(&collection, &T::CrossAccountId::from_sub(sender))?;12581259 let mut collection = collection.into_inner();12601261 collection.owner = new_owner;1262 collection.save()1263 }12641265 fn check_collection_owner(1266 collection: &NonfungibleHandle<T>,1267 account: &T::CrossAccountId,1268 ) -> DispatchResult {1269 collection1270 .check_is_owner(account)1271 .map_err(Self::map_unique_err_to_proxy)1272 }12731274 pub fn last_collection_idx() -> RmrkCollectionId {1275 <CollectionIndex<T>>::get()1276 }12771278 pub fn unique_collection_id(1279 rmrk_collection_id: RmrkCollectionId,1280 ) -> Result<CollectionId, DispatchError> {1281 <UniqueCollectionId<T>>::try_get(rmrk_collection_id)1282 .map_err(|_| <Error<T>>::CollectionUnknown.into())1283 }12841285 pub fn rmrk_collection_id(1286 unique_collection_id: CollectionId,1287 ) -> Result<RmrkCollectionId, DispatchError> {1288 <RmrkInernalCollectionId<T>>::try_get(unique_collection_id)1289 .map_err(|_| <Error<T>>::CollectionUnknown.into())1290 }12911292 pub fn get_nft_collection(1293 collection_id: CollectionId,1294 ) -> Result<NonfungibleHandle<T>, DispatchError> {1295 let collection = <CollectionHandle<T>>::try_get(collection_id)1296 .map_err(|_| <Error<T>>::CollectionUnknown)?;12971298 match collection.mode {1299 CollectionMode::NFT => Ok(NonfungibleHandle::cast(collection)),1300 _ => Err(<Error<T>>::CollectionUnknown.into()),1301 }1302 }13031304 pub fn collection_exists(collection_id: CollectionId) -> bool {1305 <CollectionHandle<T>>::try_get(collection_id).is_ok()1306 }13071308 pub fn get_collection_property(1309 collection_id: CollectionId,1310 key: RmrkProperty,1311 ) -> Result<PropertyValue, DispatchError> {1312 let collection_property = <PalletCommon<T>>::collection_properties(collection_id)1313 .get(&Self::rmrk_property_key(key)?)1314 .ok_or(<Error<T>>::CollectionUnknown)?1315 .clone();13161317 Ok(collection_property)1318 }13191320 pub fn get_collection_property_decoded<V: Decode>(1321 collection_id: CollectionId,1322 key: RmrkProperty,1323 ) -> Result<V, DispatchError> {1324 Self::decode_property(Self::get_collection_property(collection_id, key)?)1325 }13261327 pub fn get_collection_type(1328 collection_id: CollectionId,1329 ) -> Result<misc::CollectionType, DispatchError> {1330 Self::get_collection_property_decoded(collection_id, CollectionType)1331 .map_err(|_| <Error<T>>::CorruptedCollectionType.into())1332 }13331334 pub fn ensure_collection_type(1335 collection_id: CollectionId,1336 collection_type: misc::CollectionType,1337 ) -> DispatchResult {1338 let actual_type = Self::get_collection_type(collection_id)?;1339 ensure!(1340 actual_type == collection_type,1341 <CommonError<T>>::NoPermission1342 );13431344 Ok(())1345 }13461347 pub fn get_typed_nft_collection(1348 collection_id: CollectionId,1349 collection_type: misc::CollectionType,1350 ) -> Result<NonfungibleHandle<T>, DispatchError> {1351 Self::ensure_collection_type(collection_id, collection_type)?;13521353 Self::get_nft_collection(collection_id)1354 }13551356 pub fn get_typed_nft_collection_mapped(1357 rmrk_collection_id: RmrkCollectionId,1358 collection_type: misc::CollectionType,1359 ) -> Result<(NonfungibleHandle<T>, CollectionId), DispatchError> {1360 let unique_collection_id = match collection_type {1361 misc::CollectionType::Regular => Self::unique_collection_id(rmrk_collection_id)?,1362 _ => rmrk_collection_id.into(),1363 };13641365 let collection = Self::get_typed_nft_collection(unique_collection_id, collection_type)?;13661367 Ok((collection, unique_collection_id))1368 }13691370 pub fn get_nft_property(1371 collection_id: CollectionId,1372 nft_id: TokenId,1373 key: RmrkProperty,1374 ) -> Result<PropertyValue, DispatchError> {1375 let nft_property = <PalletNft<T>>::token_properties((collection_id, nft_id))1376 .get(&Self::rmrk_property_key(key)?)1377 .ok_or(<Error<T>>::NoAvailableNftId)? 1378 .clone();13791380 Ok(nft_property)1381 }13821383 pub fn get_nft_property_decoded<V: Decode>(1384 collection_id: CollectionId,1385 nft_id: TokenId,1386 key: RmrkProperty,1387 ) -> Result<V, DispatchError> {1388 Self::decode_property(Self::get_nft_property(collection_id, nft_id, key)?)1389 }13901391 pub fn nft_exists(collection_id: CollectionId, nft_id: TokenId) -> bool {1392 <TokenData<T>>::contains_key((collection_id, nft_id))1393 }13941395 pub fn get_nft_type(1396 collection_id: CollectionId,1397 token_id: TokenId,1398 ) -> Result<NftType, DispatchError> {1399 Self::get_nft_property_decoded(collection_id, token_id, TokenType)1400 .map_err(|_| <Error<T>>::NoAvailableNftId.into())1401 }14021403 pub fn ensure_nft_type(1404 collection_id: CollectionId,1405 token_id: TokenId,1406 nft_type: NftType,1407 ) -> DispatchResult {1408 let actual_type = Self::get_nft_type(collection_id, token_id)?;1409 ensure!(actual_type == nft_type, <Error<T>>::NoPermission);14101411 Ok(())1412 }14131414 pub fn ensure_nft_owner(1415 collection_id: CollectionId,1416 token_id: TokenId,1417 possible_owner: &T::CrossAccountId,1418 nesting_budget: &dyn budget::Budget,1419 ) -> DispatchResult {1420 let is_owned = <PalletStructure<T>>::check_indirectly_owned(1421 possible_owner.clone(),1422 collection_id,1423 token_id,1424 None,1425 nesting_budget,1426 )1427 .map_err(Self::map_unique_err_to_proxy)?;14281429 ensure!(is_owned, <Error<T>>::NoPermission);14301431 Ok(())1432 }14331434 pub fn filter_user_properties<Key, Value, R, Mapper>(1435 collection_id: CollectionId,1436 token_id: Option<TokenId>,1437 filter_keys: Option<Vec<RmrkPropertyKey>>,1438 mapper: Mapper,1439 ) -> Result<Vec<R>, DispatchError>1440 where1441 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,1442 Value: Decode + Default,1443 Mapper: Fn(Key, Value) -> R,1444 {1445 filter_keys1446 .map(|keys| {1447 let properties = keys1448 .into_iter()1449 .filter_map(|key| {1450 let key: Key = key.try_into().ok()?;14511452 let value = match token_id {1453 Some(token_id) => Self::get_nft_property_decoded(1454 collection_id,1455 token_id,1456 UserProperty(key.as_ref()),1457 ),1458 None => Self::get_collection_property_decoded(1459 collection_id,1460 UserProperty(key.as_ref()),1461 ),1462 }1463 .ok()?;14641465 Some(mapper(key, value))1466 })1467 .collect();14681469 Ok(properties)1470 })1471 .unwrap_or_else(|| {1472 let properties =1473 Self::iterate_user_properties(collection_id, token_id, mapper)?.collect();14741475 Ok(properties)1476 })1477 }14781479 pub fn iterate_user_properties<Key, Value, R, Mapper>(1480 collection_id: CollectionId,1481 token_id: Option<TokenId>,1482 mapper: Mapper,1483 ) -> Result<impl Iterator<Item = R>, DispatchError>1484 where1485 Key: TryFrom<RmrkPropertyKey> + AsRef<[u8]>,1486 Value: Decode + Default,1487 Mapper: Fn(Key, Value) -> R,1488 {1489 let key_prefix = Self::rmrk_property_key(UserProperty(b""))?;14901491 let properties = match token_id {1492 Some(token_id) => <PalletNft<T>>::token_properties((collection_id, token_id)),1493 None => <PalletCommon<T>>::collection_properties(collection_id),1494 };14951496 let properties = properties.into_iter().filter_map(move |(key, value)| {1497 let key = key.as_slice().strip_prefix(key_prefix.as_slice())?;14981499 let key: Key = key.to_vec().try_into().ok()?;1500 let value: Value = value.decode().ok()?;15011502 Some(mapper(key, value))1503 });15041505 Ok(properties)1506 }15071508 fn map_unique_err_to_proxy(err: DispatchError) -> DispatchError {1509 map_unique_err_to_proxy! {1510 match err {1511 CommonError::NoPermission => NoPermission,1512 CommonError::CollectionTokenLimitExceeded => CollectionFullOrLocked,1513 CommonError::PublicMintingNotAllowed => NoPermission,1514 CommonError::TokenNotFound => NoAvailableNftId,1515 CommonError::ApprovedValueTooLow => NoPermission,1516 CommonError::CantDestroyNotEmptyCollection => CollectionNotEmpty,1517 StructureError::TokenNotFound => NoAvailableNftId,1518 StructureError::OuroborosDetected => CannotSendToDescendentOrSelf,1519 }1520 }1521 }1522}