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

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::{Pallet, CollectionHandle, Config, CollectionProperties};3435/// Events for ethereum collection helper.36#[derive(ToLog)]37pub enum CollectionHelpersEvents {38	/// The collection has been created.39	CollectionCreated {40		/// Collection owner.41		#[indexed]42		owner: address,4344		/// Collection ID.45		#[indexed]46		collection_id: address,47	},48}4950/// Does not always represent a full collection, for RFT it is either51/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).52pub trait CommonEvmHandler {53	const CODE: &'static [u8];5455	/// Call precompiled handle.56	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;57}5859/// @title A contract that allows you to work with collections.60#[solidity_interface(name = "Collection")]61impl<T: Config> CollectionHandle<T>62where63	T::AccountId: From<[u8; 32]>,64{65	/// Set collection property.66	///67	/// @param key Property key.68	/// @param value Propery value.69	fn set_collection_property(70		&mut self,71		caller: caller,72		key: string,73		value: bytes,74	) -> Result<void> {75		let caller = T::CrossAccountId::from_eth(caller);76		let key = <Vec<u8>>::from(key)77			.try_into()78			.map_err(|_| "key too large")?;79		let value = value.try_into().map_err(|_| "value too large")?;8081		<Pallet<T>>::set_collection_property(self, &caller, Property { key, value })82			.map_err(dispatch_to_evm::<T>)83	}8485	/// Delete collection property.86	///87	/// @param key Property key.88	fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {89		let caller = T::CrossAccountId::from_eth(caller);90		let key = <Vec<u8>>::from(key)91			.try_into()92			.map_err(|_| "key too large")?;9394		<Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)95	}9697	/// Get collection property.98	///99	/// @dev Throws error if key not found.100	///101	/// @param key Property key.102	/// @return bytes The property corresponding to the key.103	fn collection_property(&self, key: string) -> Result<bytes> {104		let key = <Vec<u8>>::from(key)105			.try_into()106			.map_err(|_| "key too large")?;107108		let props = <CollectionProperties<T>>::get(self.id);109		let prop = props.get(&key).ok_or("key not found")?;110111		Ok(prop.to_vec())112	}113114	/// Set the sponsor of the collection.115	///116	/// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.117	///118	/// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.119	fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {120		check_is_owner_or_admin(caller, self)?;121122		let sponsor = T::CrossAccountId::from_eth(sponsor);123		self.set_sponsor(sponsor.as_sub().clone())124			.map_err(dispatch_to_evm::<T>)?;125		save(self)126	}127128	/// Collection sponsorship confirmation.129	///130	/// @dev After setting the sponsor for the collection, it must be confirmed with this function.131	fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {132		let caller = T::CrossAccountId::from_eth(caller);133		if !self134			.confirm_sponsorship(caller.as_sub())135			.map_err(dispatch_to_evm::<T>)?136		{137			return Err("caller is not set as sponsor".into());138		}139		save(self)140	}141142	/// Set limits for the collection.143	/// @dev Throws error if limit not found.144	/// @param limit Name of the limit. Valid names:145	/// 	"accountTokenOwnershipLimit",146	/// 	"sponsoredDataSize",147	/// 	"sponsoredDataRateLimit",148	/// 	"tokenLimit",149	/// 	"sponsorTransferTimeout",150	/// 	"sponsorApproveTimeout"151	/// @param value Value of the limit.152	#[solidity(rename_selector = "setCollectionLimit")]153	fn set_int_limit(&mut self, caller: caller, limit: string, value: uint32) -> Result<void> {154		check_is_owner_or_admin(caller, self)?;155		let mut limits = self.limits.clone();156157		match limit.as_str() {158			"accountTokenOwnershipLimit" => {159				limits.account_token_ownership_limit = Some(value);160			}161			"sponsoredDataSize" => {162				limits.sponsored_data_size = Some(value);163			}164			"sponsoredDataRateLimit" => {165				limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));166			}167			"tokenLimit" => {168				limits.token_limit = Some(value);169			}170			"sponsorTransferTimeout" => {171				limits.sponsor_transfer_timeout = Some(value);172			}173			"sponsorApproveTimeout" => {174				limits.sponsor_approve_timeout = Some(value);175			}176			_ => {177				return Err(Error::Revert(format!(178					"unknown integer limit \"{}\"",179					limit180				)))181			}182		}183		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)184			.map_err(dispatch_to_evm::<T>)?;185		save(self)186	}187188	/// Set limits for the collection.189	/// @dev Throws error if limit not found.190	/// @param limit Name of the limit. Valid names:191	/// 	"ownerCanTransfer",192	/// 	"ownerCanDestroy",193	/// 	"transfersEnabled"194	/// @param value Value of the limit.195	#[solidity(rename_selector = "setCollectionLimit")]196	fn set_bool_limit(&mut self, caller: caller, limit: string, value: bool) -> Result<void> {197		check_is_owner_or_admin(caller, self)?;198		let mut limits = self.limits.clone();199200		match limit.as_str() {201			"ownerCanTransfer" => {202				limits.owner_can_transfer = Some(value);203			}204			"ownerCanDestroy" => {205				limits.owner_can_destroy = Some(value);206			}207			"transfersEnabled" => {208				limits.transfers_enabled = Some(value);209			}210			_ => {211				return Err(Error::Revert(format!(212					"unknown boolean limit \"{}\"",213					limit214				)))215			}216		}217		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)218			.map_err(dispatch_to_evm::<T>)?;219		save(self)220	}221222	/// Get contract address.223	fn contract_address(&self, _caller: caller) -> Result<address> {224		Ok(crate::eth::collection_id_to_address(self.id))225	}226227	/// Add collection admin by substrate address.228	/// @param new_admin Substrate administrator address.229	fn add_collection_admin_substrate(230		&mut self,231		caller: caller,232		new_admin: uint256,233	) -> Result<void> {234		let caller = T::CrossAccountId::from_eth(caller);235		let mut new_admin_arr: [u8; 32] = Default::default();236		new_admin.to_big_endian(&mut new_admin_arr);237		let account_id = T::AccountId::from(new_admin_arr);238		let new_admin = T::CrossAccountId::from_sub(account_id);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 mut admin_arr: [u8; 32] = Default::default();252		admin.to_big_endian(&mut admin_arr);253		let account_id = T::AccountId::from(admin_arr);254		let admin = T::CrossAccountId::from_sub(account_id);255		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;256		Ok(())257	}258259	/// Add collection admin.260	/// @param new_admin Address of the added administrator.261	fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {262		let caller = T::CrossAccountId::from_eth(caller);263		let new_admin = T::CrossAccountId::from_eth(new_admin);264		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;265		Ok(())266	}267268	/// Remove collection admin.269	///270	/// @param new_admin Address of the removed administrator.271	fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {272		let caller = T::CrossAccountId::from_eth(caller);273		let admin = T::CrossAccountId::from_eth(admin);274		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;275		Ok(())276	}277278	/// Toggle accessibility of collection nesting.279	///280	/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'281	#[solidity(rename_selector = "setCollectionNesting")]282	fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {283		check_is_owner_or_admin(caller, self)?;284285		let mut permissions = self.collection.permissions.clone();286		let mut nesting = permissions.nesting().clone();287		nesting.token_owner = enable;288		nesting.restricted = None;289		permissions.nesting = Some(nesting);290291		self.collection.permissions = <Pallet<T>>::clamp_permissions(292			self.collection.mode.clone(),293			&self.collection.permissions,294			permissions,295		)296		.map_err(dispatch_to_evm::<T>)?;297298		save(self)299	}300301	/// Toggle accessibility of collection nesting.302	///303	/// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'304	/// @param collections Addresses of collections that will be available for nesting.305	#[solidity(rename_selector = "setCollectionNesting")]306	fn set_nesting(307		&mut self,308		caller: caller,309		enable: bool,310		collections: Vec<address>,311	) -> Result<void> {312		if collections.is_empty() {313			return Err("no addresses provided".into());314		}315		check_is_owner_or_admin(caller, self)?;316317		let mut permissions = self.collection.permissions.clone();318		match enable {319			false => {320				let mut nesting = permissions.nesting().clone();321				nesting.token_owner = false;322				nesting.restricted = None;323				permissions.nesting = Some(nesting);324			}325			true => {326				let mut bv = OwnerRestrictedSet::new();327				for i in collections {328					bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or(Error::Revert(329						"Can't convert address into collection id".into(),330					))?)331					.map_err(|_| "too many collections")?;332				}333				let mut nesting = permissions.nesting().clone();334				nesting.token_owner = true;335				nesting.restricted = Some(bv);336				permissions.nesting = Some(nesting);337			}338		};339340		self.collection.permissions = <Pallet<T>>::clamp_permissions(341			self.collection.mode.clone(),342			&self.collection.permissions,343			permissions,344		)345		.map_err(dispatch_to_evm::<T>)?;346347		save(self)348	}349350	/// Set the collection access method.351	/// @param mode Access mode352	/// 	0 for Normal353	/// 	1 for AllowList354	fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {355		check_is_owner_or_admin(caller, self)?;356		let permissions = CollectionPermissions {357			access: Some(match mode {358				0 => AccessMode::Normal,359				1 => AccessMode::AllowList,360				_ => return Err("not supported access mode".into()),361			}),362			..Default::default()363		};364		self.collection.permissions = <Pallet<T>>::clamp_permissions(365			self.collection.mode.clone(),366			&self.collection.permissions,367			permissions,368		)369		.map_err(dispatch_to_evm::<T>)?;370371		save(self)372	}373374	/// Add the user to the allowed list.375	///376	/// @param user Address of a trusted user.377	fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {378		let caller = T::CrossAccountId::from_eth(caller);379		let user = T::CrossAccountId::from_eth(user);380		<Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;381		Ok(())382	}383384	/// Remove the user from the allowed list.385	///386	/// @param user Address of a removed user.387	fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {388		let caller = T::CrossAccountId::from_eth(caller);389		let user = T::CrossAccountId::from_eth(user);390		<Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;391		Ok(())392	}393394	/// Switch permission for minting.395	///396	/// @param mode Enable if "true".397	fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {398		check_is_owner_or_admin(caller, self)?;399		let permissions = CollectionPermissions {400			mint_mode: Some(mode),401			..Default::default()402		};403		self.collection.permissions = <Pallet<T>>::clamp_permissions(404			self.collection.mode.clone(),405			&self.collection.permissions,406			permissions,407		)408		.map_err(dispatch_to_evm::<T>)?;409410		save(self)411	}412413	/// Check that account is the owner or admin of the collection414	///415	/// @param user account to verify416	/// @return "true" if account is the owner or admin417	fn verify_owner_or_admin(&self, user: address) -> Result<bool> {418		Ok(check_is_owner_or_admin(user, self)419			.map(|_| true)420			.unwrap_or(false))421	}422423	/// Returns collection type424	///425	/// @return `Fungible` or `NFT` or `ReFungible`426	fn unique_collection_type(&mut self) -> Result<string> {427		let mode = match self.collection.mode {428			CollectionMode::Fungible(_) => "Fungible",429			CollectionMode::NFT => "NFT",430			CollectionMode::ReFungible => "ReFungible",431		};432		Ok(mode.into())433	}434435	/// Changes collection owner436	///437	/// @dev Owner can be changed only by current owner438	/// @param newOwner new owner439	fn change_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {440		let caller = T::CrossAccountId::from_eth(caller);441		let new_owner = T::CrossAccountId::from_eth(new_owner);442		self.change_owner_internal(caller, new_owner)443	}444445impl<T: Config> CollectionHandle<T>446where447	T::AccountId: From<[u8; 32]>,448{449450	fn change_owner_internal(&mut self, caller: T::CrossAccountId, new_owner: T::CrossAccountId) -> Result<void> {451		self.check_is_owner(&caller).map_err(dispatch_to_evm::<T>)?;452		self.collection.owner = new_owner.as_sub().clone();453		save(self)454	}455}456457fn check_is_owner_or_admin<T: Config>(458	caller: caller,459	collection: &CollectionHandle<T>,460) -> Result<T::CrossAccountId> {461	let caller = T::CrossAccountId::from_eth(caller);462	collection463		.check_is_owner_or_admin(&caller)464		.map_err(dispatch_to_evm::<T>)?;465	Ok(caller)466}467468fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {469	// TODO possibly delete for the lack of transaction470	collection.consume_store_writes(1)?;471	collection472		.check_is_internal()473		.map_err(dispatch_to_evm::<T>)?;474	<crate::CollectionById<T>>::insert(collection.id, collection.collection.clone());475	Ok(())476}477478/// Contains static property keys and values.479pub mod static_property {480	use evm_coder::{481		execution::{Result, Error},482	};483	use alloc::format;484485	const EXPECT_CONVERT_ERROR: &str = "length < limit";486487	/// Keys.488	pub mod key {489		use super::*;490491		/// Key "schemaName".492		pub fn schema_name() -> up_data_structs::PropertyKey {493			property_key_from_bytes(b"schemaName").expect(EXPECT_CONVERT_ERROR)494		}495496		/// Key "baseURI".497		pub fn base_uri() -> up_data_structs::PropertyKey {498			property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)499		}500501		/// Key "url".502		pub fn url() -> up_data_structs::PropertyKey {503			property_key_from_bytes(b"url").expect(EXPECT_CONVERT_ERROR)504		}505506		/// Key "suffix".507		pub fn suffix() -> up_data_structs::PropertyKey {508			property_key_from_bytes(b"suffix").expect(EXPECT_CONVERT_ERROR)509		}510511		/// Key "parentNft".512		pub fn parent_nft() -> up_data_structs::PropertyKey {513			property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)514		}515	}516517	/// Values.518	pub mod value {519		use super::*;520521		/// Value "ERC721Metadata".522		pub const ERC721_METADATA: &[u8] = b"ERC721Metadata";523524		/// Value for [`ERC721_METADATA`].525		pub fn erc721() -> up_data_structs::PropertyValue {526			property_value_from_bytes(ERC721_METADATA).expect(EXPECT_CONVERT_ERROR)527		}528	}529530	/// Convert `byte` to [`PropertyKey`].531	pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {532		bytes.to_vec().try_into().map_err(|_| {533			Error::Revert(format!(534				"Property key is too long. Max length is {}.",535				up_data_structs::PropertyKey::bound()536			))537		})538	}539540	/// Convert `bytes` to [`PropertyValue`].541	pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {542		bytes.to_vec().try_into().map_err(|_| {543			Error::Revert(format!(544				"Property key is too long. Max length is {}.",545				up_data_structs::PropertyKey::bound()546			))547		})548	}549}