difftreelog
Merge pull request #854 from UniqueNetwork/fix/createItemWeight
in: master
15 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -5783,7 +5783,7 @@
[[package]]
name = "pallet-common"
-version = "0.1.12"
+version = "0.1.13"
dependencies = [
"ethereum 0.14.0",
"evm-coder",
@@ -6340,7 +6340,7 @@
[[package]]
name = "pallet-nonfungible"
-version = "0.1.12"
+version = "0.1.13"
dependencies = [
"evm-coder",
"frame-benchmarking",
@@ -6499,7 +6499,7 @@
[[package]]
name = "pallet-refungible"
-version = "0.2.11"
+version = "0.2.12"
dependencies = [
"evm-coder",
"frame-benchmarking",
pallets/common/CHANGELOG.mddiffbeforeafterboth--- a/pallets/common/CHANGELOG.md
+++ b/pallets/common/CHANGELOG.md
@@ -4,6 +4,12 @@
<!-- bureaucrate goes here -->
+## [0.1.13] - 2023-01-20
+
+### Changed
+
+- Behavior of the `CommonWeightInfo::create_item` method.
+
## [0.1.12] - 2022-11-16
### Changed
pallets/common/Cargo.tomldiffbeforeafterboth--- a/pallets/common/Cargo.toml
+++ b/pallets/common/Cargo.toml
@@ -2,7 +2,7 @@
edition = "2021"
license = "GPLv3"
name = "pallet-common"
-version = "0.1.12"
+version = "0.1.13"
[dependencies]
codec = { default-features = false, features = ['derive'], package = 'parity-scale-codec', version = "3.1.2" }
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 TokenOwnerError,104 PropertyKeyPermission,105 TokenData,106 TrySetProperty,107 PropertyScope,108 // RMRK109 RmrkCollectionInfo,110 RmrkInstanceInfo,111 RmrkResourceInfo,112 RmrkPropertyInfo,113 RmrkBaseInfo,114 RmrkPartType,115 RmrkBoundedTheme,116 RmrkNftChild,117 CollectionPermissions,118};119use up_pov_estimate_rpc::PovInfo;120121pub use pallet::*;122use sp_core::H160;123use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};124#[cfg(feature = "runtime-benchmarks")]125pub mod benchmarking;126pub mod dispatch;127pub mod erc;128pub mod eth;129pub mod weights;130131/// Weight info.132pub type SelfWeightOf<T> = <T as Config>::WeightInfo;133134/// Collection handle contains information about collection data and id.135/// Also provides functionality to count consumed gas.136///137/// CollectionHandle is used as a generic wrapper for collections of all types.138/// It allows to perform common operations and queries on any collection type,139/// both completely general for all, as well as their respective implementations of [`CommonCollectionOperations`].140#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]141pub struct CollectionHandle<T: Config> {142 /// Collection id143 pub id: CollectionId,144 collection: Collection<T::AccountId>,145 /// Substrate recorder for counting consumed gas146 pub recorder: SubstrateRecorder<T>,147}148149impl<T: Config> WithRecorder<T> for CollectionHandle<T> {150 fn recorder(&self) -> &SubstrateRecorder<T> {151 &self.recorder152 }153 fn into_recorder(self) -> SubstrateRecorder<T> {154 self.recorder155 }156}157158impl<T: Config> CollectionHandle<T> {159 /// Same as [CollectionHandle::new] but with an explicit gas limit.160 pub fn new_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {161 <CollectionById<T>>::get(id).map(|collection| Self {162 id,163 collection,164 recorder: SubstrateRecorder::new(gas_limit),165 })166 }167168 /// Same as [CollectionHandle::new] but with an existed [`SubstrateRecorder`].169 pub fn new_with_recorder(id: CollectionId, recorder: SubstrateRecorder<T>) -> Option<Self> {170 <CollectionById<T>>::get(id).map(|collection| Self {171 id,172 collection,173 recorder,174 })175 }176177 /// Retrives collection data from storage and creates collection handle with default parameters.178 /// If collection not found return `None`179 pub fn new(id: CollectionId) -> Option<Self> {180 Self::new_with_gas_limit(id, u64::MAX)181 }182183 /// Same as [`CollectionHandle::new`] but if collection not found [CollectionNotFound](Error::CollectionNotFound) returned.184 pub fn try_get(id: CollectionId) -> Result<Self, DispatchError> {185 Ok(Self::new(id).ok_or(<Error<T>>::CollectionNotFound)?)186 }187188 /// Consume gas for reading.189 pub fn consume_store_reads(&self, reads: u64) -> evm_coder::execution::Result<()> {190 self.recorder191 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(192 <T as frame_system::Config>::DbWeight::get()193 .read194 .saturating_mul(reads),195 )))196 }197198 /// Consume gas for writing.199 pub fn consume_store_writes(&self, writes: u64) -> evm_coder::execution::Result<()> {200 self.recorder201 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(202 <T as frame_system::Config>::DbWeight::get()203 .write204 .saturating_mul(writes),205 )))206 }207208 /// Consume gas for reading and writing.209 pub fn consume_store_reads_and_writes(210 &self,211 reads: u64,212 writes: u64,213 ) -> evm_coder::execution::Result<()> {214 let weight = <T as frame_system::Config>::DbWeight::get();215 let reads = weight.read.saturating_mul(reads);216 let writes = weight.read.saturating_mul(writes);217 self.recorder218 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(219 reads.saturating_add(writes),220 )))221 }222223 /// Save collection to storage.224 pub fn save(&self) -> DispatchResult {225 <CollectionById<T>>::insert(self.id, &self.collection);226 Ok(())227 }228229 /// Set collection sponsor.230 ///231 /// Unique collections allows sponsoring for certain actions.232 /// This method allows you to set the sponsor of the collection.233 /// In order for sponsorship to become active, it must be confirmed through [`Self::confirm_sponsorship`].234 pub fn set_sponsor(235 &mut self,236 sender: &T::CrossAccountId,237 sponsor: T::AccountId,238 ) -> DispatchResult {239 self.check_is_internal()?;240 self.check_is_owner_or_admin(sender)?;241242 self.collection.sponsorship = SponsorshipState::Unconfirmed(sponsor.clone());243244 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor));245 <PalletEvm<T>>::deposit_log(246 erc::CollectionHelpersEvents::CollectionChanged {247 collection_id: eth::collection_id_to_address(self.id),248 }249 .to_log(T::ContractAddress::get()),250 );251252 self.save()253 }254255 /// Force set `sponsor`.256 ///257 /// Differs from [`set_sponsor`][`Self::set_sponsor`] in that confirmation258 /// from the `sponsor` is not required.259 ///260 /// # Arguments261 ///262 /// * `sender`: Caller's account.263 /// * `sponsor`: ID of the account of the sponsor-to-be.264 pub fn force_set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {265 self.check_is_internal()?;266267 self.collection.sponsorship = SponsorshipState::Confirmed(sponsor.clone());268269 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor.clone()));270 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sponsor));271 <PalletEvm<T>>::deposit_log(272 erc::CollectionHelpersEvents::CollectionChanged {273 collection_id: eth::collection_id_to_address(self.id),274 }275 .to_log(T::ContractAddress::get()),276 );277278 self.save()279 }280281 /// Confirm sponsorship282 ///283 /// In order for the sponsorship to become active, the user set as the sponsor must confirm their participation.284 /// Before confirming sponsorship, the user must be specified as the sponsor of the collection via [`Self::set_sponsor`].285 pub fn confirm_sponsorship(&mut self, sender: &T::AccountId) -> DispatchResult {286 self.check_is_internal()?;287 ensure!(288 self.collection.sponsorship.pending_sponsor() == Some(sender),289 Error::<T>::ConfirmSponsorshipFail290 );291292 self.collection.sponsorship = SponsorshipState::Confirmed(sender.clone());293294 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sender.clone()));295 <PalletEvm<T>>::deposit_log(296 erc::CollectionHelpersEvents::CollectionChanged {297 collection_id: eth::collection_id_to_address(self.id),298 }299 .to_log(T::ContractAddress::get()),300 );301302 self.save()303 }304305 /// Remove collection sponsor.306 pub fn remove_sponsor(&mut self, sender: &T::CrossAccountId) -> DispatchResult {307 self.check_is_internal()?;308 self.check_is_owner_or_admin(sender)?;309310 self.collection.sponsorship = SponsorshipState::Disabled;311312 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));313 <PalletEvm<T>>::deposit_log(314 erc::CollectionHelpersEvents::CollectionChanged {315 collection_id: eth::collection_id_to_address(self.id),316 }317 .to_log(T::ContractAddress::get()),318 );319 self.save()320 }321322 /// Force remove `sponsor`.323 ///324 /// Differs from `remove_sponsor` in that325 /// it doesn't require consent from the `owner` of the collection.326 pub fn force_remove_sponsor(&mut self) -> DispatchResult {327 self.check_is_internal()?;328329 self.collection.sponsorship = SponsorshipState::Disabled;330331 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));332 <PalletEvm<T>>::deposit_log(333 erc::CollectionHelpersEvents::CollectionChanged {334 collection_id: eth::collection_id_to_address(self.id),335 }336 .to_log(T::ContractAddress::get()),337 );338 self.save()339 }340341 /// Checks that the collection was created with, and must be operated upon through **Unique API**.342 /// Now check only the `external` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.343 pub fn check_is_internal(&self) -> DispatchResult {344 if self.flags.external {345 return Err(<Error<T>>::CollectionIsExternal)?;346 }347348 Ok(())349 }350351 /// Checks that the collection was created with, and must be operated upon through an **assimilated API**.352 /// Now check only the `external` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.353 pub fn check_is_external(&self) -> DispatchResult {354 if !self.flags.external {355 return Err(<Error<T>>::CollectionIsInternal)?;356 }357358 Ok(())359 }360}361362impl<T: Config> Deref for CollectionHandle<T> {363 type Target = Collection<T::AccountId>;364365 fn deref(&self) -> &Self::Target {366 &self.collection367 }368}369370impl<T: Config> DerefMut for CollectionHandle<T> {371 fn deref_mut(&mut self) -> &mut Self::Target {372 &mut self.collection373 }374}375376impl<T: Config> CollectionHandle<T> {377 /// Checks if the `user` is the owner of the collection.378 pub fn check_is_owner(&self, user: &T::CrossAccountId) -> DispatchResult {379 ensure!(*user.as_sub() == self.owner, <Error<T>>::NoPermission);380 Ok(())381 }382383 /// Returns **true** if the `user` is the owner or administrator of the collection.384 pub fn is_owner_or_admin(&self, user: &T::CrossAccountId) -> bool {385 *user.as_sub() == self.owner || <IsAdmin<T>>::get((self.id, user))386 }387388 /// Checks if the `user` is the owner or administrator of the collection.389 pub fn check_is_owner_or_admin(&self, user: &T::CrossAccountId) -> DispatchResult {390 ensure!(self.is_owner_or_admin(user), <Error<T>>::NoPermission);391 Ok(())392 }393394 /// Returns **true** if395 /// * the `user`is a collection owner or admin396 /// * the collection limits allow the owner/admins to transfer/burn any collection token397 pub fn ignores_token_restrictions(&self, user: &T::CrossAccountId) -> bool {398 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)399 }400401 /// Return **true** if `user` does not have enough token parts, and he can ignore such restrictions.402 pub fn ignores_owned_amount(&self, user: &T::CrossAccountId) -> bool {403 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)404 }405406 /// Checks if the user is in the allow list. If not [Error::AddressNotInAllowlist] returns.407 pub fn check_allowlist(&self, user: &T::CrossAccountId) -> DispatchResult {408 ensure!(409 <Allowlist<T>>::get((self.id, user)),410 <Error<T>>::AddressNotInAllowlist411 );412 Ok(())413 }414415 /// Changes collection owner to another account416 /// #### Store read/writes417 /// 1 writes418 pub fn change_owner(419 &mut self,420 caller: T::CrossAccountId,421 new_owner: T::CrossAccountId,422 ) -> DispatchResult {423 self.check_is_internal()?;424 self.check_is_owner(&caller)?;425 self.collection.owner = new_owner.as_sub().clone();426427 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnerChanged(428 self.id,429 new_owner.as_sub().clone(),430 ));431 <PalletEvm<T>>::deposit_log(432 erc::CollectionHelpersEvents::CollectionChanged {433 collection_id: eth::collection_id_to_address(self.id),434 }435 .to_log(T::ContractAddress::get()),436 );437438 self.save()439 }440}441442#[frame_support::pallet]443pub mod pallet {444 use super::*;445 use dispatch::CollectionDispatch;446 use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};447 use frame_system::pallet_prelude::*;448 use frame_support::traits::Currency;449 use up_data_structs::{TokenId, mapping::TokenAddressMapping};450 use scale_info::TypeInfo;451 use weights::WeightInfo;452453 #[pallet::config]454 pub trait Config:455 frame_system::Config + pallet_evm_coder_substrate::Config + pallet_evm::Config + TypeInfo456 {457 /// Weight information for functions of this pallet.458 type WeightInfo: WeightInfo;459460 /// Events compatible with [`frame_system::Config::Event`].461 type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;462463 /// Handler of accounts and payment.464 type Currency: Currency<Self::AccountId>;465466 /// Set price to create a collection.467 #[pallet::constant]468 type CollectionCreationPrice: Get<469 <<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,470 >;471472 /// Dispatcher of operations on collections.473 type CollectionDispatch: CollectionDispatch<Self>;474475 /// Account which holds the chain's treasury.476 type TreasuryAccountId: Get<Self::AccountId>;477478 /// Address under which the CollectionHelper contract would be available.479 #[pallet::constant]480 type ContractAddress: Get<H160>;481482 /// Mapper for token addresses to Ethereum addresses.483 type EvmTokenAddressMapping: TokenAddressMapping<H160>;484485 /// Mapper for token addresses to [`CrossAccountId`].486 type CrossTokenAddressMapping: TokenAddressMapping<Self::CrossAccountId>;487 }488489 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);490491 #[pallet::pallet]492 #[pallet::storage_version(STORAGE_VERSION)]493 #[pallet::generate_store(pub(super) trait Store)]494 pub struct Pallet<T>(_);495496 #[pallet::extra_constants]497 impl<T: Config> Pallet<T> {498 /// Maximum admins per collection.499 pub fn collection_admins_limit() -> u32 {500 COLLECTION_ADMINS_LIMIT501 }502 }503504 impl<T: Config> Pallet<T> {505 /// Helper function that handles deposit events506 pub fn deposit_event(event: Event<T>) {507 let event = <T as Config>::RuntimeEvent::from(event);508 let event = event.into();509 <frame_system::Pallet<T>>::deposit_event(event)510 }511 }512513 #[pallet::event]514 pub enum Event<T: Config> {515 /// New collection was created516 CollectionCreated(517 /// Globally unique identifier of newly created collection.518 CollectionId,519 /// [`CollectionMode`] converted into _u8_.520 u8,521 /// Collection owner.522 T::AccountId,523 ),524525 /// New collection was destroyed526 CollectionDestroyed(527 /// Globally unique identifier of collection.528 CollectionId,529 ),530531 /// New item was created.532 ItemCreated(533 /// Id of the collection where item was created.534 CollectionId,535 /// Id of an item. Unique within the collection.536 TokenId,537 /// Owner of newly created item538 T::CrossAccountId,539 /// Always 1 for NFT540 u128,541 ),542543 /// Collection item was burned.544 ItemDestroyed(545 /// Id of the collection where item was destroyed.546 CollectionId,547 /// Identifier of burned NFT.548 TokenId,549 /// Which user has destroyed its tokens.550 T::CrossAccountId,551 /// Amount of token pieces destroed. Always 1 for NFT.552 u128,553 ),554555 /// Item was transferred556 Transfer(557 /// Id of collection to which item is belong.558 CollectionId,559 /// Id of an item.560 TokenId,561 /// Original owner of item.562 T::CrossAccountId,563 /// New owner of item.564 T::CrossAccountId,565 /// Amount of token pieces transfered. Always 1 for NFT.566 u128,567 ),568569 /// Amount pieces of token owned by `sender` was approved for `spender`.570 Approved(571 /// Id of collection to which item is belong.572 CollectionId,573 /// Id of an item.574 TokenId,575 /// Original owner of item.576 T::CrossAccountId,577 /// Id for which the approval was granted.578 T::CrossAccountId,579 /// Amount of token pieces transfered. Always 1 for NFT.580 u128,581 ),582583 /// A `sender` approves operations on all owned tokens for `spender`.584 ApprovedForAll(585 /// Id of collection to which item is belong.586 CollectionId,587 /// Owner of a wallet.588 T::CrossAccountId,589 /// Id for which operator status was granted or rewoked.590 T::CrossAccountId,591 /// Is operator status granted or revoked?592 bool,593 ),594595 /// The colletion property has been added or edited.596 CollectionPropertySet(597 /// Id of collection to which property has been set.598 CollectionId,599 /// The property that was set.600 PropertyKey,601 ),602603 /// The property has been deleted.604 CollectionPropertyDeleted(605 /// Id of collection to which property has been deleted.606 CollectionId,607 /// The property that was deleted.608 PropertyKey,609 ),610611 /// The token property has been added or edited.612 TokenPropertySet(613 /// Identifier of the collection whose token has the property set.614 CollectionId,615 /// The token for which the property was set.616 TokenId,617 /// The property that was set.618 PropertyKey,619 ),620621 /// The token property has been deleted.622 TokenPropertyDeleted(623 /// Identifier of the collection whose token has the property deleted.624 CollectionId,625 /// The token for which the property was deleted.626 TokenId,627 /// The property that was deleted.628 PropertyKey,629 ),630631 /// The token property permission of a collection has been set.632 PropertyPermissionSet(633 /// ID of collection to which property permission has been set.634 CollectionId,635 /// The property permission that was set.636 PropertyKey,637 ),638639 /// Address was added to the allow list.640 AllowListAddressAdded(641 /// ID of the affected collection.642 CollectionId,643 /// Address of the added account.644 T::CrossAccountId,645 ),646647 /// Address was removed from the allow list.648 AllowListAddressRemoved(649 /// ID of the affected collection.650 CollectionId,651 /// Address of the removed account.652 T::CrossAccountId,653 ),654655 /// Collection admin was added.656 CollectionAdminAdded(657 /// ID of the affected collection.658 CollectionId,659 /// Admin address.660 T::CrossAccountId,661 ),662663 /// Collection admin was removed.664 CollectionAdminRemoved(665 /// ID of the affected collection.666 CollectionId,667 /// Removed admin address.668 T::CrossAccountId,669 ),670671 /// Collection limits were set.672 CollectionLimitSet(673 /// ID of the affected collection.674 CollectionId,675 ),676677 /// Collection owned was changed.678 CollectionOwnerChanged(679 /// ID of the affected collection.680 CollectionId,681 /// New owner address.682 T::AccountId,683 ),684685 /// Collection permissions were set.686 CollectionPermissionSet(687 /// ID of the affected collection.688 CollectionId,689 ),690691 /// Collection sponsor was set.692 CollectionSponsorSet(693 /// ID of the affected collection.694 CollectionId,695 /// New sponsor address.696 T::AccountId,697 ),698699 /// New sponsor was confirm.700 SponsorshipConfirmed(701 /// ID of the affected collection.702 CollectionId,703 /// New sponsor address.704 T::AccountId,705 ),706707 /// Collection sponsor was removed.708 CollectionSponsorRemoved(709 /// ID of the affected collection.710 CollectionId,711 ),712 }713714 #[pallet::error]715 pub enum Error<T> {716 /// This collection does not exist.717 CollectionNotFound,718 /// Sender parameter and item owner must be equal.719 MustBeTokenOwner,720 /// No permission to perform action721 NoPermission,722 /// Destroying only empty collections is allowed723 CantDestroyNotEmptyCollection,724 /// Collection is not in mint mode.725 PublicMintingNotAllowed,726 /// Address is not in allow list.727 AddressNotInAllowlist,728729 /// Collection name can not be longer than 63 char.730 CollectionNameLimitExceeded,731 /// Collection description can not be longer than 255 char.732 CollectionDescriptionLimitExceeded,733 /// Token prefix can not be longer than 15 char.734 CollectionTokenPrefixLimitExceeded,735 /// Total collections bound exceeded.736 TotalCollectionsLimitExceeded,737 /// Exceeded max admin count738 CollectionAdminCountExceeded,739 /// Collection limit bounds per collection exceeded740 CollectionLimitBoundsExceeded,741 /// Tried to enable permissions which are only permitted to be disabled742 OwnerPermissionsCantBeReverted,743 /// Collection settings not allowing items transferring744 TransferNotAllowed,745 /// Account token limit exceeded per collection746 AccountTokenLimitExceeded,747 /// Collection token limit exceeded748 CollectionTokenLimitExceeded,749 /// Metadata flag frozen750 MetadataFlagFrozen,751752 /// Item does not exist753 TokenNotFound,754 /// Item is balance not enough755 TokenValueTooLow,756 /// Requested value is more than the approved757 ApprovedValueTooLow,758 /// Tried to approve more than owned759 CantApproveMoreThanOwned,760 /// Only spending from eth mirror could be approved761 AddressIsNotEthMirror,762763 /// Can't transfer tokens to ethereum zero address764 AddressIsZero,765766 /// The operation is not supported767 UnsupportedOperation,768769 /// Insufficient funds to perform an action770 NotSufficientFounds,771772 /// User does not satisfy the nesting rule773 UserIsNotAllowedToNest,774 /// Only tokens from specific collections may nest tokens under this one775 SourceCollectionIsNotAllowedToNest,776777 /// Tried to store more data than allowed in collection field778 CollectionFieldSizeExceeded,779780 /// Tried to store more property data than allowed781 NoSpaceForProperty,782783 /// Tried to store more property keys than allowed784 PropertyLimitReached,785786 /// Property key is too long787 PropertyKeyIsTooLong,788789 /// Only ASCII letters, digits, and symbols `_`, `-`, and `.` are allowed790 InvalidCharacterInPropertyKey,791792 /// Empty property keys are forbidden793 EmptyPropertyKey,794795 /// Tried to access an external collection with an internal API796 CollectionIsExternal,797798 /// Tried to access an internal collection with an external API799 CollectionIsInternal,800801 /// This address is not set as sponsor, use setCollectionSponsor first.802 ConfirmSponsorshipFail,803804 /// The user is not an administrator.805 UserIsNotCollectionAdmin,806 }807808 /// Storage of the count of created collections. Essentially contains the last collection ID.809 #[pallet::storage]810 pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;811812 /// Storage of the count of deleted collections.813 #[pallet::storage]814 pub type DestroyedCollectionCount<T> =815 StorageValue<Value = CollectionId, QueryKind = ValueQuery>;816817 /// Storage of collection info.818 #[pallet::storage]819 pub type CollectionById<T> = StorageMap<820 Hasher = Blake2_128Concat,821 Key = CollectionId,822 Value = Collection<<T as frame_system::Config>::AccountId>,823 QueryKind = OptionQuery,824 >;825826 /// Storage of collection properties.827 #[pallet::storage]828 #[pallet::getter(fn collection_properties)]829 pub type CollectionProperties<T> = StorageMap<830 Hasher = Blake2_128Concat,831 Key = CollectionId,832 Value = Properties,833 QueryKind = ValueQuery,834 OnEmpty = up_data_structs::CollectionProperties,835 >;836837 /// Storage of token property permissions of a collection.838 #[pallet::storage]839 #[pallet::getter(fn property_permissions)]840 pub type CollectionPropertyPermissions<T> = StorageMap<841 Hasher = Blake2_128Concat,842 Key = CollectionId,843 Value = PropertiesPermissionMap,844 QueryKind = ValueQuery,845 >;846847 /// Storage of the amount of collection admins.848 #[pallet::storage]849 pub type AdminAmount<T> = StorageMap<850 Hasher = Blake2_128Concat,851 Key = CollectionId,852 Value = u32,853 QueryKind = ValueQuery,854 >;855856 /// List of collection admins.857 #[pallet::storage]858 pub type IsAdmin<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 /// Allowlisted collection users.868 #[pallet::storage]869 pub type Allowlist<T: Config> = StorageNMap<870 Key = (871 Key<Blake2_128Concat, CollectionId>,872 Key<Blake2_128Concat, T::CrossAccountId>,873 ),874 Value = bool,875 QueryKind = ValueQuery,876 >;877878 /// Not used by code, exists only to provide some types to metadata.879 #[pallet::storage]880 pub type DummyStorageValue<T: Config> = StorageValue<881 Value = (882 CollectionStats,883 CollectionId,884 TokenId,885 TokenChild,886 PhantomType<(887 TokenData<T::CrossAccountId>,888 RpcCollection<T::AccountId>,889 // RMRK890 RmrkCollectionInfo<T::AccountId>,891 RmrkInstanceInfo<T::AccountId>,892 RmrkResourceInfo,893 RmrkPropertyInfo,894 RmrkBaseInfo<T::AccountId>,895 RmrkPartType,896 RmrkBoundedTheme,897 RmrkNftChild,898 // PoV Estimate Info899 PovInfo,900 )>,901 ),902 QueryKind = OptionQuery,903 >;904905 #[pallet::hooks]906 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {907 fn on_runtime_upgrade() -> Weight {908 StorageVersion::new(1).put::<Pallet<T>>();909910 Weight::zero()911 }912 }913}914915impl<T: Config> Pallet<T> {916 /// Enshure that receiver address is correct.917 ///918 /// Ethereum receiver 0x0000000000000000000000000000000000000000 is reserved, and shouldn't own tokens.919 pub fn ensure_correct_receiver(receiver: &T::CrossAccountId) -> DispatchResult {920 ensure!(921 &T::CrossAccountId::from_eth(H160([0; 20])) != receiver,922 <Error<T>>::AddressIsZero923 );924 Ok(())925 }926927 /// Get a vector of collection admins.928 pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {929 <IsAdmin<T>>::iter_prefix((collection,))930 .map(|(a, _)| a)931 .collect()932 }933934 /// Get a vector of users allowed to mint tokens.935 pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {936 <Allowlist<T>>::iter_prefix((collection,))937 .map(|(a, _)| a)938 .collect()939 }940941 /// Is `user` allowed to mint token in `collection`.942 pub fn allowed(collection: CollectionId, user: T::CrossAccountId) -> bool {943 <Allowlist<T>>::get((collection, user))944 }945946 /// Get statistics of collections.947 pub fn collection_stats() -> CollectionStats {948 let created = <CreatedCollectionCount<T>>::get();949 let destroyed = <DestroyedCollectionCount<T>>::get();950 CollectionStats {951 created: created.0,952 destroyed: destroyed.0,953 alive: created.0 - destroyed.0,954 }955 }956957 /// Get the effective limits for the collection.958 pub fn effective_collection_limits(collection: CollectionId) -> Option<CollectionLimits> {959 let collection = <CollectionById<T>>::get(collection)?;960 let limits = collection.limits;961 let effective_limits = CollectionLimits {962 account_token_ownership_limit: Some(limits.account_token_ownership_limit()),963 sponsored_data_size: Some(limits.sponsored_data_size()),964 sponsored_data_rate_limit: Some(965 limits966 .sponsored_data_rate_limit967 .unwrap_or(SponsoringRateLimit::SponsoringDisabled),968 ),969 token_limit: Some(limits.token_limit()),970 sponsor_transfer_timeout: Some(limits.sponsor_transfer_timeout(971 match collection.mode {972 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,973 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,974 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,975 },976 )),977 sponsor_approve_timeout: Some(limits.sponsor_approve_timeout()),978 owner_can_transfer: Some(limits.owner_can_transfer()),979 owner_can_destroy: Some(limits.owner_can_destroy()),980 transfers_enabled: Some(limits.transfers_enabled()),981 };982983 Some(effective_limits)984 }985986 /// Returns information about the `collection` adapted for rpc.987 pub fn rpc_collection(collection: CollectionId) -> Option<RpcCollection<T::AccountId>> {988 let Collection {989 name,990 description,991 owner,992 mode,993 token_prefix,994 sponsorship,995 limits,996 permissions,997 flags,998 } = <CollectionById<T>>::get(collection)?;9991000 let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)1001 .into_iter()1002 .map(|(key, permission)| PropertyKeyPermission { key, permission })1003 .collect();10041005 let properties = <CollectionProperties<T>>::get(collection)1006 .into_iter()1007 .map(|(key, value)| Property { key, value })1008 .collect();10091010 let permissions = CollectionPermissions {1011 access: Some(permissions.access()),1012 mint_mode: Some(permissions.mint_mode()),1013 nesting: Some(permissions.nesting().clone()),1014 };10151016 Some(RpcCollection {1017 name: name.into_inner(),1018 description: description.into_inner(),1019 owner,1020 mode,1021 token_prefix: token_prefix.into_inner(),1022 sponsorship,1023 limits,1024 permissions,1025 token_property_permissions,1026 properties,1027 read_only: flags.external,10281029 flags: RpcCollectionFlags {1030 foreign: flags.foreign,1031 erc721metadata: flags.erc721metadata,1032 },1033 })1034 }1035}10361037macro_rules! limit_default {1038 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1039 $(1040 if let Some($new) = $new.$field {1041 let $old = $old.$field($($arg)?);1042 let _ = $new;1043 let _ = $old;1044 $check1045 } else {1046 $new.$field = $old.$field1047 }1048 )*1049 }};1050}1051macro_rules! limit_default_clone {1052 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1053 $(1054 if let Some($new) = $new.$field.clone() {1055 let $old = $old.$field($($arg)?);1056 let _ = $new;1057 let _ = $old;1058 $check1059 } else {1060 $new.$field = $old.$field.clone()1061 }1062 )*1063 }};1064}10651066impl<T: Config> Pallet<T> {1067 /// Create new collection.1068 ///1069 /// * `owner` - The owner of the collection.1070 /// * `data` - Description of the created collection.1071 /// * `flags` - Extra flags to store.1072 pub fn init_collection(1073 owner: T::CrossAccountId,1074 payer: T::CrossAccountId,1075 data: CreateCollectionData<T::AccountId>,1076 flags: CollectionFlags,1077 ) -> Result<CollectionId, DispatchError> {1078 {1079 ensure!(1080 data.token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH as usize,1081 Error::<T>::CollectionTokenPrefixLimitExceeded1082 );1083 }10841085 let created_count = <CreatedCollectionCount<T>>::get()1086 .01087 .checked_add(1)1088 .ok_or(ArithmeticError::Overflow)?;1089 let destroyed_count = <DestroyedCollectionCount<T>>::get().0;1090 let id = CollectionId(created_count);10911092 // bound Total number of collections1093 ensure!(1094 created_count - destroyed_count <= COLLECTION_NUMBER_LIMIT,1095 <Error<T>>::TotalCollectionsLimitExceeded1096 );10971098 // =========10991100 let collection = Collection {1101 owner: owner.as_sub().clone(),1102 name: data.name,1103 mode: data.mode.clone(),1104 description: data.description,1105 token_prefix: data.token_prefix,1106 sponsorship: data1107 .pending_sponsor1108 .map(SponsorshipState::Unconfirmed)1109 .unwrap_or_default(),1110 limits: data1111 .limits1112 .map(|limits| Self::clamp_limits(data.mode.clone(), &Default::default(), limits))1113 .unwrap_or_else(|| Ok(CollectionLimits::default()))?,1114 permissions: data1115 .permissions1116 .map(|permissions| {1117 Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)1118 })1119 .unwrap_or_else(|| Ok(CollectionPermissions::default()))?,1120 flags,1121 };11221123 let mut collection_properties = up_data_structs::CollectionProperties::get();1124 collection_properties1125 .try_set_from_iter(data.properties.into_iter())1126 .map_err(<Error<T>>::from)?;11271128 CollectionProperties::<T>::insert(id, collection_properties);11291130 let mut token_props_permissions = PropertiesPermissionMap::new();1131 token_props_permissions1132 .try_set_from_iter(data.token_property_permissions.into_iter())1133 .map_err(<Error<T>>::from)?;11341135 CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);11361137 // Take a (non-refundable) deposit of collection creation1138 {1139 let mut imbalance =1140 <<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();1141 imbalance.subsume(1142 <<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(1143 &T::TreasuryAccountId::get(),1144 T::CollectionCreationPrice::get(),1145 ),1146 );1147 <T as Config>::Currency::settle(1148 payer.as_sub(),1149 imbalance,1150 WithdrawReasons::TRANSFER,1151 ExistenceRequirement::KeepAlive,1152 )1153 .map_err(|_| Error::<T>::NotSufficientFounds)?;1154 }11551156 <CreatedCollectionCount<T>>::put(created_count);1157 <Pallet<T>>::deposit_event(Event::CollectionCreated(1158 id,1159 data.mode.id(),1160 owner.as_sub().clone(),1161 ));1162 <PalletEvm<T>>::deposit_log(1163 erc::CollectionHelpersEvents::CollectionCreated {1164 owner: *owner.as_eth(),1165 collection_id: eth::collection_id_to_address(id),1166 }1167 .to_log(T::ContractAddress::get()),1168 );1169 <CollectionById<T>>::insert(id, collection);1170 Ok(id)1171 }11721173 /// Destroy collection.1174 ///1175 /// * `collection` - Collection handler.1176 /// * `sender` - The owner or administrator of the collection.1177 pub fn destroy_collection(1178 collection: CollectionHandle<T>,1179 sender: &T::CrossAccountId,1180 ) -> DispatchResult {1181 ensure!(1182 collection.limits.owner_can_destroy(),1183 <Error<T>>::NoPermission,1184 );1185 collection.check_is_owner(sender)?;11861187 let destroyed_collections = <DestroyedCollectionCount<T>>::get()1188 .01189 .checked_add(1)1190 .ok_or(ArithmeticError::Overflow)?;11911192 // =========11931194 <DestroyedCollectionCount<T>>::put(destroyed_collections);1195 <CollectionById<T>>::remove(collection.id);1196 <AdminAmount<T>>::remove(collection.id);1197 let _ = <IsAdmin<T>>::clear_prefix((collection.id,), u32::MAX, None);1198 let _ = <Allowlist<T>>::clear_prefix((collection.id,), u32::MAX, None);1199 <CollectionProperties<T>>::remove(collection.id);12001201 <Pallet<T>>::deposit_event(Event::CollectionDestroyed(collection.id));12021203 <PalletEvm<T>>::deposit_log(1204 erc::CollectionHelpersEvents::CollectionDestroyed {1205 collection_id: eth::collection_id_to_address(collection.id),1206 }1207 .to_log(T::ContractAddress::get()),1208 );1209 Ok(())1210 }12111212 /// This function sets or removes a collection properties according to1213 /// `properties_updates` contents:1214 /// * sets a property under the <key> with the value provided `(<key>, Some(<value>))`1215 /// * removes a property under the <key> if the value is `None` `(<key>, None)`.1216 ///1217 /// This function fires an event for each property change.1218 /// In case of an error, all the changes (including the events) will be reverted1219 /// since the function is transactional.1220 #[transactional]1221 fn modify_collection_properties(1222 collection: &CollectionHandle<T>,1223 sender: &T::CrossAccountId,1224 properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,1225 ) -> DispatchResult {1226 collection.check_is_owner_or_admin(sender)?;12271228 let mut stored_properties = <CollectionProperties<T>>::get(collection.id);12291230 for (key, value) in properties_updates {1231 match value {1232 Some(value) => {1233 stored_properties1234 .try_set(key.clone(), value)1235 .map_err(<Error<T>>::from)?;12361237 Self::deposit_event(Event::CollectionPropertySet(collection.id, key));1238 <PalletEvm<T>>::deposit_log(1239 erc::CollectionHelpersEvents::CollectionChanged {1240 collection_id: eth::collection_id_to_address(collection.id),1241 }1242 .to_log(T::ContractAddress::get()),1243 );1244 }1245 None => {1246 stored_properties.remove(&key).map_err(<Error<T>>::from)?;12471248 Self::deposit_event(Event::CollectionPropertyDeleted(collection.id, key));1249 <PalletEvm<T>>::deposit_log(1250 erc::CollectionHelpersEvents::CollectionChanged {1251 collection_id: eth::collection_id_to_address(collection.id),1252 }1253 .to_log(T::ContractAddress::get()),1254 );1255 }1256 }1257 }12581259 <CollectionProperties<T>>::set(collection.id, stored_properties);12601261 Ok(())1262 }12631264 /// Set collection property.1265 ///1266 /// * `collection` - Collection handler.1267 /// * `sender` - The owner or administrator of the collection.1268 /// * `property` - The property to set.1269 pub fn set_collection_property(1270 collection: &CollectionHandle<T>,1271 sender: &T::CrossAccountId,1272 property: Property,1273 ) -> DispatchResult {1274 Self::set_collection_properties(collection, sender, [property].into_iter())1275 }12761277 /// Set a scoped collection property, where the scope is a special prefix1278 /// prohibiting a user access to change the property directly.1279 ///1280 /// * `collection_id` - ID of the collection for which the property is being set.1281 /// * `scope` - Property scope.1282 /// * `property` - The property to set.1283 pub fn set_scoped_collection_property(1284 collection_id: CollectionId,1285 scope: PropertyScope,1286 property: Property,1287 ) -> DispatchResult {1288 CollectionProperties::<T>::try_mutate(collection_id, |properties| {1289 properties.try_scoped_set(scope, property.key, property.value)1290 })1291 .map_err(<Error<T>>::from)?;12921293 Ok(())1294 }12951296 /// Set scoped collection properties, where the scope is a special prefix1297 /// prohibiting a user access to change the properties directly.1298 ///1299 /// * `collection_id` - ID of the collection for which the properties is being set.1300 /// * `scope` - Property scope.1301 /// * `properties` - The properties to set.1302 pub fn set_scoped_collection_properties(1303 collection_id: CollectionId,1304 scope: PropertyScope,1305 properties: impl Iterator<Item = Property>,1306 ) -> DispatchResult {1307 CollectionProperties::<T>::try_mutate(collection_id, |stored_properties| {1308 stored_properties.try_scoped_set_from_iter(scope, properties)1309 })1310 .map_err(<Error<T>>::from)?;13111312 Ok(())1313 }13141315 /// Set collection properties.1316 ///1317 /// * `collection` - Collection handler.1318 /// * `sender` - The owner or administrator of the collection.1319 /// * `properties` - The properties to set.1320 pub fn set_collection_properties(1321 collection: &CollectionHandle<T>,1322 sender: &T::CrossAccountId,1323 properties: impl Iterator<Item = Property>,1324 ) -> DispatchResult {1325 Self::modify_collection_properties(1326 collection,1327 sender,1328 properties.map(|property| (property.key, Some(property.value))),1329 )1330 }13311332 /// Delete collection property.1333 ///1334 /// * `collection` - Collection handler.1335 /// * `sender` - The owner or administrator of the collection.1336 /// * `property` - The property to delete.1337 pub fn delete_collection_property(1338 collection: &CollectionHandle<T>,1339 sender: &T::CrossAccountId,1340 property_key: PropertyKey,1341 ) -> DispatchResult {1342 Self::delete_collection_properties(collection, sender, [property_key].into_iter())1343 }13441345 /// Delete collection properties.1346 ///1347 /// * `collection` - Collection handler.1348 /// * `sender` - The owner or administrator of the collection.1349 /// * `properties` - The properties to delete.1350 pub fn delete_collection_properties(1351 collection: &CollectionHandle<T>,1352 sender: &T::CrossAccountId,1353 property_keys: impl Iterator<Item = PropertyKey>,1354 ) -> DispatchResult {1355 Self::modify_collection_properties(collection, sender, property_keys.map(|key| (key, None)))1356 }13571358 /// Set collection propetry permission without any checks.1359 ///1360 /// Used for migrations.1361 ///1362 /// * `collection` - Collection handler.1363 /// * `property_permissions` - Property permissions.1364 pub fn set_property_permission_unchecked(1365 collection: CollectionId,1366 property_permission: PropertyKeyPermission,1367 ) -> DispatchResult {1368 <CollectionPropertyPermissions<T>>::try_mutate(collection, |permissions| {1369 permissions.try_set(property_permission.key, property_permission.permission)1370 })1371 .map_err(<Error<T>>::from)?;1372 Ok(())1373 }13741375 /// Set collection property permission.1376 ///1377 /// * `collection` - Collection handler.1378 /// * `sender` - The owner or administrator of the collection.1379 /// * `property_permission` - Property permission.1380 pub fn set_property_permission(1381 collection: &CollectionHandle<T>,1382 sender: &T::CrossAccountId,1383 property_permission: PropertyKeyPermission,1384 ) -> DispatchResult {1385 Self::set_scoped_property_permission(1386 collection,1387 sender,1388 PropertyScope::None,1389 property_permission,1390 )1391 }13921393 /// Set collection property permission with scope.1394 ///1395 /// * `collection` - Collection handler.1396 /// * `sender` - The owner or administrator of the collection.1397 /// * `scope` - Property scope.1398 /// * `property_permission` - Property permission.1399 pub fn set_scoped_property_permission(1400 collection: &CollectionHandle<T>,1401 sender: &T::CrossAccountId,1402 scope: PropertyScope,1403 property_permission: PropertyKeyPermission,1404 ) -> DispatchResult {1405 collection.check_is_owner_or_admin(sender)?;14061407 let all_permissions = CollectionPropertyPermissions::<T>::get(collection.id);1408 let current_permission = all_permissions.get(&property_permission.key);1409 if matches![1410 current_permission,1411 Some(PropertyPermission { mutable: false, .. })1412 ] {1413 return Err(<Error<T>>::NoPermission.into());1414 }14151416 CollectionPropertyPermissions::<T>::try_mutate(collection.id, |permissions| {1417 let property_permission = property_permission.clone();1418 permissions.try_scoped_set(1419 scope,1420 property_permission.key,1421 property_permission.permission,1422 )1423 })1424 .map_err(<Error<T>>::from)?;14251426 Self::deposit_event(Event::PropertyPermissionSet(1427 collection.id,1428 property_permission.key,1429 ));1430 <PalletEvm<T>>::deposit_log(1431 erc::CollectionHelpersEvents::CollectionChanged {1432 collection_id: eth::collection_id_to_address(collection.id),1433 }1434 .to_log(T::ContractAddress::get()),1435 );14361437 Ok(())1438 }14391440 /// Set token property permission.1441 ///1442 /// * `collection` - Collection handler.1443 /// * `sender` - The owner or administrator of the collection.1444 /// * `property_permissions` - Property permissions.1445 #[transactional]1446 pub fn set_token_property_permissions(1447 collection: &CollectionHandle<T>,1448 sender: &T::CrossAccountId,1449 property_permissions: Vec<PropertyKeyPermission>,1450 ) -> DispatchResult {1451 Self::set_scoped_token_property_permissions(1452 collection,1453 sender,1454 PropertyScope::None,1455 property_permissions,1456 )1457 }14581459 /// Set token property permission with scope.1460 ///1461 /// * `collection` - Collection handler.1462 /// * `sender` - The owner or administrator of the collection.1463 /// * `scope` - Property scope.1464 /// * `property_permissions` - Property permissions.1465 #[transactional]1466 pub fn set_scoped_token_property_permissions(1467 collection: &CollectionHandle<T>,1468 sender: &T::CrossAccountId,1469 scope: PropertyScope,1470 property_permissions: Vec<PropertyKeyPermission>,1471 ) -> DispatchResult {1472 for prop_pemission in property_permissions {1473 Self::set_scoped_property_permission(collection, sender, scope, prop_pemission)?;1474 }14751476 Ok(())1477 }14781479 /// Get collection property.1480 pub fn get_collection_property(1481 collection_id: CollectionId,1482 key: &PropertyKey,1483 ) -> Option<PropertyValue> {1484 Self::collection_properties(collection_id).get(key).cloned()1485 }14861487 /// Convert byte vector to property key vector.1488 pub fn bytes_keys_to_property_keys(1489 keys: Vec<Vec<u8>>,1490 ) -> Result<Vec<PropertyKey>, DispatchError> {1491 keys.into_iter()1492 .map(|key| -> Result<PropertyKey, DispatchError> {1493 key.try_into()1494 .map_err(|_| <Error<T>>::PropertyKeyIsTooLong.into())1495 })1496 .collect::<Result<Vec<PropertyKey>, DispatchError>>()1497 }14981499 /// Get properties according to given keys.1500 pub fn filter_collection_properties(1501 collection_id: CollectionId,1502 keys: Option<Vec<PropertyKey>>,1503 ) -> Result<Vec<Property>, DispatchError> {1504 let properties = Self::collection_properties(collection_id);15051506 let properties = keys1507 .map(|keys| {1508 keys.into_iter()1509 .filter_map(|key| {1510 properties.get(&key).map(|value| Property {1511 key,1512 value: value.clone(),1513 })1514 })1515 .collect()1516 })1517 .unwrap_or_else(|| {1518 properties1519 .into_iter()1520 .map(|(key, value)| Property { key, value })1521 .collect()1522 });15231524 Ok(properties)1525 }15261527 /// Get property permissions according to given keys.1528 pub fn filter_property_permissions(1529 collection_id: CollectionId,1530 keys: Option<Vec<PropertyKey>>,1531 ) -> Result<Vec<PropertyKeyPermission>, DispatchError> {1532 let permissions = Self::property_permissions(collection_id);15331534 let key_permissions = keys1535 .map(|keys| {1536 keys.into_iter()1537 .filter_map(|key| {1538 permissions1539 .get(&key)1540 .map(|permission| PropertyKeyPermission {1541 key,1542 permission: permission.clone(),1543 })1544 })1545 .collect()1546 })1547 .unwrap_or_else(|| {1548 permissions1549 .into_iter()1550 .map(|(key, permission)| PropertyKeyPermission { key, permission })1551 .collect()1552 });15531554 Ok(key_permissions)1555 }15561557 /// Toggle `user` participation in the `collection`'s allow list.1558 /// #### Store read/writes1559 /// 1 writes1560 pub fn toggle_allowlist(1561 collection: &CollectionHandle<T>,1562 sender: &T::CrossAccountId,1563 user: &T::CrossAccountId,1564 allowed: bool,1565 ) -> DispatchResult {1566 collection.check_is_owner_or_admin(sender)?;15671568 // =========15691570 if allowed {1571 <Allowlist<T>>::insert((collection.id, user), true);1572 Self::deposit_event(Event::<T>::AllowListAddressAdded(1573 collection.id,1574 user.clone(),1575 ));1576 } else {1577 <Allowlist<T>>::remove((collection.id, user));1578 Self::deposit_event(Event::<T>::AllowListAddressRemoved(1579 collection.id,1580 user.clone(),1581 ));1582 }15831584 <PalletEvm<T>>::deposit_log(1585 erc::CollectionHelpersEvents::CollectionChanged {1586 collection_id: eth::collection_id_to_address(collection.id),1587 }1588 .to_log(T::ContractAddress::get()),1589 );15901591 Ok(())1592 }15931594 /// Toggle `user` participation in the `collection`'s admin list.1595 /// #### Store read/writes1596 /// 2 reads, 2 writes1597 pub fn toggle_admin(1598 collection: &CollectionHandle<T>,1599 sender: &T::CrossAccountId,1600 user: &T::CrossAccountId,1601 admin: bool,1602 ) -> DispatchResult {1603 collection.check_is_internal()?;1604 collection.check_is_owner(sender)?;16051606 let is_admin = <IsAdmin<T>>::get((collection.id, user));1607 if is_admin == admin {1608 if admin {1609 return Ok(());1610 } else {1611 return Err(Error::<T>::UserIsNotCollectionAdmin.into());1612 }1613 }1614 let amount = <AdminAmount<T>>::get(collection.id);16151616 // =========16171618 if admin {1619 let amount = amount1620 .checked_add(1)1621 .ok_or(<Error<T>>::CollectionAdminCountExceeded)?;1622 ensure!(1623 amount <= Self::collection_admins_limit(),1624 <Error<T>>::CollectionAdminCountExceeded,1625 );16261627 <AdminAmount<T>>::insert(collection.id, amount);1628 <IsAdmin<T>>::insert((collection.id, user), true);16291630 Self::deposit_event(Event::<T>::CollectionAdminAdded(1631 collection.id,1632 user.clone(),1633 ));1634 } else {1635 <AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));1636 <IsAdmin<T>>::remove((collection.id, user));16371638 Self::deposit_event(Event::<T>::CollectionAdminRemoved(1639 collection.id,1640 user.clone(),1641 ));1642 }16431644 <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 Ok(())1652 }16531654 /// Update collection limits.1655 pub fn update_limits(1656 user: &T::CrossAccountId,1657 collection: &mut CollectionHandle<T>,1658 new_limit: CollectionLimits,1659 ) -> DispatchResult {1660 collection.check_is_internal()?;1661 collection.check_is_owner_or_admin(user)?;16621663 collection.limits =1664 Self::clamp_limits(collection.mode.clone(), &collection.limits, new_limit)?;16651666 Self::deposit_event(Event::<T>::CollectionLimitSet(collection.id));1667 <PalletEvm<T>>::deposit_log(1668 erc::CollectionHelpersEvents::CollectionChanged {1669 collection_id: eth::collection_id_to_address(collection.id),1670 }1671 .to_log(T::ContractAddress::get()),1672 );16731674 collection.save()1675 }16761677 /// Merge set fields from `new_limit` to `old_limit`.1678 fn clamp_limits(1679 mode: CollectionMode,1680 old_limit: &CollectionLimits,1681 mut new_limit: CollectionLimits,1682 ) -> Result<CollectionLimits, DispatchError> {1683 let limits = old_limit;1684 limit_default!(old_limit, new_limit,1685 account_token_ownership_limit => ensure!(1686 new_limit <= MAX_TOKEN_OWNERSHIP,1687 <Error<T>>::CollectionLimitBoundsExceeded,1688 ),1689 sponsored_data_size => ensure!(1690 new_limit <= CUSTOM_DATA_LIMIT,1691 <Error<T>>::CollectionLimitBoundsExceeded,1692 ),16931694 sponsored_data_rate_limit => {},1695 token_limit => ensure!(1696 old_limit >= new_limit && new_limit > 0,1697 <Error<T>>::CollectionTokenLimitExceeded1698 ),16991700 sponsor_transfer_timeout(match mode {1701 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,1702 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1703 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1704 }) => ensure!(1705 new_limit <= MAX_SPONSOR_TIMEOUT,1706 <Error<T>>::CollectionLimitBoundsExceeded,1707 ),1708 sponsor_approve_timeout => {},1709 owner_can_transfer => ensure!(1710 !limits.owner_can_transfer_instaled() ||1711 old_limit || !new_limit,1712 <Error<T>>::OwnerPermissionsCantBeReverted,1713 ),1714 owner_can_destroy => ensure!(1715 old_limit || !new_limit,1716 <Error<T>>::OwnerPermissionsCantBeReverted,1717 ),1718 transfers_enabled => {},1719 );1720 Ok(new_limit)1721 }17221723 /// Update collection permissions.1724 pub fn update_permissions(1725 user: &T::CrossAccountId,1726 collection: &mut CollectionHandle<T>,1727 new_permission: CollectionPermissions,1728 ) -> DispatchResult {1729 collection.check_is_internal()?;1730 collection.check_is_owner_or_admin(user)?;1731 collection.permissions = Self::clamp_permissions(1732 collection.mode.clone(),1733 &collection.permissions,1734 new_permission,1735 )?;17361737 Self::deposit_event(Event::<T>::CollectionPermissionSet(collection.id));1738 <PalletEvm<T>>::deposit_log(1739 erc::CollectionHelpersEvents::CollectionChanged {1740 collection_id: eth::collection_id_to_address(collection.id),1741 }1742 .to_log(T::ContractAddress::get()),1743 );17441745 collection.save()1746 }17471748 /// Merge set fields from `new_permission` to `old_permission`.1749 fn clamp_permissions(1750 _mode: CollectionMode,1751 old_permission: &CollectionPermissions,1752 mut new_permission: CollectionPermissions,1753 ) -> Result<CollectionPermissions, DispatchError> {1754 limit_default_clone!(old_permission, new_permission,1755 access => {},1756 mint_mode => {},1757 nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },1758 );1759 Ok(new_permission)1760 }17611762 /// Repair possibly broken properties of a collection.1763 pub fn repair_collection(collection_id: CollectionId) -> DispatchResult {1764 CollectionProperties::<T>::mutate(collection_id, |properties| {1765 properties.recompute_consumed_space();1766 });17671768 Ok(())1769 }1770}17711772/// Indicates unsupported methods by returning [Error::UnsupportedOperation].1773#[macro_export]1774macro_rules! unsupported {1775 ($runtime:path) => {1776 Err($crate::Error::<$runtime>::UnsupportedOperation.into())1777 };1778}17791780/// Return weights for various worst-case operations.1781pub trait CommonWeightInfo<CrossAccountId> {1782 /// Weight of item creation.1783 fn create_item() -> Weight;17841785 /// Weight of items creation.1786 fn create_multiple_items(amount: &[CreateItemData]) -> Weight;17871788 /// Weight of items creation.1789 fn create_multiple_items_ex(cost: &CreateItemExData<CrossAccountId>) -> Weight;17901791 /// The weight of the burning item.1792 fn burn_item() -> Weight;17931794 /// Property setting weight.1795 ///1796 /// * `amount`- The number of properties to set.1797 fn set_collection_properties(amount: u32) -> Weight;17981799 /// Collection property deletion weight.1800 ///1801 /// * `amount`- The number of properties to set.1802 fn delete_collection_properties(amount: u32) -> Weight;18031804 /// Token property setting weight.1805 ///1806 /// * `amount`- The number of properties to set.1807 fn set_token_properties(amount: u32) -> Weight;18081809 /// Token property deletion weight.1810 ///1811 /// * `amount`- The number of properties to delete.1812 fn delete_token_properties(amount: u32) -> Weight;18131814 /// Token property permissions set weight.1815 ///1816 /// * `amount`- The number of property permissions to set.1817 fn set_token_property_permissions(amount: u32) -> Weight;18181819 /// Transfer price of the token or its parts.1820 fn transfer() -> Weight;18211822 /// The price of setting the permission of the operation from another user.1823 fn approve() -> Weight;18241825 /// The price of setting the permission of the operation from another user for eth mirror.1826 fn approve_from() -> Weight;18271828 /// Transfer price from another user.1829 fn transfer_from() -> Weight;18301831 /// The price of burning a token from another user.1832 fn burn_from() -> Weight;18331834 /// Differs from burn_item in case of Fungible and Refungible, as it should burn1835 /// whole users's balance.1836 ///1837 /// This method shouldn't be used directly, as it doesn't count breadth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1838 fn burn_recursively_self_raw() -> Weight;18391840 /// Cost of iterating over `amount` children while burning, without counting child burning itself.1841 ///1842 /// This method shouldn't be used directly, as it doesn't count depth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1843 fn burn_recursively_breadth_raw(amount: u32) -> Weight;18441845 /// The price of recursive burning a token.1846 ///1847 /// `max_selfs` - The maximum burning weight of the token itself.1848 /// `max_breadth` - The maximum number of nested tokens to burn.1849 fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {1850 Self::burn_recursively_self_raw()1851 .saturating_mul(max_selfs.max(1) as u64)1852 .saturating_add(Self::burn_recursively_breadth_raw(max_breadth))1853 }18541855 /// The price of retrieving token owner1856 fn token_owner() -> Weight;18571858 /// The price of setting approval for all1859 fn set_allowance_for_all() -> Weight;18601861 /// The price of repairing an item.1862 fn force_repair_item() -> Weight;1863}18641865/// Weight info extension trait for refungible pallet.1866pub trait RefungibleExtensionsWeightInfo {1867 /// Weight of token repartition.1868 fn repartition() -> Weight;1869}18701871/// Common collection operations.1872///1873/// It wraps methods in Fungible, Nonfungible and Refungible pallets1874/// and adds weight info.1875pub trait CommonCollectionOperations<T: Config> {1876 /// Create token.1877 ///1878 /// * `sender` - The user who mint the token and pays for the transaction.1879 /// * `to` - The user who will own the token.1880 /// * `data` - Token data.1881 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1882 fn create_item(1883 &self,1884 sender: T::CrossAccountId,1885 to: T::CrossAccountId,1886 data: CreateItemData,1887 nesting_budget: &dyn Budget,1888 ) -> DispatchResultWithPostInfo;18891890 /// Create multiple tokens.1891 ///1892 /// * `sender` - The user who mint the token and pays for the transaction.1893 /// * `to` - The user who will own the token.1894 /// * `data` - Token data.1895 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1896 fn create_multiple_items(1897 &self,1898 sender: T::CrossAccountId,1899 to: T::CrossAccountId,1900 data: Vec<CreateItemData>,1901 nesting_budget: &dyn Budget,1902 ) -> DispatchResultWithPostInfo;19031904 /// Create multiple tokens.1905 ///1906 /// * `sender` - The user who mint the token and pays for the transaction.1907 /// * `to` - The user who will own the token.1908 /// * `data` - Token data.1909 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1910 fn create_multiple_items_ex(1911 &self,1912 sender: T::CrossAccountId,1913 data: CreateItemExData<T::CrossAccountId>,1914 nesting_budget: &dyn Budget,1915 ) -> DispatchResultWithPostInfo;19161917 /// Burn token.1918 ///1919 /// * `sender` - The user who owns the token.1920 /// * `token` - Token id that will burned.1921 /// * `amount` - The number of parts of the token that will be burned.1922 fn burn_item(1923 &self,1924 sender: T::CrossAccountId,1925 token: TokenId,1926 amount: u128,1927 ) -> DispatchResultWithPostInfo;19281929 /// Burn token and all nested tokens recursievly.1930 ///1931 /// * `sender` - The user who owns the token.1932 /// * `token` - Token id that will burned.1933 /// * `self_budget` - The budget that can be spent on burning tokens.1934 /// * `breadth_budget` - The budget that can be spent on burning nested tokens.1935 fn burn_item_recursively(1936 &self,1937 sender: T::CrossAccountId,1938 token: TokenId,1939 self_budget: &dyn Budget,1940 breadth_budget: &dyn Budget,1941 ) -> DispatchResultWithPostInfo;19421943 /// Set collection properties.1944 ///1945 /// * `sender` - Must be either the owner of the collection or its admin.1946 /// * `properties` - Properties to be set.1947 fn set_collection_properties(1948 &self,1949 sender: T::CrossAccountId,1950 properties: Vec<Property>,1951 ) -> DispatchResultWithPostInfo;19521953 /// Delete collection properties.1954 ///1955 /// * `sender` - Must be either the owner of the collection or its admin.1956 /// * `properties` - The properties to be removed.1957 fn delete_collection_properties(1958 &self,1959 sender: &T::CrossAccountId,1960 property_keys: Vec<PropertyKey>,1961 ) -> DispatchResultWithPostInfo;19621963 /// Set token properties.1964 ///1965 /// The appropriate [`PropertyPermission`] for the token property1966 /// must be set with [`Self::set_token_property_permissions`].1967 ///1968 /// * `sender` - Must be either the owner of the token or its admin.1969 /// * `token_id` - The token for which the properties are being set.1970 /// * `properties` - Properties to be set.1971 /// * `budget` - Budget for setting properties.1972 fn set_token_properties(1973 &self,1974 sender: T::CrossAccountId,1975 token_id: TokenId,1976 properties: Vec<Property>,1977 budget: &dyn Budget,1978 ) -> DispatchResultWithPostInfo;19791980 /// Remove token properties.1981 ///1982 /// The appropriate [`PropertyPermission`] for the token property1983 /// must be set with [`Self::set_token_property_permissions`].1984 ///1985 /// * `sender` - Must be either the owner of the token or its admin.1986 /// * `token_id` - The token for which the properties are being remove.1987 /// * `property_keys` - Keys to remove corresponding properties.1988 /// * `budget` - Budget for removing properties.1989 fn delete_token_properties(1990 &self,1991 sender: T::CrossAccountId,1992 token_id: TokenId,1993 property_keys: Vec<PropertyKey>,1994 budget: &dyn Budget,1995 ) -> DispatchResultWithPostInfo;19961997 /// Set token property permissions.1998 ///1999 /// * `sender` - Must be either the owner of the token or its admin.2000 /// * `token_id` - The token for which the properties are being set.2001 /// * `property_permissions` - Property permissions to be set.2002 /// * `budget` - Budget for setting properties.2003 fn set_token_property_permissions(2004 &self,2005 sender: &T::CrossAccountId,2006 property_permissions: Vec<PropertyKeyPermission>,2007 ) -> DispatchResultWithPostInfo;20082009 /// Transfer amount of token pieces.2010 ///2011 /// * `sender` - Donor user.2012 /// * `to` - Recepient user.2013 /// * `token` - The token of which parts are being sent.2014 /// * `amount` - The number of parts of the token that will be transferred.2015 /// * `budget` - The maximum budget that can be spent on the transfer.2016 fn transfer(2017 &self,2018 sender: T::CrossAccountId,2019 to: T::CrossAccountId,2020 token: TokenId,2021 amount: u128,2022 budget: &dyn Budget,2023 ) -> DispatchResultWithPostInfo;20242025 /// Grant access to another account to transfer parts of the token owned by the calling user via [Self::transfer_from].2026 ///2027 /// * `sender` - The user who grants access to the token.2028 /// * `spender` - The user to whom the rights are granted.2029 /// * `token` - The token to which access is granted.2030 /// * `amount` - The amount of pieces that another user can dispose of.2031 fn approve(2032 &self,2033 sender: T::CrossAccountId,2034 spender: T::CrossAccountId,2035 token: TokenId,2036 amount: u128,2037 ) -> DispatchResultWithPostInfo;20382039 /// Grant access to another account to transfer parts of the token owned by the calling user's eth mirror via [Self::transfer_from].2040 ///2041 /// * `sender` - The user who grants access to the token.2042 /// * `from` - Spender's eth mirror.2043 /// * `to` - The user to whom the rights are granted.2044 /// * `token` - The token to which access is granted.2045 /// * `amount` - The amount of pieces that another user can dispose of.2046 fn approve_from(2047 &self,2048 sender: T::CrossAccountId,2049 from: T::CrossAccountId,2050 to: T::CrossAccountId,2051 token: TokenId,2052 amount: u128,2053 ) -> DispatchResultWithPostInfo;20542055 /// Send parts of a token owned by another user.2056 ///2057 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2058 ///2059 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2060 /// * `from` - The user who owns the token.2061 /// * `to` - Recepient user.2062 /// * `token` - The token of which parts are being sent.2063 /// * `amount` - The number of parts of the token that will be transferred.2064 /// * `budget` - The maximum budget that can be spent on the transfer.2065 fn transfer_from(2066 &self,2067 sender: T::CrossAccountId,2068 from: T::CrossAccountId,2069 to: T::CrossAccountId,2070 token: TokenId,2071 amount: u128,2072 budget: &dyn Budget,2073 ) -> DispatchResultWithPostInfo;20742075 /// Burn parts of a token owned by another user.2076 ///2077 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2078 ///2079 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2080 /// * `from` - The user who owns the token.2081 /// * `token` - The token of which parts are being sent.2082 /// * `amount` - The number of parts of the token that will be transferred.2083 /// * `budget` - The maximum budget that can be spent on the burn.2084 fn burn_from(2085 &self,2086 sender: T::CrossAccountId,2087 from: T::CrossAccountId,2088 token: TokenId,2089 amount: u128,2090 budget: &dyn Budget,2091 ) -> DispatchResultWithPostInfo;20922093 /// Check permission to nest token.2094 ///2095 /// * `sender` - The user who initiated the check.2096 /// * `from` - The token that is checked for embedding.2097 /// * `under` - Token under which to check.2098 /// * `budget` - The maximum budget that can be spent on the check.2099 fn check_nesting(2100 &self,2101 sender: T::CrossAccountId,2102 from: (CollectionId, TokenId),2103 under: TokenId,2104 budget: &dyn Budget,2105 ) -> DispatchResult;21062107 /// Nest one token into another.2108 ///2109 /// * `under` - Token holder.2110 /// * `to_nest` - Nested token.2111 fn nest(&self, under: TokenId, to_nest: (CollectionId, TokenId));21122113 /// Unnest token.2114 ///2115 /// * `under` - Token holder.2116 /// * `to_nest` - Token to unnest.2117 fn unnest(&self, under: TokenId, to_nest: (CollectionId, TokenId));21182119 /// Get all user tokens.2120 ///2121 /// * `account` - Account for which you need to get tokens.2122 fn account_tokens(&self, account: T::CrossAccountId) -> Vec<TokenId>;21232124 /// Get all the tokens in the collection.2125 fn collection_tokens(&self) -> Vec<TokenId>;21262127 /// Check if the token exists.2128 ///2129 /// * `token` - Id token to check.2130 fn token_exists(&self, token: TokenId) -> bool;21312132 /// Get the id of the last minted token.2133 fn last_token_id(&self) -> TokenId;21342135 /// Get the owner of the token.2136 ///2137 /// * `token` - The token for which you need to find out the owner.2138 fn token_owner(&self, token: TokenId) -> Result<T::CrossAccountId, TokenOwnerError>;21392140 /// Returns 10 tokens owners in no particular order.2141 ///2142 /// * `token` - The token for which you need to find out the owners.2143 fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId>;21442145 /// Get the value of the token property by key.2146 ///2147 /// * `token` - Token with the property to get.2148 /// * `key` - Property name.2149 fn token_property(&self, token_id: TokenId, key: &PropertyKey) -> Option<PropertyValue>;21502151 /// Get a set of token properties by key vector.2152 ///2153 /// * `token` - Token with the property to get.2154 /// * `keys` - Vector of property keys. If this parameter is [None](sp_std::result::Result),2155 /// then all properties are returned.2156 fn token_properties(&self, token: TokenId, keys: Option<Vec<PropertyKey>>) -> Vec<Property>;21572158 /// Amount of unique collection tokens2159 fn total_supply(&self) -> u32;21602161 /// Amount of different tokens account has.2162 ///2163 /// * `account` - The account for which need to get the balance.2164 fn account_balance(&self, account: T::CrossAccountId) -> u32;21652166 /// Amount of specific token account have.2167 fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;21682169 /// Amount of token pieces2170 fn total_pieces(&self, token: TokenId) -> Option<u128>;21712172 /// Get the number of parts of the token that a trusted user can manage.2173 ///2174 /// * `sender` - Trusted user.2175 /// * `spender` - Owner of the token.2176 /// * `token` - The token for which to get the value.2177 fn allowance(2178 &self,2179 sender: T::CrossAccountId,2180 spender: T::CrossAccountId,2181 token: TokenId,2182 ) -> u128;21832184 /// Get extension for RFT collection.2185 fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>>;21862187 /// The `operator` is allowed to transfer all tokens of the `owner` on their behalf.2188 /// * `owner` - Token owner2189 /// * `operator` - Operator2190 /// * `approve` - Should operator status be granted or revoked?2191 fn set_allowance_for_all(2192 &self,2193 owner: T::CrossAccountId,2194 operator: T::CrossAccountId,2195 approve: bool,2196 ) -> DispatchResultWithPostInfo;21972198 /// Tells whether the given `owner` approves the `operator`.2199 fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool;22002201 /// Repairs a possibly broken item.2202 fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo;2203}22042205/// Extension for RFT collection.2206pub trait RefungibleExtensions<T>2207where2208 T: Config,2209{2210 /// Change the number of parts of the token.2211 ///2212 /// When the value changes down, this function is equivalent to burning parts of the token.2213 ///2214 /// * `sender` - The user calling the repartition operation. Must be the owner of the token.2215 /// * `token` - The token for which you want to change the number of parts.2216 /// * `amount` - The new value of the parts of the token.2217 fn repartition(2218 &self,2219 sender: &T::CrossAccountId,2220 token: TokenId,2221 amount: u128,2222 ) -> DispatchResultWithPostInfo;2223}22242225/// Merge [`DispatchResult`] with [`Weight`] into [`DispatchResultWithPostInfo`].2226///2227/// Used for [`CommonCollectionOperations`] implementations and flexible enough to do so.2228pub fn with_weight(res: DispatchResult, weight: Weight) -> DispatchResultWithPostInfo {2229 let post_info = PostDispatchInfo {2230 actual_weight: Some(weight),2231 pays_fee: Pays::Yes,2232 };2233 match res {2234 Ok(()) => Ok(post_info),2235 Err(error) => Err(DispatchErrorWithPostInfo { post_info, error }),2236 }2237}22382239impl<T: Config> From<PropertiesError> for Error<T> {2240 fn from(error: PropertiesError) -> Self {2241 match error {2242 PropertiesError::NoSpaceForProperty => Self::NoSpaceForProperty,2243 PropertiesError::PropertyLimitReached => Self::PropertyLimitReached,2244 PropertiesError::InvalidCharacterInPropertyKey => Self::InvalidCharacterInPropertyKey,2245 PropertiesError::PropertyKeyIsTooLong => Self::PropertyKeyIsTooLong,2246 PropertiesError::EmptyPropertyKey => Self::EmptyPropertyKey,2247 }2248 }2249}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::{57 ops::{Deref, DerefMut},58 slice::from_ref,59};60use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};61use sp_std::vec::Vec;62use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};63use evm_coder::ToLog;64use frame_support::{65 dispatch::{DispatchErrorWithPostInfo, DispatchResultWithPostInfo, Weight, PostDispatchInfo},66 ensure,67 traits::{Imbalance, Get, Currency, WithdrawReasons, ExistenceRequirement},68 dispatch::Pays,69 transactional,70};71use pallet_evm::GasWeightMapping;72use up_data_structs::{73 COLLECTION_NUMBER_LIMIT,74 Collection,75 RpcCollection,76 CollectionFlags,77 RpcCollectionFlags,78 CollectionId,79 CreateItemData,80 MAX_TOKEN_PREFIX_LENGTH,81 COLLECTION_ADMINS_LIMIT,82 TokenId,83 TokenChild,84 CollectionStats,85 MAX_TOKEN_OWNERSHIP,86 CollectionMode,87 NFT_SPONSOR_TRANSFER_TIMEOUT,88 FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,89 REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,90 MAX_SPONSOR_TIMEOUT,91 CUSTOM_DATA_LIMIT,92 CollectionLimits,93 CreateCollectionData,94 SponsorshipState,95 CreateItemExData,96 SponsoringRateLimit,97 budget::Budget,98 PhantomType,99 Property,100 Properties,101 PropertiesPermissionMap,102 PropertyKey,103 PropertyValue,104 PropertyPermission,105 PropertiesError,106 TokenOwnerError,107 PropertyKeyPermission,108 TokenData,109 TrySetProperty,110 PropertyScope,111 // RMRK112 RmrkCollectionInfo,113 RmrkInstanceInfo,114 RmrkResourceInfo,115 RmrkPropertyInfo,116 RmrkBaseInfo,117 RmrkPartType,118 RmrkBoundedTheme,119 RmrkNftChild,120 CollectionPermissions,121};122use up_pov_estimate_rpc::PovInfo;123124pub use pallet::*;125use sp_core::H160;126use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};127#[cfg(feature = "runtime-benchmarks")]128pub mod benchmarking;129pub mod dispatch;130pub mod erc;131pub mod eth;132pub mod weights;133134/// Weight info.135pub type SelfWeightOf<T> = <T as Config>::WeightInfo;136137/// Collection handle contains information about collection data and id.138/// Also provides functionality to count consumed gas.139///140/// CollectionHandle is used as a generic wrapper for collections of all types.141/// It allows to perform common operations and queries on any collection type,142/// both completely general for all, as well as their respective implementations of [`CommonCollectionOperations`].143#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]144pub struct CollectionHandle<T: Config> {145 /// Collection id146 pub id: CollectionId,147 collection: Collection<T::AccountId>,148 /// Substrate recorder for counting consumed gas149 pub recorder: SubstrateRecorder<T>,150}151152impl<T: Config> WithRecorder<T> for CollectionHandle<T> {153 fn recorder(&self) -> &SubstrateRecorder<T> {154 &self.recorder155 }156 fn into_recorder(self) -> SubstrateRecorder<T> {157 self.recorder158 }159}160161impl<T: Config> CollectionHandle<T> {162 /// Same as [CollectionHandle::new] but with an explicit gas limit.163 pub fn new_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {164 <CollectionById<T>>::get(id).map(|collection| Self {165 id,166 collection,167 recorder: SubstrateRecorder::new(gas_limit),168 })169 }170171 /// Same as [CollectionHandle::new] but with an existed [`SubstrateRecorder`].172 pub fn new_with_recorder(id: CollectionId, recorder: SubstrateRecorder<T>) -> Option<Self> {173 <CollectionById<T>>::get(id).map(|collection| Self {174 id,175 collection,176 recorder,177 })178 }179180 /// Retrives collection data from storage and creates collection handle with default parameters.181 /// If collection not found return `None`182 pub fn new(id: CollectionId) -> Option<Self> {183 Self::new_with_gas_limit(id, u64::MAX)184 }185186 /// Same as [`CollectionHandle::new`] but if collection not found [CollectionNotFound](Error::CollectionNotFound) returned.187 pub fn try_get(id: CollectionId) -> Result<Self, DispatchError> {188 Ok(Self::new(id).ok_or(<Error<T>>::CollectionNotFound)?)189 }190191 /// Consume gas for reading.192 pub fn consume_store_reads(&self, reads: u64) -> evm_coder::execution::Result<()> {193 self.recorder194 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(195 <T as frame_system::Config>::DbWeight::get()196 .read197 .saturating_mul(reads),198 )))199 }200201 /// Consume gas for writing.202 pub fn consume_store_writes(&self, writes: u64) -> evm_coder::execution::Result<()> {203 self.recorder204 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(205 <T as frame_system::Config>::DbWeight::get()206 .write207 .saturating_mul(writes),208 )))209 }210211 /// Consume gas for reading and writing.212 pub fn consume_store_reads_and_writes(213 &self,214 reads: u64,215 writes: u64,216 ) -> evm_coder::execution::Result<()> {217 let weight = <T as frame_system::Config>::DbWeight::get();218 let reads = weight.read.saturating_mul(reads);219 let writes = weight.read.saturating_mul(writes);220 self.recorder221 .consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(222 reads.saturating_add(writes),223 )))224 }225226 /// Save collection to storage.227 pub fn save(&self) -> DispatchResult {228 <CollectionById<T>>::insert(self.id, &self.collection);229 Ok(())230 }231232 /// Set collection sponsor.233 ///234 /// Unique collections allows sponsoring for certain actions.235 /// This method allows you to set the sponsor of the collection.236 /// In order for sponsorship to become active, it must be confirmed through [`Self::confirm_sponsorship`].237 pub fn set_sponsor(238 &mut self,239 sender: &T::CrossAccountId,240 sponsor: T::AccountId,241 ) -> DispatchResult {242 self.check_is_internal()?;243 self.check_is_owner_or_admin(sender)?;244245 self.collection.sponsorship = SponsorshipState::Unconfirmed(sponsor.clone());246247 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor));248 <PalletEvm<T>>::deposit_log(249 erc::CollectionHelpersEvents::CollectionChanged {250 collection_id: eth::collection_id_to_address(self.id),251 }252 .to_log(T::ContractAddress::get()),253 );254255 self.save()256 }257258 /// Force set `sponsor`.259 ///260 /// Differs from [`set_sponsor`][`Self::set_sponsor`] in that confirmation261 /// from the `sponsor` is not required.262 ///263 /// # Arguments264 ///265 /// * `sender`: Caller's account.266 /// * `sponsor`: ID of the account of the sponsor-to-be.267 pub fn force_set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {268 self.check_is_internal()?;269270 self.collection.sponsorship = SponsorshipState::Confirmed(sponsor.clone());271272 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(self.id, sponsor.clone()));273 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sponsor));274 <PalletEvm<T>>::deposit_log(275 erc::CollectionHelpersEvents::CollectionChanged {276 collection_id: eth::collection_id_to_address(self.id),277 }278 .to_log(T::ContractAddress::get()),279 );280281 self.save()282 }283284 /// Confirm sponsorship285 ///286 /// In order for the sponsorship to become active, the user set as the sponsor must confirm their participation.287 /// Before confirming sponsorship, the user must be specified as the sponsor of the collection via [`Self::set_sponsor`].288 pub fn confirm_sponsorship(&mut self, sender: &T::AccountId) -> DispatchResult {289 self.check_is_internal()?;290 ensure!(291 self.collection.sponsorship.pending_sponsor() == Some(sender),292 Error::<T>::ConfirmSponsorshipFail293 );294295 self.collection.sponsorship = SponsorshipState::Confirmed(sender.clone());296297 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(self.id, sender.clone()));298 <PalletEvm<T>>::deposit_log(299 erc::CollectionHelpersEvents::CollectionChanged {300 collection_id: eth::collection_id_to_address(self.id),301 }302 .to_log(T::ContractAddress::get()),303 );304305 self.save()306 }307308 /// Remove collection sponsor.309 pub fn remove_sponsor(&mut self, sender: &T::CrossAccountId) -> DispatchResult {310 self.check_is_internal()?;311 self.check_is_owner_or_admin(sender)?;312313 self.collection.sponsorship = SponsorshipState::Disabled;314315 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));316 <PalletEvm<T>>::deposit_log(317 erc::CollectionHelpersEvents::CollectionChanged {318 collection_id: eth::collection_id_to_address(self.id),319 }320 .to_log(T::ContractAddress::get()),321 );322 self.save()323 }324325 /// Force remove `sponsor`.326 ///327 /// Differs from `remove_sponsor` in that328 /// it doesn't require consent from the `owner` of the collection.329 pub fn force_remove_sponsor(&mut self) -> DispatchResult {330 self.check_is_internal()?;331332 self.collection.sponsorship = SponsorshipState::Disabled;333334 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(self.id));335 <PalletEvm<T>>::deposit_log(336 erc::CollectionHelpersEvents::CollectionChanged {337 collection_id: eth::collection_id_to_address(self.id),338 }339 .to_log(T::ContractAddress::get()),340 );341 self.save()342 }343344 /// Checks that the collection was created with, and must be operated upon through **Unique API**.345 /// Now check only the `external` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.346 pub fn check_is_internal(&self) -> DispatchResult {347 if self.flags.external {348 return Err(<Error<T>>::CollectionIsExternal)?;349 }350351 Ok(())352 }353354 /// Checks that the collection was created with, and must be operated upon through an **assimilated API**.355 /// Now check only the `external` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.356 pub fn check_is_external(&self) -> DispatchResult {357 if !self.flags.external {358 return Err(<Error<T>>::CollectionIsInternal)?;359 }360361 Ok(())362 }363}364365impl<T: Config> Deref for CollectionHandle<T> {366 type Target = Collection<T::AccountId>;367368 fn deref(&self) -> &Self::Target {369 &self.collection370 }371}372373impl<T: Config> DerefMut for CollectionHandle<T> {374 fn deref_mut(&mut self) -> &mut Self::Target {375 &mut self.collection376 }377}378379impl<T: Config> CollectionHandle<T> {380 /// Checks if the `user` is the owner of the collection.381 pub fn check_is_owner(&self, user: &T::CrossAccountId) -> DispatchResult {382 ensure!(*user.as_sub() == self.owner, <Error<T>>::NoPermission);383 Ok(())384 }385386 /// Returns **true** if the `user` is the owner or administrator of the collection.387 pub fn is_owner_or_admin(&self, user: &T::CrossAccountId) -> bool {388 *user.as_sub() == self.owner || <IsAdmin<T>>::get((self.id, user))389 }390391 /// Checks if the `user` is the owner or administrator of the collection.392 pub fn check_is_owner_or_admin(&self, user: &T::CrossAccountId) -> DispatchResult {393 ensure!(self.is_owner_or_admin(user), <Error<T>>::NoPermission);394 Ok(())395 }396397 /// Returns **true** if398 /// * the `user`is a collection owner or admin399 /// * the collection limits allow the owner/admins to transfer/burn any collection token400 pub fn ignores_token_restrictions(&self, user: &T::CrossAccountId) -> bool {401 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)402 }403404 /// Return **true** if `user` does not have enough token parts, and he can ignore such restrictions.405 pub fn ignores_owned_amount(&self, user: &T::CrossAccountId) -> bool {406 self.limits.owner_can_transfer() && self.is_owner_or_admin(user)407 }408409 /// Checks if the user is in the allow list. If not [Error::AddressNotInAllowlist] returns.410 pub fn check_allowlist(&self, user: &T::CrossAccountId) -> DispatchResult {411 ensure!(412 <Allowlist<T>>::get((self.id, user)),413 <Error<T>>::AddressNotInAllowlist414 );415 Ok(())416 }417418 /// Changes collection owner to another account419 /// #### Store read/writes420 /// 1 writes421 pub fn change_owner(422 &mut self,423 caller: T::CrossAccountId,424 new_owner: T::CrossAccountId,425 ) -> DispatchResult {426 self.check_is_internal()?;427 self.check_is_owner(&caller)?;428 self.collection.owner = new_owner.as_sub().clone();429430 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnerChanged(431 self.id,432 new_owner.as_sub().clone(),433 ));434 <PalletEvm<T>>::deposit_log(435 erc::CollectionHelpersEvents::CollectionChanged {436 collection_id: eth::collection_id_to_address(self.id),437 }438 .to_log(T::ContractAddress::get()),439 );440441 self.save()442 }443}444445#[frame_support::pallet]446pub mod pallet {447 use super::*;448 use dispatch::CollectionDispatch;449 use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};450 use frame_system::pallet_prelude::*;451 use frame_support::traits::Currency;452 use up_data_structs::{TokenId, mapping::TokenAddressMapping};453 use scale_info::TypeInfo;454 use weights::WeightInfo;455456 #[pallet::config]457 pub trait Config:458 frame_system::Config + pallet_evm_coder_substrate::Config + pallet_evm::Config + TypeInfo459 {460 /// Weight information for functions of this pallet.461 type WeightInfo: WeightInfo;462463 /// Events compatible with [`frame_system::Config::Event`].464 type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;465466 /// Handler of accounts and payment.467 type Currency: Currency<Self::AccountId>;468469 /// Set price to create a collection.470 #[pallet::constant]471 type CollectionCreationPrice: Get<472 <<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,473 >;474475 /// Dispatcher of operations on collections.476 type CollectionDispatch: CollectionDispatch<Self>;477478 /// Account which holds the chain's treasury.479 type TreasuryAccountId: Get<Self::AccountId>;480481 /// Address under which the CollectionHelper contract would be available.482 #[pallet::constant]483 type ContractAddress: Get<H160>;484485 /// Mapper for token addresses to Ethereum addresses.486 type EvmTokenAddressMapping: TokenAddressMapping<H160>;487488 /// Mapper for token addresses to [`CrossAccountId`].489 type CrossTokenAddressMapping: TokenAddressMapping<Self::CrossAccountId>;490 }491492 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);493494 #[pallet::pallet]495 #[pallet::storage_version(STORAGE_VERSION)]496 #[pallet::generate_store(pub(super) trait Store)]497 pub struct Pallet<T>(_);498499 #[pallet::extra_constants]500 impl<T: Config> Pallet<T> {501 /// Maximum admins per collection.502 pub fn collection_admins_limit() -> u32 {503 COLLECTION_ADMINS_LIMIT504 }505 }506507 impl<T: Config> Pallet<T> {508 /// Helper function that handles deposit events509 pub fn deposit_event(event: Event<T>) {510 let event = <T as Config>::RuntimeEvent::from(event);511 let event = event.into();512 <frame_system::Pallet<T>>::deposit_event(event)513 }514 }515516 #[pallet::event]517 pub enum Event<T: Config> {518 /// New collection was created519 CollectionCreated(520 /// Globally unique identifier of newly created collection.521 CollectionId,522 /// [`CollectionMode`] converted into _u8_.523 u8,524 /// Collection owner.525 T::AccountId,526 ),527528 /// New collection was destroyed529 CollectionDestroyed(530 /// Globally unique identifier of collection.531 CollectionId,532 ),533534 /// New item was created.535 ItemCreated(536 /// Id of the collection where item was created.537 CollectionId,538 /// Id of an item. Unique within the collection.539 TokenId,540 /// Owner of newly created item541 T::CrossAccountId,542 /// Always 1 for NFT543 u128,544 ),545546 /// Collection item was burned.547 ItemDestroyed(548 /// Id of the collection where item was destroyed.549 CollectionId,550 /// Identifier of burned NFT.551 TokenId,552 /// Which user has destroyed its tokens.553 T::CrossAccountId,554 /// Amount of token pieces destroed. Always 1 for NFT.555 u128,556 ),557558 /// Item was transferred559 Transfer(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 /// New owner of item.567 T::CrossAccountId,568 /// Amount of token pieces transfered. Always 1 for NFT.569 u128,570 ),571572 /// Amount pieces of token owned by `sender` was approved for `spender`.573 Approved(574 /// Id of collection to which item is belong.575 CollectionId,576 /// Id of an item.577 TokenId,578 /// Original owner of item.579 T::CrossAccountId,580 /// Id for which the approval was granted.581 T::CrossAccountId,582 /// Amount of token pieces transfered. Always 1 for NFT.583 u128,584 ),585586 /// A `sender` approves operations on all owned tokens for `spender`.587 ApprovedForAll(588 /// Id of collection to which item is belong.589 CollectionId,590 /// Owner of a wallet.591 T::CrossAccountId,592 /// Id for which operator status was granted or rewoked.593 T::CrossAccountId,594 /// Is operator status granted or revoked?595 bool,596 ),597598 /// The colletion property has been added or edited.599 CollectionPropertySet(600 /// Id of collection to which property has been set.601 CollectionId,602 /// The property that was set.603 PropertyKey,604 ),605606 /// The property has been deleted.607 CollectionPropertyDeleted(608 /// Id of collection to which property has been deleted.609 CollectionId,610 /// The property that was deleted.611 PropertyKey,612 ),613614 /// The token property has been added or edited.615 TokenPropertySet(616 /// Identifier of the collection whose token has the property set.617 CollectionId,618 /// The token for which the property was set.619 TokenId,620 /// The property that was set.621 PropertyKey,622 ),623624 /// The token property has been deleted.625 TokenPropertyDeleted(626 /// Identifier of the collection whose token has the property deleted.627 CollectionId,628 /// The token for which the property was deleted.629 TokenId,630 /// The property that was deleted.631 PropertyKey,632 ),633634 /// The token property permission of a collection has been set.635 PropertyPermissionSet(636 /// ID of collection to which property permission has been set.637 CollectionId,638 /// The property permission that was set.639 PropertyKey,640 ),641642 /// Address was added to the allow list.643 AllowListAddressAdded(644 /// ID of the affected collection.645 CollectionId,646 /// Address of the added account.647 T::CrossAccountId,648 ),649650 /// Address was removed from the allow list.651 AllowListAddressRemoved(652 /// ID of the affected collection.653 CollectionId,654 /// Address of the removed account.655 T::CrossAccountId,656 ),657658 /// Collection admin was added.659 CollectionAdminAdded(660 /// ID of the affected collection.661 CollectionId,662 /// Admin address.663 T::CrossAccountId,664 ),665666 /// Collection admin was removed.667 CollectionAdminRemoved(668 /// ID of the affected collection.669 CollectionId,670 /// Removed admin address.671 T::CrossAccountId,672 ),673674 /// Collection limits were set.675 CollectionLimitSet(676 /// ID of the affected collection.677 CollectionId,678 ),679680 /// Collection owned was changed.681 CollectionOwnerChanged(682 /// ID of the affected collection.683 CollectionId,684 /// New owner address.685 T::AccountId,686 ),687688 /// Collection permissions were set.689 CollectionPermissionSet(690 /// ID of the affected collection.691 CollectionId,692 ),693694 /// Collection sponsor was set.695 CollectionSponsorSet(696 /// ID of the affected collection.697 CollectionId,698 /// New sponsor address.699 T::AccountId,700 ),701702 /// New sponsor was confirm.703 SponsorshipConfirmed(704 /// ID of the affected collection.705 CollectionId,706 /// New sponsor address.707 T::AccountId,708 ),709710 /// Collection sponsor was removed.711 CollectionSponsorRemoved(712 /// ID of the affected collection.713 CollectionId,714 ),715 }716717 #[pallet::error]718 pub enum Error<T> {719 /// This collection does not exist.720 CollectionNotFound,721 /// Sender parameter and item owner must be equal.722 MustBeTokenOwner,723 /// No permission to perform action724 NoPermission,725 /// Destroying only empty collections is allowed726 CantDestroyNotEmptyCollection,727 /// Collection is not in mint mode.728 PublicMintingNotAllowed,729 /// Address is not in allow list.730 AddressNotInAllowlist,731732 /// Collection name can not be longer than 63 char.733 CollectionNameLimitExceeded,734 /// Collection description can not be longer than 255 char.735 CollectionDescriptionLimitExceeded,736 /// Token prefix can not be longer than 15 char.737 CollectionTokenPrefixLimitExceeded,738 /// Total collections bound exceeded.739 TotalCollectionsLimitExceeded,740 /// Exceeded max admin count741 CollectionAdminCountExceeded,742 /// Collection limit bounds per collection exceeded743 CollectionLimitBoundsExceeded,744 /// Tried to enable permissions which are only permitted to be disabled745 OwnerPermissionsCantBeReverted,746 /// Collection settings not allowing items transferring747 TransferNotAllowed,748 /// Account token limit exceeded per collection749 AccountTokenLimitExceeded,750 /// Collection token limit exceeded751 CollectionTokenLimitExceeded,752 /// Metadata flag frozen753 MetadataFlagFrozen,754755 /// Item does not exist756 TokenNotFound,757 /// Item is balance not enough758 TokenValueTooLow,759 /// Requested value is more than the approved760 ApprovedValueTooLow,761 /// Tried to approve more than owned762 CantApproveMoreThanOwned,763 /// Only spending from eth mirror could be approved764 AddressIsNotEthMirror,765766 /// Can't transfer tokens to ethereum zero address767 AddressIsZero,768769 /// The operation is not supported770 UnsupportedOperation,771772 /// Insufficient funds to perform an action773 NotSufficientFounds,774775 /// User does not satisfy the nesting rule776 UserIsNotAllowedToNest,777 /// Only tokens from specific collections may nest tokens under this one778 SourceCollectionIsNotAllowedToNest,779780 /// Tried to store more data than allowed in collection field781 CollectionFieldSizeExceeded,782783 /// Tried to store more property data than allowed784 NoSpaceForProperty,785786 /// Tried to store more property keys than allowed787 PropertyLimitReached,788789 /// Property key is too long790 PropertyKeyIsTooLong,791792 /// Only ASCII letters, digits, and symbols `_`, `-`, and `.` are allowed793 InvalidCharacterInPropertyKey,794795 /// Empty property keys are forbidden796 EmptyPropertyKey,797798 /// Tried to access an external collection with an internal API799 CollectionIsExternal,800801 /// Tried to access an internal collection with an external API802 CollectionIsInternal,803804 /// This address is not set as sponsor, use setCollectionSponsor first.805 ConfirmSponsorshipFail,806807 /// The user is not an administrator.808 UserIsNotCollectionAdmin,809 }810811 /// Storage of the count of created collections. Essentially contains the last collection ID.812 #[pallet::storage]813 pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;814815 /// Storage of the count of deleted collections.816 #[pallet::storage]817 pub type DestroyedCollectionCount<T> =818 StorageValue<Value = CollectionId, QueryKind = ValueQuery>;819820 /// Storage of collection info.821 #[pallet::storage]822 pub type CollectionById<T> = StorageMap<823 Hasher = Blake2_128Concat,824 Key = CollectionId,825 Value = Collection<<T as frame_system::Config>::AccountId>,826 QueryKind = OptionQuery,827 >;828829 /// Storage of collection properties.830 #[pallet::storage]831 #[pallet::getter(fn collection_properties)]832 pub type CollectionProperties<T> = StorageMap<833 Hasher = Blake2_128Concat,834 Key = CollectionId,835 Value = Properties,836 QueryKind = ValueQuery,837 OnEmpty = up_data_structs::CollectionProperties,838 >;839840 /// Storage of token property permissions of a collection.841 #[pallet::storage]842 #[pallet::getter(fn property_permissions)]843 pub type CollectionPropertyPermissions<T> = StorageMap<844 Hasher = Blake2_128Concat,845 Key = CollectionId,846 Value = PropertiesPermissionMap,847 QueryKind = ValueQuery,848 >;849850 /// Storage of the amount of collection admins.851 #[pallet::storage]852 pub type AdminAmount<T> = StorageMap<853 Hasher = Blake2_128Concat,854 Key = CollectionId,855 Value = u32,856 QueryKind = ValueQuery,857 >;858859 /// List of collection admins.860 #[pallet::storage]861 pub type IsAdmin<T: Config> = StorageNMap<862 Key = (863 Key<Blake2_128Concat, CollectionId>,864 Key<Blake2_128Concat, T::CrossAccountId>,865 ),866 Value = bool,867 QueryKind = ValueQuery,868 >;869870 /// Allowlisted collection users.871 #[pallet::storage]872 pub type Allowlist<T: Config> = StorageNMap<873 Key = (874 Key<Blake2_128Concat, CollectionId>,875 Key<Blake2_128Concat, T::CrossAccountId>,876 ),877 Value = bool,878 QueryKind = ValueQuery,879 >;880881 /// Not used by code, exists only to provide some types to metadata.882 #[pallet::storage]883 pub type DummyStorageValue<T: Config> = StorageValue<884 Value = (885 CollectionStats,886 CollectionId,887 TokenId,888 TokenChild,889 PhantomType<(890 TokenData<T::CrossAccountId>,891 RpcCollection<T::AccountId>,892 // RMRK893 RmrkCollectionInfo<T::AccountId>,894 RmrkInstanceInfo<T::AccountId>,895 RmrkResourceInfo,896 RmrkPropertyInfo,897 RmrkBaseInfo<T::AccountId>,898 RmrkPartType,899 RmrkBoundedTheme,900 RmrkNftChild,901 // PoV Estimate Info902 PovInfo,903 )>,904 ),905 QueryKind = OptionQuery,906 >;907908 #[pallet::hooks]909 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {910 fn on_runtime_upgrade() -> Weight {911 StorageVersion::new(1).put::<Pallet<T>>();912913 Weight::zero()914 }915 }916}917918impl<T: Config> Pallet<T> {919 /// Enshure that receiver address is correct.920 ///921 /// Ethereum receiver 0x0000000000000000000000000000000000000000 is reserved, and shouldn't own tokens.922 pub fn ensure_correct_receiver(receiver: &T::CrossAccountId) -> DispatchResult {923 ensure!(924 &T::CrossAccountId::from_eth(H160([0; 20])) != receiver,925 <Error<T>>::AddressIsZero926 );927 Ok(())928 }929930 /// Get a vector of collection admins.931 pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {932 <IsAdmin<T>>::iter_prefix((collection,))933 .map(|(a, _)| a)934 .collect()935 }936937 /// Get a vector of users allowed to mint tokens.938 pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {939 <Allowlist<T>>::iter_prefix((collection,))940 .map(|(a, _)| a)941 .collect()942 }943944 /// Is `user` allowed to mint token in `collection`.945 pub fn allowed(collection: CollectionId, user: T::CrossAccountId) -> bool {946 <Allowlist<T>>::get((collection, user))947 }948949 /// Get statistics of collections.950 pub fn collection_stats() -> CollectionStats {951 let created = <CreatedCollectionCount<T>>::get();952 let destroyed = <DestroyedCollectionCount<T>>::get();953 CollectionStats {954 created: created.0,955 destroyed: destroyed.0,956 alive: created.0 - destroyed.0,957 }958 }959960 /// Get the effective limits for the collection.961 pub fn effective_collection_limits(collection: CollectionId) -> Option<CollectionLimits> {962 let collection = <CollectionById<T>>::get(collection)?;963 let limits = collection.limits;964 let effective_limits = CollectionLimits {965 account_token_ownership_limit: Some(limits.account_token_ownership_limit()),966 sponsored_data_size: Some(limits.sponsored_data_size()),967 sponsored_data_rate_limit: Some(968 limits969 .sponsored_data_rate_limit970 .unwrap_or(SponsoringRateLimit::SponsoringDisabled),971 ),972 token_limit: Some(limits.token_limit()),973 sponsor_transfer_timeout: Some(limits.sponsor_transfer_timeout(974 match collection.mode {975 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,976 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,977 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,978 },979 )),980 sponsor_approve_timeout: Some(limits.sponsor_approve_timeout()),981 owner_can_transfer: Some(limits.owner_can_transfer()),982 owner_can_destroy: Some(limits.owner_can_destroy()),983 transfers_enabled: Some(limits.transfers_enabled()),984 };985986 Some(effective_limits)987 }988989 /// Returns information about the `collection` adapted for rpc.990 pub fn rpc_collection(collection: CollectionId) -> Option<RpcCollection<T::AccountId>> {991 let Collection {992 name,993 description,994 owner,995 mode,996 token_prefix,997 sponsorship,998 limits,999 permissions,1000 flags,1001 } = <CollectionById<T>>::get(collection)?;10021003 let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)1004 .into_iter()1005 .map(|(key, permission)| PropertyKeyPermission { key, permission })1006 .collect();10071008 let properties = <CollectionProperties<T>>::get(collection)1009 .into_iter()1010 .map(|(key, value)| Property { key, value })1011 .collect();10121013 let permissions = CollectionPermissions {1014 access: Some(permissions.access()),1015 mint_mode: Some(permissions.mint_mode()),1016 nesting: Some(permissions.nesting().clone()),1017 };10181019 Some(RpcCollection {1020 name: name.into_inner(),1021 description: description.into_inner(),1022 owner,1023 mode,1024 token_prefix: token_prefix.into_inner(),1025 sponsorship,1026 limits,1027 permissions,1028 token_property_permissions,1029 properties,1030 read_only: flags.external,10311032 flags: RpcCollectionFlags {1033 foreign: flags.foreign,1034 erc721metadata: flags.erc721metadata,1035 },1036 })1037 }1038}10391040macro_rules! limit_default {1041 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1042 $(1043 if let Some($new) = $new.$field {1044 let $old = $old.$field($($arg)?);1045 let _ = $new;1046 let _ = $old;1047 $check1048 } else {1049 $new.$field = $old.$field1050 }1051 )*1052 }};1053}1054macro_rules! limit_default_clone {1055 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{1056 $(1057 if let Some($new) = $new.$field.clone() {1058 let $old = $old.$field($($arg)?);1059 let _ = $new;1060 let _ = $old;1061 $check1062 } else {1063 $new.$field = $old.$field.clone()1064 }1065 )*1066 }};1067}10681069impl<T: Config> Pallet<T> {1070 /// Create new collection.1071 ///1072 /// * `owner` - The owner of the collection.1073 /// * `data` - Description of the created collection.1074 /// * `flags` - Extra flags to store.1075 pub fn init_collection(1076 owner: T::CrossAccountId,1077 payer: T::CrossAccountId,1078 data: CreateCollectionData<T::AccountId>,1079 flags: CollectionFlags,1080 ) -> Result<CollectionId, DispatchError> {1081 {1082 ensure!(1083 data.token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH as usize,1084 Error::<T>::CollectionTokenPrefixLimitExceeded1085 );1086 }10871088 let created_count = <CreatedCollectionCount<T>>::get()1089 .01090 .checked_add(1)1091 .ok_or(ArithmeticError::Overflow)?;1092 let destroyed_count = <DestroyedCollectionCount<T>>::get().0;1093 let id = CollectionId(created_count);10941095 // bound Total number of collections1096 ensure!(1097 created_count - destroyed_count <= COLLECTION_NUMBER_LIMIT,1098 <Error<T>>::TotalCollectionsLimitExceeded1099 );11001101 // =========11021103 let collection = Collection {1104 owner: owner.as_sub().clone(),1105 name: data.name,1106 mode: data.mode.clone(),1107 description: data.description,1108 token_prefix: data.token_prefix,1109 sponsorship: data1110 .pending_sponsor1111 .map(SponsorshipState::Unconfirmed)1112 .unwrap_or_default(),1113 limits: data1114 .limits1115 .map(|limits| Self::clamp_limits(data.mode.clone(), &Default::default(), limits))1116 .unwrap_or_else(|| Ok(CollectionLimits::default()))?,1117 permissions: data1118 .permissions1119 .map(|permissions| {1120 Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)1121 })1122 .unwrap_or_else(|| Ok(CollectionPermissions::default()))?,1123 flags,1124 };11251126 let mut collection_properties = up_data_structs::CollectionProperties::get();1127 collection_properties1128 .try_set_from_iter(data.properties.into_iter())1129 .map_err(<Error<T>>::from)?;11301131 CollectionProperties::<T>::insert(id, collection_properties);11321133 let mut token_props_permissions = PropertiesPermissionMap::new();1134 token_props_permissions1135 .try_set_from_iter(data.token_property_permissions.into_iter())1136 .map_err(<Error<T>>::from)?;11371138 CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);11391140 // Take a (non-refundable) deposit of collection creation1141 {1142 let mut imbalance =1143 <<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();1144 imbalance.subsume(1145 <<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(1146 &T::TreasuryAccountId::get(),1147 T::CollectionCreationPrice::get(),1148 ),1149 );1150 <T as Config>::Currency::settle(1151 payer.as_sub(),1152 imbalance,1153 WithdrawReasons::TRANSFER,1154 ExistenceRequirement::KeepAlive,1155 )1156 .map_err(|_| Error::<T>::NotSufficientFounds)?;1157 }11581159 <CreatedCollectionCount<T>>::put(created_count);1160 <Pallet<T>>::deposit_event(Event::CollectionCreated(1161 id,1162 data.mode.id(),1163 owner.as_sub().clone(),1164 ));1165 <PalletEvm<T>>::deposit_log(1166 erc::CollectionHelpersEvents::CollectionCreated {1167 owner: *owner.as_eth(),1168 collection_id: eth::collection_id_to_address(id),1169 }1170 .to_log(T::ContractAddress::get()),1171 );1172 <CollectionById<T>>::insert(id, collection);1173 Ok(id)1174 }11751176 /// Destroy collection.1177 ///1178 /// * `collection` - Collection handler.1179 /// * `sender` - The owner or administrator of the collection.1180 pub fn destroy_collection(1181 collection: CollectionHandle<T>,1182 sender: &T::CrossAccountId,1183 ) -> DispatchResult {1184 ensure!(1185 collection.limits.owner_can_destroy(),1186 <Error<T>>::NoPermission,1187 );1188 collection.check_is_owner(sender)?;11891190 let destroyed_collections = <DestroyedCollectionCount<T>>::get()1191 .01192 .checked_add(1)1193 .ok_or(ArithmeticError::Overflow)?;11941195 // =========11961197 <DestroyedCollectionCount<T>>::put(destroyed_collections);1198 <CollectionById<T>>::remove(collection.id);1199 <AdminAmount<T>>::remove(collection.id);1200 let _ = <IsAdmin<T>>::clear_prefix((collection.id,), u32::MAX, None);1201 let _ = <Allowlist<T>>::clear_prefix((collection.id,), u32::MAX, None);1202 <CollectionProperties<T>>::remove(collection.id);12031204 <Pallet<T>>::deposit_event(Event::CollectionDestroyed(collection.id));12051206 <PalletEvm<T>>::deposit_log(1207 erc::CollectionHelpersEvents::CollectionDestroyed {1208 collection_id: eth::collection_id_to_address(collection.id),1209 }1210 .to_log(T::ContractAddress::get()),1211 );1212 Ok(())1213 }12141215 /// This function sets or removes a collection properties according to1216 /// `properties_updates` contents:1217 /// * sets a property under the <key> with the value provided `(<key>, Some(<value>))`1218 /// * removes a property under the <key> if the value is `None` `(<key>, None)`.1219 ///1220 /// This function fires an event for each property change.1221 /// In case of an error, all the changes (including the events) will be reverted1222 /// since the function is transactional.1223 #[transactional]1224 fn modify_collection_properties(1225 collection: &CollectionHandle<T>,1226 sender: &T::CrossAccountId,1227 properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,1228 ) -> DispatchResult {1229 collection.check_is_owner_or_admin(sender)?;12301231 let mut stored_properties = <CollectionProperties<T>>::get(collection.id);12321233 for (key, value) in properties_updates {1234 match value {1235 Some(value) => {1236 stored_properties1237 .try_set(key.clone(), value)1238 .map_err(<Error<T>>::from)?;12391240 Self::deposit_event(Event::CollectionPropertySet(collection.id, key));1241 <PalletEvm<T>>::deposit_log(1242 erc::CollectionHelpersEvents::CollectionChanged {1243 collection_id: eth::collection_id_to_address(collection.id),1244 }1245 .to_log(T::ContractAddress::get()),1246 );1247 }1248 None => {1249 stored_properties.remove(&key).map_err(<Error<T>>::from)?;12501251 Self::deposit_event(Event::CollectionPropertyDeleted(collection.id, key));1252 <PalletEvm<T>>::deposit_log(1253 erc::CollectionHelpersEvents::CollectionChanged {1254 collection_id: eth::collection_id_to_address(collection.id),1255 }1256 .to_log(T::ContractAddress::get()),1257 );1258 }1259 }1260 }12611262 <CollectionProperties<T>>::set(collection.id, stored_properties);12631264 Ok(())1265 }12661267 /// Set collection property.1268 ///1269 /// * `collection` - Collection handler.1270 /// * `sender` - The owner or administrator of the collection.1271 /// * `property` - The property to set.1272 pub fn set_collection_property(1273 collection: &CollectionHandle<T>,1274 sender: &T::CrossAccountId,1275 property: Property,1276 ) -> DispatchResult {1277 Self::set_collection_properties(collection, sender, [property].into_iter())1278 }12791280 /// Set a scoped collection property, where the scope is a special prefix1281 /// prohibiting a user access to change the property directly.1282 ///1283 /// * `collection_id` - ID of the collection for which the property is being set.1284 /// * `scope` - Property scope.1285 /// * `property` - The property to set.1286 pub fn set_scoped_collection_property(1287 collection_id: CollectionId,1288 scope: PropertyScope,1289 property: Property,1290 ) -> DispatchResult {1291 CollectionProperties::<T>::try_mutate(collection_id, |properties| {1292 properties.try_scoped_set(scope, property.key, property.value)1293 })1294 .map_err(<Error<T>>::from)?;12951296 Ok(())1297 }12981299 /// Set scoped collection properties, where the scope is a special prefix1300 /// prohibiting a user access to change the properties directly.1301 ///1302 /// * `collection_id` - ID of the collection for which the properties is being set.1303 /// * `scope` - Property scope.1304 /// * `properties` - The properties to set.1305 pub fn set_scoped_collection_properties(1306 collection_id: CollectionId,1307 scope: PropertyScope,1308 properties: impl Iterator<Item = Property>,1309 ) -> DispatchResult {1310 CollectionProperties::<T>::try_mutate(collection_id, |stored_properties| {1311 stored_properties.try_scoped_set_from_iter(scope, properties)1312 })1313 .map_err(<Error<T>>::from)?;13141315 Ok(())1316 }13171318 /// Set collection properties.1319 ///1320 /// * `collection` - Collection handler.1321 /// * `sender` - The owner or administrator of the collection.1322 /// * `properties` - The properties to set.1323 pub fn set_collection_properties(1324 collection: &CollectionHandle<T>,1325 sender: &T::CrossAccountId,1326 properties: impl Iterator<Item = Property>,1327 ) -> DispatchResult {1328 Self::modify_collection_properties(1329 collection,1330 sender,1331 properties.map(|property| (property.key, Some(property.value))),1332 )1333 }13341335 /// Delete collection property.1336 ///1337 /// * `collection` - Collection handler.1338 /// * `sender` - The owner or administrator of the collection.1339 /// * `property` - The property to delete.1340 pub fn delete_collection_property(1341 collection: &CollectionHandle<T>,1342 sender: &T::CrossAccountId,1343 property_key: PropertyKey,1344 ) -> DispatchResult {1345 Self::delete_collection_properties(collection, sender, [property_key].into_iter())1346 }13471348 /// Delete collection properties.1349 ///1350 /// * `collection` - Collection handler.1351 /// * `sender` - The owner or administrator of the collection.1352 /// * `properties` - The properties to delete.1353 pub fn delete_collection_properties(1354 collection: &CollectionHandle<T>,1355 sender: &T::CrossAccountId,1356 property_keys: impl Iterator<Item = PropertyKey>,1357 ) -> DispatchResult {1358 Self::modify_collection_properties(collection, sender, property_keys.map(|key| (key, None)))1359 }13601361 /// Set collection propetry permission without any checks.1362 ///1363 /// Used for migrations.1364 ///1365 /// * `collection` - Collection handler.1366 /// * `property_permissions` - Property permissions.1367 pub fn set_property_permission_unchecked(1368 collection: CollectionId,1369 property_permission: PropertyKeyPermission,1370 ) -> DispatchResult {1371 <CollectionPropertyPermissions<T>>::try_mutate(collection, |permissions| {1372 permissions.try_set(property_permission.key, property_permission.permission)1373 })1374 .map_err(<Error<T>>::from)?;1375 Ok(())1376 }13771378 /// Set collection property permission.1379 ///1380 /// * `collection` - Collection handler.1381 /// * `sender` - The owner or administrator of the collection.1382 /// * `property_permission` - Property permission.1383 pub fn set_property_permission(1384 collection: &CollectionHandle<T>,1385 sender: &T::CrossAccountId,1386 property_permission: PropertyKeyPermission,1387 ) -> DispatchResult {1388 Self::set_scoped_property_permission(1389 collection,1390 sender,1391 PropertyScope::None,1392 property_permission,1393 )1394 }13951396 /// Set collection property permission with scope.1397 ///1398 /// * `collection` - Collection handler.1399 /// * `sender` - The owner or administrator of the collection.1400 /// * `scope` - Property scope.1401 /// * `property_permission` - Property permission.1402 pub fn set_scoped_property_permission(1403 collection: &CollectionHandle<T>,1404 sender: &T::CrossAccountId,1405 scope: PropertyScope,1406 property_permission: PropertyKeyPermission,1407 ) -> DispatchResult {1408 collection.check_is_owner_or_admin(sender)?;14091410 let all_permissions = CollectionPropertyPermissions::<T>::get(collection.id);1411 let current_permission = all_permissions.get(&property_permission.key);1412 if matches![1413 current_permission,1414 Some(PropertyPermission { mutable: false, .. })1415 ] {1416 return Err(<Error<T>>::NoPermission.into());1417 }14181419 CollectionPropertyPermissions::<T>::try_mutate(collection.id, |permissions| {1420 let property_permission = property_permission.clone();1421 permissions.try_scoped_set(1422 scope,1423 property_permission.key,1424 property_permission.permission,1425 )1426 })1427 .map_err(<Error<T>>::from)?;14281429 Self::deposit_event(Event::PropertyPermissionSet(1430 collection.id,1431 property_permission.key,1432 ));1433 <PalletEvm<T>>::deposit_log(1434 erc::CollectionHelpersEvents::CollectionChanged {1435 collection_id: eth::collection_id_to_address(collection.id),1436 }1437 .to_log(T::ContractAddress::get()),1438 );14391440 Ok(())1441 }14421443 /// Set token property permission.1444 ///1445 /// * `collection` - Collection handler.1446 /// * `sender` - The owner or administrator of the collection.1447 /// * `property_permissions` - Property permissions.1448 #[transactional]1449 pub fn set_token_property_permissions(1450 collection: &CollectionHandle<T>,1451 sender: &T::CrossAccountId,1452 property_permissions: Vec<PropertyKeyPermission>,1453 ) -> DispatchResult {1454 Self::set_scoped_token_property_permissions(1455 collection,1456 sender,1457 PropertyScope::None,1458 property_permissions,1459 )1460 }14611462 /// Set token property permission with scope.1463 ///1464 /// * `collection` - Collection handler.1465 /// * `sender` - The owner or administrator of the collection.1466 /// * `scope` - Property scope.1467 /// * `property_permissions` - Property permissions.1468 #[transactional]1469 pub fn set_scoped_token_property_permissions(1470 collection: &CollectionHandle<T>,1471 sender: &T::CrossAccountId,1472 scope: PropertyScope,1473 property_permissions: Vec<PropertyKeyPermission>,1474 ) -> DispatchResult {1475 for prop_pemission in property_permissions {1476 Self::set_scoped_property_permission(collection, sender, scope, prop_pemission)?;1477 }14781479 Ok(())1480 }14811482 /// Get collection property.1483 pub fn get_collection_property(1484 collection_id: CollectionId,1485 key: &PropertyKey,1486 ) -> Option<PropertyValue> {1487 Self::collection_properties(collection_id).get(key).cloned()1488 }14891490 /// Convert byte vector to property key vector.1491 pub fn bytes_keys_to_property_keys(1492 keys: Vec<Vec<u8>>,1493 ) -> Result<Vec<PropertyKey>, DispatchError> {1494 keys.into_iter()1495 .map(|key| -> Result<PropertyKey, DispatchError> {1496 key.try_into()1497 .map_err(|_| <Error<T>>::PropertyKeyIsTooLong.into())1498 })1499 .collect::<Result<Vec<PropertyKey>, DispatchError>>()1500 }15011502 /// Get properties according to given keys.1503 pub fn filter_collection_properties(1504 collection_id: CollectionId,1505 keys: Option<Vec<PropertyKey>>,1506 ) -> Result<Vec<Property>, DispatchError> {1507 let properties = Self::collection_properties(collection_id);15081509 let properties = keys1510 .map(|keys| {1511 keys.into_iter()1512 .filter_map(|key| {1513 properties.get(&key).map(|value| Property {1514 key,1515 value: value.clone(),1516 })1517 })1518 .collect()1519 })1520 .unwrap_or_else(|| {1521 properties1522 .into_iter()1523 .map(|(key, value)| Property { key, value })1524 .collect()1525 });15261527 Ok(properties)1528 }15291530 /// Get property permissions according to given keys.1531 pub fn filter_property_permissions(1532 collection_id: CollectionId,1533 keys: Option<Vec<PropertyKey>>,1534 ) -> Result<Vec<PropertyKeyPermission>, DispatchError> {1535 let permissions = Self::property_permissions(collection_id);15361537 let key_permissions = keys1538 .map(|keys| {1539 keys.into_iter()1540 .filter_map(|key| {1541 permissions1542 .get(&key)1543 .map(|permission| PropertyKeyPermission {1544 key,1545 permission: permission.clone(),1546 })1547 })1548 .collect()1549 })1550 .unwrap_or_else(|| {1551 permissions1552 .into_iter()1553 .map(|(key, permission)| PropertyKeyPermission { key, permission })1554 .collect()1555 });15561557 Ok(key_permissions)1558 }15591560 /// Toggle `user` participation in the `collection`'s allow list.1561 /// #### Store read/writes1562 /// 1 writes1563 pub fn toggle_allowlist(1564 collection: &CollectionHandle<T>,1565 sender: &T::CrossAccountId,1566 user: &T::CrossAccountId,1567 allowed: bool,1568 ) -> DispatchResult {1569 collection.check_is_owner_or_admin(sender)?;15701571 // =========15721573 if allowed {1574 <Allowlist<T>>::insert((collection.id, user), true);1575 Self::deposit_event(Event::<T>::AllowListAddressAdded(1576 collection.id,1577 user.clone(),1578 ));1579 } else {1580 <Allowlist<T>>::remove((collection.id, user));1581 Self::deposit_event(Event::<T>::AllowListAddressRemoved(1582 collection.id,1583 user.clone(),1584 ));1585 }15861587 <PalletEvm<T>>::deposit_log(1588 erc::CollectionHelpersEvents::CollectionChanged {1589 collection_id: eth::collection_id_to_address(collection.id),1590 }1591 .to_log(T::ContractAddress::get()),1592 );15931594 Ok(())1595 }15961597 /// Toggle `user` participation in the `collection`'s admin list.1598 /// #### Store read/writes1599 /// 2 reads, 2 writes1600 pub fn toggle_admin(1601 collection: &CollectionHandle<T>,1602 sender: &T::CrossAccountId,1603 user: &T::CrossAccountId,1604 admin: bool,1605 ) -> DispatchResult {1606 collection.check_is_internal()?;1607 collection.check_is_owner(sender)?;16081609 let is_admin = <IsAdmin<T>>::get((collection.id, user));1610 if is_admin == admin {1611 if admin {1612 return Ok(());1613 } else {1614 return Err(Error::<T>::UserIsNotCollectionAdmin.into());1615 }1616 }1617 let amount = <AdminAmount<T>>::get(collection.id);16181619 // =========16201621 if admin {1622 let amount = amount1623 .checked_add(1)1624 .ok_or(<Error<T>>::CollectionAdminCountExceeded)?;1625 ensure!(1626 amount <= Self::collection_admins_limit(),1627 <Error<T>>::CollectionAdminCountExceeded,1628 );16291630 <AdminAmount<T>>::insert(collection.id, amount);1631 <IsAdmin<T>>::insert((collection.id, user), true);16321633 Self::deposit_event(Event::<T>::CollectionAdminAdded(1634 collection.id,1635 user.clone(),1636 ));1637 } else {1638 <AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));1639 <IsAdmin<T>>::remove((collection.id, user));16401641 Self::deposit_event(Event::<T>::CollectionAdminRemoved(1642 collection.id,1643 user.clone(),1644 ));1645 }16461647 <PalletEvm<T>>::deposit_log(1648 erc::CollectionHelpersEvents::CollectionChanged {1649 collection_id: eth::collection_id_to_address(collection.id),1650 }1651 .to_log(T::ContractAddress::get()),1652 );16531654 Ok(())1655 }16561657 /// Update collection limits.1658 pub fn update_limits(1659 user: &T::CrossAccountId,1660 collection: &mut CollectionHandle<T>,1661 new_limit: CollectionLimits,1662 ) -> DispatchResult {1663 collection.check_is_internal()?;1664 collection.check_is_owner_or_admin(user)?;16651666 collection.limits =1667 Self::clamp_limits(collection.mode.clone(), &collection.limits, new_limit)?;16681669 Self::deposit_event(Event::<T>::CollectionLimitSet(collection.id));1670 <PalletEvm<T>>::deposit_log(1671 erc::CollectionHelpersEvents::CollectionChanged {1672 collection_id: eth::collection_id_to_address(collection.id),1673 }1674 .to_log(T::ContractAddress::get()),1675 );16761677 collection.save()1678 }16791680 /// Merge set fields from `new_limit` to `old_limit`.1681 fn clamp_limits(1682 mode: CollectionMode,1683 old_limit: &CollectionLimits,1684 mut new_limit: CollectionLimits,1685 ) -> Result<CollectionLimits, DispatchError> {1686 let limits = old_limit;1687 limit_default!(old_limit, new_limit,1688 account_token_ownership_limit => ensure!(1689 new_limit <= MAX_TOKEN_OWNERSHIP,1690 <Error<T>>::CollectionLimitBoundsExceeded,1691 ),1692 sponsored_data_size => ensure!(1693 new_limit <= CUSTOM_DATA_LIMIT,1694 <Error<T>>::CollectionLimitBoundsExceeded,1695 ),16961697 sponsored_data_rate_limit => {},1698 token_limit => ensure!(1699 old_limit >= new_limit && new_limit > 0,1700 <Error<T>>::CollectionTokenLimitExceeded1701 ),17021703 sponsor_transfer_timeout(match mode {1704 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,1705 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1706 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1707 }) => ensure!(1708 new_limit <= MAX_SPONSOR_TIMEOUT,1709 <Error<T>>::CollectionLimitBoundsExceeded,1710 ),1711 sponsor_approve_timeout => {},1712 owner_can_transfer => ensure!(1713 !limits.owner_can_transfer_instaled() ||1714 old_limit || !new_limit,1715 <Error<T>>::OwnerPermissionsCantBeReverted,1716 ),1717 owner_can_destroy => ensure!(1718 old_limit || !new_limit,1719 <Error<T>>::OwnerPermissionsCantBeReverted,1720 ),1721 transfers_enabled => {},1722 );1723 Ok(new_limit)1724 }17251726 /// Update collection permissions.1727 pub fn update_permissions(1728 user: &T::CrossAccountId,1729 collection: &mut CollectionHandle<T>,1730 new_permission: CollectionPermissions,1731 ) -> DispatchResult {1732 collection.check_is_internal()?;1733 collection.check_is_owner_or_admin(user)?;1734 collection.permissions = Self::clamp_permissions(1735 collection.mode.clone(),1736 &collection.permissions,1737 new_permission,1738 )?;17391740 Self::deposit_event(Event::<T>::CollectionPermissionSet(collection.id));1741 <PalletEvm<T>>::deposit_log(1742 erc::CollectionHelpersEvents::CollectionChanged {1743 collection_id: eth::collection_id_to_address(collection.id),1744 }1745 .to_log(T::ContractAddress::get()),1746 );17471748 collection.save()1749 }17501751 /// Merge set fields from `new_permission` to `old_permission`.1752 fn clamp_permissions(1753 _mode: CollectionMode,1754 old_permission: &CollectionPermissions,1755 mut new_permission: CollectionPermissions,1756 ) -> Result<CollectionPermissions, DispatchError> {1757 limit_default_clone!(old_permission, new_permission,1758 access => {},1759 mint_mode => {},1760 nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },1761 );1762 Ok(new_permission)1763 }17641765 /// Repair possibly broken properties of a collection.1766 pub fn repair_collection(collection_id: CollectionId) -> DispatchResult {1767 CollectionProperties::<T>::mutate(collection_id, |properties| {1768 properties.recompute_consumed_space();1769 });17701771 Ok(())1772 }1773}17741775/// Indicates unsupported methods by returning [Error::UnsupportedOperation].1776#[macro_export]1777macro_rules! unsupported {1778 ($runtime:path) => {1779 Err($crate::Error::<$runtime>::UnsupportedOperation.into())1780 };1781}17821783/// Return weights for various worst-case operations.1784pub trait CommonWeightInfo<CrossAccountId> {1785 /// Weight of item creation.1786 fn create_item(data: &CreateItemData) -> Weight {1787 Self::create_multiple_items(from_ref(data))1788 }17891790 /// Weight of items creation.1791 fn create_multiple_items(amount: &[CreateItemData]) -> Weight;17921793 /// Weight of items creation.1794 fn create_multiple_items_ex(cost: &CreateItemExData<CrossAccountId>) -> Weight;17951796 /// The weight of the burning item.1797 fn burn_item() -> Weight;17981799 /// Property setting weight.1800 ///1801 /// * `amount`- The number of properties to set.1802 fn set_collection_properties(amount: u32) -> Weight;18031804 /// Collection property deletion weight.1805 ///1806 /// * `amount`- The number of properties to set.1807 fn delete_collection_properties(amount: u32) -> Weight;18081809 /// Token property setting weight.1810 ///1811 /// * `amount`- The number of properties to set.1812 fn set_token_properties(amount: u32) -> Weight;18131814 /// Token property deletion weight.1815 ///1816 /// * `amount`- The number of properties to delete.1817 fn delete_token_properties(amount: u32) -> Weight;18181819 /// Token property permissions set weight.1820 ///1821 /// * `amount`- The number of property permissions to set.1822 fn set_token_property_permissions(amount: u32) -> Weight;18231824 /// Transfer price of the token or its parts.1825 fn transfer() -> Weight;18261827 /// The price of setting the permission of the operation from another user.1828 fn approve() -> Weight;18291830 /// The price of setting the permission of the operation from another user for eth mirror.1831 fn approve_from() -> Weight;18321833 /// Transfer price from another user.1834 fn transfer_from() -> Weight;18351836 /// The price of burning a token from another user.1837 fn burn_from() -> Weight;18381839 /// Differs from burn_item in case of Fungible and Refungible, as it should burn1840 /// whole users's balance.1841 ///1842 /// This method shouldn't be used directly, as it doesn't count breadth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1843 fn burn_recursively_self_raw() -> Weight;18441845 /// Cost of iterating over `amount` children while burning, without counting child burning itself.1846 ///1847 /// This method shouldn't be used directly, as it doesn't count depth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1848 fn burn_recursively_breadth_raw(amount: u32) -> Weight;18491850 /// The price of recursive burning a token.1851 ///1852 /// `max_selfs` - The maximum burning weight of the token itself.1853 /// `max_breadth` - The maximum number of nested tokens to burn.1854 fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {1855 Self::burn_recursively_self_raw()1856 .saturating_mul(max_selfs.max(1) as u64)1857 .saturating_add(Self::burn_recursively_breadth_raw(max_breadth))1858 }18591860 /// The price of retrieving token owner1861 fn token_owner() -> Weight;18621863 /// The price of setting approval for all1864 fn set_allowance_for_all() -> Weight;18651866 /// The price of repairing an item.1867 fn force_repair_item() -> Weight;1868}18691870/// Weight info extension trait for refungible pallet.1871pub trait RefungibleExtensionsWeightInfo {1872 /// Weight of token repartition.1873 fn repartition() -> Weight;1874}18751876/// Common collection operations.1877///1878/// It wraps methods in Fungible, Nonfungible and Refungible pallets1879/// and adds weight info.1880pub trait CommonCollectionOperations<T: Config> {1881 /// Create token.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_item(1888 &self,1889 sender: T::CrossAccountId,1890 to: T::CrossAccountId,1891 data: CreateItemData,1892 nesting_budget: &dyn Budget,1893 ) -> DispatchResultWithPostInfo;18941895 /// Create multiple tokens.1896 ///1897 /// * `sender` - The user who mint the token and pays for the transaction.1898 /// * `to` - The user who will own the token.1899 /// * `data` - Token data.1900 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1901 fn create_multiple_items(1902 &self,1903 sender: T::CrossAccountId,1904 to: T::CrossAccountId,1905 data: Vec<CreateItemData>,1906 nesting_budget: &dyn Budget,1907 ) -> DispatchResultWithPostInfo;19081909 /// Create multiple tokens.1910 ///1911 /// * `sender` - The user who mint the token and pays for the transaction.1912 /// * `to` - The user who will own the token.1913 /// * `data` - Token data.1914 /// * `nesting_budget` - A budget that can be spent on nesting tokens.1915 fn create_multiple_items_ex(1916 &self,1917 sender: T::CrossAccountId,1918 data: CreateItemExData<T::CrossAccountId>,1919 nesting_budget: &dyn Budget,1920 ) -> DispatchResultWithPostInfo;19211922 /// Burn token.1923 ///1924 /// * `sender` - The user who owns the token.1925 /// * `token` - Token id that will burned.1926 /// * `amount` - The number of parts of the token that will be burned.1927 fn burn_item(1928 &self,1929 sender: T::CrossAccountId,1930 token: TokenId,1931 amount: u128,1932 ) -> DispatchResultWithPostInfo;19331934 /// Burn token and all nested tokens recursievly.1935 ///1936 /// * `sender` - The user who owns the token.1937 /// * `token` - Token id that will burned.1938 /// * `self_budget` - The budget that can be spent on burning tokens.1939 /// * `breadth_budget` - The budget that can be spent on burning nested tokens.1940 fn burn_item_recursively(1941 &self,1942 sender: T::CrossAccountId,1943 token: TokenId,1944 self_budget: &dyn Budget,1945 breadth_budget: &dyn Budget,1946 ) -> DispatchResultWithPostInfo;19471948 /// Set collection properties.1949 ///1950 /// * `sender` - Must be either the owner of the collection or its admin.1951 /// * `properties` - Properties to be set.1952 fn set_collection_properties(1953 &self,1954 sender: T::CrossAccountId,1955 properties: Vec<Property>,1956 ) -> DispatchResultWithPostInfo;19571958 /// Delete collection properties.1959 ///1960 /// * `sender` - Must be either the owner of the collection or its admin.1961 /// * `properties` - The properties to be removed.1962 fn delete_collection_properties(1963 &self,1964 sender: &T::CrossAccountId,1965 property_keys: Vec<PropertyKey>,1966 ) -> DispatchResultWithPostInfo;19671968 /// Set token properties.1969 ///1970 /// The appropriate [`PropertyPermission`] for the token property1971 /// must be set with [`Self::set_token_property_permissions`].1972 ///1973 /// * `sender` - Must be either the owner of the token or its admin.1974 /// * `token_id` - The token for which the properties are being set.1975 /// * `properties` - Properties to be set.1976 /// * `budget` - Budget for setting properties.1977 fn set_token_properties(1978 &self,1979 sender: T::CrossAccountId,1980 token_id: TokenId,1981 properties: Vec<Property>,1982 budget: &dyn Budget,1983 ) -> DispatchResultWithPostInfo;19841985 /// Remove token properties.1986 ///1987 /// The appropriate [`PropertyPermission`] for the token property1988 /// must be set with [`Self::set_token_property_permissions`].1989 ///1990 /// * `sender` - Must be either the owner of the token or its admin.1991 /// * `token_id` - The token for which the properties are being remove.1992 /// * `property_keys` - Keys to remove corresponding properties.1993 /// * `budget` - Budget for removing properties.1994 fn delete_token_properties(1995 &self,1996 sender: T::CrossAccountId,1997 token_id: TokenId,1998 property_keys: Vec<PropertyKey>,1999 budget: &dyn Budget,2000 ) -> DispatchResultWithPostInfo;20012002 /// Set token property permissions.2003 ///2004 /// * `sender` - Must be either the owner of the token or its admin.2005 /// * `token_id` - The token for which the properties are being set.2006 /// * `property_permissions` - Property permissions to be set.2007 /// * `budget` - Budget for setting properties.2008 fn set_token_property_permissions(2009 &self,2010 sender: &T::CrossAccountId,2011 property_permissions: Vec<PropertyKeyPermission>,2012 ) -> DispatchResultWithPostInfo;20132014 /// Transfer amount of token pieces.2015 ///2016 /// * `sender` - Donor user.2017 /// * `to` - Recepient user.2018 /// * `token` - The token of which parts are being sent.2019 /// * `amount` - The number of parts of the token that will be transferred.2020 /// * `budget` - The maximum budget that can be spent on the transfer.2021 fn transfer(2022 &self,2023 sender: T::CrossAccountId,2024 to: T::CrossAccountId,2025 token: TokenId,2026 amount: u128,2027 budget: &dyn Budget,2028 ) -> DispatchResultWithPostInfo;20292030 /// Grant access to another account to transfer parts of the token owned by the calling user via [Self::transfer_from].2031 ///2032 /// * `sender` - The user who grants access to the token.2033 /// * `spender` - The user to whom the rights are granted.2034 /// * `token` - The token to which access is granted.2035 /// * `amount` - The amount of pieces that another user can dispose of.2036 fn approve(2037 &self,2038 sender: T::CrossAccountId,2039 spender: T::CrossAccountId,2040 token: TokenId,2041 amount: u128,2042 ) -> DispatchResultWithPostInfo;20432044 /// Grant access to another account to transfer parts of the token owned by the calling user's eth mirror via [Self::transfer_from].2045 ///2046 /// * `sender` - The user who grants access to the token.2047 /// * `from` - Spender's eth mirror.2048 /// * `to` - The user to whom the rights are granted.2049 /// * `token` - The token to which access is granted.2050 /// * `amount` - The amount of pieces that another user can dispose of.2051 fn approve_from(2052 &self,2053 sender: T::CrossAccountId,2054 from: T::CrossAccountId,2055 to: T::CrossAccountId,2056 token: TokenId,2057 amount: u128,2058 ) -> DispatchResultWithPostInfo;20592060 /// Send parts of a token owned by another user.2061 ///2062 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2063 ///2064 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2065 /// * `from` - The user who owns the token.2066 /// * `to` - Recepient user.2067 /// * `token` - The token of which parts are being sent.2068 /// * `amount` - The number of parts of the token that will be transferred.2069 /// * `budget` - The maximum budget that can be spent on the transfer.2070 fn transfer_from(2071 &self,2072 sender: T::CrossAccountId,2073 from: T::CrossAccountId,2074 to: T::CrossAccountId,2075 token: TokenId,2076 amount: u128,2077 budget: &dyn Budget,2078 ) -> DispatchResultWithPostInfo;20792080 /// Burn parts of a token owned by another user.2081 ///2082 /// Before calling this method, you must grant rights to the calling user via [`Self::approve`].2083 ///2084 /// * `sender` - The user who must have access to the token (see [`Self::approve`]).2085 /// * `from` - The user who owns the token.2086 /// * `token` - The token of which parts are being sent.2087 /// * `amount` - The number of parts of the token that will be transferred.2088 /// * `budget` - The maximum budget that can be spent on the burn.2089 fn burn_from(2090 &self,2091 sender: T::CrossAccountId,2092 from: T::CrossAccountId,2093 token: TokenId,2094 amount: u128,2095 budget: &dyn Budget,2096 ) -> DispatchResultWithPostInfo;20972098 /// Check permission to nest token.2099 ///2100 /// * `sender` - The user who initiated the check.2101 /// * `from` - The token that is checked for embedding.2102 /// * `under` - Token under which to check.2103 /// * `budget` - The maximum budget that can be spent on the check.2104 fn check_nesting(2105 &self,2106 sender: T::CrossAccountId,2107 from: (CollectionId, TokenId),2108 under: TokenId,2109 budget: &dyn Budget,2110 ) -> DispatchResult;21112112 /// Nest one token into another.2113 ///2114 /// * `under` - Token holder.2115 /// * `to_nest` - Nested token.2116 fn nest(&self, under: TokenId, to_nest: (CollectionId, TokenId));21172118 /// Unnest token.2119 ///2120 /// * `under` - Token holder.2121 /// * `to_nest` - Token to unnest.2122 fn unnest(&self, under: TokenId, to_nest: (CollectionId, TokenId));21232124 /// Get all user tokens.2125 ///2126 /// * `account` - Account for which you need to get tokens.2127 fn account_tokens(&self, account: T::CrossAccountId) -> Vec<TokenId>;21282129 /// Get all the tokens in the collection.2130 fn collection_tokens(&self) -> Vec<TokenId>;21312132 /// Check if the token exists.2133 ///2134 /// * `token` - Id token to check.2135 fn token_exists(&self, token: TokenId) -> bool;21362137 /// Get the id of the last minted token.2138 fn last_token_id(&self) -> TokenId;21392140 /// Get the owner of the token.2141 ///2142 /// * `token` - The token for which you need to find out the owner.2143 fn token_owner(&self, token: TokenId) -> Result<T::CrossAccountId, TokenOwnerError>;21442145 /// Returns 10 tokens owners in no particular order.2146 ///2147 /// * `token` - The token for which you need to find out the owners.2148 fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId>;21492150 /// Get the value of the token property by key.2151 ///2152 /// * `token` - Token with the property to get.2153 /// * `key` - Property name.2154 fn token_property(&self, token_id: TokenId, key: &PropertyKey) -> Option<PropertyValue>;21552156 /// Get a set of token properties by key vector.2157 ///2158 /// * `token` - Token with the property to get.2159 /// * `keys` - Vector of property keys. If this parameter is [None](sp_std::result::Result),2160 /// then all properties are returned.2161 fn token_properties(&self, token: TokenId, keys: Option<Vec<PropertyKey>>) -> Vec<Property>;21622163 /// Amount of unique collection tokens2164 fn total_supply(&self) -> u32;21652166 /// Amount of different tokens account has.2167 ///2168 /// * `account` - The account for which need to get the balance.2169 fn account_balance(&self, account: T::CrossAccountId) -> u32;21702171 /// Amount of specific token account have.2172 fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;21732174 /// Amount of token pieces2175 fn total_pieces(&self, token: TokenId) -> Option<u128>;21762177 /// Get the number of parts of the token that a trusted user can manage.2178 ///2179 /// * `sender` - Trusted user.2180 /// * `spender` - Owner of the token.2181 /// * `token` - The token for which to get the value.2182 fn allowance(2183 &self,2184 sender: T::CrossAccountId,2185 spender: T::CrossAccountId,2186 token: TokenId,2187 ) -> u128;21882189 /// Get extension for RFT collection.2190 fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>>;21912192 /// The `operator` is allowed to transfer all tokens of the `owner` on their behalf.2193 /// * `owner` - Token owner2194 /// * `operator` - Operator2195 /// * `approve` - Should operator status be granted or revoked?2196 fn set_allowance_for_all(2197 &self,2198 owner: T::CrossAccountId,2199 operator: T::CrossAccountId,2200 approve: bool,2201 ) -> DispatchResultWithPostInfo;22022203 /// Tells whether the given `owner` approves the `operator`.2204 fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool;22052206 /// Repairs a possibly broken item.2207 fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo;2208}22092210/// Extension for RFT collection.2211pub trait RefungibleExtensions<T>2212where2213 T: Config,2214{2215 /// Change the number of parts of the token.2216 ///2217 /// When the value changes down, this function is equivalent to burning parts of the token.2218 ///2219 /// * `sender` - The user calling the repartition operation. Must be the owner of the token.2220 /// * `token` - The token for which you want to change the number of parts.2221 /// * `amount` - The new value of the parts of the token.2222 fn repartition(2223 &self,2224 sender: &T::CrossAccountId,2225 token: TokenId,2226 amount: u128,2227 ) -> DispatchResultWithPostInfo;2228}22292230/// Merge [`DispatchResult`] with [`Weight`] into [`DispatchResultWithPostInfo`].2231///2232/// Used for [`CommonCollectionOperations`] implementations and flexible enough to do so.2233pub fn with_weight(res: DispatchResult, weight: Weight) -> DispatchResultWithPostInfo {2234 let post_info = PostDispatchInfo {2235 actual_weight: Some(weight),2236 pays_fee: Pays::Yes,2237 };2238 match res {2239 Ok(()) => Ok(post_info),2240 Err(error) => Err(DispatchErrorWithPostInfo { post_info, error }),2241 }2242}22432244impl<T: Config> From<PropertiesError> for Error<T> {2245 fn from(error: PropertiesError) -> Self {2246 match error {2247 PropertiesError::NoSpaceForProperty => Self::NoSpaceForProperty,2248 PropertiesError::PropertyLimitReached => Self::PropertyLimitReached,2249 PropertiesError::InvalidCharacterInPropertyKey => Self::InvalidCharacterInPropertyKey,2250 PropertiesError::PropertyKeyIsTooLong => Self::PropertyKeyIsTooLong,2251 PropertiesError::EmptyPropertyKey => Self::EmptyPropertyKey,2252 }2253 }2254}pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -36,13 +36,9 @@
pub struct CommonWeights<T: Config>(PhantomData<T>);
impl<T: Config> CommonWeightInfo<T::CrossAccountId> for CommonWeights<T> {
- fn create_item() -> Weight {
- <SelfWeightOf<T>>::create_item()
- }
-
fn create_multiple_items(_data: &[CreateItemData]) -> Weight {
// All items minted for the same user, so it works same as create_item
- Self::create_item()
+ <SelfWeightOf<T>>::create_item()
}
fn create_multiple_items_ex(data: &CreateItemExData<T::CrossAccountId>) -> Weight {
@@ -134,10 +130,10 @@
data: up_data_structs::CreateItemData,
nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
- match data {
- up_data_structs::CreateItemData::Fungible(data) => with_weight(
- <Pallet<T>>::create_item(self, &sender, (to, data.value), nesting_budget),
- <CommonWeights<T>>::create_item(),
+ match &data {
+ up_data_structs::CreateItemData::Fungible(fungible_data) => with_weight(
+ <Pallet<T>>::create_item(self, &sender, (to, fungible_data.value), nesting_budget),
+ <CommonWeights<T>>::create_item(&data),
),
_ => fail!(<Error<T>>::NotFungibleDataUsedToMintFungibleCollectionToken),
}
@@ -151,8 +147,8 @@
nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
let mut sum: u128 = 0;
- for data in data {
- match data {
+ for data in &data {
+ match &data {
up_data_structs::CreateItemData::Fungible(data) => {
sum = sum
.checked_add(data.value)
@@ -164,7 +160,7 @@
with_weight(
<Pallet<T>>::create_item(self, &sender, (to, sum), nesting_budget),
- <CommonWeights<T>>::create_item(),
+ <CommonWeights<T>>::create_multiple_items(&data),
)
}
pallets/nonfungible/CHANGELOG.mddiffbeforeafterboth--- a/pallets/nonfungible/CHANGELOG.md
+++ b/pallets/nonfungible/CHANGELOG.md
@@ -4,6 +4,12 @@
<!-- bureaucrate goes here -->
+## [0.1.13] - 2023-01-20
+
+### Fixed
+
+- The weight of properties when creating an item.
+
## [0.1.12] - 2022-12-16
### Added
pallets/nonfungible/Cargo.tomldiffbeforeafterboth--- a/pallets/nonfungible/Cargo.toml
+++ b/pallets/nonfungible/Cargo.toml
@@ -2,7 +2,7 @@
edition = "2021"
license = "GPLv3"
name = "pallet-nonfungible"
-version = "0.1.12"
+version = "0.1.13"
[dependencies]
codec = { default-features = false, features = ['derive'], package = 'parity-scale-codec', version = "3.1.2" }
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -35,10 +35,6 @@
pub struct CommonWeights<T: Config>(PhantomData<T>);
impl<T: Config> CommonWeightInfo<T::CrossAccountId> for CommonWeights<T> {
- fn create_item() -> Weight {
- <SelfWeightOf<T>>::create_item()
- }
-
fn create_multiple_items_ex(data: &CreateItemExData<T::CrossAccountId>) -> Weight {
match data {
CreateItemExData::NFT(t) => {
@@ -159,6 +155,7 @@
data: up_data_structs::CreateItemData,
nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
+ let weight = <CommonWeights<T>>::create_item(&data);
with_weight(
<Pallet<T>>::create_item(
self,
@@ -166,7 +163,7 @@
map_create_data::<T>(data, &to)?,
nesting_budget,
),
- <CommonWeights<T>>::create_item(),
+ weight,
)
}
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -590,7 +590,7 @@
/// @param tokenUri Token URI that would be stored in the NFT properties
/// @return uint256 The id of the newly minted token
#[solidity(rename_selector = "mintWithTokenURI")]
- #[weight(<SelfWeightOf<T>>::create_item())]
+ #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]
fn mint_with_token_uri(
&mut self,
caller: Caller,
@@ -612,7 +612,7 @@
/// @param tokenId ID of the minted NFT
/// @param tokenUri Token URI that would be stored in the NFT properties
#[solidity(hide, rename_selector = "mintWithTokenURI")]
- #[weight(<SelfWeightOf<T>>::create_item())]
+ #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]
fn mint_with_token_uri_check_id(
&mut self,
caller: Caller,
@@ -943,7 +943,7 @@
/// @param to The new owner
/// @param tokens array of pairs of token ID and token URI for minted tokens
#[solidity(hide, rename_selector = "mintBulkWithTokenURI")]
- #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]
+ #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32) + <SelfWeightOf<T>>::set_token_properties(tokens.len() as u32))]
fn mint_bulk_with_token_uri(
&mut self,
caller: Caller,
@@ -994,7 +994,7 @@
/// @param to The new owner crossAccountId
/// @param properties Properties of minted token
/// @return uint256 The id of the newly minted token
- #[weight(<SelfWeightOf<T>>::create_item())]
+ #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]
fn mint_cross(
&mut self,
caller: Caller,
pallets/refungible/CHANGELOG.mddiffbeforeafterboth--- a/pallets/refungible/CHANGELOG.md
+++ b/pallets/refungible/CHANGELOG.md
@@ -4,6 +4,12 @@
<!-- bureaucrate goes here -->
+## [0.2.12] - 2023-01-20
+
+### Fixed
+
+- The weight of properties when creating an item.
+
## [0.2.11] - 2022-12-16
### Added
pallets/refungible/Cargo.tomldiffbeforeafterboth--- a/pallets/refungible/Cargo.toml
+++ b/pallets/refungible/Cargo.toml
@@ -2,7 +2,7 @@
edition = "2021"
license = "GPLv3"
name = "pallet-refungible"
-version = "0.2.11"
+version = "0.2.12"
[dependencies]
codec = { default-features = false, features = ['derive'], package = 'parity-scale-codec', version = "3.1.2" }
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -55,10 +55,6 @@
pub struct CommonWeights<T: Config>(PhantomData<T>);
impl<T: Config> CommonWeightInfo<T::CrossAccountId> for CommonWeights<T> {
- fn create_item() -> Weight {
- <SelfWeightOf<T>>::create_item()
- }
-
fn create_multiple_items(data: &[up_data_structs::CreateItemData]) -> Weight {
<SelfWeightOf<T>>::create_multiple_items(data.len() as u32).saturating_add(
data.iter()
@@ -193,6 +189,7 @@
data: up_data_structs::CreateItemData,
nesting_budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
+ let weight = <CommonWeights<T>>::create_item(&data);
with_weight(
<Pallet<T>>::create_item(
self,
@@ -200,7 +197,7 @@
map_create_data::<T>(data, &to)?,
nesting_budget,
),
- <CommonWeights<T>>::create_item(),
+ weight,
)
}
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -629,7 +629,7 @@
/// @param tokenUri Token URI that would be stored in the NFT properties
/// @return uint256 The id of the newly minted token
#[solidity(rename_selector = "mintWithTokenURI")]
- #[weight(<SelfWeightOf<T>>::create_item())]
+ #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]
fn mint_with_token_uri(
&mut self,
caller: Caller,
@@ -651,7 +651,7 @@
/// @param tokenId ID of the minted RFT
/// @param tokenUri Token URI that would be stored in the RFT properties
#[solidity(hide, rename_selector = "mintWithTokenURI")]
- #[weight(<SelfWeightOf<T>>::create_item())]
+ #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]
fn mint_with_token_uri_check_id(
&mut self,
caller: Caller,
@@ -994,7 +994,7 @@
/// @param to The new owner
/// @param tokens array of pairs of token ID and token URI for minted tokens
#[solidity(hide, rename_selector = "mintBulkWithTokenURI")]
- #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]
+ #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32) + <SelfWeightOf<T>>::set_token_properties(tokens.len() as u32))]
fn mint_bulk_with_token_uri(
&mut self,
caller: Caller,
@@ -1051,7 +1051,7 @@
/// @param to The new owner crossAccountId
/// @param properties Properties of minted token
/// @return uint256 The id of the newly minted token
- #[weight(<SelfWeightOf<T>>::create_item())]
+ #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]
fn mint_cross(
&mut self,
caller: Caller,
pallets/unique/src/lib.rsdiffbeforeafterboth--- a/pallets/unique/src/lib.rs
+++ b/pallets/unique/src/lib.rs
@@ -518,7 +518,7 @@
/// * `collection_id`: ID of the collection to which an item would belong.
/// * `owner`: Address of the initial owner of the item.
/// * `data`: Token data describing the item to store on chain.
- #[weight = T::CommonWeightInfo::create_item()]
+ #[weight = T::CommonWeightInfo::create_item(&data)]
pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {
let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);
let budget = budget::Value::new(NESTING_BUDGET);
runtime/common/weights.rsdiffbeforeafterboth--- a/runtime/common/weights.rs
+++ b/runtime/common/weights.rs
@@ -57,8 +57,8 @@
where
T: CommonWeightConfigs,
{
- fn create_item() -> Weight {
- dispatch_weight::<T>() + max_weight_of!(create_item())
+ fn create_item(data: &CreateItemData) -> Weight {
+ dispatch_weight::<T>() + max_weight_of!(create_item(data))
}
fn create_multiple_items(data: &[CreateItemData]) -> Weight {