difftreelog
feat force version upgrade
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!(&token_data.owner == sender, <CommonError<T>>::NoPermission);384385 if collection.permissions.access() == AccessMode::AllowList {386 collection.check_allowlist(sender)?;387 }388389 if Self::token_has_children(collection.id, token) {390 return Err(<Error<T>>::CantBurnNftWithChildren.into());391 }392393 let burnt = <TokensBurnt<T>>::get(collection.id)394 .checked_add(1)395 .ok_or(ArithmeticError::Overflow)?;396397 let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))398 .checked_sub(1)399 .ok_or(ArithmeticError::Overflow)?;400401 // =========402403 if balance == 0 {404 <AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));405 } else {406 <AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);407 }408409 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);410411 <Owned<T>>::remove((collection.id, &token_data.owner, token));412 <TokensBurnt<T>>::insert(collection.id, burnt);413 <TokenData<T>>::remove((collection.id, token));414 <TokenProperties<T>>::remove((collection.id, token));415 <TokenAuxProperties<T>>::remove_prefix((collection.id, token), None);416 let old_spender = <Allowance<T>>::take((collection.id, token));417418 if let Some(old_spender) = old_spender {419 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(420 collection.id,421 token,422 token_data.owner.clone(),423 old_spender,424 0,425 ));426 }427428 <PalletEvm<T>>::deposit_log(429 ERC721Events::Transfer {430 from: *token_data.owner.as_eth(),431 to: H160::default(),432 token_id: token.into(),433 }434 .to_log(collection_id_to_address(collection.id)),435 );436 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(437 collection.id,438 token,439 token_data.owner,440 1,441 ));442 Ok(())443 }444445 #[transactional]446 pub fn burn_recursively(447 collection: &NonfungibleHandle<T>,448 sender: &T::CrossAccountId,449 token: TokenId,450 self_budget: &dyn Budget,451 breadth_budget: &dyn Budget,452 ) -> DispatchResultWithPostInfo {453 ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);454455 let current_token_account =456 T::CrossTokenAddressMapping::token_to_address(collection.id, token);457458 let mut weight = 0 as Weight;459460 // This method is transactional, if user in fact doesn't have permissions to remove token -461 // tokens removed here will be restored after rejected transaction462 for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {463 ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);464 let PostDispatchInfo { actual_weight, .. } =465 <PalletStructure<T>>::burn_item_recursively(466 current_token_account.clone(),467 collection,468 token,469 self_budget,470 breadth_budget,471 )?;472 if let Some(actual_weight) = actual_weight {473 weight = weight.saturating_add(actual_weight);474 }475 }476477 Self::burn(collection, sender, token)?;478 DispatchResultWithPostInfo::Ok(PostDispatchInfo {479 actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),480 pays_fee: Pays::Yes,481 })482 }483484 #[transactional]485 fn modify_token_properties(486 collection: &NonfungibleHandle<T>,487 sender: &T::CrossAccountId,488 token_id: TokenId,489 properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,490 is_token_create: bool,491 nesting_budget: &dyn Budget,492 ) -> DispatchResult {493 let mut collection_admin_status = None;494 let mut token_owner_result = None;495496 let mut is_collection_admin =497 || *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));498499 let mut is_token_owner = || {500 *token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {501 let is_owned = <PalletStructure<T>>::check_indirectly_owned(502 sender.clone(),503 collection.id,504 token_id,505 None,506 nesting_budget,507 )?;508509 Ok(is_owned)510 })511 };512513 for (key, value) in properties {514 let permission = <PalletCommon<T>>::property_permissions(collection.id)515 .get(&key)516 .cloned()517 .unwrap_or_else(PropertyPermission::none);518519 let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))520 .get(&key)521 .is_some();522523 match permission {524 PropertyPermission { mutable: false, .. } if is_property_exists => {525 return Err(<CommonError<T>>::NoPermission.into());526 }527528 PropertyPermission {529 collection_admin,530 token_owner,531 ..532 } => {533 //TODO: investigate threats during public minting.534 if is_token_create && (collection_admin || token_owner) && value.is_some() {535 // Pass536 } else if collection_admin && is_collection_admin() {537 // Pass538 } else if token_owner && is_token_owner()? {539 // Pass540 } else {541 fail!(<CommonError<T>>::NoPermission);542 }543 }544 }545546 match value {547 Some(value) => {548 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {549 properties.try_set(key.clone(), value)550 })551 .map_err(<CommonError<T>>::from)?;552553 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(554 collection.id,555 token_id,556 key,557 ));558 }559 None => {560 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {561 properties.remove(&key)562 })563 .map_err(<CommonError<T>>::from)?;564565 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(566 collection.id,567 token_id,568 key,569 ));570 }571 }572 }573574 Ok(())575 }576577 pub fn set_token_properties(578 collection: &NonfungibleHandle<T>,579 sender: &T::CrossAccountId,580 token_id: TokenId,581 properties: impl Iterator<Item = Property>,582 is_token_create: bool,583 nesting_budget: &dyn Budget,584 ) -> DispatchResult {585 Self::modify_token_properties(586 collection,587 sender,588 token_id,589 properties.map(|p| (p.key, Some(p.value))),590 is_token_create,591 nesting_budget,592 )593 }594595 pub fn set_token_property(596 collection: &NonfungibleHandle<T>,597 sender: &T::CrossAccountId,598 token_id: TokenId,599 property: Property,600 nesting_budget: &dyn Budget,601 ) -> DispatchResult {602 let is_token_create = false;603604 Self::set_token_properties(605 collection,606 sender,607 token_id,608 [property].into_iter(),609 is_token_create,610 nesting_budget,611 )612 }613614 pub fn delete_token_properties(615 collection: &NonfungibleHandle<T>,616 sender: &T::CrossAccountId,617 token_id: TokenId,618 property_keys: impl Iterator<Item = PropertyKey>,619 nesting_budget: &dyn Budget,620 ) -> DispatchResult {621 let is_token_create = false;622623 Self::modify_token_properties(624 collection,625 sender,626 token_id,627 property_keys.into_iter().map(|key| (key, None)),628 is_token_create,629 nesting_budget,630 )631 }632633 pub fn delete_token_property(634 collection: &NonfungibleHandle<T>,635 sender: &T::CrossAccountId,636 token_id: TokenId,637 property_key: PropertyKey,638 nesting_budget: &dyn Budget,639 ) -> DispatchResult {640 Self::delete_token_properties(641 collection,642 sender,643 token_id,644 [property_key].into_iter(),645 nesting_budget,646 )647 }648649 pub fn set_collection_properties(650 collection: &NonfungibleHandle<T>,651 sender: &T::CrossAccountId,652 properties: Vec<Property>,653 ) -> DispatchResult {654 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)655 }656657 pub fn delete_collection_properties(658 collection: &CollectionHandle<T>,659 sender: &T::CrossAccountId,660 property_keys: Vec<PropertyKey>,661 ) -> DispatchResult {662 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)663 }664665 pub fn set_token_property_permissions(666 collection: &CollectionHandle<T>,667 sender: &T::CrossAccountId,668 property_permissions: Vec<PropertyKeyPermission>,669 ) -> DispatchResult {670 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)671 }672673 pub fn set_property_permission(674 collection: &CollectionHandle<T>,675 sender: &T::CrossAccountId,676 permission: PropertyKeyPermission,677 ) -> DispatchResult {678 <PalletCommon<T>>::set_property_permission(collection, sender, permission)679 }680681 pub fn transfer(682 collection: &NonfungibleHandle<T>,683 from: &T::CrossAccountId,684 to: &T::CrossAccountId,685 token: TokenId,686 nesting_budget: &dyn Budget,687 ) -> DispatchResult {688 ensure!(689 collection.limits.transfers_enabled(),690 <CommonError<T>>::TransferNotAllowed691 );692693 let token_data =694 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;695 ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);696697 if collection.permissions.access() == AccessMode::AllowList {698 collection.check_allowlist(from)?;699 collection.check_allowlist(to)?;700 }701 <PalletCommon<T>>::ensure_correct_receiver(to)?;702703 let balance_from = <AccountBalance<T>>::get((collection.id, from))704 .checked_sub(1)705 .ok_or(<CommonError<T>>::TokenValueTooLow)?;706 let balance_to = if from != to {707 let balance_to = <AccountBalance<T>>::get((collection.id, to))708 .checked_add(1)709 .ok_or(ArithmeticError::Overflow)?;710711 ensure!(712 balance_to < collection.limits.account_token_ownership_limit(),713 <CommonError<T>>::AccountTokenLimitExceeded,714 );715716 Some(balance_to)717 } else {718 None719 };720721 <PalletStructure<T>>::nest_if_sent_to_token(722 from.clone(),723 to,724 collection.id,725 token,726 nesting_budget,727 )?;728729 // =========730731 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);732733 <TokenData<T>>::insert(734 (collection.id, token),735 ItemData {736 owner: to.clone(),737 ..token_data738 },739 );740741 if let Some(balance_to) = balance_to {742 // from != to743 if balance_from == 0 {744 <AccountBalance<T>>::remove((collection.id, from));745 } else {746 <AccountBalance<T>>::insert((collection.id, from), balance_from);747 }748 <AccountBalance<T>>::insert((collection.id, to), balance_to);749 <Owned<T>>::remove((collection.id, from, token));750 <Owned<T>>::insert((collection.id, to, token), true);751 }752 Self::set_allowance_unchecked(collection, from, token, None, true);753754 <PalletEvm<T>>::deposit_log(755 ERC721Events::Transfer {756 from: *from.as_eth(),757 to: *to.as_eth(),758 token_id: token.into(),759 }760 .to_log(collection_id_to_address(collection.id)),761 );762 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(763 collection.id,764 token,765 from.clone(),766 to.clone(),767 1,768 ));769 Ok(())770 }771772 pub fn create_multiple_items(773 collection: &NonfungibleHandle<T>,774 sender: &T::CrossAccountId,775 data: Vec<CreateItemData<T>>,776 nesting_budget: &dyn Budget,777 ) -> DispatchResult {778 if !collection.is_owner_or_admin(sender) {779 ensure!(780 collection.permissions.mint_mode(),781 <CommonError<T>>::PublicMintingNotAllowed782 );783 collection.check_allowlist(sender)?;784785 for item in data.iter() {786 collection.check_allowlist(&item.owner)?;787 }788 }789790 for data in data.iter() {791 <PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;792 }793794 let first_token = <TokensMinted<T>>::get(collection.id);795 let tokens_minted = first_token796 .checked_add(data.len() as u32)797 .ok_or(ArithmeticError::Overflow)?;798 ensure!(799 tokens_minted <= collection.limits.token_limit(),800 <CommonError<T>>::CollectionTokenLimitExceeded801 );802803 let mut balances = BTreeMap::new();804 for data in &data {805 let balance = balances806 .entry(&data.owner)807 .or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));808 *balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;809810 ensure!(811 *balance <= collection.limits.account_token_ownership_limit(),812 <CommonError<T>>::AccountTokenLimitExceeded,813 );814 }815816 for (i, data) in data.iter().enumerate() {817 let token = TokenId(first_token + i as u32 + 1);818819 <PalletStructure<T>>::check_nesting(820 sender.clone(),821 &data.owner,822 collection.id,823 token,824 nesting_budget,825 )?;826 }827828 // =========829830 with_transaction(|| {831 for (i, data) in data.iter().enumerate() {832 let token = first_token + i as u32 + 1;833834 <TokenData<T>>::insert(835 (collection.id, token),836 ItemData {837 // const_data: data.const_data.clone(),838 owner: data.owner.clone(),839 },840 );841842 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(843 &data.owner,844 collection.id,845 TokenId(token),846 );847848 if let Err(e) = Self::set_token_properties(849 collection,850 sender,851 TokenId(token),852 data.properties.clone().into_iter(),853 true,854 nesting_budget,855 ) {856 return TransactionOutcome::Rollback(Err(e));857 }858 }859 TransactionOutcome::Commit(Ok(()))860 })?;861862 <TokensMinted<T>>::insert(collection.id, tokens_minted);863 for (account, balance) in balances {864 <AccountBalance<T>>::insert((collection.id, account), balance);865 }866 for (i, data) in data.into_iter().enumerate() {867 let token = first_token + i as u32 + 1;868 <Owned<T>>::insert((collection.id, &data.owner, token), true);869870 <PalletEvm<T>>::deposit_log(871 ERC721Events::Transfer {872 from: H160::default(),873 to: *data.owner.as_eth(),874 token_id: token.into(),875 }876 .to_log(collection_id_to_address(collection.id)),877 );878 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(879 collection.id,880 TokenId(token),881 data.owner.clone(),882 1,883 ));884 }885 Ok(())886 }887888 pub fn set_allowance_unchecked(889 collection: &NonfungibleHandle<T>,890 sender: &T::CrossAccountId,891 token: TokenId,892 spender: Option<&T::CrossAccountId>,893 assume_implicit_eth: bool,894 ) {895 if let Some(spender) = spender {896 let old_spender = <Allowance<T>>::get((collection.id, token));897 <Allowance<T>>::insert((collection.id, token), spender);898 // In ERC721 there is only one possible approved user of token, so we set899 // approved user to spender900 <PalletEvm<T>>::deposit_log(901 ERC721Events::Approval {902 owner: *sender.as_eth(),903 approved: *spender.as_eth(),904 token_id: token.into(),905 }906 .to_log(collection_id_to_address(collection.id)),907 );908 // In Unique chain, any token can have any amount of approved users, so we need to909 // set allowance of old owner to 0, and allowance of new owner to 1910 if old_spender.as_ref() != Some(spender) {911 if let Some(old_owner) = old_spender {912 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(913 collection.id,914 token,915 sender.clone(),916 old_owner,917 0,918 ));919 }920 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(921 collection.id,922 token,923 sender.clone(),924 spender.clone(),925 1,926 ));927 }928 } else {929 let old_spender = <Allowance<T>>::take((collection.id, token));930 if !assume_implicit_eth {931 // In ERC721 there is only one possible approved user of token, so we set932 // approved user to zero address933 <PalletEvm<T>>::deposit_log(934 ERC721Events::Approval {935 owner: *sender.as_eth(),936 approved: H160::default(),937 token_id: token.into(),938 }939 .to_log(collection_id_to_address(collection.id)),940 );941 }942 // In Unique chain, any token can have any amount of approved users, so we need to943 // set allowance of old owner to 0944 if let Some(old_spender) = old_spender {945 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(946 collection.id,947 token,948 sender.clone(),949 old_spender,950 0,951 ));952 }953 }954 }955956 pub fn set_allowance(957 collection: &NonfungibleHandle<T>,958 sender: &T::CrossAccountId,959 token: TokenId,960 spender: Option<&T::CrossAccountId>,961 ) -> DispatchResult {962 if collection.permissions.access() == AccessMode::AllowList {963 collection.check_allowlist(sender)?;964 if let Some(spender) = spender {965 collection.check_allowlist(spender)?;966 }967 }968969 if let Some(spender) = spender {970 <PalletCommon<T>>::ensure_correct_receiver(spender)?;971 }972973 let token_data =974 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;975 if &token_data.owner != sender {976 ensure!(977 collection.ignores_owned_amount(sender),978 <CommonError<T>>::CantApproveMoreThanOwned979 );980 }981982 // =========983984 Self::set_allowance_unchecked(collection, sender, token, spender, false);985 Ok(())986 }987988 fn check_allowed(989 collection: &NonfungibleHandle<T>,990 spender: &T::CrossAccountId,991 from: &T::CrossAccountId,992 token: TokenId,993 nesting_budget: &dyn Budget,994 ) -> DispatchResult {995 if spender.conv_eq(from) {996 return Ok(());997 }998 if collection.permissions.access() == AccessMode::AllowList {999 // `from`, `to` checked in [`transfer`]1000 collection.check_allowlist(spender)?;1001 }10021003 if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1004 return Ok(());1005 }10061007 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1008 ensure!(1009 <PalletStructure<T>>::check_indirectly_owned(1010 spender.clone(),1011 source.0,1012 source.1,1013 None,1014 nesting_budget1015 )?,1016 <CommonError<T>>::ApprovedValueTooLow,1017 );1018 return Ok(());1019 }1020 if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1021 return Ok(());1022 }1023 ensure!(1024 collection.ignores_allowance(spender),1025 <CommonError<T>>::ApprovedValueTooLow1026 );1027 Ok(())1028 }10291030 pub fn transfer_from(1031 collection: &NonfungibleHandle<T>,1032 spender: &T::CrossAccountId,1033 from: &T::CrossAccountId,1034 to: &T::CrossAccountId,1035 token: TokenId,1036 nesting_budget: &dyn Budget,1037 ) -> DispatchResult {1038 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10391040 // =========10411042 // Allowance is reset in [`transfer`]1043 Self::transfer(collection, from, to, token, nesting_budget)1044 }10451046 pub fn burn_from(1047 collection: &NonfungibleHandle<T>,1048 spender: &T::CrossAccountId,1049 from: &T::CrossAccountId,1050 token: TokenId,1051 nesting_budget: &dyn Budget,1052 ) -> DispatchResult {1053 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10541055 // =========10561057 Self::burn(collection, from, token)1058 }10591060 pub fn check_nesting(1061 handle: &NonfungibleHandle<T>,1062 sender: T::CrossAccountId,1063 from: (CollectionId, TokenId),1064 under: TokenId,1065 nesting_budget: &dyn Budget,1066 ) -> DispatchResult {1067 let nesting = handle.permissions.nesting();10681069 #[cfg(not(feature = "runtime-benchmarks"))]1070 let permissive = false;1071 #[cfg(feature = "runtime-benchmarks")]1072 let permissive = nesting.permissive;10731074 if permissive {1075 // Pass1076 } else if nesting.token_owner1077 && <PalletStructure<T>>::check_indirectly_owned(1078 sender.clone(),1079 handle.id,1080 under,1081 Some(from),1082 nesting_budget,1083 )? {1084 // Pass1085 } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1086 // Pass1087 } else {1088 fail!(<CommonError<T>>::UserIsNotAllowedToNest);1089 }10901091 if let Some(whitelist) = &nesting.restricted {1092 ensure!(1093 whitelist.contains(&from.0),1094 <CommonError<T>>::SourceCollectionIsNotAllowedToNest1095 );1096 }1097 Ok(())1098 }10991100 fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1101 <TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1102 }11031104 fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1105 <TokenChildren<T>>::remove((under.0, under.1, to_unnest));1106 }11071108 fn collection_has_tokens(collection_id: CollectionId) -> bool {1109 <TokenData<T>>::iter_prefix((collection_id,))1110 .next()1111 .is_some()1112 }11131114 fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1115 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1116 .next()1117 .is_some()1118 }11191120 pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1121 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1122 .map(|((child_collection_id, child_id), _)| TokenChild {1123 collection: child_collection_id,1124 token: child_id,1125 })1126 .collect()1127 }11281129 /// Delegated to `create_multiple_items`1130 pub fn create_item(1131 collection: &NonfungibleHandle<T>,1132 sender: &T::CrossAccountId,1133 data: CreateItemData<T>,1134 nesting_budget: &dyn Budget,1135 ) -> DispatchResult {1136 Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1137 }1138}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 StorageVersion::new(1).put::<Pallet<T>>();187188 0189 }190 }191}192193pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);194impl<T: Config> NonfungibleHandle<T> {195 pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {196 Self(inner)197 }198 pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {199 self.0200 }201 pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {202 &mut self.0203 }204}205impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {206 fn recorder(&self) -> &SubstrateRecorder<T> {207 self.0.recorder()208 }209 fn into_recorder(self) -> SubstrateRecorder<T> {210 self.0.into_recorder()211 }212}213impl<T: Config> Deref for NonfungibleHandle<T> {214 type Target = pallet_common::CollectionHandle<T>;215216 fn deref(&self) -> &Self::Target {217 &self.0218 }219}220221impl<T: Config> Pallet<T> {222 pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {223 <TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)224 }225 pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {226 <TokenData<T>>::contains_key((collection.id, token))227 }228229 pub fn set_scoped_token_property(230 collection_id: CollectionId,231 token_id: TokenId,232 scope: PropertyScope,233 property: Property,234 ) -> DispatchResult {235 TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {236 properties.try_scoped_set(scope, property.key, property.value)237 })238 .map_err(<CommonError<T>>::from)?;239240 Ok(())241 }242243 pub fn set_scoped_token_properties(244 collection_id: CollectionId,245 token_id: TokenId,246 scope: PropertyScope,247 properties: impl Iterator<Item = Property>,248 ) -> DispatchResult {249 TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {250 stored_properties.try_scoped_set_from_iter(scope, properties)251 })252 .map_err(<CommonError<T>>::from)?;253254 Ok(())255 }256257 pub fn try_mutate_token_aux_property<R, E>(258 collection_id: CollectionId,259 token_id: TokenId,260 scope: PropertyScope,261 key: PropertyKey,262 f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,263 ) -> Result<R, E> {264 <TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)265 }266267 pub fn remove_token_aux_property(268 collection_id: CollectionId,269 token_id: TokenId,270 scope: PropertyScope,271 key: PropertyKey,272 ) {273 <TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));274 }275276 pub fn iterate_token_aux_properties(277 collection_id: CollectionId,278 token_id: TokenId,279 scope: PropertyScope,280 ) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {281 <TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))282 }283284 pub fn current_token_id(collection_id: CollectionId) -> TokenId {285 TokenId(<TokensMinted<T>>::get(collection_id))286 }287}288289// unchecked calls skips any permission checks290impl<T: Config> Pallet<T> {291 pub fn init_collection(292 owner: T::CrossAccountId,293 data: CreateCollectionData<T::AccountId>,294 is_external: bool,295 ) -> Result<CollectionId, DispatchError> {296 <PalletCommon<T>>::init_collection(owner, data, is_external)297 }298 pub fn destroy_collection(299 collection: NonfungibleHandle<T>,300 sender: &T::CrossAccountId,301 ) -> DispatchResult {302 let id = collection.id;303304 if Self::collection_has_tokens(id) {305 return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());306 }307308 // =========309310 PalletCommon::destroy_collection(collection.0, sender)?;311312 <TokenData<T>>::remove_prefix((id,), None);313 <TokenChildren<T>>::remove_prefix((id,), None);314 <Owned<T>>::remove_prefix((id,), None);315 <TokensMinted<T>>::remove(id);316 <TokensBurnt<T>>::remove(id);317 <Allowance<T>>::remove_prefix((id,), None);318 <AccountBalance<T>>::remove_prefix((id,), None);319 Ok(())320 }321322 pub fn burn(323 collection: &NonfungibleHandle<T>,324 sender: &T::CrossAccountId,325 token: TokenId,326 ) -> DispatchResult {327 let token_data =328 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;329 ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);330331 if collection.permissions.access() == AccessMode::AllowList {332 collection.check_allowlist(sender)?;333 }334335 if Self::token_has_children(collection.id, token) {336 return Err(<Error<T>>::CantBurnNftWithChildren.into());337 }338339 let burnt = <TokensBurnt<T>>::get(collection.id)340 .checked_add(1)341 .ok_or(ArithmeticError::Overflow)?;342343 let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))344 .checked_sub(1)345 .ok_or(ArithmeticError::Overflow)?;346347 // =========348349 if balance == 0 {350 <AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));351 } else {352 <AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);353 }354355 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);356357 <Owned<T>>::remove((collection.id, &token_data.owner, token));358 <TokensBurnt<T>>::insert(collection.id, burnt);359 <TokenData<T>>::remove((collection.id, token));360 <TokenProperties<T>>::remove((collection.id, token));361 <TokenAuxProperties<T>>::remove_prefix((collection.id, token), None);362 let old_spender = <Allowance<T>>::take((collection.id, token));363364 if let Some(old_spender) = old_spender {365 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(366 collection.id,367 token,368 token_data.owner.clone(),369 old_spender,370 0,371 ));372 }373374 <PalletEvm<T>>::deposit_log(375 ERC721Events::Transfer {376 from: *token_data.owner.as_eth(),377 to: H160::default(),378 token_id: token.into(),379 }380 .to_log(collection_id_to_address(collection.id)),381 );382 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(383 collection.id,384 token,385 token_data.owner,386 1,387 ));388 Ok(())389 }390391 #[transactional]392 pub fn burn_recursively(393 collection: &NonfungibleHandle<T>,394 sender: &T::CrossAccountId,395 token: TokenId,396 self_budget: &dyn Budget,397 breadth_budget: &dyn Budget,398 ) -> DispatchResultWithPostInfo {399 ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);400401 let current_token_account =402 T::CrossTokenAddressMapping::token_to_address(collection.id, token);403404 let mut weight = 0 as Weight;405406 // This method is transactional, if user in fact doesn't have permissions to remove token -407 // tokens removed here will be restored after rejected transaction408 for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {409 ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);410 let PostDispatchInfo { actual_weight, .. } =411 <PalletStructure<T>>::burn_item_recursively(412 current_token_account.clone(),413 collection,414 token,415 self_budget,416 breadth_budget,417 )?;418 if let Some(actual_weight) = actual_weight {419 weight = weight.saturating_add(actual_weight);420 }421 }422423 Self::burn(collection, sender, token)?;424 DispatchResultWithPostInfo::Ok(PostDispatchInfo {425 actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),426 pays_fee: Pays::Yes,427 })428 }429430 #[transactional]431 fn modify_token_properties(432 collection: &NonfungibleHandle<T>,433 sender: &T::CrossAccountId,434 token_id: TokenId,435 properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,436 is_token_create: bool,437 nesting_budget: &dyn Budget,438 ) -> DispatchResult {439 let mut collection_admin_status = None;440 let mut token_owner_result = None;441442 let mut is_collection_admin =443 || *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));444445 let mut is_token_owner = || {446 *token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {447 let is_owned = <PalletStructure<T>>::check_indirectly_owned(448 sender.clone(),449 collection.id,450 token_id,451 None,452 nesting_budget,453 )?;454455 Ok(is_owned)456 })457 };458459 for (key, value) in properties {460 let permission = <PalletCommon<T>>::property_permissions(collection.id)461 .get(&key)462 .cloned()463 .unwrap_or_else(PropertyPermission::none);464465 let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))466 .get(&key)467 .is_some();468469 match permission {470 PropertyPermission { mutable: false, .. } if is_property_exists => {471 return Err(<CommonError<T>>::NoPermission.into());472 }473474 PropertyPermission {475 collection_admin,476 token_owner,477 ..478 } => {479 //TODO: investigate threats during public minting.480 if is_token_create && (collection_admin || token_owner) && value.is_some() {481 // Pass482 } else if collection_admin && is_collection_admin() {483 // Pass484 } else if token_owner && is_token_owner()? {485 // Pass486 } else {487 fail!(<CommonError<T>>::NoPermission);488 }489 }490 }491492 match value {493 Some(value) => {494 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {495 properties.try_set(key.clone(), value)496 })497 .map_err(<CommonError<T>>::from)?;498499 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(500 collection.id,501 token_id,502 key,503 ));504 }505 None => {506 <TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {507 properties.remove(&key)508 })509 .map_err(<CommonError<T>>::from)?;510511 <PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(512 collection.id,513 token_id,514 key,515 ));516 }517 }518 }519520 Ok(())521 }522523 pub fn set_token_properties(524 collection: &NonfungibleHandle<T>,525 sender: &T::CrossAccountId,526 token_id: TokenId,527 properties: impl Iterator<Item = Property>,528 is_token_create: bool,529 nesting_budget: &dyn Budget,530 ) -> DispatchResult {531 Self::modify_token_properties(532 collection,533 sender,534 token_id,535 properties.map(|p| (p.key, Some(p.value))),536 is_token_create,537 nesting_budget,538 )539 }540541 pub fn set_token_property(542 collection: &NonfungibleHandle<T>,543 sender: &T::CrossAccountId,544 token_id: TokenId,545 property: Property,546 nesting_budget: &dyn Budget,547 ) -> DispatchResult {548 let is_token_create = false;549550 Self::set_token_properties(551 collection,552 sender,553 token_id,554 [property].into_iter(),555 is_token_create,556 nesting_budget,557 )558 }559560 pub fn delete_token_properties(561 collection: &NonfungibleHandle<T>,562 sender: &T::CrossAccountId,563 token_id: TokenId,564 property_keys: impl Iterator<Item = PropertyKey>,565 nesting_budget: &dyn Budget,566 ) -> DispatchResult {567 let is_token_create = false;568569 Self::modify_token_properties(570 collection,571 sender,572 token_id,573 property_keys.into_iter().map(|key| (key, None)),574 is_token_create,575 nesting_budget,576 )577 }578579 pub fn delete_token_property(580 collection: &NonfungibleHandle<T>,581 sender: &T::CrossAccountId,582 token_id: TokenId,583 property_key: PropertyKey,584 nesting_budget: &dyn Budget,585 ) -> DispatchResult {586 Self::delete_token_properties(587 collection,588 sender,589 token_id,590 [property_key].into_iter(),591 nesting_budget,592 )593 }594595 pub fn set_collection_properties(596 collection: &NonfungibleHandle<T>,597 sender: &T::CrossAccountId,598 properties: Vec<Property>,599 ) -> DispatchResult {600 <PalletCommon<T>>::set_collection_properties(collection, sender, properties)601 }602603 pub fn delete_collection_properties(604 collection: &CollectionHandle<T>,605 sender: &T::CrossAccountId,606 property_keys: Vec<PropertyKey>,607 ) -> DispatchResult {608 <PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)609 }610611 pub fn set_token_property_permissions(612 collection: &CollectionHandle<T>,613 sender: &T::CrossAccountId,614 property_permissions: Vec<PropertyKeyPermission>,615 ) -> DispatchResult {616 <PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)617 }618619 pub fn set_property_permission(620 collection: &CollectionHandle<T>,621 sender: &T::CrossAccountId,622 permission: PropertyKeyPermission,623 ) -> DispatchResult {624 <PalletCommon<T>>::set_property_permission(collection, sender, permission)625 }626627 pub fn transfer(628 collection: &NonfungibleHandle<T>,629 from: &T::CrossAccountId,630 to: &T::CrossAccountId,631 token: TokenId,632 nesting_budget: &dyn Budget,633 ) -> DispatchResult {634 ensure!(635 collection.limits.transfers_enabled(),636 <CommonError<T>>::TransferNotAllowed637 );638639 let token_data =640 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;641 ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);642643 if collection.permissions.access() == AccessMode::AllowList {644 collection.check_allowlist(from)?;645 collection.check_allowlist(to)?;646 }647 <PalletCommon<T>>::ensure_correct_receiver(to)?;648649 let balance_from = <AccountBalance<T>>::get((collection.id, from))650 .checked_sub(1)651 .ok_or(<CommonError<T>>::TokenValueTooLow)?;652 let balance_to = if from != to {653 let balance_to = <AccountBalance<T>>::get((collection.id, to))654 .checked_add(1)655 .ok_or(ArithmeticError::Overflow)?;656657 ensure!(658 balance_to < collection.limits.account_token_ownership_limit(),659 <CommonError<T>>::AccountTokenLimitExceeded,660 );661662 Some(balance_to)663 } else {664 None665 };666667 <PalletStructure<T>>::nest_if_sent_to_token(668 from.clone(),669 to,670 collection.id,671 token,672 nesting_budget,673 )?;674675 // =========676677 <PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);678679 <TokenData<T>>::insert(680 (collection.id, token),681 ItemData {682 owner: to.clone(),683 ..token_data684 },685 );686687 if let Some(balance_to) = balance_to {688 // from != to689 if balance_from == 0 {690 <AccountBalance<T>>::remove((collection.id, from));691 } else {692 <AccountBalance<T>>::insert((collection.id, from), balance_from);693 }694 <AccountBalance<T>>::insert((collection.id, to), balance_to);695 <Owned<T>>::remove((collection.id, from, token));696 <Owned<T>>::insert((collection.id, to, token), true);697 }698 Self::set_allowance_unchecked(collection, from, token, None, true);699700 <PalletEvm<T>>::deposit_log(701 ERC721Events::Transfer {702 from: *from.as_eth(),703 to: *to.as_eth(),704 token_id: token.into(),705 }706 .to_log(collection_id_to_address(collection.id)),707 );708 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(709 collection.id,710 token,711 from.clone(),712 to.clone(),713 1,714 ));715 Ok(())716 }717718 pub fn create_multiple_items(719 collection: &NonfungibleHandle<T>,720 sender: &T::CrossAccountId,721 data: Vec<CreateItemData<T>>,722 nesting_budget: &dyn Budget,723 ) -> DispatchResult {724 if !collection.is_owner_or_admin(sender) {725 ensure!(726 collection.permissions.mint_mode(),727 <CommonError<T>>::PublicMintingNotAllowed728 );729 collection.check_allowlist(sender)?;730731 for item in data.iter() {732 collection.check_allowlist(&item.owner)?;733 }734 }735736 for data in data.iter() {737 <PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;738 }739740 let first_token = <TokensMinted<T>>::get(collection.id);741 let tokens_minted = first_token742 .checked_add(data.len() as u32)743 .ok_or(ArithmeticError::Overflow)?;744 ensure!(745 tokens_minted <= collection.limits.token_limit(),746 <CommonError<T>>::CollectionTokenLimitExceeded747 );748749 let mut balances = BTreeMap::new();750 for data in &data {751 let balance = balances752 .entry(&data.owner)753 .or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));754 *balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;755756 ensure!(757 *balance <= collection.limits.account_token_ownership_limit(),758 <CommonError<T>>::AccountTokenLimitExceeded,759 );760 }761762 for (i, data) in data.iter().enumerate() {763 let token = TokenId(first_token + i as u32 + 1);764765 <PalletStructure<T>>::check_nesting(766 sender.clone(),767 &data.owner,768 collection.id,769 token,770 nesting_budget,771 )?;772 }773774 // =========775776 with_transaction(|| {777 for (i, data) in data.iter().enumerate() {778 let token = first_token + i as u32 + 1;779780 <TokenData<T>>::insert(781 (collection.id, token),782 ItemData {783 // const_data: data.const_data.clone(),784 owner: data.owner.clone(),785 },786 );787788 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(789 &data.owner,790 collection.id,791 TokenId(token),792 );793794 if let Err(e) = Self::set_token_properties(795 collection,796 sender,797 TokenId(token),798 data.properties.clone().into_iter(),799 true,800 nesting_budget,801 ) {802 return TransactionOutcome::Rollback(Err(e));803 }804 }805 TransactionOutcome::Commit(Ok(()))806 })?;807808 <TokensMinted<T>>::insert(collection.id, tokens_minted);809 for (account, balance) in balances {810 <AccountBalance<T>>::insert((collection.id, account), balance);811 }812 for (i, data) in data.into_iter().enumerate() {813 let token = first_token + i as u32 + 1;814 <Owned<T>>::insert((collection.id, &data.owner, token), true);815816 <PalletEvm<T>>::deposit_log(817 ERC721Events::Transfer {818 from: H160::default(),819 to: *data.owner.as_eth(),820 token_id: token.into(),821 }822 .to_log(collection_id_to_address(collection.id)),823 );824 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(825 collection.id,826 TokenId(token),827 data.owner.clone(),828 1,829 ));830 }831 Ok(())832 }833834 pub fn set_allowance_unchecked(835 collection: &NonfungibleHandle<T>,836 sender: &T::CrossAccountId,837 token: TokenId,838 spender: Option<&T::CrossAccountId>,839 assume_implicit_eth: bool,840 ) {841 if let Some(spender) = spender {842 let old_spender = <Allowance<T>>::get((collection.id, token));843 <Allowance<T>>::insert((collection.id, token), spender);844 // In ERC721 there is only one possible approved user of token, so we set845 // approved user to spender846 <PalletEvm<T>>::deposit_log(847 ERC721Events::Approval {848 owner: *sender.as_eth(),849 approved: *spender.as_eth(),850 token_id: token.into(),851 }852 .to_log(collection_id_to_address(collection.id)),853 );854 // In Unique chain, any token can have any amount of approved users, so we need to855 // set allowance of old owner to 0, and allowance of new owner to 1856 if old_spender.as_ref() != Some(spender) {857 if let Some(old_owner) = old_spender {858 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(859 collection.id,860 token,861 sender.clone(),862 old_owner,863 0,864 ));865 }866 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(867 collection.id,868 token,869 sender.clone(),870 spender.clone(),871 1,872 ));873 }874 } else {875 let old_spender = <Allowance<T>>::take((collection.id, token));876 if !assume_implicit_eth {877 // In ERC721 there is only one possible approved user of token, so we set878 // approved user to zero address879 <PalletEvm<T>>::deposit_log(880 ERC721Events::Approval {881 owner: *sender.as_eth(),882 approved: H160::default(),883 token_id: token.into(),884 }885 .to_log(collection_id_to_address(collection.id)),886 );887 }888 // In Unique chain, any token can have any amount of approved users, so we need to889 // set allowance of old owner to 0890 if let Some(old_spender) = old_spender {891 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(892 collection.id,893 token,894 sender.clone(),895 old_spender,896 0,897 ));898 }899 }900 }901902 pub fn set_allowance(903 collection: &NonfungibleHandle<T>,904 sender: &T::CrossAccountId,905 token: TokenId,906 spender: Option<&T::CrossAccountId>,907 ) -> DispatchResult {908 if collection.permissions.access() == AccessMode::AllowList {909 collection.check_allowlist(sender)?;910 if let Some(spender) = spender {911 collection.check_allowlist(spender)?;912 }913 }914915 if let Some(spender) = spender {916 <PalletCommon<T>>::ensure_correct_receiver(spender)?;917 }918919 let token_data =920 <TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;921 if &token_data.owner != sender {922 ensure!(923 collection.ignores_owned_amount(sender),924 <CommonError<T>>::CantApproveMoreThanOwned925 );926 }927928 // =========929930 Self::set_allowance_unchecked(collection, sender, token, spender, false);931 Ok(())932 }933934 fn check_allowed(935 collection: &NonfungibleHandle<T>,936 spender: &T::CrossAccountId,937 from: &T::CrossAccountId,938 token: TokenId,939 nesting_budget: &dyn Budget,940 ) -> DispatchResult {941 if spender.conv_eq(from) {942 return Ok(());943 }944 if collection.permissions.access() == AccessMode::AllowList {945 // `from`, `to` checked in [`transfer`]946 collection.check_allowlist(spender)?;947 }948949 if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {950 return Ok(());951 }952953 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {954 ensure!(955 <PalletStructure<T>>::check_indirectly_owned(956 spender.clone(),957 source.0,958 source.1,959 None,960 nesting_budget961 )?,962 <CommonError<T>>::ApprovedValueTooLow,963 );964 return Ok(());965 }966 if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {967 return Ok(());968 }969 ensure!(970 collection.ignores_allowance(spender),971 <CommonError<T>>::ApprovedValueTooLow972 );973 Ok(())974 }975976 pub fn transfer_from(977 collection: &NonfungibleHandle<T>,978 spender: &T::CrossAccountId,979 from: &T::CrossAccountId,980 to: &T::CrossAccountId,981 token: TokenId,982 nesting_budget: &dyn Budget,983 ) -> DispatchResult {984 Self::check_allowed(collection, spender, from, token, nesting_budget)?;985986 // =========987988 // Allowance is reset in [`transfer`]989 Self::transfer(collection, from, to, token, nesting_budget)990 }991992 pub fn burn_from(993 collection: &NonfungibleHandle<T>,994 spender: &T::CrossAccountId,995 from: &T::CrossAccountId,996 token: TokenId,997 nesting_budget: &dyn Budget,998 ) -> DispatchResult {999 Self::check_allowed(collection, spender, from, token, nesting_budget)?;10001001 // =========10021003 Self::burn(collection, from, token)1004 }10051006 pub fn check_nesting(1007 handle: &NonfungibleHandle<T>,1008 sender: T::CrossAccountId,1009 from: (CollectionId, TokenId),1010 under: TokenId,1011 nesting_budget: &dyn Budget,1012 ) -> DispatchResult {1013 let nesting = handle.permissions.nesting();10141015 #[cfg(not(feature = "runtime-benchmarks"))]1016 let permissive = false;1017 #[cfg(feature = "runtime-benchmarks")]1018 let permissive = nesting.permissive;10191020 if permissive {1021 // Pass1022 } else if nesting.token_owner1023 && <PalletStructure<T>>::check_indirectly_owned(1024 sender.clone(),1025 handle.id,1026 under,1027 Some(from),1028 nesting_budget,1029 )? {1030 // Pass1031 } else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1032 // Pass1033 } else {1034 fail!(<CommonError<T>>::UserIsNotAllowedToNest);1035 }10361037 if let Some(whitelist) = &nesting.restricted {1038 ensure!(1039 whitelist.contains(&from.0),1040 <CommonError<T>>::SourceCollectionIsNotAllowedToNest1041 );1042 }1043 Ok(())1044 }10451046 fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1047 <TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1048 }10491050 fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1051 <TokenChildren<T>>::remove((under.0, under.1, to_unnest));1052 }10531054 fn collection_has_tokens(collection_id: CollectionId) -> bool {1055 <TokenData<T>>::iter_prefix((collection_id,))1056 .next()1057 .is_some()1058 }10591060 fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1061 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1062 .next()1063 .is_some()1064 }10651066 pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1067 <TokenChildren<T>>::iter_prefix((collection_id, token_id))1068 .map(|((child_collection_id, child_id), _)| TokenChild {1069 collection: child_collection_id,1070 token: child_id,1071 })1072 .collect()1073 }10741075 /// Delegated to `create_multiple_items`1076 pub fn create_item(1077 collection: &NonfungibleHandle<T>,1078 sender: &T::CrossAccountId,1079 data: CreateItemData<T>,1080 nesting_budget: &dyn Budget,1081 ) -> DispatchResult {1082 Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1083 }1084}