difftreelog
minor: Changed tokenURI retrieving logic
in: master
1 file changed
pallets/unique/src/eth/mod.rsdiffbeforeafterboth1// 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 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: url_key(),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: suffix_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 properties122 .try_push(up_data_structs::Property {123 key: schema_name_key(),124 value: erc721_value(),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: base_uri_key(),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: Config + pallet_nonfungible::Config> EvmCollectionHelpers<T> {153 /// Create an NFT collection154 /// @param name Name of the collection155 /// @param description Informative description of the collection156 /// @param token_prefix Token prefix to represent the collection tokens in UI and user applications157 /// @return address Address of the newly created collection158 #[weight(<SelfWeightOf<T>>::create_collection())]159 fn create_nonfungible_collection(160 &mut self,161 caller: caller,162 name: string,163 description: string,164 token_prefix: string,165 ) -> Result<address> {166 let (caller, name, description, token_prefix, _base_uri_value) =167 convert_data::<T>(caller, name, description, token_prefix, "".into())?;168 let data = make_data::<T>(169 name,170 CollectionMode::NFT,171 description,172 token_prefix,173 Default::default(),174 false,175 )?;176 let collection_id =177 <pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, false)178 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;179180 let address = pallet_common::eth::collection_id_to_address(collection_id);181 Ok(address)182 }183184 #[weight(<SelfWeightOf<T>>::create_collection())]185 #[solidity(rename_selector = "createERC721MetadataCompatibleCollection")]186 fn create_nonfungible_collection_with_properties(187 &mut self,188 caller: caller,189 name: string,190 description: string,191 token_prefix: string,192 base_uri: string,193 ) -> Result<address> {194 let (caller, name, description, token_prefix, base_uri_value) =195 convert_data::<T>(caller, name, description, token_prefix, base_uri)?;196 let data = make_data::<T>(197 name,198 CollectionMode::NFT,199 description,200 token_prefix,201 base_uri_value,202 true,203 )?;204 let collection_id =205 <pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, true)206 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;207208 let address = pallet_common::eth::collection_id_to_address(collection_id);209 Ok(address)210 }211212 /// Check if a collection exists213 /// @param collection_address Address of the collection in question214 /// @return bool Does the collection exist?215 fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {216 if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {217 let collection_id = id;218 return Ok(<CollectionById<T>>::contains_key(collection_id));219 }220221 Ok(false)222 }223}224225/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]226pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);227impl<T: Config + pallet_nonfungible::Config> OnMethodCall<T> for CollectionHelpersOnMethodCall<T> {228 fn is_reserved(contract: &sp_core::H160) -> bool {229 contract == &T::ContractAddress::get()230 }231232 fn is_used(contract: &sp_core::H160) -> bool {233 contract == &T::ContractAddress::get()234 }235236 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {237 if handle.code_address() != T::ContractAddress::get() {238 return None;239 }240241 let helpers =242 EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));243 pallet_evm_coder_substrate::call(handle, helpers)244 }245246 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {247 (contract == &T::ContractAddress::get())248 .then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())249 }250}251252generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);253generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);254255fn error_feild_too_long(feild: &str, bound: usize) -> Error {256 Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))257}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}8586//87fn make_data<T: Config>(88 name: CollectionName,89 mode: CollectionMode,90 description: CollectionDescription,91 token_prefix: CollectionTokenPrefix,92 base_uri_value: PropertyValue,93 add_properties: bool,94) -> Result<CreateCollectionData<T::AccountId>> {95 let mut properties = up_data_structs::CollectionPropertiesVec::default();96 let mut token_property_permissions =97 up_data_structs::CollectionPropertiesPermissionsVec::default();9899 token_property_permissions100 .try_push(up_data_structs::PropertyKeyPermission {101 key: url_key(),102 permission: up_data_structs::PropertyPermission {103 mutable: false,104 collection_admin: true,105 token_owner: false,106 },107 })108 .map_err(|e| Error::Revert(format!("{:?}", e)))?;109110 if add_properties {111 token_property_permissions112 .try_push(up_data_structs::PropertyKeyPermission {113 key: suffix_key(),114 permission: up_data_structs::PropertyPermission {115 mutable: false,116 collection_admin: true,117 token_owner: false,118 },119 })120 .map_err(|e| Error::Revert(format!("{:?}", e)))?;121122 properties123 .try_push(up_data_structs::Property {124 key: schema_name_key(),125 value: erc721_value(),126 })127 .map_err(|e| Error::Revert(format!("{:?}", e)))?;128129 if !base_uri_value.is_empty() {130 properties131 .try_push(up_data_structs::Property {132 key: base_uri_key(),133 value: base_uri_value,134 })135 .map_err(|e| Error::Revert(format!("{:?}", e)))?;136 }137 }138139 let data = CreateCollectionData {140 name,141 mode,142 description,143 token_prefix,144 token_property_permissions,145 properties,146 ..Default::default()147 };148 Ok(data)149}150151/// @title Contract, which allows users to operate with collections152#[solidity_interface(name = "CollectionHelpers", events(CollectionHelpersEvents))]153impl<T: Config + pallet_nonfungible::Config> EvmCollectionHelpers<T> {154 /// Create an NFT collection155 /// @param name Name of the collection156 /// @param description Informative description of the collection157 /// @param token_prefix Token prefix to represent the collection tokens in UI and user applications158 /// @return address Address of the newly created collection159 #[weight(<SelfWeightOf<T>>::create_collection())]160 fn create_nonfungible_collection(161 &mut self,162 caller: caller,163 name: string,164 description: string,165 token_prefix: string,166 ) -> Result<address> {167 let (caller, name, description, token_prefix, _base_uri_value) =168 convert_data::<T>(caller, name, description, token_prefix, "".into())?;169 let data = make_data::<T>(170 name,171 CollectionMode::NFT,172 description,173 token_prefix,174 Default::default(),175 false,176 )?;177 let collection_id =178 <pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, false)179 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;180181 let address = pallet_common::eth::collection_id_to_address(collection_id);182 Ok(address)183 }184185 #[weight(<SelfWeightOf<T>>::create_collection())]186 #[solidity(rename_selector = "createERC721MetadataCompatibleCollection")]187 fn create_nonfungible_collection_with_properties(188 &mut self,189 caller: caller,190 name: string,191 description: string,192 token_prefix: string,193 base_uri: string,194 ) -> Result<address> {195 let (caller, name, description, token_prefix, base_uri_value) =196 convert_data::<T>(caller, name, description, token_prefix, base_uri)?;197 let data = make_data::<T>(198 name,199 CollectionMode::NFT,200 description,201 token_prefix,202 base_uri_value,203 true,204 )?;205 let collection_id =206 <pallet_nonfungible::Pallet<T>>::init_collection(caller.clone(), data, true)207 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;208209 let address = pallet_common::eth::collection_id_to_address(collection_id);210 Ok(address)211 }212213 /// Check if a collection exists214 /// @param collection_address Address of the collection in question215 /// @return bool Does the collection exist?216 fn is_collection_exist(&self, _caller: caller, collection_address: address) -> Result<bool> {217 if let Some(id) = pallet_common::eth::map_eth_to_id(&collection_address) {218 let collection_id = id;219 return Ok(<CollectionById<T>>::contains_key(collection_id));220 }221222 Ok(false)223 }224}225226/// Implements [`OnMethodCall`], which delegates call to [`EvmCollectionHelpers`]227pub struct CollectionHelpersOnMethodCall<T: Config>(PhantomData<*const T>);228impl<T: Config + pallet_nonfungible::Config> OnMethodCall<T> for CollectionHelpersOnMethodCall<T> {229 fn is_reserved(contract: &sp_core::H160) -> bool {230 contract == &T::ContractAddress::get()231 }232233 fn is_used(contract: &sp_core::H160) -> bool {234 contract == &T::ContractAddress::get()235 }236237 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {238 if handle.code_address() != T::ContractAddress::get() {239 return None;240 }241242 let helpers =243 EvmCollectionHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));244 pallet_evm_coder_substrate::call(handle, helpers)245 }246247 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {248 (contract == &T::ContractAddress::get())249 .then(|| include_bytes!("./stubs/CollectionHelpers.raw").to_vec())250 }251}252253generate_stubgen!(collection_helper_impl, CollectionHelpersCall<()>, true);254generate_stubgen!(collection_helper_iface, CollectionHelpersCall<()>, false);255256fn error_feild_too_long(feild: &str, bound: usize) -> Error {257 Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))258}