difftreelog
chore add check in `supports_metadata`
in: master
9 files changed
pallets/nonfungible/src/erc.rsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # 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::{ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*, weight};28use frame_support::BoundedVec;29use up_data_structs::{30 TokenId, PropertyPermission, PropertyKeyPermission, Property, CollectionId, PropertyKey,31 CollectionPropertiesVec,32};33use pallet_evm_coder_substrate::dispatch_to_evm;34use sp_std::vec::Vec;35use pallet_common::{36 erc::{37 CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key,38 static_property::value,39 },40 CollectionHandle, CollectionPropertyPermissions,41};42use pallet_evm::{account::CrossAccountId, PrecompileHandle};43use pallet_evm_coder_substrate::call;44use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};4546use crate::{47 AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,48 SelfWeightOf, weights::WeightInfo, TokenProperties,49};5051/// @title A contract that allows to set and delete token properties and change token property permissions.52#[solidity_interface(name = TokenProperties)]53impl<T: Config> NonfungibleHandle<T> {54 /// @notice Set permissions for token property.55 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.56 /// @param key Property key.57 /// @param isMutable Permission to mutate property.58 /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.59 /// @param tokenOwner Permission to mutate property by token owner if property is mutable.60 fn set_token_property_permission(61 &mut self,62 caller: caller,63 key: string,64 is_mutable: bool,65 collection_admin: bool,66 token_owner: bool,67 ) -> Result<()> {68 let caller = T::CrossAccountId::from_eth(caller);69 <Pallet<T>>::set_property_permission(70 self,71 &caller,72 PropertyKeyPermission {73 key: <Vec<u8>>::from(key)74 .try_into()75 .map_err(|_| "too long key")?,76 permission: PropertyPermission {77 mutable: is_mutable,78 collection_admin,79 token_owner,80 },81 },82 )83 .map_err(dispatch_to_evm::<T>)84 }8586 /// @notice Set token property value.87 /// @dev Throws error if `msg.sender` has no permission to edit the property.88 /// @param tokenId ID of the token.89 /// @param key Property key.90 /// @param value Property value.91 fn set_property(92 &mut self,93 caller: caller,94 token_id: uint256,95 key: string,96 value: bytes,97 ) -> Result<()> {98 let caller = T::CrossAccountId::from_eth(caller);99 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;100 let key = <Vec<u8>>::from(key)101 .try_into()102 .map_err(|_| "key too long")?;103 let value = value.try_into().map_err(|_| "value too long")?;104105 let nesting_budget = self106 .recorder107 .weight_calls_budget(<StructureWeight<T>>::find_parent());108109 <Pallet<T>>::set_token_property(110 self,111 &caller,112 TokenId(token_id),113 Property { key, value },114 &nesting_budget,115 )116 .map_err(dispatch_to_evm::<T>)117 }118119 /// @notice Delete 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 fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {124 let caller = T::CrossAccountId::from_eth(caller);125 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;126 let key = <Vec<u8>>::from(key)127 .try_into()128 .map_err(|_| "key too long")?;129130 let nesting_budget = self131 .recorder132 .weight_calls_budget(<StructureWeight<T>>::find_parent());133134 <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)135 .map_err(dispatch_to_evm::<T>)136 }137138 /// @notice Get token property value.139 /// @dev Throws error if key not found140 /// @param tokenId ID of the token.141 /// @param key Property key.142 /// @return Property value bytes143 fn property(&self, token_id: uint256, key: string) -> Result<bytes> {144 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;145 let key = <Vec<u8>>::from(key)146 .try_into()147 .map_err(|_| "key too long")?;148149 let props = <TokenProperties<T>>::get((self.id, token_id));150 let prop = props.get(&key).ok_or("key not found")?;151152 Ok(prop.to_vec())153 }154}155156#[derive(ToLog)]157pub enum ERC721Events {158 /// @dev This emits when ownership of any NFT changes by any mechanism.159 /// This event emits when NFTs are created (`from` == 0) and destroyed160 /// (`to` == 0). Exception: during contract creation, any number of NFTs161 /// may be created and assigned without emitting Transfer. At the time of162 /// any transfer, the approved address for that NFT (if any) is reset to none.163 Transfer {164 #[indexed]165 from: address,166 #[indexed]167 to: address,168 #[indexed]169 token_id: uint256,170 },171 /// @dev This emits when the approved address for an NFT is changed or172 /// reaffirmed. The zero address indicates there is no approved address.173 /// When a Transfer event emits, this also indicates that the approved174 /// address for that NFT (if any) is reset to none.175 Approval {176 #[indexed]177 owner: address,178 #[indexed]179 approved: address,180 #[indexed]181 token_id: uint256,182 },183 /// @dev This emits when an operator is enabled or disabled for an owner.184 /// The operator can manage all NFTs of the owner.185 #[allow(dead_code)]186 ApprovalForAll {187 #[indexed]188 owner: address,189 #[indexed]190 operator: address,191 approved: bool,192 },193}194195#[derive(ToLog)]196pub enum ERC721MintableEvents {197 #[allow(dead_code)]198 MintingFinished {},199}200201/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension202/// @dev See https://eips.ethereum.org/EIPS/eip-721203#[solidity_interface(name = ERC721Metadata, expect_selector = 0x5b5e139f)]204impl<T: Config> NonfungibleHandle<T> {205 /// @notice A descriptive name for a collection of NFTs in this contract206 fn name(&self) -> Result<string> {207 Ok(decode_utf16(self.name.iter().copied())208 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))209 .collect::<string>())210 }211212 /// @notice An abbreviated name for NFTs in this contract213 fn symbol(&self) -> Result<string> {214 Ok(string::from_utf8_lossy(&self.token_prefix).into())215 }216217 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.218 ///219 /// @dev If the token has a `url` property and it is not empty, it is returned.220 /// 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`.221 /// If the collection property `baseURI` is empty or absent, return "" (empty string)222 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix223 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).224 ///225 /// @return token's const_metadata226 #[solidity(rename_selector = "tokenURI")]227 fn token_uri(&self, token_id: uint256) -> Result<string> {228 if !self.supports_metadata() {229 return Ok("".into());230 }231232 let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;233234 match get_token_property(self, token_id_u32, &key::url()).as_deref() {235 Err(_) | Ok("") => (),236 Ok(url) => {237 return Ok(url.into());238 }239 };240241 let base_uri =242 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())243 .map(BoundedVec::into_inner)244 .map(string::from_utf8)245 .transpose()246 .map_err(|e| {247 Error::Revert(alloc::format!(248 "Can not convert value \"baseURI\" to string with error \"{}\"",249 e250 ))251 })?;252253 let base_uri = match base_uri.as_deref() {254 None | Some("") => {255 return Ok("".into());256 }257 Some(base_uri) => base_uri.into(),258 };259260 Ok(261 match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {262 Err(_) | Ok("") => base_uri,263 Ok(suffix) => base_uri + suffix,264 },265 )266 }267}268269/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension270/// @dev See https://eips.ethereum.org/EIPS/eip-721271#[solidity_interface(name = ERC721Enumerable, expect_selector = 0x780e9d63)]272impl<T: Config> NonfungibleHandle<T> {273 /// @notice Enumerate valid NFTs274 /// @param index A counter less than `totalSupply()`275 /// @return The token identifier for the `index`th NFT,276 /// (sort order not specified)277 fn token_by_index(&self, index: uint256) -> Result<uint256> {278 Ok(index)279 }280281 /// @dev Not implemented282 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {283 // TODO: Not implemetable284 Err("not implemented".into())285 }286287 /// @notice Count NFTs tracked by this contract288 /// @return A count of valid NFTs tracked by this contract, where each one of289 /// them has an assigned and queryable owner not equal to the zero address290 fn total_supply(&self) -> Result<uint256> {291 self.consume_store_reads(1)?;292 Ok(<Pallet<T>>::total_supply(self).into())293 }294}295296/// @title ERC-721 Non-Fungible Token Standard297/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md298#[solidity_interface(name = ERC721, events(ERC721Events), expect_selector = 0x80ac58cd)]299impl<T: Config> NonfungibleHandle<T> {300 /// @notice Count all NFTs assigned to an owner301 /// @dev NFTs assigned to the zero address are considered invalid, and this302 /// function throws for queries about the zero address.303 /// @param owner An address for whom to query the balance304 /// @return The number of NFTs owned by `owner`, possibly zero305 fn balance_of(&self, owner: address) -> Result<uint256> {306 self.consume_store_reads(1)?;307 let owner = T::CrossAccountId::from_eth(owner);308 let balance = <AccountBalance<T>>::get((self.id, owner));309 Ok(balance.into())310 }311 /// @notice Find the owner of an NFT312 /// @dev NFTs assigned to zero address are considered invalid, and queries313 /// about them do throw.314 /// @param tokenId The identifier for an NFT315 /// @return The address of the owner of the NFT316 fn owner_of(&self, token_id: uint256) -> Result<address> {317 self.consume_store_reads(1)?;318 let token: TokenId = token_id.try_into()?;319 Ok(*<TokenData<T>>::get((self.id, token))320 .ok_or("token not found")?321 .owner322 .as_eth())323 }324 /// @dev Not implemented325 #[solidity(rename_selector = "safeTransferFrom")]326 fn safe_transfer_from_with_data(327 &mut self,328 _from: address,329 _to: address,330 _token_id: uint256,331 _data: bytes,332 ) -> Result<void> {333 // TODO: Not implemetable334 Err("not implemented".into())335 }336 /// @dev Not implemented337 fn safe_transfer_from(338 &mut self,339 _from: address,340 _to: address,341 _token_id: uint256,342 ) -> Result<void> {343 // TODO: Not implemetable344 Err("not implemented".into())345 }346347 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE348 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE349 /// THEY MAY BE PERMANENTLY LOST350 /// @dev Throws unless `msg.sender` is the current owner or an authorized351 /// operator for this NFT. Throws if `from` is not the current owner. Throws352 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.353 /// @param from The current owner of the NFT354 /// @param to The new owner355 /// @param tokenId The NFT to transfer356 #[weight(<SelfWeightOf<T>>::transfer_from())]357 fn transfer_from(358 &mut self,359 caller: caller,360 from: address,361 to: address,362 token_id: uint256,363 ) -> Result<void> {364 let caller = T::CrossAccountId::from_eth(caller);365 let from = T::CrossAccountId::from_eth(from);366 let to = T::CrossAccountId::from_eth(to);367 let token = token_id.try_into()?;368 let budget = self369 .recorder370 .weight_calls_budget(<StructureWeight<T>>::find_parent());371372 <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)373 .map_err(dispatch_to_evm::<T>)?;374 Ok(())375 }376377 /// @notice Set or reaffirm the approved address for an NFT378 /// @dev The zero address indicates there is no approved address.379 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized380 /// operator of the current owner.381 /// @param approved The new approved NFT controller382 /// @param tokenId The NFT to approve383 #[weight(<SelfWeightOf<T>>::approve())]384 fn approve(&mut self, caller: caller, approved: address, token_id: uint256) -> Result<void> {385 let caller = T::CrossAccountId::from_eth(caller);386 let approved = T::CrossAccountId::from_eth(approved);387 let token = token_id.try_into()?;388389 <Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))390 .map_err(dispatch_to_evm::<T>)?;391 Ok(())392 }393394 /// @dev Not implemented395 fn set_approval_for_all(396 &mut self,397 _caller: caller,398 _operator: address,399 _approved: bool,400 ) -> Result<void> {401 // TODO: Not implemetable402 Err("not implemented".into())403 }404405 /// @dev Not implemented406 fn get_approved(&self, _token_id: uint256) -> Result<address> {407 // TODO: Not implemetable408 Err("not implemented".into())409 }410411 /// @dev Not implemented412 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {413 // TODO: Not implemetable414 Err("not implemented".into())415 }416}417418/// @title ERC721 Token that can be irreversibly burned (destroyed).419#[solidity_interface(name = ERC721Burnable)]420impl<T: Config> NonfungibleHandle<T> {421 /// @notice Burns a specific ERC721 token.422 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized423 /// operator of the current owner.424 /// @param tokenId The NFT to approve425 #[weight(<SelfWeightOf<T>>::burn_item())]426 fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {427 let caller = T::CrossAccountId::from_eth(caller);428 let token = token_id.try_into()?;429430 <Pallet<T>>::burn(self, &caller, token).map_err(dispatch_to_evm::<T>)?;431 Ok(())432 }433}434435/// @title ERC721 minting logic.436#[solidity_interface(name = ERC721Mintable, events(ERC721MintableEvents))]437impl<T: Config> NonfungibleHandle<T> {438 fn minting_finished(&self) -> Result<bool> {439 Ok(false)440 }441442 /// @notice Function to mint token.443 /// @dev `tokenId` should be obtained with `nextTokenId` method,444 /// unlike standard, you can't specify it manually445 /// @param to The new owner446 /// @param tokenId ID of the minted NFT447 #[weight(<SelfWeightOf<T>>::create_item())]448 fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {449 let caller = T::CrossAccountId::from_eth(caller);450 let to = T::CrossAccountId::from_eth(to);451 let token_id: u32 = token_id.try_into()?;452 let budget = self453 .recorder454 .weight_calls_budget(<StructureWeight<T>>::find_parent());455456 if <TokensMinted<T>>::get(self.id)457 .checked_add(1)458 .ok_or("item id overflow")?459 != token_id460 {461 return Err("item id should be next".into());462 }463464 <Pallet<T>>::create_item(465 self,466 &caller,467 CreateItemData::<T> {468 properties: BoundedVec::default(),469 owner: to,470 },471 &budget,472 )473 .map_err(dispatch_to_evm::<T>)?;474475 Ok(true)476 }477478 /// @notice Function to mint token with the given tokenUri.479 /// @dev `tokenId` should be obtained with `nextTokenId` method,480 /// unlike standard, you can't specify it manually481 /// @param to The new owner482 /// @param tokenId ID of the minted NFT483 /// @param tokenUri Token URI that would be stored in the NFT properties484 #[solidity(rename_selector = "mintWithTokenURI")]485 #[weight(<SelfWeightOf<T>>::create_item())]486 fn mint_with_token_uri(487 &mut self,488 caller: caller,489 to: address,490 token_id: uint256,491 token_uri: string,492 ) -> Result<bool> {493 let key = key::url();494 let permission = get_token_permission::<T>(self.id, &key)?;495 if !permission.collection_admin {496 return Err("Operation is not allowed".into());497 }498499 let caller = T::CrossAccountId::from_eth(caller);500 let to = T::CrossAccountId::from_eth(to);501 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;502 let budget = self503 .recorder504 .weight_calls_budget(<StructureWeight<T>>::find_parent());505506 if <TokensMinted<T>>::get(self.id)507 .checked_add(1)508 .ok_or("item id overflow")?509 != token_id510 {511 return Err("item id should be next".into());512 }513514 let mut properties = CollectionPropertiesVec::default();515 properties516 .try_push(Property {517 key,518 value: token_uri519 .into_bytes()520 .try_into()521 .map_err(|_| "token uri is too long")?,522 })523 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;524525 <Pallet<T>>::create_item(526 self,527 &caller,528 CreateItemData::<T> {529 properties,530 owner: to,531 },532 &budget,533 )534 .map_err(dispatch_to_evm::<T>)?;535 Ok(true)536 }537538 /// @dev Not implemented539 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {540 Err("not implementable".into())541 }542}543544fn get_token_property<T: Config>(545 collection: &CollectionHandle<T>,546 token_id: u32,547 key: &up_data_structs::PropertyKey,548) -> Result<string> {549 collection.consume_store_reads(1)?;550 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))551 .map_err(|_| Error::Revert("Token properties not found".into()))?;552 if let Some(property) = properties.get(key) {553 return Ok(string::from_utf8_lossy(property).into());554 }555556 Err("Property tokenURI not found".into())557}558559fn get_token_permission<T: Config>(560 collection_id: CollectionId,561 key: &PropertyKey,562) -> Result<PropertyPermission> {563 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)564 .map_err(|_| Error::Revert("No permissions for collection".into()))?;565 let a = token_property_permissions566 .get(key)567 .map(Clone::clone)568 .ok_or_else(|| {569 let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();570 Error::Revert(alloc::format!("No permission for key {}", key))571 })?;572 Ok(a)573}574575/// @title Unique extensions for ERC721.576#[solidity_interface(name = ERC721UniqueExtensions)]577impl<T: Config> NonfungibleHandle<T> {578 /// @notice Transfer ownership of an NFT579 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`580 /// is the zero address. Throws if `tokenId` is not a valid NFT.581 /// @param to The new owner582 /// @param tokenId The NFT to transfer583 #[weight(<SelfWeightOf<T>>::transfer())]584 fn transfer(&mut self, caller: caller, to: address, token_id: uint256) -> Result<void> {585 let caller = T::CrossAccountId::from_eth(caller);586 let to = T::CrossAccountId::from_eth(to);587 let token = token_id.try_into()?;588 let budget = self589 .recorder590 .weight_calls_budget(<StructureWeight<T>>::find_parent());591592 <Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;593 Ok(())594 }595596 /// @notice Burns a specific ERC721 token.597 /// @dev Throws unless `msg.sender` is the current owner or an authorized598 /// operator for this NFT. Throws if `from` is not the current owner. Throws599 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.600 /// @param from The current owner of the NFT601 /// @param tokenId The NFT to transfer602 #[weight(<SelfWeightOf<T>>::burn_from())]603 fn burn_from(&mut self, caller: caller, from: address, token_id: uint256) -> Result<void> {604 let caller = T::CrossAccountId::from_eth(caller);605 let from = T::CrossAccountId::from_eth(from);606 let token = token_id.try_into()?;607 let budget = self608 .recorder609 .weight_calls_budget(<StructureWeight<T>>::find_parent());610611 <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)612 .map_err(dispatch_to_evm::<T>)?;613 Ok(())614 }615616 /// @notice Returns next free NFT ID.617 fn next_token_id(&self) -> Result<uint256> {618 self.consume_store_reads(1)?;619 Ok(<TokensMinted<T>>::get(self.id)620 .checked_add(1)621 .ok_or("item id overflow")?622 .into())623 }624625 /// @notice Function to mint multiple tokens.626 /// @dev `tokenIds` should be an array of consecutive numbers and first number627 /// should be obtained with `nextTokenId` method628 /// @param to The new owner629 /// @param tokenIds IDs of the minted NFTs630 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]631 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {632 let caller = T::CrossAccountId::from_eth(caller);633 let to = T::CrossAccountId::from_eth(to);634 let mut expected_index = <TokensMinted<T>>::get(self.id)635 .checked_add(1)636 .ok_or("item id overflow")?;637 let budget = self638 .recorder639 .weight_calls_budget(<StructureWeight<T>>::find_parent());640641 let total_tokens = token_ids.len();642 for id in token_ids.into_iter() {643 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;644 if id != expected_index {645 return Err("item id should be next".into());646 }647 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;648 }649 let data = (0..total_tokens)650 .map(|_| CreateItemData::<T> {651 properties: BoundedVec::default(),652 owner: to.clone(),653 })654 .collect();655656 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)657 .map_err(dispatch_to_evm::<T>)?;658 Ok(true)659 }660661 /// @notice Function to mint multiple tokens with the given tokenUris.662 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive663 /// numbers and first number should be obtained with `nextTokenId` method664 /// @param to The new owner665 /// @param tokens array of pairs of token ID and token URI for minted tokens666 #[solidity(rename_selector = "mintBulkWithTokenURI")]667 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]668 fn mint_bulk_with_token_uri(669 &mut self,670 caller: caller,671 to: address,672 tokens: Vec<(uint256, string)>,673 ) -> Result<bool> {674 let key = key::url();675 let caller = T::CrossAccountId::from_eth(caller);676 let to = T::CrossAccountId::from_eth(to);677 let mut expected_index = <TokensMinted<T>>::get(self.id)678 .checked_add(1)679 .ok_or("item id overflow")?;680 let budget = self681 .recorder682 .weight_calls_budget(<StructureWeight<T>>::find_parent());683684 let mut data = Vec::with_capacity(tokens.len());685 for (id, token_uri) in tokens {686 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;687 if id != expected_index {688 return Err("item id should be next".into());689 }690 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;691692 let mut properties = CollectionPropertiesVec::default();693 properties694 .try_push(Property {695 key: key.clone(),696 value: token_uri697 .into_bytes()698 .try_into()699 .map_err(|_| "token uri is too long")?,700 })701 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;702703 data.push(CreateItemData::<T> {704 properties,705 owner: to.clone(),706 });707 }708709 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)710 .map_err(dispatch_to_evm::<T>)?;711 Ok(true)712 }713}714715impl<T: Config> NonfungibleHandle<T> {716 pub fn supports_metadata(&self) -> bool {717 if let Some(erc721_metadata) =718 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::erc721_metadata())719 {720 *erc721_metadata.into_inner() == *value::ERC721_METADATA_SUPPORTED721 } else {722 false723 }724 }725}726727#[solidity_interface(728 name = UniqueNFT,729 is(730 ERC721,731 ERC721Enumerable,732 ERC721UniqueExtensions,733 ERC721Mintable,734 ERC721Burnable,735 Collection(via(common_mut returns CollectionHandle<T>)),736 TokenProperties,737 ERC721Metadata(if(this.supports_metadata())),738 )739)]740impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}741742// Not a tests, but code generators743generate_stubgen!(gen_impl, UniqueNFTCall<()>, true);744generate_stubgen!(gen_iface, UniqueNFTCall<()>, false);745746impl<T: Config> CommonEvmHandler for NonfungibleHandle<T>747where748 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,749{750 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueNFT.raw");751752 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {753 call::<T, UniqueNFTCall<T>, _, _>(handle, self)754 }755}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::{ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*, weight};28use frame_support::BoundedVec;29use up_data_structs::{30 TokenId, PropertyPermission, PropertyKeyPermission, Property, CollectionId, PropertyKey,31 CollectionPropertiesVec,32};33use pallet_evm_coder_substrate::dispatch_to_evm;34use sp_std::vec::Vec;35use pallet_common::{36 erc::{37 CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key,38 static_property::value,39 },40 CollectionHandle, CollectionPropertyPermissions,41};42use pallet_evm::{account::CrossAccountId, PrecompileHandle};43use pallet_evm_coder_substrate::call;44use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};4546use crate::{47 AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,48 SelfWeightOf, weights::WeightInfo, TokenProperties,49};5051/// @title A contract that allows to set and delete token properties and change token property permissions.52#[solidity_interface(name = TokenProperties)]53impl<T: Config> NonfungibleHandle<T> {54 /// @notice Set permissions for token property.55 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.56 /// @param key Property key.57 /// @param isMutable Permission to mutate property.58 /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.59 /// @param tokenOwner Permission to mutate property by token owner if property is mutable.60 fn set_token_property_permission(61 &mut self,62 caller: caller,63 key: string,64 is_mutable: bool,65 collection_admin: bool,66 token_owner: bool,67 ) -> Result<()> {68 let caller = T::CrossAccountId::from_eth(caller);69 <Pallet<T>>::set_property_permission(70 self,71 &caller,72 PropertyKeyPermission {73 key: <Vec<u8>>::from(key)74 .try_into()75 .map_err(|_| "too long key")?,76 permission: PropertyPermission {77 mutable: is_mutable,78 collection_admin,79 token_owner,80 },81 },82 )83 .map_err(dispatch_to_evm::<T>)84 }8586 /// @notice Set token property value.87 /// @dev Throws error if `msg.sender` has no permission to edit the property.88 /// @param tokenId ID of the token.89 /// @param key Property key.90 /// @param value Property value.91 fn set_property(92 &mut self,93 caller: caller,94 token_id: uint256,95 key: string,96 value: bytes,97 ) -> Result<()> {98 let caller = T::CrossAccountId::from_eth(caller);99 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;100 let key = <Vec<u8>>::from(key)101 .try_into()102 .map_err(|_| "key too long")?;103 let value = value.try_into().map_err(|_| "value too long")?;104105 let nesting_budget = self106 .recorder107 .weight_calls_budget(<StructureWeight<T>>::find_parent());108109 <Pallet<T>>::set_token_property(110 self,111 &caller,112 TokenId(token_id),113 Property { key, value },114 &nesting_budget,115 )116 .map_err(dispatch_to_evm::<T>)117 }118119 /// @notice Delete 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 fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {124 let caller = T::CrossAccountId::from_eth(caller);125 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;126 let key = <Vec<u8>>::from(key)127 .try_into()128 .map_err(|_| "key too long")?;129130 let nesting_budget = self131 .recorder132 .weight_calls_budget(<StructureWeight<T>>::find_parent());133134 <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)135 .map_err(dispatch_to_evm::<T>)136 }137138 /// @notice Get token property value.139 /// @dev Throws error if key not found140 /// @param tokenId ID of the token.141 /// @param key Property key.142 /// @return Property value bytes143 fn property(&self, token_id: uint256, key: string) -> Result<bytes> {144 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;145 let key = <Vec<u8>>::from(key)146 .try_into()147 .map_err(|_| "key too long")?;148149 let props = <TokenProperties<T>>::get((self.id, token_id));150 let prop = props.get(&key).ok_or("key not found")?;151152 Ok(prop.to_vec())153 }154}155156#[derive(ToLog)]157pub enum ERC721Events {158 /// @dev This emits when ownership of any NFT changes by any mechanism.159 /// This event emits when NFTs are created (`from` == 0) and destroyed160 /// (`to` == 0). Exception: during contract creation, any number of NFTs161 /// may be created and assigned without emitting Transfer. At the time of162 /// any transfer, the approved address for that NFT (if any) is reset to none.163 Transfer {164 #[indexed]165 from: address,166 #[indexed]167 to: address,168 #[indexed]169 token_id: uint256,170 },171 /// @dev This emits when the approved address for an NFT is changed or172 /// reaffirmed. The zero address indicates there is no approved address.173 /// When a Transfer event emits, this also indicates that the approved174 /// address for that NFT (if any) is reset to none.175 Approval {176 #[indexed]177 owner: address,178 #[indexed]179 approved: address,180 #[indexed]181 token_id: uint256,182 },183 /// @dev This emits when an operator is enabled or disabled for an owner.184 /// The operator can manage all NFTs of the owner.185 #[allow(dead_code)]186 ApprovalForAll {187 #[indexed]188 owner: address,189 #[indexed]190 operator: address,191 approved: bool,192 },193}194195#[derive(ToLog)]196pub enum ERC721MintableEvents {197 #[allow(dead_code)]198 MintingFinished {},199}200201/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension202/// @dev See https://eips.ethereum.org/EIPS/eip-721203#[solidity_interface(name = ERC721Metadata, expect_selector = 0x5b5e139f)]204impl<T: Config> NonfungibleHandle<T> {205 /// @notice A descriptive name for a collection of NFTs in this contract206 fn name(&self) -> Result<string> {207 Ok(decode_utf16(self.name.iter().copied())208 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))209 .collect::<string>())210 }211212 /// @notice An abbreviated name for NFTs in this contract213 fn symbol(&self) -> Result<string> {214 Ok(string::from_utf8_lossy(&self.token_prefix).into())215 }216217 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.218 ///219 /// @dev If the token has a `url` property and it is not empty, it is returned.220 /// 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`.221 /// If the collection property `baseURI` is empty or absent, return "" (empty string)222 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix223 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).224 ///225 /// @return token's const_metadata226 #[solidity(rename_selector = "tokenURI")]227 fn token_uri(&self, token_id: uint256) -> Result<string> {228 let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;229230 match get_token_property(self, token_id_u32, &key::url()).as_deref() {231 Err(_) | Ok("") => (),232 Ok(url) => {233 return Ok(url.into());234 }235 };236237 let base_uri =238 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())239 .map(BoundedVec::into_inner)240 .map(string::from_utf8)241 .transpose()242 .map_err(|e| {243 Error::Revert(alloc::format!(244 "Can not convert value \"baseURI\" to string with error \"{}\"",245 e246 ))247 })?;248249 let base_uri = match base_uri.as_deref() {250 None | Some("") => {251 return Ok("".into());252 }253 Some(base_uri) => base_uri.into(),254 };255256 Ok(257 match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {258 Err(_) | Ok("") => base_uri,259 Ok(suffix) => base_uri + suffix,260 },261 )262 }263}264265/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension266/// @dev See https://eips.ethereum.org/EIPS/eip-721267#[solidity_interface(name = ERC721Enumerable, expect_selector = 0x780e9d63)]268impl<T: Config> NonfungibleHandle<T> {269 /// @notice Enumerate valid NFTs270 /// @param index A counter less than `totalSupply()`271 /// @return The token identifier for the `index`th NFT,272 /// (sort order not specified)273 fn token_by_index(&self, index: uint256) -> Result<uint256> {274 Ok(index)275 }276277 /// @dev Not implemented278 fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {279 // TODO: Not implemetable280 Err("not implemented".into())281 }282283 /// @notice Count NFTs tracked by this contract284 /// @return A count of valid NFTs tracked by this contract, where each one of285 /// them has an assigned and queryable owner not equal to the zero address286 fn total_supply(&self) -> Result<uint256> {287 self.consume_store_reads(1)?;288 Ok(<Pallet<T>>::total_supply(self).into())289 }290}291292/// @title ERC-721 Non-Fungible Token Standard293/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md294#[solidity_interface(name = ERC721, events(ERC721Events), expect_selector = 0x80ac58cd)]295impl<T: Config> NonfungibleHandle<T> {296 /// @notice Count all NFTs assigned to an owner297 /// @dev NFTs assigned to the zero address are considered invalid, and this298 /// function throws for queries about the zero address.299 /// @param owner An address for whom to query the balance300 /// @return The number of NFTs owned by `owner`, possibly zero301 fn balance_of(&self, owner: address) -> Result<uint256> {302 self.consume_store_reads(1)?;303 let owner = T::CrossAccountId::from_eth(owner);304 let balance = <AccountBalance<T>>::get((self.id, owner));305 Ok(balance.into())306 }307 /// @notice Find the owner of an NFT308 /// @dev NFTs assigned to zero address are considered invalid, and queries309 /// about them do throw.310 /// @param tokenId The identifier for an NFT311 /// @return The address of the owner of the NFT312 fn owner_of(&self, token_id: uint256) -> Result<address> {313 self.consume_store_reads(1)?;314 let token: TokenId = token_id.try_into()?;315 Ok(*<TokenData<T>>::get((self.id, token))316 .ok_or("token not found")?317 .owner318 .as_eth())319 }320 /// @dev Not implemented321 #[solidity(rename_selector = "safeTransferFrom")]322 fn safe_transfer_from_with_data(323 &mut self,324 _from: address,325 _to: address,326 _token_id: uint256,327 _data: bytes,328 ) -> Result<void> {329 // TODO: Not implemetable330 Err("not implemented".into())331 }332 /// @dev Not implemented333 fn safe_transfer_from(334 &mut self,335 _from: address,336 _to: address,337 _token_id: uint256,338 ) -> Result<void> {339 // TODO: Not implemetable340 Err("not implemented".into())341 }342343 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE344 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE345 /// THEY MAY BE PERMANENTLY LOST346 /// @dev Throws unless `msg.sender` is the current owner or an authorized347 /// operator for this NFT. Throws if `from` is not the current owner. Throws348 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.349 /// @param from The current owner of the NFT350 /// @param to The new owner351 /// @param tokenId The NFT to transfer352 #[weight(<SelfWeightOf<T>>::transfer_from())]353 fn transfer_from(354 &mut self,355 caller: caller,356 from: address,357 to: address,358 token_id: uint256,359 ) -> Result<void> {360 let caller = T::CrossAccountId::from_eth(caller);361 let from = T::CrossAccountId::from_eth(from);362 let to = T::CrossAccountId::from_eth(to);363 let token = token_id.try_into()?;364 let budget = self365 .recorder366 .weight_calls_budget(<StructureWeight<T>>::find_parent());367368 <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)369 .map_err(dispatch_to_evm::<T>)?;370 Ok(())371 }372373 /// @notice Set or reaffirm the approved address for an NFT374 /// @dev The zero address indicates there is no approved address.375 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized376 /// operator of the current owner.377 /// @param approved The new approved NFT controller378 /// @param tokenId The NFT to approve379 #[weight(<SelfWeightOf<T>>::approve())]380 fn approve(&mut self, caller: caller, approved: address, token_id: uint256) -> Result<void> {381 let caller = T::CrossAccountId::from_eth(caller);382 let approved = T::CrossAccountId::from_eth(approved);383 let token = token_id.try_into()?;384385 <Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))386 .map_err(dispatch_to_evm::<T>)?;387 Ok(())388 }389390 /// @dev Not implemented391 fn set_approval_for_all(392 &mut self,393 _caller: caller,394 _operator: address,395 _approved: bool,396 ) -> Result<void> {397 // TODO: Not implemetable398 Err("not implemented".into())399 }400401 /// @dev Not implemented402 fn get_approved(&self, _token_id: uint256) -> Result<address> {403 // TODO: Not implemetable404 Err("not implemented".into())405 }406407 /// @dev Not implemented408 fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {409 // TODO: Not implemetable410 Err("not implemented".into())411 }412}413414/// @title ERC721 Token that can be irreversibly burned (destroyed).415#[solidity_interface(name = ERC721Burnable)]416impl<T: Config> NonfungibleHandle<T> {417 /// @notice Burns a specific ERC721 token.418 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized419 /// operator of the current owner.420 /// @param tokenId The NFT to approve421 #[weight(<SelfWeightOf<T>>::burn_item())]422 fn burn(&mut self, caller: caller, token_id: uint256) -> Result<void> {423 let caller = T::CrossAccountId::from_eth(caller);424 let token = token_id.try_into()?;425426 <Pallet<T>>::burn(self, &caller, token).map_err(dispatch_to_evm::<T>)?;427 Ok(())428 }429}430431/// @title ERC721 minting logic.432#[solidity_interface(name = ERC721Mintable, events(ERC721MintableEvents))]433impl<T: Config> NonfungibleHandle<T> {434 fn minting_finished(&self) -> Result<bool> {435 Ok(false)436 }437438 /// @notice Function to mint token.439 /// @dev `tokenId` should be obtained with `nextTokenId` method,440 /// unlike standard, you can't specify it manually441 /// @param to The new owner442 /// @param tokenId ID of the minted NFT443 #[weight(<SelfWeightOf<T>>::create_item())]444 fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {445 let caller = T::CrossAccountId::from_eth(caller);446 let to = T::CrossAccountId::from_eth(to);447 let token_id: u32 = token_id.try_into()?;448 let budget = self449 .recorder450 .weight_calls_budget(<StructureWeight<T>>::find_parent());451452 if <TokensMinted<T>>::get(self.id)453 .checked_add(1)454 .ok_or("item id overflow")?455 != token_id456 {457 return Err("item id should be next".into());458 }459460 <Pallet<T>>::create_item(461 self,462 &caller,463 CreateItemData::<T> {464 properties: BoundedVec::default(),465 owner: to,466 },467 &budget,468 )469 .map_err(dispatch_to_evm::<T>)?;470471 Ok(true)472 }473474 /// @notice Function to mint token with the given tokenUri.475 /// @dev `tokenId` should be obtained with `nextTokenId` method,476 /// unlike standard, you can't specify it manually477 /// @param to The new owner478 /// @param tokenId ID of the minted NFT479 /// @param tokenUri Token URI that would be stored in the NFT properties480 #[solidity(rename_selector = "mintWithTokenURI")]481 #[weight(<SelfWeightOf<T>>::create_item())]482 fn mint_with_token_uri(483 &mut self,484 caller: caller,485 to: address,486 token_id: uint256,487 token_uri: string,488 ) -> Result<bool> {489 let key = key::url();490 let permission = get_token_permission::<T>(self.id, &key)?;491 if !permission.collection_admin {492 return Err("Operation is not allowed".into());493 }494495 let caller = T::CrossAccountId::from_eth(caller);496 let to = T::CrossAccountId::from_eth(to);497 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;498 let budget = self499 .recorder500 .weight_calls_budget(<StructureWeight<T>>::find_parent());501502 if <TokensMinted<T>>::get(self.id)503 .checked_add(1)504 .ok_or("item id overflow")?505 != token_id506 {507 return Err("item id should be next".into());508 }509510 let mut properties = CollectionPropertiesVec::default();511 properties512 .try_push(Property {513 key,514 value: token_uri515 .into_bytes()516 .try_into()517 .map_err(|_| "token uri is too long")?,518 })519 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;520521 <Pallet<T>>::create_item(522 self,523 &caller,524 CreateItemData::<T> {525 properties,526 owner: to,527 },528 &budget,529 )530 .map_err(dispatch_to_evm::<T>)?;531 Ok(true)532 }533534 /// @dev Not implemented535 fn finish_minting(&mut self, _caller: caller) -> Result<bool> {536 Err("not implementable".into())537 }538}539540fn get_token_property<T: Config>(541 collection: &CollectionHandle<T>,542 token_id: u32,543 key: &up_data_structs::PropertyKey,544) -> Result<string> {545 collection.consume_store_reads(1)?;546 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))547 .map_err(|_| Error::Revert("Token properties not found".into()))?;548 if let Some(property) = properties.get(key) {549 return Ok(string::from_utf8_lossy(property).into());550 }551552 Err("Property tokenURI not found".into())553}554555fn get_token_permission<T: Config>(556 collection_id: CollectionId,557 key: &PropertyKey,558) -> Result<PropertyPermission> {559 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)560 .map_err(|_| Error::Revert("No permissions for collection".into()))?;561 let a = token_property_permissions562 .get(key)563 .map(Clone::clone)564 .ok_or_else(|| {565 let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();566 Error::Revert(alloc::format!("No permission for key {}", key))567 })?;568 Ok(a)569}570571/// @title Unique extensions for ERC721.572#[solidity_interface(name = ERC721UniqueExtensions)]573impl<T: Config> NonfungibleHandle<T> {574 /// @notice Transfer ownership of an NFT575 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`576 /// is the zero address. Throws if `tokenId` is not a valid NFT.577 /// @param to The new owner578 /// @param tokenId The NFT to transfer579 #[weight(<SelfWeightOf<T>>::transfer())]580 fn transfer(&mut self, caller: caller, to: address, token_id: uint256) -> Result<void> {581 let caller = T::CrossAccountId::from_eth(caller);582 let to = T::CrossAccountId::from_eth(to);583 let token = token_id.try_into()?;584 let budget = self585 .recorder586 .weight_calls_budget(<StructureWeight<T>>::find_parent());587588 <Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;589 Ok(())590 }591592 /// @notice Burns a specific ERC721 token.593 /// @dev Throws unless `msg.sender` is the current owner or an authorized594 /// operator for this NFT. Throws if `from` is not the current owner. Throws595 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.596 /// @param from The current owner of the NFT597 /// @param tokenId The NFT to transfer598 #[weight(<SelfWeightOf<T>>::burn_from())]599 fn burn_from(&mut self, caller: caller, from: address, token_id: uint256) -> Result<void> {600 let caller = T::CrossAccountId::from_eth(caller);601 let from = T::CrossAccountId::from_eth(from);602 let token = token_id.try_into()?;603 let budget = self604 .recorder605 .weight_calls_budget(<StructureWeight<T>>::find_parent());606607 <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)608 .map_err(dispatch_to_evm::<T>)?;609 Ok(())610 }611612 /// @notice Returns next free NFT ID.613 fn next_token_id(&self) -> Result<uint256> {614 self.consume_store_reads(1)?;615 Ok(<TokensMinted<T>>::get(self.id)616 .checked_add(1)617 .ok_or("item id overflow")?618 .into())619 }620621 /// @notice Function to mint multiple tokens.622 /// @dev `tokenIds` should be an array of consecutive numbers and first number623 /// should be obtained with `nextTokenId` method624 /// @param to The new owner625 /// @param tokenIds IDs of the minted NFTs626 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]627 fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {628 let caller = T::CrossAccountId::from_eth(caller);629 let to = T::CrossAccountId::from_eth(to);630 let mut expected_index = <TokensMinted<T>>::get(self.id)631 .checked_add(1)632 .ok_or("item id overflow")?;633 let budget = self634 .recorder635 .weight_calls_budget(<StructureWeight<T>>::find_parent());636637 let total_tokens = token_ids.len();638 for id in token_ids.into_iter() {639 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;640 if id != expected_index {641 return Err("item id should be next".into());642 }643 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;644 }645 let data = (0..total_tokens)646 .map(|_| CreateItemData::<T> {647 properties: BoundedVec::default(),648 owner: to.clone(),649 })650 .collect();651652 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)653 .map_err(dispatch_to_evm::<T>)?;654 Ok(true)655 }656657 /// @notice Function to mint multiple tokens with the given tokenUris.658 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive659 /// numbers and first number should be obtained with `nextTokenId` method660 /// @param to The new owner661 /// @param tokens array of pairs of token ID and token URI for minted tokens662 #[solidity(rename_selector = "mintBulkWithTokenURI")]663 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]664 fn mint_bulk_with_token_uri(665 &mut self,666 caller: caller,667 to: address,668 tokens: Vec<(uint256, string)>,669 ) -> Result<bool> {670 let key = key::url();671 let caller = T::CrossAccountId::from_eth(caller);672 let to = T::CrossAccountId::from_eth(to);673 let mut expected_index = <TokensMinted<T>>::get(self.id)674 .checked_add(1)675 .ok_or("item id overflow")?;676 let budget = self677 .recorder678 .weight_calls_budget(<StructureWeight<T>>::find_parent());679680 let mut data = Vec::with_capacity(tokens.len());681 for (id, token_uri) in tokens {682 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;683 if id != expected_index {684 return Err("item id should be next".into());685 }686 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;687688 let mut properties = CollectionPropertiesVec::default();689 properties690 .try_push(Property {691 key: key.clone(),692 value: token_uri693 .into_bytes()694 .try_into()695 .map_err(|_| "token uri is too long")?,696 })697 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;698699 data.push(CreateItemData::<T> {700 properties,701 owner: to.clone(),702 });703 }704705 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)706 .map_err(dispatch_to_evm::<T>)?;707 Ok(true)708 }709}710711impl<T: Config> NonfungibleHandle<T> {712 pub fn supports_metadata(&self) -> bool {713 let has_metadata_support_enabled = if let Some(erc721_metadata) =714 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::erc721_metadata())715 {716 *erc721_metadata.into_inner() == *value::ERC721_METADATA_SUPPORTED717 } else {718 false719 };720721 let has_url_property_permissions = get_token_permission::<T>(self.id, &key::url()).is_ok();722723 has_metadata_support_enabled && has_url_property_permissions724 }725}726727#[solidity_interface(728 name = UniqueNFT,729 is(730 ERC721,731 ERC721Enumerable,732 ERC721UniqueExtensions,733 ERC721Mintable,734 ERC721Burnable,735 Collection(via(common_mut returns CollectionHandle<T>)),736 TokenProperties,737 ERC721Metadata(if(this.supports_metadata())),738 )739)]740impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}741742// Not a tests, but code generators743generate_stubgen!(gen_impl, UniqueNFTCall<()>, true);744generate_stubgen!(gen_iface, UniqueNFTCall<()>, false);745746impl<T: Config> CommonEvmHandler for NonfungibleHandle<T>747where748 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,749{750 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueNFT.raw");751752 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {753 call::<T, UniqueNFTCall<T>, _, _>(handle, self)754 }755}pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -108,7 +108,6 @@
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_common::{
Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,
- erc::static_property::{key, value},
eth::collection_id_to_address,
};
use pallet_structure::{Pallet as PalletStructure, Error as StructureError};
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -218,10 +218,6 @@
/// @return token's const_metadata
#[solidity(rename_selector = "tokenURI")]
fn token_uri(&self, token_id: uint256) -> Result<string> {
- if !self.supports_metadata() {
- return Ok("".into());
- }
-
let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
match get_token_property(self, token_id_u32, &key::url()).as_deref() {
@@ -770,13 +766,17 @@
impl<T: Config> RefungibleHandle<T> {
pub fn supports_metadata(&self) -> bool {
- if let Some(erc721_metadata) =
+ let has_metadata_support_enabled = if let Some(erc721_metadata) =
pallet_common::Pallet::<T>::get_collection_property(self.id, &key::erc721_metadata())
{
*erc721_metadata.into_inner() == *value::ERC721_METADATA_SUPPORTED
} else {
false
- }
+ };
+
+ let has_url_property_permissions = get_token_permission::<T>(self.id, &key::url()).is_ok();
+
+ has_metadata_support_enabled && has_url_property_permissions
}
}
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -101,10 +101,7 @@
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_evm_coder_substrate::WithRecorder;
use pallet_common::{
- CommonCollectionOperations,
- erc::static_property::{key, value},
- Error as CommonError,
- eth::collection_id_to_address,
+ CommonCollectionOperations, Error as CommonError, eth::collection_id_to_address,
Event as CommonEvent, Pallet as PalletCommon,
};
use pallet_structure::Pallet as PalletStructure;
tests/src/eth/base.test.tsdiffbeforeafterboth--- a/tests/src/eth/base.test.ts
+++ b/tests/src/eth/base.test.ts
@@ -80,7 +80,23 @@
await usingEthPlaygrounds(async (helper, privateKey) => {
const donor = privateKey('//Alice');
const [alice] = await helper.arrange.createAccounts([10n], donor);
- ({collectionId: collection} = await helper.nft.mintCollection(alice, {name: 'test', description: 'test', tokenPrefix: 'test', properties: [{key: 'ERC721Metadata', value: '1'}]}));
+ ({collectionId: collection} = await helper.nft.mintCollection(
+ alice,
+ {
+ name: 'test',
+ description: 'test',
+ tokenPrefix: 'test',
+ properties: [{key: 'ERC721Metadata', value: '1'}],
+ tokenPropertyPermissions: [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }],
+ },
+ ));
minter = helper.eth.createAccount();
});
});
tests/src/eth/collectionProperties.test.tsdiffbeforeafterboth--- a/tests/src/eth/collectionProperties.test.ts
+++ b/tests/src/eth/collectionProperties.test.ts
@@ -67,7 +67,15 @@
itEth('ERC721Metadata property can be set for NFT collection', async({helper}) => {
const caller = await helper.eth.createAccountWithBalance(donor);
- const collection = await helper.nft.mintCollection(donor, {name: 'col', description: 'descr', tokenPrefix: 'COL'});
+ const tokenPropertyPermissions = [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }];
+ const collection = await helper.nft.mintCollection(donor, {name: 'col', description: 'descr', tokenPrefix: 'COL', tokenPropertyPermissions});
await collection.addAdmin(donor, {Ethereum: caller});
const contract = helper.ethNativeContract.collectionById(collection.collectionId, 'nft', caller);
@@ -83,7 +91,15 @@
itEth.ifWithPallets('ERC721Metadata property can be set for RFT collection', [Pallets.ReFungible], async({helper}) => {
const caller = await helper.eth.createAccountWithBalance(donor);
- const collection = await helper.rft.mintCollection(donor, {name: 'col', description: 'descr', tokenPrefix: 'COL'});
+ const tokenPropertyPermissions = [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }];
+ const collection = await helper.rft.mintCollection(donor, {name: 'col', description: 'descr', tokenPrefix: 'COL', tokenPropertyPermissions});
await collection.addAdmin(donor, {Ethereum: caller});
tests/src/eth/nonFungible.test.tsdiffbeforeafterboth--- a/tests/src/eth/nonFungible.test.ts
+++ b/tests/src/eth/nonFungible.test.ts
@@ -501,7 +501,23 @@
itEth('Returns collection name', async ({helper}) => {
const caller = await helper.eth.createAccountWithBalance(donor);
- const collection = await helper.nft.mintCollection(alice, {name: 'oh River', tokenPrefix: 'CHANGE', properties: [{key: 'ERC721Metadata', value: '1'}]});
+ const tokenPropertyPermissions = [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }];
+ const collection = await helper.nft.mintCollection(
+ alice,
+ {
+ name: 'oh River',
+ tokenPrefix: 'CHANGE',
+ properties: [{key: 'ERC721Metadata', value: '1'}],
+ tokenPropertyPermissions,
+ },
+ );
const contract = helper.ethNativeContract.collectionById(collection.collectionId, 'nft', caller);
const name = await contract.methods.name().call();
@@ -510,7 +526,23 @@
itEth('Returns symbol name', async ({helper}) => {
const caller = await helper.eth.createAccountWithBalance(donor);
- const collection = await helper.nft.mintCollection(alice, {name: 'oh River', tokenPrefix: 'CHANGE', properties: [{key: 'ERC721Metadata', value: '1'}]});
+ const tokenPropertyPermissions = [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }];
+ const collection = await helper.nft.mintCollection(
+ alice,
+ {
+ name: 'oh River',
+ tokenPrefix: 'CHANGE',
+ properties: [{key: 'ERC721Metadata', value: '1'}],
+ tokenPropertyPermissions,
+ },
+ );
const contract = helper.ethNativeContract.collectionById(collection.collectionId, 'nft', caller);
const symbol = await contract.methods.symbol().call();
tests/src/eth/reFungible.test.tsdiffbeforeafterboth--- a/tests/src/eth/reFungible.test.ts
+++ b/tests/src/eth/reFungible.test.ts
@@ -377,7 +377,23 @@
itEth('Returns collection name', async ({helper}) => {
const caller = helper.eth.createAccount();
- const collection = await helper.rft.mintCollection(alice, {name: 'Leviathan', tokenPrefix: '11', properties: [{key: 'ERC721Metadata', value: '1'}]});
+ const tokenPropertyPermissions = [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }];
+ const collection = await helper.rft.mintCollection(
+ alice,
+ {
+ name: 'Leviathan',
+ tokenPrefix: '11',
+ properties: [{key: 'ERC721Metadata', value: '1'}],
+ tokenPropertyPermissions,
+ },
+ );
const contract = helper.ethNativeContract.collectionById(collection.collectionId, 'rft', caller);
const name = await contract.methods.name().call();
@@ -386,7 +402,24 @@
itEth('Returns symbol name', async ({helper}) => {
const caller = await helper.eth.createAccountWithBalance(donor);
- const {collectionId} = await helper.rft.mintCollection(alice, {name: 'Leviathan', tokenPrefix: '12', properties: [{key: 'ERC721Metadata', value: '1'}]});
+ const tokenPropertyPermissions = [{
+ key: 'URI',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ tokenOwner: false,
+ },
+ }];
+ const {collectionId} = await helper.rft.mintCollection(
+ alice,
+ {
+ name: 'Leviathan',
+ tokenPrefix: '12',
+ properties: [{key: 'ERC721Metadata', value: '1'}],
+ tokenPropertyPermissions,
+ },
+ );
+
const contract = helper.ethNativeContract.collectionById(collectionId, 'rft', caller);
const symbol = await contract.methods.symbol().call();
expect(symbol).to.equal('12');
tests/src/eth/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/eth/util/playgrounds/unique.dev.ts
+++ b/tests/src/eth/util/playgrounds/unique.dev.ts
@@ -213,7 +213,7 @@
async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string}> {
const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();
const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);
-
+
const result = await collectionHelper.methods.createERC721MetadataCompatibleRFTCollection(name, description, tokenPrefix, baseUri).send({value: Number(collectionCreationPrice)});
const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);