difftreelog
fix use fail!
in: master
1 file changed
pallets/nonfungible/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#![cfg_attr(not(feature = "std"), no_std)]1819use erc::ERC721Events;20use evm_coder::ToLog;21use frame_support::{22 BoundedVec, ensure, fail, transactional,23 storage::with_transaction,24 pallet_prelude::DispatchResultWithPostInfo,25 pallet_prelude::Weight,26 weights::{PostDispatchInfo, Pays},27};28use up_data_structs::{29 AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,30 mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission, PropertyKey,31 PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,32 AuxPropertyValue,33};34use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};35use pallet_common::{36 Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,37 eth::collection_id_to_address,38};39use pallet_structure::{Pallet as PalletStructure, Error as StructureError};40use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};41use sp_core::H160;42use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};43use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap, collections::btree_set::BTreeSet};44use core::ops::Deref;45use codec::{Encode, Decode, MaxEncodedLen};46use scale_info::TypeInfo;4748pub use pallet::*;49use weights::WeightInfo;50#[cfg(feature = "runtime-benchmarks")]51pub mod benchmarking;52pub mod common;53pub mod erc;54pub mod weights;5556pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;57pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;5859#[struct_versioning::versioned(version = 2, upper)]60#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]61pub struct ItemData<CrossAccountId> {62 #[version(..2)]63 pub const_data: BoundedVec<u8, CustomDataLimit>,6465 #[version(..2)]66 pub variable_data: BoundedVec<u8, CustomDataLimit>,6768 pub owner: CrossAccountId,69}7071#[frame_support::pallet]72pub mod pallet {73 use super::*;74 use frame_support::{75 Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,76 };77 use frame_system::pallet_prelude::*;78 use up_data_structs::{CollectionId, TokenId};79 use super::weights::WeightInfo;8081 #[pallet::error]82 pub enum Error<T> {83 /// Not Nonfungible item data used to mint in Nonfungible collection.84 NotNonfungibleDataUsedToMintFungibleCollectionToken,85 /// Used amount > 1 with NFT86 NonfungibleItemsHaveNoAmount,87 /// Unable to burn NFT with children88 CantBurnNftWithChildren,89 }9091 #[pallet::config]92 pub trait Config:93 frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config94 {95 type WeightInfo: WeightInfo;96 }9798 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);99100 #[pallet::pallet]101 #[pallet::storage_version(STORAGE_VERSION)]102 #[pallet::generate_store(pub(super) trait Store)]103 pub struct Pallet<T>(_);104105 #[pallet::storage]106 pub type TokensMinted<T: Config> =107 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;108 #[pallet::storage]109 pub type TokensBurnt<T: Config> =110 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;111112 #[pallet::storage]113 pub type TokenData<T: Config> = StorageNMap<114 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),115 Value = ItemData<T::CrossAccountId>,116 QueryKind = OptionQuery,117 >;118119 #[pallet::storage]120 #[pallet::getter(fn token_properties)]121 pub type TokenProperties<T: Config> = StorageNMap<122 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),123 Value = Properties,124 QueryKind = ValueQuery,125 OnEmpty = up_data_structs::TokenProperties,126 >;127128 #[pallet::storage]129 #[pallet::getter(fn token_aux_property)]130 pub type TokenAuxProperties<T: Config> = StorageNMap<131 Key = (132 Key<Twox64Concat, CollectionId>,133 Key<Twox64Concat, TokenId>,134 Key<Twox64Concat, PropertyScope>,135 Key<Twox64Concat, PropertyKey>,136 ),137 Value = AuxPropertyValue,138 QueryKind = OptionQuery,139 >;140141 /// Used to enumerate tokens owned by account142 #[pallet::storage]143 pub type Owned<T: Config> = StorageNMap<144 Key = (145 Key<Twox64Concat, CollectionId>,146 Key<Blake2_128Concat, T::CrossAccountId>,147 Key<Twox64Concat, TokenId>,148 ),149 Value = bool,150 QueryKind = ValueQuery,151 >;152153 /// Used to enumerate token's children154 #[pallet::storage]155 #[pallet::getter(fn token_children)]156 pub type TokenChildren<T: Config> = StorageNMap<157 Key = (158 Key<Twox64Concat, CollectionId>,159 Key<Twox64Concat, TokenId>,160 Key<Twox64Concat, (CollectionId, TokenId)>,161 ),162 Value = bool,163 QueryKind = ValueQuery,164 >;165166 #[pallet::storage]167 pub type AccountBalance<T: Config> = StorageNMap<168 Key = (169 Key<Twox64Concat, CollectionId>,170 Key<Blake2_128Concat, T::CrossAccountId>,171 ),172 Value = u32,173 QueryKind = ValueQuery,174 >;175176 #[pallet::storage]177 pub type Allowance<T: Config> = StorageNMap<178 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),179 Value = T::CrossAccountId,180 QueryKind = OptionQuery,181 >;182183 #[pallet::hooks]184 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {185 fn on_runtime_upgrade() -> Weight {186 if StorageVersion::get::<Pallet<T>>() < StorageVersion::new(1) {187 let mut had_consts = BTreeSet::new();188 <TokenData<T>>::translate::<ItemDataVersion1<T::CrossAccountId>, _>(189 |(collection, token), v| {190 let mut props = vec![];191 if !v.const_data.is_empty() {192 props.push(Property {193 key: b"_old_constData".to_vec().try_into().unwrap(),194 value: v195 .const_data196 .clone()197 .into_inner()198 .try_into()199 .expect("const too long"),200 });201 had_consts.insert(collection);202 }203 if !v.variable_data.is_empty() {204 props.push(Property {205 key: b"_old_variableData".to_vec().try_into().unwrap(),206 value: v207 .variable_data208 .clone()209 .into_inner()210 .try_into()211 .expect("variable too long"),212 })213 }214 if !props.is_empty() {215 Self::set_scoped_token_properties(216 collection,217 token,218 PropertyScope::None,219 props.into_iter(),220 )221 .expect("existing token data exceeds property storage");222 }223 Some(<ItemDataVersion2<T::CrossAccountId>>::from(v))224 },225 );226 for collection in had_consts {227 <PalletCommon<T>>::set_property_permission_unchecked(228 collection,229 PropertyKeyPermission {230 key: b"_old_constData".to_vec().try_into().unwrap(),231 permission: PropertyPermission {232 mutable: false,233 collection_admin: true,234 token_owner: false,235 },236 },237 )238 .expect("failed to configure permission");239 }240 }241242 0243 }244 }245}246247pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);248impl<T: Config> NonfungibleHandle<T> {249 pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {250 Self(inner)251 }252 pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {253 self.0254 }255 pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {256 &mut self.0257 }258}259impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {260 fn recorder(&self) -> &SubstrateRecorder<T> {261 self.0.recorder()262 }263 fn into_recorder(self) -> SubstrateRecorder<T> {264 self.0.into_recorder()265 }266}267impl<T: Config> Deref for NonfungibleHandle<T> {268 type Target = pallet_common::CollectionHandle<T>;269270 fn deref(&self) -> &Self::Target {271 &self.0272 }273}274275impl<T: Config> Pallet<T> {276 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {277 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)278 }279 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {280 <TokenData<T>>::contains_key((collection.id, token))281 }282283 pub fn set_scoped_token_property(284 collection_id: CollectionId,285 token_id: TokenId,286 scope: PropertyScope,287 property: Property,288 ) -> DispatchResult {289 TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {290 properties.try_scoped_set(scope, property.key, property.value)291 })292 .map_err(<CommonError<T>>::from)?;293294 Ok(())295 }296297 pub fn set_scoped_token_properties(298 collection_id: CollectionId,299 token_id: TokenId,300 scope: PropertyScope,301 properties: impl Iterator<Item = Property>,302 ) -> DispatchResult {303 TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {304 stored_properties.try_scoped_set_from_iter(scope, properties)305 })306 .map_err(<CommonError<T>>::from)?;307308 Ok(())309 }310311 pub fn try_mutate_token_aux_property<R, E>(312 collection_id: CollectionId,313 token_id: TokenId,314 scope: PropertyScope,315 key: PropertyKey,316 f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,317 ) -> Result<R, E> {318 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)319 }320321 pub fn remove_token_aux_property(322 collection_id: CollectionId,323 token_id: TokenId,324 scope: PropertyScope,325 key: PropertyKey,326 ) {327 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));328 }329330 pub fn iterate_token_aux_properties(331 collection_id: CollectionId,332 token_id: TokenId,333 scope: PropertyScope,334 ) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {335 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))336 }337338 pub fn current_token_id(collection_id: CollectionId) -> TokenId {339 TokenId(<TokensMinted<T>>::get(collection_id))340 }341}342343// unchecked calls skips any permission checks344impl<T: Config> Pallet<T> {345 pub fn init_collection(346 owner: T::CrossAccountId,347 data: CreateCollectionData<T::AccountId>,348 is_external: bool,349 ) -> Result<CollectionId, DispatchError> {350 <PalletCommon<T>>::init_collection(owner, data, is_external)351 }352 pub fn destroy_collection(353 collection: NonfungibleHandle<T>,354 sender: &T::CrossAccountId,355 ) -> DispatchResult {356 let id = collection.id;357358 if Self::collection_has_tokens(id) {359 return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());360 }361362 // =========363364 PalletCommon::destroy_collection(collection.0, sender)?;365366 <TokenData<T>>::remove_prefix((id,), None);367 <TokenChildren<T>>::remove_prefix((id,), None);368 <Owned<T>>::remove_prefix((id,), None);369 <TokensMinted<T>>::remove(id);370 <TokensBurnt<T>>::remove(id);371 <Allowance<T>>::remove_prefix((id,), None);372 <AccountBalance<T>>::remove_prefix((id,), None);373 Ok(())374 }375376 pub fn burn(377 collection: &NonfungibleHandle<T>,378 sender: &T::CrossAccountId,379 token: TokenId,380 ) -> DispatchResult {381 let token_data =382 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;383 ensure!(384 &token_data.owner == sender385 || (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(sender)),386 <CommonError<T>>::NoPermission387 );388389 if collection.permissions.access() == AccessMode::AllowList {390 collection.check_allowlist(sender)?;391 }392393 if Self::token_has_children(collection.id, token) {394 return Err(<Error<T>>::CantBurnNftWithChildren.into());395 }396397 let burnt = <TokensBurnt<T>>::get(collection.id)398 .checked_add(1)399 .ok_or(ArithmeticError::Overflow)?;400401 let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))402 .checked_sub(1)403 .ok_or(ArithmeticError::Overflow)?;404405 // =========406407 if balance == 0 {408 <AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));409 } else {410 <AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);411 }412413 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);414415 <Owned<T>>::remove((collection.id, &token_data.owner, token));416 <TokensBurnt<T>>::insert(collection.id, burnt);417 <TokenData<T>>::remove((collection.id, token));418 <TokenProperties<T>>::remove((collection.id, token));419 <TokenAuxProperties<T>>::remove_prefix((collection.id, token), None);420 let old_spender = <Allowance<T>>::take((collection.id, token));421422 if let Some(old_spender) = old_spender {423 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(424 collection.id,425 token,426 token_data.owner.clone(),427 old_spender,428 0,429 ));430 }431432 <PalletEvm<T>>::deposit_log(433 ERC721Events::Transfer {434 from: *token_data.owner.as_eth(),435 to: H160::default(),436 token_id: token.into(),437 }438 .to_log(collection_id_to_address(collection.id)),439 );440 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(441 collection.id,442 token,443 token_data.owner,444 1,445 ));446 Ok(())447 }448449 #[transactional]450 pub fn burn_recursively(451 collection: &NonfungibleHandle<T>,452 sender: &T::CrossAccountId,453 token: TokenId,454 self_budget: &dyn Budget,455 breadth_budget: &dyn Budget,456 ) -> DispatchResultWithPostInfo {457 ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);458459 let current_token_account =460 T::CrossTokenAddressMapping::token_to_address(collection.id, token);461462 let mut weight = 0 as Weight;463464 // This method is transactional, if user in fact doesn't have permissions to remove token -465 // tokens removed here will be restored after rejected transaction466 for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {467 ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);468 let PostDispatchInfo { actual_weight, .. } =469 <PalletStructure<T>>::burn_item_recursively(470 current_token_account.clone(),471 collection,472 token,473 self_budget,474 breadth_budget,475 )?;476 if let Some(actual_weight) = actual_weight {477 weight = weight.saturating_add(actual_weight);478 }479 }480481 Self::burn(collection, sender, token)?;482 DispatchResultWithPostInfo::Ok(PostDispatchInfo {483 actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),484 pays_fee: Pays::Yes,485 })486 }487488 #[transactional]489 fn modify_token_properties(490 collection: &NonfungibleHandle<T>,491 sender: &T::CrossAccountId,492 token_id: TokenId,493 properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,494 is_token_create: bool,495 nesting_budget: &dyn Budget,496 ) -> DispatchResult {497 let mut collection_admin_status = None;498 let mut token_owner_result = None;499500 let mut is_collection_admin =501 || *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));502503 let mut is_token_owner = || {504 *token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {505 let is_owned = <PalletStructure<T>>::check_indirectly_owned(506 sender.clone(),507 collection.id,508 token_id,509 None,510 nesting_budget,511 )?;512513 Ok(is_owned)514 })515 };516517 for (key, value) in properties {518 let permission = <PalletCommon<T>>::property_permissions(collection.id)519 .get(&key)520 .cloned()521 .unwrap_or_else(PropertyPermission::none);522523 let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))524 .get(&key)525 .is_some();526527 match permission {528 PropertyPermission { mutable: false, .. } if is_property_exists => {529 return Err(<CommonError<T>>::NoPermission.into());530 }531532 PropertyPermission {533 collection_admin,534 token_owner,535 ..536 } => {537 //TODO: investigate threats during public minting.538 if is_token_create && (collection_admin || token_owner) && value.is_some() {539 // Pass540 } else if collection_admin && is_collection_admin() {541 // Pass542 } else if token_owner && is_token_owner()? {543 // Pass544 } else {545 return Err(<CommonError<T>>::NoPermission.into());546 }547 }548 }549550 match value {551 Some(value) => {552 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {553 properties.try_set(key.clone(), value)554 })555 .map_err(<CommonError<T>>::from)?;556557 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(558 collection.id,559 token_id,560 key,561 ));562 }563 None => {564 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {565 properties.remove(&key)566 })567 .map_err(<CommonError<T>>::from)?;568569 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(570 collection.id,571 token_id,572 key,573 ));574 }575 }576 }577578 Ok(())579 }580581 pub fn set_token_properties(582 collection: &NonfungibleHandle<T>,583 sender: &T::CrossAccountId,584 token_id: TokenId,585 properties: impl Iterator<Item = Property>,586 is_token_create: bool,587 nesting_budget: &dyn Budget,588 ) -> DispatchResult {589 Self::modify_token_properties(590 collection,591 sender,592 token_id,593 properties.map(|p| (p.key, Some(p.value))),594 is_token_create,595 nesting_budget,596 )597 }598599 pub fn set_token_property(600 collection: &NonfungibleHandle<T>,601 sender: &T::CrossAccountId,602 token_id: TokenId,603 property: Property,604 nesting_budget: &dyn Budget,605 ) -> DispatchResult {606 let is_token_create = false;607608 Self::set_token_properties(609 collection,610 sender,611 token_id,612 [property].into_iter(),613 is_token_create,614 nesting_budget,615 )616 }617618 pub fn delete_token_properties(619 collection: &NonfungibleHandle<T>,620 sender: &T::CrossAccountId,621 token_id: TokenId,622 property_keys: impl Iterator<Item = PropertyKey>,623 nesting_budget: &dyn Budget,624 ) -> DispatchResult {625 let is_token_create = false;626627 Self::modify_token_properties(628 collection,629 sender,630 token_id,631 property_keys.into_iter().map(|key| (key, None)),632 is_token_create,633 nesting_budget,634 )635 }636637 pub fn delete_token_property(638 collection: &NonfungibleHandle<T>,639 sender: &T::CrossAccountId,640 token_id: TokenId,641 property_key: PropertyKey,642 nesting_budget: &dyn Budget,643 ) -> DispatchResult {644 Self::delete_token_properties(645 collection,646 sender,647 token_id,648 [property_key].into_iter(),649 nesting_budget,650 )651 }652653 pub fn set_collection_properties(654 collection: &NonfungibleHandle<T>,655 sender: &T::CrossAccountId,656 properties: Vec<Property>,657 ) -> DispatchResult {658 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)659 }660661 pub fn delete_collection_properties(662 collection: &CollectionHandle<T>,663 sender: &T::CrossAccountId,664 property_keys: Vec<PropertyKey>,665 ) -> DispatchResult {666 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)667 }668669 pub fn set_token_property_permissions(670 collection: &CollectionHandle<T>,671 sender: &T::CrossAccountId,672 property_permissions: Vec<PropertyKeyPermission>,673 ) -> DispatchResult {674 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)675 }676677 pub fn set_property_permission(678 collection: &CollectionHandle<T>,679 sender: &T::CrossAccountId,680 permission: PropertyKeyPermission,681 ) -> DispatchResult {682 <PalletCommon<T>>::set_property_permission(collection, sender, permission)683 }684685 pub fn transfer(686 collection: &NonfungibleHandle<T>,687 from: &T::CrossAccountId,688 to: &T::CrossAccountId,689 token: TokenId,690 nesting_budget: &dyn Budget,691 ) -> DispatchResult {692 ensure!(693 collection.limits.transfers_enabled(),694 <CommonError<T>>::TransferNotAllowed695 );696697 let token_data =698 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;699 // TODO: require sender to be token, owner, require admins to go through transfer_from700 ensure!(701 &token_data.owner == from702 || (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(from)),703 <CommonError<T>>::NoPermission704 );705706 if collection.permissions.access() == AccessMode::AllowList {707 collection.check_allowlist(from)?;708 collection.check_allowlist(to)?;709 }710 <PalletCommon<T>>::ensure_correct_receiver(to)?;711712 let balance_from = <AccountBalance<T>>::get((collection.id, from))713 .checked_sub(1)714 .ok_or(<CommonError<T>>::TokenValueTooLow)?;715 let balance_to = if from != to {716 let balance_to = <AccountBalance<T>>::get((collection.id, to))717 .checked_add(1)718 .ok_or(ArithmeticError::Overflow)?;719720 ensure!(721 balance_to < collection.limits.account_token_ownership_limit(),722 <CommonError<T>>::AccountTokenLimitExceeded,723 );724725 Some(balance_to)726 } else {727 None728 };729730 <PalletStructure<T>>::nest_if_sent_to_token(731 from.clone(),732 to,733 collection.id,734 token,735 nesting_budget,736 )?;737738 // =========739740 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);741742 <TokenData<T>>::insert(743 (collection.id, token),744 ItemData {745 owner: to.clone(),746 ..token_data747 },748 );749750 if let Some(balance_to) = balance_to {751 // from != to752 if balance_from == 0 {753 <AccountBalance<T>>::remove((collection.id, from));754 } else {755 <AccountBalance<T>>::insert((collection.id, from), balance_from);756 }757 <AccountBalance<T>>::insert((collection.id, to), balance_to);758 <Owned<T>>::remove((collection.id, from, token));759 <Owned<T>>::insert((collection.id, to, token), true);760 }761 Self::set_allowance_unchecked(collection, from, token, None, true);762763 <PalletEvm<T>>::deposit_log(764 ERC721Events::Transfer {765 from: *from.as_eth(),766 to: *to.as_eth(),767 token_id: token.into(),768 }769 .to_log(collection_id_to_address(collection.id)),770 );771 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(772 collection.id,773 token,774 from.clone(),775 to.clone(),776 1,777 ));778 Ok(())779 }780781 pub fn create_multiple_items(782 collection: &NonfungibleHandle<T>,783 sender: &T::CrossAccountId,784 data: Vec<CreateItemData<T>>,785 nesting_budget: &dyn Budget,786 ) -> DispatchResult {787 if !collection.is_owner_or_admin(sender) {788 ensure!(789 collection.permissions.mint_mode(),790 <CommonError<T>>::PublicMintingNotAllowed791 );792 collection.check_allowlist(sender)?;793794 for item in data.iter() {795 collection.check_allowlist(&item.owner)?;796 }797 }798799 for data in data.iter() {800 <PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;801 }802803 let first_token = <TokensMinted<T>>::get(collection.id);804 let tokens_minted = first_token805 .checked_add(data.len() as u32)806 .ok_or(ArithmeticError::Overflow)?;807 ensure!(808 tokens_minted <= collection.limits.token_limit(),809 <CommonError<T>>::CollectionTokenLimitExceeded810 );811812 let mut balances = BTreeMap::new();813 for data in &data {814 let balance = balances815 .entry(&data.owner)816 .or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));817 *balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;818819 ensure!(820 *balance <= collection.limits.account_token_ownership_limit(),821 <CommonError<T>>::AccountTokenLimitExceeded,822 );823 }824825 for (i, data) in data.iter().enumerate() {826 let token = TokenId(first_token + i as u32 + 1);827828 <PalletStructure<T>>::check_nesting(829 sender.clone(),830 &data.owner,831 collection.id,832 token,833 nesting_budget,834 )?;835 }836837 // =========838839 with_transaction(|| {840 for (i, data) in data.iter().enumerate() {841 let token = first_token + i as u32 + 1;842843 <TokenData<T>>::insert(844 (collection.id, token),845 ItemData {846 // const_data: data.const_data.clone(),847 owner: data.owner.clone(),848 },849 );850851 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(852 &data.owner,853 collection.id,854 TokenId(token),855 );856857 if let Err(e) = Self::set_token_properties(858 collection,859 sender,860 TokenId(token),861 data.properties.clone().into_iter(),862 true,863 nesting_budget,864 ) {865 return TransactionOutcome::Rollback(Err(e));866 }867 }868 TransactionOutcome::Commit(Ok(()))869 })?;870871 <TokensMinted<T>>::insert(collection.id, tokens_minted);872 for (account, balance) in balances {873 <AccountBalance<T>>::insert((collection.id, account), balance);874 }875 for (i, data) in data.into_iter().enumerate() {876 let token = first_token + i as u32 + 1;877 <Owned<T>>::insert((collection.id, &data.owner, token), true);878879 <PalletEvm<T>>::deposit_log(880 ERC721Events::Transfer {881 from: H160::default(),882 to: *data.owner.as_eth(),883 token_id: token.into(),884 }885 .to_log(collection_id_to_address(collection.id)),886 );887 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(888 collection.id,889 TokenId(token),890 data.owner.clone(),891 1,892 ));893 }894 Ok(())895 }896897 pub fn set_allowance_unchecked(898 collection: &NonfungibleHandle<T>,899 sender: &T::CrossAccountId,900 token: TokenId,901 spender: Option<&T::CrossAccountId>,902 assume_implicit_eth: bool,903 ) {904 if let Some(spender) = spender {905 let old_spender = <Allowance<T>>::get((collection.id, token));906 <Allowance<T>>::insert((collection.id, token), spender);907 // In ERC721 there is only one possible approved user of token, so we set908 // approved user to spender909 <PalletEvm<T>>::deposit_log(910 ERC721Events::Approval {911 owner: *sender.as_eth(),912 approved: *spender.as_eth(),913 token_id: token.into(),914 }915 .to_log(collection_id_to_address(collection.id)),916 );917 // In Unique chain, any token can have any amount of approved users, so we need to918 // set allowance of old owner to 0, and allowance of new owner to 1919 if old_spender.as_ref() != Some(spender) {920 if let Some(old_owner) = old_spender {921 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(922 collection.id,923 token,924 sender.clone(),925 old_owner,926 0,927 ));928 }929 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(930 collection.id,931 token,932 sender.clone(),933 spender.clone(),934 1,935 ));936 }937 } else {938 let old_spender = <Allowance<T>>::take((collection.id, token));939 if !assume_implicit_eth {940 // In ERC721 there is only one possible approved user of token, so we set941 // approved user to zero address942 <PalletEvm<T>>::deposit_log(943 ERC721Events::Approval {944 owner: *sender.as_eth(),945 approved: H160::default(),946 token_id: token.into(),947 }948 .to_log(collection_id_to_address(collection.id)),949 );950 }951 // In Unique chain, any token can have any amount of approved users, so we need to952 // set allowance of old owner to 0953 if let Some(old_spender) = old_spender {954 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(955 collection.id,956 token,957 sender.clone(),958 old_spender,959 0,960 ));961 }962 }963 }964965 pub fn set_allowance(966 collection: &NonfungibleHandle<T>,967 sender: &T::CrossAccountId,968 token: TokenId,969 spender: Option<&T::CrossAccountId>,970 ) -> DispatchResult {971 if collection.permissions.access() == AccessMode::AllowList {972 collection.check_allowlist(sender)?;973 if let Some(spender) = spender {974 collection.check_allowlist(spender)?;975 }976 }977978 if let Some(spender) = spender {979 <PalletCommon<T>>::ensure_correct_receiver(spender)?;980 }981982 let token_data =983 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;984 if &token_data.owner != sender {985 ensure!(986 collection.ignores_owned_amount(sender),987 <CommonError<T>>::CantApproveMoreThanOwned988 );989 }990991 // =========992993 Self::set_allowance_unchecked(collection, sender, token, spender, false);994 Ok(())995 }996997 fn check_allowed(998 collection: &NonfungibleHandle<T>,999 spender: &T::CrossAccountId,1000 from: &T::CrossAccountId,1001 token: TokenId,1002 nesting_budget: &dyn Budget,1003 ) -> DispatchResult {1004 if spender.conv_eq(from) {1005 return Ok(());1006 }1007 if collection.permissions.access() == AccessMode::AllowList {1008 // `from`, `to` checked in [`transfer`]1009 collection.check_allowlist(spender)?;1010 }1011 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1012 // TODO: should collection owner be allowed to perform this transfer?1013 ensure!(1014 <PalletStructure<T>>::check_indirectly_owned(1015 spender.clone(),1016 source.0,1017 source.1,1018 None,1019 nesting_budget1020 )?,1021 <CommonError<T>>::ApprovedValueTooLow,1022 );1023 return Ok(());1024 }1025 if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1026 return Ok(());1027 }1028 ensure!(1029 collection.ignores_allowance(spender),1030 <CommonError<T>>::ApprovedValueTooLow1031 );1032 Ok(())1033 }10341035 pub fn transfer_from(1036 collection: &NonfungibleHandle<T>,1037 spender: &T::CrossAccountId,1038 from: &T::CrossAccountId,1039 to: &T::CrossAccountId,1040 token: TokenId,1041 nesting_budget: &dyn Budget,1042 ) -> DispatchResult {1043 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10441045 // =========10461047 // Allowance is reset in [`transfer`]1048 Self::transfer(collection, from, to, token, nesting_budget)1049 }10501051 pub fn burn_from(1052 collection: &NonfungibleHandle<T>,1053 spender: &T::CrossAccountId,1054 from: &T::CrossAccountId,1055 token: TokenId,1056 nesting_budget: &dyn Budget,1057 ) -> DispatchResult {1058 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10591060 // =========10611062 Self::burn(collection, from, token)1063 }10641065 pub fn check_nesting(1066 handle: &NonfungibleHandle<T>,1067 sender: T::CrossAccountId,1068 from: (CollectionId, TokenId),1069 under: TokenId,1070 nesting_budget: &dyn Budget,1071 ) -> DispatchResult {1072 let nesting = handle.permissions.nesting();10731074 #[cfg(not(feature = "runtime-benchmarks"))]1075 let permissive = false;1076 #[cfg(feature = "runtime-benchmarks")]1077 let permissive = nesting.permissive;10781079 if permissive {1080 // Pass1081 } else if nesting.token_owner1082 && <PalletStructure<T>>::check_indirectly_owned(1083 sender.clone(),1084 handle.id,1085 under,1086 Some(from),1087 nesting_budget,1088 )? {1089 // Pass1090 } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1091 // Pass1092 } else {1093 fail!(<CommonError<T>>::UserIsNotAllowedToNest);1094 }10951096 if let Some(whitelist) = &nesting.restricted {1097 ensure!(1098 whitelist.contains(&from.0),1099 <CommonError<T>>::SourceCollectionIsNotAllowedToNest1100 );1101 }1102 Ok(())1103 }11041105 fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1106 <TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1107 }11081109 fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1110 <TokenChildren<T>>::remove((under.0, under.1, to_unnest));1111 }11121113 fn collection_has_tokens(collection_id: CollectionId) -> bool {1114 <TokenData<T>>::iter_prefix((collection_id,))1115 .next()1116 .is_some()1117 }11181119 fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1120 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1121 .next()1122 .is_some()1123 }11241125 pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1126 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1127 .map(|((child_collection_id, child_id), _)| TokenChild {1128 collection: child_collection_id,1129 token: child_id,1130 })1131 .collect()1132 }11331134 /// Delegated to `create_multiple_items`1135 pub fn create_item(1136 collection: &NonfungibleHandle<T>,1137 sender: &T::CrossAccountId,1138 data: CreateItemData<T>,1139 nesting_budget: &dyn Budget,1140 ) -> DispatchResult {1141 Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1142 }1143}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#![cfg_attr(not(feature = "std"), no_std)]1819use erc::ERC721Events;20use evm_coder::ToLog;21use frame_support::{22 BoundedVec, ensure, fail, transactional,23 storage::with_transaction,24 pallet_prelude::DispatchResultWithPostInfo,25 pallet_prelude::Weight,26 weights::{PostDispatchInfo, Pays},27};28use up_data_structs::{29 AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,30 mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission, PropertyKey,31 PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,32 AuxPropertyValue,33};34use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};35use pallet_common::{36 Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,37 eth::collection_id_to_address,38};39use pallet_structure::{Pallet as PalletStructure, Error as StructureError};40use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};41use sp_core::H160;42use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};43use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap, collections::btree_set::BTreeSet};44use core::ops::Deref;45use codec::{Encode, Decode, MaxEncodedLen};46use scale_info::TypeInfo;4748pub use pallet::*;49use weights::WeightInfo;50#[cfg(feature = "runtime-benchmarks")]51pub mod benchmarking;52pub mod common;53pub mod erc;54pub mod weights;5556pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;57pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;5859#[struct_versioning::versioned(version = 2, upper)]60#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]61pub struct ItemData<CrossAccountId> {62 #[version(..2)]63 pub const_data: BoundedVec<u8, CustomDataLimit>,6465 #[version(..2)]66 pub variable_data: BoundedVec<u8, CustomDataLimit>,6768 pub owner: CrossAccountId,69}7071#[frame_support::pallet]72pub mod pallet {73 use super::*;74 use frame_support::{75 Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,76 };77 use frame_system::pallet_prelude::*;78 use up_data_structs::{CollectionId, TokenId};79 use super::weights::WeightInfo;8081 #[pallet::error]82 pub enum Error<T> {83 /// Not Nonfungible item data used to mint in Nonfungible collection.84 NotNonfungibleDataUsedToMintFungibleCollectionToken,85 /// Used amount > 1 with NFT86 NonfungibleItemsHaveNoAmount,87 /// Unable to burn NFT with children88 CantBurnNftWithChildren,89 }9091 #[pallet::config]92 pub trait Config:93 frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config94 {95 type WeightInfo: WeightInfo;96 }9798 const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);99100 #[pallet::pallet]101 #[pallet::storage_version(STORAGE_VERSION)]102 #[pallet::generate_store(pub(super) trait Store)]103 pub struct Pallet<T>(_);104105 #[pallet::storage]106 pub type TokensMinted<T: Config> =107 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;108 #[pallet::storage]109 pub type TokensBurnt<T: Config> =110 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;111112 #[pallet::storage]113 pub type TokenData<T: Config> = StorageNMap<114 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),115 Value = ItemData<T::CrossAccountId>,116 QueryKind = OptionQuery,117 >;118119 #[pallet::storage]120 #[pallet::getter(fn token_properties)]121 pub type TokenProperties<T: Config> = StorageNMap<122 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),123 Value = Properties,124 QueryKind = ValueQuery,125 OnEmpty = up_data_structs::TokenProperties,126 >;127128 #[pallet::storage]129 #[pallet::getter(fn token_aux_property)]130 pub type TokenAuxProperties<T: Config> = StorageNMap<131 Key = (132 Key<Twox64Concat, CollectionId>,133 Key<Twox64Concat, TokenId>,134 Key<Twox64Concat, PropertyScope>,135 Key<Twox64Concat, PropertyKey>,136 ),137 Value = AuxPropertyValue,138 QueryKind = OptionQuery,139 >;140141 /// Used to enumerate tokens owned by account142 #[pallet::storage]143 pub type Owned<T: Config> = StorageNMap<144 Key = (145 Key<Twox64Concat, CollectionId>,146 Key<Blake2_128Concat, T::CrossAccountId>,147 Key<Twox64Concat, TokenId>,148 ),149 Value = bool,150 QueryKind = ValueQuery,151 >;152153 /// Used to enumerate token's children154 #[pallet::storage]155 #[pallet::getter(fn token_children)]156 pub type TokenChildren<T: Config> = StorageNMap<157 Key = (158 Key<Twox64Concat, CollectionId>,159 Key<Twox64Concat, TokenId>,160 Key<Twox64Concat, (CollectionId, TokenId)>,161 ),162 Value = bool,163 QueryKind = ValueQuery,164 >;165166 #[pallet::storage]167 pub type AccountBalance<T: Config> = StorageNMap<168 Key = (169 Key<Twox64Concat, CollectionId>,170 Key<Blake2_128Concat, T::CrossAccountId>,171 ),172 Value = u32,173 QueryKind = ValueQuery,174 >;175176 #[pallet::storage]177 pub type Allowance<T: Config> = StorageNMap<178 Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),179 Value = T::CrossAccountId,180 QueryKind = OptionQuery,181 >;182183 #[pallet::hooks]184 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {185 fn on_runtime_upgrade() -> Weight {186 if StorageVersion::get::<Pallet<T>>() < StorageVersion::new(1) {187 let mut had_consts = BTreeSet::new();188 <TokenData<T>>::translate::<ItemDataVersion1<T::CrossAccountId>, _>(189 |(collection, token), v| {190 let mut props = vec![];191 if !v.const_data.is_empty() {192 props.push(Property {193 key: b"_old_constData".to_vec().try_into().unwrap(),194 value: v195 .const_data196 .clone()197 .into_inner()198 .try_into()199 .expect("const too long"),200 });201 had_consts.insert(collection);202 }203 if !v.variable_data.is_empty() {204 props.push(Property {205 key: b"_old_variableData".to_vec().try_into().unwrap(),206 value: v207 .variable_data208 .clone()209 .into_inner()210 .try_into()211 .expect("variable too long"),212 })213 }214 if !props.is_empty() {215 Self::set_scoped_token_properties(216 collection,217 token,218 PropertyScope::None,219 props.into_iter(),220 )221 .expect("existing token data exceeds property storage");222 }223 Some(<ItemDataVersion2<T::CrossAccountId>>::from(v))224 },225 );226 for collection in had_consts {227 <PalletCommon<T>>::set_property_permission_unchecked(228 collection,229 PropertyKeyPermission {230 key: b"_old_constData".to_vec().try_into().unwrap(),231 permission: PropertyPermission {232 mutable: false,233 collection_admin: true,234 token_owner: false,235 },236 },237 )238 .expect("failed to configure permission");239 }240 }241242 0243 }244 }245}246247pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);248impl<T: Config> NonfungibleHandle<T> {249 pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {250 Self(inner)251 }252 pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {253 self.0254 }255 pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {256 &mut self.0257 }258}259impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {260 fn recorder(&self) -> &SubstrateRecorder<T> {261 self.0.recorder()262 }263 fn into_recorder(self) -> SubstrateRecorder<T> {264 self.0.into_recorder()265 }266}267impl<T: Config> Deref for NonfungibleHandle<T> {268 type Target = pallet_common::CollectionHandle<T>;269270 fn deref(&self) -> &Self::Target {271 &self.0272 }273}274275impl<T: Config> Pallet<T> {276 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {277 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)278 }279 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {280 <TokenData<T>>::contains_key((collection.id, token))281 }282283 pub fn set_scoped_token_property(284 collection_id: CollectionId,285 token_id: TokenId,286 scope: PropertyScope,287 property: Property,288 ) -> DispatchResult {289 TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {290 properties.try_scoped_set(scope, property.key, property.value)291 })292 .map_err(<CommonError<T>>::from)?;293294 Ok(())295 }296297 pub fn set_scoped_token_properties(298 collection_id: CollectionId,299 token_id: TokenId,300 scope: PropertyScope,301 properties: impl Iterator<Item = Property>,302 ) -> DispatchResult {303 TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {304 stored_properties.try_scoped_set_from_iter(scope, properties)305 })306 .map_err(<CommonError<T>>::from)?;307308 Ok(())309 }310311 pub fn try_mutate_token_aux_property<R, E>(312 collection_id: CollectionId,313 token_id: TokenId,314 scope: PropertyScope,315 key: PropertyKey,316 f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,317 ) -> Result<R, E> {318 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)319 }320321 pub fn remove_token_aux_property(322 collection_id: CollectionId,323 token_id: TokenId,324 scope: PropertyScope,325 key: PropertyKey,326 ) {327 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));328 }329330 pub fn iterate_token_aux_properties(331 collection_id: CollectionId,332 token_id: TokenId,333 scope: PropertyScope,334 ) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {335 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))336 }337338 pub fn current_token_id(collection_id: CollectionId) -> TokenId {339 TokenId(<TokensMinted<T>>::get(collection_id))340 }341}342343// unchecked calls skips any permission checks344impl<T: Config> Pallet<T> {345 pub fn init_collection(346 owner: T::CrossAccountId,347 data: CreateCollectionData<T::AccountId>,348 is_external: bool,349 ) -> Result<CollectionId, DispatchError> {350 <PalletCommon<T>>::init_collection(owner, data, is_external)351 }352 pub fn destroy_collection(353 collection: NonfungibleHandle<T>,354 sender: &T::CrossAccountId,355 ) -> DispatchResult {356 let id = collection.id;357358 if Self::collection_has_tokens(id) {359 return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());360 }361362 // =========363364 PalletCommon::destroy_collection(collection.0, sender)?;365366 <TokenData<T>>::remove_prefix((id,), None);367 <TokenChildren<T>>::remove_prefix((id,), None);368 <Owned<T>>::remove_prefix((id,), None);369 <TokensMinted<T>>::remove(id);370 <TokensBurnt<T>>::remove(id);371 <Allowance<T>>::remove_prefix((id,), None);372 <AccountBalance<T>>::remove_prefix((id,), None);373 Ok(())374 }375376 pub fn burn(377 collection: &NonfungibleHandle<T>,378 sender: &T::CrossAccountId,379 token: TokenId,380 ) -> DispatchResult {381 let token_data =382 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;383 ensure!(384 &token_data.owner == sender385 || (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(sender)),386 <CommonError<T>>::NoPermission387 );388389 if collection.permissions.access() == AccessMode::AllowList {390 collection.check_allowlist(sender)?;391 }392393 if Self::token_has_children(collection.id, token) {394 return Err(<Error<T>>::CantBurnNftWithChildren.into());395 }396397 let burnt = <TokensBurnt<T>>::get(collection.id)398 .checked_add(1)399 .ok_or(ArithmeticError::Overflow)?;400401 let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))402 .checked_sub(1)403 .ok_or(ArithmeticError::Overflow)?;404405 // =========406407 if balance == 0 {408 <AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));409 } else {410 <AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);411 }412413 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);414415 <Owned<T>>::remove((collection.id, &token_data.owner, token));416 <TokensBurnt<T>>::insert(collection.id, burnt);417 <TokenData<T>>::remove((collection.id, token));418 <TokenProperties<T>>::remove((collection.id, token));419 <TokenAuxProperties<T>>::remove_prefix((collection.id, token), None);420 let old_spender = <Allowance<T>>::take((collection.id, token));421422 if let Some(old_spender) = old_spender {423 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(424 collection.id,425 token,426 token_data.owner.clone(),427 old_spender,428 0,429 ));430 }431432 <PalletEvm<T>>::deposit_log(433 ERC721Events::Transfer {434 from: *token_data.owner.as_eth(),435 to: H160::default(),436 token_id: token.into(),437 }438 .to_log(collection_id_to_address(collection.id)),439 );440 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(441 collection.id,442 token,443 token_data.owner,444 1,445 ));446 Ok(())447 }448449 #[transactional]450 pub fn burn_recursively(451 collection: &NonfungibleHandle<T>,452 sender: &T::CrossAccountId,453 token: TokenId,454 self_budget: &dyn Budget,455 breadth_budget: &dyn Budget,456 ) -> DispatchResultWithPostInfo {457 ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);458459 let current_token_account =460 T::CrossTokenAddressMapping::token_to_address(collection.id, token);461462 let mut weight = 0 as Weight;463464 // This method is transactional, if user in fact doesn't have permissions to remove token -465 // tokens removed here will be restored after rejected transaction466 for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {467 ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);468 let PostDispatchInfo { actual_weight, .. } =469 <PalletStructure<T>>::burn_item_recursively(470 current_token_account.clone(),471 collection,472 token,473 self_budget,474 breadth_budget,475 )?;476 if let Some(actual_weight) = actual_weight {477 weight = weight.saturating_add(actual_weight);478 }479 }480481 Self::burn(collection, sender, token)?;482 DispatchResultWithPostInfo::Ok(PostDispatchInfo {483 actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),484 pays_fee: Pays::Yes,485 })486 }487488 #[transactional]489 fn modify_token_properties(490 collection: &NonfungibleHandle<T>,491 sender: &T::CrossAccountId,492 token_id: TokenId,493 properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,494 is_token_create: bool,495 nesting_budget: &dyn Budget,496 ) -> DispatchResult {497 let mut collection_admin_status = None;498 let mut token_owner_result = None;499500 let mut is_collection_admin =501 || *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));502503 let mut is_token_owner = || {504 *token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {505 let is_owned = <PalletStructure<T>>::check_indirectly_owned(506 sender.clone(),507 collection.id,508 token_id,509 None,510 nesting_budget,511 )?;512513 Ok(is_owned)514 })515 };516517 for (key, value) in properties {518 let permission = <PalletCommon<T>>::property_permissions(collection.id)519 .get(&key)520 .cloned()521 .unwrap_or_else(PropertyPermission::none);522523 let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))524 .get(&key)525 .is_some();526527 match permission {528 PropertyPermission { mutable: false, .. } if is_property_exists => {529 return Err(<CommonError<T>>::NoPermission.into());530 }531532 PropertyPermission {533 collection_admin,534 token_owner,535 ..536 } => {537 //TODO: investigate threats during public minting.538 if is_token_create && (collection_admin || token_owner) && value.is_some() {539 // Pass540 } else if collection_admin && is_collection_admin() {541 // Pass542 } else if token_owner && is_token_owner()? {543 // Pass544 } else {545 fail!(<CommonError<T>>::NoPermission);546 }547 }548 }549550 match value {551 Some(value) => {552 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {553 properties.try_set(key.clone(), value)554 })555 .map_err(<CommonError<T>>::from)?;556557 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(558 collection.id,559 token_id,560 key,561 ));562 }563 None => {564 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {565 properties.remove(&key)566 })567 .map_err(<CommonError<T>>::from)?;568569 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(570 collection.id,571 token_id,572 key,573 ));574 }575 }576 }577578 Ok(())579 }580581 pub fn set_token_properties(582 collection: &NonfungibleHandle<T>,583 sender: &T::CrossAccountId,584 token_id: TokenId,585 properties: impl Iterator<Item = Property>,586 is_token_create: bool,587 nesting_budget: &dyn Budget,588 ) -> DispatchResult {589 Self::modify_token_properties(590 collection,591 sender,592 token_id,593 properties.map(|p| (p.key, Some(p.value))),594 is_token_create,595 nesting_budget,596 )597 }598599 pub fn set_token_property(600 collection: &NonfungibleHandle<T>,601 sender: &T::CrossAccountId,602 token_id: TokenId,603 property: Property,604 nesting_budget: &dyn Budget,605 ) -> DispatchResult {606 let is_token_create = false;607608 Self::set_token_properties(609 collection,610 sender,611 token_id,612 [property].into_iter(),613 is_token_create,614 nesting_budget,615 )616 }617618 pub fn delete_token_properties(619 collection: &NonfungibleHandle<T>,620 sender: &T::CrossAccountId,621 token_id: TokenId,622 property_keys: impl Iterator<Item = PropertyKey>,623 nesting_budget: &dyn Budget,624 ) -> DispatchResult {625 let is_token_create = false;626627 Self::modify_token_properties(628 collection,629 sender,630 token_id,631 property_keys.into_iter().map(|key| (key, None)),632 is_token_create,633 nesting_budget,634 )635 }636637 pub fn delete_token_property(638 collection: &NonfungibleHandle<T>,639 sender: &T::CrossAccountId,640 token_id: TokenId,641 property_key: PropertyKey,642 nesting_budget: &dyn Budget,643 ) -> DispatchResult {644 Self::delete_token_properties(645 collection,646 sender,647 token_id,648 [property_key].into_iter(),649 nesting_budget,650 )651 }652653 pub fn set_collection_properties(654 collection: &NonfungibleHandle<T>,655 sender: &T::CrossAccountId,656 properties: Vec<Property>,657 ) -> DispatchResult {658 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)659 }660661 pub fn delete_collection_properties(662 collection: &CollectionHandle<T>,663 sender: &T::CrossAccountId,664 property_keys: Vec<PropertyKey>,665 ) -> DispatchResult {666 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)667 }668669 pub fn set_token_property_permissions(670 collection: &CollectionHandle<T>,671 sender: &T::CrossAccountId,672 property_permissions: Vec<PropertyKeyPermission>,673 ) -> DispatchResult {674 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)675 }676677 pub fn set_property_permission(678 collection: &CollectionHandle<T>,679 sender: &T::CrossAccountId,680 permission: PropertyKeyPermission,681 ) -> DispatchResult {682 <PalletCommon<T>>::set_property_permission(collection, sender, permission)683 }684685 pub fn transfer(686 collection: &NonfungibleHandle<T>,687 from: &T::CrossAccountId,688 to: &T::CrossAccountId,689 token: TokenId,690 nesting_budget: &dyn Budget,691 ) -> DispatchResult {692 ensure!(693 collection.limits.transfers_enabled(),694 <CommonError<T>>::TransferNotAllowed695 );696697 let token_data =698 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;699 // TODO: require sender to be token, owner, require admins to go through transfer_from700 ensure!(701 &token_data.owner == from702 || (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(from)),703 <CommonError<T>>::NoPermission704 );705706 if collection.permissions.access() == AccessMode::AllowList {707 collection.check_allowlist(from)?;708 collection.check_allowlist(to)?;709 }710 <PalletCommon<T>>::ensure_correct_receiver(to)?;711712 let balance_from = <AccountBalance<T>>::get((collection.id, from))713 .checked_sub(1)714 .ok_or(<CommonError<T>>::TokenValueTooLow)?;715 let balance_to = if from != to {716 let balance_to = <AccountBalance<T>>::get((collection.id, to))717 .checked_add(1)718 .ok_or(ArithmeticError::Overflow)?;719720 ensure!(721 balance_to < collection.limits.account_token_ownership_limit(),722 <CommonError<T>>::AccountTokenLimitExceeded,723 );724725 Some(balance_to)726 } else {727 None728 };729730 <PalletStructure<T>>::nest_if_sent_to_token(731 from.clone(),732 to,733 collection.id,734 token,735 nesting_budget,736 )?;737738 // =========739740 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);741742 <TokenData<T>>::insert(743 (collection.id, token),744 ItemData {745 owner: to.clone(),746 ..token_data747 },748 );749750 if let Some(balance_to) = balance_to {751 // from != to752 if balance_from == 0 {753 <AccountBalance<T>>::remove((collection.id, from));754 } else {755 <AccountBalance<T>>::insert((collection.id, from), balance_from);756 }757 <AccountBalance<T>>::insert((collection.id, to), balance_to);758 <Owned<T>>::remove((collection.id, from, token));759 <Owned<T>>::insert((collection.id, to, token), true);760 }761 Self::set_allowance_unchecked(collection, from, token, None, true);762763 <PalletEvm<T>>::deposit_log(764 ERC721Events::Transfer {765 from: *from.as_eth(),766 to: *to.as_eth(),767 token_id: token.into(),768 }769 .to_log(collection_id_to_address(collection.id)),770 );771 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(772 collection.id,773 token,774 from.clone(),775 to.clone(),776 1,777 ));778 Ok(())779 }780781 pub fn create_multiple_items(782 collection: &NonfungibleHandle<T>,783 sender: &T::CrossAccountId,784 data: Vec<CreateItemData<T>>,785 nesting_budget: &dyn Budget,786 ) -> DispatchResult {787 if !collection.is_owner_or_admin(sender) {788 ensure!(789 collection.permissions.mint_mode(),790 <CommonError<T>>::PublicMintingNotAllowed791 );792 collection.check_allowlist(sender)?;793794 for item in data.iter() {795 collection.check_allowlist(&item.owner)?;796 }797 }798799 for data in data.iter() {800 <PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;801 }802803 let first_token = <TokensMinted<T>>::get(collection.id);804 let tokens_minted = first_token805 .checked_add(data.len() as u32)806 .ok_or(ArithmeticError::Overflow)?;807 ensure!(808 tokens_minted <= collection.limits.token_limit(),809 <CommonError<T>>::CollectionTokenLimitExceeded810 );811812 let mut balances = BTreeMap::new();813 for data in &data {814 let balance = balances815 .entry(&data.owner)816 .or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));817 *balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;818819 ensure!(820 *balance <= collection.limits.account_token_ownership_limit(),821 <CommonError<T>>::AccountTokenLimitExceeded,822 );823 }824825 for (i, data) in data.iter().enumerate() {826 let token = TokenId(first_token + i as u32 + 1);827828 <PalletStructure<T>>::check_nesting(829 sender.clone(),830 &data.owner,831 collection.id,832 token,833 nesting_budget,834 )?;835 }836837 // =========838839 with_transaction(|| {840 for (i, data) in data.iter().enumerate() {841 let token = first_token + i as u32 + 1;842843 <TokenData<T>>::insert(844 (collection.id, token),845 ItemData {846 // const_data: data.const_data.clone(),847 owner: data.owner.clone(),848 },849 );850851 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(852 &data.owner,853 collection.id,854 TokenId(token),855 );856857 if let Err(e) = Self::set_token_properties(858 collection,859 sender,860 TokenId(token),861 data.properties.clone().into_iter(),862 true,863 nesting_budget,864 ) {865 return TransactionOutcome::Rollback(Err(e));866 }867 }868 TransactionOutcome::Commit(Ok(()))869 })?;870871 <TokensMinted<T>>::insert(collection.id, tokens_minted);872 for (account, balance) in balances {873 <AccountBalance<T>>::insert((collection.id, account), balance);874 }875 for (i, data) in data.into_iter().enumerate() {876 let token = first_token + i as u32 + 1;877 <Owned<T>>::insert((collection.id, &data.owner, token), true);878879 <PalletEvm<T>>::deposit_log(880 ERC721Events::Transfer {881 from: H160::default(),882 to: *data.owner.as_eth(),883 token_id: token.into(),884 }885 .to_log(collection_id_to_address(collection.id)),886 );887 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(888 collection.id,889 TokenId(token),890 data.owner.clone(),891 1,892 ));893 }894 Ok(())895 }896897 pub fn set_allowance_unchecked(898 collection: &NonfungibleHandle<T>,899 sender: &T::CrossAccountId,900 token: TokenId,901 spender: Option<&T::CrossAccountId>,902 assume_implicit_eth: bool,903 ) {904 if let Some(spender) = spender {905 let old_spender = <Allowance<T>>::get((collection.id, token));906 <Allowance<T>>::insert((collection.id, token), spender);907 // In ERC721 there is only one possible approved user of token, so we set908 // approved user to spender909 <PalletEvm<T>>::deposit_log(910 ERC721Events::Approval {911 owner: *sender.as_eth(),912 approved: *spender.as_eth(),913 token_id: token.into(),914 }915 .to_log(collection_id_to_address(collection.id)),916 );917 // In Unique chain, any token can have any amount of approved users, so we need to918 // set allowance of old owner to 0, and allowance of new owner to 1919 if old_spender.as_ref() != Some(spender) {920 if let Some(old_owner) = old_spender {921 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(922 collection.id,923 token,924 sender.clone(),925 old_owner,926 0,927 ));928 }929 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(930 collection.id,931 token,932 sender.clone(),933 spender.clone(),934 1,935 ));936 }937 } else {938 let old_spender = <Allowance<T>>::take((collection.id, token));939 if !assume_implicit_eth {940 // In ERC721 there is only one possible approved user of token, so we set941 // approved user to zero address942 <PalletEvm<T>>::deposit_log(943 ERC721Events::Approval {944 owner: *sender.as_eth(),945 approved: H160::default(),946 token_id: token.into(),947 }948 .to_log(collection_id_to_address(collection.id)),949 );950 }951 // In Unique chain, any token can have any amount of approved users, so we need to952 // set allowance of old owner to 0953 if let Some(old_spender) = old_spender {954 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(955 collection.id,956 token,957 sender.clone(),958 old_spender,959 0,960 ));961 }962 }963 }964965 pub fn set_allowance(966 collection: &NonfungibleHandle<T>,967 sender: &T::CrossAccountId,968 token: TokenId,969 spender: Option<&T::CrossAccountId>,970 ) -> DispatchResult {971 if collection.permissions.access() == AccessMode::AllowList {972 collection.check_allowlist(sender)?;973 if let Some(spender) = spender {974 collection.check_allowlist(spender)?;975 }976 }977978 if let Some(spender) = spender {979 <PalletCommon<T>>::ensure_correct_receiver(spender)?;980 }981982 let token_data =983 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;984 if &token_data.owner != sender {985 ensure!(986 collection.ignores_owned_amount(sender),987 <CommonError<T>>::CantApproveMoreThanOwned988 );989 }990991 // =========992993 Self::set_allowance_unchecked(collection, sender, token, spender, false);994 Ok(())995 }996997 fn check_allowed(998 collection: &NonfungibleHandle<T>,999 spender: &T::CrossAccountId,1000 from: &T::CrossAccountId,1001 token: TokenId,1002 nesting_budget: &dyn Budget,1003 ) -> DispatchResult {1004 if spender.conv_eq(from) {1005 return Ok(());1006 }1007 if collection.permissions.access() == AccessMode::AllowList {1008 // `from`, `to` checked in [`transfer`]1009 collection.check_allowlist(spender)?;1010 }1011 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1012 // TODO: should collection owner be allowed to perform this transfer?1013 ensure!(1014 <PalletStructure<T>>::check_indirectly_owned(1015 spender.clone(),1016 source.0,1017 source.1,1018 None,1019 nesting_budget1020 )?,1021 <CommonError<T>>::ApprovedValueTooLow,1022 );1023 return Ok(());1024 }1025 if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1026 return Ok(());1027 }1028 ensure!(1029 collection.ignores_allowance(spender),1030 <CommonError<T>>::ApprovedValueTooLow1031 );1032 Ok(())1033 }10341035 pub fn transfer_from(1036 collection: &NonfungibleHandle<T>,1037 spender: &T::CrossAccountId,1038 from: &T::CrossAccountId,1039 to: &T::CrossAccountId,1040 token: TokenId,1041 nesting_budget: &dyn Budget,1042 ) -> DispatchResult {1043 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10441045 // =========10461047 // Allowance is reset in [`transfer`]1048 Self::transfer(collection, from, to, token, nesting_budget)1049 }10501051 pub fn burn_from(1052 collection: &NonfungibleHandle<T>,1053 spender: &T::CrossAccountId,1054 from: &T::CrossAccountId,1055 token: TokenId,1056 nesting_budget: &dyn Budget,1057 ) -> DispatchResult {1058 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10591060 // =========10611062 Self::burn(collection, from, token)1063 }10641065 pub fn check_nesting(1066 handle: &NonfungibleHandle<T>,1067 sender: T::CrossAccountId,1068 from: (CollectionId, TokenId),1069 under: TokenId,1070 nesting_budget: &dyn Budget,1071 ) -> DispatchResult {1072 let nesting = handle.permissions.nesting();10731074 #[cfg(not(feature = "runtime-benchmarks"))]1075 let permissive = false;1076 #[cfg(feature = "runtime-benchmarks")]1077 let permissive = nesting.permissive;10781079 if permissive {1080 // Pass1081 } else if nesting.token_owner1082 && <PalletStructure<T>>::check_indirectly_owned(1083 sender.clone(),1084 handle.id,1085 under,1086 Some(from),1087 nesting_budget,1088 )? {1089 // Pass1090 } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1091 // Pass1092 } else {1093 fail!(<CommonError<T>>::UserIsNotAllowedToNest);1094 }10951096 if let Some(whitelist) = &nesting.restricted {1097 ensure!(1098 whitelist.contains(&from.0),1099 <CommonError<T>>::SourceCollectionIsNotAllowedToNest1100 );1101 }1102 Ok(())1103 }11041105 fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1106 <TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1107 }11081109 fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1110 <TokenChildren<T>>::remove((under.0, under.1, to_unnest));1111 }11121113 fn collection_has_tokens(collection_id: CollectionId) -> bool {1114 <TokenData<T>>::iter_prefix((collection_id,))1115 .next()1116 .is_some()1117 }11181119 fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1120 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1121 .next()1122 .is_some()1123 }11241125 pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1126 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1127 .map(|((child_collection_id, child_id), _)| TokenChild {1128 collection: child_collection_id,1129 token: child_id,1130 })1131 .collect()1132 }11331134 /// Delegated to `create_multiple_items`1135 pub fn create_item(1136 collection: &NonfungibleHandle<T>,1137 sender: &T::CrossAccountId,1138 data: CreateItemData<T>,1139 nesting_budget: &dyn Budget,1140 ) -> DispatchResult {1141 Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1142 }1143}