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

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//! This module contains the implementation of pallet methods for evm.1819use evm_coder::{20	solidity_interface, solidity, ToLog,21	types::*,22	execution::{Result, Error},23};24pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};25use pallet_evm_coder_substrate::dispatch_to_evm;26use sp_std::vec::Vec;27use up_data_structs::{28	AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,29	SponsoringRateLimit,30};31use alloc::format;3233use crate::{34	Pallet, CollectionHandle, Config, CollectionProperties,35	eth::convert_substrate_address_to_cross_account_id,36};3738/// Events for ethereum collection helper.39#[derive(ToLog)]40pub enum CollectionHelpersEvents {41	/// The collection has been created.42	CollectionCreated {43		/// Collection owner.44		#[indexed]45		owner: address,4647		/// Collection ID.48		#[indexed]49		collection_id: address,50	},51}5253/// Does not always represent a full collection, for RFT it is either54/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).55pub trait CommonEvmHandler {56	const CODE: &'static [u8];5758	/// Call precompiled handle.59	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;60}6162/// @title A contract that allows you to work with collections.63#[solidity_interface(name = Collection)]64impl<T: Config> CollectionHandle<T>65where66	T::AccountId: From<[u8; 32]>,67{68	/// Set collection property.69	///70	/// @param key Property key.71	/// @param value Propery value.72	fn set_collection_property(73		&mut self,74		caller: caller,75		key: string,76		value: bytes,77	) -> Result<void> {78		let caller = T::CrossAccountId::from_eth(caller);79		let key = <Vec<u8>>::from(key)80			.try_into()81			.map_err(|_| "key too large")?;82		let value = value.try_into().map_err(|_| "value too large")?;8384		<Pallet<T>>::set_collection_property(self, &caller, Property { key, value })85			.map_err(dispatch_to_evm::<T>)86	}8788	/// Delete collection property.89	///90	/// @param key Property key.91	fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {92		let caller = T::CrossAccountId::from_eth(caller);93		let key = <Vec<u8>>::from(key)94			.try_into()95			.map_err(|_| "key too large")?;9697		<Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)98	}99100	/// Get collection property.101	///102	/// @dev Throws error if key not found.103	///104	/// @param key Property key.105	/// @return bytes The property corresponding to the key.106	fn collection_property(&self, key: string) -> Result<bytes> {107		let key = <Vec<u8>>::from(key)108			.try_into()109			.map_err(|_| "key too large")?;110111		let props = <CollectionProperties<T>>::get(self.id);112		let prop = props.get(&key).ok_or("key not found")?;113114		Ok(prop.to_vec())115	}116117	/// Set the sponsor of the collection.118	///119	/// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.120	///121	/// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.122	fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {123		check_is_owner_or_admin(caller, self)?;124125		let sponsor = T::CrossAccountId::from_eth(sponsor);126		self.set_sponsor(sponsor.as_sub().clone())127			.map_err(dispatch_to_evm::<T>)?;128		save(self)129	}130131	/// Collection sponsorship confirmation.132	///133	/// @dev After setting the sponsor for the collection, it must be confirmed with this function.134	fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {135		let caller = T::CrossAccountId::from_eth(caller);136		if !self137			.confirm_sponsorship(caller.as_sub())138			.map_err(dispatch_to_evm::<T>)?139		{140			return Err("caller is not set as sponsor".into());141		}142		save(self)143	}144145	/// Set limits for the collection.146	/// @dev Throws error if limit not found.147	/// @param limit Name of the limit. Valid names:148	/// 	"accountTokenOwnershipLimit",149	/// 	"sponsoredDataSize",150	/// 	"sponsoredDataRateLimit",151	/// 	"tokenLimit",152	/// 	"sponsorTransferTimeout",153	/// 	"sponsorApproveTimeout"154	/// @param value Value of the limit.155	#[solidity(rename_selector = "setCollectionLimit")]156	fn set_int_limit(&mut self, caller: caller, limit: string, value: uint32) -> Result<void> {157		check_is_owner_or_admin(caller, self)?;158		let mut limits = self.limits.clone();159160		match limit.as_str() {161			"accountTokenOwnershipLimit" => {162				limits.account_token_ownership_limit = Some(value);163			}164			"sponsoredDataSize" => {165				limits.sponsored_data_size = Some(value);166			}167			"sponsoredDataRateLimit" => {168				limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));169			}170			"tokenLimit" => {171				limits.token_limit = Some(value);172			}173			"sponsorTransferTimeout" => {174				limits.sponsor_transfer_timeout = Some(value);175			}176			"sponsorApproveTimeout" => {177				limits.sponsor_approve_timeout = Some(value);178			}179			_ => {180				return Err(Error::Revert(format!(181					"unknown integer limit \"{}\"",182					limit183				)))184			}185		}186		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)187			.map_err(dispatch_to_evm::<T>)?;188		save(self)189	}190191	/// Set limits for the collection.192	/// @dev Throws error if limit not found.193	/// @param limit Name of the limit. Valid names:194	/// 	"ownerCanTransfer",195	/// 	"ownerCanDestroy",196	/// 	"transfersEnabled"197	/// @param value Value of the limit.198	#[solidity(rename_selector = "setCollectionLimit")]199	fn set_bool_limit(&mut self, caller: caller, limit: string, value: bool) -> Result<void> {200		check_is_owner_or_admin(caller, self)?;201		let mut limits = self.limits.clone();202203		match limit.as_str() {204			"ownerCanTransfer" => {205				limits.owner_can_transfer = Some(value);206			}207			"ownerCanDestroy" => {208				limits.owner_can_destroy = Some(value);209			}210			"transfersEnabled" => {211				limits.transfers_enabled = Some(value);212			}213			_ => {214				return Err(Error::Revert(format!(215					"unknown boolean limit \"{}\"",216					limit217				)))218			}219		}220		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)221			.map_err(dispatch_to_evm::<T>)?;222		save(self)223	}224225	/// Get contract address.226	fn contract_address(&self, _caller: caller) -> Result<address> {227		Ok(crate::eth::collection_id_to_address(self.id))228	}229230	/// Add collection admin by substrate address.231	/// @param newAdmin Substrate administrator address.232	fn add_collection_admin_substrate(233		&mut self,234		caller: caller,235		new_admin: uint256,236	) -> Result<void> {237		let caller = T::CrossAccountId::from_eth(caller);238		let new_admin = convert_substrate_address_to_cross_account_id::<T>(new_admin);239		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;240		Ok(())241	}242243	/// Remove collection admin by substrate address.244	/// @param admin Substrate administrator address.245	fn remove_collection_admin_substrate(246		&mut self,247		caller: caller,248		admin: uint256,249	) -> Result<void> {250		let caller = T::CrossAccountId::from_eth(caller);251		let admin = convert_substrate_address_to_cross_account_id::<T>(admin);252		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;253		Ok(())254	}255256	/// Add collection admin.257	/// @param newAdmin Address of the added administrator.258	fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {259		let caller = T::CrossAccountId::from_eth(caller);260		let new_admin = T::CrossAccountId::from_eth(new_admin);261		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;262		Ok(())263	}264265	/// Remove collection admin.266	///267	/// @param admin Address of the removed administrator.268	fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {269		let caller = T::CrossAccountId::from_eth(caller);270		let admin = T::CrossAccountId::from_eth(admin);271		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;272		Ok(())273	}274275	/// Toggle accessibility of collection nesting.276	///277	/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'278	#[solidity(rename_selector = "setCollectionNesting")]279	fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {280		check_is_owner_or_admin(caller, self)?;281282		let mut permissions = self.collection.permissions.clone();283		let mut nesting = permissions.nesting().clone();284		nesting.token_owner = enable;285		nesting.restricted = None;286		permissions.nesting = Some(nesting);287288		self.collection.permissions = <Pallet<T>>::clamp_permissions(289			self.collection.mode.clone(),290			&self.collection.permissions,291			permissions,292		)293		.map_err(dispatch_to_evm::<T>)?;294295		save(self)296	}297298	/// Toggle accessibility of collection nesting.299	///300	/// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'301	/// @param collections Addresses of collections that will be available for nesting.302	#[solidity(rename_selector = "setCollectionNesting")]303	fn set_nesting(304		&mut self,305		caller: caller,306		enable: bool,307		collections: Vec<address>,308	) -> Result<void> {309		if collections.is_empty() {310			return Err("no addresses provided".into());311		}312		check_is_owner_or_admin(caller, self)?;313314		let mut permissions = self.collection.permissions.clone();315		match enable {316			false => {317				let mut nesting = permissions.nesting().clone();318				nesting.token_owner = false;319				nesting.restricted = None;320				permissions.nesting = Some(nesting);321			}322			true => {323				let mut bv = OwnerRestrictedSet::new();324				for i in collections {325					bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or(Error::Revert(326						"Can't convert address into collection id".into(),327					))?)328					.map_err(|_| "too many collections")?;329				}330				let mut nesting = permissions.nesting().clone();331				nesting.token_owner = true;332				nesting.restricted = Some(bv);333				permissions.nesting = Some(nesting);334			}335		};336337		self.collection.permissions = <Pallet<T>>::clamp_permissions(338			self.collection.mode.clone(),339			&self.collection.permissions,340			permissions,341		)342		.map_err(dispatch_to_evm::<T>)?;343344		save(self)345	}346347	/// Set the collection access method.348	/// @param mode Access mode349	/// 	0 for Normal350	/// 	1 for AllowList351	fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {352		check_is_owner_or_admin(caller, self)?;353		let permissions = CollectionPermissions {354			access: Some(match mode {355				0 => AccessMode::Normal,356				1 => AccessMode::AllowList,357				_ => return Err("not supported access mode".into()),358			}),359			..Default::default()360		};361		self.collection.permissions = <Pallet<T>>::clamp_permissions(362			self.collection.mode.clone(),363			&self.collection.permissions,364			permissions,365		)366		.map_err(dispatch_to_evm::<T>)?;367368		save(self)369	}370371	/// Add the user to the allowed list.372	///373	/// @param user Address of a trusted user.374	fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {375		let caller = T::CrossAccountId::from_eth(caller);376		let user = T::CrossAccountId::from_eth(user);377		<Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;378		Ok(())379	}380381	/// Remove the user from the allowed list.382	///383	/// @param user Address of a removed user.384	fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {385		let caller = T::CrossAccountId::from_eth(caller);386		let user = T::CrossAccountId::from_eth(user);387		<Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;388		Ok(())389	}390391	/// Switch permission for minting.392	///393	/// @param mode Enable if "true".394	fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {395		check_is_owner_or_admin(caller, self)?;396		let permissions = CollectionPermissions {397			mint_mode: Some(mode),398			..Default::default()399		};400		self.collection.permissions = <Pallet<T>>::clamp_permissions(401			self.collection.mode.clone(),402			&self.collection.permissions,403			permissions,404		)405		.map_err(dispatch_to_evm::<T>)?;406407		save(self)408	}409410	/// Check that account is the owner or admin of the collection411	///412	/// @param user account to verify413	/// @return "true" if account is the owner or admin414	#[solidity(rename_selector = "isOwnerOrAdmin")]415	fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {416		let user = T::CrossAccountId::from_eth(user);417		Ok(self.is_owner_or_admin(&user))418	}419420	/// Check that substrate account is the owner or admin of the collection421	///422	/// @param user account to verify423	/// @return "true" if account is the owner or admin424	fn is_owner_or_admin_substrate(&self, user: uint256) -> Result<bool> {425		let user = convert_substrate_address_to_cross_account_id::<T>(user);426		Ok(self.is_owner_or_admin(&user))427	}428429	/// Returns collection type430	///431	/// @return `Fungible` or `NFT` or `ReFungible`432	fn unique_collection_type(&mut self) -> Result<string> {433		let mode = match self.collection.mode {434			CollectionMode::Fungible(_) => "Fungible",435			CollectionMode::NFT => "NFT",436			CollectionMode::ReFungible => "ReFungible",437		};438		Ok(mode.into())439	}440441	/// Changes collection owner to another account442	///443	/// @dev Owner can be changed only by current owner444	/// @param newOwner new owner account445	fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {446		let caller = T::CrossAccountId::from_eth(caller);447		let new_owner = T::CrossAccountId::from_eth(new_owner);448		self.set_owner_internal(caller, new_owner)449			.map_err(dispatch_to_evm::<T>)450	}451452	/// Changes collection owner to another substrate account453	///454	/// @dev Owner can be changed only by current owner455	/// @param newOwner new owner substrate account456	fn set_owner_substrate(&mut self, caller: caller, new_owner: uint256) -> Result<void> {457		let caller = T::CrossAccountId::from_eth(caller);458		let new_owner = convert_substrate_address_to_cross_account_id::<T>(new_owner);459		self.set_owner_internal(caller, new_owner)460			.map_err(dispatch_to_evm::<T>)461	}462}463464fn check_is_owner_or_admin<T: Config>(465	caller: caller,466	collection: &CollectionHandle<T>,467) -> Result<T::CrossAccountId> {468	let caller = T::CrossAccountId::from_eth(caller);469	collection470		.check_is_owner_or_admin(&caller)471		.map_err(dispatch_to_evm::<T>)?;472	Ok(caller)473}474475fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {476	// TODO possibly delete for the lack of transaction477	collection.consume_store_writes(1)?;478	collection479		.check_is_internal()480		.map_err(dispatch_to_evm::<T>)?;481	collection.save().map_err(dispatch_to_evm::<T>)?;482	Ok(())483}484485/// Contains static property keys and values.486pub mod static_property {487	use evm_coder::{488		execution::{Result, Error},489	};490	use alloc::format;491492	const EXPECT_CONVERT_ERROR: &str = "length < limit";493494	/// Keys.495	pub mod key {496		use super::*;497498		/// Key "schemaName".499		pub fn schema_name() -> up_data_structs::PropertyKey {500			property_key_from_bytes(b"schemaName").expect(EXPECT_CONVERT_ERROR)501		}502503		/// Key "baseURI".504		pub fn base_uri() -> up_data_structs::PropertyKey {505			property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)506		}507508		/// Key "url".509		pub fn url() -> up_data_structs::PropertyKey {510			property_key_from_bytes(b"url").expect(EXPECT_CONVERT_ERROR)511		}512513		/// Key "suffix".514		pub fn suffix() -> up_data_structs::PropertyKey {515			property_key_from_bytes(b"suffix").expect(EXPECT_CONVERT_ERROR)516		}517518		/// Key "parentNft".519		pub fn parent_nft() -> up_data_structs::PropertyKey {520			property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)521		}522	}523524	/// Values.525	pub mod value {526		use super::*;527528		/// Value "ERC721Metadata".529		pub const ERC721_METADATA: &[u8] = b"ERC721Metadata";530531		/// Value for [`ERC721_METADATA`].532		pub fn erc721() -> up_data_structs::PropertyValue {533			property_value_from_bytes(ERC721_METADATA).expect(EXPECT_CONVERT_ERROR)534		}535	}536537	/// Convert `byte` to [`PropertyKey`].538	pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {539		bytes.to_vec().try_into().map_err(|_| {540			Error::Revert(format!(541				"Property key is too long. Max length is {}.",542				up_data_structs::PropertyKey::bound()543			))544		})545	}546547	/// Convert `bytes` to [`PropertyValue`].548	pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {549		bytes.to_vec().try_into().map_err(|_| {550			Error::Revert(format!(551				"Property key is too long. Max length is {}.",552				up_data_structs::PropertyKey::bound()553			))554		})555	}556}