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

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_interface, solidity, weight, types::*};22use frame_support::traits::Get;23use pallet_common::{24	CollectionById,25	dispatch::CollectionDispatch,26	erc::{27		CollectionHelpersEvents,28		static_property::{key, value as property_value},29	},30	Pallet as PalletCommon,31};32use pallet_evm_coder_substrate::{dispatch_to_evm, SubstrateRecorder, WithRecorder};33use pallet_evm::{account::CrossAccountId, OnMethodCall, PrecompileHandle, PrecompileResult};34use sp_std::vec;35use up_data_structs::{36	CollectionName, CollectionDescription, CollectionTokenPrefix, CreateCollectionData,37	CollectionMode, PropertyValue,38};3940use crate::{Config, SelfWeightOf, weights::WeightInfo};4142use sp_std::vec::Vec;43use alloc::format;4445/// See [`CollectionHelpersCall`]46pub struct EvmCollectionHelpers<T: Config>(SubstrateRecorder<T>);47impl<T: Config> WithRecorder<T> for EvmCollectionHelpers<T> {48	fn recorder(&self) -> &SubstrateRecorder<T> {49		&self.050	}5152	fn into_recorder(self) -> SubstrateRecorder<T> {53		self.054	}55}5657fn convert_data<T: Config>(58	caller: caller,59	name: string,60	description: string,61	token_prefix: string,62	base_uri: string,63) -> Result<(64	T::CrossAccountId,65	CollectionName,66	CollectionDescription,67	CollectionTokenPrefix,68	PropertyValue,69)> {70	let caller = T::CrossAccountId::from_eth(caller);71	let name = name72		.encode_utf16()73		.collect::<Vec<u16>>()74		.try_into()75		.map_err(|_| error_field_too_long(stringify!(name), CollectionName::bound()))?;76	let description = description77		.encode_utf16()78		.collect::<Vec<u16>>()79		.try_into()80		.map_err(|_| {81			error_field_too_long(stringify!(description), CollectionDescription::bound())82		})?;83	let token_prefix = token_prefix.into_bytes().try_into().map_err(|_| {84		error_field_too_long(stringify!(token_prefix), CollectionTokenPrefix::bound())85	})?;86	let base_uri_value = base_uri87		.into_bytes()88		.try_into()89		.map_err(|_| error_field_too_long(stringify!(token_prefix), PropertyValue::bound()))?;90	Ok((caller, name, description, token_prefix, base_uri_value))91}9293fn default_url_pkp() -> up_data_structs::PropertyKeyPermission {94	up_data_structs::PropertyKeyPermission {95		key: key::url(),96		permission: up_data_structs::PropertyPermission {97			mutable: true,98			collection_admin: true,99			token_owner: false,100		},101	}102}103fn default_suffix_pkp() -> up_data_structs::PropertyKeyPermission {104	up_data_structs::PropertyKeyPermission {105		key: key::suffix(),106		permission: up_data_structs::PropertyPermission {107			mutable: true,108			collection_admin: true,109			token_owner: false,110		},111	}112}113fn make_data<T: Config>(114	name: CollectionName,115	mode: CollectionMode,116	description: CollectionDescription,117	token_prefix: CollectionTokenPrefix,118	base_uri_value: PropertyValue,119	add_properties: bool,120) -> Result<CreateCollectionData<T::AccountId>> {121	let token_property_permissions = if add_properties {122		vec![default_url_pkp(), default_suffix_pkp()]123			.try_into()124			.map_err(|e| Error::Revert(format!("{:?}", e)))?125	} else {126		up_data_structs::CollectionPropertiesPermissionsVec::default()127	};128	let properties = if add_properties {129		let mut properties = vec![130			up_data_structs::Property {131				key: key::schema_name(),132				value: property_value::erc721(),133			},134			up_data_structs::Property {135				key: key::schema_version(),136				value: property_value::schema_version(),137			},138		];139		if !base_uri_value.is_empty() {140			properties.push(up_data_structs::Property {141				key: key::base_uri(),142				value: base_uri_value,143			})144		}145		properties146			.try_into()147			.map_err(|e| Error::Revert(format!("{:?}", e)))?148	} else {149		up_data_structs::CollectionPropertiesVec::default()150	};151152	let data = CreateCollectionData {153		name,154		mode,155		description,156		token_prefix,157		token_property_permissions,158		properties,159		..Default::default()160	};161	Ok(data)162}163164fn create_refungible_collection_internal<165	T: Config + pallet_nonfungible::Config + pallet_refungible::Config,166>(167	caller: caller,168	value: value,169	name: string,170	description: string,171	token_prefix: string,172	base_uri: string,173	add_properties: bool,174) -> Result<address> {175	let (caller, name, description, token_prefix, base_uri_value) =176		convert_data::<T>(caller, name, description, token_prefix, base_uri)?;177	let data = make_data::<T>(178		name,179		CollectionMode::ReFungible,180		description,181		token_prefix,182		base_uri_value,183		add_properties,184	)?;185	check_sent_amount_equals_collection_creation_price::<T>(value)?;186	let collection_helpers_address =187		T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());188189	let collection_id =190		T::CollectionDispatch::create(caller.clone(), collection_helpers_address, data)191			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;192	let address = pallet_common::eth::collection_id_to_address(collection_id);193	Ok(address)194}195196fn check_sent_amount_equals_collection_creation_price<T: Config>(value: value) -> Result<()> {197	let value = value.as_u128();198	let creation_price: u128 = T::CollectionCreationPrice::get()199		.try_into()200		.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait201		.expect("Collection creation price should be convertible to u128");202	if value != creation_price {203		return Err(format!(204			"Sent amount not equals to collection creation price ({0})",205			creation_price206		)207		.into());208	}209	Ok(())210}211212/// @title Contract, which allows users to operate with collections213#[solidity_interface(name = CollectionHelpers, events(CollectionHelpersEvents))]214impl<T> EvmCollectionHelpers<T>215where216	T: Config + pallet_common::Config + pallet_nonfungible::Config + pallet_refungible::Config,217{218	/// Create an NFT collection219	/// @param name Name of the collection220	/// @param description Informative description of the collection221	/// @param tokenPrefix Token prefix to represent the collection tokens in UI and user applications222	/// @return address Address of the newly created collection223	#[weight(<SelfWeightOf<T>>::create_collection())]224	#[solidity(rename_selector = "createNFTCollection")]225	fn create_nft_collection(226		&mut self,227		caller: caller,228		value: value,229		name: string,230		description: string,231		token_prefix: string,232	) -> Result<address> {233		let (caller, name, description, token_prefix, _base_uri_value) =234			convert_data::<T>(caller, name, description, token_prefix, "".into())?;235		let data = make_data::<T>(236			name,237			CollectionMode::NFT,238			description,239			token_prefix,240			Default::default(),241			false,242		)?;243		check_sent_amount_equals_collection_creation_price::<T>(value)?;244		let collection_helpers_address =245			T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());246		let collection_id = T::CollectionDispatch::create(caller, collection_helpers_address, data)247			.map_err(dispatch_to_evm::<T>)?;248249		let address = pallet_common::eth::collection_id_to_address(collection_id);250		Ok(address)251	}252	/// Create an NFT collection253	/// @param name Name of the collection254	/// @param description Informative description of the collection255	/// @param tokenPrefix Token prefix to represent the collection tokens in UI and user applications256	/// @return address Address of the newly created collection257	#[weight(<SelfWeightOf<T>>::create_collection())]258	#[deprecated(note = "mathod was renamed to `create_nft_collection`, prefer it instead")]259	fn create_nonfungible_collection(260		&mut self,261		caller: caller,262		value: value,263		name: string,264		description: string,265		token_prefix: string,266	) -> Result<address> {267		self.create_nft_collection(caller, value, name, description, token_prefix)268	}269270	#[weight(<SelfWeightOf<T>>::create_collection())]271	#[solidity(rename_selector = "createERC721MetadataCompatibleNFTCollection")]272	fn create_nonfungible_collection_with_properties(273		&mut self,274		caller: caller,275		value: value,276		name: string,277		description: string,278		token_prefix: string,279		base_uri: string,280	) -> Result<address> {281		let (caller, name, description, token_prefix, base_uri_value) =282			convert_data::<T>(caller, name, description, token_prefix, base_uri)?;283		let data = make_data::<T>(284			name,285			CollectionMode::NFT,286			description,287			token_prefix,288			base_uri_value,289			true,290		)?;291		check_sent_amount_equals_collection_creation_price::<T>(value)?;292		let collection_helpers_address =293			T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());294		let collection_id = T::CollectionDispatch::create(caller, collection_helpers_address, data)295			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;296297		let address = pallet_common::eth::collection_id_to_address(collection_id);298		Ok(address)299	}300301	#[weight(<SelfWeightOf<T>>::create_collection())]302	#[solidity(rename_selector = "createRFTCollection")]303	fn create_rft_collection(304		&mut self,305		caller: caller,306		value: value,307		name: string,308		description: string,309		token_prefix: string,310	) -> Result<address> {311		create_refungible_collection_internal::<T>(312			caller,313			value,314			name,315			description,316			token_prefix,317			Default::default(),318			false,319		)320	}321322	#[weight(<SelfWeightOf<T>>::create_collection())]323	#[solidity(rename_selector = "createERC721MetadataCompatibleRFTCollection")]324	fn create_refungible_collection_with_properties(325		&mut self,326		caller: caller,327		value: value,328		name: string,329		description: string,330		token_prefix: string,331		base_uri: string,332	) -> Result<address> {333		create_refungible_collection_internal::<T>(334			caller,335			value,336			name,337			description,338			token_prefix,339			base_uri,340			true,341		)342	}343344	#[solidity(rename_selector = "makeCollectionERC721MetadataCompatible")]345	fn make_collection_metadata_compatible(346		&mut self,347		caller: caller,348		collection: address,349		base_uri: string,350	) -> Result<()> {351		let caller = T::CrossAccountId::from_eth(caller);352		let collection =353			pallet_common::eth::map_eth_to_id(&collection).ok_or("not a collection address")?;354		let mut collection =355			<crate::CollectionHandle<T>>::new(collection).ok_or("collection not found")?;356357		if !matches!(358			collection.mode,359			CollectionMode::NFT | CollectionMode::ReFungible360		) {361			return Err("target collection should be either NFT or Refungible".into());362		}363364		self.recorder().consume_sstore()?;365		collection366			.check_is_owner_or_admin(&caller)367			.map_err(dispatch_to_evm::<T>)?;368369		if collection.flags.erc721metadata {370			return Err("target collection is already Erc721Metadata compatible".into());371		}372		collection.flags.erc721metadata = true;373374		let all_permissions = <pallet_common::CollectionPropertyPermissions<T>>::get(collection.id);375		if all_permissions.get(&key::url()).is_none() {376			self.recorder().consume_sstore()?;377			<PalletCommon<T>>::set_property_permission(&collection, &caller, default_url_pkp())378				.map_err(dispatch_to_evm::<T>)?;379		}380		if all_permissions.get(&key::suffix()).is_none() {381			self.recorder().consume_sstore()?;382			<PalletCommon<T>>::set_property_permission(&collection, &caller, default_suffix_pkp())383				.map_err(dispatch_to_evm::<T>)?;384		}385386		let all_properties = <pallet_common::CollectionProperties<T>>::get(collection.id);387		let mut new_properties = vec![];388		if all_properties.get(&key::schema_name()).is_none() {389			self.recorder().consume_sstore()?;390			new_properties.push(up_data_structs::Property {391				key: key::schema_name(),392				value: property_value::erc721(),393			});394			new_properties.push(up_data_structs::Property {395				key: key::schema_version(),396				value: property_value::schema_version(),397			});398		}399		if all_properties.get(&key::base_uri()).is_none() && !base_uri.is_empty() {400			new_properties.push(up_data_structs::Property {401				key: key::base_uri(),402				value: base_uri403					.into_bytes()404					.try_into()405					.map_err(|_| "base uri is too large")?,406			});407		}408409		if !new_properties.is_empty() {410			self.recorder().consume_sstore()?;411			<PalletCommon<T>>::set_collection_properties(&collection, &caller, new_properties)412				.map_err(dispatch_to_evm::<T>)?;413		}414415		self.recorder().consume_sstore()?;416		collection.save().map_err(dispatch_to_evm::<T>)?;417418		Ok(())419	}420421	/// Check if a collection exists422	/// @param collectionAddress Address of the collection in question423	/// @return bool Does the collection exist?424	fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {425		if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {426			let collection_id = id;427			return Ok(<CollectionById<T>>::contains_key(collection_id));428		}429430		Ok(false)431	}432433	fn collection_creation_fee(&self) -> Result<value> {434		let price: u128 = T::CollectionCreationPrice::get()435			.try_into()436			.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait437			.expect("Collection creation price should be convertible to u128");438		Ok(price.into())439	}440}441442/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]443pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);444impl<T: Config + pallet_nonfungible::Config + pallet_refungible::Config> OnMethodCall<T>445	for CollectionHelpersOnMethodCall<T>446{447	fn is_reserved(contract: &sp_core::H160) -> bool {448		contract == &T::ContractAddress::get()449	}450451	fn is_used(contract: &sp_core::H160) -> bool {452		contract == &T::ContractAddress::get()453	}454455	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {456		if handle.code_address() != T::ContractAddress::get() {457			return None;458		}459460		let helpers =461			EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));462		pallet_evm_coder_substrate::call(handle, helpers)463	}464465	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {466		(contract == &T::ContractAddress::get())467			.then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())468	}469}470471generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);472generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);473474fn error_field_too_long(feild: &str, bound: usize) -> Error {475	Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))476}