git.delta.rocks / unique-network / refs/commits / 48f959311e08

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};31use pallet_evm_coder_substrate::{dispatch_to_evm, SubstrateRecorder, WithRecorder};32use pallet_evm::{account::CrossAccountId, OnMethodCall, PrecompileHandle, PrecompileResult};33use up_data_structs::{34	CollectionName, CollectionDescription, CollectionTokenPrefix, CreateCollectionData,35	CollectionMode, PropertyValue,36};3738use crate::{Config, SelfWeightOf, weights::WeightInfo};3940use sp_std::vec::Vec;41use alloc::format;4243/// See [`CollectionHelpersCall`]44pub struct EvmCollectionHelpers<T: Config>(SubstrateRecorder<T>);45impl<T: Config> WithRecorder<T> for EvmCollectionHelpers<T> {46	fn recorder(&self) -> &SubstrateRecorder<T> {47		&self.048	}4950	fn into_recorder(self) -> SubstrateRecorder<T> {51		self.052	}53}5455fn convert_data<T: Config>(56	caller: caller,57	name: string,58	description: string,59	token_prefix: string,60	base_uri: string,61) -> Result<(62	T::CrossAccountId,63	CollectionName,64	CollectionDescription,65	CollectionTokenPrefix,66	PropertyValue,67)> {68	let caller = T::CrossAccountId::from_eth(caller);69	let name = name70		.encode_utf16()71		.collect::<Vec<u16>>()72		.try_into()73		.map_err(|_| error_field_too_long(stringify!(name), CollectionName::bound()))?;74	let description = description75		.encode_utf16()76		.collect::<Vec<u16>>()77		.try_into()78		.map_err(|_| {79			error_field_too_long(stringify!(description), CollectionDescription::bound())80		})?;81	let token_prefix = token_prefix.into_bytes().try_into().map_err(|_| {82		error_field_too_long(stringify!(token_prefix), CollectionTokenPrefix::bound())83	})?;84	let base_uri_value = base_uri85		.into_bytes()86		.try_into()87		.map_err(|_| error_field_too_long(stringify!(token_prefix), PropertyValue::bound()))?;88	Ok((caller, name, description, token_prefix, base_uri_value))89}9091fn make_data<T: Config>(92	name: CollectionName,93	mode: CollectionMode,94	description: CollectionDescription,95	token_prefix: CollectionTokenPrefix,96	base_uri_value: PropertyValue,97	add_properties: bool,98) -> Result<CreateCollectionData<T::AccountId>> {99	let mut properties = up_data_structs::CollectionPropertiesVec::default();100	let mut token_property_permissions =101		up_data_structs::CollectionPropertiesPermissionsVec::default();102103	token_property_permissions104		.try_push(up_data_structs::PropertyKeyPermission {105			key: key::url(),106			permission: up_data_structs::PropertyPermission {107				mutable: true,108				collection_admin: true,109				token_owner: false,110			},111		})112		.map_err(|e| Error::Revert(format!("{:?}", e)))?;113114	if add_properties {115		token_property_permissions116			.try_push(up_data_structs::PropertyKeyPermission {117				key: key::suffix(),118				permission: up_data_structs::PropertyPermission {119					mutable: true,120					collection_admin: true,121					token_owner: false,122				},123			})124			.map_err(|e| Error::Revert(format!("{:?}", e)))?;125126		properties127			.try_push(up_data_structs::Property {128				key: key::schema_name(),129				value: property_value::erc721(),130			})131			.map_err(|e| Error::Revert(format!("{:?}", e)))?;132133		properties134			.try_push(up_data_structs::Property {135				key: key::schema_version(),136				value: property_value::schema_version(),137			})138			.map_err(|e| Error::Revert(format!("{:?}", e)))?;139140		properties141			.try_push(up_data_structs::Property {142				key: key::erc721_metadata(),143				value: property_value::erc721_metadata_supported(),144			})145			.map_err(|e| Error::Revert(format!("{:?}", e)))?;146147		if !base_uri_value.is_empty() {148			properties149				.try_push(up_data_structs::Property {150					key: key::base_uri(),151					value: base_uri_value,152				})153				.map_err(|e| Error::Revert(format!("{:?}", e)))?;154		}155	}156157	let data = CreateCollectionData {158		name,159		mode,160		description,161		token_prefix,162		token_property_permissions,163		properties,164		..Default::default()165	};166	Ok(data)167}168169fn create_refungible_collection_internal<170	T: Config + pallet_nonfungible::Config + pallet_refungible::Config,171>(172	caller: caller,173	value: value,174	name: string,175	description: string,176	token_prefix: string,177	base_uri: string,178	add_properties: bool,179) -> Result<address> {180	let (caller, name, description, token_prefix, base_uri_value) =181		convert_data::<T>(caller, name, description, token_prefix, base_uri)?;182	let data = make_data::<T>(183		name,184		CollectionMode::ReFungible,185		description,186		token_prefix,187		base_uri_value,188		add_properties,189	)?;190	check_sent_amount_equals_collection_creation_price::<T>(value)?;191	let collection_helpers_address =192		T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());193194	let collection_id =195		T::CollectionDispatch::create(caller.clone(), collection_helpers_address, data)196			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;197	let address = pallet_common::eth::collection_id_to_address(collection_id);198	Ok(address)199}200201fn check_sent_amount_equals_collection_creation_price<T: Config>(value: value) -> Result<()> {202	let value = value.as_u128();203	let creation_price: u128 = T::CollectionCreationPrice::get()204		.try_into()205		.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait206		.expect("Collection creation price should be convertible to u128");207	if value != creation_price {208		return Err(format!(209			"Sent amount not equals to collection creation price ({0})",210			creation_price211		)212		.into());213	}214	Ok(())215}216217/// @title Contract, which allows users to operate with collections218#[solidity_interface(name = CollectionHelpers, events(CollectionHelpersEvents))]219impl<T> EvmCollectionHelpers<T>220where221	T: Config + pallet_common::Config + pallet_nonfungible::Config + pallet_refungible::Config,222{223	/// Create an NFT collection224	/// @param name Name of the collection225	/// @param description Informative description of the collection226	/// @param tokenPrefix Token prefix to represent the collection tokens in UI and user applications227	/// @return address Address of the newly created collection228	#[weight(<SelfWeightOf<T>>::create_collection())]229	#[solidity(rename_selector = "createNFTCollection")]230	fn create_nft_collection(231		&mut self,232		caller: caller,233		value: value,234		name: string,235		description: string,236		token_prefix: string,237	) -> Result<address> {238		let (caller, name, description, token_prefix, _base_uri_value) =239			convert_data::<T>(caller, name, description, token_prefix, "".into())?;240		let data = make_data::<T>(241			name,242			CollectionMode::NFT,243			description,244			token_prefix,245			Default::default(),246			false,247		)?;248		check_sent_amount_equals_collection_creation_price::<T>(value)?;249		let collection_helpers_address =250			T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());251		let collection_id = T::CollectionDispatch::create(caller, collection_helpers_address, data)252			.map_err(dispatch_to_evm::<T>)?;253254		let address = pallet_common::eth::collection_id_to_address(collection_id);255		Ok(address)256	}257	/// Create an NFT collection258	/// @param name Name of the collection259	/// @param description Informative description of the collection260	/// @param tokenPrefix Token prefix to represent the collection tokens in UI and user applications261	/// @return address Address of the newly created collection262	#[weight(<SelfWeightOf<T>>::create_collection())]263	#[deprecated(note = "mathod was renamed to `create_nft_collection`, prefer it instead")]264	fn create_nonfungible_collection(265		&mut self,266		caller: caller,267		value: value,268		name: string,269		description: string,270		token_prefix: string,271	) -> Result<address> {272		self.create_nft_collection(caller, value, name, description, token_prefix)273	}274275	#[weight(<SelfWeightOf<T>>::create_collection())]276	#[solidity(rename_selector = "createERC721MetadataCompatibleNFTCollection")]277	fn create_nonfungible_collection_with_properties(278		&mut self,279		caller: caller,280		value: value,281		name: string,282		description: string,283		token_prefix: string,284		base_uri: string,285	) -> Result<address> {286		let (caller, name, description, token_prefix, base_uri_value) =287			convert_data::<T>(caller, name, description, token_prefix, base_uri)?;288		let data = make_data::<T>(289			name,290			CollectionMode::NFT,291			description,292			token_prefix,293			base_uri_value,294			true,295		)?;296		check_sent_amount_equals_collection_creation_price::<T>(value)?;297		let collection_helpers_address =298			T::CrossAccountId::from_eth(<T as pallet_common::Config>::ContractAddress::get());299		let collection_id = T::CollectionDispatch::create(caller, collection_helpers_address, data)300			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;301302		let address = pallet_common::eth::collection_id_to_address(collection_id);303		Ok(address)304	}305306	#[weight(<SelfWeightOf<T>>::create_collection())]307	#[solidity(rename_selector = "createRFTCollection")]308	fn create_rft_collection(309		&mut self,310		caller: caller,311		value: value,312		name: string,313		description: string,314		token_prefix: string,315	) -> Result<address> {316		create_refungible_collection_internal::<T>(317			caller,318			value,319			name,320			description,321			token_prefix,322			Default::default(),323			false,324		)325	}326327	#[weight(<SelfWeightOf<T>>::create_collection())]328	#[solidity(rename_selector = "createERC721MetadataCompatibleRFTCollection")]329	fn create_refungible_collection_with_properties(330		&mut self,331		caller: caller,332		value: value,333		name: string,334		description: string,335		token_prefix: string,336		base_uri: string,337	) -> Result<address> {338		create_refungible_collection_internal::<T>(339			caller,340			value,341			name,342			description,343			token_prefix,344			base_uri,345			true,346		)347	}348349	/// Check if a collection exists350	/// @param collectionAddress Address of the collection in question351	/// @return bool Does the collection exist?352	fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {353		if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {354			let collection_id = id;355			return Ok(<CollectionById<T>>::contains_key(collection_id));356		}357358		Ok(false)359	}360361	fn collection_creation_fee(&self) -> Result<value> {362		let price: u128 = T::CollectionCreationPrice::get()363			.try_into()364			.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait365			.expect("Collection creation price should be convertible to u128");366		Ok(price.into())367	}368}369370/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]371pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);372impl<T: Config + pallet_nonfungible::Config + pallet_refungible::Config> OnMethodCall<T>373	for CollectionHelpersOnMethodCall<T>374{375	fn is_reserved(contract: &sp_core::H160) -> bool {376		contract == &T::ContractAddress::get()377	}378379	fn is_used(contract: &sp_core::H160) -> bool {380		contract == &T::ContractAddress::get()381	}382383	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {384		if handle.code_address() != T::ContractAddress::get() {385			return None;386		}387388		let helpers =389			EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));390		pallet_evm_coder_substrate::call(handle, helpers)391	}392393	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {394		(contract == &T::ContractAddress::get())395			.then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())396	}397}398399generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);400generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);401402fn error_field_too_long(feild: &str, bound: usize) -> Error {403	Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))404}