difftreelog
fix manage properties of nested tokens
in: master
7 files changed
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -1311,12 +1311,14 @@
sender: T::CrossAccountId,
token_id: TokenId,
property: Vec<Property>,
+ budget: &dyn Budget,
) -> DispatchResultWithPostInfo;
fn delete_token_properties(
&self,
sender: T::CrossAccountId,
token_id: TokenId,
property_keys: Vec<PropertyKey>,
+ budget: &dyn Budget,
) -> DispatchResultWithPostInfo;
fn set_token_property_permissions(
&self,
pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -298,6 +298,7 @@
_sender: T::CrossAccountId,
_token_id: TokenId,
_property: Vec<Property>,
+ _budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
fail!(<Error<T>>::SettingPropertiesNotAllowed)
}
@@ -315,6 +316,7 @@
_sender: T::CrossAccountId,
_token_id: TokenId,
_property_keys: Vec<PropertyKey>,
+ _budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
fail!(<Error<T>>::SettingPropertiesNotAllowed)
}
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -220,11 +220,12 @@
sender: T::CrossAccountId,
token_id: TokenId,
properties: Vec<Property>,
+ budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
let weight = <CommonWeights<T>>::set_token_properties(properties.len() as u32);
with_weight(
- <Pallet<T>>::set_token_properties(self, &sender, token_id, properties, false),
+ <Pallet<T>>::set_token_properties(self, &sender, token_id, properties, false, budget),
weight,
)
}
@@ -234,11 +235,12 @@
sender: T::CrossAccountId,
token_id: TokenId,
property_keys: Vec<PropertyKey>,
+ budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
let weight = <CommonWeights<T>>::delete_token_properties(property_keys.len() as u32);
with_weight(
- <Pallet<T>>::delete_token_properties(self, &sender, token_id, property_keys),
+ <Pallet<T>>::delete_token_properties(self, &sender, token_id, property_keys, budget),
weight,
)
}
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -38,6 +38,7 @@
use crate::{
AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,
SelfWeightOf, weights::WeightInfo, TokenProperties,
+ property_guard::PropertyGuard,
};
#[solidity_interface(name = "TokenProperties")]
@@ -82,14 +83,21 @@
.map_err(|_| "key too long")?;
let value = value.try_into().map_err(|_| "value too long")?;
- <Pallet<T>>::set_token_property(
+ let is_token_create = false;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let mut guard = PropertyGuard::new(
+ &caller,
self,
- &caller,
TokenId(token_id),
- Property { key, value },
- false,
- )
- .map_err(dispatch_to_evm::<T>)
+ is_token_create,
+ &budget,
+ );
+
+ <Pallet<T>>::set_token_property(Property { key, value }, &mut guard)
+ .map_err(dispatch_to_evm::<T>)
}
fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {
@@ -99,7 +107,20 @@
.try_into()
.map_err(|_| "key too long")?;
- <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key)
+ let is_token_create = false;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let mut guard = PropertyGuard::new(
+ &caller,
+ self,
+ TokenId(token_id),
+ is_token_create,
+ &budget,
+ );
+
+ <Pallet<T>>::delete_token_property(key, &mut guard)
.map_err(dispatch_to_evm::<T>)
}
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -52,6 +52,10 @@
pub mod erc;
pub mod weights;
+mod property_guard;
+
+use property_guard::*;
+
pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;
pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;
@@ -484,30 +488,18 @@
})
}
- pub fn set_token_property(
- collection: &NonfungibleHandle<T>,
- sender: &T::CrossAccountId,
- token_id: TokenId,
- property: Property,
- is_token_create: bool,
- ) -> DispatchResult {
- Self::check_token_change_permission(
- collection,
- sender,
- token_id,
- &property.key,
- is_token_create,
- )?;
+ pub fn set_token_property(property: Property, guard: &mut PropertyGuard<'_, T>) -> DispatchResult {
+ Self::check_token_change_permission(&property.key, guard)?;
- <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
+ <TokenProperties<T>>::try_mutate((guard.collection.id, guard.token), |properties| {
let property = property.clone();
properties.try_set(property.key, property.value)
})
.map_err(<CommonError<T>>::from)?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(
- collection.id,
- token_id,
+ guard.collection.id,
+ guard.token,
property.key,
));
@@ -521,57 +513,47 @@
token_id: TokenId,
properties: Vec<Property>,
is_token_create: bool,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
+ let mut guard = PropertyGuard::new(
+ sender,
+ collection,
+ token_id,
+ is_token_create,
+ nesting_budget,
+ );
+
for property in properties {
- Self::set_token_property(collection, sender, token_id, property, is_token_create)?;
+ Self::set_token_property(property, &mut guard)?;
}
Ok(())
}
- pub fn delete_token_property(
- collection: &NonfungibleHandle<T>,
- sender: &T::CrossAccountId,
- token_id: TokenId,
- property_key: PropertyKey,
- ) -> DispatchResult {
- Self::check_token_change_permission(collection, sender, token_id, &property_key, false)?;
+ pub fn delete_token_property(property_key: PropertyKey, guard: &mut PropertyGuard<'_, T>) -> DispatchResult {
+ Self::check_token_change_permission(&property_key, guard)?;
- <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
+ <TokenProperties<T>>::try_mutate((guard.collection.id, guard.token), |properties| {
properties.remove(&property_key)
})
.map_err(<CommonError<T>>::from)?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(
- collection.id,
- token_id,
+ guard.collection.id,
+ guard.token,
property_key,
));
Ok(())
}
- fn check_token_change_permission(
- collection: &NonfungibleHandle<T>,
- sender: &T::CrossAccountId,
- token_id: TokenId,
- property_key: &PropertyKey,
- is_token_create: bool,
- ) -> DispatchResult {
- let permission = <PalletCommon<T>>::property_permissions(collection.id)
+ fn check_token_change_permission(property_key: &PropertyKey, guard: &mut PropertyGuard<'_, T>) -> DispatchResult {
+ let permission = <PalletCommon<T>>::property_permissions(guard.collection.id)
.get(property_key)
.cloned()
.unwrap_or_else(PropertyPermission::none);
- let token_data = <TokenData<T>>::get((collection.id, token_id))
- .ok_or(<CommonError<T>>::TokenNotFound)?;
-
- let check_token_owner = || -> DispatchResult {
- ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);
- Ok(())
- };
-
- let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))
+ let is_property_exists = TokenProperties::<T>::get((guard.collection.id, guard.token))
.get(property_key)
.is_some();
@@ -586,18 +568,18 @@
..
} => {
//TODO: investigate threats during public minting.
- if is_token_create && (collection_admin || token_owner) {
+ if guard.is_token_create && (collection_admin || token_owner) {
return Ok(());
}
let mut check_result = Err(<CommonError<T>>::NoPermission.into());
if collection_admin {
- check_result = collection.check_is_owner_or_admin(sender);
+ check_result = guard.check_collection_admin();
}
if token_owner {
- check_result.or_else(|_| check_token_owner())
+ check_result.or_else(|_| guard.check_token_owner())
} else {
check_result
}
@@ -611,9 +593,20 @@
sender: &T::CrossAccountId,
token_id: TokenId,
property_keys: Vec<PropertyKey>,
+ nesting_budget: &dyn Budget,
) -> DispatchResult {
+ let is_token_create = false;
+
+ let mut guard = PropertyGuard::new(
+ sender,
+ collection,
+ token_id,
+ is_token_create,
+ nesting_budget,
+ );
+
for key in property_keys {
- Self::delete_token_property(collection, sender, token_id, key)?;
+ Self::delete_token_property(key, &mut guard)?;
}
Ok(())
@@ -829,6 +822,7 @@
TokenId(token),
data.properties.clone().into_inner(),
true,
+ nesting_budget,
) {
return TransactionOutcome::Rollback(Err(e));
}
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -314,6 +314,7 @@
_sender: T::CrossAccountId,
_token_id: TokenId,
_property: Vec<Property>,
+ _budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
fail!(<Error<T>>::SettingPropertiesNotAllowed)
}
@@ -331,6 +332,7 @@
_sender: T::CrossAccountId,
_token_id: TokenId,
_property_keys: Vec<PropertyKey>,
+ _budget: &dyn Budget,
) -> DispatchResultWithPostInfo {
fail!(<Error<T>>::SettingPropertiesNotAllowed)
}
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)]2425extern crate alloc;2627use frame_support::{28 decl_module, decl_storage, decl_error, decl_event,29 dispatch::DispatchResult,30 ensure, fail,31 weights::{Weight},32 transactional,33 pallet_prelude::{DispatchResultWithPostInfo, ConstU32},34 BoundedVec,35};36use scale_info::TypeInfo;37use frame_system::{self as system, ensure_signed};38use sp_runtime::{sp_std::prelude::Vec};39use up_data_structs::{40 MAX_COLLECTION_NAME_LENGTH, MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH,41 CreateItemData, CollectionLimits, CollectionPermissions, CollectionId, CollectionMode, TokenId,42 SponsorshipState, CreateCollectionData, CreateItemExData, budget, Property, PropertyKey,43 PropertyKeyPermission,44};45use pallet_evm::account::CrossAccountId;46use pallet_common::{47 CollectionHandle, Pallet as PalletCommon, CommonWeightInfo, dispatch::dispatch_tx,48 dispatch::CollectionDispatch, RefungibleExtensionsWeightInfo,49};50pub mod eth;5152#[cfg(feature = "runtime-benchmarks")]53mod benchmarking;54pub mod weights;55use weights::WeightInfo;5657const NESTING_BUDGET: u32 = 5;5859decl_error! {60 /// Error for non-fungible-token module.61 pub enum Error for Module<T: Config> {62 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.63 CollectionDecimalPointLimitExceeded,64 /// This address is not set as sponsor, use setCollectionSponsor first.65 ConfirmUnsetSponsorFail,66 /// Length of items properties must be greater than 0.67 EmptyArgument,68 /// Repertition is only supported by refungible collection69 RepartitionCalledOnNonRefungibleCollection,70 }71}7273pub trait Config: system::Config + pallet_common::Config + Sized + TypeInfo {74 type Event: From<Event<Self>> + Into<<Self as frame_system::Config>::Event>;7576 /// Weight information for extrinsics in this pallet.77 type WeightInfo: WeightInfo;78 type CommonWeightInfo: CommonWeightInfo<Self::CrossAccountId>;79 type RefungibleExtensionsWeightInfo: RefungibleExtensionsWeightInfo;80}8182decl_event! {83 pub enum Event<T>84 where85 <T as frame_system::Config>::AccountId,86 <T as pallet_evm::account::Config>::CrossAccountId,87 {88 /// Collection sponsor was removed89 ///90 /// # Arguments91 ///92 /// * collection_id: Globally unique collection identifier.93 CollectionSponsorRemoved(CollectionId),9495 /// Collection admin was added96 ///97 /// # Arguments98 ///99 /// * collection_id: Globally unique collection identifier.100 ///101 /// * admin: Admin address.102 CollectionAdminAdded(CollectionId, CrossAccountId),103104 /// Collection owned was change105 ///106 /// # Arguments107 ///108 /// * collection_id: Globally unique collection identifier.109 ///110 /// * owner: New owner address.111 CollectionOwnedChanged(CollectionId, AccountId),112113 /// Collection sponsor was set114 ///115 /// # Arguments116 ///117 /// * collection_id: Globally unique collection identifier.118 ///119 /// * owner: New sponsor address.120 CollectionSponsorSet(CollectionId, AccountId),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 CollectionPermissionSet(CollectionId),166 }167}168169type SelfWeightOf<T> = <T as Config>::WeightInfo;170171// # Used definitions172//173// ## User control levels174//175// chain-controlled - key is uncontrolled by user176// i.e autoincrementing index177// can use non-cryptographic hash178// real - key is controlled by user179// but it is hard to generate enough colliding values, i.e owner of signed txs180// can use non-cryptographic hash181// controlled - key is completly controlled by users182// i.e maps with mutable keys183// should use cryptographic hash184//185// ## User control level downgrade reasons186//187// ?1 - chain-controlled -> controlled188// collections/tokens can be destroyed, resulting in massive holes189// ?2 - chain-controlled -> controlled190// same as ?1, but can be only added, resulting in easier exploitation191// ?3 - real -> controlled192// no confirmation required, so addresses can be easily generated193decl_storage! {194 trait Store for Module<T: Config> as Unique {195196 //#region Private members197 /// Used for migrations198 ChainVersion: u64;199 //#endregion200201 //#region Tokens transfer rate limit baskets202 /// (Collection id (controlled?2), who created (real))203 /// TODO: Off chain worker should remove from this map when collection gets removed204 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => Option<T::BlockNumber>;205 /// Collection id (controlled?2), token id (controlled?2)206 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;207 /// Collection id (controlled?2), owning user (real)208 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;209 /// Collection id (controlled?2), token id (controlled?2)210 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>;211 //#endregion212213 /// Variable metadata sponsoring214 /// Collection id (controlled?2), token id (controlled?2)215 #[deprecated]216 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;217 pub TokenPropertyBasket get(fn token_property_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;218219 /// Approval sponsoring220 pub NftApproveBasket get(fn nft_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber>;221 pub FungibleApproveBasket get(fn fungible_approve_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => Option<T::BlockNumber>;222 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>;223 }224}225226decl_module! {227 pub struct Module<T: Config> for enum Call228 where229 origin: T::Origin230 {231 type Error = Error<T>;232233 fn deposit_event() = default;234235 fn on_initialize(_now: T::BlockNumber) -> Weight {236 0237 }238239 fn on_runtime_upgrade() -> Weight {240 let limit = None;241242 <VariableMetaDataBasket<T>>::remove_all(limit);243244 0245 }246247 /// 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.248 ///249 /// # Permissions250 ///251 /// * Anyone.252 ///253 /// # Arguments254 ///255 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.256 ///257 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.258 ///259 /// * token_prefix: UTF-8 string with token prefix.260 ///261 /// * mode: [CollectionMode] collection type and type dependent data.262 // returns collection ID263 #[weight = <SelfWeightOf<T>>::create_collection()]264 #[transactional]265 #[deprecated]266 pub fn create_collection(origin,267 collection_name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,268 collection_description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,269 token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,270 mode: CollectionMode) -> DispatchResult {271 let data: CreateCollectionData<T::AccountId> = CreateCollectionData {272 name: collection_name,273 description: collection_description,274 token_prefix,275 mode,276 ..Default::default()277 };278 Self::create_collection_ex(origin, data)279 }280281 /// This method creates a collection282 ///283 /// Prefer it to deprecated [`created_collection`] method284 #[weight = <SelfWeightOf<T>>::create_collection()]285 #[transactional]286 pub fn create_collection_ex(origin, data: CreateCollectionData<T::AccountId>) -> DispatchResult {287 let sender = ensure_signed(origin)?;288289 // =========290291 T::CollectionDispatch::create(T::CrossAccountId::from_sub(sender), data)?;292293 Ok(())294 }295296 /// Destroys collection if no tokens within this collection297 ///298 /// # Permissions299 ///300 /// * Collection Owner.301 ///302 /// # Arguments303 ///304 /// * collection_id: collection to destroy.305 #[weight = <SelfWeightOf<T>>::destroy_collection()]306 #[transactional]307 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {308 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);309 let collection = <CollectionHandle<T>>::try_get(collection_id)?;310 collection.check_is_internal()?;311312 // =========313314 T::CollectionDispatch::destroy(sender, collection)?;315316 <NftTransferBasket<T>>::remove_prefix(collection_id, None);317 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);318 <ReFungibleTransferBasket<T>>::remove_prefix((collection_id,), None);319320 <NftApproveBasket<T>>::remove_prefix(collection_id, None);321 <FungibleApproveBasket<T>>::remove_prefix(collection_id, None);322 <RefungibleApproveBasket<T>>::remove_prefix((collection_id,), None);323324 Ok(())325 }326327 /// Add an address to allow list.328 ///329 /// # Permissions330 ///331 /// * Collection Owner332 /// * Collection Admin333 ///334 /// # Arguments335 ///336 /// * collection_id.337 ///338 /// * address.339 #[weight = <SelfWeightOf<T>>::add_to_allow_list()]340 #[transactional]341 pub fn add_to_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{342343 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);344 let collection = <CollectionHandle<T>>::try_get(collection_id)?;345 collection.check_is_internal()?;346347 <PalletCommon<T>>::toggle_allowlist(348 &collection,349 &sender,350 &address,351 true,352 )?;353354 Self::deposit_event(Event::<T>::AllowListAddressAdded(355 collection_id,356 address357 ));358359 Ok(())360 }361362 /// Remove an address from allow list.363 ///364 /// # Permissions365 ///366 /// * Collection Owner367 /// * Collection Admin368 ///369 /// # Arguments370 ///371 /// * collection_id.372 ///373 /// * address.374 #[weight = <SelfWeightOf<T>>::remove_from_allow_list()]375 #[transactional]376 pub fn remove_from_allow_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{377378 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);379 let collection = <CollectionHandle<T>>::try_get(collection_id)?;380 collection.check_is_internal()?;381382 <PalletCommon<T>>::toggle_allowlist(383 &collection,384 &sender,385 &address,386 false,387 )?;388389 <Pallet<T>>::deposit_event(Event::<T>::AllowListAddressRemoved(390 collection_id,391 address392 ));393394 Ok(())395 }396397 /// Change the owner of the collection.398 ///399 /// # Permissions400 ///401 /// * Collection Owner.402 ///403 /// # Arguments404 ///405 /// * collection_id.406 ///407 /// * new_owner.408 #[weight = <SelfWeightOf<T>>::change_collection_owner()]409 #[transactional]410 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {411412 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);413414 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;415 target_collection.check_is_internal()?;416 target_collection.check_is_owner(&sender)?;417418 target_collection.owner = new_owner.clone();419 <Pallet<T>>::deposit_event(Event::<T>::CollectionOwnedChanged(420 collection_id,421 new_owner422 ));423424 target_collection.save()425 }426427 /// Adds an admin of the Collection.428 /// 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.429 ///430 /// # Permissions431 ///432 /// * Collection Owner.433 /// * Collection Admin.434 ///435 /// # Arguments436 ///437 /// * collection_id: ID of the Collection to add admin for.438 ///439 /// * new_admin_id: Address of new admin to add.440 #[weight = <SelfWeightOf<T>>::add_collection_admin()]441 #[transactional]442 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {443 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);444 let collection = <CollectionHandle<T>>::try_get(collection_id)?;445 collection.check_is_internal()?;446447 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminAdded(448 collection_id,449 new_admin_id.clone()450 ));451452 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin_id, true)453 }454455 /// 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.456 ///457 /// # Permissions458 ///459 /// * Collection Owner.460 /// * Collection Admin.461 ///462 /// # Arguments463 ///464 /// * collection_id: ID of the Collection to remove admin for.465 ///466 /// * account_id: Address of admin to remove.467 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]468 #[transactional]469 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {470 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);471 let collection = <CollectionHandle<T>>::try_get(collection_id)?;472 collection.check_is_internal()?;473474 <Pallet<T>>::deposit_event(Event::<T>::CollectionAdminRemoved(475 collection_id,476 account_id.clone()477 ));478479 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)480 }481482 /// # Permissions483 ///484 /// * Collection Owner485 ///486 /// # Arguments487 ///488 /// * collection_id.489 ///490 /// * new_sponsor.491 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]492 #[transactional]493 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {494 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);495496 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;497 target_collection.check_is_owner_or_admin(&sender)?;498 target_collection.check_is_internal()?;499500 target_collection.set_sponsor(new_sponsor.clone())?;501502 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorSet(503 collection_id,504 new_sponsor505 ));506507 target_collection.save()508 }509510 /// # Permissions511 ///512 /// * Sponsor.513 ///514 /// # Arguments515 ///516 /// * collection_id.517 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]518 #[transactional]519 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {520 let sender = ensure_signed(origin)?;521522 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;523 target_collection.check_is_internal()?;524 ensure!(525 target_collection.confirm_sponsorship(&sender)?,526 Error::<T>::ConfirmUnsetSponsorFail527 );528529 <Pallet<T>>::deposit_event(Event::<T>::SponsorshipConfirmed(530 collection_id,531 sender532 ));533534 target_collection.save()535 }536537 /// Switch back to pay-per-own-transaction model.538 ///539 /// # Permissions540 ///541 /// * Collection owner.542 ///543 /// # Arguments544 ///545 /// * collection_id.546 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]547 #[transactional]548 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {549 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);550551 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;552 target_collection.check_is_internal()?;553 target_collection.check_is_owner(&sender)?;554555 target_collection.sponsorship = SponsorshipState::Disabled;556557 <Pallet<T>>::deposit_event(Event::<T>::CollectionSponsorRemoved(558 collection_id559 ));560 target_collection.save()561 }562563 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.564 ///565 /// # Permissions566 ///567 /// * Collection Owner.568 /// * Collection Admin.569 /// * Anyone if570 /// * Allow List is enabled, and571 /// * Address is added to allow list, and572 /// * MintPermission is enabled (see SetMintPermission method)573 ///574 /// # Arguments575 ///576 /// * collection_id: ID of the collection.577 ///578 /// * owner: Address, initial owner of the NFT.579 ///580 /// * data: Token data to store on chain.581 #[weight = T::CommonWeightInfo::create_item()]582 #[transactional]583 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {584 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);585 let budget = budget::Value::new(NESTING_BUDGET);586587 dispatch_tx::<T, _>(collection_id, |d| d.create_item(sender, owner, data, &budget))588 }589590 /// This method creates multiple items in a collection created with CreateCollection method.591 ///592 /// # Permissions593 ///594 /// * Collection Owner.595 /// * Collection Admin.596 /// * Anyone if597 /// * Allow List is enabled, and598 /// * Address is added to allow list, and599 /// * MintPermission is enabled (see SetMintPermission method)600 ///601 /// # Arguments602 ///603 /// * collection_id: ID of the collection.604 ///605 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].606 ///607 /// * owner: Address, initial owner of the NFT.608 #[weight = T::CommonWeightInfo::create_multiple_items(&items_data)]609 #[transactional]610 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {611 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);612 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);613 let budget = budget::Value::new(NESTING_BUDGET);614615 dispatch_tx::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data, &budget))616 }617618 #[weight = T::CommonWeightInfo::set_collection_properties(properties.len() as u32)]619 #[transactional]620 pub fn set_collection_properties(621 origin,622 collection_id: CollectionId,623 properties: Vec<Property>624 ) -> DispatchResultWithPostInfo {625 ensure!(!properties.is_empty(), Error::<T>::EmptyArgument);626627 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);628629 dispatch_tx::<T, _>(collection_id, |d| d.set_collection_properties(sender, properties))630 }631632 #[weight = T::CommonWeightInfo::delete_collection_properties(property_keys.len() as u32)]633 #[transactional]634 pub fn delete_collection_properties(635 origin,636 collection_id: CollectionId,637 property_keys: Vec<PropertyKey>,638 ) -> DispatchResultWithPostInfo {639 ensure!(!property_keys.is_empty(), Error::<T>::EmptyArgument);640641 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);642643 dispatch_tx::<T, _>(collection_id, |d| d.delete_collection_properties(&sender, property_keys))644 }645646 #[weight = T::CommonWeightInfo::set_token_properties(properties.len() as u32)]647 #[transactional]648 pub fn set_token_properties(649 origin,650 collection_id: CollectionId,651 token_id: TokenId,652 properties: Vec<Property>653 ) -> DispatchResultWithPostInfo {654 ensure!(!properties.is_empty(), Error::<T>::EmptyArgument);655656 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);657658 dispatch_tx::<T, _>(collection_id, |d| d.set_token_properties(sender, token_id, properties))659 }660661 #[weight = T::CommonWeightInfo::delete_token_properties(property_keys.len() as u32)]662 #[transactional]663 pub fn delete_token_properties(664 origin,665 collection_id: CollectionId,666 token_id: TokenId,667 property_keys: Vec<PropertyKey>668 ) -> DispatchResultWithPostInfo {669 ensure!(!property_keys.is_empty(), Error::<T>::EmptyArgument);670671 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);672673 dispatch_tx::<T, _>(collection_id, |d| d.delete_token_properties(sender, token_id, property_keys))674 }675676 #[weight = T::CommonWeightInfo::set_token_property_permissions(property_permissions.len() as u32)]677 #[transactional]678 pub fn set_token_property_permissions(679 origin,680 collection_id: CollectionId,681 property_permissions: Vec<PropertyKeyPermission>,682 ) -> DispatchResultWithPostInfo {683 ensure!(!property_permissions.is_empty(), Error::<T>::EmptyArgument);684685 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);686687 dispatch_tx::<T, _>(collection_id, |d| d.set_token_property_permissions(&sender, property_permissions))688 }689690 #[weight = T::CommonWeightInfo::create_multiple_items_ex(&data)]691 #[transactional]692 pub fn create_multiple_items_ex(origin, collection_id: CollectionId, data: CreateItemExData<T::CrossAccountId>) -> DispatchResultWithPostInfo {693 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);694 let budget = budget::Value::new(NESTING_BUDGET);695696 dispatch_tx::<T, _>(collection_id, |d| d.create_multiple_items_ex(sender, data, &budget))697 }698699 /// Set transfers_enabled value for particular collection700 ///701 /// # Permissions702 ///703 /// * Collection Owner.704 ///705 /// # Arguments706 ///707 /// * collection_id: ID of the collection.708 ///709 /// * value: New flag value.710 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]711 #[transactional]712 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {713 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);714 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;715 target_collection.check_is_internal()?;716 target_collection.check_is_owner(&sender)?;717718 // =========719720 target_collection.limits.transfers_enabled = Some(value);721 target_collection.save()722 }723724 /// Destroys a concrete instance of NFT.725 ///726 /// # Permissions727 ///728 /// * Collection Owner.729 /// * Collection Admin.730 /// * Current NFT Owner.731 ///732 /// # Arguments733 ///734 /// * collection_id: ID of the collection.735 ///736 /// * item_id: ID of NFT to burn.737 #[weight = T::CommonWeightInfo::burn_item()]738 #[transactional]739 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {740 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);741742 let post_info = dispatch_tx::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))?;743 if value == 1 {744 <NftTransferBasket<T>>::remove(collection_id, item_id);745 <NftApproveBasket<T>>::remove(collection_id, item_id);746 }747 // Those maps should be cleared only if token disappears completly, need to move this part of logic to pallets?748 // <FungibleApproveBasket<T>>::remove(collection_id, sender.as_sub());749 // <RefungibleApproveBasket<T>>::remove((collection_id, item_id, sender.as_sub()));750 Ok(post_info)751 }752753 /// Destroys a concrete instance of NFT on behalf of the owner754 /// See also: [`approve`]755 ///756 /// # Permissions757 ///758 /// * Collection Owner.759 /// * Collection Admin.760 /// * Current NFT Owner.761 ///762 /// # Arguments763 ///764 /// * collection_id: ID of the collection.765 ///766 /// * item_id: ID of NFT to burn.767 ///768 /// * from: owner of item769 #[weight = T::CommonWeightInfo::burn_from()]770 #[transactional]771 pub fn burn_from(origin, collection_id: CollectionId, from: T::CrossAccountId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {772 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);773 let budget = budget::Value::new(NESTING_BUDGET);774775 dispatch_tx::<T, _>(collection_id, |d| d.burn_from(sender, from, item_id, value, &budget))776 }777778 /// Change ownership of the token.779 ///780 /// # Permissions781 ///782 /// * Collection Owner783 /// * Collection Admin784 /// * Current NFT owner785 ///786 /// # Arguments787 ///788 /// * recipient: Address of token recipient.789 ///790 /// * collection_id.791 ///792 /// * item_id: ID of the item793 /// * Non-Fungible Mode: Required.794 /// * Fungible Mode: Ignored.795 /// * Re-Fungible Mode: Required.796 ///797 /// * value: Amount to transfer.798 /// * Non-Fungible Mode: Ignored799 /// * Fungible Mode: Must specify transferred amount800 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)801 #[weight = T::CommonWeightInfo::transfer()]802 #[transactional]803 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {804 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);805 let budget = budget::Value::new(NESTING_BUDGET);806807 dispatch_tx::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value, &budget))808 }809810 /// Set, change, or remove approved address to transfer the ownership of the NFT.811 ///812 /// # Permissions813 ///814 /// * Collection Owner815 /// * Collection Admin816 /// * Current NFT owner817 ///818 /// # Arguments819 ///820 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).821 ///822 /// * collection_id.823 ///824 /// * item_id: ID of the item.825 #[weight = T::CommonWeightInfo::approve()]826 #[transactional]827 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {828 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);829830 dispatch_tx::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))831 }832833 /// 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.834 ///835 /// # Permissions836 /// * Collection Owner837 /// * Collection Admin838 /// * Current NFT owner839 /// * Address approved by current NFT owner840 ///841 /// # Arguments842 ///843 /// * from: Address that owns token.844 ///845 /// * recipient: Address of token recipient.846 ///847 /// * collection_id.848 ///849 /// * item_id: ID of the item.850 ///851 /// * value: Amount to transfer.852 #[weight = T::CommonWeightInfo::transfer_from()]853 #[transactional]854 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {855 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);856 let budget = budget::Value::new(NESTING_BUDGET);857858 dispatch_tx::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value, &budget))859 }860861 #[weight = <SelfWeightOf<T>>::set_collection_limits()]862 #[transactional]863 pub fn set_collection_limits(864 origin,865 collection_id: CollectionId,866 new_limit: CollectionLimits,867 ) -> DispatchResult {868 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);869 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;870 target_collection.check_is_internal()?;871 target_collection.check_is_owner_or_admin(&sender)?;872 let old_limit = &target_collection.limits;873874 target_collection.limits = <PalletCommon<T>>::clamp_limits(target_collection.mode.clone(), &old_limit, new_limit)?;875876 <Pallet<T>>::deposit_event(Event::<T>::CollectionLimitSet(877 collection_id878 ));879880 target_collection.save()881 }882883 #[weight = <SelfWeightOf<T>>::set_collection_limits()]884 #[transactional]885 pub fn set_collection_permissions(886 origin,887 collection_id: CollectionId,888 new_limit: CollectionPermissions,889 ) -> DispatchResult {890 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);891 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;892 target_collection.check_is_internal()?;893 target_collection.check_is_owner_or_admin(&sender)?;894 let old_limit = &target_collection.permissions;895896 target_collection.permissions = <PalletCommon<T>>::clamp_permissions(target_collection.mode.clone(), &old_limit, new_limit)?;897898 <Pallet<T>>::deposit_event(Event::<T>::CollectionPermissionSet(899 collection_id900 ));901902 target_collection.save()903 }904905 #[weight = T::RefungibleExtensionsWeightInfo::repartition()]906 #[transactional]907 pub fn repartition(908 origin,909 collection_id: CollectionId,910 token: TokenId,911 amount: u128,912 ) -> DispatchResultWithPostInfo {913 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);914 dispatch_tx::<T, _>(collection_id, |d| {915 if let Some(refungible_extensions) = d.refungible_extensions() {916 refungible_extensions.repartition(&sender, token, amount)917 } else {918 fail!(<Error<T>>::RepartitionCalledOnNonRefungibleCollection)919 }920 })921 }922 }923}