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

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::*, 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 collection_properties = up_data_structs::CollectionPropertiesVec::default();95	let mut token_property_permissions =96		up_data_structs::CollectionPropertiesPermissionsVec::default();9798	if add_properties {99		token_property_permissions100			.try_push(up_data_structs::PropertyKeyPermission {101				key: token_uri_key(),102				permission: up_data_structs::PropertyPermission {103					mutable: true,104					collection_admin: true,105					token_owner: false,106				},107			})108			.map_err(|e| Error::Revert(format!("{:?}", e)))?;109110		token_property_permissions111			.try_push(up_data_structs::PropertyKeyPermission {112				key: u_key(),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		token_property_permissions122			.try_push(up_data_structs::PropertyKeyPermission {123				key: s_key(),124				permission: up_data_structs::PropertyPermission {125					mutable: false,126					collection_admin: true,127					token_owner: false,128				},129			})130			.map_err(|e| Error::Revert(format!("{:?}", e)))?;131132		collection_properties133			.try_push(up_data_structs::Property {134				key: schema_name_key(),135				value: erc721_value(),136			})137			.map_err(|e| Error::Revert(format!("{:?}", e)))?;138139		if !base_uri_value.is_empty() {140			collection_properties141				.try_push(up_data_structs::Property {142					key: base_uri_key(),143					value: base_uri_value,144				})145				.map_err(|e| Error::Revert(format!("{:?}", e)))?;146		}147	}148149	let data = CreateCollectionData {150		name,151		mode,152		description,153		token_prefix,154		token_property_permissions,155		..Default::default()156	};157	Ok(data)158}159160/// @title Contract, which allows users to operate with collections161#[solidity_interface(name = "CollectionHelpers", events(CollectionHelpersEvents))]162impl<T: Config + pallet_nonfungible::Config> EvmCollectionHelpers<T> {163	/// Create an NFT collection164	/// @param name Name of the collection165	/// @param description Informative description of the collection166	/// @param token_prefix 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	fn create_nonfungible_collection(170		&mut self,171		caller: caller,172		name: string,173		description: string,174		token_prefix: string,175	) -> Result<address> {176		let (caller, name, description, token_prefix, _base_uri_value) =177			convert_data::<T>(caller, name, description, token_prefix, "".into())?;178		let data = make_data::<T>(name, CollectionMode::NFT, description, token_prefix, Default::default(), false)?;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>(name, CollectionMode::NFT, description, token_prefix, base_uri_value, true)?;200		let collection_id =201			<pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, false)202				.map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;203204		let address = pallet_common::eth::collection_id_to_address(collection_id);205		Ok(address)206	}207208	/// Check if a collection exists209	/// @param collection_address Address of the collection in question210	/// @return bool Does the collection exist?211	fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {212		if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {213			let collection_id = id;214			return Ok(<CollectionById<T>>::contains_key(collection_id));215		}216217		Ok(false)218	}219}220221/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]222pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);223impl<T: Config + pallet_nonfungible::Config> OnMethodCall<T> for CollectionHelpersOnMethodCall<T> {224	fn is_reserved(contract: &sp_core::H160) -> bool {225		contract == &T::ContractAddress::get()226	}227228	fn is_used(contract: &sp_core::H160) -> bool {229		contract == &T::ContractAddress::get()230	}231232	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {233		if handle.code_address() != T::ContractAddress::get() {234			return None;235		}236237		let helpers =238			EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));239		pallet_evm_coder_substrate::call(handle, helpers)240	}241242	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {243		(contract == &T::ContractAddress::get())244			.then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())245	}246}247248generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);249generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);250251fn error_feild_too_long(feild: &str, bound: usize) -> Error {252	Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))253}