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

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	Property, SponsoringRateLimit, OwnerRestrictedSet, AccessMode, CollectionPermissions,29};30use alloc::format;3132use crate::{Pallet, CollectionHandle, Config, CollectionProperties};3334/// Events for ethereum collection helper.35#[derive(ToLog)]36pub enum CollectionHelpersEvents {37	/// The collection has been created.38	CollectionCreated {39		/// Collection owner.40		#[indexed]41		owner: address,4243		/// Collection ID.44		#[indexed]45		collection_id: address,46	},47}4849/// Does not always represent a full collection, for RFT it is either50/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).51pub trait CommonEvmHandler {52	const CODE: &'static [u8];5354	/// Call precompiled handle.55	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;56}5758/// @title A contract that allows you to work with collections.59#[solidity_interface(name = "Collection")]60impl<T: Config> CollectionHandle<T>61where62	T::AccountId: From<[u8; 32]>,63{64	/// Set collection property.65	///66	/// @param key Property key.67	/// @param value Propery value.68	fn set_collection_property(69		&mut self,70		caller: caller,71		key: string,72		value: bytes,73	) -> Result<void> {74		let caller = T::CrossAccountId::from_eth(caller);75		let key = <Vec<u8>>::from(key)76			.try_into()77			.map_err(|_| "key too large")?;78		let value = value.try_into().map_err(|_| "value too large")?;7980		<Pallet<T>>::set_collection_property(self, &caller, Property { key, value })81			.map_err(dispatch_to_evm::<T>)82	}8384	/// Delete collection property.85	///86	/// @param key Property key.87	fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {88		let caller = T::CrossAccountId::from_eth(caller);89		let key = <Vec<u8>>::from(key)90			.try_into()91			.map_err(|_| "key too large")?;9293		<Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)94	}9596	/// Get collection property.97	///98	/// @dev Throws error if key not found.99	///100	/// @param key Property key.101	/// @return bytes The property corresponding to the key.102	fn collection_property(&self, key: string) -> Result<bytes> {103		let key = <Vec<u8>>::from(key)104			.try_into()105			.map_err(|_| "key too large")?;106107		let props = <CollectionProperties<T>>::get(self.id);108		let prop = props.get(&key).ok_or("key not found")?;109110		Ok(prop.to_vec())111	}112113	/// Set the sponsor of the collection.114	///115	/// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.116	///117	/// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.118	fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {119		check_is_owner_or_admin(caller, self)?;120121		let sponsor = T::CrossAccountId::from_eth(sponsor);122		self.set_sponsor(sponsor.as_sub().clone())123			.map_err(dispatch_to_evm::<T>)?;124		save(self)125	}126127	/// Collection sponsorship confirmation.128	///129	/// @dev After setting the sponsor for the collection, it must be confirmed with this function.130	fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {131		let caller = T::CrossAccountId::from_eth(caller);132		if !self133			.confirm_sponsorship(caller.as_sub())134			.map_err(dispatch_to_evm::<T>)?135		{136			return Err("caller is not set as sponsor".into());137		}138		save(self)139	}140141	/// Set limits for the collection.142	/// @dev Throws error if limit not found.143	/// @param limit Name of the limit. Valid names:144	/// 	"accountTokenOwnershipLimit",145	/// 	"sponsoredDataSize",146	/// 	"sponsoredDataRateLimit",147	/// 	"tokenLimit",148	/// 	"sponsorTransferTimeout",149	/// 	"sponsorApproveTimeout"150	/// @param value Value of the limit.151	#[solidity(rename_selector = "setCollectionLimit")]152	fn set_int_limit(&mut self, caller: caller, limit: string, value: uint32) -> Result<void> {153		check_is_owner_or_admin(caller, self)?;154		let mut limits = self.limits.clone();155156		match limit.as_str() {157			"accountTokenOwnershipLimit" => {158				limits.account_token_ownership_limit = Some(value);159			}160			"sponsoredDataSize" => {161				limits.sponsored_data_size = Some(value);162			}163			"sponsoredDataRateLimit" => {164				limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));165			}166			"tokenLimit" => {167				limits.token_limit = Some(value);168			}169			"sponsorTransferTimeout" => {170				limits.sponsor_transfer_timeout = Some(value);171			}172			"sponsorApproveTimeout" => {173				limits.sponsor_approve_timeout = Some(value);174			}175			_ => {176				return Err(Error::Revert(format!(177					"unknown integer limit \"{}\"",178					limit179				)))180			}181		}182		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)183			.map_err(dispatch_to_evm::<T>)?;184		save(self)185	}186187	/// Set limits for the collection.188	/// @dev Throws error if limit not found.189	/// @param limit Name of the limit. Valid names:190	/// 	"ownerCanTransfer",191	/// 	"ownerCanDestroy",192	/// 	"transfersEnabled"193	/// @param value Value of the limit.194	#[solidity(rename_selector = "setCollectionLimit")]195	fn set_bool_limit(&mut self, caller: caller, limit: string, value: bool) -> Result<void> {196		check_is_owner_or_admin(caller, self)?;197		let mut limits = self.limits.clone();198199		match limit.as_str() {200			"ownerCanTransfer" => {201				limits.owner_can_transfer = Some(value);202			}203			"ownerCanDestroy" => {204				limits.owner_can_destroy = Some(value);205			}206			"transfersEnabled" => {207				limits.transfers_enabled = Some(value);208			}209			_ => {210				return Err(Error::Revert(format!(211					"unknown boolean limit \"{}\"",212					limit213				)))214			}215		}216		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)217			.map_err(dispatch_to_evm::<T>)?;218		save(self)219	}220221	/// Get contract address.222	fn contract_address(&self, _caller: caller) -> Result<address> {223		Ok(crate::eth::collection_id_to_address(self.id))224	}225226	/// Add collection admin by substrate address.227	/// @param new_admin Substrate administrator address.228	fn add_collection_admin_substrate(229		&mut self,230		caller: caller,231		new_admin: uint256,232	) -> Result<void> {233		let caller = T::CrossAccountId::from_eth(caller);234		let mut new_admin_arr: [u8; 32] = Default::default();235		new_admin.to_big_endian(&mut new_admin_arr);236		let account_id = T::AccountId::from(new_admin_arr);237		let new_admin = T::CrossAccountId::from_sub(account_id);238		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;239		Ok(())240	}241242	/// Remove collection admin by substrate address.243	/// @param admin Substrate administrator address.244	fn remove_collection_admin_substrate(245		&mut self,246		caller: caller,247		admin: uint256,248	) -> Result<void> {249		let caller = T::CrossAccountId::from_eth(caller);250		let mut admin_arr: [u8; 32] = Default::default();251		admin.to_big_endian(&mut admin_arr);252		let account_id = T::AccountId::from(admin_arr);253		let admin = T::CrossAccountId::from_sub(account_id);254		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;255		Ok(())256	}257258	/// Add collection admin.259	/// @param new_admin Address of the added administrator.260	fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {261		let caller = T::CrossAccountId::from_eth(caller);262		let new_admin = T::CrossAccountId::from_eth(new_admin);263		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;264		Ok(())265	}266267	/// Remove collection admin.268	///269	/// @param new_admin Address of the removed administrator.270	fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {271		let caller = T::CrossAccountId::from_eth(caller);272		let admin = T::CrossAccountId::from_eth(admin);273		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;274		Ok(())275	}276277	/// Toggle accessibility of collection nesting.278	///279	/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'280	#[solidity(rename_selector = "setCollectionNesting")]281	fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {282		check_is_owner_or_admin(caller, self)?;283284		let mut permissions = self.collection.permissions.clone();285		let mut nesting = permissions.nesting().clone();286		nesting.token_owner = enable;287		nesting.restricted = None;288		permissions.nesting = Some(nesting);289290		self.collection.permissions = <Pallet<T>>::clamp_permissions(291			self.collection.mode.clone(),292			&self.collection.permissions,293			permissions,294		)295		.map_err(dispatch_to_evm::<T>)?;296297		save(self)298	}299300	/// Toggle accessibility of collection nesting.301	///302	/// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'303	/// @param collections Addresses of collections that will be available for nesting.304	#[solidity(rename_selector = "setCollectionNesting")]305	fn set_nesting(306		&mut self,307		caller: caller,308		enable: bool,309		collections: Vec<address>,310	) -> Result<void> {311		if collections.is_empty() {312			return Err("no addresses provided".into());313		}314		check_is_owner_or_admin(caller, self)?;315316		let mut permissions = self.collection.permissions.clone();317		match enable {318			false => {319				let mut nesting = permissions.nesting().clone();320				nesting.token_owner = false;321				nesting.restricted = None;322				permissions.nesting = Some(nesting);323			}324			true => {325				let mut bv = OwnerRestrictedSet::new();326				for i in collections {327					bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or(Error::Revert(328						"Can't convert address into collection id".into(),329					))?)330					.map_err(|_| "too many collections")?;331				}332				let mut nesting = permissions.nesting().clone();333				nesting.token_owner = true;334				nesting.restricted = Some(bv);335				permissions.nesting = Some(nesting);336			}337		};338339		self.collection.permissions = <Pallet<T>>::clamp_permissions(340			self.collection.mode.clone(),341			&self.collection.permissions,342			permissions,343		)344		.map_err(dispatch_to_evm::<T>)?;345346		save(self)347	}348349	/// Set the collection access method.350	/// @param mode Access mode351	/// 	0 for Normal352	/// 	1 for AllowList353	fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {354		check_is_owner_or_admin(caller, self)?;355		let permissions = CollectionPermissions {356			access: Some(match mode {357				0 => AccessMode::Normal,358				1 => AccessMode::AllowList,359				_ => return Err("not supported access mode".into()),360			}),361			..Default::default()362		};363		self.collection.permissions = <Pallet<T>>::clamp_permissions(364			self.collection.mode.clone(),365			&self.collection.permissions,366			permissions,367		)368		.map_err(dispatch_to_evm::<T>)?;369370		save(self)371	}372373	/// Add the user to the allowed list.374	///375	/// @param user Address of a trusted user.376	fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {377		let caller = T::CrossAccountId::from_eth(caller);378		let user = T::CrossAccountId::from_eth(user);379		<Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;380		Ok(())381	}382383	/// Remove the user from the allowed list.384	///385	/// @param user Address of a removed user.386	fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {387		let caller = T::CrossAccountId::from_eth(caller);388		let user = T::CrossAccountId::from_eth(user);389		<Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;390		Ok(())391	}392393	/// Switch permission for minting.394	///395	/// @param mode Enable if "true".396	fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {397		check_is_owner_or_admin(caller, self)?;398		let permissions = CollectionPermissions {399			mint_mode: Some(mode),400			..Default::default()401		};402		self.collection.permissions = <Pallet<T>>::clamp_permissions(403			self.collection.mode.clone(),404			&self.collection.permissions,405			permissions,406		)407		.map_err(dispatch_to_evm::<T>)?;408409		save(self)410	}411}412413fn check_is_owner_or_admin<T: Config>(414	caller: caller,415	collection: &CollectionHandle<T>,416) -> Result<T::CrossAccountId> {417	let caller = T::CrossAccountId::from_eth(caller);418	collection419		.check_is_owner_or_admin(&caller)420		.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;421	Ok(caller)422}423424fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {425	// TODO possibly delete for the lack of transaction426	collection427		.check_is_internal()428		.map_err(dispatch_to_evm::<T>)?;429	<crate::CollectionById<T>>::insert(collection.id, collection.collection.clone());430	Ok(())431}432433/// Contains static property keys and values.434pub mod static_property {435	use evm_coder::{436		execution::{Result, Error},437	};438	use alloc::format;439440	const EXPECT_CONVERT_ERROR: &str = "length < limit";441442	/// Keys.443	pub mod key {444		use super::*;445446		/// Key "schemaName".447		pub fn schema_name() -> up_data_structs::PropertyKey {448			property_key_from_bytes(b"schemaName").expect(EXPECT_CONVERT_ERROR)449		}450451		/// Key "baseURI".452		pub fn base_uri() -> up_data_structs::PropertyKey {453			property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)454		}455456		/// Key "url".457		pub fn url() -> up_data_structs::PropertyKey {458			property_key_from_bytes(b"url").expect(EXPECT_CONVERT_ERROR)459		}460461		/// Key "suffix".462		pub fn suffix() -> up_data_structs::PropertyKey {463			property_key_from_bytes(b"suffix").expect(EXPECT_CONVERT_ERROR)464		}465	}466467	/// Values.468	pub mod value {469		use super::*;470471		/// Value "ERC721Metadata".472		pub const ERC721_METADATA: &[u8] = b"ERC721Metadata";473474		/// Value for [`ERC721_METADATA`].475		pub fn erc721() -> up_data_structs::PropertyValue {476			property_value_from_bytes(ERC721_METADATA).expect(EXPECT_CONVERT_ERROR)477		}478	}479480	/// Convert `byte` to [`PropertyKey`].481	pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {482		bytes.to_vec().try_into().map_err(|_| {483			Error::Revert(format!(484				"Property key is too long. Max length is {}.",485				up_data_structs::PropertyKey::bound()486			))487		})488	}489490	/// Convert `bytes` to [`PropertyValue`].491	pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {492		bytes.to_vec().try_into().map_err(|_| {493			Error::Revert(format!(494				"Property key is too long. Max length is {}.",495				up_data_structs::PropertyKey::bound()496			))497		})498	}499}