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

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 sp_std::vec;34use up_data_structs::{35	CollectionName, CollectionDescription, CollectionTokenPrefix, CreateCollectionData,36	CollectionMode, PropertyValue,37};3839use crate::{Config, SelfWeightOf, weights::WeightInfo};4041use sp_std::vec::Vec;42use alloc::format;4344/// See [`CollectionHelpersCall`]45pub struct EvmCollectionHelpers<T: Config>(SubstrateRecorder<T>);46impl<T: Config> WithRecorder<T> for EvmCollectionHelpers<T> {47	fn recorder(&self) -> &SubstrateRecorder<T> {48		&self.049	}5051	fn into_recorder(self) -> SubstrateRecorder<T> {52		self.053	}54}5556fn convert_data<T: Config>(57	caller: caller,58	name: string,59	description: string,60	token_prefix: string,61	base_uri: string,62) -> Result<(63	T::CrossAccountId,64	CollectionName,65	CollectionDescription,66	CollectionTokenPrefix,67	PropertyValue,68)> {69	let caller = T::CrossAccountId::from_eth(caller);70	let name = name71		.encode_utf16()72		.collect::<Vec<u16>>()73		.try_into()74		.map_err(|_| error_field_too_long(stringify!(name), CollectionName::bound()))?;75	let description = description76		.encode_utf16()77		.collect::<Vec<u16>>()78		.try_into()79		.map_err(|_| {80			error_field_too_long(stringify!(description), CollectionDescription::bound())81		})?;82	let token_prefix = token_prefix.into_bytes().try_into().map_err(|_| {83		error_field_too_long(stringify!(token_prefix), CollectionTokenPrefix::bound())84	})?;85	let base_uri_value = base_uri86		.into_bytes()87		.try_into()88		.map_err(|_| error_field_too_long(stringify!(token_prefix), PropertyValue::bound()))?;89	Ok((caller, name, description, token_prefix, base_uri_value))90}9192fn make_data<T: Config>(93	name: CollectionName,94	mode: CollectionMode,95	description: CollectionDescription,96	token_prefix: CollectionTokenPrefix,97	base_uri_value: PropertyValue,98	add_properties: bool,99) -> Result<CreateCollectionData<T::AccountId>> {100	let token_property_permissions = if add_properties {101		vec![102			up_data_structs::PropertyKeyPermission {103				key: key::url(),104				permission: up_data_structs::PropertyPermission {105					mutable: true,106					collection_admin: true,107					token_owner: false,108				},109			},110			up_data_structs::PropertyKeyPermission {111				key: key::suffix(),112				permission: up_data_structs::PropertyPermission {113					mutable: true,114					collection_admin: true,115					token_owner: false,116				},117			},118		]119		.try_into()120		.map_err(|e| Error::Revert(format!("{:?}", e)))?121	} else {122		up_data_structs::CollectionPropertiesPermissionsVec::default()123	};124	let properties = if add_properties {125		let mut properties = vec![126			up_data_structs::Property {127				key: key::schema_name(),128				value: property_value::erc721(),129			},130			up_data_structs::Property {131				key: key::schema_version(),132				value: property_value::schema_version(),133			},134			up_data_structs::Property {135				key: key::erc721_metadata(),136				value: property_value::erc721_metadata_supported(),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	/// Check if a collection exists345	/// @param collectionAddress Address of the collection in question346	/// @return bool Does the collection exist?347	fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {348		if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {349			let collection_id = id;350			return Ok(<CollectionById<T>>::contains_key(collection_id));351		}352353		Ok(false)354	}355356	fn collection_creation_fee(&self) -> Result<value> {357		let price: u128 = T::CollectionCreationPrice::get()358			.try_into()359			.map_err(|_| ()) // workaround for `expect` requiring `Debug` trait360			.expect("Collection creation price should be convertible to u128");361		Ok(price.into())362	}363}364365/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]366pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);367impl<T: Config + pallet_nonfungible::Config + pallet_refungible::Config> OnMethodCall<T>368	for CollectionHelpersOnMethodCall<T>369{370	fn is_reserved(contract: &sp_core::H160) -> bool {371		contract == &T::ContractAddress::get()372	}373374	fn is_used(contract: &sp_core::H160) -> bool {375		contract == &T::ContractAddress::get()376	}377378	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {379		if handle.code_address() != T::ContractAddress::get() {380			return None;381		}382383		let helpers =384			EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));385		pallet_evm_coder_substrate::call(handle, helpers)386	}387388	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {389		(contract == &T::ContractAddress::get())390			.then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())391	}392}393394generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);395generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);396397fn error_field_too_long(feild: &str, bound: usize) -> Error {398	Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))399}