git.delta.rocks / unique-network / refs/commits / 8298cf829479

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::{Property as PropertyStruct, EthCrossAccount},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<pallet_common::eth::TokenPropertyPermission>,98	) -> Result<()> {99		let caller = T::CrossAccountId::from_eth(caller);100		let perms = pallet_common::eth::TokenPropertyPermission::into_property_key_permissions(101			permissions,102		)?;103104		<Pallet<T>>::set_token_property_permissions(self, &caller, perms)105			.map_err(dispatch_to_evm::<T>)106	}107108	/// @notice Get permissions for token properties.109	fn token_property_permissions(110		&self,111	) -> Result<Vec<pallet_common::eth::TokenPropertyPermission>> {112		let perms = <Pallet<T>>::token_property_permission(self.id);113		Ok(perms114			.into_iter()115			.map(pallet_common::eth::TokenPropertyPermission::from)116			.collect())117	}118119	/// @notice Set token property value.120	/// @dev Throws error if `msg.sender` has no permission to edit the property.121	/// @param tokenId ID of the token.122	/// @param key Property key.123	/// @param value Property value.124	#[solidity(hide)]125	#[weight(<SelfWeightOf<T>>::set_token_properties(1))]126	fn set_property(127		&mut self,128		caller: caller,129		token_id: uint256,130		key: string,131		value: bytes,132	) -> Result<()> {133		let caller = T::CrossAccountId::from_eth(caller);134		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;135		let key = <Vec<u8>>::from(key)136			.try_into()137			.map_err(|_| "key too long")?;138		let value = value.0.try_into().map_err(|_| "value too long")?;139140		let nesting_budget = self141			.recorder142			.weight_calls_budget(<StructureWeight<T>>::find_parent());143144		<Pallet<T>>::set_token_property(145			self,146			&caller,147			TokenId(token_id),148			Property { key, value },149			&nesting_budget,150		)151		.map_err(dispatch_to_evm::<T>)152	}153154	/// @notice Set token properties value.155	/// @dev Throws error if `msg.sender` has no permission to edit the property.156	/// @param tokenId ID of the token.157	/// @param properties settable properties158	#[weight(<SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]159	fn set_properties(160		&mut self,161		caller: caller,162		token_id: uint256,163		properties: Vec<PropertyStruct>,164	) -> Result<()> {165		let caller = T::CrossAccountId::from_eth(caller);166		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;167168		let nesting_budget = self169			.recorder170			.weight_calls_budget(<StructureWeight<T>>::find_parent());171172		let properties = properties173			.into_iter()174			.map(|PropertyStruct { key, value }| {175				let key = <Vec<u8>>::from(key)176					.try_into()177					.map_err(|_| "key too large")?;178179				let value = value.0.try_into().map_err(|_| "value too large")?;180181				Ok(Property { key, value })182			})183			.collect::<Result<Vec<_>>>()?;184185		<Pallet<T>>::set_token_properties(186			self,187			&caller,188			TokenId(token_id),189			properties.into_iter(),190			false,191			&nesting_budget,192		)193		.map_err(dispatch_to_evm::<T>)194	}195196	/// @notice Delete token property value.197	/// @dev Throws error if `msg.sender` has no permission to edit the property.198	/// @param tokenId ID of the token.199	/// @param key Property key.200	#[solidity(hide)]201	#[weight(<SelfWeightOf<T>>::delete_token_properties(1))]202	fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {203		let caller = T::CrossAccountId::from_eth(caller);204		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;205		let key = <Vec<u8>>::from(key)206			.try_into()207			.map_err(|_| "key too long")?;208209		let nesting_budget = self210			.recorder211			.weight_calls_budget(<StructureWeight<T>>::find_parent());212213		<Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)214			.map_err(dispatch_to_evm::<T>)215	}216217	/// @notice Delete token properties value.218	/// @dev Throws error if `msg.sender` has no permission to edit the property.219	/// @param tokenId ID of the token.220	/// @param keys Properties key.221	#[weight(<SelfWeightOf<T>>::delete_token_properties(keys.len() as u32))]222	fn delete_properties(223		&mut self,224		token_id: uint256,225		caller: caller,226		keys: Vec<string>,227	) -> Result<()> {228		let caller = T::CrossAccountId::from_eth(caller);229		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;230		let keys = keys231			.into_iter()232			.map(|k| Ok(<Vec<u8>>::from(k).try_into().map_err(|_| "key too long")?))233			.collect::<Result<Vec<_>>>()?;234235		let nesting_budget = self236			.recorder237			.weight_calls_budget(<StructureWeight<T>>::find_parent());238239		<Pallet<T>>::delete_token_properties(240			self,241			&caller,242			TokenId(token_id),243			keys.into_iter(),244			&nesting_budget,245		)246		.map_err(dispatch_to_evm::<T>)247	}248249	/// @notice Get token property value.250	/// @dev Throws error if key not found251	/// @param tokenId ID of the token.252	/// @param key Property key.253	/// @return Property value bytes254	fn property(&self, token_id: uint256, key: string) -> Result<bytes> {255		let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;256		let key = <Vec<u8>>::from(key)257			.try_into()258			.map_err(|_| "key too long")?;259260		let props = <TokenProperties<T>>::get((self.id, token_id));261		let prop = props.get(&key).ok_or("key not found")?;262263		Ok(prop.to_vec().into())264	}265}266267#[derive(ToLog)]268pub enum ERC721Events {269	/// @dev This emits when ownership of any NFT changes by any mechanism.270	///  This event emits when NFTs are created (`from` == 0) and destroyed271	///  (`to` == 0). Exception: during contract creation, any number of NFTs272	///  may be created and assigned without emitting Transfer. At the time of273	///  any transfer, the approved address for that NFT (if any) is reset to none.274	Transfer {275		#[indexed]276		from: address,277		#[indexed]278		to: address,279		#[indexed]280		token_id: uint256,281	},282	/// @dev This emits when the approved address for an NFT is changed or283	///  reaffirmed. The zero address indicates there is no approved address.284	///  When a Transfer event emits, this also indicates that the approved285	///  address for that NFT (if any) is reset to none.286	Approval {287		#[indexed]288		owner: address,289		#[indexed]290		approved: address,291		#[indexed]292		token_id: uint256,293	},294	/// @dev This emits when an operator is enabled or disabled for an owner.295	///  The operator can manage all NFTs of the owner.296	#[allow(dead_code)]297	ApprovalForAll {298		#[indexed]299		owner: address,300		#[indexed]301		operator: address,302		approved: bool,303	},304}305306#[derive(ToLog)]307pub enum ERC721UniqueMintableEvents {308	#[allow(dead_code)]309	MintingFinished {},310}311312/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension313/// @dev See https://eips.ethereum.org/EIPS/eip-721314#[solidity_interface(name = ERC721Metadata, expect_selector = 0x5b5e139f)]315impl<T: Config> NonfungibleHandle<T>316where317	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,318{319	/// @notice A descriptive name for a collection of NFTs in this contract320	/// @dev real implementation of this function lies in `ERC721UniqueExtensions`321	#[solidity(hide, rename_selector = "name")]322	fn name_proxy(&self) -> Result<string> {323		self.name()324	}325326	/// @notice An abbreviated name for NFTs in this contract327	/// @dev real implementation of this function lies in `ERC721UniqueExtensions`328	#[solidity(hide, rename_selector = "symbol")]329	fn symbol_proxy(&self) -> Result<string> {330		self.symbol()331	}332333	/// @notice A distinct Uniform Resource Identifier (URI) for a given asset.334	///335	/// @dev If the token has a `url` property and it is not empty, it is returned.336	///  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`.337	///  If the collection property `baseURI` is empty or absent, return "" (empty string)338	///  otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix339	///  otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).340	///341	/// @return token's const_metadata342	#[solidity(rename_selector = "tokenURI")]343	fn token_uri(&self, token_id: uint256) -> Result<string> {344		let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;345346		match get_token_property(self, token_id_u32, &key::url()).as_deref() {347			Err(_) | Ok("") => (),348			Ok(url) => {349				return Ok(url.into());350			}351		};352353		let base_uri =354			pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())355				.map(BoundedVec::into_inner)356				.map(string::from_utf8)357				.transpose()358				.map_err(|e| {359					Error::Revert(alloc::format!(360						"Can not convert value \"baseURI\" to string with error \"{}\"",361						e362					))363				})?;364365		let base_uri = match base_uri.as_deref() {366			None | Some("") => {367				return Ok("".into());368			}369			Some(base_uri) => base_uri.into(),370		};371372		Ok(373			match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {374				Err(_) | Ok("") => base_uri,375				Ok(suffix) => base_uri + suffix,376			},377		)378	}379}380381/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension382/// @dev See https://eips.ethereum.org/EIPS/eip-721383#[solidity_interface(name = ERC721Enumerable, expect_selector = 0x780e9d63)]384impl<T: Config> NonfungibleHandle<T> {385	/// @notice Enumerate valid NFTs386	/// @param index A counter less than `totalSupply()`387	/// @return The token identifier for the `index`th NFT,388	///  (sort order not specified)389	fn token_by_index(&self, index: uint256) -> Result<uint256> {390		Ok(index)391	}392393	/// @dev Not implemented394	fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {395		// TODO: Not implemetable396		Err("not implemented".into())397	}398399	/// @notice Count NFTs tracked by this contract400	/// @return A count of valid NFTs tracked by this contract, where each one of401	///  them has an assigned and queryable owner not equal to the zero address402	fn total_supply(&self) -> Result<uint256> {403		self.consume_store_reads(1)?;404		Ok(<Pallet<T>>::total_supply(self).into())405	}406}407408/// @title ERC-721 Non-Fungible Token Standard409/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md410#[solidity_interface(name = ERC721, events(ERC721Events), expect_selector = 0x80ac58cd)]411impl<T: Config> NonfungibleHandle<T> {412	/// @notice Count all NFTs assigned to an owner413	/// @dev NFTs assigned to the zero address are considered invalid, and this414	///  function throws for queries about the zero address.415	/// @param owner An address for whom to query the balance416	/// @return The number of NFTs owned by `owner`, possibly zero417	fn balance_of(&self, owner: address) -> Result<uint256> {418		self.consume_store_reads(1)?;419		let owner = T::CrossAccountId::from_eth(owner);420		let balance = <AccountBalance<T>>::get((self.id, owner));421		Ok(balance.into())422	}423	/// @notice Find the owner of an NFT424	/// @dev NFTs assigned to zero address are considered invalid, and queries425	///  about them do throw.426	/// @param tokenId The identifier for an NFT427	/// @return The address of the owner of the NFT428	fn owner_of(&self, token_id: uint256) -> Result<address> {429		self.consume_store_reads(1)?;430		let token: TokenId = token_id.try_into()?;431		Ok(*<TokenData<T>>::get((self.id, token))432			.ok_or("token not found")?433			.owner434			.as_eth())435	}436	/// @dev Not implemented437	#[solidity(rename_selector = "safeTransferFrom")]438	fn safe_transfer_from_with_data(439		&mut self,440		_from: address,441		_to: address,442		_token_id: uint256,443		_data: bytes,444	) -> Result<void> {445		// TODO: Not implemetable446		Err("not implemented".into())447	}448	/// @dev Not implemented449	fn safe_transfer_from(450		&mut self,451		_from: address,452		_to: address,453		_token_id: uint256,454	) -> Result<void> {455		// TODO: Not implemetable456		Err("not implemented".into())457	}458459	/// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE460	///  TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE461	///  THEY MAY BE PERMANENTLY LOST462	/// @dev Throws unless `msg.sender` is the current owner or an authorized463	///  operator for this NFT. Throws if `from` is not the current owner. Throws464	///  if `to` is the zero address. Throws if `tokenId` is not a valid NFT.465	/// @param from The current owner of the NFT466	/// @param to The new owner467	/// @param tokenId The NFT to transfer468	#[weight(<SelfWeightOf<T>>::transfer_from())]469	fn transfer_from(470		&mut self,471		caller: caller,472		from: address,473		to: address,474		token_id: uint256,475	) -> Result<void> {476		let caller = T::CrossAccountId::from_eth(caller);477		let from = T::CrossAccountId::from_eth(from);478		let to = T::CrossAccountId::from_eth(to);479		let token = token_id.try_into()?;480		let budget = self481			.recorder482			.weight_calls_budget(<StructureWeight<T>>::find_parent());483484		<Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)485			.map_err(dispatch_to_evm::<T>)?;486		Ok(())487	}488489	/// @notice Set or reaffirm the approved address for an NFT490	/// @dev The zero address indicates there is no approved address.491	/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized492	///  operator of the current owner.493	/// @param approved The new approved NFT controller494	/// @param tokenId The NFT to approve495	#[weight(<SelfWeightOf<T>>::approve())]496	fn approve(&mut self, caller: caller, approved: address, token_id: uint256) -> Result<void> {497		let caller = T::CrossAccountId::from_eth(caller);498		let approved = T::CrossAccountId::from_eth(approved);499		let token = token_id.try_into()?;500501		<Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))502			.map_err(dispatch_to_evm::<T>)?;503		Ok(())504	}505506	/// @notice Sets or unsets the approval of a given operator.507	/// The `operator` is allowed to transfer all tokens of the `caller` on their behalf.508	/// @param operator Operator509	/// @param approved Should operator status be granted or revoked?510	#[weight(<SelfWeightOf<T>>::set_allowance_for_all())]511	fn set_approval_for_all(512		&mut self,513		caller: caller,514		operator: address,515		approved: bool,516	) -> Result<void> {517		let caller = T::CrossAccountId::from_eth(caller);518		let operator = T::CrossAccountId::from_eth(operator);519520		<Pallet<T>>::set_allowance_for_all(self, &caller, &operator, approved)521			.map_err(dispatch_to_evm::<T>)?;522		Ok(())523	}524525	/// @dev Not implemented526	fn get_approved(&self, _token_id: uint256) -> Result<address> {527		// TODO: Not implemetable528		Err("not implemented".into())529	}530531	/// @notice Tells whether the given `owner` approves the `operator`.532	#[weight(<SelfWeightOf<T>>::allowance_for_all())]533	fn is_approved_for_all(&self, owner: address, operator: address) -> Result<bool> {534		let owner = T::CrossAccountId::from_eth(owner);535		let operator = T::CrossAccountId::from_eth(operator);536537		Ok(<Pallet<T>>::allowance_for_all(self, &owner, &operator))538	}539540	/// @notice Returns collection helper contract address541	fn collection_helper_address(&self) -> Result<address> {542		Ok(T::ContractAddress::get())543	}544}545546/// @title ERC721 Token that can be irreversibly burned (destroyed).547#[solidity_interface(name = ERC721Burnable)]548impl<T: Config> NonfungibleHandle<T> {549	/// @notice Burns a specific ERC721 token.550	/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized551	///  operator of the current owner.552	/// @param tokenId The NFT to approve553	#[weight(<SelfWeightOf<T>>::burn_item())]554	fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {555		let caller = T::CrossAccountId::from_eth(caller);556		let token = token_id.try_into()?;557558		<Pallet<T>>::burn(self, &caller, token).map_err(dispatch_to_evm::<T>)?;559		Ok(())560	}561}562563/// @title ERC721 minting logic.564#[solidity_interface(name = ERC721UniqueMintable, events(ERC721UniqueMintableEvents))]565impl<T: Config> NonfungibleHandle<T> {566	fn minting_finished(&self) -> Result<bool> {567		Ok(false)568	}569570	/// @notice Function to mint a token.571	/// @param to The new owner572	/// @return uint256 The id of the newly minted token573	#[weight(<SelfWeightOf<T>>::create_item())]574	fn mint(&mut self, caller: caller, to: address) -> Result<uint256> {575		let token_id: uint256 = <TokensMinted<T>>::get(self.id)576			.checked_add(1)577			.ok_or("item id overflow")?578			.into();579		self.mint_check_id(caller, to, token_id)?;580		Ok(token_id)581	}582583	/// @notice Function to mint a token.584	/// @dev `tokenId` should be obtained with `nextTokenId` method,585	///  unlike standard, you can't specify it manually586	/// @param to The new owner587	/// @param tokenId ID of the minted NFT588	#[solidity(hide, rename_selector = "mint")]589	#[weight(<SelfWeightOf<T>>::create_item())]590	fn mint_check_id(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {591		let caller = T::CrossAccountId::from_eth(caller);592		let to = T::CrossAccountId::from_eth(to);593		let token_id: u32 = token_id.try_into()?;594		let budget = self595			.recorder596			.weight_calls_budget(<StructureWeight<T>>::find_parent());597598		if <TokensMinted<T>>::get(self.id)599			.checked_add(1)600			.ok_or("item id overflow")?601			!= token_id602		{603			return Err("item id should be next".into());604		}605606		<Pallet<T>>::create_item(607			self,608			&caller,609			CreateItemData::<T> {610				properties: BoundedVec::default(),611				owner: to,612			},613			&budget,614		)615		.map_err(dispatch_to_evm::<T>)?;616617		Ok(true)618	}619620	/// @notice Function to mint token with the given tokenUri.621	/// @param to The new owner622	/// @param tokenUri Token URI that would be stored in the NFT properties623	/// @return uint256 The id of the newly minted token624	#[solidity(rename_selector = "mintWithTokenURI")]625	#[weight(<SelfWeightOf<T>>::create_item())]626	fn mint_with_token_uri(627		&mut self,628		caller: caller,629		to: address,630		token_uri: string,631	) -> Result<uint256> {632		let token_id: uint256 = <TokensMinted<T>>::get(self.id)633			.checked_add(1)634			.ok_or("item id overflow")?635			.into();636		self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;637		Ok(token_id)638	}639640	/// @notice Function to mint token with the given tokenUri.641	/// @dev `tokenId` should be obtained with `nextTokenId` method,642	///  unlike standard, you can't specify it manually643	/// @param to The new owner644	/// @param tokenId ID of the minted NFT645	/// @param tokenUri Token URI that would be stored in the NFT properties646	#[solidity(hide, rename_selector = "mintWithTokenURI")]647	#[weight(<SelfWeightOf<T>>::create_item())]648	fn mint_with_token_uri_check_id(649		&mut self,650		caller: caller,651		to: address,652		token_id: uint256,653		token_uri: string,654	) -> Result<bool> {655		let key = key::url();656		let permission = get_token_permission::<T>(self.id, &key)?;657		if !permission.collection_admin {658			return Err("Operation is not allowed".into());659		}660661		let caller = T::CrossAccountId::from_eth(caller);662		let to = T::CrossAccountId::from_eth(to);663		let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;664		let budget = self665			.recorder666			.weight_calls_budget(<StructureWeight<T>>::find_parent());667668		if <TokensMinted<T>>::get(self.id)669			.checked_add(1)670			.ok_or("item id overflow")?671			!= token_id672		{673			return Err("item id should be next".into());674		}675676		let mut properties = CollectionPropertiesVec::default();677		properties678			.try_push(Property {679				key,680				value: token_uri681					.into_bytes()682					.try_into()683					.map_err(|_| "token uri is too long")?,684			})685			.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;686687		<Pallet<T>>::create_item(688			self,689			&caller,690			CreateItemData::<T> {691				properties,692				owner: to,693			},694			&budget,695		)696		.map_err(dispatch_to_evm::<T>)?;697		Ok(true)698	}699700	/// @dev Not implemented701	fn finish_minting(&mut self, _caller: caller) -> Result<bool> {702		Err("not implementable".into())703	}704}705706fn get_token_property<T: Config>(707	collection: &CollectionHandle<T>,708	token_id: u32,709	key: &up_data_structs::PropertyKey,710) -> Result<string> {711	collection.consume_store_reads(1)?;712	let properties = <TokenProperties<T>>::try_get((collection.id, token_id))713		.map_err(|_| Error::Revert("Token properties not found".into()))?;714	if let Some(property) = properties.get(key) {715		return Ok(string::from_utf8_lossy(property).into());716	}717718	Err("Property tokenURI not found".into())719}720721fn get_token_permission<T: Config>(722	collection_id: CollectionId,723	key: &PropertyKey,724) -> Result<PropertyPermission> {725	let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)726		.map_err(|_| Error::Revert("No permissions for collection".into()))?;727	let a = token_property_permissions728		.get(key)729		.map(Clone::clone)730		.ok_or_else(|| {731			let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();732			Error::Revert(alloc::format!("No permission for key {}", key))733		})?;734	Ok(a)735}736737/// @title Unique extensions for ERC721.738#[solidity_interface(name = ERC721UniqueExtensions)]739impl<T: Config> NonfungibleHandle<T>740where741	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,742{743	/// @notice A descriptive name for a collection of NFTs in this contract744	fn name(&self) -> Result<string> {745		Ok(decode_utf16(self.name.iter().copied())746			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))747			.collect::<string>())748	}749750	/// @notice An abbreviated name for NFTs in this contract751	fn symbol(&self) -> Result<string> {752		Ok(string::from_utf8_lossy(&self.token_prefix).into())753	}754755	/// @notice A description for the collection.756	fn description(&self) -> Result<string> {757		Ok(decode_utf16(self.description.iter().copied())758			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))759			.collect::<string>())760	}761762	/// Returns the owner (in cross format) of the token.763	///764	/// @param tokenId Id for the token.765	fn cross_owner_of(&self, token_id: uint256) -> Result<EthCrossAccount> {766		Self::token_owner(&self, token_id.try_into()?)767			.map(|o| EthCrossAccount::from_sub_cross_account::<T>(&o))768			.ok_or(Error::Revert("key too large".into()))769	}770771	/// Returns the token properties.772	///773	/// @param tokenId Id for the token.774	/// @param keys Properties keys. Empty keys for all propertyes.775	/// @return Vector of properties key/value pairs.776	fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {777		let keys = keys778			.into_iter()779			.map(|key| {780				<Vec<u8>>::from(key)781					.try_into()782					.map_err(|_| Error::Revert("key too large".into()))783			})784			.collect::<Result<Vec<_>>>()?;785786		<Self as CommonCollectionOperations<T>>::token_properties(787			&self,788			token_id.try_into()?,789			if keys.is_empty() { None } else { Some(keys) },790		)791		.into_iter()792		.map(|p| {793			let key = string::from_utf8(p.key.to_vec())794				.map_err(|e| Error::Revert(alloc::format!("{}", e)))?;795			let value = bytes(p.value.to_vec());796			Ok(PropertyStruct { key, value })797		})798		.collect::<Result<Vec<_>>>()799	}800801	/// @notice Set or reaffirm the approved address for an NFT802	/// @dev The zero address indicates there is no approved address.803	/// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized804	///  operator of the current owner.805	/// @param approved The new substrate address approved NFT controller806	/// @param tokenId The NFT to approve807	#[weight(<SelfWeightOf<T>>::approve())]808	fn approve_cross(809		&mut self,810		caller: caller,811		approved: EthCrossAccount,812		token_id: uint256,813	) -> Result<void> {814		let caller = T::CrossAccountId::from_eth(caller);815		let approved = approved.into_sub_cross_account::<T>()?;816		let token = token_id.try_into()?;817818		<Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))819			.map_err(dispatch_to_evm::<T>)?;820		Ok(())821	}822823	/// @notice Transfer ownership of an NFT824	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`825	///  is the zero address. Throws if `tokenId` is not a valid NFT.826	/// @param to The new owner827	/// @param tokenId The NFT to transfer828	#[weight(<SelfWeightOf<T>>::transfer())]829	fn transfer(&mut self, caller: caller, to: address, token_id: uint256) -> Result<void> {830		let caller = T::CrossAccountId::from_eth(caller);831		let to = T::CrossAccountId::from_eth(to);832		let token = token_id.try_into()?;833		let budget = self834			.recorder835			.weight_calls_budget(<StructureWeight<T>>::find_parent());836837		<Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;838		Ok(())839	}840841	/// @notice Transfer ownership of an NFT842	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`843	///  is the zero address. Throws if `tokenId` is not a valid NFT.844	/// @param to The new owner845	/// @param tokenId The NFT to transfer846	#[weight(<SelfWeightOf<T>>::transfer())]847	fn transfer_cross(848		&mut self,849		caller: caller,850		to: EthCrossAccount,851		token_id: uint256,852	) -> Result<void> {853		let caller = T::CrossAccountId::from_eth(caller);854		let to = to.into_sub_cross_account::<T>()?;855		let token = token_id.try_into()?;856		let budget = self857			.recorder858			.weight_calls_budget(<StructureWeight<T>>::find_parent());859860		<Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;861		Ok(())862	}863864	/// @notice Transfer ownership of an NFT from cross account address to cross account address865	/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`866	///  is the zero address. Throws if `tokenId` is not a valid NFT.867	/// @param from Cross acccount address of current owner868	/// @param to Cross acccount address of new owner869	/// @param tokenId The NFT to transfer870	#[weight(<SelfWeightOf<T>>::transfer())]871	fn transfer_from_cross(872		&mut self,873		caller: caller,874		from: EthCrossAccount,875		to: EthCrossAccount,876		token_id: uint256,877	) -> Result<void> {878		let caller = T::CrossAccountId::from_eth(caller);879		let from = from.into_sub_cross_account::<T>()?;880		let to = to.into_sub_cross_account::<T>()?;881		let token_id = token_id.try_into()?;882		let budget = self883			.recorder884			.weight_calls_budget(<StructureWeight<T>>::find_parent());885		Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, &budget)886			.map_err(dispatch_to_evm::<T>)?;887		Ok(())888	}889890	/// @notice Burns a specific ERC721 token.891	/// @dev Throws unless `msg.sender` is the current owner or an authorized892	///  operator for this NFT. Throws if `from` is not the current owner. Throws893	///  if `to` is the zero address. Throws if `tokenId` is not a valid NFT.894	/// @param from The current owner of the NFT895	/// @param tokenId The NFT to transfer896	#[solidity(hide)]897	#[weight(<SelfWeightOf<T>>::burn_from())]898	fn burn_from(&mut self, caller: caller, from: address, token_id: uint256) -> Result<void> {899		let caller = T::CrossAccountId::from_eth(caller);900		let from = T::CrossAccountId::from_eth(from);901		let token = token_id.try_into()?;902		let budget = self903			.recorder904			.weight_calls_budget(<StructureWeight<T>>::find_parent());905906		<Pallet<T>>::burn_from(self, &caller, &from, token, &budget)907			.map_err(dispatch_to_evm::<T>)?;908		Ok(())909	}910911	/// @notice Burns a specific ERC721 token.912	/// @dev Throws unless `msg.sender` is the current owner or an authorized913	///  operator for this NFT. Throws if `from` is not the current owner. Throws914	///  if `to` is the zero address. Throws if `tokenId` is not a valid NFT.915	/// @param from The current owner of the NFT916	/// @param tokenId The NFT to transfer917	#[weight(<SelfWeightOf<T>>::burn_from())]918	fn burn_from_cross(919		&mut self,920		caller: caller,921		from: EthCrossAccount,922		token_id: uint256,923	) -> Result<void> {924		let caller = T::CrossAccountId::from_eth(caller);925		let from = from.into_sub_cross_account::<T>()?;926		let token = token_id.try_into()?;927		let budget = self928			.recorder929			.weight_calls_budget(<StructureWeight<T>>::find_parent());930931		<Pallet<T>>::burn_from(self, &caller, &from, token, &budget)932			.map_err(dispatch_to_evm::<T>)?;933		Ok(())934	}935936	/// @notice Returns next free NFT ID.937	fn next_token_id(&self) -> Result<uint256> {938		self.consume_store_reads(1)?;939		Ok(<TokensMinted<T>>::get(self.id)940			.checked_add(1)941			.ok_or("item id overflow")?942			.into())943	}944945	/// @notice Function to mint multiple tokens.946	/// @dev `tokenIds` should be an array of consecutive numbers and first number947	///  should be obtained with `nextTokenId` method948	/// @param to The new owner949	/// @param tokenIds IDs of the minted NFTs950	#[solidity(hide)]951	#[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]952	fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {953		let caller = T::CrossAccountId::from_eth(caller);954		let to = T::CrossAccountId::from_eth(to);955		let mut expected_index = <TokensMinted<T>>::get(self.id)956			.checked_add(1)957			.ok_or("item id overflow")?;958		let budget = self959			.recorder960			.weight_calls_budget(<StructureWeight<T>>::find_parent());961962		let total_tokens = token_ids.len();963		for id in token_ids.into_iter() {964			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;965			if id != expected_index {966				return Err("item id should be next".into());967			}968			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;969		}970		let data = (0..total_tokens)971			.map(|_| CreateItemData::<T> {972				properties: BoundedVec::default(),973				owner: to.clone(),974			})975			.collect();976977		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)978			.map_err(dispatch_to_evm::<T>)?;979		Ok(true)980	}981982	/// @notice Function to mint multiple tokens with the given tokenUris.983	/// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive984	///  numbers and first number should be obtained with `nextTokenId` method985	/// @param to The new owner986	/// @param tokens array of pairs of token ID and token URI for minted tokens987	#[solidity(hide, rename_selector = "mintBulkWithTokenURI")]988	#[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]989	fn mint_bulk_with_token_uri(990		&mut self,991		caller: caller,992		to: address,993		tokens: Vec<(uint256, string)>,994	) -> Result<bool> {995		let key = key::url();996		let caller = T::CrossAccountId::from_eth(caller);997		let to = T::CrossAccountId::from_eth(to);998		let mut expected_index = <TokensMinted<T>>::get(self.id)999			.checked_add(1)1000			.ok_or("item id overflow")?;1001		let budget = self1002			.recorder1003			.weight_calls_budget(<StructureWeight<T>>::find_parent());10041005		let mut data = Vec::with_capacity(tokens.len());1006		for (id, token_uri) in tokens {1007			let id: u32 = id.try_into().map_err(|_| "token id overflow")?;1008			if id != expected_index {1009				return Err("item id should be next".into());1010			}1011			expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;10121013			let mut properties = CollectionPropertiesVec::default();1014			properties1015				.try_push(Property {1016					key: key.clone(),1017					value: token_uri1018						.into_bytes()1019						.try_into()1020						.map_err(|_| "token uri is too long")?,1021				})1022				.map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;10231024			data.push(CreateItemData::<T> {1025				properties,1026				owner: to.clone(),1027			});1028		}10291030		<Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1031			.map_err(dispatch_to_evm::<T>)?;1032		Ok(true)1033	}10341035	/// @notice Function to mint a token.1036	/// @param to The new owner crossAccountId1037	/// @param properties Properties of minted token1038	/// @return uint256 The id of the newly minted token1039	#[weight(<SelfWeightOf<T>>::create_item())]1040	fn mint_cross(1041		&mut self,1042		caller: caller,1043		to: EthCrossAccount,1044		properties: Vec<PropertyStruct>,1045	) -> Result<uint256> {1046		let token_id = <TokensMinted<T>>::get(self.id)1047			.checked_add(1)1048			.ok_or("item id overflow")?;10491050		let to = to.into_sub_cross_account::<T>()?;10511052		let properties = properties1053			.into_iter()1054			.map(|PropertyStruct { key, value }| {1055				let key = <Vec<u8>>::from(key)1056					.try_into()1057					.map_err(|_| "key too large")?;10581059				let value = value.0.try_into().map_err(|_| "value too large")?;10601061				Ok(Property { key, value })1062			})1063			.collect::<Result<Vec<_>>>()?1064			.try_into()1065			.map_err(|_| Error::Revert(alloc::format!("too many properties")))?;10661067		let caller = T::CrossAccountId::from_eth(caller);10681069		let budget = self1070			.recorder1071			.weight_calls_budget(<StructureWeight<T>>::find_parent());10721073		<Pallet<T>>::create_item(1074			self,1075			&caller,1076			CreateItemData::<T> {1077				properties,1078				owner: to,1079			},1080			&budget,1081		)1082		.map_err(dispatch_to_evm::<T>)?;10831084		Ok(token_id.into())1085	}1086}10871088#[solidity_interface(1089	name = UniqueNFT,1090	is(1091		ERC721,1092		ERC721Enumerable,1093		ERC721UniqueExtensions,1094		ERC721UniqueMintable,1095		ERC721Burnable,1096		ERC721Metadata(if(this.flags.erc721metadata)),1097		Collection(via(common_mut returns CollectionHandle<T>)),1098		TokenProperties,1099	)1100)]1101impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}11021103// Not a tests, but code generators1104generate_stubgen!(gen_impl, UniqueNFTCall<()>, true);1105generate_stubgen!(gen_iface, UniqueNFTCall<()>, false);11061107impl<T: Config> CommonEvmHandler for NonfungibleHandle<T>1108where1109	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1110{1111	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueNFT.raw");11121113	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {1114		call::<T, UniqueNFTCall<T>, _, _>(handle, self)1115	}1116}