git.delta.rocks / unique-network / refs/commits / 118b8d5eaba9

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 evm_coder::{execution::*, generate_stubgen, solidity_interface, solidity, weight, types::*};21use ethereum as _;22use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};23use pallet_evm::{OnMethodCall, PrecompileResult, account::CrossAccountId, PrecompileHandle};24use up_data_structs::{25	CollectionName, CollectionDescription, CollectionTokenPrefix, CreateCollectionData,26	CollectionMode, PropertyValue,27};28use frame_support::traits::Get;29use pallet_common::{30	CollectionById,31	erc::{static_property::{key, value as property_value}, CollectionHelpersEvents},32};33use crate::{SelfWeightOf, Config, weights::WeightInfo};3435use sp_std::vec::Vec;36use alloc::format;3738/// See [`CollectionHelpersCall`]39pub struct EvmCollectionHelpers<T: Config>(SubstrateRecorder<T>);40impl<T: Config> WithRecorder<T> for EvmCollectionHelpers<T> {41	fn recorder(&self) -> &SubstrateRecorder<T> {42		&self.043	}4445	fn into_recorder(self) -> SubstrateRecorder<T> {46		self.047	}48}4950fn convert_data<T: Config>(51	caller: caller,52	name: string,53	description: string,54	token_prefix: string,55	base_uri: string,56) -> Result<(57	T::CrossAccountId,58	CollectionName,59	CollectionDescription,60	CollectionTokenPrefix,61	PropertyValue,62)> {63	let caller = T::CrossAccountId::from_eth(caller);64	let name = name65		.encode_utf16()66		.collect::<Vec<u16>>()67		.try_into()68		.map_err(|_| error_feild_too_long(stringify!(name), CollectionName::bound()))?;69	let description = description70		.encode_utf16()71		.collect::<Vec<u16>>()72		.try_into()73		.map_err(|_| {74			error_feild_too_long(stringify!(description), CollectionDescription::bound())75		})?;76	let token_prefix = token_prefix.into_bytes().try_into().map_err(|_| {77		error_feild_too_long(stringify!(token_prefix), CollectionTokenPrefix::bound())78	})?;79	let base_uri_value = base_uri80		.into_bytes()81		.try_into()82		.map_err(|_| error_feild_too_long(stringify!(token_prefix), PropertyValue::bound()))?;83	Ok((caller, name, description, token_prefix, base_uri_value))84}8586fn make_data<T: Config>(87	name: CollectionName,88	mode: CollectionMode,89	description: CollectionDescription,90	token_prefix: CollectionTokenPrefix,91	base_uri_value: PropertyValue,92	add_properties: bool,93) -> Result<CreateCollectionData<T::AccountId>> {94	let mut properties = up_data_structs::CollectionPropertiesVec::default();95	let mut token_property_permissions =96		up_data_structs::CollectionPropertiesPermissionsVec::default();9798	token_property_permissions99		.try_push(up_data_structs::PropertyKeyPermission {100			key: key::url(),101			permission: up_data_structs::PropertyPermission {102				mutable: false,103				collection_admin: true,104				token_owner: false,105			},106		})107		.map_err(|e| Error::Revert(format!("{:?}", e)))?;108109	if add_properties {110		token_property_permissions111			.try_push(up_data_structs::PropertyKeyPermission {112				key: key::suffix(),113				permission: up_data_structs::PropertyPermission {114					mutable: false,115					collection_admin: true,116					token_owner: false,117				},118			})119			.map_err(|e| Error::Revert(format!("{:?}", e)))?;120121		properties122			.try_push(up_data_structs::Property {123				key: key::schema_name(),124				value: property_value::erc721(),125			})126			.map_err(|e| Error::Revert(format!("{:?}", e)))?;127128		if !base_uri_value.is_empty() {129			properties130				.try_push(up_data_structs::Property {131					key: key::base_uri(),132					value: base_uri_value,133				})134				.map_err(|e| Error::Revert(format!("{:?}", e)))?;135		}136	}137138	let data = CreateCollectionData {139		name,140		mode,141		description,142		token_prefix,143		token_property_permissions,144		properties,145		..Default::default()146	};147	Ok(data)148}149150/// @title Contract, which allows users to operate with collections151#[solidity_interface(name = "CollectionHelpers", events(CollectionHelpersEvents))]152impl<T> EvmCollectionHelpers<T>153where154	T: Config + pallet_nonfungible::Config + pallet_refungible::Config,155{156	/// Create an NFT collection157	/// @param name Name of the collection158	/// @param description Informative description of the collection159	/// @param token_prefix Token prefix to represent the collection tokens in UI and user applications160	/// @return address Address of the newly created collection161	#[weight(<SelfWeightOf<T>>::create_collection())]162	fn create_nonfungible_collection(163		&mut self,164		caller: caller,165		name: string,166		description: string,167		token_prefix: string,168	) -> Result<address> {169		let (caller, name, description, token_prefix, _base_uri_value) =170			convert_data::<T>(caller, name, description, token_prefix, "".into())?;171		let data = make_data::<T>(172			name,173			CollectionMode::NFT,174			description,175			token_prefix,176			Default::default(),177			false,178		)?;179		let collection_id =180			<pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, false)181				.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;182183		let address = pallet_common::eth::collection_id_to_address(collection_id);184		Ok(address)185	}186187	#[weight(<SelfWeightOf<T>>::create_collection())]188	#[solidity(rename_selector = "createERC721MetadataCompatibleCollection")]189	fn create_nonfungible_collection_with_properties(190		&mut self,191		caller: caller,192		name: string,193		description: string,194		token_prefix: string,195		base_uri: string,196	) -> Result<address> {197		let (caller, name, description, token_prefix, base_uri_value) =198			convert_data::<T>(caller, name, description, token_prefix, base_uri)?;199		let data = make_data::<T>(200			name,201			CollectionMode::NFT,202			description,203			token_prefix,204			base_uri_value,205			true,206		)?;207		let collection_id =208			<pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, true)209				.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;210211		let address = pallet_common::eth::collection_id_to_address(collection_id);212		Ok(address)213	}214215	#[weight(<SelfWeightOf<T>>::create_collection())]216	fn create_refungible_collection(217		&self,218		caller: caller,219		name: string,220		description: string,221		token_prefix: string,222	) -> Result<address> {223		let (caller, name, description, token_prefix, _base_uri) =224			convert_data::<T>(caller, name, description, token_prefix, "".into())?;225		let data = make_data::<T>(226			name,227			CollectionMode::ReFungible,228			description,229			token_prefix,230			Default::default(),231			false,232		)?;233		let collection_id = <pallet_refungible::Pallet<T>>::init_collection(caller.clone(), data)234			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;235236		let address = pallet_common::eth::collection_id_to_address(collection_id);237		Ok(address)238	}239240	#[weight(<SelfWeightOf<T>>::create_collection())]241	#[solidity(rename_selector = "createERC721MetadataCompatibleRFTCollection")]242	fn create_refungible_collection_with_properties(243		&mut self,244		caller: caller,245		name: string,246		description: string,247		token_prefix: string,248		base_uri: string,249	) -> Result<address> {250		let (caller, name, description, token_prefix, base_uri_value) =251			convert_data::<T>(caller, name, description, token_prefix, base_uri)?;252		let data = make_data::<T>(253			name,254			CollectionMode::NFT,255			description,256			token_prefix,257			base_uri_value,258			true,259		)?;260		let collection_id = <pallet_refungible::Pallet<T>>::init_collection(caller.clone(), data)261			.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;262263		let address = pallet_common::eth::collection_id_to_address(collection_id);264		Ok(address)265	}266267	/// Check if a collection exists268	/// @param collection_address Address of the collection in question269	/// @return bool Does the collection exist?270	fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {271		if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {272			let collection_id = id;273			return Ok(<CollectionById<T>>::contains_key(collection_id));274		}275276		Ok(false)277	}278}279280/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]281pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);282impl<T: Config + pallet_nonfungible::Config + pallet_refungible::Config> OnMethodCall<T>283	for CollectionHelpersOnMethodCall<T>284{285	fn is_reserved(contract: &sp_core::H160) -> bool {286		contract == &T::ContractAddress::get()287	}288289	fn is_used(contract: &sp_core::H160) -> bool {290		contract == &T::ContractAddress::get()291	}292293	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {294		if handle.code_address() != T::ContractAddress::get() {295			return None;296		}297298		let helpers =299			EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));300		pallet_evm_coder_substrate::call(handle, helpers)301	}302303	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {304		(contract == &T::ContractAddress::get())305			.then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())306	}307}308309generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);310generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);311312fn error_feild_too_long(feild: &str, bound: usize) -> Error {313	Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))314}