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

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//! Implementation of CollectionHelpers contract.1819use core::marker::PhantomData;20use ethereum as _;21use evm_coder::{execution::*, generate_stubgen, solidity, solidity_interface, types::*, weight};22use frame_support::traits::Get;2324use crate::Pallet;2526use pallet_common::{27	CollectionById,28	dispatch::CollectionDispatch,29	erc::{30		static_property::key,31		CollectionHelpersEvents,32	},33	Pallet as PalletCommon,34	35};36use pallet_evm::{account::CrossAccountId, OnMethodCall, PrecompileHandle, PrecompileResult};37use pallet_evm_coder_substrate::{dispatch_to_evm, SubstrateRecorder, WithRecorder};38use sp_std::vec;39use up_data_structs::{40	CollectionDescription, CollectionMode, CollectionName, CollectionTokenPrefix,41	CreateCollectionData, PropertyValue,42};4344use crate::{weights::WeightInfo, Config, SelfWeightOf};4546use alloc::format;47use sp_std::vec::Vec;4849/// See [`CollectionHelpersCall`]50pub struct EvmCollectionHelpers<T: Config>(SubstrateRecorder<T>);51impl<T: Config> WithRecorder<T> for EvmCollectionHelpers<T> {52	fn recorder(&self) -> &SubstrateRecorder<T> {53		&self.054	}5556	fn into_recorder(self) -> SubstrateRecorder<T> {57		self.058	}59}6061fn convert_data<T: Config>(62	caller: caller,63	name: string,64	description: string,65	token_prefix: string,66) -> Result<(67	T::CrossAccountId,68	CollectionName,69	CollectionDescription,70	CollectionTokenPrefix,71)> {72	let caller = T::CrossAccountId::from_eth(caller);73	let name = name74		.encode_utf16()75		.collect::<Vec<u16>>()76		.try_into()77		.map_err(|_| error_field_too_long(stringify!(name), CollectionName::bound()))?;78	let description = description79		.encode_utf16()80		.collect::<Vec<u16>>()81		.try_into()82		.map_err(|_| {83			error_field_too_long(stringify!(description), CollectionDescription::bound())84		})?;85	let token_prefix = token_prefix.into_bytes().try_into().map_err(|_| {86		error_field_too_long(stringify!(token_prefix), CollectionTokenPrefix::bound())87	})?;88	Ok((caller, name, description, token_prefix))89}9091fn create_refungible_collection_internal<T: Config>(92	caller: caller,93	value: value,94	name: string,95	description: string,96	token_prefix: string,97) -> Result<address> {98	self::create_collection_internal::<T>(99		caller,100		value,101		name,102		CollectionMode::ReFungible,103		description,104		token_prefix105	)106}107108#[inline(always)]109fn create_collection_internal<T: Config>(110	caller: caller,111	value: value,112	name: string,113	collection_mode: CollectionMode,114	description: string,115	token_prefix: string,116) -> Result<address> {117	let (caller, name, description, token_prefix) =118		convert_data::<T>(caller, name, description, token_prefix)?;119	let data = CreateCollectionData {120		name,121		mode: collection_mode,122		description,123		token_prefix,124		..Default::default()125	};126	check_sent_amount_equals_collection_creation_price::<T>(value)?;127	let collection_helpers_address =128		T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());129130	let collection_id = T::CollectionDispatch::create(131		caller.clone(),132		collection_helpers_address,133		data,134		Default::default(),135	)136	.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;137	let address = pallet_common::eth::collection_id_to_address(collection_id);138	Ok(address)139}140141fn check_sent_amount_equals_collection_creation_price<T: Config>(value: value) -> Result<()> {142	let value = value.as_u128();143	let creation_price: u128 = T::CollectionCreationPrice::get()144		.try_into()145		.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait146		.expect("Collection creation price should be convertible to u128");147	if value != creation_price {148		return Err(format!(149			"Sent amount not equals to collection creation price ({0})",150			creation_price151		)152		.into());153	}154	Ok(())155}156157/// @title Contract, which allows users to operate with collections158#[solidity_interface(name = CollectionHelpers, events(CollectionHelpersEvents))]159impl<T> EvmCollectionHelpers<T>160where161	T: Config + pallet_common::Config + pallet_nonfungible::Config + pallet_refungible::Config,162{163	/// Create an NFT collection164	/// @param name Name of the collection165	/// @param description Informative description of the collection166	/// @param tokenPrefix Token prefix to represent the collection tokens in UI and user applications167	/// @return address Address of the newly created collection168	#[weight(<SelfWeightOf<T>>::create_collection())]169	#[solidity(rename_selector = "createNFTCollection")]170	fn create_nft_collection(171		&mut self,172		caller: caller,173		value: value,174		name: string,175		description: string,176		token_prefix: string,177	) -> Result<address> {178		let (caller, name, description, token_prefix) =179			convert_data::<T>(caller, name, description, token_prefix)?;180		let data = CreateCollectionData {181			name,182			mode: CollectionMode::NFT,183			description,184			token_prefix,185			..Default::default()186		};187		check_sent_amount_equals_collection_creation_price::<T>(value)?;188		let collection_helpers_address =189			T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());190		let collection_id = T::CollectionDispatch::create(191			caller,192			collection_helpers_address,193			data,194			Default::default(),195		)196		.map_err(dispatch_to_evm::<T>)?;197198		let address = pallet_common::eth::collection_id_to_address(collection_id);199		Ok(address)200	}201	/// Create an NFT collection202	/// @param name Name of the collection203	/// @param description Informative description of the collection204	/// @param tokenPrefix Token prefix to represent the collection tokens in UI and user applications205	/// @return address Address of the newly created collection206	#[weight(<SelfWeightOf<T>>::create_collection())]207	#[deprecated(note = "mathod was renamed to `create_nft_collection`, prefer it instead")]208	#[solidity(hide)]209	fn create_nonfungible_collection(210		&mut self,211		caller: caller,212		value: value,213		name: string,214		description: string,215		token_prefix: string,216	) -> Result<address> {217		create_collection_internal::<T>(218			caller,219			value,220			name,221			CollectionMode::NFT,222			description,223			token_prefix,224		)225	}226227	#[weight(<SelfWeightOf<T>>::create_collection())]228	#[solidity(rename_selector = "createRFTCollection")]229	fn create_rft_collection(230		&mut self,231		caller: caller,232		value: value,233		name: string,234		description: string,235		token_prefix: string,236	) -> Result<address> {237		create_collection_internal::<T>(238			caller,239			value,240			name,241			CollectionMode::ReFungible,242			description,243			token_prefix,244		)245	}246247	#[weight(<SelfWeightOf<T>>::create_collection())]248	#[solidity(rename_selector = "createERC721MetadataCompatibleRFTCollection")]249	fn create_refungible_collection_with_properties(250		&mut self,251		caller: caller,252		value: value,253		name: string,254		description: string,255		token_prefix: string,256		base_uri: string,257	) -> Result<address> {258		create_collection_internal::<T>(259			caller,260			value,261			name,262			CollectionMode::ReFungible,263			description,264			token_prefix,265		)266	}267268	#[weight(<SelfWeightOf<T>>::create_collection())]269	#[solidity(rename_selector = "createFTCollection")]270	fn create_fungible_collection(271		&mut self,272		caller: caller,273		value: value,274		name: string,275		decimals: uint8,276		description: string,277		token_prefix: string,278	) -> Result<address> {279		create_collection_internal::<T>(280			caller,281			value,282			name,283			CollectionMode::Fungible(decimals),284			description,285			token_prefix,286		)287	}288289	#[solidity(rename_selector = "makeCollectionERC721MetadataCompatible")]290	fn make_collection_metadata_compatible(291		&mut self,292		caller: caller,293		collection: address,294		base_uri: string,295	) -> Result<()> {296		let caller = T::CrossAccountId::from_eth(caller);297		let collection =298			pallet_common::eth::map_eth_to_id(&collection).ok_or("not a collection address")?;299		let mut collection =300			<crate::CollectionHandle<T>>::new(collection).ok_or("collection not found")?;301302		if !matches!(303			collection.mode,304			CollectionMode::NFT | CollectionMode::ReFungible305		) {306			return Err("target collection should be either NFT or Refungible".into());307		}308309		self.recorder().consume_sstore()?;310		collection311			.check_is_owner_or_admin(&caller)312			.map_err(dispatch_to_evm::<T>)?;313314		if collection.flags.erc721metadata {315			return Err("target collection is already Erc721Metadata compatible".into());316		}317		collection.flags.erc721metadata = true;318319		let all_permissions = <pallet_common::CollectionPropertyPermissions<T>>::get(collection.id);320		if all_permissions.get(&key::url()).is_none() {321			self.recorder().consume_sstore()?;322			<PalletCommon<T>>::set_property_permission(323				&collection,324				&caller,325				up_data_structs::PropertyKeyPermission {326					key: key::url(),327					permission: up_data_structs::PropertyPermission {328						mutable: true,329						collection_admin: true,330						token_owner: false,331					},332				},333			)334			.map_err(dispatch_to_evm::<T>)?;335		}336		if all_permissions.get(&key::suffix()).is_none() {337			self.recorder().consume_sstore()?;338			<PalletCommon<T>>::set_property_permission(339				&collection,340				&caller,341				up_data_structs::PropertyKeyPermission {342					key: key::suffix(),343					permission: up_data_structs::PropertyPermission {344						mutable: true,345						collection_admin: true,346						token_owner: false,347					},348				},349			)350			.map_err(dispatch_to_evm::<T>)?;351		}352353		let all_properties = <pallet_common::CollectionProperties<T>>::get(collection.id);354		if all_properties.get(&key::base_uri()).is_none() && !base_uri.is_empty() {355			self.recorder().consume_sstore()?;356			<PalletCommon<T>>::set_collection_properties(357				&collection,358				&caller,359				vec![up_data_structs::Property {360					key: key::base_uri(),361					value: base_uri362						.into_bytes()363						.try_into()364						.map_err(|_| "base uri is too large")?,365				}],366			)367			.map_err(dispatch_to_evm::<T>)?;368		}369370		self.recorder().consume_sstore()?;371		collection.save().map_err(dispatch_to_evm::<T>)?;372373		Ok(())374	}375376	#[weight(<SelfWeightOf<T>>::destroy_collection())]377	fn destroy_collection(&mut self, caller: caller, collection_address: address) -> Result<void> {378		let caller = T::CrossAccountId::from_eth(caller);379380		let collection_id = pallet_common::eth::map_eth_to_id(&collection_address)381			.ok_or("Invalid collection address format")?;382		<Pallet<T>>::destroy_collection_internal(caller, collection_id)383			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)384	}385386	/// Check if a collection exists387	/// @param collectionAddress Address of the collection in question388	/// @return bool Does the collection exist?389	fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {390		if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {391			let collection_id = id;392			return Ok(<CollectionById<T>>::contains_key(collection_id));393		}394395		Ok(false)396	}397398	fn collection_creation_fee(&self) -> Result<value> {399		let price: u128 = T::CollectionCreationPrice::get()400			.try_into()401			.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait402			.expect("Collection creation price should be convertible to u128");403		Ok(price.into())404	}405}406407/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]408pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);409impl<T: Config + pallet_nonfungible::Config + pallet_refungible::Config> OnMethodCall<T>410	for CollectionHelpersOnMethodCall<T>411{412	fn is_reserved(contract: &sp_core::H160) -> bool {413		contract == &T::ContractAddress::get()414	}415416	fn is_used(contract: &sp_core::H160) -> bool {417		contract == &T::ContractAddress::get()418	}419420	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {421		if handle.code_address() != T::ContractAddress::get() {422			return None;423		}424425		let helpers =426			EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));427		pallet_evm_coder_substrate::call(handle, helpers)428	}429430	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {431		(contract == &T::ContractAddress::get())432			.then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())433	}434}435436generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);437generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);438439fn error_field_too_long(feild: &str, bound: usize) -> Error {440	Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))441}