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

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;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	}485}486487/// Returns amount of pieces of `token` that `owner` have488pub fn balance<T: Config>(489	collection: &RefungibleHandle<T>,490	token: TokenId,491	owner: &T::CrossAccountId,492) -> Result<u128> {493	collection.consume_store_reads(1)?;494	let balance = <Balance<T>>::get((collection.id, token, &owner));495	Ok(balance)496}497498/// Throws if `owner_balance` is lower than total amount of `token` pieces499pub fn ensure_single_owner<T: Config>(500	collection: &RefungibleHandle<T>,501	token: TokenId,502	owner_balance: u128,503) -> Result<()> {504	collection.consume_store_reads(1)?;505	let total_supply = <TotalSupply<T>>::get((collection.id, token));506	if total_supply != owner_balance {507		return Err("token has multiple owners".into());508	}509	Ok(())510}511512/// @title ERC721 Token that can be irreversibly burned (destroyed).513#[solidity_interface(name = ERC721Burnable)]514impl<T: Config> RefungibleHandle<T> {515	/// @notice Burns a specific ERC721 token.516	/// @dev Throws unless `msg.sender` is the current RFT owner, or an authorized517	///  operator of the current owner.518	/// @param tokenId The RFT to approve519	#[weight(<SelfWeightOf<T>>::burn_item_fully())]520	fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {521		let caller = T::CrossAccountId::from_eth(caller);522		let token = token_id.try_into()?;523524		let balance = balance(&self, token, &caller)?;525		ensure_single_owner(&self, token, balance)?;526527		<Pallet<T>>::burn(self, &caller, token, balance).map_err(dispatch_to_evm::<T>)?;528		Ok(())529	}530}531532/// @title ERC721 minting logic.533#[solidity_interface(name = ERC721UniqueMintable, events(ERC721UniqueMintableEvents))]534impl<T: Config> RefungibleHandle<T> {535	fn minting_finished(&self) -> Result<bool> {536		Ok(false)537	}538539	/// @notice Function to mint token.540	/// @param to The new owner541	/// @return uint256 The id of the newly minted token542	#[weight(<SelfWeightOf<T>>::create_item())]543	fn mint(&mut self, caller: caller, to: address) -> Result<uint256> {544		let token_id: uint256 = <TokensMinted<T>>::get(self.id)545			.checked_add(1)546			.ok_or("item id overflow")?547			.into();548		self.mint_check_id(caller, to, token_id)?;549		Ok(token_id)550	}551552	/// @notice Function to mint token.553	/// @dev `tokenId` should be obtained with `nextTokenId` method,554	///  unlike standard, you can't specify it manually555	/// @param to The new owner556	/// @param tokenId ID of the minted RFT557	#[solidity(hide, rename_selector = "mint")]558	#[weight(<SelfWeightOf<T>>::create_item())]559	fn mint_check_id(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {560		let caller = T::CrossAccountId::from_eth(caller);561		let to = T::CrossAccountId::from_eth(to);562		let token_id: u32 = token_id.try_into()?;563		let budget = self564			.recorder565			.weight_calls_budget(<StructureWeight<T>>::find_parent());566567		if <TokensMinted<T>>::get(self.id)568			.checked_add(1)569			.ok_or("item id overflow")?570			!= token_id571		{572			return Err("item id should be next".into());573		}574575		let users = [(to.clone(), 1)]576			.into_iter()577			.collect::<BTreeMap<_, _>>()578			.try_into()579			.unwrap();580		<Pallet<T>>::create_item(581			self,582			&caller,583			CreateItemData::<T::CrossAccountId> {584				users,585				properties: CollectionPropertiesVec::default(),586			},587			&budget,588		)589		.map_err(dispatch_to_evm::<T>)?;590591		Ok(true)592	}593594	/// @notice Function to mint token with the given tokenUri.595	/// @param to The new owner596	/// @param tokenUri Token URI that would be stored in the NFT properties597	/// @return uint256 The id of the newly minted token598	#[solidity(rename_selector = "mintWithTokenURI")]599	#[weight(<SelfWeightOf<T>>::create_item())]600	fn mint_with_token_uri(601		&mut self,602		caller: caller,603		to: address,604		token_uri: string,605	) -> Result<uint256> {606		let token_id: uint256 = <TokensMinted<T>>::get(self.id)607			.checked_add(1)608			.ok_or("item id overflow")?609			.into();610		self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;611		Ok(token_id)612	}613614	/// @notice Function to mint token with the given tokenUri.615	/// @dev `tokenId` should be obtained with `nextTokenId` method,616	///  unlike standard, you can't specify it manually617	/// @param to The new owner618	/// @param tokenId ID of the minted RFT619	/// @param tokenUri Token URI that would be stored in the RFT properties620	#[solidity(hide, rename_selector = "mintWithTokenURI")]621	#[weight(<SelfWeightOf<T>>::create_item())]622	fn mint_with_token_uri_check_id(623		&mut self,624		caller: caller,625		to: address,626		token_id: uint256,627		token_uri: string,628	) -> Result<bool> {629		let key = key::url();630		let permission = get_token_permission::<T>(self.id, &key)?;631		if !permission.collection_admin {632			return Err("Operation is not allowed".into());633		}634635		let caller = T::CrossAccountId::from_eth(caller);636		let to = T::CrossAccountId::from_eth(to);637		let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;638		let budget = self639			.recorder640			.weight_calls_budget(<StructureWeight<T>>::find_parent());641642		if <TokensMinted<T>>::get(self.id)643			.checked_add(1)644			.ok_or("item id overflow")?645			!= token_id646		{647			return Err("item id should be next".into());648		}649650		let mut properties = CollectionPropertiesVec::default();651		properties652			.try_push(Property {653				key,654				value: token_uri655					.into_bytes()656					.try_into()657					.map_err(|_| "token uri is too long")?,658			})659			.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;660661		let users = [(to.clone(), 1)]662			.into_iter()663			.collect::<BTreeMap<_, _>>()664			.try_into()665			.unwrap();666		<Pallet<T>>::create_item(667			self,668			&caller,669			CreateItemData::<T::CrossAccountId> { users, properties },670			&budget,671		)672		.map_err(dispatch_to_evm::<T>)?;673		Ok(true)674	}675676	/// @dev Not implemented677	fn finish_minting(&mut self, _caller: caller) -> Result<bool> {678		Err("not implementable".into())679	}680}681682fn get_token_property<T: Config>(683	collection: &CollectionHandle<T>,684	token_id: u32,685	key: &up_data_structs::PropertyKey,686) -> Result<string> {687	collection.consume_store_reads(1)?;688	let properties = <TokenProperties<T>>::try_get((collection.id, token_id))689		.map_err(|_| Error::Revert("Token properties not found".into()))?;690	if let Some(property) = properties.get(key) {691		return Ok(string::from_utf8_lossy(property).into());692	}693694	Err("Property tokenURI not found".into())695}696697fn get_token_permission<T: Config>(698	collection_id: CollectionId,699	key: &PropertyKey,700) -> Result<PropertyPermission> {701	let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)702		.map_err(|_| Error::Revert("No permissions for collection".into()))?;703	let a = token_property_permissions704		.get(key)705		.map(Clone::clone)706		.ok_or_else(|| {707			let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();708			Error::Revert(alloc::format!("No permission for key {}", key))709		})?;710	Ok(a)711}712713/// @title Unique extensions for ERC721.714#[solidity_interface(name = ERC721UniqueExtensions)]715impl<T: Config> RefungibleHandle<T>716where717	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,718{719	/// @notice A descriptive name for a collection of NFTs in this contract720	fn name(&self) -> Result<string> {721		Ok(decode_utf16(self.name.iter().copied())722			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))723			.collect::<string>())724	}725726	/// @notice An abbreviated name for NFTs in this contract727	fn symbol(&self) -> Result<string> {728		Ok(string::from_utf8_lossy(&self.token_prefix).into())729	}730731	/// @notice A description for the collection.732	fn description(&self) -> Result<string> {733		Ok(decode_utf16(self.description.iter().copied())734			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))735			.collect::<string>())736	}737738	/// Returns the owner (in cross format) of the token.739	///740	/// @param tokenId Id for the token.741	fn cross_owner_of(&self, token_id: uint256) -> Result<EthCrossAccount> {742		Self::token_owner(&self, token_id.try_into()?)743			.map(|o| EthCrossAccount::from_sub_cross_account::<T>(&o))744			.ok_or(Error::Revert("key too large".into()))745	}746747	/// Returns the token properties.748	///749	/// @param tokenId Id for the token.750	/// @param keys Properties keys. Empty keys for all propertyes.751	/// @return Vector of properties key/value pairs.752	fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {753		let keys = keys754			.into_iter()755			.map(|key| {756				<Vec<u8>>::from(key)757					.try_into()758					.map_err(|_| Error::Revert("key too large".into()))759			})760			.collect::<Result<Vec<_>>>()?;761762		<Self as CommonCollectionOperations<T>>::token_properties(763			&self,764			token_id.try_into()?,765			if keys.is_empty() { None } else { Some(keys) },766		)767		.into_iter()768		.map(|p| {769			let key = string::from_utf8(p.key.to_vec())770				.map_err(|e| Error::Revert(alloc::format!("{}", e)))?;771			let value = bytes(p.value.to_vec());772			Ok(PropertyStruct { key, value })773		})774		.collect::<Result<Vec<_>>>()775	}776	/// @notice Transfer ownership of an RFT777	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`778	///  is the zero address. Throws if `tokenId` is not a valid RFT.779	///  Throws if RFT pieces have multiple owners.780	/// @param to The new owner781	/// @param tokenId The RFT to transfer782	#[weight(<SelfWeightOf<T>>::transfer_creating_removing())]783	fn transfer(&mut self, caller: caller, to: address, token_id: uint256) -> Result<void> {784		let caller = T::CrossAccountId::from_eth(caller);785		let to = T::CrossAccountId::from_eth(to);786		let token = token_id.try_into()?;787		let budget = self788			.recorder789			.weight_calls_budget(<StructureWeight<T>>::find_parent());790791		let balance = balance(self, token, &caller)?;792		ensure_single_owner(self, token, balance)?;793794		<Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)795			.map_err(dispatch_to_evm::<T>)?;796		Ok(())797	}798799	/// @notice Transfer ownership of an RFT800	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`801	///  is the zero address. Throws if `tokenId` is not a valid RFT.802	///  Throws if RFT pieces have multiple owners.803	/// @param to The new owner804	/// @param tokenId The RFT to transfer805	#[weight(<SelfWeightOf<T>>::transfer_creating_removing())]806	fn transfer_cross(807		&mut self,808		caller: caller,809		to: EthCrossAccount,810		token_id: uint256,811	) -> Result<void> {812		let caller = T::CrossAccountId::from_eth(caller);813		let to = to.into_sub_cross_account::<T>()?;814		let token = token_id.try_into()?;815		let budget = self816			.recorder817			.weight_calls_budget(<StructureWeight<T>>::find_parent());818819		let balance = balance(self, token, &caller)?;820		ensure_single_owner(self, token, balance)?;821822		<Pallet<T>>::transfer(self, &caller, &to, token, balance, &budget)823			.map_err(dispatch_to_evm::<T>)?;824		Ok(())825	}826827	/// @notice Transfer ownership of an RFT828	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`829	///  is the zero address. Throws if `tokenId` is not a valid RFT.830	///  Throws if RFT pieces have multiple owners.831	/// @param to The new owner832	/// @param tokenId The RFT to transfer833	#[weight(<SelfWeightOf<T>>::transfer_creating_removing())]834	fn transfer_from_cross(835		&mut self,836		caller: caller,837		from: EthCrossAccount,838		to: EthCrossAccount,839		token_id: uint256,840	) -> Result<void> {841		let caller = T::CrossAccountId::from_eth(caller);842		let from = from.into_sub_cross_account::<T>()?;843		let to = to.into_sub_cross_account::<T>()?;844		let token_id = token_id.try_into()?;845		let budget = self846			.recorder847			.weight_calls_budget(<StructureWeight<T>>::find_parent());848849		let balance = balance(self, token_id, &from)?;850		ensure_single_owner(self, token_id, balance)?;851852		Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, balance, &budget)853			.map_err(dispatch_to_evm::<T>)?;854		Ok(())855	}856857	/// @notice Burns a specific ERC721 token.858	/// @dev Throws unless `msg.sender` is the current owner or an authorized859	///  operator for this RFT. Throws if `from` is not the current owner. Throws860	///  if `to` is the zero address. Throws if `tokenId` is not a valid RFT.861	///  Throws if RFT pieces have multiple owners.862	/// @param from The current owner of the RFT863	/// @param tokenId The RFT to transfer864	#[solidity(hide)]865	#[weight(<SelfWeightOf<T>>::burn_from())]866	fn burn_from(&mut self, caller: caller, from: address, token_id: uint256) -> Result<void> {867		let caller = T::CrossAccountId::from_eth(caller);868		let from = T::CrossAccountId::from_eth(from);869		let token = token_id.try_into()?;870		let budget = self871			.recorder872			.weight_calls_budget(<StructureWeight<T>>::find_parent());873874		let balance = balance(self, token, &from)?;875		ensure_single_owner(self, token, balance)?;876877		<Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)878			.map_err(dispatch_to_evm::<T>)?;879		Ok(())880	}881882	/// @notice Burns a specific ERC721 token.883	/// @dev Throws unless `msg.sender` is the current owner or an authorized884	///  operator for this RFT. Throws if `from` is not the current owner. Throws885	///  if `to` is the zero address. Throws if `tokenId` is not a valid RFT.886	///  Throws if RFT pieces have multiple owners.887	/// @param from The current owner of the RFT888	/// @param tokenId The RFT to transfer889	#[weight(<SelfWeightOf<T>>::burn_from())]890	fn burn_from_cross(891		&mut self,892		caller: caller,893		from: EthCrossAccount,894		token_id: uint256,895	) -> Result<void> {896		let caller = T::CrossAccountId::from_eth(caller);897		let from = from.into_sub_cross_account::<T>()?;898		let token = token_id.try_into()?;899		let budget = self900			.recorder901			.weight_calls_budget(<StructureWeight<T>>::find_parent());902903		let balance = balance(self, token, &from)?;904		ensure_single_owner(self, token, balance)?;905906		<Pallet<T>>::burn_from(self, &caller, &from, token, balance, &budget)907			.map_err(dispatch_to_evm::<T>)?;908		Ok(())909	}910911	/// @notice Returns next free RFT ID.912	fn next_token_id(&self) -> Result<uint256> {913		self.consume_store_reads(1)?;914		Ok(<TokensMinted<T>>::get(self.id)915			.checked_add(1)916			.ok_or("item id overflow")?917			.into())918	}919920	/// @notice Function to mint multiple tokens.921	/// @dev `tokenIds` should be an array of consecutive numbers and first number922	///  should be obtained with `nextTokenId` method923	/// @param to The new owner924	/// @param tokenIds IDs of the minted RFTs925	#[solidity(hide)]926	#[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]927	fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {928		let caller = T::CrossAccountId::from_eth(caller);929		let to = T::CrossAccountId::from_eth(to);930		let mut expected_index = <TokensMinted<T>>::get(self.id)931			.checked_add(1)932			.ok_or("item id overflow")?;933		let budget = self934			.recorder935			.weight_calls_budget(<StructureWeight<T>>::find_parent());936937		let total_tokens = token_ids.len();938		for id in token_ids.into_iter() {939			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;940			if id != expected_index {941				return Err("item id should be next".into());942			}943			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;944		}945		let users = [(to.clone(), 1)]946			.into_iter()947			.collect::<BTreeMap<_, _>>()948			.try_into()949			.unwrap();950		let create_item_data = CreateItemData::<T::CrossAccountId> {951			users,952			properties: CollectionPropertiesVec::default(),953		};954		let data = (0..total_tokens)955			.map(|_| create_item_data.clone())956			.collect();957958		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)959			.map_err(dispatch_to_evm::<T>)?;960		Ok(true)961	}962963	/// @notice Function to mint multiple tokens with the given tokenUris.964	/// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive965	///  numbers and first number should be obtained with `nextTokenId` method966	/// @param to The new owner967	/// @param tokens array of pairs of token ID and token URI for minted tokens968	#[solidity(hide, rename_selector = "mintBulkWithTokenURI")]969	#[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]970	fn mint_bulk_with_token_uri(971		&mut self,972		caller: caller,973		to: address,974		tokens: Vec<(uint256, string)>,975	) -> Result<bool> {976		let key = key::url();977		let caller = T::CrossAccountId::from_eth(caller);978		let to = T::CrossAccountId::from_eth(to);979		let mut expected_index = <TokensMinted<T>>::get(self.id)980			.checked_add(1)981			.ok_or("item id overflow")?;982		let budget = self983			.recorder984			.weight_calls_budget(<StructureWeight<T>>::find_parent());985986		let mut data = Vec::with_capacity(tokens.len());987		let users: BoundedBTreeMap<_, _, _> = [(to.clone(), 1)]988			.into_iter()989			.collect::<BTreeMap<_, _>>()990			.try_into()991			.unwrap();992		for (id, token_uri) in tokens {993			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;994			if id != expected_index {995				return Err("item id should be next".into());996			}997			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;998999			let mut properties = CollectionPropertiesVec::default();1000			properties1001				.try_push(Property {1002					key: key.clone(),1003					value: token_uri1004						.into_bytes()1005						.try_into()1006						.map_err(|_| "token uri is too long")?,1007				})1008				.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;10091010			let create_item_data = CreateItemData::<T::CrossAccountId> {1011				users: users.clone(),1012				properties,1013			};1014			data.push(create_item_data);1015		}10161017		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1018			.map_err(dispatch_to_evm::<T>)?;1019		Ok(true)1020	}10211022	/// Returns EVM address for refungible token1023	///1024	/// @param token ID of the token1025	fn token_contract_address(&self, token: uint256) -> Result<address> {1026		Ok(T::EvmTokenAddressMapping::token_to_address(1027			self.id,1028			token.try_into().map_err(|_| "token id overflow")?,1029		))1030	}1031}10321033#[solidity_interface(1034	name = UniqueRefungible,1035	is(1036		ERC721,1037		ERC721Enumerable,1038		ERC721UniqueExtensions,1039		ERC721UniqueMintable,1040		ERC721Burnable,1041		ERC721Metadata(if(this.flags.erc721metadata)),1042		Collection(via(common_mut returns CollectionHandle<T>)),1043		TokenProperties,1044	)1045)]1046impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}10471048// Not a tests, but code generators1049generate_stubgen!(gen_impl, UniqueRefungibleCall<()>, true);1050generate_stubgen!(gen_iface, UniqueRefungibleCall<()>, false);10511052impl<T: Config> CommonEvmHandler for RefungibleHandle<T>1053where1054	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1055{1056	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungible.raw");1057	fn call(1058		self,1059		handle: &mut impl PrecompileHandle,1060	) -> Option<pallet_common::erc::PrecompileResult> {1061		call::<T, UniqueRefungibleCall<T>, _, _>(handle, self)1062	}1063}