git.delta.rocks / unique-network / refs/commits / 4cc1096094ca

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, SponsorshipState,30};31use alloc::format;3233use crate::{34	Pallet, CollectionHandle, Config, CollectionProperties,35	eth::{convert_cross_account_to_uint256, convert_uint256_to_cross_account},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]> + AsRef<[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	/// Set the substrate sponsor of the collection.132	///133	/// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.134	///135	/// @param sponsor Substrate address of the sponsor from whose account funds will be debited for operations with the contract.136	fn set_collection_sponsor_substrate(137		&mut self,138		caller: caller,139		sponsor: uint256,140	) -> Result<void> {141		check_is_owner_or_admin(caller, self)?;142143		let sponsor = convert_uint256_to_cross_account::<T>(sponsor);144		self.set_sponsor(sponsor.as_sub().clone())145			.map_err(dispatch_to_evm::<T>)?;146		save(self)147	}148149	// /// Whether there is a pending sponsor.150	fn has_collection_pending_sponsor(&self) -> Result<bool> {151		Ok(matches!(152			self.collection.sponsorship,153			SponsorshipState::Unconfirmed(_)154		))155	}156157	/// Collection sponsorship confirmation.158	///159	/// @dev After setting the sponsor for the collection, it must be confirmed with this function.160	fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {161		let caller = T::CrossAccountId::from_eth(caller);162		if !self163			.confirm_sponsorship(caller.as_sub())164			.map_err(dispatch_to_evm::<T>)?165		{166			return Err("caller is not set as sponsor".into());167		}168		save(self)169	}170171	/// Remove collection sponsor.172	fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {173		check_is_owner_or_admin(caller, self)?;174		self.remove_sponsor().map_err(dispatch_to_evm::<T>)?;175		save(self)176	}177178	/// Get current sponsor.179	///180	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.181	fn get_collection_sponsor(&self) -> Result<(address, uint256)> {182		let sponsor = match self.collection.sponsorship.sponsor() {183			Some(sponsor) => sponsor,184			None => return Ok(Default::default()),185		};186		let sponsor = T::CrossAccountId::from_sub(sponsor.clone());187		let result: (address, uint256) = if sponsor.is_canonical_substrate() {188			let sponsor = convert_cross_account_to_uint256::<T>(&sponsor);189			(Default::default(), sponsor)190		} else {191			let sponsor = *sponsor.as_eth();192			(sponsor, Default::default())193		};194		Ok(result)195	}196197	/// Set limits for the collection.198	/// @dev Throws error if limit not found.199	/// @param limit Name of the limit. Valid names:200	/// 	"accountTokenOwnershipLimit",201	/// 	"sponsoredDataSize",202	/// 	"sponsoredDataRateLimit",203	/// 	"tokenLimit",204	/// 	"sponsorTransferTimeout",205	/// 	"sponsorApproveTimeout"206	/// @param value Value of the limit.207	#[solidity(rename_selector = "setCollectionLimit")]208	fn set_int_limit(&mut self, caller: caller, limit: string, value: uint32) -> Result<void> {209		check_is_owner_or_admin(caller, self)?;210		let mut limits = self.limits.clone();211212		match limit.as_str() {213			"accountTokenOwnershipLimit" => {214				limits.account_token_ownership_limit = Some(value);215			}216			"sponsoredDataSize" => {217				limits.sponsored_data_size = Some(value);218			}219			"sponsoredDataRateLimit" => {220				limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));221			}222			"tokenLimit" => {223				limits.token_limit = Some(value);224			}225			"sponsorTransferTimeout" => {226				limits.sponsor_transfer_timeout = Some(value);227			}228			"sponsorApproveTimeout" => {229				limits.sponsor_approve_timeout = Some(value);230			}231			_ => {232				return Err(Error::Revert(format!(233					"unknown integer limit \"{}\"",234					limit235				)))236			}237		}238		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)239			.map_err(dispatch_to_evm::<T>)?;240		save(self)241	}242243	/// Set limits for the collection.244	/// @dev Throws error if limit not found.245	/// @param limit Name of the limit. Valid names:246	/// 	"ownerCanTransfer",247	/// 	"ownerCanDestroy",248	/// 	"transfersEnabled"249	/// @param value Value of the limit.250	#[solidity(rename_selector = "setCollectionLimit")]251	fn set_bool_limit(&mut self, caller: caller, limit: string, value: bool) -> Result<void> {252		check_is_owner_or_admin(caller, self)?;253		let mut limits = self.limits.clone();254255		match limit.as_str() {256			"ownerCanTransfer" => {257				limits.owner_can_transfer = Some(value);258			}259			"ownerCanDestroy" => {260				limits.owner_can_destroy = Some(value);261			}262			"transfersEnabled" => {263				limits.transfers_enabled = Some(value);264			}265			_ => {266				return Err(Error::Revert(format!(267					"unknown boolean limit \"{}\"",268					limit269				)))270			}271		}272		self.limits = <Pallet<T>>::clamp_limits(self.mode.clone(), &self.limits, limits)273			.map_err(dispatch_to_evm::<T>)?;274		save(self)275	}276277	/// Get contract address.278	fn contract_address(&self, _caller: caller) -> Result<address> {279		Ok(crate::eth::collection_id_to_address(self.id))280	}281282	/// Add collection admin by substrate address.283	/// @param newAdmin Substrate administrator address.284	fn add_collection_admin_substrate(285		&mut self,286		caller: caller,287		new_admin: uint256,288	) -> Result<void> {289		let caller = T::CrossAccountId::from_eth(caller);290		let new_admin = convert_uint256_to_cross_account::<T>(new_admin);291		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;292		Ok(())293	}294295	/// Remove collection admin by substrate address.296	/// @param admin Substrate administrator address.297	fn remove_collection_admin_substrate(298		&mut self,299		caller: caller,300		admin: uint256,301	) -> Result<void> {302		let caller = T::CrossAccountId::from_eth(caller);303		let admin = convert_uint256_to_cross_account::<T>(admin);304		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;305		Ok(())306	}307308	/// Add collection admin.309	/// @param newAdmin Address of the added administrator.310	fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {311		let caller = T::CrossAccountId::from_eth(caller);312		let new_admin = T::CrossAccountId::from_eth(new_admin);313		<Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;314		Ok(())315	}316317	/// Remove collection admin.318	///319	/// @param admin Address of the removed administrator.320	fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {321		let caller = T::CrossAccountId::from_eth(caller);322		let admin = T::CrossAccountId::from_eth(admin);323		<Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;324		Ok(())325	}326327	/// Toggle accessibility of collection nesting.328	///329	/// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'330	#[solidity(rename_selector = "setCollectionNesting")]331	fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {332		check_is_owner_or_admin(caller, self)?;333334		let mut permissions = self.collection.permissions.clone();335		let mut nesting = permissions.nesting().clone();336		nesting.token_owner = enable;337		nesting.restricted = None;338		permissions.nesting = Some(nesting);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	/// Toggle accessibility of collection nesting.351	///352	/// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'353	/// @param collections Addresses of collections that will be available for nesting.354	#[solidity(rename_selector = "setCollectionNesting")]355	fn set_nesting(356		&mut self,357		caller: caller,358		enable: bool,359		collections: Vec<address>,360	) -> Result<void> {361		if collections.is_empty() {362			return Err("no addresses provided".into());363		}364		check_is_owner_or_admin(caller, self)?;365366		let mut permissions = self.collection.permissions.clone();367		match enable {368			false => {369				let mut nesting = permissions.nesting().clone();370				nesting.token_owner = false;371				nesting.restricted = None;372				permissions.nesting = Some(nesting);373			}374			true => {375				let mut bv = OwnerRestrictedSet::new();376				for i in collections {377					bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or(Error::Revert(378						"Can't convert address into collection id".into(),379					))?)380					.map_err(|_| "too many collections")?;381				}382				let mut nesting = permissions.nesting().clone();383				nesting.token_owner = true;384				nesting.restricted = Some(bv);385				permissions.nesting = Some(nesting);386			}387		};388389		self.collection.permissions = <Pallet<T>>::clamp_permissions(390			self.collection.mode.clone(),391			&self.collection.permissions,392			permissions,393		)394		.map_err(dispatch_to_evm::<T>)?;395396		save(self)397	}398399	/// Set the collection access method.400	/// @param mode Access mode401	/// 	0 for Normal402	/// 	1 for AllowList403	fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {404		check_is_owner_or_admin(caller, self)?;405		let permissions = CollectionPermissions {406			access: Some(match mode {407				0 => AccessMode::Normal,408				1 => AccessMode::AllowList,409				_ => return Err("not supported access mode".into()),410			}),411			..Default::default()412		};413		self.collection.permissions = <Pallet<T>>::clamp_permissions(414			self.collection.mode.clone(),415			&self.collection.permissions,416			permissions,417		)418		.map_err(dispatch_to_evm::<T>)?;419420		save(self)421	}422423	/// Add the user to the allowed list.424	///425	/// @param user Address of a trusted user.426	fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {427		let caller = T::CrossAccountId::from_eth(caller);428		let user = T::CrossAccountId::from_eth(user);429		<Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;430		Ok(())431	}432433	/// Remove the user from the allowed list.434	///435	/// @param user Address of a removed user.436	fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {437		let caller = T::CrossAccountId::from_eth(caller);438		let user = T::CrossAccountId::from_eth(user);439		<Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;440		Ok(())441	}442443	/// Switch permission for minting.444	///445	/// @param mode Enable if "true".446	fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {447		check_is_owner_or_admin(caller, self)?;448		let permissions = CollectionPermissions {449			mint_mode: Some(mode),450			..Default::default()451		};452		self.collection.permissions = <Pallet<T>>::clamp_permissions(453			self.collection.mode.clone(),454			&self.collection.permissions,455			permissions,456		)457		.map_err(dispatch_to_evm::<T>)?;458459		save(self)460	}461462	/// Check that account is the owner or admin of the collection463	///464	/// @param user account to verify465	/// @return "true" if account is the owner or admin466	#[solidity(rename_selector = "isOwnerOrAdmin")]467	fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {468		let user = T::CrossAccountId::from_eth(user);469		Ok(self.is_owner_or_admin(&user))470	}471472	/// Check that substrate account is the owner or admin of the collection473	///474	/// @param user account to verify475	/// @return "true" if account is the owner or admin476	fn is_owner_or_admin_substrate(&self, user: uint256) -> Result<bool> {477		let user = convert_uint256_to_cross_account::<T>(user);478		Ok(self.is_owner_or_admin(&user))479	}480481	/// Returns collection type482	///483	/// @return `Fungible` or `NFT` or `ReFungible`484	fn unique_collection_type(&mut self) -> Result<string> {485		let mode = match self.collection.mode {486			CollectionMode::Fungible(_) => "Fungible",487			CollectionMode::NFT => "NFT",488			CollectionMode::ReFungible => "ReFungible",489		};490		Ok(mode.into())491	}492493	/// Changes collection owner to another account494	///495	/// @dev Owner can be changed only by current owner496	/// @param newOwner new owner account497	fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {498		let caller = T::CrossAccountId::from_eth(caller);499		let new_owner = T::CrossAccountId::from_eth(new_owner);500		self.set_owner_internal(caller, new_owner)501			.map_err(dispatch_to_evm::<T>)502	}503504	/// Changes collection owner to another substrate account505	///506	/// @dev Owner can be changed only by current owner507	/// @param newOwner new owner substrate account508	fn set_owner_substrate(&mut self, caller: caller, new_owner: uint256) -> Result<void> {509		let caller = T::CrossAccountId::from_eth(caller);510		let new_owner = convert_uint256_to_cross_account::<T>(new_owner);511		self.set_owner_internal(caller, new_owner)512			.map_err(dispatch_to_evm::<T>)513	}514}515516fn check_is_owner_or_admin<T: Config>(517	caller: caller,518	collection: &CollectionHandle<T>,519) -> Result<T::CrossAccountId> {520	let caller = T::CrossAccountId::from_eth(caller);521	collection522		.check_is_owner_or_admin(&caller)523		.map_err(dispatch_to_evm::<T>)?;524	Ok(caller)525}526527fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {528	// TODO possibly delete for the lack of transaction529	collection.consume_store_writes(1)?;530	collection531		.check_is_internal()532		.map_err(dispatch_to_evm::<T>)?;533	collection.save().map_err(dispatch_to_evm::<T>)?;534	Ok(())535}536537/// Contains static property keys and values.538pub mod static_property {539	use evm_coder::{540		execution::{Result, Error},541	};542	use alloc::format;543544	const EXPECT_CONVERT_ERROR: &str = "length < limit";545546	/// Keys.547	pub mod key {548		use super::*;549550		/// Key "schemaName".551		pub fn schema_name() -> up_data_structs::PropertyKey {552			property_key_from_bytes(b"schemaName").expect(EXPECT_CONVERT_ERROR)553		}554555		/// Key "baseURI".556		pub fn base_uri() -> up_data_structs::PropertyKey {557			property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)558		}559560		/// Key "url".561		pub fn url() -> up_data_structs::PropertyKey {562			property_key_from_bytes(b"url").expect(EXPECT_CONVERT_ERROR)563		}564565		/// Key "suffix".566		pub fn suffix() -> up_data_structs::PropertyKey {567			property_key_from_bytes(b"suffix").expect(EXPECT_CONVERT_ERROR)568		}569570		/// Key "parentNft".571		pub fn parent_nft() -> up_data_structs::PropertyKey {572			property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)573		}574	}575576	/// Values.577	pub mod value {578		use super::*;579580		/// Value "ERC721Metadata".581		pub const ERC721_METADATA: &[u8] = b"ERC721Metadata";582583		/// Value for [`ERC721_METADATA`].584		pub fn erc721() -> up_data_structs::PropertyValue {585			property_value_from_bytes(ERC721_METADATA).expect(EXPECT_CONVERT_ERROR)586		}587	}588589	/// Convert `byte` to [`PropertyKey`].590	pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {591		bytes.to_vec().try_into().map_err(|_| {592			Error::Revert(format!(593				"Property key is too long. Max length is {}.",594				up_data_structs::PropertyKey::bound()595			))596		})597	}598599	/// Convert `bytes` to [`PropertyValue`].600	pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {601		bytes.to_vec().try_into().map_err(|_| {602			Error::Revert(format!(603				"Property key is too long. Max length is {}.",604				up_data_structs::PropertyKey::bound()605			))606		})607	}608}