difftreelog
fix bulk properties set
in: master
6 files changed
pallets/common/src/erc.rsdiffbeforeafterboth--- a/pallets/common/src/erc.rs
+++ b/pallets/common/src/erc.rs
@@ -125,7 +125,7 @@
.map(eth::Property::try_into)
.collect::<Result<Vec<_>>>()?;
- <Pallet<T>>::set_collection_properties(self, &caller, properties)
+ <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())
.map_err(dispatch_to_evm::<T>)
}
@@ -158,7 +158,8 @@
})
.collect::<Result<Vec<_>>>()?;
- <Pallet<T>>::delete_collection_properties(self, &caller, keys).map_err(dispatch_to_evm::<T>)
+ <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())
+ .map_err(dispatch_to_evm::<T>)
}
/// Get collection property.
pallets/common/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//! # Common pallet18//!19//! The Common pallet provides functionality for handling collections.20//!21//! ## Overview22//!23//! The Common pallet provides an interface for common collection operations for different collection types24//! (see [CommonCollectionOperations]), as well as a generic dispatcher for these, see [dispatch] module.25//! It also provides this functionality to EVM, see [erc] and [eth] modules.26//!27//! The Common pallet provides functions for:28//!29//! - Setting and approving collection sponsor.30//! - Get\set\delete allow list.31//! - Get\set\delete collection properties.32//! - Get\set\delete collection property permissions.33//! - Get\set\delete token property permissions.34//! - Get\set\delete collection administrators.35//! - Checking access permissions.36//!37//! ### Terminology38//! **Collection sponsor** - For the collection, you can set a sponsor, at whose expense it will39//! be possible to mint tokens.40//!41//! **Allow list** - List of users who have the right to minting tokens.42//!43//! **Collection properties** - Collection properties are simply key-value stores where various44//! metadata can be placed.45//!46//! **Permissions on token properties** - For each property in the token can be set permission47//! to change, see [`PropertyPermission`].48//!49//! **Collection administrator** - For a collection, you can set administrators who have the right50//! to most actions on the collection.5152#![warn(missing_docs)]53#![cfg_attr(not(feature = "std"), no_std)]54extern crate alloc;5556use core::ops::{Deref, DerefMut};57use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};58use sp_std::vec::Vec;59use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};60use evm_coder::ToLog;61use frame_support::{62 dispatch::{DispatchErrorWithPostInfo, DispatchResultWithPostInfo, Weight, PostDispatchInfo},63 ensure,64 traits::{Imbalance, Get, Currency, WithdrawReasons, ExistenceRequirement},65 dispatch::Pays,66 transactional,67};68use pallet_evm::GasWeightMapping;69use up_data_structs::{70 COLLECTION_NUMBER_LIMIT,71 Collection,72 RpcCollection,73 CollectionFlags,74 RpcCollectionFlags,75 CollectionId,76 CreateItemData,77 MAX_TOKEN_PREFIX_LENGTH,78 COLLECTION_ADMINS_LIMIT,79 TokenId,80 TokenChild,81 CollectionStats,82 MAX_TOKEN_OWNERSHIP,83 CollectionMode,84 NFT_SPONSOR_TRANSFER_TIMEOUT,85 FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,86 REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,87 MAX_SPONSOR_TIMEOUT,88 CUSTOM_DATA_LIMIT,89 CollectionLimits,90 CreateCollectionData,91 SponsorshipState,92 CreateItemExData,93 SponsoringRateLimit,94 budget::Budget,95 PhantomType,96 Property,97 Properties,98 PropertiesPermissionMap,99 PropertyKey,100 PropertyValue,101 PropertyPermission,102 PropertiesError,103 PropertyKeyPermission,104 TokenData,105 TrySetProperty,106 PropertyScope,107 // RMRK108 RmrkCollectionInfo,109 RmrkInstanceInfo,110 RmrkResourceInfo,111 RmrkPropertyInfo,112 RmrkBaseInfo,113 RmrkPartType,114 RmrkBoundedTheme,115 RmrkNftChild,116 CollectionPermissions,117};118use up_pov_estimate_rpc::PovInfo;119120pub use pallet::*;121use sp_core::H160;122use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};123#[cfg(feature = "runtime-benchmarks")]124pub mod benchmarking;125pub mod dispatch;126pub mod erc;127pub mod eth;128pub mod weights;129130/// Weight info.131pub type SelfWeightOf<T> = <T as Config>::WeightInfo;132133/// Collection handle contains information about collection data and id.134/// Also provides functionality to count consumed gas.135///136/// CollectionHandle is used as a generic wrapper for collections of all types.137/// It allows to perform common operations and queries on any collection type,138/// both completely general for all, as well as their respective implementations of [`CommonCollectionOperations`].139#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]140pub struct CollectionHandle<T: Config> {141 /// Collection id142 pub id: CollectionId,143 collection: Collection<T::AccountId>,144 /// Substrate recorder for counting consumed gas145 pub recorder: SubstrateRecorder<T>,146}147148impl<T: Config> WithRecorder<T> for CollectionHandle<T> {149 fn recorder(&self) -> &SubstrateRecorder<T> {150 &self.recorder151 }152 fn into_recorder(self) -> SubstrateRecorder<T> {153 self.recorder154 }155}156157impl<T: Config> CollectionHandle<T> {158 /// Same as [CollectionHandle::new] but with an explicit gas limit.159 pub fn new_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {160 <CollectionById<T>>::get(id).map(|collection| Self {161 id,162 collection,163 recorder: SubstrateRecorder::new(gas_limit),164 })165 }166167 /// Same as [CollectionHandle::new] but with an existed [`SubstrateRecorder`].168 pub fn new_with_recorder(id: CollectionId, recorder: SubstrateRecorder<T>) -> Option<Self> {169 <CollectionById<T>>::get(id).map(|collection| Self {170 id,171 collection,172 recorder,173 })174 }175176 /// Retrives collection data from storage and creates collection handle with default parameters.177 /// If collection not found return `None`178 pub fn new(id: CollectionId) -> Option<Self> {179 Self::new_with_gas_limit(id, u64::MAX)180 }181182 /// Same as [`CollectionHandle::new`] but if collection not found [CollectionNotFound](Error::CollectionNotFound) returned.183 pub fn try_get(id: CollectionId) -> Result<Self, DispatchError> {184 Ok(Self::new(id).ok_or(<Error<T>>::CollectionNotFound)?)185 }186187 /// Consume gas for reading.188 pub fn consume_store_reads(&self, reads: u64) -> evm_coder::execution::Result<()> {189 self.recorder190 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(191 <T as frame_system::Config>::DbWeight::get()192 .read193 .saturating_mul(reads),194 )))195 }196197 /// Consume gas for writing.198 pub fn consume_store_writes(&self, writes: u64) -> evm_coder::execution::Result<()> {199 self.recorder200 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(201 <T as frame_system::Config>::DbWeight::get()202 .write203 .saturating_mul(writes),204 )))205 }206207 /// Consume gas for reading and writing.208 pub fn consume_store_reads_and_writes(209 &self,210 reads: u64,211 writes: u64,212 ) -> evm_coder::execution::Result<()> {213 let weight = <T as frame_system::Config>::DbWeight::get();214 let reads = weight.read.saturating_mul(reads);215 let writes = weight.read.saturating_mul(writes);216 self.recorder217 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(218 reads.saturating_add(writes),219 )))220 }221222 /// Save collection to storage.223 pub fn save(&self) -> DispatchResult {224 <CollectionById<T>>::insert(self.id, &self.collection);225 Ok(())226 }227228 /// Set collection sponsor.229 ///230 /// Unique collections allows sponsoring for certain actions.231 /// This method allows you to set the sponsor of the collection.232 /// In order for sponsorship to become active, it must be confirmed through [`Self::confirm_sponsorship`].233 pub fn set_sponsor(234 &mut self,235 sender: &T::CrossAccountId,236 sponsor: T::AccountId,237 ) -> DispatchResult {238 self.check_is_internal()?;239 self.check_is_owner_or_admin(sender)?;240241 self.collection.sponsorship = SponsorshipState::Unconfirmed(sponsor.clone());242243 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor));244 <PalletEvm<T>>::deposit_log(245 erc::CollectionHelpersEvents::CollectionChanged {246 collection_id: eth::collection_id_to_address(self.id),247 }248 .to_log(T::ContractAddress::get()),249 );250251 self.save()252 }253254 /// Force set `sponsor`.255 ///256 /// Differs from [`set_sponsor`][`Self::set_sponsor`] in that confirmation257 /// from the `sponsor` is not required.258 ///259 /// # Arguments260 ///261 /// * `sender`: Caller's account.262 /// * `sponsor`: ID of the account of the sponsor-to-be.263 pub fn force_set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {264 self.check_is_internal()?;265266 self.collection.sponsorship = SponsorshipState::Confirmed(sponsor.clone());267268 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor.clone()));269 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sponsor));270 <PalletEvm<T>>::deposit_log(271 erc::CollectionHelpersEvents::CollectionChanged {272 collection_id: eth::collection_id_to_address(self.id),273 }274 .to_log(T::ContractAddress::get()),275 );276277 self.save()278 }279280 /// Confirm sponsorship281 ///282 /// In order for the sponsorship to become active, the user set as the sponsor must confirm their participation.283 /// Before confirming sponsorship, the user must be specified as the sponsor of the collection via [`Self::set_sponsor`].284 pub fn confirm_sponsorship(&mut self, sender: &T::AccountId) -> DispatchResult {285 self.check_is_internal()?;286 ensure!(287 self.collection.sponsorship.pending_sponsor() == Some(sender),288 Error::<T>::ConfirmSponsorshipFail289 );290291 self.collection.sponsorship = SponsorshipState::Confirmed(sender.clone());292293 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sender.clone()));294 <PalletEvm<T>>::deposit_log(295 erc::CollectionHelpersEvents::CollectionChanged {296 collection_id: eth::collection_id_to_address(self.id),297 }298 .to_log(T::ContractAddress::get()),299 );300301 self.save()302 }303304 /// Remove collection sponsor.305 pub fn remove_sponsor(&mut self, sender: &T::CrossAccountId) -> DispatchResult {306 self.check_is_internal()?;307 self.check_is_owner_or_admin(sender)?;308309 self.collection.sponsorship = SponsorshipState::Disabled;310311 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));312 <PalletEvm<T>>::deposit_log(313 erc::CollectionHelpersEvents::CollectionChanged {314 collection_id: eth::collection_id_to_address(self.id),315 }316 .to_log(T::ContractAddress::get()),317 );318 self.save()319 }320321 /// Force remove `sponsor`.322 ///323 /// Differs from `remove_sponsor` in that324 /// it doesn't require consent from the `owner` of the collection.325 pub fn force_remove_sponsor(&mut self) -> DispatchResult {326 self.check_is_internal()?;327328 self.collection.sponsorship = SponsorshipState::Disabled;329330 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));331 <PalletEvm<T>>::deposit_log(332 erc::CollectionHelpersEvents::CollectionChanged {333 collection_id: eth::collection_id_to_address(self.id),334 }335 .to_log(T::ContractAddress::get()),336 );337 self.save()338 }339340 /// Checks that the collection was created with, and must be operated upon through **Unique API**.341 /// Now check only the `external` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.342 pub fn check_is_internal(&self) -> DispatchResult {343 if self.flags.external {344 return Err(<Error<T>>::CollectionIsExternal)?;345 }346347 Ok(())348 }349350 /// Checks that the collection was created with, and must be operated upon through an **assimilated API**.351 /// Now check only the `external` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.352 pub fn check_is_external(&self) -> DispatchResult {353 if !self.flags.external {354 return Err(<Error<T>>::CollectionIsInternal)?;355 }356357 Ok(())358 }359}360361impl<T: Config> Deref for CollectionHandle<T> {362 type Target = Collection<T::AccountId>;363364 fn deref(&self) -> &Self::Target {365 &self.collection366 }367}368369impl<T: Config> DerefMut for CollectionHandle<T> {370 fn deref_mut(&mut self) -> &mut Self::Target {371 &mut self.collection372 }373}374375impl<T: Config> CollectionHandle<T> {376 /// Checks if the `user` is the owner of the collection.377 pub fn check_is_owner(&self, user: &T::CrossAccountId) -> DispatchResult {378 ensure!(*user.as_sub() == self.owner, <Error<T>>::NoPermission);379 Ok(())380 }381382 /// Returns **true** if the `user` is the owner or administrator of the collection.383 pub fn is_owner_or_admin(&self, user: &T::CrossAccountId) -> bool {384 *user.as_sub() == self.owner || <IsAdmin<T>>::get((self.id, user))385 }386387 /// Checks if the `user` is the owner or administrator of the collection.388 pub fn check_is_owner_or_admin(&self, user: &T::CrossAccountId) -> DispatchResult {389 ensure!(self.is_owner_or_admin(user), <Error<T>>::NoPermission);390 Ok(())391 }392393 /// Return **true** if `user` was not allowed to have tokens, and he can ignore such restrictions.394 pub fn ignores_allowance(&self, user: &T::CrossAccountId) -> bool {395 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)396 }397398 /// Return **true** if `user` does not have enough token parts, and he can ignore such restrictions.399 pub fn ignores_owned_amount(&self, user: &T::CrossAccountId) -> bool {400 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)401 }402403 /// Checks if the user is in the allow list. If not [Error::AddressNotInAllowlist] returns.404 pub fn check_allowlist(&self, user: &T::CrossAccountId) -> DispatchResult {405 ensure!(406 <Allowlist<T>>::get((self.id, user)),407 <Error<T>>::AddressNotInAllowlist408 );409 Ok(())410 }411412 /// Changes collection owner to another account413 /// #### Store read/writes414 /// 1 writes415 pub fn change_owner(416 &mut self,417 caller: T::CrossAccountId,418 new_owner: T::CrossAccountId,419 ) -> DispatchResult {420 self.check_is_internal()?;421 self.check_is_owner(&caller)?;422 self.collection.owner = new_owner.as_sub().clone();423424 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnerChanged(425 self.id,426 new_owner.as_sub().clone(),427 ));428 <PalletEvm<T>>::deposit_log(429 erc::CollectionHelpersEvents::CollectionChanged {430 collection_id: eth::collection_id_to_address(self.id),431 }432 .to_log(T::ContractAddress::get()),433 );434435 self.save()436 }437}438439#[frame_support::pallet]440pub mod pallet {441 use super::*;442 use dispatch::CollectionDispatch;443 use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};444 use frame_system::pallet_prelude::*;445 use frame_support::traits::Currency;446 use up_data_structs::{TokenId, mapping::TokenAddressMapping};447 use scale_info::TypeInfo;448 use weights::WeightInfo;449450 #[pallet::config]451 pub trait Config:452 frame_system::Config + pallet_evm_coder_substrate::Config + pallet_evm::Config + TypeInfo453 {454 /// Weight information for functions of this pallet.455 type WeightInfo: WeightInfo;456457 /// Events compatible with [`frame_system::Config::Event`].458 type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;459460 /// Handler of accounts and payment.461 type Currency: Currency<Self::AccountId>;462463 /// Set price to create a collection.464 #[pallet::constant]465 type CollectionCreationPrice: Get<466 <<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,467 >;468469 /// Dispatcher of operations on collections.470 type CollectionDispatch: CollectionDispatch<Self>;471472 /// Account which holds the chain's treasury.473 type TreasuryAccountId: Get<Self::AccountId>;474475 /// Address under which the CollectionHelper contract would be available.476 #[pallet::constant]477 type ContractAddress: Get<H160>;478479 /// Mapper for token addresses to Ethereum addresses.480 type EvmTokenAddressMapping: TokenAddressMapping<H160>;481482 /// Mapper for token addresses to [`CrossAccountId`].483 type CrossTokenAddressMapping: TokenAddressMapping<Self::CrossAccountId>;484 }485486 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);487488 #[pallet::pallet]489 #[pallet::storage_version(STORAGE_VERSION)]490 #[pallet::generate_store(pub(super) trait Store)]491 pub struct Pallet<T>(_);492493 #[pallet::extra_constants]494 impl<T: Config> Pallet<T> {495 /// Maximum admins per collection.496 pub fn collection_admins_limit() -> u32 {497 COLLECTION_ADMINS_LIMIT498 }499 }500501 #[pallet::event]502 #[pallet::generate_deposit(pub fn deposit_event)]503 pub enum Event<T: Config> {504 /// New collection was created505 CollectionCreated(506 /// Globally unique identifier of newly created collection.507 CollectionId,508 /// [`CollectionMode`] converted into _u8_.509 u8,510 /// Collection owner.511 T::AccountId,512 ),513514 /// New collection was destroyed515 CollectionDestroyed(516 /// Globally unique identifier of collection.517 CollectionId,518 ),519520 /// New item was created.521 ItemCreated(522 /// Id of the collection where item was created.523 CollectionId,524 /// Id of an item. Unique within the collection.525 TokenId,526 /// Owner of newly created item527 T::CrossAccountId,528 /// Always 1 for NFT529 u128,530 ),531532 /// Collection item was burned.533 ItemDestroyed(534 /// Id of the collection where item was destroyed.535 CollectionId,536 /// Identifier of burned NFT.537 TokenId,538 /// Which user has destroyed its tokens.539 T::CrossAccountId,540 /// Amount of token pieces destroed. Always 1 for NFT.541 u128,542 ),543544 /// Item was transferred545 Transfer(546 /// Id of collection to which item is belong.547 CollectionId,548 /// Id of an item.549 TokenId,550 /// Original owner of item.551 T::CrossAccountId,552 /// New owner of item.553 T::CrossAccountId,554 /// Amount of token pieces transfered. Always 1 for NFT.555 u128,556 ),557558 /// Amount pieces of token owned by `sender` was approved for `spender`.559 Approved(560 /// Id of collection to which item is belong.561 CollectionId,562 /// Id of an item.563 TokenId,564 /// Original owner of item.565 T::CrossAccountId,566 /// Id for which the approval was granted.567 T::CrossAccountId,568 /// Amount of token pieces transfered. Always 1 for NFT.569 u128,570 ),571572 /// A `sender` approves operations on all owned tokens for `spender`.573 ApprovedForAll(574 /// Id of collection to which item is belong.575 CollectionId,576 /// Owner of a wallet.577 T::CrossAccountId,578 /// Id for which operator status was granted or rewoked.579 T::CrossAccountId,580 /// Is operator status granted or revoked?581 bool,582 ),583584 /// The colletion property has been added or edited.585 CollectionPropertySet(586 /// Id of collection to which property has been set.587 CollectionId,588 /// The property that was set.589 PropertyKey,590 ),591592 /// The property has been deleted.593 CollectionPropertyDeleted(594 /// Id of collection to which property has been deleted.595 CollectionId,596 /// The property that was deleted.597 PropertyKey,598 ),599600 /// The token property has been added or edited.601 TokenPropertySet(602 /// Identifier of the collection whose token has the property set.603 CollectionId,604 /// The token for which the property was set.605 TokenId,606 /// The property that was set.607 PropertyKey,608 ),609610 /// The token property has been deleted.611 TokenPropertyDeleted(612 /// Identifier of the collection whose token has the property deleted.613 CollectionId,614 /// The token for which the property was deleted.615 TokenId,616 /// The property that was deleted.617 PropertyKey,618 ),619620 /// The token property permission of a collection has been set.621 PropertyPermissionSet(622 /// ID of collection to which property permission has been set.623 CollectionId,624 /// The property permission that was set.625 PropertyKey,626 ),627628 /// Address was added to the allow list.629 AllowListAddressAdded(630 /// ID of the affected collection.631 CollectionId,632 /// Address of the added account.633 T::CrossAccountId,634 ),635636 /// Address was removed from the allow list.637 AllowListAddressRemoved(638 /// ID of the affected collection.639 CollectionId,640 /// Address of the removed account.641 T::CrossAccountId,642 ),643644 /// Collection admin was added.645 CollectionAdminAdded(646 /// ID of the affected collection.647 CollectionId,648 /// Admin address.649 T::CrossAccountId,650 ),651652 /// Collection admin was removed.653 CollectionAdminRemoved(654 /// ID of the affected collection.655 CollectionId,656 /// Removed admin address.657 T::CrossAccountId,658 ),659660 /// Collection limits were set.661 CollectionLimitSet(662 /// ID of the affected collection.663 CollectionId,664 ),665666 /// Collection owned was changed.667 CollectionOwnerChanged(668 /// ID of the affected collection.669 CollectionId,670 /// New owner address.671 T::AccountId,672 ),673674 /// Collection permissions were set.675 CollectionPermissionSet(676 /// ID of the affected collection.677 CollectionId,678 ),679680 /// Collection sponsor was set.681 CollectionSponsorSet(682 /// ID of the affected collection.683 CollectionId,684 /// New sponsor address.685 T::AccountId,686 ),687688 /// New sponsor was confirm.689 SponsorshipConfirmed(690 /// ID of the affected collection.691 CollectionId,692 /// New sponsor address.693 T::AccountId,694 ),695696 /// Collection sponsor was removed.697 CollectionSponsorRemoved(698 /// ID of the affected collection.699 CollectionId,700 ),701 }702703 #[pallet::error]704 pub enum Error<T> {705 /// This collection does not exist.706 CollectionNotFound,707 /// Sender parameter and item owner must be equal.708 MustBeTokenOwner,709 /// No permission to perform action710 NoPermission,711 /// Destroying only empty collections is allowed712 CantDestroyNotEmptyCollection,713 /// Collection is not in mint mode.714 PublicMintingNotAllowed,715 /// Address is not in allow list.716 AddressNotInAllowlist,717718 /// Collection name can not be longer than 63 char.719 CollectionNameLimitExceeded,720 /// Collection description can not be longer than 255 char.721 CollectionDescriptionLimitExceeded,722 /// Token prefix can not be longer than 15 char.723 CollectionTokenPrefixLimitExceeded,724 /// Total collections bound exceeded.725 TotalCollectionsLimitExceeded,726 /// Exceeded max admin count727 CollectionAdminCountExceeded,728 /// Collection limit bounds per collection exceeded729 CollectionLimitBoundsExceeded,730 /// Tried to enable permissions which are only permitted to be disabled731 OwnerPermissionsCantBeReverted,732 /// Collection settings not allowing items transferring733 TransferNotAllowed,734 /// Account token limit exceeded per collection735 AccountTokenLimitExceeded,736 /// Collection token limit exceeded737 CollectionTokenLimitExceeded,738 /// Metadata flag frozen739 MetadataFlagFrozen,740741 /// Item does not exist742 TokenNotFound,743 /// Item is balance not enough744 TokenValueTooLow,745 /// Requested value is more than the approved746 ApprovedValueTooLow,747 /// Tried to approve more than owned748 CantApproveMoreThanOwned,749 /// Only spending from eth mirror could be approved750 AddressIsNotEthMirror,751752 /// Can't transfer tokens to ethereum zero address753 AddressIsZero,754755 /// The operation is not supported756 UnsupportedOperation,757758 /// Insufficient funds to perform an action759 NotSufficientFounds,760761 /// User does not satisfy the nesting rule762 UserIsNotAllowedToNest,763 /// Only tokens from specific collections may nest tokens under this one764 SourceCollectionIsNotAllowedToNest,765766 /// Tried to store more data than allowed in collection field767 CollectionFieldSizeExceeded,768769 /// Tried to store more property data than allowed770 NoSpaceForProperty,771772 /// Tried to store more property keys than allowed773 PropertyLimitReached,774775 /// Property key is too long776 PropertyKeyIsTooLong,777778 /// Only ASCII letters, digits, and symbols `_`, `-`, and `.` are allowed779 InvalidCharacterInPropertyKey,780781 /// Empty property keys are forbidden782 EmptyPropertyKey,783784 /// Tried to access an external collection with an internal API785 CollectionIsExternal,786787 /// Tried to access an internal collection with an external API788 CollectionIsInternal,789790 /// This address is not set as sponsor, use setCollectionSponsor first.791 ConfirmSponsorshipFail,792793 /// The user is not an administrator.794 UserIsNotCollectionAdmin,795 }796797 /// Storage of the count of created collections. Essentially contains the last collection ID.798 #[pallet::storage]799 pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;800801 /// Storage of the count of deleted collections.802 #[pallet::storage]803 pub type DestroyedCollectionCount<T> =804 StorageValue<Value = CollectionId, QueryKind = ValueQuery>;805806 /// Storage of collection info.807 #[pallet::storage]808 pub type CollectionById<T> = StorageMap<809 Hasher = Blake2_128Concat,810 Key = CollectionId,811 Value = Collection<<T as frame_system::Config>::AccountId>,812 QueryKind = OptionQuery,813 >;814815 /// Storage of collection properties.816 #[pallet::storage]817 #[pallet::getter(fn collection_properties)]818 pub type CollectionProperties<T> = StorageMap<819 Hasher = Blake2_128Concat,820 Key = CollectionId,821 Value = Properties,822 QueryKind = ValueQuery,823 OnEmpty = up_data_structs::CollectionProperties,824 >;825826 /// Storage of token property permissions of a collection.827 #[pallet::storage]828 #[pallet::getter(fn property_permissions)]829 pub type CollectionPropertyPermissions<T> = StorageMap<830 Hasher = Blake2_128Concat,831 Key = CollectionId,832 Value = PropertiesPermissionMap,833 QueryKind = ValueQuery,834 >;835836 /// Storage of the amount of collection admins.837 #[pallet::storage]838 pub type AdminAmount<T> = StorageMap<839 Hasher = Blake2_128Concat,840 Key = CollectionId,841 Value = u32,842 QueryKind = ValueQuery,843 >;844845 /// List of collection admins.846 #[pallet::storage]847 pub type IsAdmin<T: Config> = StorageNMap<848 Key = (849 Key<Blake2_128Concat, CollectionId>,850 Key<Blake2_128Concat, T::CrossAccountId>,851 ),852 Value = bool,853 QueryKind = ValueQuery,854 >;855856 /// Allowlisted collection users.857 #[pallet::storage]858 pub type Allowlist<T: Config> = StorageNMap<859 Key = (860 Key<Blake2_128Concat, CollectionId>,861 Key<Blake2_128Concat, T::CrossAccountId>,862 ),863 Value = bool,864 QueryKind = ValueQuery,865 >;866867 /// Not used by code, exists only to provide some types to metadata.868 #[pallet::storage]869 pub type DummyStorageValue<T: Config> = StorageValue<870 Value = (871 CollectionStats,872 CollectionId,873 TokenId,874 TokenChild,875 PhantomType<(876 TokenData<T::CrossAccountId>,877 RpcCollection<T::AccountId>,878 // RMRK879 RmrkCollectionInfo<T::AccountId>,880 RmrkInstanceInfo<T::AccountId>,881 RmrkResourceInfo,882 RmrkPropertyInfo,883 RmrkBaseInfo<T::AccountId>,884 RmrkPartType,885 RmrkBoundedTheme,886 RmrkNftChild,887 // PoV Estimate Info888 PovInfo,889 )>,890 ),891 QueryKind = OptionQuery,892 >;893894 #[pallet::hooks]895 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {896 fn on_runtime_upgrade() -> Weight {897 StorageVersion::new(1).put::<Pallet<T>>();898899 Weight::zero()900 }901 }902}903904impl<T: Config> Pallet<T> {905 /// Enshure that receiver address is correct.906 ///907 /// Ethereum receiver 0x0000000000000000000000000000000000000000 is reserved, and shouldn't own tokens.908 pub fn ensure_correct_receiver(receiver: &T::CrossAccountId) -> DispatchResult {909 ensure!(910 &T::CrossAccountId::from_eth(H160([0; 20])) != receiver,911 <Error<T>>::AddressIsZero912 );913 Ok(())914 }915916 /// Get a vector of collection admins.917 pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {918 <IsAdmin<T>>::iter_prefix((collection,))919 .map(|(a, _)| a)920 .collect()921 }922923 /// Get a vector of users allowed to mint tokens.924 pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {925 <Allowlist<T>>::iter_prefix((collection,))926 .map(|(a, _)| a)927 .collect()928 }929930 /// Is `user` allowed to mint token in `collection`.931 pub fn allowed(collection: CollectionId, user: T::CrossAccountId) -> bool {932 <Allowlist<T>>::get((collection, user))933 }934935 /// Get statistics of collections.936 pub fn collection_stats() -> CollectionStats {937 let created = <CreatedCollectionCount<T>>::get();938 let destroyed = <DestroyedCollectionCount<T>>::get();939 CollectionStats {940 created: created.0,941 destroyed: destroyed.0,942 alive: created.0 - destroyed.0,943 }944 }945946 /// Get the effective limits for the collection.947 pub fn effective_collection_limits(collection: CollectionId) -> Option<CollectionLimits> {948 let collection = <CollectionById<T>>::get(collection)?;949 let limits = collection.limits;950 let effective_limits = CollectionLimits {951 account_token_ownership_limit: Some(limits.account_token_ownership_limit()),952 sponsored_data_size: Some(limits.sponsored_data_size()),953 sponsored_data_rate_limit: Some(954 limits955 .sponsored_data_rate_limit956 .unwrap_or(SponsoringRateLimit::SponsoringDisabled),957 ),958 token_limit: Some(limits.token_limit()),959 sponsor_transfer_timeout: Some(limits.sponsor_transfer_timeout(960 match collection.mode {961 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,962 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,963 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,964 },965 )),966 sponsor_approve_timeout: Some(limits.sponsor_approve_timeout()),967 owner_can_transfer: Some(limits.owner_can_transfer()),968 owner_can_destroy: Some(limits.owner_can_destroy()),969 transfers_enabled: Some(limits.transfers_enabled()),970 };971972 Some(effective_limits)973 }974975 /// Returns information about the `collection` adapted for rpc.976 pub fn rpc_collection(collection: CollectionId) -> Option<RpcCollection<T::AccountId>> {977 let Collection {978 name,979 description,980 owner,981 mode,982 token_prefix,983 sponsorship,984 limits,985 permissions,986 flags,987 } = <CollectionById<T>>::get(collection)?;988989 let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)990 .into_iter()991 .map(|(key, permission)| PropertyKeyPermission { key, permission })992 .collect();993994 let properties = <CollectionProperties<T>>::get(collection)995 .into_iter()996 .map(|(key, value)| Property { key, value })997 .collect();998999 let permissions = CollectionPermissions {1000 access: Some(permissions.access()),1001 mint_mode: Some(permissions.mint_mode()),1002 nesting: Some(permissions.nesting().clone()),1003 };10041005 Some(RpcCollection {1006 name: name.into_inner(),1007 description: description.into_inner(),1008 owner,1009 mode,1010 token_prefix: token_prefix.into_inner(),1011 sponsorship,1012 limits,1013 permissions,1014 token_property_permissions,1015 properties,1016 read_only: flags.external,10171018 flags: RpcCollectionFlags {1019 foreign: flags.foreign,1020 erc721metadata: flags.erc721metadata,1021 },1022 })1023 }1024}10251026macro_rules! limit_default {1027 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1028 $(1029 if let Some($new) = $new.$field {1030 let $old = $old.$field($($arg)?);1031 let _ = $new;1032 let _ = $old;1033 $check1034 } else {1035 $new.$field = $old.$field1036 }1037 )*1038 }};1039}1040macro_rules! limit_default_clone {1041 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1042 $(1043 if let Some($new) = $new.$field.clone() {1044 let $old = $old.$field($($arg)?);1045 let _ = $new;1046 let _ = $old;1047 $check1048 } else {1049 $new.$field = $old.$field.clone()1050 }1051 )*1052 }};1053}10541055impl<T: Config> Pallet<T> {1056 /// Create new collection.1057 ///1058 /// * `owner` - The owner of the collection.1059 /// * `data` - Description of the created collection.1060 /// * `flags` - Extra flags to store.1061 pub fn init_collection(1062 owner: T::CrossAccountId,1063 payer: T::CrossAccountId,1064 data: CreateCollectionData<T::AccountId>,1065 flags: CollectionFlags,1066 ) -> Result<CollectionId, DispatchError> {1067 {1068 ensure!(1069 data.token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH as usize,1070 Error::<T>::CollectionTokenPrefixLimitExceeded1071 );1072 }10731074 let created_count = <CreatedCollectionCount<T>>::get()1075 .01076 .checked_add(1)1077 .ok_or(ArithmeticError::Overflow)?;1078 let destroyed_count = <DestroyedCollectionCount<T>>::get().0;1079 let id = CollectionId(created_count);10801081 // bound Total number of collections1082 ensure!(1083 created_count - destroyed_count <= COLLECTION_NUMBER_LIMIT,1084 <Error<T>>::TotalCollectionsLimitExceeded1085 );10861087 // =========10881089 let collection = Collection {1090 owner: owner.as_sub().clone(),1091 name: data.name,1092 mode: data.mode.clone(),1093 description: data.description,1094 token_prefix: data.token_prefix,1095 sponsorship: data1096 .pending_sponsor1097 .map(SponsorshipState::Unconfirmed)1098 .unwrap_or_default(),1099 limits: data1100 .limits1101 .map(|limits| Self::clamp_limits(data.mode.clone(), &Default::default(), limits))1102 .unwrap_or_else(|| Ok(CollectionLimits::default()))?,1103 permissions: data1104 .permissions1105 .map(|permissions| {1106 Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)1107 })1108 .unwrap_or_else(|| Ok(CollectionPermissions::default()))?,1109 flags,1110 };11111112 let mut collection_properties = up_data_structs::CollectionProperties::get();1113 collection_properties1114 .try_set_from_iter(data.properties.into_iter())1115 .map_err(<Error<T>>::from)?;11161117 CollectionProperties::<T>::insert(id, collection_properties);11181119 let mut token_props_permissions = PropertiesPermissionMap::new();1120 token_props_permissions1121 .try_set_from_iter(data.token_property_permissions.into_iter())1122 .map_err(<Error<T>>::from)?;11231124 CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);11251126 // Take a (non-refundable) deposit of collection creation1127 {1128 let mut imbalance =1129 <<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();1130 imbalance.subsume(1131 <<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(1132 &T::TreasuryAccountId::get(),1133 T::CollectionCreationPrice::get(),1134 ),1135 );1136 <T as Config>::Currency::settle(1137 payer.as_sub(),1138 imbalance,1139 WithdrawReasons::TRANSFER,1140 ExistenceRequirement::KeepAlive,1141 )1142 .map_err(|_| Error::<T>::NotSufficientFounds)?;1143 }11441145 <CreatedCollectionCount<T>>::put(created_count);1146 <Pallet<T>>::deposit_event(Event::CollectionCreated(1147 id,1148 data.mode.id(),1149 owner.as_sub().clone(),1150 ));1151 <PalletEvm<T>>::deposit_log(1152 erc::CollectionHelpersEvents::CollectionCreated {1153 owner: *owner.as_eth(),1154 collection_id: eth::collection_id_to_address(id),1155 }1156 .to_log(T::ContractAddress::get()),1157 );1158 <CollectionById<T>>::insert(id, collection);1159 Ok(id)1160 }11611162 /// Destroy collection.1163 ///1164 /// * `collection` - Collection handler.1165 /// * `sender` - The owner or administrator of the collection.1166 pub fn destroy_collection(1167 collection: CollectionHandle<T>,1168 sender: &T::CrossAccountId,1169 ) -> DispatchResult {1170 ensure!(1171 collection.limits.owner_can_destroy(),1172 <Error<T>>::NoPermission,1173 );1174 collection.check_is_owner(sender)?;11751176 let destroyed_collections = <DestroyedCollectionCount<T>>::get()1177 .01178 .checked_add(1)1179 .ok_or(ArithmeticError::Overflow)?;11801181 // =========11821183 <DestroyedCollectionCount<T>>::put(destroyed_collections);1184 <CollectionById<T>>::remove(collection.id);1185 <AdminAmount<T>>::remove(collection.id);1186 let _ = <IsAdmin<T>>::clear_prefix((collection.id,), u32::MAX, None);1187 let _ = <Allowlist<T>>::clear_prefix((collection.id,), u32::MAX, None);1188 <CollectionProperties<T>>::remove(collection.id);11891190 <Pallet<T>>::deposit_event(Event::CollectionDestroyed(collection.id));11911192 <PalletEvm<T>>::deposit_log(1193 erc::CollectionHelpersEvents::CollectionDestroyed {1194 collection_id: eth::collection_id_to_address(collection.id),1195 }1196 .to_log(T::ContractAddress::get()),1197 );1198 Ok(())1199 }12001201 /// Set collection property.1202 ///1203 /// * `collection` - Collection handler.1204 /// * `sender` - The owner or administrator of the collection.1205 /// * `property` - The property to set.1206 pub fn set_collection_property(1207 collection: &CollectionHandle<T>,1208 sender: &T::CrossAccountId,1209 property: Property,1210 ) -> DispatchResult {1211 collection.check_is_owner_or_admin(sender)?;12121213 CollectionProperties::<T>::try_mutate(collection.id, |properties| {1214 let property = property.clone();1215 properties.try_set(property.key, property.value)1216 })1217 .map_err(<Error<T>>::from)?;12181219 Self::deposit_event(Event::CollectionPropertySet(collection.id, property.key));1220 <PalletEvm<T>>::deposit_log(1221 erc::CollectionHelpersEvents::CollectionChanged {1222 collection_id: eth::collection_id_to_address(collection.id),1223 }1224 .to_log(T::ContractAddress::get()),1225 );12261227 Ok(())1228 }12291230 /// Set a scoped collection property, where the scope is a special prefix1231 /// prohibiting a user access to change the property directly.1232 ///1233 /// * `collection_id` - ID of the collection for which the property is being set.1234 /// * `scope` - Property scope.1235 /// * `property` - The property to set.1236 pub fn set_scoped_collection_property(1237 collection_id: CollectionId,1238 scope: PropertyScope,1239 property: Property,1240 ) -> DispatchResult {1241 CollectionProperties::<T>::try_mutate(collection_id, |properties| {1242 properties.try_scoped_set(scope, property.key, property.value)1243 })1244 .map_err(<Error<T>>::from)?;12451246 Ok(())1247 }12481249 /// Set scoped collection properties, where the scope is a special prefix1250 /// prohibiting a user access to change the properties directly.1251 ///1252 /// * `collection_id` - ID of the collection for which the properties is being set.1253 /// * `scope` - Property scope.1254 /// * `properties` - The properties to set.1255 pub fn set_scoped_collection_properties(1256 collection_id: CollectionId,1257 scope: PropertyScope,1258 properties: impl Iterator<Item = Property>,1259 ) -> DispatchResult {1260 CollectionProperties::<T>::try_mutate(collection_id, |stored_properties| {1261 stored_properties.try_scoped_set_from_iter(scope, properties)1262 })1263 .map_err(<Error<T>>::from)?;12641265 Ok(())1266 }12671268 /// Set collection properties.1269 ///1270 /// * `collection` - Collection handler.1271 /// * `sender` - The owner or administrator of the collection.1272 /// * `properties` - The properties to set.1273 #[transactional]1274 pub fn set_collection_properties(1275 collection: &CollectionHandle<T>,1276 sender: &T::CrossAccountId,1277 properties: Vec<Property>,1278 ) -> DispatchResult {1279 for property in properties {1280 Self::set_collection_property(collection, sender, property)?;1281 }12821283 Ok(())1284 }12851286 /// Delete collection property.1287 ///1288 /// * `collection` - Collection handler.1289 /// * `sender` - The owner or administrator of the collection.1290 /// * `property` - The property to delete.1291 pub fn delete_collection_property(1292 collection: &CollectionHandle<T>,1293 sender: &T::CrossAccountId,1294 property_key: PropertyKey,1295 ) -> DispatchResult {1296 collection.check_is_owner_or_admin(sender)?;12971298 CollectionProperties::<T>::try_mutate(collection.id, |properties| {1299 properties.remove(&property_key)1300 })1301 .map_err(<Error<T>>::from)?;13021303 Self::deposit_event(Event::CollectionPropertyDeleted(1304 collection.id,1305 property_key,1306 ));1307 <PalletEvm<T>>::deposit_log(1308 erc::CollectionHelpersEvents::CollectionChanged {1309 collection_id: eth::collection_id_to_address(collection.id),1310 }1311 .to_log(T::ContractAddress::get()),1312 );13131314 Ok(())1315 }13161317 /// Delete collection properties.1318 ///1319 /// * `collection` - Collection handler.1320 /// * `sender` - The owner or administrator of the collection.1321 /// * `properties` - The properties to delete.1322 #[transactional]1323 pub fn delete_collection_properties(1324 collection: &CollectionHandle<T>,1325 sender: &T::CrossAccountId,1326 property_keys: Vec<PropertyKey>,1327 ) -> DispatchResult {1328 for key in property_keys {1329 Self::delete_collection_property(collection, sender, key)?;1330 }13311332 Ok(())1333 }13341335 /// Set collection propetry permission without any checks.1336 ///1337 /// Used for migrations.1338 ///1339 /// * `collection` - Collection handler.1340 /// * `property_permissions` - Property permissions.1341 pub fn set_property_permission_unchecked(1342 collection: CollectionId,1343 property_permission: PropertyKeyPermission,1344 ) -> DispatchResult {1345 <CollectionPropertyPermissions<T>>::try_mutate(collection, |permissions| {1346 permissions.try_set(property_permission.key, property_permission.permission)1347 })1348 .map_err(<Error<T>>::from)?;1349 Ok(())1350 }13511352 /// Set collection property permission.1353 ///1354 /// * `collection` - Collection handler.1355 /// * `sender` - The owner or administrator of the collection.1356 /// * `property_permission` - Property permission.1357 pub fn set_property_permission(1358 collection: &CollectionHandle<T>,1359 sender: &T::CrossAccountId,1360 property_permission: PropertyKeyPermission,1361 ) -> DispatchResult {1362 Self::set_scoped_property_permission(1363 collection,1364 sender,1365 PropertyScope::None,1366 property_permission,1367 )1368 }13691370 /// Set collection property permission with scope.1371 ///1372 /// * `collection` - Collection handler.1373 /// * `sender` - The owner or administrator of the collection.1374 /// * `scope` - Property scope.1375 /// * `property_permission` - Property permission.1376 pub fn set_scoped_property_permission(1377 collection: &CollectionHandle<T>,1378 sender: &T::CrossAccountId,1379 scope: PropertyScope,1380 property_permission: PropertyKeyPermission,1381 ) -> DispatchResult {1382 collection.check_is_owner_or_admin(sender)?;13831384 let all_permissions = CollectionPropertyPermissions::<T>::get(collection.id);1385 let current_permission = all_permissions.get(&property_permission.key);1386 if matches![1387 current_permission,1388 Some(PropertyPermission { mutable: false, .. })1389 ] {1390 return Err(<Error<T>>::NoPermission.into());1391 }13921393 CollectionPropertyPermissions::<T>::try_mutate(collection.id, |permissions| {1394 let property_permission = property_permission.clone();1395 permissions.try_scoped_set(1396 scope,1397 property_permission.key,1398 property_permission.permission,1399 )1400 })1401 .map_err(<Error<T>>::from)?;14021403 Self::deposit_event(Event::PropertyPermissionSet(1404 collection.id,1405 property_permission.key,1406 ));1407 <PalletEvm<T>>::deposit_log(1408 erc::CollectionHelpersEvents::CollectionChanged {1409 collection_id: eth::collection_id_to_address(collection.id),1410 }1411 .to_log(T::ContractAddress::get()),1412 );14131414 Ok(())1415 }14161417 /// Set token property permission.1418 ///1419 /// * `collection` - Collection handler.1420 /// * `sender` - The owner or administrator of the collection.1421 /// * `property_permissions` - Property permissions.1422 #[transactional]1423 pub fn set_token_property_permissions(1424 collection: &CollectionHandle<T>,1425 sender: &T::CrossAccountId,1426 property_permissions: Vec<PropertyKeyPermission>,1427 ) -> DispatchResult {1428 Self::set_scoped_token_property_permissions(1429 collection,1430 sender,1431 PropertyScope::None,1432 property_permissions,1433 )1434 }14351436 /// Set token property permission with scope.1437 ///1438 /// * `collection` - Collection handler.1439 /// * `sender` - The owner or administrator of the collection.1440 /// * `scope` - Property scope.1441 /// * `property_permissions` - Property permissions.1442 #[transactional]1443 pub fn set_scoped_token_property_permissions(1444 collection: &CollectionHandle<T>,1445 sender: &T::CrossAccountId,1446 scope: PropertyScope,1447 property_permissions: Vec<PropertyKeyPermission>,1448 ) -> DispatchResult {1449 for prop_pemission in property_permissions {1450 Self::set_scoped_property_permission(collection, sender, scope, prop_pemission)?;1451 }14521453 Ok(())1454 }14551456 /// Get collection property.1457 pub fn get_collection_property(1458 collection_id: CollectionId,1459 key: &PropertyKey,1460 ) -> Option<PropertyValue> {1461 Self::collection_properties(collection_id).get(key).cloned()1462 }14631464 /// Convert byte vector to property key vector.1465 pub fn bytes_keys_to_property_keys(1466 keys: Vec<Vec<u8>>,1467 ) -> Result<Vec<PropertyKey>, DispatchError> {1468 keys.into_iter()1469 .map(|key| -> Result<PropertyKey, DispatchError> {1470 key.try_into()1471 .map_err(|_| <Error<T>>::PropertyKeyIsTooLong.into())1472 })1473 .collect::<Result<Vec<PropertyKey>, DispatchError>>()1474 }14751476 /// Get properties according to given keys.1477 pub fn filter_collection_properties(1478 collection_id: CollectionId,1479 keys: Option<Vec<PropertyKey>>,1480 ) -> Result<Vec<Property>, DispatchError> {1481 let properties = Self::collection_properties(collection_id);14821483 let properties = keys1484 .map(|keys| {1485 keys.into_iter()1486 .filter_map(|key| {1487 properties.get(&key).map(|value| Property {1488 key,1489 value: value.clone(),1490 })1491 })1492 .collect()1493 })1494 .unwrap_or_else(|| {1495 properties1496 .into_iter()1497 .map(|(key, value)| Property { key, value })1498 .collect()1499 });15001501 Ok(properties)1502 }15031504 /// Get property permissions according to given keys.1505 pub fn filter_property_permissions(1506 collection_id: CollectionId,1507 keys: Option<Vec<PropertyKey>>,1508 ) -> Result<Vec<PropertyKeyPermission>, DispatchError> {1509 let permissions = Self::property_permissions(collection_id);15101511 let key_permissions = keys1512 .map(|keys| {1513 keys.into_iter()1514 .filter_map(|key| {1515 permissions1516 .get(&key)1517 .map(|permission| PropertyKeyPermission {1518 key,1519 permission: permission.clone(),1520 })1521 })1522 .collect()1523 })1524 .unwrap_or_else(|| {1525 permissions1526 .into_iter()1527 .map(|(key, permission)| PropertyKeyPermission { key, permission })1528 .collect()1529 });15301531 Ok(key_permissions)1532 }15331534 /// Toggle `user` participation in the `collection`'s allow list.1535 /// #### Store read/writes1536 /// 1 writes1537 pub fn toggle_allowlist(1538 collection: &CollectionHandle<T>,1539 sender: &T::CrossAccountId,1540 user: &T::CrossAccountId,1541 allowed: bool,1542 ) -> DispatchResult {1543 collection.check_is_owner_or_admin(sender)?;15441545 // =========15461547 if allowed {1548 <Allowlist<T>>::insert((collection.id, user), true);1549 Self::deposit_event(Event::<T>::AllowListAddressAdded(1550 collection.id,1551 user.clone(),1552 ));1553 } else {1554 <Allowlist<T>>::remove((collection.id, user));1555 Self::deposit_event(Event::<T>::AllowListAddressRemoved(1556 collection.id,1557 user.clone(),1558 ));1559 }15601561 <PalletEvm<T>>::deposit_log(1562 erc::CollectionHelpersEvents::CollectionChanged {1563 collection_id: eth::collection_id_to_address(collection.id),1564 }1565 .to_log(T::ContractAddress::get()),1566 );15671568 Ok(())1569 }15701571 /// Toggle `user` participation in the `collection`'s admin list.1572 /// #### Store read/writes1573 /// 2 reads, 2 writes1574 pub fn toggle_admin(1575 collection: &CollectionHandle<T>,1576 sender: &T::CrossAccountId,1577 user: &T::CrossAccountId,1578 admin: bool,1579 ) -> DispatchResult {1580 collection.check_is_internal()?;1581 collection.check_is_owner(sender)?;15821583 let is_admin = <IsAdmin<T>>::get((collection.id, user));1584 if is_admin == admin {1585 if admin {1586 return Ok(());1587 } else {1588 return Err(Error::<T>::UserIsNotCollectionAdmin.into());1589 }1590 }1591 let amount = <AdminAmount<T>>::get(collection.id);15921593 // =========15941595 if admin {1596 let amount = amount1597 .checked_add(1)1598 .ok_or(<Error<T>>::CollectionAdminCountExceeded)?;1599 ensure!(1600 amount <= Self::collection_admins_limit(),1601 <Error<T>>::CollectionAdminCountExceeded,1602 );16031604 <AdminAmount<T>>::insert(collection.id, amount);1605 <IsAdmin<T>>::insert((collection.id, user), true);16061607 Self::deposit_event(Event::<T>::CollectionAdminAdded(1608 collection.id,1609 user.clone(),1610 ));1611 } else {1612 <AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));1613 <IsAdmin<T>>::remove((collection.id, user));16141615 Self::deposit_event(Event::<T>::CollectionAdminRemoved(1616 collection.id,1617 user.clone(),1618 ));1619 }16201621 <PalletEvm<T>>::deposit_log(1622 erc::CollectionHelpersEvents::CollectionChanged {1623 collection_id: eth::collection_id_to_address(collection.id),1624 }1625 .to_log(T::ContractAddress::get()),1626 );16271628 Ok(())1629 }16301631 /// Update collection limits.1632 pub fn update_limits(1633 user: &T::CrossAccountId,1634 collection: &mut CollectionHandle<T>,1635 new_limit: CollectionLimits,1636 ) -> DispatchResult {1637 collection.check_is_internal()?;1638 collection.check_is_owner_or_admin(user)?;16391640 collection.limits =1641 Self::clamp_limits(collection.mode.clone(), &collection.limits, new_limit)?;16421643 Self::deposit_event(Event::<T>::CollectionLimitSet(collection.id));1644 <PalletEvm<T>>::deposit_log(1645 erc::CollectionHelpersEvents::CollectionChanged {1646 collection_id: eth::collection_id_to_address(collection.id),1647 }1648 .to_log(T::ContractAddress::get()),1649 );16501651 collection.save()1652 }16531654 /// Merge set fields from `new_limit` to `old_limit`.1655 fn clamp_limits(1656 mode: CollectionMode,1657 old_limit: &CollectionLimits,1658 mut new_limit: CollectionLimits,1659 ) -> Result<CollectionLimits, DispatchError> {1660 let limits = old_limit;1661 limit_default!(old_limit, new_limit,1662 account_token_ownership_limit => ensure!(1663 new_limit <= MAX_TOKEN_OWNERSHIP,1664 <Error<T>>::CollectionLimitBoundsExceeded,1665 ),1666 sponsored_data_size => ensure!(1667 new_limit <= CUSTOM_DATA_LIMIT,1668 <Error<T>>::CollectionLimitBoundsExceeded,1669 ),16701671 sponsored_data_rate_limit => {},1672 token_limit => ensure!(1673 old_limit >= new_limit && new_limit > 0,1674 <Error<T>>::CollectionTokenLimitExceeded1675 ),16761677 sponsor_transfer_timeout(match mode {1678 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,1679 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1680 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1681 }) => ensure!(1682 new_limit <= MAX_SPONSOR_TIMEOUT,1683 <Error<T>>::CollectionLimitBoundsExceeded,1684 ),1685 sponsor_approve_timeout => {},1686 owner_can_transfer => ensure!(1687 !limits.owner_can_transfer_instaled() ||1688 old_limit || !new_limit,1689 <Error<T>>::OwnerPermissionsCantBeReverted,1690 ),1691 owner_can_destroy => ensure!(1692 old_limit || !new_limit,1693 <Error<T>>::OwnerPermissionsCantBeReverted,1694 ),1695 transfers_enabled => {},1696 );1697 Ok(new_limit)1698 }16991700 /// Update collection permissions.1701 pub fn update_permissions(1702 user: &T::CrossAccountId,1703 collection: &mut CollectionHandle<T>,1704 new_permission: CollectionPermissions,1705 ) -> DispatchResult {1706 collection.check_is_internal()?;1707 collection.check_is_owner_or_admin(user)?;1708 collection.permissions = Self::clamp_permissions(1709 collection.mode.clone(),1710 &collection.permissions,1711 new_permission,1712 )?;17131714 Self::deposit_event(Event::<T>::CollectionPermissionSet(collection.id));1715 <PalletEvm<T>>::deposit_log(1716 erc::CollectionHelpersEvents::CollectionChanged {1717 collection_id: eth::collection_id_to_address(collection.id),1718 }1719 .to_log(T::ContractAddress::get()),1720 );17211722 collection.save()1723 }17241725 /// Merge set fields from `new_permission` to `old_permission`.1726 fn clamp_permissions(1727 _mode: CollectionMode,1728 old_permission: &CollectionPermissions,1729 mut new_permission: CollectionPermissions,1730 ) -> Result<CollectionPermissions, DispatchError> {1731 limit_default_clone!(old_permission, new_permission,1732 access => {},1733 mint_mode => {},1734 nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },1735 );1736 Ok(new_permission)1737 }17381739 /// Repair possibly broken properties of a collection.1740 pub fn repair_collection(collection_id: CollectionId) -> DispatchResult {1741 CollectionProperties::<T>::mutate(collection_id, |properties| {1742 properties.recompute_consumed_space();1743 });17441745 Ok(())1746 }1747}17481749/// Indicates unsupported methods by returning [Error::UnsupportedOperation].1750#[macro_export]1751macro_rules! unsupported {1752 ($runtime:path) => {1753 Err($crate::Error::<$runtime>::UnsupportedOperation.into())1754 };1755}17561757/// Return weights for various worst-case operations.1758pub trait CommonWeightInfo<CrossAccountId> {1759 /// Weight of item creation.1760 fn create_item() -> Weight;17611762 /// Weight of items creation.1763 fn create_multiple_items(amount: &[CreateItemData]) -> Weight;17641765 /// Weight of items creation.1766 fn create_multiple_items_ex(cost: &CreateItemExData<CrossAccountId>) -> Weight;17671768 /// The weight of the burning item.1769 fn burn_item() -> Weight;17701771 /// Property setting weight.1772 ///1773 /// * `amount`- The number of properties to set.1774 fn set_collection_properties(amount: u32) -> Weight;17751776 /// Collection property deletion weight.1777 ///1778 /// * `amount`- The number of properties to set.1779 fn delete_collection_properties(amount: u32) -> Weight;17801781 /// Token property setting weight.1782 ///1783 /// * `amount`- The number of properties to set.1784 fn set_token_properties(amount: u32) -> Weight;17851786 /// Token property deletion weight.1787 ///1788 /// * `amount`- The number of properties to delete.1789 fn delete_token_properties(amount: u32) -> Weight;17901791 /// Token property permissions set weight.1792 ///1793 /// * `amount`- The number of property permissions to set.1794 fn set_token_property_permissions(amount: u32) -> Weight;17951796 /// Transfer price of the token or its parts.1797 fn transfer() -> Weight;17981799 /// The price of setting the permission of the operation from another user.1800 fn approve() -> Weight;18011802 /// The price of setting the permission of the operation from another user for eth mirror.1803 fn approve_from() -> Weight;18041805 /// Transfer price from another user.1806 fn transfer_from() -> Weight;18071808 /// The price of burning a token from another user.1809 fn burn_from() -> Weight;18101811 /// Differs from burn_item in case of Fungible and Refungible, as it should burn1812 /// whole users's balance.1813 ///1814 /// This method shouldn't be used directly, as it doesn't count breadth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1815 fn burn_recursively_self_raw() -> Weight;18161817 /// Cost of iterating over `amount` children while burning, without counting child burning itself.1818 ///1819 /// This method shouldn't be used directly, as it doesn't count depth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1820 fn burn_recursively_breadth_raw(amount: u32) -> Weight;18211822 /// The price of recursive burning a token.1823 ///1824 /// `max_selfs` - The maximum burning weight of the token itself.1825 /// `max_breadth` - The maximum number of nested tokens to burn.1826 fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {1827 Self::burn_recursively_self_raw()1828 .saturating_mul(max_selfs.max(1) as u64)1829 .saturating_add(Self::burn_recursively_breadth_raw(max_breadth))1830 }18311832 /// The price of retrieving token owner1833 fn token_owner() -> Weight;18341835 /// The price of setting approval for all1836 fn set_allowance_for_all() -> Weight;18371838 /// The price of repairing an item.1839 fn force_repair_item() -> Weight;1840}18411842/// Weight info extension trait for refungible pallet.1843pub trait RefungibleExtensionsWeightInfo {1844 /// Weight of token repartition.1845 fn repartition() -> Weight;1846}18471848/// Common collection operations.1849///1850/// It wraps methods in Fungible, Nonfungible and Refungible pallets1851/// and adds weight info.1852pub trait CommonCollectionOperations<T: Config> {1853 /// Create token.1854 ///1855 /// * `sender` - The user who mint the token and pays for the transaction.1856 /// * `to` - The user who will own the token.1857 /// * `data` - Token data.1858 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1859 fn create_item(1860 &self,1861 sender: T::CrossAccountId,1862 to: T::CrossAccountId,1863 data: CreateItemData,1864 nesting_budget: &dyn Budget,1865 ) -> DispatchResultWithPostInfo;18661867 /// Create multiple tokens.1868 ///1869 /// * `sender` - The user who mint the token and pays for the transaction.1870 /// * `to` - The user who will own the token.1871 /// * `data` - Token data.1872 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1873 fn create_multiple_items(1874 &self,1875 sender: T::CrossAccountId,1876 to: T::CrossAccountId,1877 data: Vec<CreateItemData>,1878 nesting_budget: &dyn Budget,1879 ) -> DispatchResultWithPostInfo;18801881 /// Create multiple tokens.1882 ///1883 /// * `sender` - The user who mint the token and pays for the transaction.1884 /// * `to` - The user who will own the token.1885 /// * `data` - Token data.1886 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1887 fn create_multiple_items_ex(1888 &self,1889 sender: T::CrossAccountId,1890 data: CreateItemExData<T::CrossAccountId>,1891 nesting_budget: &dyn Budget,1892 ) -> DispatchResultWithPostInfo;18931894 /// Burn token.1895 ///1896 /// * `sender` - The user who owns the token.1897 /// * `token` - Token id that will burned.1898 /// * `amount` - The number of parts of the token that will be burned.1899 fn burn_item(1900 &self,1901 sender: T::CrossAccountId,1902 token: TokenId,1903 amount: u128,1904 ) -> DispatchResultWithPostInfo;19051906 /// Burn token and all nested tokens recursievly.1907 ///1908 /// * `sender` - The user who owns the token.1909 /// * `token` - Token id that will burned.1910 /// * `self_budget` - The budget that can be spent on burning tokens.1911 /// * `breadth_budget` - The budget that can be spent on burning nested tokens.1912 fn burn_item_recursively(1913 &self,1914 sender: T::CrossAccountId,1915 token: TokenId,1916 self_budget: &dyn Budget,1917 breadth_budget: &dyn Budget,1918 ) -> DispatchResultWithPostInfo;19191920 /// Set collection properties.1921 ///1922 /// * `sender` - Must be either the owner of the collection or its admin.1923 /// * `properties` - Properties to be set.1924 fn set_collection_properties(1925 &self,1926 sender: T::CrossAccountId,1927 properties: Vec<Property>,1928 ) -> DispatchResultWithPostInfo;19291930 /// Delete collection properties.1931 ///1932 /// * `sender` - Must be either the owner of the collection or its admin.1933 /// * `properties` - The properties to be removed.1934 fn delete_collection_properties(1935 &self,1936 sender: &T::CrossAccountId,1937 property_keys: Vec<PropertyKey>,1938 ) -> DispatchResultWithPostInfo;19391940 /// Set token properties.1941 ///1942 /// The appropriate [`PropertyPermission`] for the token property1943 /// must be set with [`Self::set_token_property_permissions`].1944 ///1945 /// * `sender` - Must be either the owner of the token or its admin.1946 /// * `token_id` - The token for which the properties are being set.1947 /// * `properties` - Properties to be set.1948 /// * `budget` - Budget for setting properties.1949 fn set_token_properties(1950 &self,1951 sender: T::CrossAccountId,1952 token_id: TokenId,1953 properties: Vec<Property>,1954 budget: &dyn Budget,1955 ) -> DispatchResultWithPostInfo;19561957 /// Remove token properties.1958 ///1959 /// The appropriate [`PropertyPermission`] for the token property1960 /// must be set with [`Self::set_token_property_permissions`].1961 ///1962 /// * `sender` - Must be either the owner of the token or its admin.1963 /// * `token_id` - The token for which the properties are being remove.1964 /// * `property_keys` - Keys to remove corresponding properties.1965 /// * `budget` - Budget for removing properties.1966 fn delete_token_properties(1967 &self,1968 sender: T::CrossAccountId,1969 token_id: TokenId,1970 property_keys: Vec<PropertyKey>,1971 budget: &dyn Budget,1972 ) -> DispatchResultWithPostInfo;19731974 /// Set token property permissions.1975 ///1976 /// * `sender` - Must be either the owner of the token or its admin.1977 /// * `token_id` - The token for which the properties are being set.1978 /// * `property_permissions` - Property permissions to be set.1979 /// * `budget` - Budget for setting properties.1980 fn set_token_property_permissions(1981 &self,1982 sender: &T::CrossAccountId,1983 property_permissions: Vec<PropertyKeyPermission>,1984 ) -> DispatchResultWithPostInfo;19851986 /// Transfer amount of token pieces.1987 ///1988 /// * `sender` - Donor user.1989 /// * `to` - Recepient user.1990 /// * `token` - The token of which parts are being sent.1991 /// * `amount` - The number of parts of the token that will be transferred.1992 /// * `budget` - The maximum budget that can be spent on the transfer.1993 fn transfer(1994 &self,1995 sender: T::CrossAccountId,1996 to: T::CrossAccountId,1997 token: TokenId,1998 amount: u128,1999 budget: &dyn Budget,2000 ) -> DispatchResultWithPostInfo;20012002 /// Grant access to another account to transfer parts of the token owned by the calling user via [Self::transfer_from].2003 ///2004 /// * `sender` - The user who grants access to the token.2005 /// * `spender` - The user to whom the rights are granted.2006 /// * `token` - The token to which access is granted.2007 /// * `amount` - The amount of pieces that another user can dispose of.2008 fn approve(2009 &self,2010 sender: T::CrossAccountId,2011 spender: T::CrossAccountId,2012 token: TokenId,2013 amount: u128,2014 ) -> DispatchResultWithPostInfo;20152016 /// Grant access to another account to transfer parts of the token owned by the calling user's eth mirror via [Self::transfer_from].2017 ///2018 /// * `sender` - The user who grants access to the token.2019 /// * `from` - Spender's eth mirror.2020 /// * `to` - The user to whom the rights are granted.2021 /// * `token` - The token to which access is granted.2022 /// * `amount` - The amount of pieces that another user can dispose of.2023 fn approve_from(2024 &self,2025 sender: T::CrossAccountId,2026 from: T::CrossAccountId,2027 to: T::CrossAccountId,2028 token: TokenId,2029 amount: u128,2030 ) -> DispatchResultWithPostInfo;20312032 /// Send parts of a token owned by another user.2033 ///2034 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2035 ///2036 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2037 /// * `from` - The user who owns the token.2038 /// * `to` - Recepient user.2039 /// * `token` - The token of which parts are being sent.2040 /// * `amount` - The number of parts of the token that will be transferred.2041 /// * `budget` - The maximum budget that can be spent on the transfer.2042 fn transfer_from(2043 &self,2044 sender: T::CrossAccountId,2045 from: T::CrossAccountId,2046 to: T::CrossAccountId,2047 token: TokenId,2048 amount: u128,2049 budget: &dyn Budget,2050 ) -> DispatchResultWithPostInfo;20512052 /// Burn parts of a token owned by another user.2053 ///2054 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2055 ///2056 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2057 /// * `from` - The user who owns the token.2058 /// * `token` - The token of which parts are being sent.2059 /// * `amount` - The number of parts of the token that will be transferred.2060 /// * `budget` - The maximum budget that can be spent on the burn.2061 fn burn_from(2062 &self,2063 sender: T::CrossAccountId,2064 from: T::CrossAccountId,2065 token: TokenId,2066 amount: u128,2067 budget: &dyn Budget,2068 ) -> DispatchResultWithPostInfo;20692070 /// Check permission to nest token.2071 ///2072 /// * `sender` - The user who initiated the check.2073 /// * `from` - The token that is checked for embedding.2074 /// * `under` - Token under which to check.2075 /// * `budget` - The maximum budget that can be spent on the check.2076 fn check_nesting(2077 &self,2078 sender: T::CrossAccountId,2079 from: (CollectionId, TokenId),2080 under: TokenId,2081 budget: &dyn Budget,2082 ) -> DispatchResult;20832084 /// Nest one token into another.2085 ///2086 /// * `under` - Token holder.2087 /// * `to_nest` - Nested token.2088 fn nest(&self, under: TokenId, to_nest: (CollectionId, TokenId));20892090 /// Unnest token.2091 ///2092 /// * `under` - Token holder.2093 /// * `to_nest` - Token to unnest.2094 fn unnest(&self, under: TokenId, to_nest: (CollectionId, TokenId));20952096 /// Get all user tokens.2097 ///2098 /// * `account` - Account for which you need to get tokens.2099 fn account_tokens(&self, account: T::CrossAccountId) -> Vec<TokenId>;21002101 /// Get all the tokens in the collection.2102 fn collection_tokens(&self) -> Vec<TokenId>;21032104 /// Check if the token exists.2105 ///2106 /// * `token` - Id token to check.2107 fn token_exists(&self, token: TokenId) -> bool;21082109 /// Get the id of the last minted token.2110 fn last_token_id(&self) -> TokenId;21112112 /// Get the owner of the token.2113 ///2114 /// * `token` - The token for which you need to find out the owner.2115 fn token_owner(&self, token: TokenId) -> Option<T::CrossAccountId>;21162117 /// Returns 10 tokens owners in no particular order.2118 ///2119 /// * `token` - The token for which you need to find out the owners.2120 fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId>;21212122 /// Get the value of the token property by key.2123 ///2124 /// * `token` - Token with the property to get.2125 /// * `key` - Property name.2126 fn token_property(&self, token_id: TokenId, key: &PropertyKey) -> Option<PropertyValue>;21272128 /// Get a set of token properties by key vector.2129 ///2130 /// * `token` - Token with the property to get.2131 /// * `keys` - Vector of property keys. If this parameter is [None](sp_std::result::Result),2132 /// then all properties are returned.2133 fn token_properties(&self, token: TokenId, keys: Option<Vec<PropertyKey>>) -> Vec<Property>;21342135 /// Amount of unique collection tokens2136 fn total_supply(&self) -> u32;21372138 /// Amount of different tokens account has.2139 ///2140 /// * `account` - The account for which need to get the balance.2141 fn account_balance(&self, account: T::CrossAccountId) -> u32;21422143 /// Amount of specific token account have.2144 fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;21452146 /// Amount of token pieces2147 fn total_pieces(&self, token: TokenId) -> Option<u128>;21482149 /// Get the number of parts of the token that a trusted user can manage.2150 ///2151 /// * `sender` - Trusted user.2152 /// * `spender` - Owner of the token.2153 /// * `token` - The token for which to get the value.2154 fn allowance(2155 &self,2156 sender: T::CrossAccountId,2157 spender: T::CrossAccountId,2158 token: TokenId,2159 ) -> u128;21602161 /// Get extension for RFT collection.2162 fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>>;21632164 /// The `operator` is allowed to transfer all tokens of the `owner` on their behalf.2165 /// * `owner` - Token owner2166 /// * `operator` - Operator2167 /// * `approve` - Should operator status be granted or revoked?2168 fn set_allowance_for_all(2169 &self,2170 owner: T::CrossAccountId,2171 operator: T::CrossAccountId,2172 approve: bool,2173 ) -> DispatchResultWithPostInfo;21742175 /// Tells whether the given `owner` approves the `operator`.2176 fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool;21772178 /// Repairs a possibly broken item.2179 fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo;2180}21812182/// Extension for RFT collection.2183pub trait RefungibleExtensions<T>2184where2185 T: Config,2186{2187 /// Change the number of parts of the token.2188 ///2189 /// When the value changes down, this function is equivalent to burning parts of the token.2190 ///2191 /// * `sender` - The user calling the repartition operation. Must be the owner of the token.2192 /// * `token` - The token for which you want to change the number of parts.2193 /// * `amount` - The new value of the parts of the token.2194 fn repartition(2195 &self,2196 sender: &T::CrossAccountId,2197 token: TokenId,2198 amount: u128,2199 ) -> DispatchResultWithPostInfo;2200}22012202/// Merge [`DispatchResult`] with [`Weight`] into [`DispatchResultWithPostInfo`].2203///2204/// Used for [`CommonCollectionOperations`] implementations and flexible enough to do so.2205pub fn with_weight(res: DispatchResult, weight: Weight) -> DispatchResultWithPostInfo {2206 let post_info = PostDispatchInfo {2207 actual_weight: Some(weight),2208 pays_fee: Pays::Yes,2209 };2210 match res {2211 Ok(()) => Ok(post_info),2212 Err(error) => Err(DispatchErrorWithPostInfo { post_info, error }),2213 }2214}22152216impl<T: Config> From<PropertiesError> for Error<T> {2217 fn from(error: PropertiesError) -> Self {2218 match error {2219 PropertiesError::NoSpaceForProperty => Self::NoSpaceForProperty,2220 PropertiesError::PropertyLimitReached => Self::PropertyLimitReached,2221 PropertiesError::InvalidCharacterInPropertyKey => Self::InvalidCharacterInPropertyKey,2222 PropertiesError::PropertyKeyIsTooLong => Self::PropertyKeyIsTooLong,2223 PropertiesError::EmptyPropertyKey => Self::EmptyPropertyKey,2224 }2225 }2226}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//! # Common pallet18//!19//! The Common pallet provides functionality for handling collections.20//!21//! ## Overview22//!23//! The Common pallet provides an interface for common collection operations for different collection types24//! (see [CommonCollectionOperations]), as well as a generic dispatcher for these, see [dispatch] module.25//! It also provides this functionality to EVM, see [erc] and [eth] modules.26//!27//! The Common pallet provides functions for:28//!29//! - Setting and approving collection sponsor.30//! - Get\set\delete allow list.31//! - Get\set\delete collection properties.32//! - Get\set\delete collection property permissions.33//! - Get\set\delete token property permissions.34//! - Get\set\delete collection administrators.35//! - Checking access permissions.36//!37//! ### Terminology38//! **Collection sponsor** - For the collection, you can set a sponsor, at whose expense it will39//! be possible to mint tokens.40//!41//! **Allow list** - List of users who have the right to minting tokens.42//!43//! **Collection properties** - Collection properties are simply key-value stores where various44//! metadata can be placed.45//!46//! **Permissions on token properties** - For each property in the token can be set permission47//! to change, see [`PropertyPermission`].48//!49//! **Collection administrator** - For a collection, you can set administrators who have the right50//! to most actions on the collection.5152#![warn(missing_docs)]53#![cfg_attr(not(feature = "std"), no_std)]54extern crate alloc;5556use core::ops::{Deref, DerefMut};57use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};58use sp_std::vec::Vec;59use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};60use evm_coder::ToLog;61use frame_support::{62 dispatch::{DispatchErrorWithPostInfo, DispatchResultWithPostInfo, Weight, PostDispatchInfo},63 ensure,64 traits::{Imbalance, Get, Currency, WithdrawReasons, ExistenceRequirement},65 dispatch::Pays,66 transactional,67};68use pallet_evm::GasWeightMapping;69use up_data_structs::{70 COLLECTION_NUMBER_LIMIT,71 Collection,72 RpcCollection,73 CollectionFlags,74 RpcCollectionFlags,75 CollectionId,76 CreateItemData,77 MAX_TOKEN_PREFIX_LENGTH,78 COLLECTION_ADMINS_LIMIT,79 TokenId,80 TokenChild,81 CollectionStats,82 MAX_TOKEN_OWNERSHIP,83 CollectionMode,84 NFT_SPONSOR_TRANSFER_TIMEOUT,85 FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,86 REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,87 MAX_SPONSOR_TIMEOUT,88 CUSTOM_DATA_LIMIT,89 CollectionLimits,90 CreateCollectionData,91 SponsorshipState,92 CreateItemExData,93 SponsoringRateLimit,94 budget::Budget,95 PhantomType,96 Property,97 Properties,98 PropertiesPermissionMap,99 PropertyKey,100 PropertyValue,101 PropertyPermission,102 PropertiesError,103 PropertyKeyPermission,104 TokenData,105 TrySetProperty,106 PropertyScope,107 // RMRK108 RmrkCollectionInfo,109 RmrkInstanceInfo,110 RmrkResourceInfo,111 RmrkPropertyInfo,112 RmrkBaseInfo,113 RmrkPartType,114 RmrkBoundedTheme,115 RmrkNftChild,116 CollectionPermissions,117};118use up_pov_estimate_rpc::PovInfo;119120pub use pallet::*;121use sp_core::H160;122use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};123#[cfg(feature = "runtime-benchmarks")]124pub mod benchmarking;125pub mod dispatch;126pub mod erc;127pub mod eth;128pub mod weights;129130/// Weight info.131pub type SelfWeightOf<T> = <T as Config>::WeightInfo;132133/// Collection handle contains information about collection data and id.134/// Also provides functionality to count consumed gas.135///136/// CollectionHandle is used as a generic wrapper for collections of all types.137/// It allows to perform common operations and queries on any collection type,138/// both completely general for all, as well as their respective implementations of [`CommonCollectionOperations`].139#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]140pub struct CollectionHandle<T: Config> {141 /// Collection id142 pub id: CollectionId,143 collection: Collection<T::AccountId>,144 /// Substrate recorder for counting consumed gas145 pub recorder: SubstrateRecorder<T>,146}147148impl<T: Config> WithRecorder<T> for CollectionHandle<T> {149 fn recorder(&self) -> &SubstrateRecorder<T> {150 &self.recorder151 }152 fn into_recorder(self) -> SubstrateRecorder<T> {153 self.recorder154 }155}156157impl<T: Config> CollectionHandle<T> {158 /// Same as [CollectionHandle::new] but with an explicit gas limit.159 pub fn new_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {160 <CollectionById<T>>::get(id).map(|collection| Self {161 id,162 collection,163 recorder: SubstrateRecorder::new(gas_limit),164 })165 }166167 /// Same as [CollectionHandle::new] but with an existed [`SubstrateRecorder`].168 pub fn new_with_recorder(id: CollectionId, recorder: SubstrateRecorder<T>) -> Option<Self> {169 <CollectionById<T>>::get(id).map(|collection| Self {170 id,171 collection,172 recorder,173 })174 }175176 /// Retrives collection data from storage and creates collection handle with default parameters.177 /// If collection not found return `None`178 pub fn new(id: CollectionId) -> Option<Self> {179 Self::new_with_gas_limit(id, u64::MAX)180 }181182 /// Same as [`CollectionHandle::new`] but if collection not found [CollectionNotFound](Error::CollectionNotFound) returned.183 pub fn try_get(id: CollectionId) -> Result<Self, DispatchError> {184 Ok(Self::new(id).ok_or(<Error<T>>::CollectionNotFound)?)185 }186187 /// Consume gas for reading.188 pub fn consume_store_reads(&self, reads: u64) -> evm_coder::execution::Result<()> {189 self.recorder190 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(191 <T as frame_system::Config>::DbWeight::get()192 .read193 .saturating_mul(reads),194 )))195 }196197 /// Consume gas for writing.198 pub fn consume_store_writes(&self, writes: u64) -> evm_coder::execution::Result<()> {199 self.recorder200 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(201 <T as frame_system::Config>::DbWeight::get()202 .write203 .saturating_mul(writes),204 )))205 }206207 /// Consume gas for reading and writing.208 pub fn consume_store_reads_and_writes(209 &self,210 reads: u64,211 writes: u64,212 ) -> evm_coder::execution::Result<()> {213 let weight = <T as frame_system::Config>::DbWeight::get();214 let reads = weight.read.saturating_mul(reads);215 let writes = weight.read.saturating_mul(writes);216 self.recorder217 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(218 reads.saturating_add(writes),219 )))220 }221222 /// Save collection to storage.223 pub fn save(&self) -> DispatchResult {224 <CollectionById<T>>::insert(self.id, &self.collection);225 Ok(())226 }227228 /// Set collection sponsor.229 ///230 /// Unique collections allows sponsoring for certain actions.231 /// This method allows you to set the sponsor of the collection.232 /// In order for sponsorship to become active, it must be confirmed through [`Self::confirm_sponsorship`].233 pub fn set_sponsor(234 &mut self,235 sender: &T::CrossAccountId,236 sponsor: T::AccountId,237 ) -> DispatchResult {238 self.check_is_internal()?;239 self.check_is_owner_or_admin(sender)?;240241 self.collection.sponsorship = SponsorshipState::Unconfirmed(sponsor.clone());242243 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor));244 <PalletEvm<T>>::deposit_log(245 erc::CollectionHelpersEvents::CollectionChanged {246 collection_id: eth::collection_id_to_address(self.id),247 }248 .to_log(T::ContractAddress::get()),249 );250251 self.save()252 }253254 /// Force set `sponsor`.255 ///256 /// Differs from [`set_sponsor`][`Self::set_sponsor`] in that confirmation257 /// from the `sponsor` is not required.258 ///259 /// # Arguments260 ///261 /// * `sender`: Caller's account.262 /// * `sponsor`: ID of the account of the sponsor-to-be.263 pub fn force_set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {264 self.check_is_internal()?;265266 self.collection.sponsorship = SponsorshipState::Confirmed(sponsor.clone());267268 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor.clone()));269 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sponsor));270 <PalletEvm<T>>::deposit_log(271 erc::CollectionHelpersEvents::CollectionChanged {272 collection_id: eth::collection_id_to_address(self.id),273 }274 .to_log(T::ContractAddress::get()),275 );276277 self.save()278 }279280 /// Confirm sponsorship281 ///282 /// In order for the sponsorship to become active, the user set as the sponsor must confirm their participation.283 /// Before confirming sponsorship, the user must be specified as the sponsor of the collection via [`Self::set_sponsor`].284 pub fn confirm_sponsorship(&mut self, sender: &T::AccountId) -> DispatchResult {285 self.check_is_internal()?;286 ensure!(287 self.collection.sponsorship.pending_sponsor() == Some(sender),288 Error::<T>::ConfirmSponsorshipFail289 );290291 self.collection.sponsorship = SponsorshipState::Confirmed(sender.clone());292293 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sender.clone()));294 <PalletEvm<T>>::deposit_log(295 erc::CollectionHelpersEvents::CollectionChanged {296 collection_id: eth::collection_id_to_address(self.id),297 }298 .to_log(T::ContractAddress::get()),299 );300301 self.save()302 }303304 /// Remove collection sponsor.305 pub fn remove_sponsor(&mut self, sender: &T::CrossAccountId) -> DispatchResult {306 self.check_is_internal()?;307 self.check_is_owner_or_admin(sender)?;308309 self.collection.sponsorship = SponsorshipState::Disabled;310311 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));312 <PalletEvm<T>>::deposit_log(313 erc::CollectionHelpersEvents::CollectionChanged {314 collection_id: eth::collection_id_to_address(self.id),315 }316 .to_log(T::ContractAddress::get()),317 );318 self.save()319 }320321 /// Force remove `sponsor`.322 ///323 /// Differs from `remove_sponsor` in that324 /// it doesn't require consent from the `owner` of the collection.325 pub fn force_remove_sponsor(&mut self) -> DispatchResult {326 self.check_is_internal()?;327328 self.collection.sponsorship = SponsorshipState::Disabled;329330 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));331 <PalletEvm<T>>::deposit_log(332 erc::CollectionHelpersEvents::CollectionChanged {333 collection_id: eth::collection_id_to_address(self.id),334 }335 .to_log(T::ContractAddress::get()),336 );337 self.save()338 }339340 /// Checks that the collection was created with, and must be operated upon through **Unique API**.341 /// Now check only the `external` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.342 pub fn check_is_internal(&self) -> DispatchResult {343 if self.flags.external {344 return Err(<Error<T>>::CollectionIsExternal)?;345 }346347 Ok(())348 }349350 /// Checks that the collection was created with, and must be operated upon through an **assimilated API**.351 /// Now check only the `external` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.352 pub fn check_is_external(&self) -> DispatchResult {353 if !self.flags.external {354 return Err(<Error<T>>::CollectionIsInternal)?;355 }356357 Ok(())358 }359}360361impl<T: Config> Deref for CollectionHandle<T> {362 type Target = Collection<T::AccountId>;363364 fn deref(&self) -> &Self::Target {365 &self.collection366 }367}368369impl<T: Config> DerefMut for CollectionHandle<T> {370 fn deref_mut(&mut self) -> &mut Self::Target {371 &mut self.collection372 }373}374375impl<T: Config> CollectionHandle<T> {376 /// Checks if the `user` is the owner of the collection.377 pub fn check_is_owner(&self, user: &T::CrossAccountId) -> DispatchResult {378 ensure!(*user.as_sub() == self.owner, <Error<T>>::NoPermission);379 Ok(())380 }381382 /// Returns **true** if the `user` is the owner or administrator of the collection.383 pub fn is_owner_or_admin(&self, user: &T::CrossAccountId) -> bool {384 *user.as_sub() == self.owner || <IsAdmin<T>>::get((self.id, user))385 }386387 /// Checks if the `user` is the owner or administrator of the collection.388 pub fn check_is_owner_or_admin(&self, user: &T::CrossAccountId) -> DispatchResult {389 ensure!(self.is_owner_or_admin(user), <Error<T>>::NoPermission);390 Ok(())391 }392393 /// Return **true** if `user` was not allowed to have tokens, and he can ignore such restrictions.394 pub fn ignores_allowance(&self, user: &T::CrossAccountId) -> bool {395 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)396 }397398 /// Return **true** if `user` does not have enough token parts, and he can ignore such restrictions.399 pub fn ignores_owned_amount(&self, user: &T::CrossAccountId) -> bool {400 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)401 }402403 /// Checks if the user is in the allow list. If not [Error::AddressNotInAllowlist] returns.404 pub fn check_allowlist(&self, user: &T::CrossAccountId) -> DispatchResult {405 ensure!(406 <Allowlist<T>>::get((self.id, user)),407 <Error<T>>::AddressNotInAllowlist408 );409 Ok(())410 }411412 /// Changes collection owner to another account413 /// #### Store read/writes414 /// 1 writes415 pub fn change_owner(416 &mut self,417 caller: T::CrossAccountId,418 new_owner: T::CrossAccountId,419 ) -> DispatchResult {420 self.check_is_internal()?;421 self.check_is_owner(&caller)?;422 self.collection.owner = new_owner.as_sub().clone();423424 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnerChanged(425 self.id,426 new_owner.as_sub().clone(),427 ));428 <PalletEvm<T>>::deposit_log(429 erc::CollectionHelpersEvents::CollectionChanged {430 collection_id: eth::collection_id_to_address(self.id),431 }432 .to_log(T::ContractAddress::get()),433 );434435 self.save()436 }437}438439#[frame_support::pallet]440pub mod pallet {441 use super::*;442 use dispatch::CollectionDispatch;443 use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};444 use frame_system::pallet_prelude::*;445 use frame_support::traits::Currency;446 use up_data_structs::{TokenId, mapping::TokenAddressMapping};447 use scale_info::TypeInfo;448 use weights::WeightInfo;449450 #[pallet::config]451 pub trait Config:452 frame_system::Config + pallet_evm_coder_substrate::Config + pallet_evm::Config + TypeInfo453 {454 /// Weight information for functions of this pallet.455 type WeightInfo: WeightInfo;456457 /// Events compatible with [`frame_system::Config::Event`].458 type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;459460 /// Handler of accounts and payment.461 type Currency: Currency<Self::AccountId>;462463 /// Set price to create a collection.464 #[pallet::constant]465 type CollectionCreationPrice: Get<466 <<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,467 >;468469 /// Dispatcher of operations on collections.470 type CollectionDispatch: CollectionDispatch<Self>;471472 /// Account which holds the chain's treasury.473 type TreasuryAccountId: Get<Self::AccountId>;474475 /// Address under which the CollectionHelper contract would be available.476 #[pallet::constant]477 type ContractAddress: Get<H160>;478479 /// Mapper for token addresses to Ethereum addresses.480 type EvmTokenAddressMapping: TokenAddressMapping<H160>;481482 /// Mapper for token addresses to [`CrossAccountId`].483 type CrossTokenAddressMapping: TokenAddressMapping<Self::CrossAccountId>;484 }485486 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);487488 #[pallet::pallet]489 #[pallet::storage_version(STORAGE_VERSION)]490 #[pallet::generate_store(pub(super) trait Store)]491 pub struct Pallet<T>(_);492493 #[pallet::extra_constants]494 impl<T: Config> Pallet<T> {495 /// Maximum admins per collection.496 pub fn collection_admins_limit() -> u32 {497 COLLECTION_ADMINS_LIMIT498 }499 }500501 #[pallet::event]502 #[pallet::generate_deposit(pub fn deposit_event)]503 pub enum Event<T: Config> {504 /// New collection was created505 CollectionCreated(506 /// Globally unique identifier of newly created collection.507 CollectionId,508 /// [`CollectionMode`] converted into _u8_.509 u8,510 /// Collection owner.511 T::AccountId,512 ),513514 /// New collection was destroyed515 CollectionDestroyed(516 /// Globally unique identifier of collection.517 CollectionId,518 ),519520 /// New item was created.521 ItemCreated(522 /// Id of the collection where item was created.523 CollectionId,524 /// Id of an item. Unique within the collection.525 TokenId,526 /// Owner of newly created item527 T::CrossAccountId,528 /// Always 1 for NFT529 u128,530 ),531532 /// Collection item was burned.533 ItemDestroyed(534 /// Id of the collection where item was destroyed.535 CollectionId,536 /// Identifier of burned NFT.537 TokenId,538 /// Which user has destroyed its tokens.539 T::CrossAccountId,540 /// Amount of token pieces destroed. Always 1 for NFT.541 u128,542 ),543544 /// Item was transferred545 Transfer(546 /// Id of collection to which item is belong.547 CollectionId,548 /// Id of an item.549 TokenId,550 /// Original owner of item.551 T::CrossAccountId,552 /// New owner of item.553 T::CrossAccountId,554 /// Amount of token pieces transfered. Always 1 for NFT.555 u128,556 ),557558 /// Amount pieces of token owned by `sender` was approved for `spender`.559 Approved(560 /// Id of collection to which item is belong.561 CollectionId,562 /// Id of an item.563 TokenId,564 /// Original owner of item.565 T::CrossAccountId,566 /// Id for which the approval was granted.567 T::CrossAccountId,568 /// Amount of token pieces transfered. Always 1 for NFT.569 u128,570 ),571572 /// A `sender` approves operations on all owned tokens for `spender`.573 ApprovedForAll(574 /// Id of collection to which item is belong.575 CollectionId,576 /// Owner of a wallet.577 T::CrossAccountId,578 /// Id for which operator status was granted or rewoked.579 T::CrossAccountId,580 /// Is operator status granted or revoked?581 bool,582 ),583584 /// The colletion property has been added or edited.585 CollectionPropertySet(586 /// Id of collection to which property has been set.587 CollectionId,588 /// The property that was set.589 PropertyKey,590 ),591592 /// The property has been deleted.593 CollectionPropertyDeleted(594 /// Id of collection to which property has been deleted.595 CollectionId,596 /// The property that was deleted.597 PropertyKey,598 ),599600 /// The token property has been added or edited.601 TokenPropertySet(602 /// Identifier of the collection whose token has the property set.603 CollectionId,604 /// The token for which the property was set.605 TokenId,606 /// The property that was set.607 PropertyKey,608 ),609610 /// The token property has been deleted.611 TokenPropertyDeleted(612 /// Identifier of the collection whose token has the property deleted.613 CollectionId,614 /// The token for which the property was deleted.615 TokenId,616 /// The property that was deleted.617 PropertyKey,618 ),619620 /// The token property permission of a collection has been set.621 PropertyPermissionSet(622 /// ID of collection to which property permission has been set.623 CollectionId,624 /// The property permission that was set.625 PropertyKey,626 ),627628 /// Address was added to the allow list.629 AllowListAddressAdded(630 /// ID of the affected collection.631 CollectionId,632 /// Address of the added account.633 T::CrossAccountId,634 ),635636 /// Address was removed from the allow list.637 AllowListAddressRemoved(638 /// ID of the affected collection.639 CollectionId,640 /// Address of the removed account.641 T::CrossAccountId,642 ),643644 /// Collection admin was added.645 CollectionAdminAdded(646 /// ID of the affected collection.647 CollectionId,648 /// Admin address.649 T::CrossAccountId,650 ),651652 /// Collection admin was removed.653 CollectionAdminRemoved(654 /// ID of the affected collection.655 CollectionId,656 /// Removed admin address.657 T::CrossAccountId,658 ),659660 /// Collection limits were set.661 CollectionLimitSet(662 /// ID of the affected collection.663 CollectionId,664 ),665666 /// Collection owned was changed.667 CollectionOwnerChanged(668 /// ID of the affected collection.669 CollectionId,670 /// New owner address.671 T::AccountId,672 ),673674 /// Collection permissions were set.675 CollectionPermissionSet(676 /// ID of the affected collection.677 CollectionId,678 ),679680 /// Collection sponsor was set.681 CollectionSponsorSet(682 /// ID of the affected collection.683 CollectionId,684 /// New sponsor address.685 T::AccountId,686 ),687688 /// New sponsor was confirm.689 SponsorshipConfirmed(690 /// ID of the affected collection.691 CollectionId,692 /// New sponsor address.693 T::AccountId,694 ),695696 /// Collection sponsor was removed.697 CollectionSponsorRemoved(698 /// ID of the affected collection.699 CollectionId,700 ),701 }702703 #[pallet::error]704 pub enum Error<T> {705 /// This collection does not exist.706 CollectionNotFound,707 /// Sender parameter and item owner must be equal.708 MustBeTokenOwner,709 /// No permission to perform action710 NoPermission,711 /// Destroying only empty collections is allowed712 CantDestroyNotEmptyCollection,713 /// Collection is not in mint mode.714 PublicMintingNotAllowed,715 /// Address is not in allow list.716 AddressNotInAllowlist,717718 /// Collection name can not be longer than 63 char.719 CollectionNameLimitExceeded,720 /// Collection description can not be longer than 255 char.721 CollectionDescriptionLimitExceeded,722 /// Token prefix can not be longer than 15 char.723 CollectionTokenPrefixLimitExceeded,724 /// Total collections bound exceeded.725 TotalCollectionsLimitExceeded,726 /// Exceeded max admin count727 CollectionAdminCountExceeded,728 /// Collection limit bounds per collection exceeded729 CollectionLimitBoundsExceeded,730 /// Tried to enable permissions which are only permitted to be disabled731 OwnerPermissionsCantBeReverted,732 /// Collection settings not allowing items transferring733 TransferNotAllowed,734 /// Account token limit exceeded per collection735 AccountTokenLimitExceeded,736 /// Collection token limit exceeded737 CollectionTokenLimitExceeded,738 /// Metadata flag frozen739 MetadataFlagFrozen,740741 /// Item does not exist742 TokenNotFound,743 /// Item is balance not enough744 TokenValueTooLow,745 /// Requested value is more than the approved746 ApprovedValueTooLow,747 /// Tried to approve more than owned748 CantApproveMoreThanOwned,749 /// Only spending from eth mirror could be approved750 AddressIsNotEthMirror,751752 /// Can't transfer tokens to ethereum zero address753 AddressIsZero,754755 /// The operation is not supported756 UnsupportedOperation,757758 /// Insufficient funds to perform an action759 NotSufficientFounds,760761 /// User does not satisfy the nesting rule762 UserIsNotAllowedToNest,763 /// Only tokens from specific collections may nest tokens under this one764 SourceCollectionIsNotAllowedToNest,765766 /// Tried to store more data than allowed in collection field767 CollectionFieldSizeExceeded,768769 /// Tried to store more property data than allowed770 NoSpaceForProperty,771772 /// Tried to store more property keys than allowed773 PropertyLimitReached,774775 /// Property key is too long776 PropertyKeyIsTooLong,777778 /// Only ASCII letters, digits, and symbols `_`, `-`, and `.` are allowed779 InvalidCharacterInPropertyKey,780781 /// Empty property keys are forbidden782 EmptyPropertyKey,783784 /// Tried to access an external collection with an internal API785 CollectionIsExternal,786787 /// Tried to access an internal collection with an external API788 CollectionIsInternal,789790 /// This address is not set as sponsor, use setCollectionSponsor first.791 ConfirmSponsorshipFail,792793 /// The user is not an administrator.794 UserIsNotCollectionAdmin,795 }796797 /// Storage of the count of created collections. Essentially contains the last collection ID.798 #[pallet::storage]799 pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;800801 /// Storage of the count of deleted collections.802 #[pallet::storage]803 pub type DestroyedCollectionCount<T> =804 StorageValue<Value = CollectionId, QueryKind = ValueQuery>;805806 /// Storage of collection info.807 #[pallet::storage]808 pub type CollectionById<T> = StorageMap<809 Hasher = Blake2_128Concat,810 Key = CollectionId,811 Value = Collection<<T as frame_system::Config>::AccountId>,812 QueryKind = OptionQuery,813 >;814815 /// Storage of collection properties.816 #[pallet::storage]817 #[pallet::getter(fn collection_properties)]818 pub type CollectionProperties<T> = StorageMap<819 Hasher = Blake2_128Concat,820 Key = CollectionId,821 Value = Properties,822 QueryKind = ValueQuery,823 OnEmpty = up_data_structs::CollectionProperties,824 >;825826 /// Storage of token property permissions of a collection.827 #[pallet::storage]828 #[pallet::getter(fn property_permissions)]829 pub type CollectionPropertyPermissions<T> = StorageMap<830 Hasher = Blake2_128Concat,831 Key = CollectionId,832 Value = PropertiesPermissionMap,833 QueryKind = ValueQuery,834 >;835836 /// Storage of the amount of collection admins.837 #[pallet::storage]838 pub type AdminAmount<T> = StorageMap<839 Hasher = Blake2_128Concat,840 Key = CollectionId,841 Value = u32,842 QueryKind = ValueQuery,843 >;844845 /// List of collection admins.846 #[pallet::storage]847 pub type IsAdmin<T: Config> = StorageNMap<848 Key = (849 Key<Blake2_128Concat, CollectionId>,850 Key<Blake2_128Concat, T::CrossAccountId>,851 ),852 Value = bool,853 QueryKind = ValueQuery,854 >;855856 /// Allowlisted collection users.857 #[pallet::storage]858 pub type Allowlist<T: Config> = StorageNMap<859 Key = (860 Key<Blake2_128Concat, CollectionId>,861 Key<Blake2_128Concat, T::CrossAccountId>,862 ),863 Value = bool,864 QueryKind = ValueQuery,865 >;866867 /// Not used by code, exists only to provide some types to metadata.868 #[pallet::storage]869 pub type DummyStorageValue<T: Config> = StorageValue<870 Value = (871 CollectionStats,872 CollectionId,873 TokenId,874 TokenChild,875 PhantomType<(876 TokenData<T::CrossAccountId>,877 RpcCollection<T::AccountId>,878 // RMRK879 RmrkCollectionInfo<T::AccountId>,880 RmrkInstanceInfo<T::AccountId>,881 RmrkResourceInfo,882 RmrkPropertyInfo,883 RmrkBaseInfo<T::AccountId>,884 RmrkPartType,885 RmrkBoundedTheme,886 RmrkNftChild,887 // PoV Estimate Info888 PovInfo,889 )>,890 ),891 QueryKind = OptionQuery,892 >;893894 #[pallet::hooks]895 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {896 fn on_runtime_upgrade() -> Weight {897 StorageVersion::new(1).put::<Pallet<T>>();898899 Weight::zero()900 }901 }902}903904impl<T: Config> Pallet<T> {905 /// Enshure that receiver address is correct.906 ///907 /// Ethereum receiver 0x0000000000000000000000000000000000000000 is reserved, and shouldn't own tokens.908 pub fn ensure_correct_receiver(receiver: &T::CrossAccountId) -> DispatchResult {909 ensure!(910 &T::CrossAccountId::from_eth(H160([0; 20])) != receiver,911 <Error<T>>::AddressIsZero912 );913 Ok(())914 }915916 /// Get a vector of collection admins.917 pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {918 <IsAdmin<T>>::iter_prefix((collection,))919 .map(|(a, _)| a)920 .collect()921 }922923 /// Get a vector of users allowed to mint tokens.924 pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {925 <Allowlist<T>>::iter_prefix((collection,))926 .map(|(a, _)| a)927 .collect()928 }929930 /// Is `user` allowed to mint token in `collection`.931 pub fn allowed(collection: CollectionId, user: T::CrossAccountId) -> bool {932 <Allowlist<T>>::get((collection, user))933 }934935 /// Get statistics of collections.936 pub fn collection_stats() -> CollectionStats {937 let created = <CreatedCollectionCount<T>>::get();938 let destroyed = <DestroyedCollectionCount<T>>::get();939 CollectionStats {940 created: created.0,941 destroyed: destroyed.0,942 alive: created.0 - destroyed.0,943 }944 }945946 /// Get the effective limits for the collection.947 pub fn effective_collection_limits(collection: CollectionId) -> Option<CollectionLimits> {948 let collection = <CollectionById<T>>::get(collection)?;949 let limits = collection.limits;950 let effective_limits = CollectionLimits {951 account_token_ownership_limit: Some(limits.account_token_ownership_limit()),952 sponsored_data_size: Some(limits.sponsored_data_size()),953 sponsored_data_rate_limit: Some(954 limits955 .sponsored_data_rate_limit956 .unwrap_or(SponsoringRateLimit::SponsoringDisabled),957 ),958 token_limit: Some(limits.token_limit()),959 sponsor_transfer_timeout: Some(limits.sponsor_transfer_timeout(960 match collection.mode {961 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,962 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,963 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,964 },965 )),966 sponsor_approve_timeout: Some(limits.sponsor_approve_timeout()),967 owner_can_transfer: Some(limits.owner_can_transfer()),968 owner_can_destroy: Some(limits.owner_can_destroy()),969 transfers_enabled: Some(limits.transfers_enabled()),970 };971972 Some(effective_limits)973 }974975 /// Returns information about the `collection` adapted for rpc.976 pub fn rpc_collection(collection: CollectionId) -> Option<RpcCollection<T::AccountId>> {977 let Collection {978 name,979 description,980 owner,981 mode,982 token_prefix,983 sponsorship,984 limits,985 permissions,986 flags,987 } = <CollectionById<T>>::get(collection)?;988989 let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)990 .into_iter()991 .map(|(key, permission)| PropertyKeyPermission { key, permission })992 .collect();993994 let properties = <CollectionProperties<T>>::get(collection)995 .into_iter()996 .map(|(key, value)| Property { key, value })997 .collect();998999 let permissions = CollectionPermissions {1000 access: Some(permissions.access()),1001 mint_mode: Some(permissions.mint_mode()),1002 nesting: Some(permissions.nesting().clone()),1003 };10041005 Some(RpcCollection {1006 name: name.into_inner(),1007 description: description.into_inner(),1008 owner,1009 mode,1010 token_prefix: token_prefix.into_inner(),1011 sponsorship,1012 limits,1013 permissions,1014 token_property_permissions,1015 properties,1016 read_only: flags.external,10171018 flags: RpcCollectionFlags {1019 foreign: flags.foreign,1020 erc721metadata: flags.erc721metadata,1021 },1022 })1023 }1024}10251026macro_rules! limit_default {1027 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1028 $(1029 if let Some($new) = $new.$field {1030 let $old = $old.$field($($arg)?);1031 let _ = $new;1032 let _ = $old;1033 $check1034 } else {1035 $new.$field = $old.$field1036 }1037 )*1038 }};1039}1040macro_rules! limit_default_clone {1041 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1042 $(1043 if let Some($new) = $new.$field.clone() {1044 let $old = $old.$field($($arg)?);1045 let _ = $new;1046 let _ = $old;1047 $check1048 } else {1049 $new.$field = $old.$field.clone()1050 }1051 )*1052 }};1053}10541055impl<T: Config> Pallet<T> {1056 /// Create new collection.1057 ///1058 /// * `owner` - The owner of the collection.1059 /// * `data` - Description of the created collection.1060 /// * `flags` - Extra flags to store.1061 pub fn init_collection(1062 owner: T::CrossAccountId,1063 payer: T::CrossAccountId,1064 data: CreateCollectionData<T::AccountId>,1065 flags: CollectionFlags,1066 ) -> Result<CollectionId, DispatchError> {1067 {1068 ensure!(1069 data.token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH as usize,1070 Error::<T>::CollectionTokenPrefixLimitExceeded1071 );1072 }10731074 let created_count = <CreatedCollectionCount<T>>::get()1075 .01076 .checked_add(1)1077 .ok_or(ArithmeticError::Overflow)?;1078 let destroyed_count = <DestroyedCollectionCount<T>>::get().0;1079 let id = CollectionId(created_count);10801081 // bound Total number of collections1082 ensure!(1083 created_count - destroyed_count <= COLLECTION_NUMBER_LIMIT,1084 <Error<T>>::TotalCollectionsLimitExceeded1085 );10861087 // =========10881089 let collection = Collection {1090 owner: owner.as_sub().clone(),1091 name: data.name,1092 mode: data.mode.clone(),1093 description: data.description,1094 token_prefix: data.token_prefix,1095 sponsorship: data1096 .pending_sponsor1097 .map(SponsorshipState::Unconfirmed)1098 .unwrap_or_default(),1099 limits: data1100 .limits1101 .map(|limits| Self::clamp_limits(data.mode.clone(), &Default::default(), limits))1102 .unwrap_or_else(|| Ok(CollectionLimits::default()))?,1103 permissions: data1104 .permissions1105 .map(|permissions| {1106 Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)1107 })1108 .unwrap_or_else(|| Ok(CollectionPermissions::default()))?,1109 flags,1110 };11111112 let mut collection_properties = up_data_structs::CollectionProperties::get();1113 collection_properties1114 .try_set_from_iter(data.properties.into_iter())1115 .map_err(<Error<T>>::from)?;11161117 CollectionProperties::<T>::insert(id, collection_properties);11181119 let mut token_props_permissions = PropertiesPermissionMap::new();1120 token_props_permissions1121 .try_set_from_iter(data.token_property_permissions.into_iter())1122 .map_err(<Error<T>>::from)?;11231124 CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);11251126 // Take a (non-refundable) deposit of collection creation1127 {1128 let mut imbalance =1129 <<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();1130 imbalance.subsume(1131 <<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(1132 &T::TreasuryAccountId::get(),1133 T::CollectionCreationPrice::get(),1134 ),1135 );1136 <T as Config>::Currency::settle(1137 payer.as_sub(),1138 imbalance,1139 WithdrawReasons::TRANSFER,1140 ExistenceRequirement::KeepAlive,1141 )1142 .map_err(|_| Error::<T>::NotSufficientFounds)?;1143 }11441145 <CreatedCollectionCount<T>>::put(created_count);1146 <Pallet<T>>::deposit_event(Event::CollectionCreated(1147 id,1148 data.mode.id(),1149 owner.as_sub().clone(),1150 ));1151 <PalletEvm<T>>::deposit_log(1152 erc::CollectionHelpersEvents::CollectionCreated {1153 owner: *owner.as_eth(),1154 collection_id: eth::collection_id_to_address(id),1155 }1156 .to_log(T::ContractAddress::get()),1157 );1158 <CollectionById<T>>::insert(id, collection);1159 Ok(id)1160 }11611162 /// Destroy collection.1163 ///1164 /// * `collection` - Collection handler.1165 /// * `sender` - The owner or administrator of the collection.1166 pub fn destroy_collection(1167 collection: CollectionHandle<T>,1168 sender: &T::CrossAccountId,1169 ) -> DispatchResult {1170 ensure!(1171 collection.limits.owner_can_destroy(),1172 <Error<T>>::NoPermission,1173 );1174 collection.check_is_owner(sender)?;11751176 let destroyed_collections = <DestroyedCollectionCount<T>>::get()1177 .01178 .checked_add(1)1179 .ok_or(ArithmeticError::Overflow)?;11801181 // =========11821183 <DestroyedCollectionCount<T>>::put(destroyed_collections);1184 <CollectionById<T>>::remove(collection.id);1185 <AdminAmount<T>>::remove(collection.id);1186 let _ = <IsAdmin<T>>::clear_prefix((collection.id,), u32::MAX, None);1187 let _ = <Allowlist<T>>::clear_prefix((collection.id,), u32::MAX, None);1188 <CollectionProperties<T>>::remove(collection.id);11891190 <Pallet<T>>::deposit_event(Event::CollectionDestroyed(collection.id));11911192 <PalletEvm<T>>::deposit_log(1193 erc::CollectionHelpersEvents::CollectionDestroyed {1194 collection_id: eth::collection_id_to_address(collection.id),1195 }1196 .to_log(T::ContractAddress::get()),1197 );1198 Ok(())1199 }12001201 fn modify_collection_properties(1202 collection: &CollectionHandle<T>,1203 sender: &T::CrossAccountId,1204 properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,1205 ) -> DispatchResult {1206 collection.check_is_owner_or_admin(sender)?;12071208 let mut stored_properties = <CollectionProperties<T>>::get(collection.id);12091210 for (key, value) in properties_updates {1211 match value {1212 Some(value) => {1213 stored_properties1214 .try_set(key.clone(), value)1215 .map_err(<Error<T>>::from)?;12161217 Self::deposit_event(Event::CollectionPropertySet(collection.id, key));1218 <PalletEvm<T>>::deposit_log(1219 erc::CollectionHelpersEvents::CollectionChanged {1220 collection_id: eth::collection_id_to_address(collection.id),1221 }1222 .to_log(T::ContractAddress::get()),1223 );1224 }1225 None => {1226 stored_properties.remove(&key).map_err(<Error<T>>::from)?;12271228 Self::deposit_event(Event::CollectionPropertyDeleted(collection.id, key));1229 <PalletEvm<T>>::deposit_log(1230 erc::CollectionHelpersEvents::CollectionChanged {1231 collection_id: eth::collection_id_to_address(collection.id),1232 }1233 .to_log(T::ContractAddress::get()),1234 );1235 }1236 }1237 }12381239 <CollectionProperties<T>>::mutate(collection.id, |properties| {1240 *properties = stored_properties;1241 });12421243 Ok(())1244 }12451246 /// Set collection property.1247 ///1248 /// * `collection` - Collection handler.1249 /// * `sender` - The owner or administrator of the collection.1250 /// * `property` - The property to set.1251 pub fn set_collection_property(1252 collection: &CollectionHandle<T>,1253 sender: &T::CrossAccountId,1254 property: Property,1255 ) -> DispatchResult {1256 Self::set_collection_properties(collection, sender, [property].into_iter())1257 }12581259 /// Set a scoped collection property, where the scope is a special prefix1260 /// prohibiting a user access to change the property directly.1261 ///1262 /// * `collection_id` - ID of the collection for which the property is being set.1263 /// * `scope` - Property scope.1264 /// * `property` - The property to set.1265 pub fn set_scoped_collection_property(1266 collection_id: CollectionId,1267 scope: PropertyScope,1268 property: Property,1269 ) -> DispatchResult {1270 CollectionProperties::<T>::try_mutate(collection_id, |properties| {1271 properties.try_scoped_set(scope, property.key, property.value)1272 })1273 .map_err(<Error<T>>::from)?;12741275 Ok(())1276 }12771278 /// Set scoped collection properties, where the scope is a special prefix1279 /// prohibiting a user access to change the properties directly.1280 ///1281 /// * `collection_id` - ID of the collection for which the properties is being set.1282 /// * `scope` - Property scope.1283 /// * `properties` - The properties to set.1284 pub fn set_scoped_collection_properties(1285 collection_id: CollectionId,1286 scope: PropertyScope,1287 properties: impl Iterator<Item = Property>,1288 ) -> DispatchResult {1289 CollectionProperties::<T>::try_mutate(collection_id, |stored_properties| {1290 stored_properties.try_scoped_set_from_iter(scope, properties)1291 })1292 .map_err(<Error<T>>::from)?;12931294 Ok(())1295 }12961297 /// Set collection properties.1298 ///1299 /// * `collection` - Collection handler.1300 /// * `sender` - The owner or administrator of the collection.1301 /// * `properties` - The properties to set.1302 #[transactional]1303 pub fn set_collection_properties(1304 collection: &CollectionHandle<T>,1305 sender: &T::CrossAccountId,1306 properties: impl Iterator<Item = Property>,1307 ) -> DispatchResult {1308 Self::modify_collection_properties(1309 collection,1310 sender,1311 properties.map(|property| (property.key, Some(property.value))),1312 )1313 }13141315 /// Delete collection property.1316 ///1317 /// * `collection` - Collection handler.1318 /// * `sender` - The owner or administrator of the collection.1319 /// * `property` - The property to delete.1320 pub fn delete_collection_property(1321 collection: &CollectionHandle<T>,1322 sender: &T::CrossAccountId,1323 property_key: PropertyKey,1324 ) -> DispatchResult {1325 Self::delete_collection_properties(collection, sender, [property_key].into_iter())1326 }13271328 /// Delete collection properties.1329 ///1330 /// * `collection` - Collection handler.1331 /// * `sender` - The owner or administrator of the collection.1332 /// * `properties` - The properties to delete.1333 #[transactional]1334 pub fn delete_collection_properties(1335 collection: &CollectionHandle<T>,1336 sender: &T::CrossAccountId,1337 property_keys: impl Iterator<Item = PropertyKey>,1338 ) -> DispatchResult {1339 Self::modify_collection_properties(collection, sender, property_keys.map(|key| (key, None)))1340 }13411342 /// Set collection propetry permission without any checks.1343 ///1344 /// Used for migrations.1345 ///1346 /// * `collection` - Collection handler.1347 /// * `property_permissions` - Property permissions.1348 pub fn set_property_permission_unchecked(1349 collection: CollectionId,1350 property_permission: PropertyKeyPermission,1351 ) -> DispatchResult {1352 <CollectionPropertyPermissions<T>>::try_mutate(collection, |permissions| {1353 permissions.try_set(property_permission.key, property_permission.permission)1354 })1355 .map_err(<Error<T>>::from)?;1356 Ok(())1357 }13581359 /// Set collection property permission.1360 ///1361 /// * `collection` - Collection handler.1362 /// * `sender` - The owner or administrator of the collection.1363 /// * `property_permission` - Property permission.1364 pub fn set_property_permission(1365 collection: &CollectionHandle<T>,1366 sender: &T::CrossAccountId,1367 property_permission: PropertyKeyPermission,1368 ) -> DispatchResult {1369 Self::set_scoped_property_permission(1370 collection,1371 sender,1372 PropertyScope::None,1373 property_permission,1374 )1375 }13761377 /// Set collection property permission with scope.1378 ///1379 /// * `collection` - Collection handler.1380 /// * `sender` - The owner or administrator of the collection.1381 /// * `scope` - Property scope.1382 /// * `property_permission` - Property permission.1383 pub fn set_scoped_property_permission(1384 collection: &CollectionHandle<T>,1385 sender: &T::CrossAccountId,1386 scope: PropertyScope,1387 property_permission: PropertyKeyPermission,1388 ) -> DispatchResult {1389 collection.check_is_owner_or_admin(sender)?;13901391 let all_permissions = CollectionPropertyPermissions::<T>::get(collection.id);1392 let current_permission = all_permissions.get(&property_permission.key);1393 if matches![1394 current_permission,1395 Some(PropertyPermission { mutable: false, .. })1396 ] {1397 return Err(<Error<T>>::NoPermission.into());1398 }13991400 CollectionPropertyPermissions::<T>::try_mutate(collection.id, |permissions| {1401 let property_permission = property_permission.clone();1402 permissions.try_scoped_set(1403 scope,1404 property_permission.key,1405 property_permission.permission,1406 )1407 })1408 .map_err(<Error<T>>::from)?;14091410 Self::deposit_event(Event::PropertyPermissionSet(1411 collection.id,1412 property_permission.key,1413 ));1414 <PalletEvm<T>>::deposit_log(1415 erc::CollectionHelpersEvents::CollectionChanged {1416 collection_id: eth::collection_id_to_address(collection.id),1417 }1418 .to_log(T::ContractAddress::get()),1419 );14201421 Ok(())1422 }14231424 /// Set token property permission.1425 ///1426 /// * `collection` - Collection handler.1427 /// * `sender` - The owner or administrator of the collection.1428 /// * `property_permissions` - Property permissions.1429 #[transactional]1430 pub fn set_token_property_permissions(1431 collection: &CollectionHandle<T>,1432 sender: &T::CrossAccountId,1433 property_permissions: Vec<PropertyKeyPermission>,1434 ) -> DispatchResult {1435 Self::set_scoped_token_property_permissions(1436 collection,1437 sender,1438 PropertyScope::None,1439 property_permissions,1440 )1441 }14421443 /// Set token property permission with scope.1444 ///1445 /// * `collection` - Collection handler.1446 /// * `sender` - The owner or administrator of the collection.1447 /// * `scope` - Property scope.1448 /// * `property_permissions` - Property permissions.1449 #[transactional]1450 pub fn set_scoped_token_property_permissions(1451 collection: &CollectionHandle<T>,1452 sender: &T::CrossAccountId,1453 scope: PropertyScope,1454 property_permissions: Vec<PropertyKeyPermission>,1455 ) -> DispatchResult {1456 for prop_pemission in property_permissions {1457 Self::set_scoped_property_permission(collection, sender, scope, prop_pemission)?;1458 }14591460 Ok(())1461 }14621463 /// Get collection property.1464 pub fn get_collection_property(1465 collection_id: CollectionId,1466 key: &PropertyKey,1467 ) -> Option<PropertyValue> {1468 Self::collection_properties(collection_id).get(key).cloned()1469 }14701471 /// Convert byte vector to property key vector.1472 pub fn bytes_keys_to_property_keys(1473 keys: Vec<Vec<u8>>,1474 ) -> Result<Vec<PropertyKey>, DispatchError> {1475 keys.into_iter()1476 .map(|key| -> Result<PropertyKey, DispatchError> {1477 key.try_into()1478 .map_err(|_| <Error<T>>::PropertyKeyIsTooLong.into())1479 })1480 .collect::<Result<Vec<PropertyKey>, DispatchError>>()1481 }14821483 /// Get properties according to given keys.1484 pub fn filter_collection_properties(1485 collection_id: CollectionId,1486 keys: Option<Vec<PropertyKey>>,1487 ) -> Result<Vec<Property>, DispatchError> {1488 let properties = Self::collection_properties(collection_id);14891490 let properties = keys1491 .map(|keys| {1492 keys.into_iter()1493 .filter_map(|key| {1494 properties.get(&key).map(|value| Property {1495 key,1496 value: value.clone(),1497 })1498 })1499 .collect()1500 })1501 .unwrap_or_else(|| {1502 properties1503 .into_iter()1504 .map(|(key, value)| Property { key, value })1505 .collect()1506 });15071508 Ok(properties)1509 }15101511 /// Get property permissions according to given keys.1512 pub fn filter_property_permissions(1513 collection_id: CollectionId,1514 keys: Option<Vec<PropertyKey>>,1515 ) -> Result<Vec<PropertyKeyPermission>, DispatchError> {1516 let permissions = Self::property_permissions(collection_id);15171518 let key_permissions = keys1519 .map(|keys| {1520 keys.into_iter()1521 .filter_map(|key| {1522 permissions1523 .get(&key)1524 .map(|permission| PropertyKeyPermission {1525 key,1526 permission: permission.clone(),1527 })1528 })1529 .collect()1530 })1531 .unwrap_or_else(|| {1532 permissions1533 .into_iter()1534 .map(|(key, permission)| PropertyKeyPermission { key, permission })1535 .collect()1536 });15371538 Ok(key_permissions)1539 }15401541 /// Toggle `user` participation in the `collection`'s allow list.1542 /// #### Store read/writes1543 /// 1 writes1544 pub fn toggle_allowlist(1545 collection: &CollectionHandle<T>,1546 sender: &T::CrossAccountId,1547 user: &T::CrossAccountId,1548 allowed: bool,1549 ) -> DispatchResult {1550 collection.check_is_owner_or_admin(sender)?;15511552 // =========15531554 if allowed {1555 <Allowlist<T>>::insert((collection.id, user), true);1556 Self::deposit_event(Event::<T>::AllowListAddressAdded(1557 collection.id,1558 user.clone(),1559 ));1560 } else {1561 <Allowlist<T>>::remove((collection.id, user));1562 Self::deposit_event(Event::<T>::AllowListAddressRemoved(1563 collection.id,1564 user.clone(),1565 ));1566 }15671568 <PalletEvm<T>>::deposit_log(1569 erc::CollectionHelpersEvents::CollectionChanged {1570 collection_id: eth::collection_id_to_address(collection.id),1571 }1572 .to_log(T::ContractAddress::get()),1573 );15741575 Ok(())1576 }15771578 /// Toggle `user` participation in the `collection`'s admin list.1579 /// #### Store read/writes1580 /// 2 reads, 2 writes1581 pub fn toggle_admin(1582 collection: &CollectionHandle<T>,1583 sender: &T::CrossAccountId,1584 user: &T::CrossAccountId,1585 admin: bool,1586 ) -> DispatchResult {1587 collection.check_is_internal()?;1588 collection.check_is_owner(sender)?;15891590 let is_admin = <IsAdmin<T>>::get((collection.id, user));1591 if is_admin == admin {1592 if admin {1593 return Ok(());1594 } else {1595 return Err(Error::<T>::UserIsNotCollectionAdmin.into());1596 }1597 }1598 let amount = <AdminAmount<T>>::get(collection.id);15991600 // =========16011602 if admin {1603 let amount = amount1604 .checked_add(1)1605 .ok_or(<Error<T>>::CollectionAdminCountExceeded)?;1606 ensure!(1607 amount <= Self::collection_admins_limit(),1608 <Error<T>>::CollectionAdminCountExceeded,1609 );16101611 <AdminAmount<T>>::insert(collection.id, amount);1612 <IsAdmin<T>>::insert((collection.id, user), true);16131614 Self::deposit_event(Event::<T>::CollectionAdminAdded(1615 collection.id,1616 user.clone(),1617 ));1618 } else {1619 <AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));1620 <IsAdmin<T>>::remove((collection.id, user));16211622 Self::deposit_event(Event::<T>::CollectionAdminRemoved(1623 collection.id,1624 user.clone(),1625 ));1626 }16271628 <PalletEvm<T>>::deposit_log(1629 erc::CollectionHelpersEvents::CollectionChanged {1630 collection_id: eth::collection_id_to_address(collection.id),1631 }1632 .to_log(T::ContractAddress::get()),1633 );16341635 Ok(())1636 }16371638 /// Update collection limits.1639 pub fn update_limits(1640 user: &T::CrossAccountId,1641 collection: &mut CollectionHandle<T>,1642 new_limit: CollectionLimits,1643 ) -> DispatchResult {1644 collection.check_is_internal()?;1645 collection.check_is_owner_or_admin(user)?;16461647 collection.limits =1648 Self::clamp_limits(collection.mode.clone(), &collection.limits, new_limit)?;16491650 Self::deposit_event(Event::<T>::CollectionLimitSet(collection.id));1651 <PalletEvm<T>>::deposit_log(1652 erc::CollectionHelpersEvents::CollectionChanged {1653 collection_id: eth::collection_id_to_address(collection.id),1654 }1655 .to_log(T::ContractAddress::get()),1656 );16571658 collection.save()1659 }16601661 /// Merge set fields from `new_limit` to `old_limit`.1662 fn clamp_limits(1663 mode: CollectionMode,1664 old_limit: &CollectionLimits,1665 mut new_limit: CollectionLimits,1666 ) -> Result<CollectionLimits, DispatchError> {1667 let limits = old_limit;1668 limit_default!(old_limit, new_limit,1669 account_token_ownership_limit => ensure!(1670 new_limit <= MAX_TOKEN_OWNERSHIP,1671 <Error<T>>::CollectionLimitBoundsExceeded,1672 ),1673 sponsored_data_size => ensure!(1674 new_limit <= CUSTOM_DATA_LIMIT,1675 <Error<T>>::CollectionLimitBoundsExceeded,1676 ),16771678 sponsored_data_rate_limit => {},1679 token_limit => ensure!(1680 old_limit >= new_limit && new_limit > 0,1681 <Error<T>>::CollectionTokenLimitExceeded1682 ),16831684 sponsor_transfer_timeout(match mode {1685 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,1686 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1687 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1688 }) => ensure!(1689 new_limit <= MAX_SPONSOR_TIMEOUT,1690 <Error<T>>::CollectionLimitBoundsExceeded,1691 ),1692 sponsor_approve_timeout => {},1693 owner_can_transfer => ensure!(1694 !limits.owner_can_transfer_instaled() ||1695 old_limit || !new_limit,1696 <Error<T>>::OwnerPermissionsCantBeReverted,1697 ),1698 owner_can_destroy => ensure!(1699 old_limit || !new_limit,1700 <Error<T>>::OwnerPermissionsCantBeReverted,1701 ),1702 transfers_enabled => {},1703 );1704 Ok(new_limit)1705 }17061707 /// Update collection permissions.1708 pub fn update_permissions(1709 user: &T::CrossAccountId,1710 collection: &mut CollectionHandle<T>,1711 new_permission: CollectionPermissions,1712 ) -> DispatchResult {1713 collection.check_is_internal()?;1714 collection.check_is_owner_or_admin(user)?;1715 collection.permissions = Self::clamp_permissions(1716 collection.mode.clone(),1717 &collection.permissions,1718 new_permission,1719 )?;17201721 Self::deposit_event(Event::<T>::CollectionPermissionSet(collection.id));1722 <PalletEvm<T>>::deposit_log(1723 erc::CollectionHelpersEvents::CollectionChanged {1724 collection_id: eth::collection_id_to_address(collection.id),1725 }1726 .to_log(T::ContractAddress::get()),1727 );17281729 collection.save()1730 }17311732 /// Merge set fields from `new_permission` to `old_permission`.1733 fn clamp_permissions(1734 _mode: CollectionMode,1735 old_permission: &CollectionPermissions,1736 mut new_permission: CollectionPermissions,1737 ) -> Result<CollectionPermissions, DispatchError> {1738 limit_default_clone!(old_permission, new_permission,1739 access => {},1740 mint_mode => {},1741 nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },1742 );1743 Ok(new_permission)1744 }17451746 /// Repair possibly broken properties of a collection.1747 pub fn repair_collection(collection_id: CollectionId) -> DispatchResult {1748 CollectionProperties::<T>::mutate(collection_id, |properties| {1749 properties.recompute_consumed_space();1750 });17511752 Ok(())1753 }1754}17551756/// Indicates unsupported methods by returning [Error::UnsupportedOperation].1757#[macro_export]1758macro_rules! unsupported {1759 ($runtime:path) => {1760 Err($crate::Error::<$runtime>::UnsupportedOperation.into())1761 };1762}17631764/// Return weights for various worst-case operations.1765pub trait CommonWeightInfo<CrossAccountId> {1766 /// Weight of item creation.1767 fn create_item() -> Weight;17681769 /// Weight of items creation.1770 fn create_multiple_items(amount: &[CreateItemData]) -> Weight;17711772 /// Weight of items creation.1773 fn create_multiple_items_ex(cost: &CreateItemExData<CrossAccountId>) -> Weight;17741775 /// The weight of the burning item.1776 fn burn_item() -> Weight;17771778 /// Property setting weight.1779 ///1780 /// * `amount`- The number of properties to set.1781 fn set_collection_properties(amount: u32) -> Weight;17821783 /// Collection property deletion weight.1784 ///1785 /// * `amount`- The number of properties to set.1786 fn delete_collection_properties(amount: u32) -> Weight;17871788 /// Token property setting weight.1789 ///1790 /// * `amount`- The number of properties to set.1791 fn set_token_properties(amount: u32) -> Weight;17921793 /// Token property deletion weight.1794 ///1795 /// * `amount`- The number of properties to delete.1796 fn delete_token_properties(amount: u32) -> Weight;17971798 /// Token property permissions set weight.1799 ///1800 /// * `amount`- The number of property permissions to set.1801 fn set_token_property_permissions(amount: u32) -> Weight;18021803 /// Transfer price of the token or its parts.1804 fn transfer() -> Weight;18051806 /// The price of setting the permission of the operation from another user.1807 fn approve() -> Weight;18081809 /// The price of setting the permission of the operation from another user for eth mirror.1810 fn approve_from() -> Weight;18111812 /// Transfer price from another user.1813 fn transfer_from() -> Weight;18141815 /// The price of burning a token from another user.1816 fn burn_from() -> Weight;18171818 /// Differs from burn_item in case of Fungible and Refungible, as it should burn1819 /// whole users's balance.1820 ///1821 /// This method shouldn't be used directly, as it doesn't count breadth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1822 fn burn_recursively_self_raw() -> Weight;18231824 /// Cost of iterating over `amount` children while burning, without counting child burning itself.1825 ///1826 /// This method shouldn't be used directly, as it doesn't count depth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1827 fn burn_recursively_breadth_raw(amount: u32) -> Weight;18281829 /// The price of recursive burning a token.1830 ///1831 /// `max_selfs` - The maximum burning weight of the token itself.1832 /// `max_breadth` - The maximum number of nested tokens to burn.1833 fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {1834 Self::burn_recursively_self_raw()1835 .saturating_mul(max_selfs.max(1) as u64)1836 .saturating_add(Self::burn_recursively_breadth_raw(max_breadth))1837 }18381839 /// The price of retrieving token owner1840 fn token_owner() -> Weight;18411842 /// The price of setting approval for all1843 fn set_allowance_for_all() -> Weight;18441845 /// The price of repairing an item.1846 fn force_repair_item() -> Weight;1847}18481849/// Weight info extension trait for refungible pallet.1850pub trait RefungibleExtensionsWeightInfo {1851 /// Weight of token repartition.1852 fn repartition() -> Weight;1853}18541855/// Common collection operations.1856///1857/// It wraps methods in Fungible, Nonfungible and Refungible pallets1858/// and adds weight info.1859pub trait CommonCollectionOperations<T: Config> {1860 /// Create token.1861 ///1862 /// * `sender` - The user who mint the token and pays for the transaction.1863 /// * `to` - The user who will own the token.1864 /// * `data` - Token data.1865 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1866 fn create_item(1867 &self,1868 sender: T::CrossAccountId,1869 to: T::CrossAccountId,1870 data: CreateItemData,1871 nesting_budget: &dyn Budget,1872 ) -> DispatchResultWithPostInfo;18731874 /// Create multiple tokens.1875 ///1876 /// * `sender` - The user who mint the token and pays for the transaction.1877 /// * `to` - The user who will own the token.1878 /// * `data` - Token data.1879 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1880 fn create_multiple_items(1881 &self,1882 sender: T::CrossAccountId,1883 to: T::CrossAccountId,1884 data: Vec<CreateItemData>,1885 nesting_budget: &dyn Budget,1886 ) -> DispatchResultWithPostInfo;18871888 /// Create multiple tokens.1889 ///1890 /// * `sender` - The user who mint the token and pays for the transaction.1891 /// * `to` - The user who will own the token.1892 /// * `data` - Token data.1893 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1894 fn create_multiple_items_ex(1895 &self,1896 sender: T::CrossAccountId,1897 data: CreateItemExData<T::CrossAccountId>,1898 nesting_budget: &dyn Budget,1899 ) -> DispatchResultWithPostInfo;19001901 /// Burn token.1902 ///1903 /// * `sender` - The user who owns the token.1904 /// * `token` - Token id that will burned.1905 /// * `amount` - The number of parts of the token that will be burned.1906 fn burn_item(1907 &self,1908 sender: T::CrossAccountId,1909 token: TokenId,1910 amount: u128,1911 ) -> DispatchResultWithPostInfo;19121913 /// Burn token and all nested tokens recursievly.1914 ///1915 /// * `sender` - The user who owns the token.1916 /// * `token` - Token id that will burned.1917 /// * `self_budget` - The budget that can be spent on burning tokens.1918 /// * `breadth_budget` - The budget that can be spent on burning nested tokens.1919 fn burn_item_recursively(1920 &self,1921 sender: T::CrossAccountId,1922 token: TokenId,1923 self_budget: &dyn Budget,1924 breadth_budget: &dyn Budget,1925 ) -> DispatchResultWithPostInfo;19261927 /// Set collection properties.1928 ///1929 /// * `sender` - Must be either the owner of the collection or its admin.1930 /// * `properties` - Properties to be set.1931 fn set_collection_properties(1932 &self,1933 sender: T::CrossAccountId,1934 properties: Vec<Property>,1935 ) -> DispatchResultWithPostInfo;19361937 /// Delete collection properties.1938 ///1939 /// * `sender` - Must be either the owner of the collection or its admin.1940 /// * `properties` - The properties to be removed.1941 fn delete_collection_properties(1942 &self,1943 sender: &T::CrossAccountId,1944 property_keys: Vec<PropertyKey>,1945 ) -> DispatchResultWithPostInfo;19461947 /// Set token properties.1948 ///1949 /// The appropriate [`PropertyPermission`] for the token property1950 /// must be set with [`Self::set_token_property_permissions`].1951 ///1952 /// * `sender` - Must be either the owner of the token or its admin.1953 /// * `token_id` - The token for which the properties are being set.1954 /// * `properties` - Properties to be set.1955 /// * `budget` - Budget for setting properties.1956 fn set_token_properties(1957 &self,1958 sender: T::CrossAccountId,1959 token_id: TokenId,1960 properties: Vec<Property>,1961 budget: &dyn Budget,1962 ) -> DispatchResultWithPostInfo;19631964 /// Remove token properties.1965 ///1966 /// The appropriate [`PropertyPermission`] for the token property1967 /// must be set with [`Self::set_token_property_permissions`].1968 ///1969 /// * `sender` - Must be either the owner of the token or its admin.1970 /// * `token_id` - The token for which the properties are being remove.1971 /// * `property_keys` - Keys to remove corresponding properties.1972 /// * `budget` - Budget for removing properties.1973 fn delete_token_properties(1974 &self,1975 sender: T::CrossAccountId,1976 token_id: TokenId,1977 property_keys: Vec<PropertyKey>,1978 budget: &dyn Budget,1979 ) -> DispatchResultWithPostInfo;19801981 /// Set token property permissions.1982 ///1983 /// * `sender` - Must be either the owner of the token or its admin.1984 /// * `token_id` - The token for which the properties are being set.1985 /// * `property_permissions` - Property permissions to be set.1986 /// * `budget` - Budget for setting properties.1987 fn set_token_property_permissions(1988 &self,1989 sender: &T::CrossAccountId,1990 property_permissions: Vec<PropertyKeyPermission>,1991 ) -> DispatchResultWithPostInfo;19921993 /// Transfer amount of token pieces.1994 ///1995 /// * `sender` - Donor user.1996 /// * `to` - Recepient user.1997 /// * `token` - The token of which parts are being sent.1998 /// * `amount` - The number of parts of the token that will be transferred.1999 /// * `budget` - The maximum budget that can be spent on the transfer.2000 fn transfer(2001 &self,2002 sender: T::CrossAccountId,2003 to: T::CrossAccountId,2004 token: TokenId,2005 amount: u128,2006 budget: &dyn Budget,2007 ) -> DispatchResultWithPostInfo;20082009 /// Grant access to another account to transfer parts of the token owned by the calling user via [Self::transfer_from].2010 ///2011 /// * `sender` - The user who grants access to the token.2012 /// * `spender` - The user to whom the rights are granted.2013 /// * `token` - The token to which access is granted.2014 /// * `amount` - The amount of pieces that another user can dispose of.2015 fn approve(2016 &self,2017 sender: T::CrossAccountId,2018 spender: T::CrossAccountId,2019 token: TokenId,2020 amount: u128,2021 ) -> DispatchResultWithPostInfo;20222023 /// Grant access to another account to transfer parts of the token owned by the calling user's eth mirror via [Self::transfer_from].2024 ///2025 /// * `sender` - The user who grants access to the token.2026 /// * `from` - Spender's eth mirror.2027 /// * `to` - The user to whom the rights are granted.2028 /// * `token` - The token to which access is granted.2029 /// * `amount` - The amount of pieces that another user can dispose of.2030 fn approve_from(2031 &self,2032 sender: T::CrossAccountId,2033 from: T::CrossAccountId,2034 to: T::CrossAccountId,2035 token: TokenId,2036 amount: u128,2037 ) -> DispatchResultWithPostInfo;20382039 /// Send parts of a token owned by another user.2040 ///2041 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2042 ///2043 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2044 /// * `from` - The user who owns the token.2045 /// * `to` - Recepient user.2046 /// * `token` - The token of which parts are being sent.2047 /// * `amount` - The number of parts of the token that will be transferred.2048 /// * `budget` - The maximum budget that can be spent on the transfer.2049 fn transfer_from(2050 &self,2051 sender: T::CrossAccountId,2052 from: T::CrossAccountId,2053 to: T::CrossAccountId,2054 token: TokenId,2055 amount: u128,2056 budget: &dyn Budget,2057 ) -> DispatchResultWithPostInfo;20582059 /// Burn parts of a token owned by another user.2060 ///2061 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2062 ///2063 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2064 /// * `from` - The user who owns the token.2065 /// * `token` - The token of which parts are being sent.2066 /// * `amount` - The number of parts of the token that will be transferred.2067 /// * `budget` - The maximum budget that can be spent on the burn.2068 fn burn_from(2069 &self,2070 sender: T::CrossAccountId,2071 from: T::CrossAccountId,2072 token: TokenId,2073 amount: u128,2074 budget: &dyn Budget,2075 ) -> DispatchResultWithPostInfo;20762077 /// Check permission to nest token.2078 ///2079 /// * `sender` - The user who initiated the check.2080 /// * `from` - The token that is checked for embedding.2081 /// * `under` - Token under which to check.2082 /// * `budget` - The maximum budget that can be spent on the check.2083 fn check_nesting(2084 &self,2085 sender: T::CrossAccountId,2086 from: (CollectionId, TokenId),2087 under: TokenId,2088 budget: &dyn Budget,2089 ) -> DispatchResult;20902091 /// Nest one token into another.2092 ///2093 /// * `under` - Token holder.2094 /// * `to_nest` - Nested token.2095 fn nest(&self, under: TokenId, to_nest: (CollectionId, TokenId));20962097 /// Unnest token.2098 ///2099 /// * `under` - Token holder.2100 /// * `to_nest` - Token to unnest.2101 fn unnest(&self, under: TokenId, to_nest: (CollectionId, TokenId));21022103 /// Get all user tokens.2104 ///2105 /// * `account` - Account for which you need to get tokens.2106 fn account_tokens(&self, account: T::CrossAccountId) -> Vec<TokenId>;21072108 /// Get all the tokens in the collection.2109 fn collection_tokens(&self) -> Vec<TokenId>;21102111 /// Check if the token exists.2112 ///2113 /// * `token` - Id token to check.2114 fn token_exists(&self, token: TokenId) -> bool;21152116 /// Get the id of the last minted token.2117 fn last_token_id(&self) -> TokenId;21182119 /// Get the owner of the token.2120 ///2121 /// * `token` - The token for which you need to find out the owner.2122 fn token_owner(&self, token: TokenId) -> Option<T::CrossAccountId>;21232124 /// Returns 10 tokens owners in no particular order.2125 ///2126 /// * `token` - The token for which you need to find out the owners.2127 fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId>;21282129 /// Get the value of the token property by key.2130 ///2131 /// * `token` - Token with the property to get.2132 /// * `key` - Property name.2133 fn token_property(&self, token_id: TokenId, key: &PropertyKey) -> Option<PropertyValue>;21342135 /// Get a set of token properties by key vector.2136 ///2137 /// * `token` - Token with the property to get.2138 /// * `keys` - Vector of property keys. If this parameter is [None](sp_std::result::Result),2139 /// then all properties are returned.2140 fn token_properties(&self, token: TokenId, keys: Option<Vec<PropertyKey>>) -> Vec<Property>;21412142 /// Amount of unique collection tokens2143 fn total_supply(&self) -> u32;21442145 /// Amount of different tokens account has.2146 ///2147 /// * `account` - The account for which need to get the balance.2148 fn account_balance(&self, account: T::CrossAccountId) -> u32;21492150 /// Amount of specific token account have.2151 fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;21522153 /// Amount of token pieces2154 fn total_pieces(&self, token: TokenId) -> Option<u128>;21552156 /// Get the number of parts of the token that a trusted user can manage.2157 ///2158 /// * `sender` - Trusted user.2159 /// * `spender` - Owner of the token.2160 /// * `token` - The token for which to get the value.2161 fn allowance(2162 &self,2163 sender: T::CrossAccountId,2164 spender: T::CrossAccountId,2165 token: TokenId,2166 ) -> u128;21672168 /// Get extension for RFT collection.2169 fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>>;21702171 /// The `operator` is allowed to transfer all tokens of the `owner` on their behalf.2172 /// * `owner` - Token owner2173 /// * `operator` - Operator2174 /// * `approve` - Should operator status be granted or revoked?2175 fn set_allowance_for_all(2176 &self,2177 owner: T::CrossAccountId,2178 operator: T::CrossAccountId,2179 approve: bool,2180 ) -> DispatchResultWithPostInfo;21812182 /// Tells whether the given `owner` approves the `operator`.2183 fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool;21842185 /// Repairs a possibly broken item.2186 fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo;2187}21882189/// Extension for RFT collection.2190pub trait RefungibleExtensions<T>2191where2192 T: Config,2193{2194 /// Change the number of parts of the token.2195 ///2196 /// When the value changes down, this function is equivalent to burning parts of the token.2197 ///2198 /// * `sender` - The user calling the repartition operation. Must be the owner of the token.2199 /// * `token` - The token for which you want to change the number of parts.2200 /// * `amount` - The new value of the parts of the token.2201 fn repartition(2202 &self,2203 sender: &T::CrossAccountId,2204 token: TokenId,2205 amount: u128,2206 ) -> DispatchResultWithPostInfo;2207}22082209/// Merge [`DispatchResult`] with [`Weight`] into [`DispatchResultWithPostInfo`].2210///2211/// Used for [`CommonCollectionOperations`] implementations and flexible enough to do so.2212pub fn with_weight(res: DispatchResult, weight: Weight) -> DispatchResultWithPostInfo {2213 let post_info = PostDispatchInfo {2214 actual_weight: Some(weight),2215 pays_fee: Pays::Yes,2216 };2217 match res {2218 Ok(()) => Ok(post_info),2219 Err(error) => Err(DispatchErrorWithPostInfo { post_info, error }),2220 }2221}22222223impl<T: Config> From<PropertiesError> for Error<T> {2224 fn from(error: PropertiesError) -> Self {2225 match error {2226 PropertiesError::NoSpaceForProperty => Self::NoSpaceForProperty,2227 PropertiesError::PropertyLimitReached => Self::PropertyLimitReached,2228 PropertiesError::InvalidCharacterInPropertyKey => Self::InvalidCharacterInPropertyKey,2229 PropertiesError::PropertyKeyIsTooLong => Self::PropertyKeyIsTooLong,2230 PropertiesError::EmptyPropertyKey => Self::EmptyPropertyKey,2231 }2232 }2233}pallets/fungible/src/lib.rsdiffbeforeafterboth--- a/pallets/fungible/src/lib.rs
+++ b/pallets/fungible/src/lib.rs
@@ -266,7 +266,7 @@
sender: &T::CrossAccountId,
properties: Vec<Property>,
) -> DispatchResult {
- <PalletCommon<T>>::set_collection_properties(collection, sender, properties)
+ <PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())
}
/// Delete properties of the collection, associated with the provided keys.
@@ -275,7 +275,11 @@
sender: &T::CrossAccountId,
property_keys: Vec<PropertyKey>,
) -> DispatchResult {
- <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)
+ <PalletCommon<T>>::delete_collection_properties(
+ collection,
+ sender,
+ property_keys.into_iter(),
+ )
}
/// Checks if collection has tokens. Return `true` if it has.
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -590,7 +590,7 @@
collection: &NonfungibleHandle<T>,
sender: &T::CrossAccountId,
token_id: TokenId,
- properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
+ properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
is_token_create: bool,
nesting_budget: &dyn Budget,
) -> DispatchResult {
@@ -614,15 +614,16 @@
})
};
- for (key, value) in properties {
- let permission = <PalletCommon<T>>::property_permissions(collection.id)
+ let mut stored_properties = <TokenProperties<T>>::get((collection.id, token_id));
+ let permissions = <PalletCommon<T>>::property_permissions(collection.id);
+
+ for (key, value) in properties_updates {
+ let permission = permissions
.get(&key)
.cloned()
.unwrap_or_else(PropertyPermission::none);
- let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))
- .get(&key)
- .is_some();
+ let is_property_exists = stored_properties.get(&key).is_some();
match permission {
PropertyPermission { mutable: false, .. } if is_property_exists => {
@@ -649,10 +650,9 @@
match value {
Some(value) => {
- <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
- properties.try_set(key.clone(), value)
- })
- .map_err(<CommonError<T>>::from)?;
+ stored_properties
+ .try_set(key.clone(), value)
+ .map_err(<CommonError<T>>::from)?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(
collection.id,
@@ -661,10 +661,9 @@
));
}
None => {
- <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
- properties.remove(&key)
- })
- .map_err(<CommonError<T>>::from)?;
+ stored_properties
+ .remove(&key)
+ .map_err(<CommonError<T>>::from)?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(
collection.id,
@@ -683,6 +682,10 @@
);
}
+ <TokenProperties<T>>::mutate((collection.id, token_id), |properties| {
+ *properties = stored_properties;
+ });
+
Ok(())
}
@@ -784,7 +787,7 @@
sender: &T::CrossAccountId,
properties: Vec<Property>,
) -> DispatchResult {
- <PalletCommon<T>>::set_collection_properties(collection, sender, properties)
+ <PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())
}
/// Remove properties from the collection
@@ -793,7 +796,11 @@
sender: &T::CrossAccountId,
property_keys: Vec<PropertyKey>,
) -> DispatchResult {
- <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)
+ <PalletCommon<T>>::delete_collection_properties(
+ collection,
+ sender,
+ property_keys.into_iter(),
+ )
}
/// Set property permissions for the token.
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -520,7 +520,7 @@
collection: &RefungibleHandle<T>,
sender: &T::CrossAccountId,
token_id: TokenId,
- properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
+ properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
is_token_create: bool,
nesting_budget: &dyn Budget,
) -> DispatchResult {
@@ -544,15 +544,16 @@
Ok(is_bundle_owner)
};
- for (key, value) in properties {
- let permission = <PalletCommon<T>>::property_permissions(collection.id)
+ let mut stored_properties = <TokenProperties<T>>::get((collection.id, token_id));
+ let permissions = <PalletCommon<T>>::property_permissions(collection.id);
+
+ for (key, value) in properties_updates {
+ let permission = permissions
.get(&key)
.cloned()
.unwrap_or_else(PropertyPermission::none);
- let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))
- .get(&key)
- .is_some();
+ let is_property_exists = stored_properties.get(&key).is_some();
match permission {
PropertyPermission { mutable: false, .. } if is_property_exists => {
@@ -578,10 +579,9 @@
match value {
Some(value) => {
- <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
- properties.try_set(key.clone(), value)
- })
- .map_err(<CommonError<T>>::from)?;
+ stored_properties
+ .try_set(key.clone(), value)
+ .map_err(<CommonError<T>>::from)?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(
collection.id,
@@ -590,10 +590,9 @@
));
}
None => {
- <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
- properties.remove(&key)
- })
- .map_err(<CommonError<T>>::from)?;
+ stored_properties
+ .remove(&key)
+ .map_err(<CommonError<T>>::from)?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(
collection.id,
@@ -612,6 +611,10 @@
);
}
+ <TokenProperties<T>>::mutate((collection.id, token_id), |properties| {
+ *properties = stored_properties;
+ });
+
Ok(())
}
@@ -1353,7 +1356,7 @@
sender: &T::CrossAccountId,
properties: Vec<Property>,
) -> DispatchResult {
- <PalletCommon<T>>::set_collection_properties(collection, sender, properties)
+ <PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())
}
pub fn delete_collection_properties(
@@ -1361,7 +1364,11 @@
sender: &T::CrossAccountId,
property_keys: Vec<PropertyKey>,
) -> DispatchResult {
- <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)
+ <PalletCommon<T>>::delete_collection_properties(
+ collection,
+ sender,
+ property_keys.into_iter(),
+ )
}
pub fn set_token_property_permissions(
pallets/unique/src/eth/mod.rsdiffbeforeafterboth--- a/pallets/unique/src/eth/mod.rs
+++ b/pallets/unique/src/eth/mod.rs
@@ -33,7 +33,6 @@
};
use pallet_evm::{account::CrossAccountId, OnMethodCall, PrecompileHandle, PrecompileResult};
use pallet_evm_coder_substrate::{dispatch_to_evm, SubstrateRecorder, WithRecorder};
-use sp_std::vec;
use up_data_structs::{
CollectionDescription, CollectionMode, CollectionName, CollectionTokenPrefix,
CreateCollectionData,
@@ -316,13 +315,14 @@
<PalletCommon<T>>::set_collection_properties(
&collection,
&caller,
- vec![up_data_structs::Property {
+ [up_data_structs::Property {
key: key::base_uri(),
value: base_uri
.into_bytes()
.try_into()
.map_err(|_| "base uri is too large")?,
- }],
+ }]
+ .into_iter(),
)
.map_err(dispatch_to_evm::<T>)?;
}