git.delta.rocks / unique-network / refs/commits / b69992369f0e

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, budget::Budget, Property, PropertyPermission,24};25use pallet_evm::account::CrossAccountId;26use pallet_common::{27	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,28	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	#[pallet::storage]98	pub type TokenProperties<T: Config> = StorageNMap<99		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),100		Value = up_data_structs::Properties,101		QueryKind = ValueQuery,102		OnEmpty = up_data_structs::TokenProperties,103	>;104105	/// Used to enumerate tokens owned by account106	#[pallet::storage]107	pub type Owned<T: Config> = StorageNMap<108		Key = (109			Key<Twox64Concat, CollectionId>,110			Key<Blake2_128Concat, T::CrossAccountId>,111			Key<Twox64Concat, TokenId>,112		),113		Value = bool,114		QueryKind = ValueQuery,115	>;116117	#[pallet::storage]118	pub type AccountBalance<T: Config> = StorageNMap<119		Key = (120			Key<Twox64Concat, CollectionId>,121			Key<Blake2_128Concat, T::CrossAccountId>,122		),123		Value = u32,124		QueryKind = ValueQuery,125	>;126127	#[pallet::storage]128	pub type Allowance<T: Config> = StorageNMap<129		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),130		Value = T::CrossAccountId,131		QueryKind = OptionQuery,132	>;133}134135pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);136impl<T: Config> NonfungibleHandle<T> {137	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {138		Self(inner)139	}140	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {141		self.0142	}143}144impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {145	fn recorder(&self) -> &SubstrateRecorder<T> {146		self.0.recorder()147	}148	fn into_recorder(self) -> SubstrateRecorder<T> {149		self.0.into_recorder()150	}151}152impl<T: Config> Deref for NonfungibleHandle<T> {153	type Target = pallet_common::CollectionHandle<T>;154155	fn deref(&self) -> &Self::Target {156		&self.0157	}158}159160impl<T: Config> Pallet<T> {161	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {162		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)163	}164	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {165		<TokenData<T>>::contains_key((collection.id, token))166	}167}168169// unchecked calls skips any permission checks170impl<T: Config> Pallet<T> {171	pub fn init_collection(172		owner: T::AccountId,173		data: CreateCollectionData<T::AccountId>,174	) -> Result<CollectionId, DispatchError> {175		<PalletCommon<T>>::init_collection(owner, data)176	}177	pub fn destroy_collection(178		collection: NonfungibleHandle<T>,179		sender: &T::CrossAccountId,180	) -> DispatchResult {181		let id = collection.id;182183		// =========184185		PalletCommon::destroy_collection(collection.0, sender)?;186187		<TokenData<T>>::remove_prefix((id,), None);188		<Owned<T>>::remove_prefix((id,), None);189		<TokensMinted<T>>::remove(id);190		<TokensBurnt<T>>::remove(id);191		<Allowance<T>>::remove_prefix((id,), None);192		<AccountBalance<T>>::remove_prefix((id,), None);193		Ok(())194	}195196	pub fn burn(197		collection: &NonfungibleHandle<T>,198		sender: &T::CrossAccountId,199		token: TokenId,200	) -> DispatchResult {201		let token_data =202			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;203		ensure!(204			&token_data.owner == sender205				|| (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(sender)),206			<CommonError<T>>::NoPermission207		);208209		if collection.access == AccessMode::AllowList {210			collection.check_allowlist(sender)?;211		}212213		let burnt = <TokensBurnt<T>>::get(collection.id)214			.checked_add(1)215			.ok_or(ArithmeticError::Overflow)?;216217		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))218			.checked_sub(1)219			.ok_or(ArithmeticError::Overflow)?;220221		if balance == 0 {222			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));223		} else {224			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);225		}226		// =========227228		<Owned<T>>::remove((collection.id, &token_data.owner, token));229		<TokensBurnt<T>>::insert(collection.id, burnt);230		<TokenData<T>>::remove((collection.id, token));231		let old_spender = <Allowance<T>>::take((collection.id, token));232233		if let Some(old_spender) = old_spender {234			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(235				collection.id,236				token,237				sender.clone(),238				old_spender,239				0,240			));241		}242243		collection.log_mirrored(ERC721Events::Transfer {244			from: *token_data.owner.as_eth(),245			to: H160::default(),246			token_id: token.into(),247		});248		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(249			collection.id,250			token,251			token_data.owner,252			1,253		));254		Ok(())255	}256257	pub fn change_token_property(258		collection: &NonfungibleHandle<T>,259		sender: &T::CrossAccountId,260		token_id: TokenId,261		property: Property,262	) -> DispatchResult {263		let permission = <PalletCommon<T>>::property_permission(collection.id)264			.get(&property.key)265			.map(|p| p.clone())266			.unwrap_or(PropertyPermission::None);267268		let check_token_owner = || -> DispatchResult {269			let token_data = <TokenData<T>>::get((collection.id, token_id))270				.ok_or(<CommonError<T>>::TokenNotFound)?;271272			ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);273274			Ok(())275		};276277		let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))278			.get_property(&property.key)279			.is_some();280281		match (permission, is_property_exists) {282			(PropertyPermission::AdminConst, false) => {283				collection.check_is_owner_or_admin(sender)?284			}285			(PropertyPermission::Admin, _) => collection.check_is_owner_or_admin(sender)?,286			(PropertyPermission::ItemOwnerConst, false) => check_token_owner()?,287			(PropertyPermission::ItemOwner, _) => check_token_owner()?,288			(PropertyPermission::ItemOwnerOrAdmin, _) => {289				check_token_owner().or(collection.check_is_owner_or_admin(sender))?;290			}291			_ => return Err(<CommonError<T>>::NoPermission.into()),292		}293294		<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {295			properties.try_change_property(property.clone())296		})?;297298		<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(299			collection.id,300			token_id,301			property,302		));303304		Ok(())305	}306307	pub fn transfer(308		collection: &NonfungibleHandle<T>,309		from: &T::CrossAccountId,310		to: &T::CrossAccountId,311		token: TokenId,312		nesting_budget: &dyn Budget,313	) -> DispatchResult {314		ensure!(315			collection.limits.transfers_enabled(),316			<CommonError<T>>::TransferNotAllowed317		);318319		let token_data =320			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;321		// TODO: require sender to be token, owner, require admins to go through transfer_from322		ensure!(323			&token_data.owner == from324				|| (collection.limits.owner_can_transfer() && collection.is_owner_or_admin(from)),325			<CommonError<T>>::NoPermission326		);327328		if collection.access == AccessMode::AllowList {329			collection.check_allowlist(from)?;330			collection.check_allowlist(to)?;331		}332		<PalletCommon<T>>::ensure_correct_receiver(to)?;333334		let balance_from = <AccountBalance<T>>::get((collection.id, from))335			.checked_sub(1)336			.ok_or(<CommonError<T>>::TokenValueTooLow)?;337		let balance_to = if from != to {338			let balance_to = <AccountBalance<T>>::get((collection.id, to))339				.checked_add(1)340				.ok_or(ArithmeticError::Overflow)?;341342			ensure!(343				balance_to < collection.limits.account_token_ownership_limit(),344				<CommonError<T>>::AccountTokenLimitExceeded,345			);346347			Some(balance_to)348		} else {349			None350		};351352		if let Some(target) = T::CrossTokenAddressMapping::address_to_token(to) {353			let handle = <CollectionHandle<T>>::try_get(target.0)?;354			let dispatch = T::CollectionDispatch::dispatch(handle);355			let dispatch = dispatch.as_dyn();356357			dispatch.check_nesting(358				from.clone(),359				(collection.id, token),360				target.1,361				nesting_budget,362			)?;363		}364365		// =========366367		<TokenData<T>>::insert(368			(collection.id, token),369			ItemData {370				owner: to.clone(),371				..token_data372			},373		);374375		if let Some(balance_to) = balance_to {376			// from != to377			if balance_from == 0 {378				<AccountBalance<T>>::remove((collection.id, from));379			} else {380				<AccountBalance<T>>::insert((collection.id, from), balance_from);381			}382			<AccountBalance<T>>::insert((collection.id, to), balance_to);383			<Owned<T>>::remove((collection.id, from, token));384			<Owned<T>>::insert((collection.id, to, token), true);385		}386		Self::set_allowance_unchecked(collection, from, token, None, true);387388		collection.log_mirrored(ERC721Events::Transfer {389			from: *from.as_eth(),390			to: *to.as_eth(),391			token_id: token.into(),392		});393		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(394			collection.id,395			token,396			from.clone(),397			to.clone(),398			1,399		));400		Ok(())401	}402403	pub fn create_multiple_items(404		collection: &NonfungibleHandle<T>,405		sender: &T::CrossAccountId,406		data: Vec<CreateItemData<T>>,407		nesting_budget: &dyn Budget,408	) -> DispatchResult {409		if !collection.is_owner_or_admin(sender) {410			ensure!(411				collection.mint_mode,412				<CommonError<T>>::PublicMintingNotAllowed413			);414			collection.check_allowlist(sender)?;415416			for item in data.iter() {417				collection.check_allowlist(&item.owner)?;418			}419		}420421		for data in data.iter() {422			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;423		}424425		let first_token = <TokensMinted<T>>::get(collection.id);426		let tokens_minted = first_token427			.checked_add(data.len() as u32)428			.ok_or(ArithmeticError::Overflow)?;429		ensure!(430			tokens_minted <= collection.limits.token_limit(),431			<CommonError<T>>::CollectionTokenLimitExceeded432		);433434		let mut balances = BTreeMap::new();435		for data in &data {436			let balance = balances437				.entry(&data.owner)438				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));439			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;440441			ensure!(442				*balance <= collection.limits.account_token_ownership_limit(),443				<CommonError<T>>::AccountTokenLimitExceeded,444			);445		}446447		for (i, data) in data.iter().enumerate() {448			let token = TokenId(first_token + i as u32 + 1);449			if let Some(target) = T::CrossTokenAddressMapping::address_to_token(&data.owner) {450				let handle = <CollectionHandle<T>>::try_get(target.0)?;451				let dispatch = T::CollectionDispatch::dispatch(handle);452				let dispatch = dispatch.as_dyn();453				dispatch.check_nesting(454					sender.clone(),455					(collection.id, token),456					target.1,457					nesting_budget,458				)?;459			}460		}461462		// =========463464		<TokensMinted<T>>::insert(collection.id, tokens_minted);465		for (account, balance) in balances {466			<AccountBalance<T>>::insert((collection.id, account), balance);467		}468		for (i, data) in data.into_iter().enumerate() {469			let token = first_token + i as u32 + 1;470471			<TokenData<T>>::insert(472				(collection.id, token),473				ItemData {474					const_data: data.const_data,475					variable_data: data.variable_data,476					owner: data.owner.clone(),477				},478			);479			<Owned<T>>::insert((collection.id, &data.owner, token), true);480481			collection.log_mirrored(ERC721Events::Transfer {482				from: H160::default(),483				to: *data.owner.as_eth(),484				token_id: token.into(),485			});486			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(487				collection.id,488				TokenId(token),489				data.owner.clone(),490				1,491			));492		}493		Ok(())494	}495496	pub fn set_allowance_unchecked(497		collection: &NonfungibleHandle<T>,498		sender: &T::CrossAccountId,499		token: TokenId,500		spender: Option<&T::CrossAccountId>,501		assume_implicit_eth: bool,502	) {503		if let Some(spender) = spender {504			let old_spender = <Allowance<T>>::get((collection.id, token));505			<Allowance<T>>::insert((collection.id, token), spender);506			// In ERC721 there is only one possible approved user of token, so we set507			// approved user to spender508			collection.log_mirrored(ERC721Events::Approval {509				owner: *sender.as_eth(),510				approved: *spender.as_eth(),511				token_id: token.into(),512			});513			// In Unique chain, any token can have any amount of approved users, so we need to514			// set allowance of old owner to 0, and allowance of new owner to 1515			if old_spender.as_ref() != Some(spender) {516				if let Some(old_owner) = old_spender {517					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(518						collection.id,519						token,520						sender.clone(),521						old_owner,522						0,523					));524				}525				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(526					collection.id,527					token,528					sender.clone(),529					spender.clone(),530					1,531				));532			}533		} else {534			let old_spender = <Allowance<T>>::take((collection.id, token));535			if !assume_implicit_eth {536				// In ERC721 there is only one possible approved user of token, so we set537				// approved user to zero address538				collection.log_mirrored(ERC721Events::Approval {539					owner: *sender.as_eth(),540					approved: H160::default(),541					token_id: token.into(),542				});543			}544			// In Unique chain, any token can have any amount of approved users, so we need to545			// set allowance of old owner to 0546			if let Some(old_spender) = old_spender {547				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(548					collection.id,549					token,550					sender.clone(),551					old_spender,552					0,553				));554			}555		}556	}557558	pub fn set_allowance(559		collection: &NonfungibleHandle<T>,560		sender: &T::CrossAccountId,561		token: TokenId,562		spender: Option<&T::CrossAccountId>,563	) -> DispatchResult {564		if collection.access == AccessMode::AllowList {565			collection.check_allowlist(sender)?;566			if let Some(spender) = spender {567				collection.check_allowlist(spender)?;568			}569		}570571		if let Some(spender) = spender {572			<PalletCommon<T>>::ensure_correct_receiver(spender)?;573		}574		let token_data =575			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;576		if &token_data.owner != sender {577			ensure!(578				collection.ignores_owned_amount(sender),579				<CommonError<T>>::CantApproveMoreThanOwned580			);581		}582583		// =========584585		Self::set_allowance_unchecked(collection, sender, token, spender, false);586		Ok(())587	}588589	fn check_allowed(590		collection: &NonfungibleHandle<T>,591		spender: &T::CrossAccountId,592		from: &T::CrossAccountId,593		token: TokenId,594		nesting_budget: &dyn Budget,595	) -> DispatchResult {596		if spender.conv_eq(from) {597			return Ok(());598		}599		if collection.access == AccessMode::AllowList {600			// `from`, `to` checked in [`transfer`]601			collection.check_allowlist(spender)?;602		}603		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {604			// TODO: should collection owner be allowed to perform this transfer?605			ensure!(606				<PalletStructure<T>>::check_indirectly_owned(607					spender.clone(),608					source.0,609					source.1,610					None,611					nesting_budget612				)?,613				<CommonError<T>>::ApprovedValueTooLow,614			);615			return Ok(());616		}617		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {618			return Ok(());619		}620		ensure!(621			collection.ignores_allowance(spender),622			<CommonError<T>>::ApprovedValueTooLow623		);624		Ok(())625	}626627	pub fn transfer_from(628		collection: &NonfungibleHandle<T>,629		spender: &T::CrossAccountId,630		from: &T::CrossAccountId,631		to: &T::CrossAccountId,632		token: TokenId,633		nesting_budget: &dyn Budget,634	) -> DispatchResult {635		Self::check_allowed(collection, spender, from, token, nesting_budget)?;636637		// =========638639		// Allowance is reset in [`transfer`]640		Self::transfer(collection, from, to, token, nesting_budget)641	}642643	pub fn burn_from(644		collection: &NonfungibleHandle<T>,645		spender: &T::CrossAccountId,646		from: &T::CrossAccountId,647		token: TokenId,648		nesting_budget: &dyn Budget,649	) -> DispatchResult {650		Self::check_allowed(collection, spender, from, token, nesting_budget)?;651652		// =========653654		Self::burn(collection, from, token)655	}656657	pub fn set_variable_metadata(658		collection: &NonfungibleHandle<T>,659		sender: &T::CrossAccountId,660		token: TokenId,661		data: BoundedVec<u8, CustomDataLimit>,662	) -> DispatchResult {663		let token_data =664			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;665		collection.check_can_update_meta(sender, &token_data.owner)?;666667		// =========668669		<TokenData<T>>::insert(670			(collection.id, token),671			ItemData {672				variable_data: data,673				..token_data674			},675		);676		Ok(())677	}678679	pub fn check_nesting(680		handle: &NonfungibleHandle<T>,681		sender: T::CrossAccountId,682		from: (CollectionId, TokenId),683		under: TokenId,684		nesting_budget: &dyn Budget,685	) -> DispatchResult {686		fn ensure_sender_allowed<T: Config>(687			collection: CollectionId,688			token: TokenId,689			for_nest: (CollectionId, TokenId),690			sender: T::CrossAccountId,691			budget: &dyn Budget,692		) -> DispatchResult {693			ensure!(694				<PalletStructure<T>>::check_indirectly_owned(695					sender,696					collection,697					token,698					Some(for_nest),699					budget700				)?,701				<CommonError<T>>::OnlyOwnerAllowedToNest,702			);703			Ok(())704		}705		match handle.limits.nesting_rule() {706			NestingRule::Disabled => fail!(<CommonError<T>>::NestingIsDisabled),707			NestingRule::Owner => {708				ensure_sender_allowed::<T>(handle.id, under, from, sender, nesting_budget)?709			}710			NestingRule::OwnerRestricted(whitelist) => {711				ensure!(712					whitelist.contains(&from.0),713					<CommonError<T>>::SourceCollectionIsNotAllowedToNest714				);715				ensure_sender_allowed::<T>(handle.id, under, from, sender, nesting_budget)?716			}717		}718		Ok(())719	}720721	/// Delegated to `create_multiple_items`722	pub fn create_item(723		collection: &NonfungibleHandle<T>,724		sender: &T::CrossAccountId,725		data: CreateItemData<T>,726		nesting_budget: &dyn Budget,727	) -> DispatchResult {728		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)729	}730}