git.delta.rocks / unique-network / refs/commits / 23942aa9dbcc

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 frame_support::{BoundedVec, ensure, fail};21use up_data_structs::{22	AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,23	mapping::TokenAddressMapping, NestingRule,24};25use pallet_evm::account::CrossAccountId;26use pallet_common::{27	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent,28	CollectionHandle, dispatch::CollectionDispatch,29};30use pallet_structure::Pallet as PalletStructure;31use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};32use sp_core::H160;33use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};34use sp_std::{vec::Vec, vec};35use core::ops::Deref;36use sp_std::collections::btree_map::BTreeMap;37use codec::{Encode, Decode, MaxEncodedLen};38use scale_info::TypeInfo;3940pub use pallet::*;41#[cfg(feature = "runtime-benchmarks")]42pub mod benchmarking;43pub mod common;44pub mod erc;45pub mod weights;4647pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;48pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;4950#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]51pub struct ItemData<CrossAccountId> {52	pub const_data: BoundedVec<u8, CustomDataLimit>,53	pub variable_data: BoundedVec<u8, CustomDataLimit>,54	pub owner: CrossAccountId,55}5657#[frame_support::pallet]58pub mod pallet {59	use super::*;60	use frame_support::{Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key};61	use up_data_structs::{CollectionId, TokenId};62	use super::weights::WeightInfo;6364	#[pallet::error]65	pub enum Error<T> {66		/// Not Nonfungible item data used to mint in Nonfungible collection.67		NotNonfungibleDataUsedToMintFungibleCollectionToken,68		/// Used amount > 1 with NFT69		NonfungibleItemsHaveNoAmount,70	}7172	#[pallet::config]73	pub trait Config:74		frame_system::Config + pallet_common::Config + pallet_structure::Config75	{76		type WeightInfo: WeightInfo;77	}7879	#[pallet::pallet]80	#[pallet::generate_store(pub(super) trait Store)]81	pub struct Pallet<T>(_);8283	#[pallet::storage]84	pub type TokensMinted<T: Config> =85		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;86	#[pallet::storage]87	pub type TokensBurnt<T: Config> =88		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;8990	#[pallet::storage]91	pub type TokenData<T: Config> = StorageNMap<92		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),93		Value = ItemData<T::CrossAccountId>,94		QueryKind = OptionQuery,95	>;9697	/// Used to enumerate tokens owned by account98	#[pallet::storage]99	pub type Owned<T: Config> = StorageNMap<100		Key = (101			Key<Twox64Concat, CollectionId>,102			Key<Blake2_128Concat, T::CrossAccountId>,103			Key<Twox64Concat, TokenId>,104		),105		Value = bool,106		QueryKind = ValueQuery,107	>;108109	#[pallet::storage]110	pub type AccountBalance<T: Config> = StorageNMap<111		Key = (112			Key<Twox64Concat, CollectionId>,113			Key<Blake2_128Concat, T::CrossAccountId>,114		),115		Value = u32,116		QueryKind = ValueQuery,117	>;118119	#[pallet::storage]120	pub type Allowance<T: Config> = StorageNMap<121		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),122		Value = T::CrossAccountId,123		QueryKind = OptionQuery,124	>;125}126127pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);128impl<T: Config> NonfungibleHandle<T> {129	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {130		Self(inner)131	}132	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {133		self.0134	}135}136impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {137	fn recorder(&self) -> &SubstrateRecorder<T> {138		self.0.recorder()139	}140	fn into_recorder(self) -> SubstrateRecorder<T> {141		self.0.into_recorder()142	}143}144impl<T: Config> Deref for NonfungibleHandle<T> {145	type Target = pallet_common::CollectionHandle<T>;146147	fn deref(&self) -> &Self::Target {148		&self.0149	}150}151152impl<T: Config> Pallet<T> {153	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {154		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)155	}156	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {157		<TokenData<T>>::contains_key((collection.id, token))158	}159}160161// unchecked calls skips any permission checks162impl<T: Config> Pallet<T> {163	pub fn init_collection(164		owner: T::AccountId,165		data: CreateCollectionData<T::AccountId>,166	) -> Result<CollectionId, DispatchError> {167		<PalletCommon<T>>::init_collection(owner, data)168	}169	pub fn destroy_collection(170		collection: NonfungibleHandle<T>,171		sender: &T::CrossAccountId,172	) -> DispatchResult {173		let id = collection.id;174175		// =========176177		PalletCommon::destroy_collection(collection.0, sender)?;178179		<TokenData<T>>::remove_prefix((id,), None);180		<Owned<T>>::remove_prefix((id,), None);181		<TokensMinted<T>>::remove(id);182		<TokensBurnt<T>>::remove(id);183		<Allowance<T>>::remove_prefix((id,), None);184		<AccountBalance<T>>::remove_prefix((id,), None);185		Ok(())186	}187188	pub fn burn(189		collection: &NonfungibleHandle<T>,190		sender: &T::CrossAccountId,191		token: TokenId,192	) -> DispatchResult {193		let token_data =194			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;195		ensure!(196			&token_data.owner == sender197				|| (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(sender)),198			<CommonError<T>>::NoPermission199		);200201		if collection.access == AccessMode::AllowList {202			collection.check_allowlist(sender)?;203		}204205		let burnt = <TokensBurnt<T>>::get(collection.id)206			.checked_add(1)207			.ok_or(ArithmeticError::Overflow)?;208209		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))210			.checked_sub(1)211			.ok_or(ArithmeticError::Overflow)?;212213		if balance == 0 {214			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));215		} else {216			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);217		}218		// =========219220		<Owned<T>>::remove((collection.id, &token_data.owner, token));221		<TokensBurnt<T>>::insert(collection.id, burnt);222		<TokenData<T>>::remove((collection.id, token));223		let old_spender = <Allowance<T>>::take((collection.id, token));224225		if let Some(old_spender) = old_spender {226			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(227				collection.id,228				token,229				sender.clone(),230				old_spender,231				0,232			));233		}234235		collection.log_mirrored(ERC721Events::Transfer {236			from: *token_data.owner.as_eth(),237			to: H160::default(),238			token_id: token.into(),239		});240		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(241			collection.id,242			token,243			token_data.owner,244			1,245		));246		Ok(())247	}248249	pub fn transfer(250		collection: &NonfungibleHandle<T>,251		from: &T::CrossAccountId,252		to: &T::CrossAccountId,253		token: TokenId,254	) -> DispatchResult {255		ensure!(256			collection.limits.transfers_enabled(),257			<CommonError<T>>::TransferNotAllowed258		);259260		let token_data =261			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;262		// TODO: require sender to be token, owner, require admins to go through transfer_from263		ensure!(264			&token_data.owner == from265				|| (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(from)),266			<CommonError<T>>::NoPermission267		);268269		if collection.access == AccessMode::AllowList {270			collection.check_allowlist(from)?;271			collection.check_allowlist(to)?;272		}273		<PalletCommon<T>>::ensure_correct_receiver(to)?;274275		let balance_from = <AccountBalance<T>>::get((collection.id, from))276			.checked_sub(1)277			.ok_or(<CommonError<T>>::TokenValueTooLow)?;278		let balance_to = if from != to {279			let balance_to = <AccountBalance<T>>::get((collection.id, to))280				.checked_add(1)281				.ok_or(ArithmeticError::Overflow)?;282283			ensure!(284				balance_to < collection.limits.account_token_ownership_limit(),285				<CommonError<T>>::AccountTokenLimitExceeded,286			);287288			Some(balance_to)289		} else {290			None291		};292293		if let Some(target) = T::CrossTokenAddressMapping::address_to_token(to) {294			let handle = <CollectionHandle<T>>::try_get(target.0)?;295			let dispatch = T::CollectionDispatch::dispatch(handle);296			let dispatch = dispatch.as_dyn();297298			// =========299300			dispatch.nest_token(from.clone(), (collection.id, token), target.1)?;301		}302303		<TokenData<T>>::insert(304			(collection.id, token),305			ItemData {306				owner: to.clone(),307				..token_data308			},309		);310311		if let Some(balance_to) = balance_to {312			// from != to313			if balance_from == 0 {314				<AccountBalance<T>>::remove((collection.id, from));315			} else {316				<AccountBalance<T>>::insert((collection.id, from), balance_from);317			}318			<AccountBalance<T>>::insert((collection.id, to), balance_to);319			<Owned<T>>::remove((collection.id, from, token));320			<Owned<T>>::insert((collection.id, to, token), true);321		}322		Self::set_allowance_unchecked(collection, from, token, None, true);323324		collection.log_mirrored(ERC721Events::Transfer {325			from: *from.as_eth(),326			to: *to.as_eth(),327			token_id: token.into(),328		});329		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(330			collection.id,331			token,332			from.clone(),333			to.clone(),334			1,335		));336		Ok(())337	}338339	pub fn create_multiple_items(340		collection: &NonfungibleHandle<T>,341		sender: &T::CrossAccountId,342		data: Vec<CreateItemData<T>>,343	) -> DispatchResult {344		if !collection.is_owner_or_admin(sender) {345			ensure!(346				collection.mint_mode,347				<CommonError<T>>::PublicMintingNotAllowed348			);349			collection.check_allowlist(sender)?;350351			for item in data.iter() {352				collection.check_allowlist(&item.owner)?;353			}354		}355356		for data in data.iter() {357			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;358		}359360		let first_token = <TokensMinted<T>>::get(collection.id);361		let tokens_minted = first_token362			.checked_add(data.len() as u32)363			.ok_or(ArithmeticError::Overflow)?;364		ensure!(365			tokens_minted <= collection.limits.token_limit(),366			<CommonError<T>>::CollectionTokenLimitExceeded367		);368369		let mut balances = BTreeMap::new();370		for data in &data {371			let balance = balances372				.entry(&data.owner)373				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));374			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;375376			ensure!(377				*balance <= collection.limits.account_token_ownership_limit(),378				<CommonError<T>>::AccountTokenLimitExceeded,379			);380		}381382		// =========383384		<TokensMinted<T>>::insert(collection.id, tokens_minted);385		for (account, balance) in balances {386			<AccountBalance<T>>::insert((collection.id, account), balance);387		}388		for (i, data) in data.into_iter().enumerate() {389			let token = first_token + i as u32 + 1;390391			<TokenData<T>>::insert(392				(collection.id, token),393				ItemData {394					const_data: data.const_data,395					variable_data: data.variable_data,396					owner: data.owner.clone(),397				},398			);399			<Owned<T>>::insert((collection.id, &data.owner, token), true);400401			collection.log_mirrored(ERC721Events::Transfer {402				from: H160::default(),403				to: *data.owner.as_eth(),404				token_id: token.into(),405			});406			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(407				collection.id,408				TokenId(token),409				data.owner.clone(),410				1,411			));412		}413		Ok(())414	}415416	pub fn set_allowance_unchecked(417		collection: &NonfungibleHandle<T>,418		sender: &T::CrossAccountId,419		token: TokenId,420		spender: Option<&T::CrossAccountId>,421		assume_implicit_eth: bool,422	) {423		if let Some(spender) = spender {424			let old_spender = <Allowance<T>>::get((collection.id, token));425			<Allowance<T>>::insert((collection.id, token), spender);426			// In ERC721 there is only one possible approved user of token, so we set427			// approved user to spender428			collection.log_mirrored(ERC721Events::Approval {429				owner: *sender.as_eth(),430				approved: *spender.as_eth(),431				token_id: token.into(),432			});433			// In Unique chain, any token can have any amount of approved users, so we need to434			// set allowance of old owner to 0, and allowance of new owner to 1435			if old_spender.as_ref() != Some(spender) {436				if let Some(old_owner) = old_spender {437					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(438						collection.id,439						token,440						sender.clone(),441						old_owner,442						0,443					));444				}445				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(446					collection.id,447					token,448					sender.clone(),449					spender.clone(),450					1,451				));452			}453		} else {454			let old_spender = <Allowance<T>>::take((collection.id, token));455			if !assume_implicit_eth {456				// In ERC721 there is only one possible approved user of token, so we set457				// approved user to zero address458				collection.log_mirrored(ERC721Events::Approval {459					owner: *sender.as_eth(),460					approved: H160::default(),461					token_id: token.into(),462				});463			}464			// In Unique chain, any token can have any amount of approved users, so we need to465			// set allowance of old owner to 0466			if let Some(old_spender) = old_spender {467				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(468					collection.id,469					token,470					sender.clone(),471					old_spender,472					0,473				));474			}475		}476	}477478	pub fn set_allowance(479		collection: &NonfungibleHandle<T>,480		sender: &T::CrossAccountId,481		token: TokenId,482		spender: Option<&T::CrossAccountId>,483	) -> DispatchResult {484		if collection.access == AccessMode::AllowList {485			collection.check_allowlist(sender)?;486			if let Some(spender) = spender {487				collection.check_allowlist(spender)?;488			}489		}490491		if let Some(spender) = spender {492			<PalletCommon<T>>::ensure_correct_receiver(spender)?;493		}494		let token_data =495			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;496		if &token_data.owner != sender {497			ensure!(498				collection.ignores_owned_amount(sender),499				<CommonError<T>>::CantApproveMoreThanOwned500			);501		}502503		// =========504505		Self::set_allowance_unchecked(collection, sender, token, spender, false);506		Ok(())507	}508509	fn check_allowed(510		collection: &NonfungibleHandle<T>,511		spender: &T::CrossAccountId,512		from: &T::CrossAccountId,513		token: TokenId,514	) -> DispatchResult {515		if spender.conv_eq(from) {516			return Ok(());517		}518		if collection.access == AccessMode::AllowList {519			// `from`, `to` checked in [`transfer`]520			collection.check_allowlist(spender)?;521		}522		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {523			// TODO: should collection owner be allowed to perform this transfer?524			ensure!(525				<PalletStructure<T>>::indirectly_owned(spender.clone(), source.0, source.1, 1)?,526				<CommonError<T>>::ApprovedValueTooLow,527			);528			return Ok(());529		}530		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {531			return Ok(());532		}533		ensure!(534			collection.ignores_allowance(spender),535			<CommonError<T>>::ApprovedValueTooLow536		);537		Ok(())538	}539540	pub fn transfer_from(541		collection: &NonfungibleHandle<T>,542		spender: &T::CrossAccountId,543		from: &T::CrossAccountId,544		to: &T::CrossAccountId,545		token: TokenId,546	) -> DispatchResult {547		Self::check_allowed(collection, spender, from, token)?;548549		// =========550551		// Allowance is reset in [`transfer`]552		Self::transfer(collection, from, to, token)553	}554555	pub fn burn_from(556		collection: &NonfungibleHandle<T>,557		spender: &T::CrossAccountId,558		from: &T::CrossAccountId,559		token: TokenId,560	) -> DispatchResult {561		Self::check_allowed(collection, spender, from, token)?;562563		// =========564565		Self::burn(collection, from, token)566	}567568	pub fn set_variable_metadata(569		collection: &NonfungibleHandle<T>,570		sender: &T::CrossAccountId,571		token: TokenId,572		data: BoundedVec<u8, CustomDataLimit>,573	) -> DispatchResult {574		let token_data =575			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;576		collection.check_can_update_meta(sender, &token_data.owner)?;577578		// =========579580		<TokenData<T>>::insert(581			(collection.id, token),582			ItemData {583				variable_data: data,584				..token_data585			},586		);587		Ok(())588	}589590	pub fn nest_token(591		handle: &NonfungibleHandle<T>,592		sender: T::CrossAccountId,593		from: CollectionId,594		under: TokenId,595	) -> DispatchResult {596		fn ensure_sender_allowed<T: Config>(597			collection: CollectionId,598			token: TokenId,599			sender: T::CrossAccountId,600		) -> DispatchResult {601			ensure!(602				<TokenData<T>>::get((collection, token))603					.ok_or(<CommonError<T>>::TokenNotFound)?604					.owner605					.conv_eq(&sender),606				<CommonError<T>>::OnlyOwnerAllowedToNest,607			);608			Ok(())609		}610		match handle.limits.nesting_rule() {611			NestingRule::Disabled => fail!(<CommonError<T>>::NestingIsDisabled),612			NestingRule::Owner => ensure_sender_allowed::<T>(from, under, sender)?,613			NestingRule::OwnerRestricted(whitelist) => {614				ensure!(615					whitelist.contains(&from),616					<CommonError<T>>::SourceCollectionIsNotAllowedToNest617				);618				ensure_sender_allowed::<T>(from, under, sender)?619			}620		}621		Ok(())622	}623624	/// Delegated to `create_multiple_items`625	pub fn create_item(626		collection: &NonfungibleHandle<T>,627		sender: &T::CrossAccountId,628		data: CreateItemData<T>,629	) -> DispatchResult {630		Self::create_multiple_items(collection, sender, vec![data])631	}632}