git.delta.rocks / unique-network / refs/commits / 22251a0f47f9

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};21use up_data_structs::{22	AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,23};24use pallet_common::{25	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent,26};27use frame_common::account::CrossAccountId;28use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};29use sp_core::H160;30use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};31use sp_std::{vec::Vec, vec};32use core::ops::Deref;33use sp_std::collections::btree_map::BTreeMap;34use codec::{Encode, Decode, MaxEncodedLen};35use scale_info::TypeInfo;3637pub use pallet::*;38#[cfg(feature = "runtime-benchmarks")]39pub mod benchmarking;40pub mod common;41pub mod erc;42pub mod weights;4344pub type CreateItemData<T> = CreateNftExData<<T as pallet_common::Config>::CrossAccountId>;45pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;4647#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]48pub struct ItemData<CrossAccountId> {49	pub const_data: BoundedVec<u8, CustomDataLimit>,50	pub variable_data: BoundedVec<u8, CustomDataLimit>,51	pub owner: CrossAccountId,52}5354#[frame_support::pallet]55pub mod pallet {56	use super::*;57	use frame_support::{Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key};58	use up_data_structs::{CollectionId, TokenId};59	use super::weights::WeightInfo;6061	#[pallet::error]62	pub enum Error<T> {63		/// Not Nonfungible item data used to mint in Nonfungible collection.64		NotNonfungibleDataUsedToMintFungibleCollectionToken,65		/// Used amount > 1 with NFT66		NonfungibleItemsHaveNoAmount,67	}6869	#[pallet::config]70	pub trait Config: frame_system::Config + pallet_common::Config {71		type WeightInfo: WeightInfo;72	}7374	#[pallet::pallet]75	#[pallet::generate_store(pub(super) trait Store)]76	pub struct Pallet<T>(_);7778	#[pallet::storage]79	pub type TokensMinted<T: Config> =80		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;81	#[pallet::storage]82	pub type TokensBurnt<T: Config> =83		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;8485	#[pallet::storage]86	pub type TokenData<T: Config> = StorageNMap<87		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),88		Value = ItemData<T::CrossAccountId>,89		QueryKind = OptionQuery,90	>;9192	/// Used to enumerate tokens owned by account93	#[pallet::storage]94	pub type Owned<T: Config> = StorageNMap<95		Key = (96			Key<Twox64Concat, CollectionId>,97			Key<Blake2_128Concat, T::CrossAccountId>,98			Key<Twox64Concat, TokenId>,99		),100		Value = bool,101		QueryKind = ValueQuery,102	>;103104	#[pallet::storage]105	pub type AccountBalance<T: Config> = StorageNMap<106		Key = (107			Key<Twox64Concat, CollectionId>,108			Key<Blake2_128Concat, T::CrossAccountId>,109		),110		Value = u32,111		QueryKind = ValueQuery,112	>;113114	#[pallet::storage]115	pub type Allowance<T: Config> = StorageNMap<116		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),117		Value = T::CrossAccountId,118		QueryKind = OptionQuery,119	>;120}121122pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);123impl<T: Config> NonfungibleHandle<T> {124	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {125		Self(inner)126	}127	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {128		self.0129	}130}131impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {132	fn recorder(&self) -> &SubstrateRecorder<T> {133		self.0.recorder()134	}135	fn into_recorder(self) -> SubstrateRecorder<T> {136		self.0.into_recorder()137	}138}139impl<T: Config> Deref for NonfungibleHandle<T> {140	type Target = pallet_common::CollectionHandle<T>;141142	fn deref(&self) -> &Self::Target {143		&self.0144	}145}146147impl<T: Config> Pallet<T> {148	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {149		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)150	}151	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {152		<TokenData<T>>::contains_key((collection.id, token))153	}154}155156// unchecked calls skips any permission checks157impl<T: Config> Pallet<T> {158	pub fn init_collection(159		owner: T::AccountId,160		data: CreateCollectionData<T::AccountId>,161	) -> Result<CollectionId, DispatchError> {162		<PalletCommon<T>>::init_collection(owner, data)163	}164	pub fn destroy_collection(165		collection: NonfungibleHandle<T>,166		sender: &T::CrossAccountId,167	) -> DispatchResult {168		let id = collection.id;169170		// =========171172		PalletCommon::destroy_collection(collection.0, sender)?;173174		<TokenData<T>>::remove_prefix((id,), None);175		<Owned<T>>::remove_prefix((id,), None);176		<TokensMinted<T>>::remove(id);177		<TokensBurnt<T>>::remove(id);178		<Allowance<T>>::remove_prefix((id,), None);179		<AccountBalance<T>>::remove_prefix((id,), None);180		Ok(())181	}182183	pub fn burn(184		collection: &NonfungibleHandle<T>,185		sender: &T::CrossAccountId,186		token: TokenId,187	) -> DispatchResult {188		let token_data =189			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;190		ensure!(191			&token_data.owner == sender192				|| (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(sender)),193			<CommonError<T>>::NoPermission194		);195196		if collection.access == AccessMode::AllowList {197			collection.check_allowlist(sender)?;198		}199200		let burnt = <TokensBurnt<T>>::get(collection.id)201			.checked_add(1)202			.ok_or(ArithmeticError::Overflow)?;203204		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))205			.checked_sub(1)206			.ok_or(ArithmeticError::Overflow)?;207208		if balance == 0 {209			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));210		} else {211			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);212		}213		// =========214215		<Owned<T>>::remove((collection.id, &token_data.owner, token));216		<TokensBurnt<T>>::insert(collection.id, burnt);217		<TokenData<T>>::remove((collection.id, token));218		let old_spender = <Allowance<T>>::take((collection.id, token));219220		if let Some(old_spender) = old_spender {221			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(222				collection.id,223				token,224				sender.clone(),225				old_spender,226				0,227			));228		}229230		collection.log_mirrored(ERC721Events::Transfer {231			from: *token_data.owner.as_eth(),232			to: H160::default(),233			token_id: token.into(),234		});235		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(236			collection.id,237			token,238			token_data.owner,239			1,240		));241		Ok(())242	}243244	pub fn transfer(245		collection: &NonfungibleHandle<T>,246		from: &T::CrossAccountId,247		to: &T::CrossAccountId,248		token: TokenId,249	) -> DispatchResult {250		ensure!(251			collection.limits.transfers_enabled(),252			<CommonError<T>>::TransferNotAllowed253		);254255		let token_data =256			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;257		ensure!(258			&token_data.owner == from259				|| (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(from)),260			<CommonError<T>>::NoPermission261		);262263		if collection.access == AccessMode::AllowList {264			collection.check_allowlist(from)?;265			collection.check_allowlist(to)?;266		}267		<PalletCommon<T>>::ensure_correct_receiver(to)?;268269		let balance_from = <AccountBalance<T>>::get((collection.id, from))270			.checked_sub(1)271			.ok_or(<CommonError<T>>::TokenValueTooLow)?;272		let balance_to = if from != to {273			let balance_to = <AccountBalance<T>>::get((collection.id, to))274				.checked_add(1)275				.ok_or(ArithmeticError::Overflow)?;276277			ensure!(278				balance_to < collection.limits.account_token_ownership_limit(),279				<CommonError<T>>::AccountTokenLimitExceeded,280			);281282			Some(balance_to)283		} else {284			None285		};286287		// =========288289		<TokenData<T>>::insert(290			(collection.id, token),291			ItemData {292				owner: to.clone(),293				..token_data294			},295		);296297		if let Some(balance_to) = balance_to {298			// from != to299			if balance_from == 0 {300				<AccountBalance<T>>::remove((collection.id, from));301			} else {302				<AccountBalance<T>>::insert((collection.id, from), balance_from);303			}304			<AccountBalance<T>>::insert((collection.id, to), balance_to);305			<Owned<T>>::remove((collection.id, from, token));306			<Owned<T>>::insert((collection.id, to, token), true);307		}308		Self::set_allowance_unchecked(collection, from, token, None, true);309310		collection.log_mirrored(ERC721Events::Transfer {311			from: *from.as_eth(),312			to: *to.as_eth(),313			token_id: token.into(),314		});315		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(316			collection.id,317			token,318			from.clone(),319			to.clone(),320			1,321		));322		Ok(())323	}324325	pub fn create_multiple_items(326		collection: &NonfungibleHandle<T>,327		sender: &T::CrossAccountId,328		data: Vec<CreateItemData<T>>,329	) -> DispatchResult {330		if !collection.is_owner_or_admin(sender) {331			ensure!(332				collection.mint_mode,333				<CommonError<T>>::PublicMintingNotAllowed334			);335			collection.check_allowlist(sender)?;336337			for item in data.iter() {338				collection.check_allowlist(&item.owner)?;339			}340		}341342		for data in data.iter() {343			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;344		}345346		let first_token = <TokensMinted<T>>::get(collection.id);347		let tokens_minted = first_token348			.checked_add(data.len() as u32)349			.ok_or(ArithmeticError::Overflow)?;350		ensure!(351			tokens_minted <= collection.limits.token_limit(),352			<CommonError<T>>::CollectionTokenLimitExceeded353		);354355		let mut balances = BTreeMap::new();356		for data in &data {357			let balance = balances358				.entry(&data.owner)359				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));360			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;361362			ensure!(363				*balance <= collection.limits.account_token_ownership_limit(),364				<CommonError<T>>::AccountTokenLimitExceeded,365			);366		}367368		// =========369370		<TokensMinted<T>>::insert(collection.id, tokens_minted);371		for (account, balance) in balances {372			<AccountBalance<T>>::insert((collection.id, account), balance);373		}374		for (i, data) in data.into_iter().enumerate() {375			let token = first_token + i as u32 + 1;376377			<TokenData<T>>::insert(378				(collection.id, token),379				ItemData {380					const_data: data.const_data,381					variable_data: data.variable_data,382					owner: data.owner.clone(),383				},384			);385			<Owned<T>>::insert((collection.id, &data.owner, token), true);386387			collection.log_mirrored(ERC721Events::Transfer {388				from: H160::default(),389				to: *data.owner.as_eth(),390				token_id: token.into(),391			});392			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(393				collection.id,394				TokenId(token),395				data.owner.clone(),396				1,397			));398		}399		Ok(())400	}401402	pub fn set_allowance_unchecked(403		collection: &NonfungibleHandle<T>,404		sender: &T::CrossAccountId,405		token: TokenId,406		spender: Option<&T::CrossAccountId>,407		assume_implicit_eth: bool,408	) {409		if let Some(spender) = spender {410			let old_spender = <Allowance<T>>::get((collection.id, token));411			<Allowance<T>>::insert((collection.id, token), spender);412			// In ERC721 there is only one possible approved user of token, so we set413			// approved user to spender414			collection.log_mirrored(ERC721Events::Approval {415				owner: *sender.as_eth(),416				approved: *spender.as_eth(),417				token_id: token.into(),418			});419			// In Unique chain, any token can have any amount of approved users, so we need to420			// set allowance of old owner to 0, and allowance of new owner to 1421			if old_spender.as_ref() != Some(spender) {422				if let Some(old_owner) = old_spender {423					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(424						collection.id,425						token,426						sender.clone(),427						old_owner,428						0,429					));430				}431				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(432					collection.id,433					token,434					sender.clone(),435					spender.clone(),436					1,437				));438			}439		} else {440			let old_spender = <Allowance<T>>::take((collection.id, token));441			if !assume_implicit_eth {442				// In ERC721 there is only one possible approved user of token, so we set443				// approved user to zero address444				collection.log_mirrored(ERC721Events::Approval {445					owner: *sender.as_eth(),446					approved: H160::default(),447					token_id: token.into(),448				});449			}450			// In Unique chain, any token can have any amount of approved users, so we need to451			// set allowance of old owner to 0452			if let Some(old_spender) = old_spender {453				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(454					collection.id,455					token,456					sender.clone(),457					old_spender,458					0,459				));460			}461		}462	}463464	pub fn set_allowance(465		collection: &NonfungibleHandle<T>,466		sender: &T::CrossAccountId,467		token: TokenId,468		spender: Option<&T::CrossAccountId>,469	) -> DispatchResult {470		if collection.access == AccessMode::AllowList {471			collection.check_allowlist(sender)?;472			if let Some(spender) = spender {473				collection.check_allowlist(spender)?;474			}475		}476477		if let Some(spender) = spender {478			<PalletCommon<T>>::ensure_correct_receiver(spender)?;479		}480		let token_data =481			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;482		if &token_data.owner != sender {483			ensure!(484				collection.ignores_owned_amount(sender),485				<CommonError<T>>::CantApproveMoreThanOwned486			);487		}488489		// =========490491		Self::set_allowance_unchecked(collection, sender, token, spender, false);492		Ok(())493	}494495	pub fn transfer_from(496		collection: &NonfungibleHandle<T>,497		spender: &T::CrossAccountId,498		from: &T::CrossAccountId,499		to: &T::CrossAccountId,500		token: TokenId,501	) -> DispatchResult {502		if spender.conv_eq(from) {503			return Self::transfer(collection, from, to, token);504		}505		if collection.access == AccessMode::AllowList {506			// `from`, `to` checked in [`transfer`]507			collection.check_allowlist(spender)?;508		}509510		if <Allowance<T>>::get((collection.id, token)).as_ref() != Some(spender) {511			ensure!(512				collection.ignores_allowance(spender),513				<CommonError<T>>::ApprovedValueTooLow514			);515		}516517		// =========518519		Self::transfer(collection, from, to, token)?;520		// Allowance is reset in [`transfer`]521		Ok(())522	}523524	pub fn burn_from(525		collection: &NonfungibleHandle<T>,526		spender: &T::CrossAccountId,527		from: &T::CrossAccountId,528		token: TokenId,529	) -> DispatchResult {530		if spender.conv_eq(from) {531			return Self::burn(collection, from, token);532		}533		if collection.access == AccessMode::AllowList {534			// `from` checked in [`burn`]535			collection.check_allowlist(spender)?;536		}537538		if <Allowance<T>>::get((collection.id, token)).as_ref() != Some(spender) {539			ensure!(540				collection.ignores_allowance(spender),541				<CommonError<T>>::ApprovedValueTooLow542			);543		}544545		// =========546547		Self::burn(collection, from, token)548	}549550	pub fn set_variable_metadata(551		collection: &NonfungibleHandle<T>,552		sender: &T::CrossAccountId,553		token: TokenId,554		data: BoundedVec<u8, CustomDataLimit>,555	) -> DispatchResult {556		let token_data =557			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;558		collection.check_can_update_meta(sender, &token_data.owner)?;559560		// =========561562		<TokenData<T>>::insert(563			(collection.id, token),564			ItemData {565				variable_data: data,566				..token_data567			},568		);569		Ok(())570	}571572	/// Delegated to `create_multiple_items`573	pub fn create_item(574		collection: &NonfungibleHandle<T>,575		sender: &T::CrossAccountId,576		data: CreateItemData<T>,577	) -> DispatchResult {578		Self::create_multiple_items(collection, sender, vec![data])579	}580}