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

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//! # Refungible Pallet EVM API for tokens18//!19//! Provides ERC-721 standart support implementation and EVM API for unique extensions for Refungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Refungible Pallet methods.2122extern crate alloc;2324use core::{25	char::{REPLACEMENT_CHARACTER, decode_utf16},26	convert::TryInto,27};28use evm_coder::{29	abi::AbiType, ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*,30	types::Property as PropertyStruct, weight,31};32use frame_support::{BoundedBTreeMap, BoundedVec};33use pallet_common::{34	CollectionHandle, CollectionPropertyPermissions,35	erc::{CommonEvmHandler, CollectionCall, static_property::key},36	CommonCollectionOperations,37};38use pallet_evm::{account::CrossAccountId, PrecompileHandle};39use pallet_evm_coder_substrate::{call, dispatch_to_evm};40use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};41use sp_core::{H160, Get};42use sp_std::{collections::btree_map::BTreeMap, vec::Vec, vec};43use up_data_structs::{44	CollectionId, CollectionPropertiesVec, mapping::TokenAddressMapping, Property, PropertyKey,45	PropertyKeyPermission, PropertyPermission, TokenId,46};4748use crate::{49	AccountBalance, Balance, Config, CreateItemData, Pallet, RefungibleHandle, SelfWeightOf,50	TokenProperties, TokensMinted, TotalSupply, weights::WeightInfo,51};5253pub const ADDRESS_FOR_PARTIALLY_OWNED_TOKENS: H160 = H160::repeat_byte(0xff);5455/// @title A contract that allows to set and delete token properties and change token property permissions.56#[solidity_interface(name = TokenProperties)]57impl<T: Config> RefungibleHandle<T> {58	/// @notice Set permissions for token property.59	/// @dev Throws error if `msg.sender` is not admin or owner of the collection.60	/// @param key Property key.61	/// @param isMutable Permission to mutate property.62	/// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.63	/// @param tokenOwner Permission to mutate property by token owner if property is mutable.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 token property value.91	/// @dev Throws error if `msg.sender` has no permission to edit the property.92	/// @param tokenId ID of the token.93	/// @param key Property key.94	/// @param value Property value.95	#[solidity(hide)]96	fn set_property(97		&mut self,98		caller: caller,99		token_id: uint256,100		key: string,101		value: bytes,102	) -> Result<()> {103		let caller = T::CrossAccountId::from_eth(caller);104		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;105		let key = <Vec<u8>>::from(key)106			.try_into()107			.map_err(|_| "key too long")?;108		let value = value.0.try_into().map_err(|_| "value too long")?;109110		let nesting_budget = self111			.recorder112			.weight_calls_budget(<StructureWeight<T>>::find_parent());113114		<Pallet<T>>::set_token_property(115			self,116			&caller,117			TokenId(token_id),118			Property { key, value },119			&nesting_budget,120		)121		.map_err(dispatch_to_evm::<T>)122	}123124	/// @notice Set token properties value.125	/// @dev Throws error if `msg.sender` has no permission to edit the property.126	/// @param tokenId ID of the token.127	/// @param properties settable properties128	fn set_properties(129		&mut self,130		caller: caller,131		token_id: uint256,132		properties: Vec<PropertyStruct>,133	) -> Result<()> {134		let caller = T::CrossAccountId::from_eth(caller);135		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;136137		let nesting_budget = self138			.recorder139			.weight_calls_budget(<StructureWeight<T>>::find_parent());140141		let properties = properties142			.into_iter()143			.map(|PropertyStruct { key, value }| {144				let key = <Vec<u8>>::from(key)145					.try_into()146					.map_err(|_| "key too large")?;147148				let value = value.0.try_into().map_err(|_| "value too large")?;149150				Ok(Property { key, value })151			})152			.collect::<Result<Vec<_>>>()?;153154		<Pallet<T>>::set_token_properties(155			self,156			&caller,157			TokenId(token_id),158			properties.into_iter(),159			<Pallet<T>>::token_exists(&self, TokenId(token_id)),160			&nesting_budget,161		)162		.map_err(dispatch_to_evm::<T>)163	}164165	/// @notice Delete token property value.166	/// @dev Throws error if `msg.sender` has no permission to edit the property.167	/// @param tokenId ID of the token.168	/// @param key Property key.169	#[solidity(hide)]170	fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {171		let caller = T::CrossAccountId::from_eth(caller);172		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;173		let key = <Vec<u8>>::from(key)174			.try_into()175			.map_err(|_| "key too long")?;176177		let nesting_budget = self178			.recorder179			.weight_calls_budget(<StructureWeight<T>>::find_parent());180181		<Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)182			.map_err(dispatch_to_evm::<T>)183	}184185	/// @notice Delete token properties value.186	/// @dev Throws error if `msg.sender` has no permission to edit the property.187	/// @param tokenId ID of the token.188	/// @param keys Properties key.189	fn delete_properties(190		&mut self,191		token_id: uint256,192		caller: caller,193		keys: Vec<string>,194	) -> Result<()> {195		let caller = T::CrossAccountId::from_eth(caller);196		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;197		let keys = keys198			.into_iter()199			.map(|k| Ok(<Vec<u8>>::from(k).try_into().map_err(|_| "key too long")?))200			.collect::<Result<Vec<_>>>()?;201202		let nesting_budget = self203			.recorder204			.weight_calls_budget(<StructureWeight<T>>::find_parent());205206		<Pallet<T>>::delete_token_properties(207			self,208			&caller,209			TokenId(token_id),210			keys.into_iter(),211			&nesting_budget,212		)213		.map_err(dispatch_to_evm::<T>)214	}215216	/// @notice Get token property value.217	/// @dev Throws error if key not found218	/// @param tokenId ID of the token.219	/// @param key Property key.220	/// @return Property value bytes221	fn property(&self, token_id: uint256, key: string) -> Result<bytes> {222		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;223		let key = <Vec<u8>>::from(key)224			.try_into()225			.map_err(|_| "key too long")?;226227		let props = <TokenProperties<T>>::get((self.id, token_id));228		let prop = props.get(&key).ok_or("key not found")?;229230		Ok(prop.to_vec().into())231	}232}233234#[derive(ToLog)]235pub enum ERC721Events {236	/// @dev This event emits when NFTs are created (`from` == 0) and destroyed237	///  (`to` == 0). Exception: during contract creation, any number of RFTs238	///  may be created and assigned without emitting Transfer.239	Transfer {240		#[indexed]241		from: address,242		#[indexed]243		to: address,244		#[indexed]245		token_id: uint256,246	},247	/// @dev Not supported248	Approval {249		#[indexed]250		owner: address,251		#[indexed]252		approved: address,253		#[indexed]254		token_id: uint256,255	},256	/// @dev Not supported257	#[allow(dead_code)]258	ApprovalForAll {259		#[indexed]260		owner: address,261		#[indexed]262		operator: address,263		approved: bool,264	},265}266267#[derive(ToLog)]268pub enum ERC721UniqueMintableEvents {269	/// @dev Not supported270	#[allow(dead_code)]271	MintingFinished {},272}273274#[solidity_interface(name = ERC721Metadata)]275impl<T: Config> RefungibleHandle<T>276where277	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,278{279	/// @notice A descriptive name for a collection of NFTs in this contract280	/// @dev real implementation of this function lies in `ERC721UniqueExtensions`281	#[solidity(hide, rename_selector = "name")]282	fn name_proxy(&self) -> Result<string> {283		self.name()284	}285286	/// @notice An abbreviated name for NFTs in this contract287	/// @dev real implementation of this function lies in `ERC721UniqueExtensions`288	#[solidity(hide, rename_selector = "symbol")]289	fn symbol_proxy(&self) -> Result<string> {290		self.symbol()291	}292293	/// @notice A distinct Uniform Resource Identifier (URI) for a given asset.294	///295	/// @dev If the token has a `url` property and it is not empty, it is returned.296	///  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`.297	///  If the collection property `baseURI` is empty or absent, return "" (empty string)298	///  otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix299	///  otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).300	///301	/// @return token's const_metadata302	#[solidity(rename_selector = "tokenURI")]303	fn token_uri(&self, token_id: uint256) -> Result<string> {304		let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;305306		match get_token_property(self, token_id_u32, &key::url()).as_deref() {307			Err(_) | Ok("") => (),308			Ok(url) => {309				return Ok(url.into());310			}311		};312313		let base_uri =314			pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())315				.map(BoundedVec::into_inner)316				.map(string::from_utf8)317				.transpose()318				.map_err(|e| {319					Error::Revert(alloc::format!(320						"Can not convert value \"baseURI\" to string with error \"{}\"",321						e322					))323				})?;324325		let base_uri = match base_uri.as_deref() {326			None | Some("") => {327				return Ok("".into());328			}329			Some(base_uri) => base_uri.into(),330		};331332		Ok(333			match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {334				Err(_) | Ok("") => base_uri,335				Ok(suffix) => base_uri + suffix,336			},337		)338	}339}340341/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension342/// @dev See https://eips.ethereum.org/EIPS/eip-721343#[solidity_interface(name = ERC721Enumerable)]344impl<T: Config> RefungibleHandle<T> {345	/// @notice Enumerate valid RFTs346	/// @param index A counter less than `totalSupply()`347	/// @return The token identifier for the `index`th NFT,348	///  (sort order not specified)349	fn token_by_index(&self, index: uint256) -> Result<uint256> {350		Ok(index)351	}352353	/// Not implemented354	fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {355		// TODO: Not implemetable356		Err("not implemented".into())357	}358359	/// @notice Count RFTs tracked by this contract360	/// @return A count of valid RFTs tracked by this contract, where each one of361	///  them has an assigned and queryable owner not equal to the zero address362	fn total_supply(&self) -> Result<uint256> {363		self.consume_store_reads(1)?;364		Ok(<Pallet<T>>::total_supply(self).into())365	}366}367368/// @title ERC-721 Non-Fungible Token Standard369/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md370#[solidity_interface(name = ERC721, events(ERC721Events))]371impl<T: Config> RefungibleHandle<T> {372	/// @notice Count all RFTs assigned to an owner373	/// @dev RFTs assigned to the zero address are considered invalid, and this374	///  function throws for queries about the zero address.375	/// @param owner An address for whom to query the balance376	/// @return The number of RFTs owned by `owner`, possibly zero377	fn balance_of(&self, owner: address) -> Result<uint256> {378		self.consume_store_reads(1)?;379		let owner = T::CrossAccountId::from_eth(owner);380		let balance = <AccountBalance<T>>::get((self.id, owner));381		Ok(balance.into())382	}383384	/// @notice Find the owner of an RFT385	/// @dev RFTs assigned to zero address are considered invalid, and queries386	///  about them do throw.387	///  Returns special 0xffffffffffffffffffffffffffffffffffffffff address for388	///  the tokens that are partially owned.389	/// @param tokenId The identifier for an RFT390	/// @return The address of the owner of the RFT391	fn owner_of(&self, token_id: uint256) -> Result<address> {392		self.consume_store_reads(2)?;393		let token = token_id.try_into()?;394		let owner = <Pallet<T>>::token_owner(self.id, token);395		Ok(owner396			.map(|address| *address.as_eth())397			.unwrap_or_else(|| ADDRESS_FOR_PARTIALLY_OWNED_TOKENS))398	}399400	/// @dev Not implemented401	fn safe_transfer_from_with_data(402		&mut self,403		_from: address,404		_to: address,405		_token_id: uint256,406		_data: bytes,407	) -> Result<void> {408		// TODO: Not implemetable409		Err("not implemented".into())410	}411412	/// @dev Not implemented413	fn safe_transfer_from(414		&mut self,415		_from: address,416		_to: address,417		_token_id: uint256,418	) -> Result<void> {419		// TODO: Not implemetable420		Err("not implemented".into())421	}422423	/// @notice Transfer ownership of an RFT -- THE CALLER IS RESPONSIBLE424	///  TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE425	///  THEY MAY BE PERMANENTLY LOST426	/// @dev Throws unless `msg.sender` is the current owner or an authorized427	///  operator for this RFT. Throws if `from` is not the current owner. Throws428	///  if `to` is the zero address. Throws if `tokenId` is not a valid RFT.429	///  Throws if RFT pieces have multiple owners.430	/// @param from The current owner of the NFT431	/// @param to The new owner432	/// @param tokenId The NFT to transfer433	#[weight(<SelfWeightOf<T>>::transfer_from_creating_removing())]434	fn transfer_from(435		&mut self,436		caller: caller,437		from: address,438		to: address,439		token_id: uint256,440	) -> Result<void> {441		let caller = T::CrossAccountId::from_eth(caller);442		let from = T::CrossAccountId::from_eth(from);443		let to = T::CrossAccountId::from_eth(to);444		let token = token_id.try_into()?;445		let budget = self446			.recorder447			.weight_calls_budget(<StructureWeight<T>>::find_parent());448449		let balance = balance(&self, token, &from)?;450		ensure_single_owner(&self, token, balance)?;451452		<Pallet<T>>::transfer_from(self, &caller, &from, &to, token, balance, &budget)453			.map_err(dispatch_to_evm::<T>)?;454455		Ok(())456	}457458	/// @dev Not implemented459	fn approve(&mut self, _caller: caller, _approved: address, _token_id: uint256) -> Result<void> {460		Err("not implemented".into())461	}462463	/// @dev Not implemented464	fn set_approval_for_all(465		&mut self,466		_caller: caller,467		_operator: address,468		_approved: bool,469	) -> Result<void> {470		// TODO: Not implemetable471		Err("not implemented".into())472	}473474	/// @dev Not implemented475	fn get_approved(&self, _token_id: uint256) -> Result<address> {476		// TODO: Not implemetable477		Err("not implemented".into())478	}479480	/// @dev Not implemented481	fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {482		// TODO: Not implemetable483		Err("not implemented".into())484	}485486	/// @notice Returns collection helper contract address487	fn collection_helper_address(&self) -> Result<address> {488		Ok(T::ContractAddress::get())489	}490}491492/// Returns amount of pieces of `token` that `owner` have493pub fn balance<T: Config>(494	collection: &RefungibleHandle<T>,495	token: TokenId,496	owner: &T::CrossAccountId,497) -> Result<u128> {498	collection.consume_store_reads(1)?;499	let balance = <Balance<T>>::get((collection.id, token, &owner));500	Ok(balance)501}502503/// Throws if `owner_balance` is lower than total amount of `token` pieces504pub fn ensure_single_owner<T: Config>(505	collection: &RefungibleHandle<T>,506	token: TokenId,507	owner_balance: u128,508) -> Result<()> {509	collection.consume_store_reads(1)?;510	let total_supply = <TotalSupply<T>>::get((collection.id, token));511	if total_supply != owner_balance {512		return Err("token has multiple owners".into());513	}514	Ok(())515}516517/// @title ERC721 Token that can be irreversibly burned (destroyed).518#[solidity_interface(name = ERC721Burnable)]519impl<T: Config> RefungibleHandle<T> {520	/// @notice Burns a specific ERC721 token.521	/// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized522	///  operator of the current owner.523	/// @param tokenId The RFT to approve524	#[weight(<SelfWeightOf<T>>::burn_item_fully())]525	fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {526		let caller = T::CrossAccountId::from_eth(caller);527		let token = token_id.try_into()?;528529		let balance = balance(&self, token, &caller)?;530		ensure_single_owner(&self, token, balance)?;531532		<Pallet<T>>::burn(self, &caller, token, balance).map_err(dispatch_to_evm::<T>)?;533		Ok(())534	}535}536537/// @title ERC721 minting logic.538#[solidity_interface(name = ERC721UniqueMintable, events(ERC721UniqueMintableEvents))]539impl<T: Config> RefungibleHandle<T> {540	fn minting_finished(&self) -> Result<bool> {541		Ok(false)542	}543544	/// @notice Function to mint token.545	/// @param to The new owner546	/// @return uint256 The id of the newly minted token547	#[weight(<SelfWeightOf<T>>::create_item())]548	fn mint(&mut self, caller: caller, to: address) -> Result<uint256> {549		let token_id: uint256 = <TokensMinted<T>>::get(self.id)550			.checked_add(1)551			.ok_or("item id overflow")?552			.into();553		self.mint_check_id(caller, to, token_id)?;554		Ok(token_id)555	}556557	/// @notice Function to mint token.558	/// @dev `tokenId` should be obtained with `nextTokenId` method,559	///  unlike standard, you can't specify it manually560	/// @param to The new owner561	/// @param tokenId ID of the minted RFT562	#[solidity(hide, rename_selector = "mint")]563	#[weight(<SelfWeightOf<T>>::create_item())]564	fn mint_check_id(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {565		let caller = T::CrossAccountId::from_eth(caller);566		let to = T::CrossAccountId::from_eth(to);567		let token_id: u32 = token_id.try_into()?;568		let budget = self569			.recorder570			.weight_calls_budget(<StructureWeight<T>>::find_parent());571572		if <TokensMinted<T>>::get(self.id)573			.checked_add(1)574			.ok_or("item id overflow")?575			!= token_id576		{577			return Err("item id should be next".into());578		}579580		let users = [(to.clone(), 1)]581			.into_iter()582			.collect::<BTreeMap<_, _>>()583			.try_into()584			.unwrap();585		<Pallet<T>>::create_item(586			self,587			&caller,588			CreateItemData::<T::CrossAccountId> {589				users,590				properties: CollectionPropertiesVec::default(),591			},592			&budget,593		)594		.map_err(dispatch_to_evm::<T>)?;595596		Ok(true)597	}598599	/// @notice Function to mint token with the given tokenUri.600	/// @param to The new owner601	/// @param tokenUri Token URI that would be stored in the NFT properties602	/// @return uint256 The id of the newly minted token603	#[solidity(rename_selector = "mintWithTokenURI")]604	#[weight(<SelfWeightOf<T>>::create_item())]605	fn mint_with_token_uri(606		&mut self,607		caller: caller,608		to: address,609		token_uri: string,610	) -> Result<uint256> {611		let token_id: uint256 = <TokensMinted<T>>::get(self.id)612			.checked_add(1)613			.ok_or("item id overflow")?614			.into();615		self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;616		Ok(token_id)617	}618619	/// @notice Function to mint token with the given tokenUri.620	/// @dev `tokenId` should be obtained with `nextTokenId` method,621	///  unlike standard, you can't specify it manually622	/// @param to The new owner623	/// @param tokenId ID of the minted RFT624	/// @param tokenUri Token URI that would be stored in the RFT properties625	#[solidity(hide, rename_selector = "mintWithTokenURI")]626	#[weight(<SelfWeightOf<T>>::create_item())]627	fn mint_with_token_uri_check_id(628		&mut self,629		caller: caller,630		to: address,631		token_id: uint256,632		token_uri: string,633	) -> Result<bool> {634		let key = key::url();635		let permission = get_token_permission::<T>(self.id, &key)?;636		if !permission.collection_admin {637			return Err("Operation is not allowed".into());638		}639640		let caller = T::CrossAccountId::from_eth(caller);641		let to = T::CrossAccountId::from_eth(to);642		let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;643		let budget = self644			.recorder645			.weight_calls_budget(<StructureWeight<T>>::find_parent());646647		if <TokensMinted<T>>::get(self.id)648			.checked_add(1)649			.ok_or("item id overflow")?650			!= token_id651		{652			return Err("item id should be next".into());653		}654655		let mut properties = CollectionPropertiesVec::default();656		properties657			.try_push(Property {658				key,659				value: token_uri660					.into_bytes()661					.try_into()662					.map_err(|_| "token uri is too long")?,663			})664			.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;665666		let users = [(to.clone(), 1)]667			.into_iter()668			.collect::<BTreeMap<_, _>>()669			.try_into()670			.unwrap();671		<Pallet<T>>::create_item(672			self,673			&caller,674			CreateItemData::<T::CrossAccountId> { users, properties },675			&budget,676		)677		.map_err(dispatch_to_evm::<T>)?;678		Ok(true)679	}680681	/// @dev Not implemented682	fn finish_minting(&mut self, _caller: caller) -> Result<bool> {683		Err("not implementable".into())684	}685}686687fn get_token_property<T: Config>(688	collection: &CollectionHandle<T>,689	token_id: u32,690	key: &up_data_structs::PropertyKey,691) -> Result<string> {692	collection.consume_store_reads(1)?;693	let properties = <TokenProperties<T>>::try_get((collection.id, token_id))694		.map_err(|_| Error::Revert("Token properties not found".into()))?;695	if let Some(property) = properties.get(key) {696		return Ok(string::from_utf8_lossy(property).into());697	}698699	Err("Property tokenURI not found".into())700}701702fn get_token_permission<T: Config>(703	collection_id: CollectionId,704	key: &PropertyKey,705) -> Result<PropertyPermission> {706	let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)707		.map_err(|_| Error::Revert("No permissions for collection".into()))?;708	let a = token_property_permissions709		.get(key)710		.map(Clone::clone)711		.ok_or_else(|| {712			let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();713			Error::Revert(alloc::format!("No permission for key {}", key))714		})?;715	Ok(a)716}717718/// @title Unique extensions for ERC721.719#[solidity_interface(name = ERC721UniqueExtensions)]720impl<T: Config> RefungibleHandle<T>721where722	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,723{724	/// @notice A descriptive name for a collection of NFTs in this contract725	fn name(&self) -> Result<string> {726		Ok(decode_utf16(self.name.iter().copied())727			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))728			.collect::<string>())729	}730731	/// @notice An abbreviated name for NFTs in this contract732	fn symbol(&self) -> Result<string> {733		Ok(string::from_utf8_lossy(&self.token_prefix).into())734	}735736	/// @notice A description for the collection.737	fn description(&self) -> Result<string> {738		Ok(decode_utf16(self.description.iter().copied())739			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))740			.collect::<string>())741	}742743	/// Returns the owner (in cross format) of the token.744	///745	/// @param tokenId Id for the token.746	fn cross_owner_of(&self, token_id: uint256) -> Result<EthCrossAccount> {747		Self::token_owner(&self, token_id.try_into()?)748			.map(|o| EthCrossAccount::from_sub_cross_account::<T>(&o))749			.ok_or(Error::Revert("key too large".into()))750	}751752	/// Returns the token properties.753	///754	/// @param tokenId Id for the token.755	/// @param keys Properties keys. Empty keys for all propertyes.756	/// @return Vector of properties key/value pairs.757	fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {758		let keys = keys759			.into_iter()760			.map(|key| {761				<Vec<u8>>::from(key)762					.try_into()763					.map_err(|_| Error::Revert("key too large".into()))764			})765			.collect::<Result<Vec<_>>>()?;766767		<Self as CommonCollectionOperations<T>>::token_properties(768			&self,769			token_id.try_into()?,770			if keys.is_empty() { None } else { Some(keys) },771		)772		.into_iter()773		.map(|p| {774			let key = string::from_utf8(p.key.to_vec())775				.map_err(|e| Error::Revert(alloc::format!("{}", e)))?;776			let value = bytes(p.value.to_vec());777			Ok(PropertyStruct { key, value })778		})779		.collect::<Result<Vec<_>>>()780	}781	/// @notice Transfer ownership of an RFT782	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`783	///  is the zero address. Throws if `tokenId` is not a valid RFT.784	///  Throws if RFT pieces have multiple owners.785	/// @param to The new owner786	/// @param tokenId The RFT to transfer787	#[weight(<SelfWeightOf<T>>::transfer_creating_removing())]788	fn transfer(&mut self, caller: caller, to: address, token_id: uint256) -> Result<void> {789		let caller = T::CrossAccountId::from_eth(caller);790		let to = T::CrossAccountId::from_eth(to);791		let token = token_id.try_into()?;792		let budget = self793			.recorder794			.weight_calls_budget(<StructureWeight<T>>::find_parent());795796		let balance = balance(self, token, &caller)?;797		ensure_single_owner(self, token, balance)?;798799		<Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)800			.map_err(dispatch_to_evm::<T>)?;801		Ok(())802	}803804	/// @notice Transfer ownership of an RFT805	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`806	///  is the zero address. Throws if `tokenId` is not a valid RFT.807	///  Throws if RFT pieces have multiple owners.808	/// @param to The new owner809	/// @param tokenId The RFT to transfer810	#[weight(<SelfWeightOf<T>>::transfer_creating_removing())]811	fn transfer_cross(812		&mut self,813		caller: caller,814		to: EthCrossAccount,815		token_id: uint256,816	) -> Result<void> {817		let caller = T::CrossAccountId::from_eth(caller);818		let to = to.into_sub_cross_account::<T>()?;819		let token = token_id.try_into()?;820		let budget = self821			.recorder822			.weight_calls_budget(<StructureWeight<T>>::find_parent());823824		let balance = balance(self, token, &caller)?;825		ensure_single_owner(self, token, balance)?;826827		<Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)828			.map_err(dispatch_to_evm::<T>)?;829		Ok(())830	}831832	/// @notice Transfer ownership of an RFT833	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`834	///  is the zero address. Throws if `tokenId` is not a valid RFT.835	///  Throws if RFT pieces have multiple owners.836	/// @param to The new owner837	/// @param tokenId The RFT to transfer838	#[weight(<SelfWeightOf<T>>::transfer_creating_removing())]839	fn transfer_from_cross(840		&mut self,841		caller: caller,842		from: EthCrossAccount,843		to: EthCrossAccount,844		token_id: uint256,845	) -> Result<void> {846		let caller = T::CrossAccountId::from_eth(caller);847		let from = from.into_sub_cross_account::<T>()?;848		let to = to.into_sub_cross_account::<T>()?;849		let token_id = token_id.try_into()?;850		let budget = self851			.recorder852			.weight_calls_budget(<StructureWeight<T>>::find_parent());853854		let balance = balance(self, token_id, &from)?;855		ensure_single_owner(self, token_id, balance)?;856857		Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, balance, &budget)858			.map_err(dispatch_to_evm::<T>)?;859		Ok(())860	}861862	/// @notice Burns a specific ERC721 token.863	/// @dev Throws unless `msg.sender` is the current owner or an authorized864	///  operator for this RFT. Throws if `from` is not the current owner. Throws865	///  if `to` is the zero address. Throws if `tokenId` is not a valid RFT.866	///  Throws if RFT pieces have multiple owners.867	/// @param from The current owner of the RFT868	/// @param tokenId The RFT to transfer869	#[solidity(hide)]870	#[weight(<SelfWeightOf<T>>::burn_from())]871	fn burn_from(&mut self, caller: caller, from: address, token_id: uint256) -> Result<void> {872		let caller = T::CrossAccountId::from_eth(caller);873		let from = T::CrossAccountId::from_eth(from);874		let token = token_id.try_into()?;875		let budget = self876			.recorder877			.weight_calls_budget(<StructureWeight<T>>::find_parent());878879		let balance = balance(self, token, &from)?;880		ensure_single_owner(self, token, balance)?;881882		<Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)883			.map_err(dispatch_to_evm::<T>)?;884		Ok(())885	}886887	/// @notice Burns a specific ERC721 token.888	/// @dev Throws unless `msg.sender` is the current owner or an authorized889	///  operator for this RFT. Throws if `from` is not the current owner. Throws890	///  if `to` is the zero address. Throws if `tokenId` is not a valid RFT.891	///  Throws if RFT pieces have multiple owners.892	/// @param from The current owner of the RFT893	/// @param tokenId The RFT to transfer894	#[weight(<SelfWeightOf<T>>::burn_from())]895	fn burn_from_cross(896		&mut self,897		caller: caller,898		from: EthCrossAccount,899		token_id: uint256,900	) -> Result<void> {901		let caller = T::CrossAccountId::from_eth(caller);902		let from = from.into_sub_cross_account::<T>()?;903		let token = token_id.try_into()?;904		let budget = self905			.recorder906			.weight_calls_budget(<StructureWeight<T>>::find_parent());907908		let balance = balance(self, token, &from)?;909		ensure_single_owner(self, token, balance)?;910911		<Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)912			.map_err(dispatch_to_evm::<T>)?;913		Ok(())914	}915916	/// @notice Returns next free RFT ID.917	fn next_token_id(&self) -> Result<uint256> {918		self.consume_store_reads(1)?;919		Ok(<TokensMinted<T>>::get(self.id)920			.checked_add(1)921			.ok_or("item id overflow")?922			.into())923	}924925	/// @notice Function to mint multiple tokens.926	/// @dev `tokenIds` should be an array of consecutive numbers and first number927	///  should be obtained with `nextTokenId` method928	/// @param to The new owner929	/// @param tokenIds IDs of the minted RFTs930	#[solidity(hide)]931	#[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]932	fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {933		let caller = T::CrossAccountId::from_eth(caller);934		let to = T::CrossAccountId::from_eth(to);935		let mut expected_index = <TokensMinted<T>>::get(self.id)936			.checked_add(1)937			.ok_or("item id overflow")?;938		let budget = self939			.recorder940			.weight_calls_budget(<StructureWeight<T>>::find_parent());941942		let total_tokens = token_ids.len();943		for id in token_ids.into_iter() {944			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;945			if id != expected_index {946				return Err("item id should be next".into());947			}948			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;949		}950		let users = [(to.clone(), 1)]951			.into_iter()952			.collect::<BTreeMap<_, _>>()953			.try_into()954			.unwrap();955		let create_item_data = CreateItemData::<T::CrossAccountId> {956			users,957			properties: CollectionPropertiesVec::default(),958		};959		let data = (0..total_tokens)960			.map(|_| create_item_data.clone())961			.collect();962963		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)964			.map_err(dispatch_to_evm::<T>)?;965		Ok(true)966	}967968	/// @notice Function to mint multiple tokens with the given tokenUris.969	/// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive970	///  numbers and first number should be obtained with `nextTokenId` method971	/// @param to The new owner972	/// @param tokens array of pairs of token ID and token URI for minted tokens973	#[solidity(hide, rename_selector = "mintBulkWithTokenURI")]974	#[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]975	fn mint_bulk_with_token_uri(976		&mut self,977		caller: caller,978		to: address,979		tokens: Vec<(uint256, string)>,980	) -> Result<bool> {981		let key = key::url();982		let caller = T::CrossAccountId::from_eth(caller);983		let to = T::CrossAccountId::from_eth(to);984		let mut expected_index = <TokensMinted<T>>::get(self.id)985			.checked_add(1)986			.ok_or("item id overflow")?;987		let budget = self988			.recorder989			.weight_calls_budget(<StructureWeight<T>>::find_parent());990991		let mut data = Vec::with_capacity(tokens.len());992		let users: BoundedBTreeMap<_, _, _> = [(to.clone(), 1)]993			.into_iter()994			.collect::<BTreeMap<_, _>>()995			.try_into()996			.unwrap();997		for (id, token_uri) in tokens {998			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;999			if id != expected_index {1000				return Err("item id should be next".into());1001			}1002			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;10031004			let mut properties = CollectionPropertiesVec::default();1005			properties1006				.try_push(Property {1007					key: key.clone(),1008					value: token_uri1009						.into_bytes()1010						.try_into()1011						.map_err(|_| "token uri is too long")?,1012				})1013				.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;10141015			let create_item_data = CreateItemData::<T::CrossAccountId> {1016				users: users.clone(),1017				properties,1018			};1019			data.push(create_item_data);1020		}10211022		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1023			.map_err(dispatch_to_evm::<T>)?;1024		Ok(true)1025	}10261027	/// Returns EVM address for refungible token1028	///1029	/// @param token ID of the token1030	fn token_contract_address(&self, token: uint256) -> Result<address> {1031		Ok(T::EvmTokenAddressMapping::token_to_address(1032			self.id,1033			token.try_into().map_err(|_| "token id overflow")?,1034		))1035	}1036}10371038#[solidity_interface(1039	name = UniqueRefungible,1040	is(1041		ERC721,1042		ERC721Enumerable,1043		ERC721UniqueExtensions,1044		ERC721UniqueMintable,1045		ERC721Burnable,1046		ERC721Metadata(if(this.flags.erc721metadata)),1047		Collection(via(common_mut returns CollectionHandle<T>)),1048		TokenProperties,1049	)1050)]1051impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}10521053// Not a tests, but code generators1054generate_stubgen!(gen_impl, UniqueRefungibleCall<()>, true);1055generate_stubgen!(gen_iface, UniqueRefungibleCall<()>, false);10561057impl<T: Config> CommonEvmHandler for RefungibleHandle<T>1058where1059	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1060{1061	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungible.raw");1062	fn call(1063		self,1064		handle: &mut impl PrecompileHandle,1065	) -> Option<pallet_common::erc::PrecompileResult> {1066		call::<T, UniqueRefungibleCall<T>, _, _>(handle, self)1067	}1068}