difftreelog
feat sponsor token property modifications
in: master
3 files changed
pallets/unique/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#![recursion_limit = "1024"]18#![cfg_attr(not(feature = "std"), no_std)]19#![allow(20 clippy::too_many_arguments,21 clippy::unnecessary_mut_passed,22 clippy::unused_unit23)]2425use frame_support::{26 decl_module, decl_storage, decl_error, decl_event,27 dispatch::DispatchResult,28 ensure,29 weights::{Weight},30 transactional,31 pallet_prelude::{DispatchResultWithPostInfo, ConstU32},32 BoundedVec,33};34use scale_info::TypeInfo;35use frame_system::{self as system, ensure_signed};36use sp_runtime::{sp_std::prelude::Vec};37use up_data_structs::{38 CONST_ON_CHAIN_SCHEMA_LIMIT, OFFCHAIN_SCHEMA_LIMIT, MAX_COLLECTION_NAME_LENGTH,39 MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH, AccessMode, CreateItemData,40 CollectionLimits, CollectionId, CollectionMode, TokenId, SchemaVersion, SponsorshipState,41 CreateCollectionData, CreateItemExData, budget, CollectionField, Property, PropertyKey,42 PropertyKeyPermission,43};44use pallet_evm::account::CrossAccountId;45use pallet_common::{46 CollectionHandle, Pallet as PalletCommon, CommonWeightInfo, dispatch::dispatch_call,47 dispatch::CollectionDispatch,48};4950#[cfg(feature = "runtime-benchmarks")]51mod benchmarking;52pub mod weights;53use weights::WeightInfo;5455decl_error! {56 /// Error for non-fungible-token module.57 pub enum Error for Module<T: Config> {58 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.59 CollectionDecimalPointLimitExceeded,60 /// This address is not set as sponsor, use setCollectionSponsor first.61 ConfirmUnsetSponsorFail,62 /// Length of items properties must be greater than 0.63 EmptyArgument,64 }65}6667pub trait Config: system::Config + pallet_common::Config + Sized + TypeInfo {68 type Event: From<Event<Self>> + Into<<Self as frame_system::Config>::Event>;6970 /// Weight information for extrinsics in this pallet.71 type WeightInfo: WeightInfo;72 type CommonWeightInfo: CommonWeightInfo<Self::CrossAccountId>;73}7475decl_event! {76 pub enum Event<T>77 where78 <T as frame_system::Config>::AccountId,79 <T as pallet_evm::account::Config>::CrossAccountId,80 {81 /// Collection sponsor was removed82 ///83 /// # Arguments84 ///85 /// * collection_id: Globally unique collection identifier.86 CollectionSponsorRemoved(CollectionId),8788 /// Collection admin was added89 ///90 /// # Arguments91 ///92 /// * collection_id: Globally unique collection identifier.93 ///94 /// * admin: Admin address.95 CollectionAdminAdded(CollectionId, CrossAccountId),9697 /// Collection owned was change98 ///99 /// # Arguments100 ///101 /// * collection_id: Globally unique collection identifier.102 ///103 /// * owner: New owner address.104 CollectionOwnedChanged(CollectionId, AccountId),105106 /// Collection sponsor was set107 ///108 /// # Arguments109 ///110 /// * collection_id: Globally unique collection identifier.111 ///112 /// * owner: New sponsor address.113 CollectionSponsorSet(CollectionId, AccountId),114115 /// const on chain schema was set116 ///117 /// # Arguments118 ///119 /// * collection_id: Globally unique collection identifier.120 ConstOnChainSchemaSet(CollectionId),121122 /// New sponsor was confirm123 ///124 /// # Arguments125 ///126 /// * collection_id: Globally unique collection identifier.127 ///128 /// * sponsor: New sponsor address.129 SponsorshipConfirmed(CollectionId, AccountId),130131 /// Collection admin was removed132 ///133 /// # Arguments134 ///135 /// * collection_id: Globally unique collection identifier.136 ///137 /// * admin: Admin address.138 CollectionAdminRemoved(CollectionId, CrossAccountId),139140 /// Address was remove from allow list141 ///142 /// # Arguments143 ///144 /// * collection_id: Globally unique collection identifier.145 ///146 /// * user: Address.147 AllowListAddressRemoved(CollectionId, CrossAccountId),148149 /// Address was add to allow list150 ///151 /// # Arguments152 ///153 /// * collection_id: Globally unique collection identifier.154 ///155 /// * user: Address.156 AllowListAddressAdded(CollectionId, CrossAccountId),157158 /// Collection limits was set159 ///160 /// # Arguments161 ///162 /// * collection_id: Globally unique collection identifier.163 CollectionLimitSet(CollectionId),164165 /// Mint permission was set166 ///167 /// # Arguments168 ///169 /// * collection_id: Globally unique collection identifier.170 MintPermissionSet(CollectionId),171172 /// Offchain schema was set173 ///174 /// # Arguments175 ///176 /// * collection_id: Globally unique collection identifier.177 OffchainSchemaSet(CollectionId),178179 /// Public access mode was set180 ///181 /// # Arguments182 ///183 /// * collection_id: Globally unique collection identifier.184 ///185 /// * mode: New access state.186 PublicAccessModeSet(CollectionId, AccessMode),187188 /// Schema version was set189 ///190 /// # Arguments191 ///192 /// * collection_id: Globally unique collection identifier.193 SchemaVersionSet(CollectionId),194 }195}196197type SelfWeightOf<T> = <T as Config>::WeightInfo;198199// # Used definitions200//201// ## User control levels202//203// chain-controlled - key is uncontrolled by user204// i.e autoincrementing index205// can use non-cryptographic hash206// real - key is controlled by user207// but it is hard to generate enough colliding values, i.e owner of signed txs208// can use non-cryptographic hash209// controlled - key is completly controlled by users210// i.e maps with mutable keys211// should use cryptographic hash212//213// ## User control level downgrade reasons214//215// ?1 - chain-controlled -> controlled216// collections/tokens can be destroyed, resulting in massive holes217// ?2 - chain-controlled -> controlled218// same as ?1, but can be only added, resulting in easier exploitation219// ?3 - real -> controlled220// no confirmation required, so addresses can be easily generated221decl_storage! {222 trait Store for Module<T: Config> as Unique {223224 //#region Private members225 /// Used for migrations226 ChainVersion: u64;227 //#endregion228229 //#region Tokens transfer rate limit baskets230 /// (Collection id (controlled?2), who created (real))231 /// TODO: Off chain worker should remove from this map when collection gets removed232 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => Option<T::BlockNumber>;233 /// Collection id (controlled?2), token id (controlled?2)234 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;235 /// Collection id (controlled?2), owning user (real)236 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;237 /// Collection id (controlled?2), token id (controlled?2)238 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;239 //#endregion240241 /// Variable metadata sponsoring242 /// Collection id (controlled?2), token id (controlled?2)243 #[deprecated]244 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;245246 /// Approval sponsoring247 pub NftApproveBasket get(fn nft_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;248 pub FungibleApproveBasket get(fn fungible_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;249 pub RefungibleApproveBasket get(fn refungible_approve_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;250 }251}252253decl_module! {254 pub struct Module<T: Config> for enum Call255 where256 origin: T::Origin257 {258 type Error = Error<T>;259260 fn deposit_event() = default;261262 fn on_initialize(_now: T::BlockNumber) -> Weight {263 0264 }265266 fn on_runtime_upgrade() -> Weight {267 let limit = None;268269 <VariableMetaDataBasket<T>>::remove_all(limit);270271 0272 }273274 /// This method creates a Collection of NFTs. Each Token may have multiple properties encoded as an array of bytes of certain length. The initial owner of the collection is set to the address that signed the transaction and can be changed later.275 ///276 /// # Permissions277 ///278 /// * Anyone.279 ///280 /// # Arguments281 ///282 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.283 ///284 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.285 ///286 /// * token_prefix: UTF-8 string with token prefix.287 ///288 /// * mode: [CollectionMode] collection type and type dependent data.289 // returns collection ID290 #[weight = <SelfWeightOf<T>>::create_collection()]291 #[transactional]292 #[deprecated]293 pub fn create_collection(origin,294 collection_name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,295 collection_description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,296 token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,297 mode: CollectionMode) -> DispatchResult {298 let data: CreateCollectionData<T::AccountId> = CreateCollectionData {299 name: collection_name,300 description: collection_description,301 token_prefix,302 mode,303 ..Default::default()304 };305 Self::create_collection_ex(origin, data)306 }307308 /// This method creates a collection309 ///310 /// Prefer it to deprecated [`created_collection`] method311 #[weight = <SelfWeightOf<T>>::create_collection()]312 #[transactional]313 pub fn create_collection_ex(origin, data: CreateCollectionData<T::AccountId>) -> DispatchResult {314 let sender = ensure_signed(origin)?;315316 // =========317318 T::CollectionDispatch::create(sender, data)?;319320 Ok(())321 }322323 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.324 ///325 /// # Permissions326 ///327 /// * Collection Owner.328 ///329 /// # Arguments330 ///331 /// * collection_id: collection to destroy.332 #[weight = <SelfWeightOf<T>>::destroy_collection()]333 #[transactional]334 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {335 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);336 let collection = <CollectionHandle<T>>::try_get(collection_id)?;337338 // =========339340 T::CollectionDispatch::destroy(sender, collection)?;341342 <NftTransferBasket<T>>::remove_prefix(collection_id, None);343 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);344 <ReFungibleTransferBasket<T>>::remove_prefix((collection_id,), None);345346 <NftApproveBasket<T>>::remove_prefix(collection_id, None);347 <FungibleApproveBasket<T>>::remove_prefix(collection_id, None);348 <RefungibleApproveBasket<T>>::remove_prefix((collection_id,), None);349350 Ok(())351 }352353 /// Add an address to allow list.354 ///355 /// # Permissions356 ///357 /// * Collection Owner358 /// * Collection Admin359 ///360 /// # Arguments361 ///362 /// * collection_id.363 ///364 /// * address.365 #[weight = <SelfWeightOf<T>>::add_to_allow_list()]366 #[transactional]367 pub fn add_to_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{368369 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);370 let collection = <CollectionHandle<T>>::try_get(collection_id)?;371372 <PalletCommon<T>>::toggle_allowlist(373 &collection,374 &sender,375 &address,376 true,377 )?;378379 Self::deposit_event(Event::<T>::AllowListAddressAdded(380 collection_id,381 address382 ));383384 Ok(())385 }386387 /// Remove an address from allow list.388 ///389 /// # Permissions390 ///391 /// * Collection Owner392 /// * Collection Admin393 ///394 /// # Arguments395 ///396 /// * collection_id.397 ///398 /// * address.399 #[weight = <SelfWeightOf<T>>::remove_from_allow_list()]400 #[transactional]401 pub fn remove_from_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{402403 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);404 let collection = <CollectionHandle<T>>::try_get(collection_id)?;405406 <PalletCommon<T>>::toggle_allowlist(407 &collection,408 &sender,409 &address,410 false,411 )?;412413 <Pallet<T>>::deposit_event(Event::<T>::AllowListAddressRemoved(414 collection_id,415 address416 ));417418 Ok(())419 }420421 /// Toggle between normal and allow list access for the methods with access for `Anyone`.422 ///423 /// # Permissions424 ///425 /// * Collection Owner.426 ///427 /// # Arguments428 ///429 /// * collection_id.430 ///431 /// * mode: [AccessMode]432 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]433 #[transactional]434 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult435 {436 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);437438 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;439 target_collection.check_is_owner(&sender)?;440441 target_collection.access = mode.clone();442443 <Pallet<T>>::deposit_event(Event::<T>::PublicAccessModeSet(444 collection_id,445 mode446 ));447448 target_collection.save()449 }450451 /// Allows Anyone to create tokens if:452 /// * Allow List is enabled, and453 /// * Address is added to allow list, and454 /// * This method was called with True parameter455 ///456 /// # Permissions457 /// * Collection Owner458 ///459 /// # Arguments460 ///461 /// * collection_id.462 ///463 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.464 #[weight = <SelfWeightOf<T>>::set_mint_permission()]465 #[transactional]466 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult467 {468 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);469470 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;471 target_collection.check_is_owner(&sender)?;472473 target_collection.mint_mode = mint_permission;474475 <Pallet<T>>::deposit_event(Event::<T>::MintPermissionSet(476 collection_id477 ));478479 target_collection.save()480 }481482 /// Change the owner of the collection.483 ///484 /// # Permissions485 ///486 /// * Collection Owner.487 ///488 /// # Arguments489 ///490 /// * collection_id.491 ///492 /// * new_owner.493 #[weight = <SelfWeightOf<T>>::change_collection_owner()]494 #[transactional]495 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {496497 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);498499 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;500 target_collection.check_is_owner(&sender)?;501502 target_collection.owner = new_owner.clone();503 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnedChanged(504 collection_id,505 new_owner506 ));507508 target_collection.save()509 }510511 /// Adds an admin of the Collection.512 /// NFT Collection can be controlled by multiple admin addresses (some which can also be servers, for example). Admins can issue and burn NFTs, as well as add and remove other admins, but cannot change NFT or Collection ownership.513 ///514 /// # Permissions515 ///516 /// * Collection Owner.517 /// * Collection Admin.518 ///519 /// # Arguments520 ///521 /// * collection_id: ID of the Collection to add admin for.522 ///523 /// * new_admin_id: Address of new admin to add.524 #[weight = <SelfWeightOf<T>>::add_collection_admin()]525 #[transactional]526 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {527 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);528 let collection = <CollectionHandle<T>>::try_get(collection_id)?;529530 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminAdded(531 collection_id,532 new_admin_id.clone()533 ));534535 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin_id, true)536 }537538 /// Remove admin address of the Collection. An admin address can remove itself. List of admins may become empty, in which case only Collection Owner will be able to add an Admin.539 ///540 /// # Permissions541 ///542 /// * Collection Owner.543 /// * Collection Admin.544 ///545 /// # Arguments546 ///547 /// * collection_id: ID of the Collection to remove admin for.548 ///549 /// * account_id: Address of admin to remove.550 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]551 #[transactional]552 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {553 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);554 let collection = <CollectionHandle<T>>::try_get(collection_id)?;555556 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminRemoved(557 collection_id,558 account_id.clone()559 ));560561 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)562 }563564 /// # Permissions565 ///566 /// * Collection Owner567 ///568 /// # Arguments569 ///570 /// * collection_id.571 ///572 /// * new_sponsor.573 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]574 #[transactional]575 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {576 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);577578 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;579 target_collection.check_is_owner(&sender)?;580581 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor.clone());582583 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(584 collection_id,585 new_sponsor586 ));587588 target_collection.save()589 }590591 /// # Permissions592 ///593 /// * Sponsor.594 ///595 /// # Arguments596 ///597 /// * collection_id.598 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]599 #[transactional]600 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {601 let sender = ensure_signed(origin)?;602603 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;604 ensure!(605 target_collection.sponsorship.pending_sponsor() == Some(&sender),606 Error::<T>::ConfirmUnsetSponsorFail607 );608609 target_collection.sponsorship = SponsorshipState::Confirmed(sender.clone());610611 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(612 collection_id,613 sender614 ));615616 target_collection.save()617 }618619 /// Switch back to pay-per-own-transaction model.620 ///621 /// # Permissions622 ///623 /// * Collection owner.624 ///625 /// # Arguments626 ///627 /// * collection_id.628 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]629 #[transactional]630 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {631 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);632633 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;634 target_collection.check_is_owner(&sender)?;635636 target_collection.sponsorship = SponsorshipState::Disabled;637638 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(639 collection_id640 ));641 target_collection.save()642 }643644 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.645 ///646 /// # Permissions647 ///648 /// * Collection Owner.649 /// * Collection Admin.650 /// * Anyone if651 /// * Allow List is enabled, and652 /// * Address is added to allow list, and653 /// * MintPermission is enabled (see SetMintPermission method)654 ///655 /// # Arguments656 ///657 /// * collection_id: ID of the collection.658 ///659 /// * owner: Address, initial owner of the NFT.660 ///661 /// * data: Token data to store on chain.662 #[weight = T::CommonWeightInfo::create_item()]663 #[transactional]664 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {665 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);666 let budget = budget::Value::new(2);667668 dispatch_call::<T, _>(collection_id, |d| d.create_item(sender, owner, data, &budget))669 }670671 /// This method creates multiple items in a collection created with CreateCollection method.672 ///673 /// # Permissions674 ///675 /// * Collection Owner.676 /// * Collection Admin.677 /// * Anyone if678 /// * Allow List is enabled, and679 /// * Address is added to allow list, and680 /// * MintPermission is enabled (see SetMintPermission method)681 ///682 /// # Arguments683 ///684 /// * collection_id: ID of the collection.685 ///686 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].687 ///688 /// * owner: Address, initial owner of the NFT.689 #[weight = T::CommonWeightInfo::create_multiple_items(items_data.len() as u32)]690 #[transactional]691 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {692 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);693 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);694 let budget = budget::Value::new(2);695696 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data, &budget))697 }698699 #[weight = T::CommonWeightInfo::set_collection_properties(properties.len() as u32)]700 #[transactional]701 pub fn set_collection_properties(702 origin,703 collection_id: CollectionId,704 properties: Vec<Property>705 ) -> DispatchResultWithPostInfo {706 ensure!(!properties.is_empty(), Error::<T>::EmptyArgument);707708 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);709710 dispatch_call::<T, _>(collection_id, |d| d.set_collection_properties(sender, properties))711 }712713 #[weight = T::CommonWeightInfo::delete_collection_properties(property_keys.len() as u32)]714 #[transactional]715 pub fn delete_collection_properties(716 origin,717 collection_id: CollectionId,718 property_keys: Vec<PropertyKey>,719 ) -> DispatchResultWithPostInfo {720 ensure!(!property_keys.is_empty(), Error::<T>::EmptyArgument);721722 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);723724 dispatch_call::<T, _>(collection_id, |d| d.delete_collection_properties(&sender, property_keys))725 }726727 #[weight = T::CommonWeightInfo::set_token_properties(properties.len() as u32)]728 #[transactional]729 pub fn set_token_properties(730 origin,731 collection_id: CollectionId,732 token_id: TokenId,733 properties: Vec<Property>734 ) -> DispatchResultWithPostInfo {735 ensure!(!properties.is_empty(), Error::<T>::EmptyArgument);736737 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);738739 dispatch_call::<T, _>(collection_id, |d| d.set_token_properties(sender, token_id, properties))740 }741742 #[weight = T::CommonWeightInfo::delete_token_properties(property_keys.len() as u32)]743 #[transactional]744 pub fn delete_token_properties(745 origin,746 collection_id: CollectionId,747 token_id: TokenId,748 property_keys: Vec<PropertyKey>749 ) -> DispatchResultWithPostInfo {750 ensure!(!property_keys.is_empty(), Error::<T>::EmptyArgument);751752 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);753754 dispatch_call::<T, _>(collection_id, |d| d.delete_token_properties(sender, token_id, property_keys))755 }756757 #[weight = T::CommonWeightInfo::set_property_permissions(property_permissions.len() as u32)]758 #[transactional]759 pub fn set_property_permissions(760 origin,761 collection_id: CollectionId,762 property_permissions: Vec<PropertyKeyPermission>,763 ) -> DispatchResultWithPostInfo {764 ensure!(!property_permissions.is_empty(), Error::<T>::EmptyArgument);765766 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);767768 dispatch_call::<T, _>(collection_id, |d| d.set_property_permissions(&sender, property_permissions))769 }770771 #[weight = T::CommonWeightInfo::create_multiple_items_ex(&data)]772 #[transactional]773 pub fn create_multiple_items_ex(origin, collection_id: CollectionId, data: CreateItemExData<T::CrossAccountId>) -> DispatchResultWithPostInfo {774 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);775 let budget = budget::Value::new(2);776777 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items_ex(sender, data, &budget))778 }779780 // TODO! transaction weight781782 /// Set transfers_enabled value for particular collection783 ///784 /// # Permissions785 ///786 /// * Collection Owner.787 ///788 /// # Arguments789 ///790 /// * collection_id: ID of the collection.791 ///792 /// * value: New flag value.793 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]794 #[transactional]795 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {796 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);797 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;798 target_collection.check_is_owner(&sender)?;799800 // =========801802 target_collection.limits.transfers_enabled = Some(value);803 target_collection.save()804 }805806 /// Destroys a concrete instance of NFT.807 ///808 /// # Permissions809 ///810 /// * Collection Owner.811 /// * Collection Admin.812 /// * Current NFT Owner.813 ///814 /// # Arguments815 ///816 /// * collection_id: ID of the collection.817 ///818 /// * item_id: ID of NFT to burn.819 #[weight = T::CommonWeightInfo::burn_item()]820 #[transactional]821 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {822 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);823824 let post_info = dispatch_call::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))?;825 if value == 1 {826 <NftTransferBasket<T>>::remove(collection_id, item_id);827 <NftApproveBasket<T>>::remove(collection_id, item_id);828 }829 // Those maps should be cleared only if token disappears completly, need to move this part of logic to pallets?830 // <FungibleApproveBasket<T>>::remove(collection_id, sender.as_sub());831 // <RefungibleApproveBasket<T>>::remove((collection_id, item_id, sender.as_sub()));832 Ok(post_info)833 }834835 /// Destroys a concrete instance of NFT on behalf of the owner836 /// See also: [`approve`]837 ///838 /// # Permissions839 ///840 /// * Collection Owner.841 /// * Collection Admin.842 /// * Current NFT Owner.843 ///844 /// # Arguments845 ///846 /// * collection_id: ID of the collection.847 ///848 /// * item_id: ID of NFT to burn.849 ///850 /// * from: owner of item851 #[weight = T::CommonWeightInfo::burn_from()]852 #[transactional]853 pub fn burn_from(origin, collection_id: CollectionId, from: T::CrossAccountId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {854 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);855 let budget = budget::Value::new(2);856857 dispatch_call::<T, _>(collection_id, |d| d.burn_from(sender, from, item_id, value, &budget))858 }859860 /// Change ownership of the token.861 ///862 /// # Permissions863 ///864 /// * Collection Owner865 /// * Collection Admin866 /// * Current NFT owner867 ///868 /// # Arguments869 ///870 /// * recipient: Address of token recipient.871 ///872 /// * collection_id.873 ///874 /// * item_id: ID of the item875 /// * Non-Fungible Mode: Required.876 /// * Fungible Mode: Ignored.877 /// * Re-Fungible Mode: Required.878 ///879 /// * value: Amount to transfer.880 /// * Non-Fungible Mode: Ignored881 /// * Fungible Mode: Must specify transferred amount882 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)883 #[weight = T::CommonWeightInfo::transfer()]884 #[transactional]885 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {886 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);887 let budget = budget::Value::new(2);888889 dispatch_call::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value, &budget))890 }891892 /// Set, change, or remove approved address to transfer the ownership of the NFT.893 ///894 /// # Permissions895 ///896 /// * Collection Owner897 /// * Collection Admin898 /// * Current NFT owner899 ///900 /// # Arguments901 ///902 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).903 ///904 /// * collection_id.905 ///906 /// * item_id: ID of the item.907 #[weight = T::CommonWeightInfo::approve()]908 #[transactional]909 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {910 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);911912 dispatch_call::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))913 }914915 /// Change ownership of a NFT on behalf of the owner. See Approve method for additional information. After this method executes, the approval is removed so that the approved address will not be able to transfer this NFT again from this owner.916 ///917 /// # Permissions918 /// * Collection Owner919 /// * Collection Admin920 /// * Current NFT owner921 /// * Address approved by current NFT owner922 ///923 /// # Arguments924 ///925 /// * from: Address that owns token.926 ///927 /// * recipient: Address of token recipient.928 ///929 /// * collection_id.930 ///931 /// * item_id: ID of the item.932 ///933 /// * value: Amount to transfer.934 #[weight = T::CommonWeightInfo::transfer_from()]935 #[transactional]936 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {937 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);938 let budget = budget::Value::new(2);939940 dispatch_call::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value, &budget))941 }942943 /// Set schema standard944 /// ImageURL945 /// Unique946 ///947 /// # Permissions948 ///949 /// * Collection Owner950 /// * Collection Admin951 ///952 /// # Arguments953 ///954 /// * collection_id.955 ///956 /// * schema: SchemaVersion: enum957 #[weight = <SelfWeightOf<T>>::set_schema_version()]958 #[transactional]959 pub fn set_schema_version(960 origin,961 collection_id: CollectionId,962 version: SchemaVersion963 ) -> DispatchResult {964 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);965 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;966 target_collection.check_is_owner_or_admin(&sender)?;967 target_collection.schema_version = version;968969 <Pallet<T>>::deposit_event(Event::<T>::SchemaVersionSet(970 collection_id971 ));972973 target_collection.save()974 }975976 /// Set off-chain data schema.977 ///978 /// # Permissions979 ///980 /// * Collection Owner981 /// * Collection Admin982 ///983 /// # Arguments984 ///985 /// * collection_id.986 ///987 /// * schema: String representing the offchain data schema.988 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]989 #[transactional]990 pub fn set_offchain_schema(991 origin,992 collection_id: CollectionId,993 schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,994 ) -> DispatchResult {995 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);996 let collection = <CollectionHandle<T>>::try_get(collection_id)?;997998 // =========9991000 <PalletCommon<T>>::set_field(&collection, &sender, CollectionField::OffchainSchema, schema.into_inner())?;10011002 <Pallet<T>>::deposit_event(Event::<T>::OffchainSchemaSet(1003 collection_id1004 ));1005 Ok(())1006 }10071008 /// Set const on-chain data schema.1009 ///1010 /// # Permissions1011 ///1012 /// * Collection Owner1013 /// * Collection Admin1014 ///1015 /// # Arguments1016 ///1017 /// * collection_id.1018 ///1019 /// * schema: String representing the const on-chain data schema.1020 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1021 #[transactional]1022 pub fn set_const_on_chain_schema (1023 origin,1024 collection_id: CollectionId,1025 schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>1026 ) -> DispatchResult {1027 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1028 let collection = <CollectionHandle<T>>::try_get(collection_id)?;10291030 // =========10311032 <PalletCommon<T>>::set_field(&collection, &sender, CollectionField::ConstOnChainSchema, schema.into_inner())?;10331034 <Pallet<T>>::deposit_event(Event::<T>::ConstOnChainSchemaSet(1035 collection_id1036 ));1037 Ok(())1038 }10391040 #[weight = <SelfWeightOf<T>>::set_collection_limits()]1041 #[transactional]1042 pub fn set_collection_limits(1043 origin,1044 collection_id: CollectionId,1045 new_limit: CollectionLimits,1046 ) -> DispatchResult {1047 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1048 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1049 target_collection.check_is_owner(&sender)?;1050 let old_limit = &target_collection.limits;10511052 target_collection.limits = <PalletCommon<T>>::clamp_limits(target_collection.mode.clone(), &old_limit, new_limit)?;10531054 <Pallet<T>>::deposit_event(Event::<T>::CollectionLimitSet(1055 collection_id1056 ));10571058 target_collection.save()1059 }1060 }1061}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#![recursion_limit = "1024"]18#![cfg_attr(not(feature = "std"), no_std)]19#![allow(20 clippy::too_many_arguments,21 clippy::unnecessary_mut_passed,22 clippy::unused_unit23)]2425use frame_support::{26 decl_module, decl_storage, decl_error, decl_event,27 dispatch::DispatchResult,28 ensure,29 weights::{Weight},30 transactional,31 pallet_prelude::{DispatchResultWithPostInfo, ConstU32},32 BoundedVec,33};34use scale_info::TypeInfo;35use frame_system::{self as system, ensure_signed};36use sp_runtime::{sp_std::prelude::Vec};37use up_data_structs::{38 CONST_ON_CHAIN_SCHEMA_LIMIT, OFFCHAIN_SCHEMA_LIMIT, MAX_COLLECTION_NAME_LENGTH,39 MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH, AccessMode, CreateItemData,40 CollectionLimits, CollectionId, CollectionMode, TokenId, SchemaVersion, SponsorshipState,41 CreateCollectionData, CreateItemExData, budget, CollectionField, Property, PropertyKey,42 PropertyKeyPermission,43};44use pallet_evm::account::CrossAccountId;45use pallet_common::{46 CollectionHandle, Pallet as PalletCommon, CommonWeightInfo, dispatch::dispatch_call,47 dispatch::CollectionDispatch,48};4950#[cfg(feature = "runtime-benchmarks")]51mod benchmarking;52pub mod weights;53use weights::WeightInfo;5455decl_error! {56 /// Error for non-fungible-token module.57 pub enum Error for Module<T: Config> {58 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.59 CollectionDecimalPointLimitExceeded,60 /// This address is not set as sponsor, use setCollectionSponsor first.61 ConfirmUnsetSponsorFail,62 /// Length of items properties must be greater than 0.63 EmptyArgument,64 }65}6667pub trait Config: system::Config + pallet_common::Config + Sized + TypeInfo {68 type Event: From<Event<Self>> + Into<<Self as frame_system::Config>::Event>;6970 /// Weight information for extrinsics in this pallet.71 type WeightInfo: WeightInfo;72 type CommonWeightInfo: CommonWeightInfo<Self::CrossAccountId>;73}7475decl_event! {76 pub enum Event<T>77 where78 <T as frame_system::Config>::AccountId,79 <T as pallet_evm::account::Config>::CrossAccountId,80 {81 /// Collection sponsor was removed82 ///83 /// # Arguments84 ///85 /// * collection_id: Globally unique collection identifier.86 CollectionSponsorRemoved(CollectionId),8788 /// Collection admin was added89 ///90 /// # Arguments91 ///92 /// * collection_id: Globally unique collection identifier.93 ///94 /// * admin: Admin address.95 CollectionAdminAdded(CollectionId, CrossAccountId),9697 /// Collection owned was change98 ///99 /// # Arguments100 ///101 /// * collection_id: Globally unique collection identifier.102 ///103 /// * owner: New owner address.104 CollectionOwnedChanged(CollectionId, AccountId),105106 /// Collection sponsor was set107 ///108 /// # Arguments109 ///110 /// * collection_id: Globally unique collection identifier.111 ///112 /// * owner: New sponsor address.113 CollectionSponsorSet(CollectionId, AccountId),114115 /// const on chain schema was set116 ///117 /// # Arguments118 ///119 /// * collection_id: Globally unique collection identifier.120 ConstOnChainSchemaSet(CollectionId),121122 /// New sponsor was confirm123 ///124 /// # Arguments125 ///126 /// * collection_id: Globally unique collection identifier.127 ///128 /// * sponsor: New sponsor address.129 SponsorshipConfirmed(CollectionId, AccountId),130131 /// Collection admin was removed132 ///133 /// # Arguments134 ///135 /// * collection_id: Globally unique collection identifier.136 ///137 /// * admin: Admin address.138 CollectionAdminRemoved(CollectionId, CrossAccountId),139140 /// Address was remove from allow list141 ///142 /// # Arguments143 ///144 /// * collection_id: Globally unique collection identifier.145 ///146 /// * user: Address.147 AllowListAddressRemoved(CollectionId, CrossAccountId),148149 /// Address was add to allow list150 ///151 /// # Arguments152 ///153 /// * collection_id: Globally unique collection identifier.154 ///155 /// * user: Address.156 AllowListAddressAdded(CollectionId, CrossAccountId),157158 /// Collection limits was set159 ///160 /// # Arguments161 ///162 /// * collection_id: Globally unique collection identifier.163 CollectionLimitSet(CollectionId),164165 /// Mint permission was set166 ///167 /// # Arguments168 ///169 /// * collection_id: Globally unique collection identifier.170 MintPermissionSet(CollectionId),171172 /// Offchain schema was set173 ///174 /// # Arguments175 ///176 /// * collection_id: Globally unique collection identifier.177 OffchainSchemaSet(CollectionId),178179 /// Public access mode was set180 ///181 /// # Arguments182 ///183 /// * collection_id: Globally unique collection identifier.184 ///185 /// * mode: New access state.186 PublicAccessModeSet(CollectionId, AccessMode),187188 /// Schema version was set189 ///190 /// # Arguments191 ///192 /// * collection_id: Globally unique collection identifier.193 SchemaVersionSet(CollectionId),194 }195}196197type SelfWeightOf<T> = <T as Config>::WeightInfo;198199// # Used definitions200//201// ## User control levels202//203// chain-controlled - key is uncontrolled by user204// i.e autoincrementing index205// can use non-cryptographic hash206// real - key is controlled by user207// but it is hard to generate enough colliding values, i.e owner of signed txs208// can use non-cryptographic hash209// controlled - key is completly controlled by users210// i.e maps with mutable keys211// should use cryptographic hash212//213// ## User control level downgrade reasons214//215// ?1 - chain-controlled -> controlled216// collections/tokens can be destroyed, resulting in massive holes217// ?2 - chain-controlled -> controlled218// same as ?1, but can be only added, resulting in easier exploitation219// ?3 - real -> controlled220// no confirmation required, so addresses can be easily generated221decl_storage! {222 trait Store for Module<T: Config> as Unique {223224 //#region Private members225 /// Used for migrations226 ChainVersion: u64;227 //#endregion228229 //#region Tokens transfer rate limit baskets230 /// (Collection id (controlled?2), who created (real))231 /// TODO: Off chain worker should remove from this map when collection gets removed232 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => Option<T::BlockNumber>;233 /// Collection id (controlled?2), token id (controlled?2)234 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;235 /// Collection id (controlled?2), owning user (real)236 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;237 /// Collection id (controlled?2), token id (controlled?2)238 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;239 //#endregion240241 /// Variable metadata sponsoring242 /// Collection id (controlled?2), token id (controlled?2)243 #[deprecated]244 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;245 pub TokenPropertyBasket get(fn token_property_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;246247 /// Approval sponsoring248 pub NftApproveBasket get(fn nft_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;249 pub FungibleApproveBasket get(fn fungible_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;250 pub RefungibleApproveBasket get(fn refungible_approve_basket): nmap hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;251 }252}253254decl_module! {255 pub struct Module<T: Config> for enum Call256 where257 origin: T::Origin258 {259 type Error = Error<T>;260261 fn deposit_event() = default;262263 fn on_initialize(_now: T::BlockNumber) -> Weight {264 0265 }266267 fn on_runtime_upgrade() -> Weight {268 let limit = None;269270 <VariableMetaDataBasket<T>>::remove_all(limit);271272 0273 }274275 /// This method creates a Collection of NFTs. Each Token may have multiple properties encoded as an array of bytes of certain length. The initial owner of the collection is set to the address that signed the transaction and can be changed later.276 ///277 /// # Permissions278 ///279 /// * Anyone.280 ///281 /// # Arguments282 ///283 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.284 ///285 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.286 ///287 /// * token_prefix: UTF-8 string with token prefix.288 ///289 /// * mode: [CollectionMode] collection type and type dependent data.290 // returns collection ID291 #[weight = <SelfWeightOf<T>>::create_collection()]292 #[transactional]293 #[deprecated]294 pub fn create_collection(origin,295 collection_name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,296 collection_description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,297 token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,298 mode: CollectionMode) -> DispatchResult {299 let data: CreateCollectionData<T::AccountId> = CreateCollectionData {300 name: collection_name,301 description: collection_description,302 token_prefix,303 mode,304 ..Default::default()305 };306 Self::create_collection_ex(origin, data)307 }308309 /// This method creates a collection310 ///311 /// Prefer it to deprecated [`created_collection`] method312 #[weight = <SelfWeightOf<T>>::create_collection()]313 #[transactional]314 pub fn create_collection_ex(origin, data: CreateCollectionData<T::AccountId>) -> DispatchResult {315 let sender = ensure_signed(origin)?;316317 // =========318319 T::CollectionDispatch::create(sender, data)?;320321 Ok(())322 }323324 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.325 ///326 /// # Permissions327 ///328 /// * Collection Owner.329 ///330 /// # Arguments331 ///332 /// * collection_id: collection to destroy.333 #[weight = <SelfWeightOf<T>>::destroy_collection()]334 #[transactional]335 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {336 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);337 let collection = <CollectionHandle<T>>::try_get(collection_id)?;338339 // =========340341 T::CollectionDispatch::destroy(sender, collection)?;342343 <NftTransferBasket<T>>::remove_prefix(collection_id, None);344 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);345 <ReFungibleTransferBasket<T>>::remove_prefix((collection_id,), None);346347 <NftApproveBasket<T>>::remove_prefix(collection_id, None);348 <FungibleApproveBasket<T>>::remove_prefix(collection_id, None);349 <RefungibleApproveBasket<T>>::remove_prefix((collection_id,), None);350351 Ok(())352 }353354 /// Add an address to allow list.355 ///356 /// # Permissions357 ///358 /// * Collection Owner359 /// * Collection Admin360 ///361 /// # Arguments362 ///363 /// * collection_id.364 ///365 /// * address.366 #[weight = <SelfWeightOf<T>>::add_to_allow_list()]367 #[transactional]368 pub fn add_to_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{369370 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);371 let collection = <CollectionHandle<T>>::try_get(collection_id)?;372373 <PalletCommon<T>>::toggle_allowlist(374 &collection,375 &sender,376 &address,377 true,378 )?;379380 Self::deposit_event(Event::<T>::AllowListAddressAdded(381 collection_id,382 address383 ));384385 Ok(())386 }387388 /// Remove an address from allow list.389 ///390 /// # Permissions391 ///392 /// * Collection Owner393 /// * Collection Admin394 ///395 /// # Arguments396 ///397 /// * collection_id.398 ///399 /// * address.400 #[weight = <SelfWeightOf<T>>::remove_from_allow_list()]401 #[transactional]402 pub fn remove_from_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{403404 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);405 let collection = <CollectionHandle<T>>::try_get(collection_id)?;406407 <PalletCommon<T>>::toggle_allowlist(408 &collection,409 &sender,410 &address,411 false,412 )?;413414 <Pallet<T>>::deposit_event(Event::<T>::AllowListAddressRemoved(415 collection_id,416 address417 ));418419 Ok(())420 }421422 /// Toggle between normal and allow list access for the methods with access for `Anyone`.423 ///424 /// # Permissions425 ///426 /// * Collection Owner.427 ///428 /// # Arguments429 ///430 /// * collection_id.431 ///432 /// * mode: [AccessMode]433 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]434 #[transactional]435 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult436 {437 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);438439 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;440 target_collection.check_is_owner(&sender)?;441442 target_collection.access = mode.clone();443444 <Pallet<T>>::deposit_event(Event::<T>::PublicAccessModeSet(445 collection_id,446 mode447 ));448449 target_collection.save()450 }451452 /// Allows Anyone to create tokens if:453 /// * Allow List is enabled, and454 /// * Address is added to allow list, and455 /// * This method was called with True parameter456 ///457 /// # Permissions458 /// * Collection Owner459 ///460 /// # Arguments461 ///462 /// * collection_id.463 ///464 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.465 #[weight = <SelfWeightOf<T>>::set_mint_permission()]466 #[transactional]467 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult468 {469 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);470471 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;472 target_collection.check_is_owner(&sender)?;473474 target_collection.mint_mode = mint_permission;475476 <Pallet<T>>::deposit_event(Event::<T>::MintPermissionSet(477 collection_id478 ));479480 target_collection.save()481 }482483 /// Change the owner of the collection.484 ///485 /// # Permissions486 ///487 /// * Collection Owner.488 ///489 /// # Arguments490 ///491 /// * collection_id.492 ///493 /// * new_owner.494 #[weight = <SelfWeightOf<T>>::change_collection_owner()]495 #[transactional]496 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {497498 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);499500 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;501 target_collection.check_is_owner(&sender)?;502503 target_collection.owner = new_owner.clone();504 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnedChanged(505 collection_id,506 new_owner507 ));508509 target_collection.save()510 }511512 /// Adds an admin of the Collection.513 /// NFT Collection can be controlled by multiple admin addresses (some which can also be servers, for example). Admins can issue and burn NFTs, as well as add and remove other admins, but cannot change NFT or Collection ownership.514 ///515 /// # Permissions516 ///517 /// * Collection Owner.518 /// * Collection Admin.519 ///520 /// # Arguments521 ///522 /// * collection_id: ID of the Collection to add admin for.523 ///524 /// * new_admin_id: Address of new admin to add.525 #[weight = <SelfWeightOf<T>>::add_collection_admin()]526 #[transactional]527 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {528 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);529 let collection = <CollectionHandle<T>>::try_get(collection_id)?;530531 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminAdded(532 collection_id,533 new_admin_id.clone()534 ));535536 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin_id, true)537 }538539 /// Remove admin address of the Collection. An admin address can remove itself. List of admins may become empty, in which case only Collection Owner will be able to add an Admin.540 ///541 /// # Permissions542 ///543 /// * Collection Owner.544 /// * Collection Admin.545 ///546 /// # Arguments547 ///548 /// * collection_id: ID of the Collection to remove admin for.549 ///550 /// * account_id: Address of admin to remove.551 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]552 #[transactional]553 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {554 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);555 let collection = <CollectionHandle<T>>::try_get(collection_id)?;556557 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminRemoved(558 collection_id,559 account_id.clone()560 ));561562 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)563 }564565 /// # Permissions566 ///567 /// * Collection Owner568 ///569 /// # Arguments570 ///571 /// * collection_id.572 ///573 /// * new_sponsor.574 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]575 #[transactional]576 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {577 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);578579 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;580 target_collection.check_is_owner(&sender)?;581582 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor.clone());583584 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(585 collection_id,586 new_sponsor587 ));588589 target_collection.save()590 }591592 /// # Permissions593 ///594 /// * Sponsor.595 ///596 /// # Arguments597 ///598 /// * collection_id.599 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]600 #[transactional]601 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {602 let sender = ensure_signed(origin)?;603604 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;605 ensure!(606 target_collection.sponsorship.pending_sponsor() == Some(&sender),607 Error::<T>::ConfirmUnsetSponsorFail608 );609610 target_collection.sponsorship = SponsorshipState::Confirmed(sender.clone());611612 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(613 collection_id,614 sender615 ));616617 target_collection.save()618 }619620 /// Switch back to pay-per-own-transaction model.621 ///622 /// # Permissions623 ///624 /// * Collection owner.625 ///626 /// # Arguments627 ///628 /// * collection_id.629 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]630 #[transactional]631 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {632 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);633634 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;635 target_collection.check_is_owner(&sender)?;636637 target_collection.sponsorship = SponsorshipState::Disabled;638639 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(640 collection_id641 ));642 target_collection.save()643 }644645 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.646 ///647 /// # Permissions648 ///649 /// * Collection Owner.650 /// * Collection Admin.651 /// * Anyone if652 /// * Allow List is enabled, and653 /// * Address is added to allow list, and654 /// * MintPermission is enabled (see SetMintPermission method)655 ///656 /// # Arguments657 ///658 /// * collection_id: ID of the collection.659 ///660 /// * owner: Address, initial owner of the NFT.661 ///662 /// * data: Token data to store on chain.663 #[weight = T::CommonWeightInfo::create_item()]664 #[transactional]665 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {666 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);667 let budget = budget::Value::new(2);668669 dispatch_call::<T, _>(collection_id, |d| d.create_item(sender, owner, data, &budget))670 }671672 /// This method creates multiple items in a collection created with CreateCollection method.673 ///674 /// # Permissions675 ///676 /// * Collection Owner.677 /// * Collection Admin.678 /// * Anyone if679 /// * Allow List is enabled, and680 /// * Address is added to allow list, and681 /// * MintPermission is enabled (see SetMintPermission method)682 ///683 /// # Arguments684 ///685 /// * collection_id: ID of the collection.686 ///687 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].688 ///689 /// * owner: Address, initial owner of the NFT.690 #[weight = T::CommonWeightInfo::create_multiple_items(items_data.len() as u32)]691 #[transactional]692 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {693 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);694 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);695 let budget = budget::Value::new(2);696697 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data, &budget))698 }699700 #[weight = T::CommonWeightInfo::set_collection_properties(properties.len() as u32)]701 #[transactional]702 pub fn set_collection_properties(703 origin,704 collection_id: CollectionId,705 properties: Vec<Property>706 ) -> DispatchResultWithPostInfo {707 ensure!(!properties.is_empty(), Error::<T>::EmptyArgument);708709 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);710711 dispatch_call::<T, _>(collection_id, |d| d.set_collection_properties(sender, properties))712 }713714 #[weight = T::CommonWeightInfo::delete_collection_properties(property_keys.len() as u32)]715 #[transactional]716 pub fn delete_collection_properties(717 origin,718 collection_id: CollectionId,719 property_keys: Vec<PropertyKey>,720 ) -> DispatchResultWithPostInfo {721 ensure!(!property_keys.is_empty(), Error::<T>::EmptyArgument);722723 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);724725 dispatch_call::<T, _>(collection_id, |d| d.delete_collection_properties(&sender, property_keys))726 }727728 #[weight = T::CommonWeightInfo::set_token_properties(properties.len() as u32)]729 #[transactional]730 pub fn set_token_properties(731 origin,732 collection_id: CollectionId,733 token_id: TokenId,734 properties: Vec<Property>735 ) -> DispatchResultWithPostInfo {736 ensure!(!properties.is_empty(), Error::<T>::EmptyArgument);737738 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);739740 dispatch_call::<T, _>(collection_id, |d| d.set_token_properties(sender, token_id, properties))741 }742743 #[weight = T::CommonWeightInfo::delete_token_properties(property_keys.len() as u32)]744 #[transactional]745 pub fn delete_token_properties(746 origin,747 collection_id: CollectionId,748 token_id: TokenId,749 property_keys: Vec<PropertyKey>750 ) -> DispatchResultWithPostInfo {751 ensure!(!property_keys.is_empty(), Error::<T>::EmptyArgument);752753 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);754755 dispatch_call::<T, _>(collection_id, |d| d.delete_token_properties(sender, token_id, property_keys))756 }757758 #[weight = T::CommonWeightInfo::set_property_permissions(property_permissions.len() as u32)]759 #[transactional]760 pub fn set_property_permissions(761 origin,762 collection_id: CollectionId,763 property_permissions: Vec<PropertyKeyPermission>,764 ) -> DispatchResultWithPostInfo {765 ensure!(!property_permissions.is_empty(), Error::<T>::EmptyArgument);766767 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);768769 dispatch_call::<T, _>(collection_id, |d| d.set_property_permissions(&sender, property_permissions))770 }771772 #[weight = T::CommonWeightInfo::create_multiple_items_ex(&data)]773 #[transactional]774 pub fn create_multiple_items_ex(origin, collection_id: CollectionId, data: CreateItemExData<T::CrossAccountId>) -> DispatchResultWithPostInfo {775 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);776 let budget = budget::Value::new(2);777778 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items_ex(sender, data, &budget))779 }780781 // TODO! transaction weight782783 /// Set transfers_enabled value for particular collection784 ///785 /// # Permissions786 ///787 /// * Collection Owner.788 ///789 /// # Arguments790 ///791 /// * collection_id: ID of the collection.792 ///793 /// * value: New flag value.794 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]795 #[transactional]796 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {797 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);798 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;799 target_collection.check_is_owner(&sender)?;800801 // =========802803 target_collection.limits.transfers_enabled = Some(value);804 target_collection.save()805 }806807 /// Destroys a concrete instance of NFT.808 ///809 /// # Permissions810 ///811 /// * Collection Owner.812 /// * Collection Admin.813 /// * Current NFT Owner.814 ///815 /// # Arguments816 ///817 /// * collection_id: ID of the collection.818 ///819 /// * item_id: ID of NFT to burn.820 #[weight = T::CommonWeightInfo::burn_item()]821 #[transactional]822 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {823 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);824825 let post_info = dispatch_call::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))?;826 if value == 1 {827 <NftTransferBasket<T>>::remove(collection_id, item_id);828 <NftApproveBasket<T>>::remove(collection_id, item_id);829 }830 // Those maps should be cleared only if token disappears completly, need to move this part of logic to pallets?831 // <FungibleApproveBasket<T>>::remove(collection_id, sender.as_sub());832 // <RefungibleApproveBasket<T>>::remove((collection_id, item_id, sender.as_sub()));833 Ok(post_info)834 }835836 /// Destroys a concrete instance of NFT on behalf of the owner837 /// See also: [`approve`]838 ///839 /// # Permissions840 ///841 /// * Collection Owner.842 /// * Collection Admin.843 /// * Current NFT Owner.844 ///845 /// # Arguments846 ///847 /// * collection_id: ID of the collection.848 ///849 /// * item_id: ID of NFT to burn.850 ///851 /// * from: owner of item852 #[weight = T::CommonWeightInfo::burn_from()]853 #[transactional]854 pub fn burn_from(origin, collection_id: CollectionId, from: T::CrossAccountId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {855 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);856 let budget = budget::Value::new(2);857858 dispatch_call::<T, _>(collection_id, |d| d.burn_from(sender, from, item_id, value, &budget))859 }860861 /// Change ownership of the token.862 ///863 /// # Permissions864 ///865 /// * Collection Owner866 /// * Collection Admin867 /// * Current NFT owner868 ///869 /// # Arguments870 ///871 /// * recipient: Address of token recipient.872 ///873 /// * collection_id.874 ///875 /// * item_id: ID of the item876 /// * Non-Fungible Mode: Required.877 /// * Fungible Mode: Ignored.878 /// * Re-Fungible Mode: Required.879 ///880 /// * value: Amount to transfer.881 /// * Non-Fungible Mode: Ignored882 /// * Fungible Mode: Must specify transferred amount883 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)884 #[weight = T::CommonWeightInfo::transfer()]885 #[transactional]886 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {887 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);888 let budget = budget::Value::new(2);889890 dispatch_call::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value, &budget))891 }892893 /// Set, change, or remove approved address to transfer the ownership of the NFT.894 ///895 /// # Permissions896 ///897 /// * Collection Owner898 /// * Collection Admin899 /// * Current NFT owner900 ///901 /// # Arguments902 ///903 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).904 ///905 /// * collection_id.906 ///907 /// * item_id: ID of the item.908 #[weight = T::CommonWeightInfo::approve()]909 #[transactional]910 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {911 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);912913 dispatch_call::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))914 }915916 /// Change ownership of a NFT on behalf of the owner. See Approve method for additional information. After this method executes, the approval is removed so that the approved address will not be able to transfer this NFT again from this owner.917 ///918 /// # Permissions919 /// * Collection Owner920 /// * Collection Admin921 /// * Current NFT owner922 /// * Address approved by current NFT owner923 ///924 /// # Arguments925 ///926 /// * from: Address that owns token.927 ///928 /// * recipient: Address of token recipient.929 ///930 /// * collection_id.931 ///932 /// * item_id: ID of the item.933 ///934 /// * value: Amount to transfer.935 #[weight = T::CommonWeightInfo::transfer_from()]936 #[transactional]937 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {938 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);939 let budget = budget::Value::new(2);940941 dispatch_call::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value, &budget))942 }943944 /// Set schema standard945 /// ImageURL946 /// Unique947 ///948 /// # Permissions949 ///950 /// * Collection Owner951 /// * Collection Admin952 ///953 /// # Arguments954 ///955 /// * collection_id.956 ///957 /// * schema: SchemaVersion: enum958 #[weight = <SelfWeightOf<T>>::set_schema_version()]959 #[transactional]960 pub fn set_schema_version(961 origin,962 collection_id: CollectionId,963 version: SchemaVersion964 ) -> DispatchResult {965 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);966 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;967 target_collection.check_is_owner_or_admin(&sender)?;968 target_collection.schema_version = version;969970 <Pallet<T>>::deposit_event(Event::<T>::SchemaVersionSet(971 collection_id972 ));973974 target_collection.save()975 }976977 /// Set off-chain data schema.978 ///979 /// # Permissions980 ///981 /// * Collection Owner982 /// * Collection Admin983 ///984 /// # Arguments985 ///986 /// * collection_id.987 ///988 /// * schema: String representing the offchain data schema.989 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]990 #[transactional]991 pub fn set_offchain_schema(992 origin,993 collection_id: CollectionId,994 schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,995 ) -> DispatchResult {996 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);997 let collection = <CollectionHandle<T>>::try_get(collection_id)?;998999 // =========10001001 <PalletCommon<T>>::set_field(&collection, &sender, CollectionField::OffchainSchema, schema.into_inner())?;10021003 <Pallet<T>>::deposit_event(Event::<T>::OffchainSchemaSet(1004 collection_id1005 ));1006 Ok(())1007 }10081009 /// Set const on-chain data schema.1010 ///1011 /// # Permissions1012 ///1013 /// * Collection Owner1014 /// * Collection Admin1015 ///1016 /// # Arguments1017 ///1018 /// * collection_id.1019 ///1020 /// * schema: String representing the const on-chain data schema.1021 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1022 #[transactional]1023 pub fn set_const_on_chain_schema (1024 origin,1025 collection_id: CollectionId,1026 schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>1027 ) -> DispatchResult {1028 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1029 let collection = <CollectionHandle<T>>::try_get(collection_id)?;10301031 // =========10321033 <PalletCommon<T>>::set_field(&collection, &sender, CollectionField::ConstOnChainSchema, schema.into_inner())?;10341035 <Pallet<T>>::deposit_event(Event::<T>::ConstOnChainSchemaSet(1036 collection_id1037 ));1038 Ok(())1039 }10401041 #[weight = <SelfWeightOf<T>>::set_collection_limits()]1042 #[transactional]1043 pub fn set_collection_limits(1044 origin,1045 collection_id: CollectionId,1046 new_limit: CollectionLimits,1047 ) -> DispatchResult {1048 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1049 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;1050 target_collection.check_is_owner(&sender)?;1051 let old_limit = &target_collection.limits;10521053 target_collection.limits = <PalletCommon<T>>::clamp_limits(target_collection.mode.clone(), &old_limit, new_limit)?;10541055 <Pallet<T>>::deposit_event(Event::<T>::CollectionLimitSet(1056 collection_id1057 ));10581059 target_collection.save()1060 }1061 }1062}runtime/common/src/eth_sponsoring.rsdiffbeforeafterboth--- a/runtime/common/src/eth_sponsoring.rs
+++ b/runtime/common/src/eth_sponsoring.rs
@@ -30,7 +30,7 @@
use crate::sponsoring::*;
use pallet_nonfungible::erc::{
- UniqueNFTCall, ERC721UniqueExtensionsCall, ERC721MintableCall, ERC721Call,
+ UniqueNFTCall, ERC721UniqueExtensionsCall, ERC721MintableCall, ERC721Call, TokenPropertiesCall,
};
use pallet_fungible::erc::{UniqueFungibleCall, ERC20Call};
use pallet_fungible::Config as FungibleConfig;
@@ -50,6 +50,17 @@
CollectionMode::NFT => {
let call = <UniqueNFTCall<T>>::parse(method_id, &mut reader).ok()??;
match call {
+ UniqueNFTCall::TokenProperties(
+ TokenPropertiesCall::SetProperty { token_id, key, value, .. },
+ ) => {
+ let token_id: TokenId = token_id.try_into().ok()?;
+ withdraw_set_token_property::<T>(
+ &collection,
+ &who,
+ &token_id,
+ key.len() + value.len(),
+ ).map(|()| sponsor)
+ }
UniqueNFTCall::ERC721UniqueExtensions(
ERC721UniqueExtensionsCall::Transfer { token_id, .. },
) => {
runtime/common/src/sponsoring.rsdiffbeforeafterboth--- a/runtime/common/src/sponsoring.rs
+++ b/runtime/common/src/sponsoring.rs
@@ -29,8 +29,8 @@
use pallet_evm::account::CrossAccountId;
use pallet_unique::{
Call as UniqueCall, Config as UniqueConfig, FungibleApproveBasket, RefungibleApproveBasket,
- NftApproveBasket, CreateItemBasket, ReFungibleTransferBasket, FungibleTransferBasket,
- NftTransferBasket,
+ NftApproveBasket, CreateItemBasket, ReFungibleTransferBasket,
+ FungibleTransferBasket, NftTransferBasket, TokenPropertyBasket,
};
use pallet_fungible::Config as FungibleConfig;
use pallet_nonfungible::Config as NonfungibleConfig;
@@ -39,6 +39,51 @@
pub trait Config: UniqueConfig + FungibleConfig + NonfungibleConfig + RefungibleConfig {}
impl<T> Config for T where T: UniqueConfig + FungibleConfig + NonfungibleConfig + RefungibleConfig {}
+// TODO: permission check?
+pub fn withdraw_set_token_property<T: Config>(
+ collection: &CollectionHandle<T>,
+ who: &T::CrossAccountId,
+ item_id: &TokenId,
+ data_size: usize,
+) -> Option<()> {
+ // preliminary sponsoring correctness check
+ match collection.mode {
+ CollectionMode::NFT => {
+ let owner = pallet_nonfungible::TokenData::<T>::get((collection.id, item_id))?.owner;
+ if !owner.conv_eq(who) {
+ return None;
+ }
+ }
+ CollectionMode::Fungible(_) => {
+ // Fungible tokens have no properties
+ return None;
+ }
+ CollectionMode::ReFungible => {
+ if !<pallet_refungible::Owned<T>>::get((collection.id, who, item_id)) {
+ return None;
+ }
+ }
+ }
+
+ if data_size > collection.limits.sponsored_data_size() as usize {
+ return None;
+ }
+
+ let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;
+ let limit = collection.limits.sponsored_data_rate_limit()?;
+
+ if let Some(last_tx_block) = TokenPropertyBasket::<T>::get(collection.id, item_id) {
+ let timeout = last_tx_block + limit.into();
+ if block_number < timeout {
+ return None;
+ }
+ }
+
+ <TokenPropertyBasket<T>>::insert(collection.id, item_id, block_number);
+
+ Some(())
+}
+
pub fn withdraw_transfer<T: Config>(
collection: &CollectionHandle<T>,
who: &T::CrossAccountId,
@@ -190,6 +235,22 @@
{
fn get_sponsor(who: &T::AccountId, call: &C) -> Option<T::AccountId> {
match IsSubType::<UniqueCall<T>>::is_sub_type(call)? {
+ UniqueCall::set_token_properties {
+ collection_id,
+ token_id,
+ properties,
+ ..
+ } => {
+ let (sponsor, collection) = load::<T>(*collection_id)?;
+ withdraw_set_token_property(
+ &collection,
+ &T::CrossAccountId::from_sub(who.clone()),
+ &token_id,
+ // No overflow may happen, as data larger than usize can't reach here
+ properties.iter().map(|p| p.key.len() + p.value.len()).sum()
+ )
+ .map(|()| sponsor)
+ }
UniqueCall::create_item {
collection_id,
data,