git.delta.rocks / unique-network / refs/commits / 916ae427c879

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//! # Nonfungible Pallet EVM API18//!19//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Nonfungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Nonfungible Pallet methods.2122extern crate alloc;23use core::{24	char::{REPLACEMENT_CHARACTER, decode_utf16},25	convert::TryInto,26};27use evm_coder::{28	abi::AbiType, ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*,29	weight,30};31use frame_support::BoundedVec;32use up_data_structs::{33	TokenId, PropertyPermission, PropertyKeyPermission, Property, CollectionId, PropertyKey,34	CollectionPropertiesVec,35};36use pallet_evm_coder_substrate::dispatch_to_evm;37use sp_std::{vec::Vec, vec};38use pallet_common::{39	CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,40	erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},41	eth,42};43use pallet_evm::{account::CrossAccountId, PrecompileHandle};44use pallet_evm_coder_substrate::call;45use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};46use sp_core::Get;4748use crate::{49	AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,50	SelfWeightOf, weights::WeightInfo, TokenProperties,51};5253/// @title A contract that allows to set and delete token properties and change token property permissions.54#[solidity_interface(name = TokenProperties)]55impl<T: Config> NonfungibleHandle<T> {56	/// @notice Set permissions for token property.57	/// @dev Throws error if `msg.sender` is not admin or owner of the collection.58	/// @param key Property key.59	/// @param isMutable Permission to mutate property.60	/// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.61	/// @param tokenOwner Permission to mutate property by token owner if property is mutable.62	#[weight(<SelfWeightOf<T>>::set_token_property_permissions(1))]63	#[solidity(hide)]64	fn set_token_property_permission(65		&mut self,66		caller: caller,67		key: string,68		is_mutable: bool,69		collection_admin: bool,70		token_owner: bool,71	) -> Result<()> {72		let caller = T::CrossAccountId::from_eth(caller);73		<Pallet<T>>::set_token_property_permissions(74			self,75			&caller,76			vec![PropertyKeyPermission {77				key: <Vec<u8>>::from(key)78					.try_into()79					.map_err(|_| "too long key")?,80				permission: PropertyPermission {81					mutable: is_mutable,82					collection_admin,83					token_owner,84				},85			}],86		)87		.map_err(dispatch_to_evm::<T>)88	}8990	/// @notice Set permissions for token property.91	/// @dev Throws error if `msg.sender` is not admin or owner of the collection.92	/// @param permissions Permissions for keys.93	#[weight(<SelfWeightOf<T>>::set_token_property_permissions(permissions.len() as u32))]94	fn set_token_property_permissions(95		&mut self,96		caller: caller,97		permissions: Vec<eth::TokenPropertyPermission>,98	) -> Result<()> {99		let caller = T::CrossAccountId::from_eth(caller);100		let perms = eth::TokenPropertyPermission::into_property_key_permissions(permissions)?;101102		<Pallet<T>>::set_token_property_permissions(self, &caller, perms)103			.map_err(dispatch_to_evm::<T>)104	}105106	/// @notice Get permissions for token properties.107	fn token_property_permissions(&self) -> Result<Vec<eth::TokenPropertyPermission>> {108		let perms = <Pallet<T>>::token_property_permission(self.id);109		Ok(perms110			.into_iter()111			.map(eth::TokenPropertyPermission::from)112			.collect())113	}114115	/// @notice Set token property value.116	/// @dev Throws error if `msg.sender` has no permission to edit the property.117	/// @param tokenId ID of the token.118	/// @param key Property key.119	/// @param value Property value.120	#[solidity(hide)]121	#[weight(<SelfWeightOf<T>>::set_token_properties(1))]122	fn set_property(123		&mut self,124		caller: caller,125		token_id: uint256,126		key: string,127		value: bytes,128	) -> Result<()> {129		let caller = T::CrossAccountId::from_eth(caller);130		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;131		let key = <Vec<u8>>::from(key)132			.try_into()133			.map_err(|_| "key too long")?;134		let value = value.0.try_into().map_err(|_| "value too long")?;135136		let nesting_budget = self137			.recorder138			.weight_calls_budget(<StructureWeight<T>>::find_parent());139140		<Pallet<T>>::set_token_property(141			self,142			&caller,143			TokenId(token_id),144			Property { key, value },145			&nesting_budget,146		)147		.map_err(dispatch_to_evm::<T>)148	}149150	/// @notice Set token properties value.151	/// @dev Throws error if `msg.sender` has no permission to edit the property.152	/// @param tokenId ID of the token.153	/// @param properties settable properties154	#[weight(<SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]155	fn set_properties(156		&mut self,157		caller: caller,158		token_id: uint256,159		properties: Vec<eth::Property>,160	) -> Result<()> {161		let caller = T::CrossAccountId::from_eth(caller);162		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;163164		let nesting_budget = self165			.recorder166			.weight_calls_budget(<StructureWeight<T>>::find_parent());167168		let properties = properties169			.into_iter()170			.map(eth::Property::try_into)171			.collect::<Result<Vec<_>>>()?;172173		<Pallet<T>>::set_token_properties(174			self,175			&caller,176			TokenId(token_id),177			properties.into_iter(),178			false,179			&nesting_budget,180		)181		.map_err(dispatch_to_evm::<T>)182	}183184	/// @notice Delete token property value.185	/// @dev Throws error if `msg.sender` has no permission to edit the property.186	/// @param tokenId ID of the token.187	/// @param key Property key.188	#[solidity(hide)]189	#[weight(<SelfWeightOf<T>>::delete_token_properties(1))]190	fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {191		let caller = T::CrossAccountId::from_eth(caller);192		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;193		let key = <Vec<u8>>::from(key)194			.try_into()195			.map_err(|_| "key too long")?;196197		let nesting_budget = self198			.recorder199			.weight_calls_budget(<StructureWeight<T>>::find_parent());200201		<Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)202			.map_err(dispatch_to_evm::<T>)203	}204205	/// @notice Delete token properties value.206	/// @dev Throws error if `msg.sender` has no permission to edit the property.207	/// @param tokenId ID of the token.208	/// @param keys Properties key.209	#[weight(<SelfWeightOf<T>>::delete_token_properties(keys.len() as u32))]210	fn delete_properties(211		&mut self,212		token_id: uint256,213		caller: caller,214		keys: Vec<string>,215	) -> Result<()> {216		let caller = T::CrossAccountId::from_eth(caller);217		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;218		let keys = keys219			.into_iter()220			.map(|k| Ok(<Vec<u8>>::from(k).try_into().map_err(|_| "key too long")?))221			.collect::<Result<Vec<_>>>()?;222223		let nesting_budget = self224			.recorder225			.weight_calls_budget(<StructureWeight<T>>::find_parent());226227		<Pallet<T>>::delete_token_properties(228			self,229			&caller,230			TokenId(token_id),231			keys.into_iter(),232			&nesting_budget,233		)234		.map_err(dispatch_to_evm::<T>)235	}236237	/// @notice Get token property value.238	/// @dev Throws error if key not found239	/// @param tokenId ID of the token.240	/// @param key Property key.241	/// @return Property value bytes242	fn property(&self, token_id: uint256, key: string) -> Result<bytes> {243		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;244		let key = <Vec<u8>>::from(key)245			.try_into()246			.map_err(|_| "key too long")?;247248		let props = <TokenProperties<T>>::get((self.id, token_id));249		let prop = props.get(&key).ok_or("key not found")?;250251		Ok(prop.to_vec().into())252	}253}254255#[derive(ToLog)]256pub enum ERC721Events {257	/// @dev This emits when ownership of any NFT changes by any mechanism.258	///  This event emits when NFTs are created (`from` == 0) and destroyed259	///  (`to` == 0). Exception: during contract creation, any number of NFTs260	///  may be created and assigned without emitting Transfer. At the time of261	///  any transfer, the approved address for that NFT (if any) is reset to none.262	Transfer {263		#[indexed]264		from: address,265		#[indexed]266		to: address,267		#[indexed]268		token_id: uint256,269	},270	/// @dev This emits when the approved address for an NFT is changed or271	///  reaffirmed. The zero address indicates there is no approved address.272	///  When a Transfer event emits, this also indicates that the approved273	///  address for that NFT (if any) is reset to none.274	Approval {275		#[indexed]276		owner: address,277		#[indexed]278		approved: address,279		#[indexed]280		token_id: uint256,281	},282	/// @dev This emits when an operator is enabled or disabled for an owner.283	///  The operator can manage all NFTs of the owner.284	#[allow(dead_code)]285	ApprovalForAll {286		#[indexed]287		owner: address,288		#[indexed]289		operator: address,290		approved: bool,291	},292}293294#[derive(ToLog)]295pub enum ERC721UniqueMintableEvents {296	#[allow(dead_code)]297	MintingFinished {},298}299300/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension301/// @dev See https://eips.ethereum.org/EIPS/eip-721302#[solidity_interface(name = ERC721Metadata, expect_selector = 0x5b5e139f)]303impl<T: Config> NonfungibleHandle<T>304where305	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,306{307	/// @notice A descriptive name for a collection of NFTs in this contract308	/// @dev real implementation of this function lies in `ERC721UniqueExtensions`309	#[solidity(hide, rename_selector = "name")]310	fn name_proxy(&self) -> Result<string> {311		self.name()312	}313314	/// @notice An abbreviated name for NFTs in this contract315	/// @dev real implementation of this function lies in `ERC721UniqueExtensions`316	#[solidity(hide, rename_selector = "symbol")]317	fn symbol_proxy(&self) -> Result<string> {318		self.symbol()319	}320321	/// @notice A distinct Uniform Resource Identifier (URI) for a given asset.322	///323	/// @dev If the token has a `url` property and it is not empty, it is returned.324	///  Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.325	///  If the collection property `baseURI` is empty or absent, return "" (empty string)326	///  otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix327	///  otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).328	///329	/// @return token's const_metadata330	#[solidity(rename_selector = "tokenURI")]331	fn token_uri(&self, token_id: uint256) -> Result<string> {332		let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;333334		match get_token_property(self, token_id_u32, &key::url()).as_deref() {335			Err(_) | Ok("") => (),336			Ok(url) => {337				return Ok(url.into());338			}339		};340341		let base_uri =342			pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())343				.map(BoundedVec::into_inner)344				.map(string::from_utf8)345				.transpose()346				.map_err(|e| {347					Error::Revert(alloc::format!(348						"Can not convert value \"baseURI\" to string with error \"{}\"",349						e350					))351				})?;352353		let base_uri = match base_uri.as_deref() {354			None | Some("") => {355				return Ok("".into());356			}357			Some(base_uri) => base_uri.into(),358		};359360		Ok(361			match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {362				Err(_) | Ok("") => base_uri,363				Ok(suffix) => base_uri + suffix,364			},365		)366	}367}368369/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension370/// @dev See https://eips.ethereum.org/EIPS/eip-721371#[solidity_interface(name = ERC721Enumerable, expect_selector = 0x780e9d63)]372impl<T: Config> NonfungibleHandle<T> {373	/// @notice Enumerate valid NFTs374	/// @param index A counter less than `totalSupply()`375	/// @return The token identifier for the `index`th NFT,376	///  (sort order not specified)377	fn token_by_index(&self, index: uint256) -> Result<uint256> {378		Ok(index)379	}380381	/// @dev Not implemented382	fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {383		// TODO: Not implemetable384		Err("not implemented".into())385	}386387	/// @notice Count NFTs tracked by this contract388	/// @return A count of valid NFTs tracked by this contract, where each one of389	///  them has an assigned and queryable owner not equal to the zero address390	fn total_supply(&self) -> Result<uint256> {391		self.consume_store_reads(1)?;392		Ok(<Pallet<T>>::total_supply(self).into())393	}394}395396/// @title ERC-721 Non-Fungible Token Standard397/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md398#[solidity_interface(name = ERC721, events(ERC721Events), expect_selector = 0x80ac58cd)]399impl<T: Config> NonfungibleHandle<T> {400	/// @notice Count all NFTs assigned to an owner401	/// @dev NFTs assigned to the zero address are considered invalid, and this402	///  function throws for queries about the zero address.403	/// @param owner An address for whom to query the balance404	/// @return The number of NFTs owned by `owner`, possibly zero405	fn balance_of(&self, owner: address) -> Result<uint256> {406		self.consume_store_reads(1)?;407		let owner = T::CrossAccountId::from_eth(owner);408		let balance = <AccountBalance<T>>::get((self.id, owner));409		Ok(balance.into())410	}411	/// @notice Find the owner of an NFT412	/// @dev NFTs assigned to zero address are considered invalid, and queries413	///  about them do throw.414	/// @param tokenId The identifier for an NFT415	/// @return The address of the owner of the NFT416	fn owner_of(&self, token_id: uint256) -> Result<address> {417		self.consume_store_reads(1)?;418		let token: TokenId = token_id.try_into()?;419		Ok(*<TokenData<T>>::get((self.id, token))420			.ok_or("token not found")?421			.owner422			.as_eth())423	}424	/// @dev Not implemented425	#[solidity(rename_selector = "safeTransferFrom")]426	fn safe_transfer_from_with_data(427		&mut self,428		_from: address,429		_to: address,430		_token_id: uint256,431		_data: bytes,432	) -> Result<void> {433		// TODO: Not implemetable434		Err("not implemented".into())435	}436	/// @dev Not implemented437	fn safe_transfer_from(438		&mut self,439		_from: address,440		_to: address,441		_token_id: uint256,442	) -> Result<void> {443		// TODO: Not implemetable444		Err("not implemented".into())445	}446447	/// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE448	///  TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE449	///  THEY MAY BE PERMANENTLY LOST450	/// @dev Throws unless `msg.sender` is the current owner or an authorized451	///  operator for this NFT. Throws if `from` is not the current owner. Throws452	///  if `to` is the zero address. Throws if `tokenId` is not a valid NFT.453	/// @param from The current owner of the NFT454	/// @param to The new owner455	/// @param tokenId The NFT to transfer456	#[weight(<SelfWeightOf<T>>::transfer_from())]457	fn transfer_from(458		&mut self,459		caller: caller,460		from: address,461		to: address,462		token_id: uint256,463	) -> Result<void> {464		let caller = T::CrossAccountId::from_eth(caller);465		let from = T::CrossAccountId::from_eth(from);466		let to = T::CrossAccountId::from_eth(to);467		let token = token_id.try_into()?;468		let budget = self469			.recorder470			.weight_calls_budget(<StructureWeight<T>>::find_parent());471472		<Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)473			.map_err(dispatch_to_evm::<T>)?;474		Ok(())475	}476477	/// @notice Set or reaffirm the approved address for an NFT478	/// @dev The zero address indicates there is no approved address.479	/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized480	///  operator of the current owner.481	/// @param approved The new approved NFT controller482	/// @param tokenId The NFT to approve483	#[weight(<SelfWeightOf<T>>::approve())]484	fn approve(&mut self, caller: caller, approved: address, token_id: uint256) -> Result<void> {485		let caller = T::CrossAccountId::from_eth(caller);486		let approved = T::CrossAccountId::from_eth(approved);487		let token = token_id.try_into()?;488489		<Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))490			.map_err(dispatch_to_evm::<T>)?;491		Ok(())492	}493494	/// @notice Sets or unsets the approval of a given operator.495	/// The `operator` is allowed to transfer all tokens of the `caller` on their behalf.496	/// @param operator Operator497	/// @param approved Should operator status be granted or revoked?498	#[weight(<SelfWeightOf<T>>::set_allowance_for_all())]499	fn set_approval_for_all(500		&mut self,501		caller: caller,502		operator: address,503		approved: bool,504	) -> Result<void> {505		let caller = T::CrossAccountId::from_eth(caller);506		let operator = T::CrossAccountId::from_eth(operator);507508		<Pallet<T>>::set_allowance_for_all(self, &caller, &operator, approved)509			.map_err(dispatch_to_evm::<T>)?;510		Ok(())511	}512513	/// @dev Not implemented514	fn get_approved(&self, _token_id: uint256) -> Result<address> {515		// TODO: Not implemetable516		Err("not implemented".into())517	}518519	/// @notice Tells whether the given `owner` approves the `operator`.520	#[weight(<SelfWeightOf<T>>::allowance_for_all())]521	fn is_approved_for_all(&self, owner: address, operator: address) -> Result<bool> {522		let owner = T::CrossAccountId::from_eth(owner);523		let operator = T::CrossAccountId::from_eth(operator);524525		Ok(<Pallet<T>>::allowance_for_all(self, &owner, &operator))526	}527}528529/// @title ERC721 Token that can be irreversibly burned (destroyed).530#[solidity_interface(name = ERC721Burnable)]531impl<T: Config> NonfungibleHandle<T> {532	/// @notice Burns a specific ERC721 token.533	/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized534	///  operator of the current owner.535	/// @param tokenId The NFT to approve536	#[weight(<SelfWeightOf<T>>::burn_item())]537	fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {538		let caller = T::CrossAccountId::from_eth(caller);539		let token = token_id.try_into()?;540541		<Pallet<T>>::burn(self, &caller, token).map_err(dispatch_to_evm::<T>)?;542		Ok(())543	}544}545546/// @title ERC721 minting logic.547#[solidity_interface(name = ERC721UniqueMintable, events(ERC721UniqueMintableEvents))]548impl<T: Config> NonfungibleHandle<T> {549	fn minting_finished(&self) -> Result<bool> {550		Ok(false)551	}552553	/// @notice Function to mint a token.554	/// @param to The new owner555	/// @return uint256 The id of the newly minted token556	#[weight(<SelfWeightOf<T>>::create_item())]557	fn mint(&mut self, caller: caller, to: address) -> Result<uint256> {558		let token_id: uint256 = <TokensMinted<T>>::get(self.id)559			.checked_add(1)560			.ok_or("item id overflow")?561			.into();562		self.mint_check_id(caller, to, token_id)?;563		Ok(token_id)564	}565566	/// @notice Function to mint a token.567	/// @dev `tokenId` should be obtained with `nextTokenId` method,568	///  unlike standard, you can't specify it manually569	/// @param to The new owner570	/// @param tokenId ID of the minted NFT571	#[solidity(hide, rename_selector = "mint")]572	#[weight(<SelfWeightOf<T>>::create_item())]573	fn mint_check_id(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {574		let caller = T::CrossAccountId::from_eth(caller);575		let to = T::CrossAccountId::from_eth(to);576		let token_id: u32 = token_id.try_into()?;577		let budget = self578			.recorder579			.weight_calls_budget(<StructureWeight<T>>::find_parent());580581		if <TokensMinted<T>>::get(self.id)582			.checked_add(1)583			.ok_or("item id overflow")?584			!= token_id585		{586			return Err("item id should be next".into());587		}588589		<Pallet<T>>::create_item(590			self,591			&caller,592			CreateItemData::<T> {593				properties: BoundedVec::default(),594				owner: to,595			},596			&budget,597		)598		.map_err(dispatch_to_evm::<T>)?;599600		Ok(true)601	}602603	/// @notice Function to mint token with the given tokenUri.604	/// @param to The new owner605	/// @param tokenUri Token URI that would be stored in the NFT properties606	/// @return uint256 The id of the newly minted token607	#[solidity(rename_selector = "mintWithTokenURI")]608	#[weight(<SelfWeightOf<T>>::create_item())]609	fn mint_with_token_uri(610		&mut self,611		caller: caller,612		to: address,613		token_uri: string,614	) -> Result<uint256> {615		let token_id: uint256 = <TokensMinted<T>>::get(self.id)616			.checked_add(1)617			.ok_or("item id overflow")?618			.into();619		self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;620		Ok(token_id)621	}622623	/// @notice Function to mint token with the given tokenUri.624	/// @dev `tokenId` should be obtained with `nextTokenId` method,625	///  unlike standard, you can't specify it manually626	/// @param to The new owner627	/// @param tokenId ID of the minted NFT628	/// @param tokenUri Token URI that would be stored in the NFT properties629	#[solidity(hide, rename_selector = "mintWithTokenURI")]630	#[weight(<SelfWeightOf<T>>::create_item())]631	fn mint_with_token_uri_check_id(632		&mut self,633		caller: caller,634		to: address,635		token_id: uint256,636		token_uri: string,637	) -> Result<bool> {638		let key = key::url();639		let permission = get_token_permission::<T>(self.id, &key)?;640		if !permission.collection_admin {641			return Err("Operation is not allowed".into());642		}643644		let caller = T::CrossAccountId::from_eth(caller);645		let to = T::CrossAccountId::from_eth(to);646		let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;647		let budget = self648			.recorder649			.weight_calls_budget(<StructureWeight<T>>::find_parent());650651		if <TokensMinted<T>>::get(self.id)652			.checked_add(1)653			.ok_or("item id overflow")?654			!= token_id655		{656			return Err("item id should be next".into());657		}658659		let mut properties = CollectionPropertiesVec::default();660		properties661			.try_push(Property {662				key,663				value: token_uri664					.into_bytes()665					.try_into()666					.map_err(|_| "token uri is too long")?,667			})668			.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;669670		<Pallet<T>>::create_item(671			self,672			&caller,673			CreateItemData::<T> {674				properties,675				owner: to,676			},677			&budget,678		)679		.map_err(dispatch_to_evm::<T>)?;680		Ok(true)681	}682683	/// @dev Not implemented684	fn finish_minting(&mut self, _caller: caller) -> Result<bool> {685		Err("not implementable".into())686	}687}688689fn get_token_property<T: Config>(690	collection: &CollectionHandle<T>,691	token_id: u32,692	key: &up_data_structs::PropertyKey,693) -> Result<string> {694	collection.consume_store_reads(1)?;695	let properties = <TokenProperties<T>>::try_get((collection.id, token_id))696		.map_err(|_| Error::Revert("Token properties not found".into()))?;697	if let Some(property) = properties.get(key) {698		return Ok(string::from_utf8_lossy(property).into());699	}700701	Err("Property tokenURI not found".into())702}703704fn get_token_permission<T: Config>(705	collection_id: CollectionId,706	key: &PropertyKey,707) -> Result<PropertyPermission> {708	let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)709		.map_err(|_| Error::Revert("No permissions for collection".into()))?;710	let a = token_property_permissions711		.get(key)712		.map(Clone::clone)713		.ok_or_else(|| {714			let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();715			Error::Revert(alloc::format!("No permission for key {}", key))716		})?;717	Ok(a)718}719720/// @title Unique extensions for ERC721.721#[solidity_interface(name = ERC721UniqueExtensions)]722impl<T: Config> NonfungibleHandle<T>723where724	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,725{726	/// @notice A descriptive name for a collection of NFTs in this contract727	fn name(&self) -> Result<string> {728		Ok(decode_utf16(self.name.iter().copied())729			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))730			.collect::<string>())731	}732733	/// @notice An abbreviated name for NFTs in this contract734	fn symbol(&self) -> Result<string> {735		Ok(string::from_utf8_lossy(&self.token_prefix).into())736	}737738	/// @notice A description for the collection.739	fn description(&self) -> Result<string> {740		Ok(decode_utf16(self.description.iter().copied())741			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))742			.collect::<string>())743	}744745	/// Returns the owner (in cross format) of the token.746	///747	/// @param tokenId Id for the token.748	fn cross_owner_of(&self, token_id: uint256) -> Result<eth::CrossAddress> {749		Self::token_owner(&self, token_id.try_into()?)750			.map(|o| eth::CrossAddress::from_sub_cross_account::<T>(&o))751			.ok_or(Error::Revert("key too large".into()))752	}753754	/// Returns the token properties.755	///756	/// @param tokenId Id for the token.757	/// @param keys Properties keys. Empty keys for all propertyes.758	/// @return Vector of properties key/value pairs.759	fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<eth::Property>> {760		let keys = keys761			.into_iter()762			.map(|key| {763				<Vec<u8>>::from(key)764					.try_into()765					.map_err(|_| Error::Revert("key too large".into()))766			})767			.collect::<Result<Vec<_>>>()?;768769		<Self as CommonCollectionOperations<T>>::token_properties(770			&self,771			token_id.try_into()?,772			if keys.is_empty() { None } else { Some(keys) },773		)774		.into_iter()775		.map(eth::Property::try_from)776		.collect::<Result<Vec<_>>>()777	}778779	/// @notice Set or reaffirm the approved address for an NFT780	/// @dev The zero address indicates there is no approved address.781	/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized782	///  operator of the current owner.783	/// @param approved The new substrate address approved NFT controller784	/// @param tokenId The NFT to approve785	#[weight(<SelfWeightOf<T>>::approve())]786	fn approve_cross(787		&mut self,788		caller: caller,789		approved: eth::CrossAddress,790		token_id: uint256,791	) -> Result<void> {792		let caller = T::CrossAccountId::from_eth(caller);793		let approved = approved.into_sub_cross_account::<T>()?;794		let token = token_id.try_into()?;795796		<Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))797			.map_err(dispatch_to_evm::<T>)?;798		Ok(())799	}800801	/// @notice Transfer ownership of an NFT802	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`803	///  is the zero address. Throws if `tokenId` is not a valid NFT.804	/// @param to The new owner805	/// @param tokenId The NFT to transfer806	#[weight(<SelfWeightOf<T>>::transfer())]807	fn transfer(&mut self, caller: caller, to: address, token_id: uint256) -> Result<void> {808		let caller = T::CrossAccountId::from_eth(caller);809		let to = T::CrossAccountId::from_eth(to);810		let token = token_id.try_into()?;811		let budget = self812			.recorder813			.weight_calls_budget(<StructureWeight<T>>::find_parent());814815		<Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;816		Ok(())817	}818819	/// @notice Transfer ownership of an NFT820	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`821	///  is the zero address. Throws if `tokenId` is not a valid NFT.822	/// @param to The new owner823	/// @param tokenId The NFT to transfer824	#[weight(<SelfWeightOf<T>>::transfer())]825	fn transfer_cross(826		&mut self,827		caller: caller,828		to: eth::CrossAddress,829		token_id: uint256,830	) -> Result<void> {831		let caller = T::CrossAccountId::from_eth(caller);832		let to = to.into_sub_cross_account::<T>()?;833		let token = token_id.try_into()?;834		let budget = self835			.recorder836			.weight_calls_budget(<StructureWeight<T>>::find_parent());837838		<Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;839		Ok(())840	}841842	/// @notice Transfer ownership of an NFT from cross account address to cross account address843	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`844	///  is the zero address. Throws if `tokenId` is not a valid NFT.845	/// @param from Cross acccount address of current owner846	/// @param to Cross acccount address of new owner847	/// @param tokenId The NFT to transfer848	#[weight(<SelfWeightOf<T>>::transfer())]849	fn transfer_from_cross(850		&mut self,851		caller: caller,852		from: eth::CrossAddress,853		to: eth::CrossAddress,854		token_id: uint256,855	) -> Result<void> {856		let caller = T::CrossAccountId::from_eth(caller);857		let from = from.into_sub_cross_account::<T>()?;858		let to = to.into_sub_cross_account::<T>()?;859		let token_id = token_id.try_into()?;860		let budget = self861			.recorder862			.weight_calls_budget(<StructureWeight<T>>::find_parent());863		Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, &budget)864			.map_err(dispatch_to_evm::<T>)?;865		Ok(())866	}867868	/// @notice Burns a specific ERC721 token.869	/// @dev Throws unless `msg.sender` is the current owner or an authorized870	///  operator for this NFT. Throws if `from` is not the current owner. Throws871	///  if `to` is the zero address. Throws if `tokenId` is not a valid NFT.872	/// @param from The current owner of the NFT873	/// @param tokenId The NFT to transfer874	#[solidity(hide)]875	#[weight(<SelfWeightOf<T>>::burn_from())]876	fn burn_from(&mut self, caller: caller, from: address, token_id: uint256) -> Result<void> {877		let caller = T::CrossAccountId::from_eth(caller);878		let from = T::CrossAccountId::from_eth(from);879		let token = token_id.try_into()?;880		let budget = self881			.recorder882			.weight_calls_budget(<StructureWeight<T>>::find_parent());883884		<Pallet<T>>::burn_from(self, &caller, &from, token, &budget)885			.map_err(dispatch_to_evm::<T>)?;886		Ok(())887	}888889	/// @notice Burns a specific ERC721 token.890	/// @dev Throws unless `msg.sender` is the current owner or an authorized891	///  operator for this NFT. Throws if `from` is not the current owner. Throws892	///  if `to` is the zero address. Throws if `tokenId` is not a valid NFT.893	/// @param from The current owner of the NFT894	/// @param tokenId The NFT to transfer895	#[weight(<SelfWeightOf<T>>::burn_from())]896	fn burn_from_cross(897		&mut self,898		caller: caller,899		from: eth::CrossAddress,900		token_id: uint256,901	) -> Result<void> {902		let caller = T::CrossAccountId::from_eth(caller);903		let from = from.into_sub_cross_account::<T>()?;904		let token = token_id.try_into()?;905		let budget = self906			.recorder907			.weight_calls_budget(<StructureWeight<T>>::find_parent());908909		<Pallet<T>>::burn_from(self, &caller, &from, token, &budget)910			.map_err(dispatch_to_evm::<T>)?;911		Ok(())912	}913914	/// @notice Returns next free NFT ID.915	fn next_token_id(&self) -> Result<uint256> {916		self.consume_store_reads(1)?;917		Ok(<TokensMinted<T>>::get(self.id)918			.checked_add(1)919			.ok_or("item id overflow")?920			.into())921	}922923	/// @notice Function to mint multiple tokens.924	/// @dev `tokenIds` should be an array of consecutive numbers and first number925	///  should be obtained with `nextTokenId` method926	/// @param to The new owner927	/// @param tokenIds IDs of the minted NFTs928	#[solidity(hide)]929	#[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]930	fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {931		let caller = T::CrossAccountId::from_eth(caller);932		let to = T::CrossAccountId::from_eth(to);933		let mut expected_index = <TokensMinted<T>>::get(self.id)934			.checked_add(1)935			.ok_or("item id overflow")?;936		let budget = self937			.recorder938			.weight_calls_budget(<StructureWeight<T>>::find_parent());939940		let total_tokens = token_ids.len();941		for id in token_ids.into_iter() {942			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;943			if id != expected_index {944				return Err("item id should be next".into());945			}946			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;947		}948		let data = (0..total_tokens)949			.map(|_| CreateItemData::<T> {950				properties: BoundedVec::default(),951				owner: to.clone(),952			})953			.collect();954955		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)956			.map_err(dispatch_to_evm::<T>)?;957		Ok(true)958	}959960	/// @notice Function to mint multiple tokens with the given tokenUris.961	/// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive962	///  numbers and first number should be obtained with `nextTokenId` method963	/// @param to The new owner964	/// @param tokens array of pairs of token ID and token URI for minted tokens965	#[solidity(hide, rename_selector = "mintBulkWithTokenURI")]966	#[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]967	fn mint_bulk_with_token_uri(968		&mut self,969		caller: caller,970		to: address,971		tokens: Vec<(uint256, string)>,972	) -> Result<bool> {973		let key = key::url();974		let caller = T::CrossAccountId::from_eth(caller);975		let to = T::CrossAccountId::from_eth(to);976		let mut expected_index = <TokensMinted<T>>::get(self.id)977			.checked_add(1)978			.ok_or("item id overflow")?;979		let budget = self980			.recorder981			.weight_calls_budget(<StructureWeight<T>>::find_parent());982983		let mut data = Vec::with_capacity(tokens.len());984		for (id, token_uri) in tokens {985			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;986			if id != expected_index {987				return Err("item id should be next".into());988			}989			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;990991			let mut properties = CollectionPropertiesVec::default();992			properties993				.try_push(Property {994					key: key.clone(),995					value: token_uri996						.into_bytes()997						.try_into()998						.map_err(|_| "token uri is too long")?,999				})1000				.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;10011002			data.push(CreateItemData::<T> {1003				properties,1004				owner: to.clone(),1005			});1006		}10071008		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1009			.map_err(dispatch_to_evm::<T>)?;1010		Ok(true)1011	}10121013	/// @notice Function to mint a token.1014	/// @param to The new owner crossAccountId1015	/// @param properties Properties of minted token1016	/// @return uint256 The id of the newly minted token1017	#[weight(<SelfWeightOf<T>>::create_item())]1018	fn mint_cross(1019		&mut self,1020		caller: caller,1021		to: eth::CrossAddress,1022		properties: Vec<eth::Property>,1023	) -> Result<uint256> {1024		let token_id = <TokensMinted<T>>::get(self.id)1025			.checked_add(1)1026			.ok_or("item id overflow")?;10271028		let to = to.into_sub_cross_account::<T>()?;10291030		let properties = properties1031			.into_iter()1032			.map(eth::Property::try_into)1033			.collect::<Result<Vec<_>>>()?1034			.try_into()1035			.map_err(|_| Error::Revert(alloc::format!("too many properties")))?;10361037		let caller = T::CrossAccountId::from_eth(caller);10381039		let budget = self1040			.recorder1041			.weight_calls_budget(<StructureWeight<T>>::find_parent());10421043		<Pallet<T>>::create_item(1044			self,1045			&caller,1046			CreateItemData::<T> {1047				properties,1048				owner: to,1049			},1050			&budget,1051		)1052		.map_err(dispatch_to_evm::<T>)?;10531054		Ok(token_id.into())1055	}10561057	/// @notice Returns collection helper contract address1058	fn collection_helper_address(&self) -> Result<address> {1059		Ok(T::ContractAddress::get())1060	}1061}10621063#[solidity_interface(1064	name = UniqueNFT,1065	is(1066		ERC721,1067		ERC721Enumerable,1068		ERC721UniqueExtensions,1069		ERC721UniqueMintable,1070		ERC721Burnable,1071		ERC721Metadata(if(this.flags.erc721metadata)),1072		Collection(via(common_mut returns CollectionHandle<T>)),1073		TokenProperties,1074	)1075)]1076impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}10771078// Not a tests, but code generators1079generate_stubgen!(gen_impl, UniqueNFTCall<()>, true);1080generate_stubgen!(gen_iface, UniqueNFTCall<()>, false);10811082impl<T: Config> CommonEvmHandler for NonfungibleHandle<T>1083where1084	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1085{1086	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueNFT.raw");10871088	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {1089		call::<T, UniqueNFTCall<T>, _, _>(handle, self)1090	}1091}