difftreelog
misk: Move TokenChanged event into ERC721 contracts
in: master
16 files changed
pallets/common/src/erc.rsdiffbeforeafterboth--- a/pallets/common/src/erc.rs
+++ b/pallets/common/src/erc.rs
@@ -26,7 +26,6 @@
};
use pallet_evm_coder_substrate::dispatch_to_evm;
use sp_std::{vec, vec::Vec};
-use sp_core::U256;
use up_data_structs::{
CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property, SponsoringRateLimit,
SponsorshipState,
@@ -62,18 +61,9 @@
},
/// The collection has been changed.
CollectionChanged {
- /// Collection ID.
- #[indexed]
- collection_id: Address,
- },
-
- /// The token has been changed.
- TokenChanged {
/// Collection ID.
#[indexed]
collection_id: Address,
- /// Token ID.
- token_id: U256,
},
}
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -1250,6 +1250,7 @@
mut stored_properties: Properties,
is_token_owner: impl Fn() -> Result<bool, DispatchError>,
set_token_properties: impl FnOnce(Properties),
+ log: evm_coder::ethereum::Log,
) -> DispatchResult {
let is_collection_admin = collection.is_owner_or_admin(sender);
let permissions = Self::property_permissions(collection.id);
@@ -1304,13 +1305,7 @@
}
}
- <PalletEvm<T>>::deposit_log(
- CollectionHelpersEvents::TokenChanged {
- collection_id: eth::collection_id_to_address(collection.id),
- token_id: token_id.into(),
- }
- .to_log(T::ContractAddress::get()),
- );
+ <PalletEvm<T>>::deposit_log(log.clone());
}
set_token_properties(stored_properties);
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::{abi::AbiType, ToLog, generate_stubgen, solidity_interface, types::*};28use frame_support::BoundedVec;29use up_data_structs::{30 TokenId, PropertyPermission, PropertyKeyPermission, Property, CollectionId, PropertyKey,31 CollectionPropertiesVec,32};33use pallet_evm_coder_substrate::{34 dispatch_to_evm, frontier_contract,35 execution::{Result, PreDispatch, Error},36};37use sp_std::{vec::Vec, vec};38use pallet_common::{39 CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,40 erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},41 eth::{self, TokenUri},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::{U256, Get};4748use crate::{49 AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,50 TokenProperties, SelfWeightOf, weights::WeightInfo,51};5253frontier_contract! {54 macro_rules! NonfungibleHandle_result {...}55 impl<T: Config> Contract for NonfungibleHandle<T> {...}56}5758/// @title A contract that allows to set and delete token properties and change token property permissions.59#[solidity_interface(name = TokenProperties, enum(derive(PreDispatch)), enum_attr(weight))]60impl<T: Config> NonfungibleHandle<T> {61 /// @notice Set permissions for token property.62 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.63 /// @param key Property key.64 /// @param isMutable Permission to mutate property.65 /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.66 /// @param tokenOwner Permission to mutate property by token owner if property is mutable.67 #[solidity(hide)]68 #[weight(<SelfWeightOf<T>>::set_token_property_permissions(1))]69 fn set_token_property_permission(70 &mut self,71 caller: Caller,72 key: String,73 is_mutable: bool,74 collection_admin: bool,75 token_owner: bool,76 ) -> Result<()> {77 let caller = T::CrossAccountId::from_eth(caller);78 <Pallet<T>>::set_token_property_permissions(79 self,80 &caller,81 vec![PropertyKeyPermission {82 key: <Vec<u8>>::from(key)83 .try_into()84 .map_err(|_| "too long key")?,85 permission: PropertyPermission {86 mutable: is_mutable,87 collection_admin,88 token_owner,89 },90 }],91 )92 .map_err(dispatch_to_evm::<T>)93 }9495 /// @notice Set permissions for token property.96 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.97 /// @param permissions Permissions for keys.98 #[weight(<SelfWeightOf<T>>::set_token_property_permissions(permissions.len() as u32))]99 fn set_token_property_permissions(100 &mut self,101 caller: Caller,102 permissions: Vec<eth::TokenPropertyPermission>,103 ) -> Result<()> {104 let caller = T::CrossAccountId::from_eth(caller);105 let perms = eth::TokenPropertyPermission::into_property_key_permissions(permissions)?;106107 <Pallet<T>>::set_token_property_permissions(self, &caller, perms)108 .map_err(dispatch_to_evm::<T>)109 }110111 /// @notice Get permissions for token properties.112 fn token_property_permissions(&self) -> Result<Vec<eth::TokenPropertyPermission>> {113 let perms = <Pallet<T>>::token_property_permission(self.id);114 Ok(perms115 .into_iter()116 .map(eth::TokenPropertyPermission::from)117 .collect())118 }119120 /// @notice Set token property value.121 /// @dev Throws error if `msg.sender` has no permission to edit the property.122 /// @param tokenId ID of the token.123 /// @param key Property key.124 /// @param value Property value.125 #[solidity(hide)]126 #[weight(<SelfWeightOf<T>>::set_token_properties(1))]127 fn set_property(128 &mut self,129 caller: Caller,130 token_id: U256,131 key: String,132 value: Bytes,133 ) -> Result<()> {134 let caller = T::CrossAccountId::from_eth(caller);135 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;136 let key = <Vec<u8>>::from(key)137 .try_into()138 .map_err(|_| "key too long")?;139 let value = value.0.try_into().map_err(|_| "value too long")?;140141 let nesting_budget = self142 .recorder143 .weight_calls_budget(<StructureWeight<T>>::find_parent());144145 <Pallet<T>>::set_token_property(146 self,147 &caller,148 TokenId(token_id),149 Property { key, value },150 &nesting_budget,151 )152 .map_err(dispatch_to_evm::<T>)153 }154155 /// @notice Set token properties value.156 /// @dev Throws error if `msg.sender` has no permission to edit the property.157 /// @param tokenId ID of the token.158 /// @param properties settable properties159 #[weight(<SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]160 fn set_properties(161 &mut self,162 caller: Caller,163 token_id: U256,164 properties: Vec<eth::Property>,165 ) -> Result<()> {166 let caller = T::CrossAccountId::from_eth(caller);167 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;168169 let nesting_budget = self170 .recorder171 .weight_calls_budget(<StructureWeight<T>>::find_parent());172173 let properties = properties174 .into_iter()175 .map(eth::Property::try_into)176 .collect::<Result<Vec<_>>>()?;177178 <Pallet<T>>::set_token_properties(179 self,180 &caller,181 TokenId(token_id),182 properties.into_iter(),183 false,184 &nesting_budget,185 )186 .map_err(dispatch_to_evm::<T>)187 }188189 /// @notice Delete token property value.190 /// @dev Throws error if `msg.sender` has no permission to edit the property.191 /// @param tokenId ID of the token.192 /// @param key Property key.193 #[solidity(hide)]194 #[weight(<SelfWeightOf<T>>::delete_token_properties(1))]195 fn delete_property(&mut self, token_id: U256, caller: Caller, key: String) -> Result<()> {196 let caller = T::CrossAccountId::from_eth(caller);197 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;198 let key = <Vec<u8>>::from(key)199 .try_into()200 .map_err(|_| "key too long")?;201202 let nesting_budget = self203 .recorder204 .weight_calls_budget(<StructureWeight<T>>::find_parent());205206 <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)207 .map_err(dispatch_to_evm::<T>)208 }209210 /// @notice Delete token properties value.211 /// @dev Throws error if `msg.sender` has no permission to edit the property.212 /// @param tokenId ID of the token.213 /// @param keys Properties key.214 #[weight(<SelfWeightOf<T>>::delete_token_properties(keys.len() as u32))]215 fn delete_properties(216 &mut self,217 token_id: U256,218 caller: Caller,219 keys: Vec<String>,220 ) -> Result<()> {221 let caller = T::CrossAccountId::from_eth(caller);222 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;223 let keys = keys224 .into_iter()225 .map(|k| Ok(<Vec<u8>>::from(k).try_into().map_err(|_| "key too long")?))226 .collect::<Result<Vec<_>>>()?;227228 let nesting_budget = self229 .recorder230 .weight_calls_budget(<StructureWeight<T>>::find_parent());231232 <Pallet<T>>::delete_token_properties(233 self,234 &caller,235 TokenId(token_id),236 keys.into_iter(),237 &nesting_budget,238 )239 .map_err(dispatch_to_evm::<T>)240 }241242 /// @notice Get token property value.243 /// @dev Throws error if key not found244 /// @param tokenId ID of the token.245 /// @param key Property key.246 /// @return Property value bytes247 fn property(&self, token_id: U256, key: String) -> Result<Bytes> {248 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;249 let key = <Vec<u8>>::from(key)250 .try_into()251 .map_err(|_| "key too long")?;252253 let props = <TokenProperties<T>>::get((self.id, token_id));254 let prop = props.get(&key).ok_or("key not found")?;255256 Ok(prop.to_vec().into())257 }258}259260#[derive(ToLog)]261pub enum ERC721Events {262 /// @dev This emits when ownership of any NFT changes by any mechanism.263 /// This event emits when NFTs are created (`from` == 0) and destroyed264 /// (`to` == 0). Exception: during contract creation, any number of NFTs265 /// may be created and assigned without emitting Transfer. At the time of266 /// any transfer, the approved address for that NFT (if any) is reset to none.267 Transfer {268 #[indexed]269 from: Address,270 #[indexed]271 to: Address,272 #[indexed]273 token_id: U256,274 },275 /// @dev This emits when the approved address for an NFT is changed or276 /// reaffirmed. The zero address indicates there is no approved address.277 /// When a Transfer event emits, this also indicates that the approved278 /// address for that NFT (if any) is reset to none.279 Approval {280 #[indexed]281 owner: Address,282 #[indexed]283 approved: Address,284 #[indexed]285 token_id: U256,286 },287 /// @dev This emits when an operator is enabled or disabled for an owner.288 /// The operator can manage all NFTs of the owner.289 #[allow(dead_code)]290 ApprovalForAll {291 #[indexed]292 owner: Address,293 #[indexed]294 operator: Address,295 approved: bool,296 },297}298299/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension300/// @dev See https://eips.ethereum.org/EIPS/eip-721301#[solidity_interface(name = ERC721Metadata, expect_selector = 0x5b5e139f, enum(derive(PreDispatch)), enum_attr(weight))]302impl<T: Config> NonfungibleHandle<T>303where304 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,305{306 /// @notice A descriptive name for a collection of NFTs in this contract307 /// @dev real implementation of this function lies in `ERC721UniqueExtensions`308 #[solidity(hide, rename_selector = "name")]309 fn name_proxy(&self) -> String {310 self.name()311 }312313 /// @notice An abbreviated name for NFTs in this contract314 /// @dev real implementation of this function lies in `ERC721UniqueExtensions`315 #[solidity(hide, rename_selector = "symbol")]316 fn symbol_proxy(&self) -> String {317 self.symbol()318 }319320 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.321 ///322 /// @dev If the token has a `url` property and it is not empty, it is returned.323 /// 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`.324 /// If the collection property `baseURI` is empty or absent, return "" (empty string)325 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix326 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).327 ///328 /// @return token's const_metadata329 #[solidity(rename_selector = "tokenURI")]330 fn token_uri(&self, token_id: U256) -> Result<String> {331 let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;332333 match get_token_property(self, token_id_u32, &key::url()).as_deref() {334 Err(_) | Ok("") => (),335 Ok(url) => {336 return Ok(url.into());337 }338 };339340 let base_uri =341 pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())342 .map(BoundedVec::into_inner)343 .map(String::from_utf8)344 .transpose()345 .map_err(|e| {346 Error::Revert(alloc::format!(347 "Can not convert value \"baseURI\" to string with error \"{}\"",348 e349 ))350 })?;351352 let base_uri = match base_uri.as_deref() {353 None | Some("") => {354 return Ok("".into());355 }356 Some(base_uri) => base_uri.into(),357 };358359 Ok(360 match get_token_property(self, token_id_u32, &key::suffix()).as_deref() {361 Err(_) | Ok("") => base_uri,362 Ok(suffix) => base_uri + suffix,363 },364 )365 }366}367368/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension369/// @dev See https://eips.ethereum.org/EIPS/eip-721370#[solidity_interface(name = ERC721Enumerable, expect_selector = 0x780e9d63, enum(derive(PreDispatch)), enum_attr(weight))]371impl<T: Config> NonfungibleHandle<T> {372 /// @notice Enumerate valid NFTs373 /// @param index A counter less than `totalSupply()`374 /// @return The token identifier for the `index`th NFT,375 /// (sort order not specified)376 fn token_by_index(&self, index: U256) -> U256 {377 index378 }379380 /// @dev Not implemented381 fn token_of_owner_by_index(&self, _owner: Address, _index: U256) -> Result<U256> {382 // TODO: Not implemetable383 Err("not implemented".into())384 }385386 /// @notice Count NFTs tracked by this contract387 /// @return A count of valid NFTs tracked by this contract, where each one of388 /// them has an assigned and queryable owner not equal to the zero address389 fn total_supply(&self) -> Result<U256> {390 self.consume_store_reads(1)?;391 Ok(<Pallet<T>>::total_supply(self).into())392 }393}394395/// @title ERC-721 Non-Fungible Token Standard396/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md397#[solidity_interface(name = ERC721, events(ERC721Events), enum(derive(PreDispatch)), enum_attr(weight), expect_selector = 0x80ac58cd)]398impl<T: Config> NonfungibleHandle<T> {399 /// @notice Count all NFTs assigned to an owner400 /// @dev NFTs assigned to the zero address are considered invalid, and this401 /// function throws for queries about the zero address.402 /// @param owner An address for whom to query the balance403 /// @return The number of NFTs owned by `owner`, possibly zero404 fn balance_of(&self, owner: Address) -> Result<U256> {405 self.consume_store_reads(1)?;406 let owner = T::CrossAccountId::from_eth(owner);407 let balance = <AccountBalance<T>>::get((self.id, owner));408 Ok(balance.into())409 }410 /// @notice Find the owner of an NFT411 /// @dev NFTs assigned to zero address are considered invalid, and queries412 /// about them do throw.413 /// @param tokenId The identifier for an NFT414 /// @return The address of the owner of the NFT415 fn owner_of(&self, token_id: U256) -> Result<Address> {416 self.consume_store_reads(1)?;417 let token: TokenId = token_id.try_into()?;418 Ok(*<TokenData<T>>::get((self.id, token))419 .ok_or("token not found")?420 .owner421 .as_eth())422 }423 /// @dev Not implemented424 #[solidity(rename_selector = "safeTransferFrom")]425 fn safe_transfer_from_with_data(426 &mut self,427 _from: Address,428 _to: Address,429 _token_id: U256,430 _data: Bytes,431 ) -> Result<()> {432 // TODO: Not implemetable433 Err("not implemented".into())434 }435 /// @dev Not implemented436 fn safe_transfer_from(&mut self, _from: Address, _to: Address, _token_id: U256) -> Result<()> {437 // TODO: Not implemetable438 Err("not implemented".into())439 }440441 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE442 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE443 /// THEY MAY BE PERMANENTLY LOST444 /// @dev Throws unless `msg.sender` is the current owner or an authorized445 /// operator for this NFT. Throws if `from` is not the current owner. Throws446 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.447 /// @param from The current owner of the NFT448 /// @param to The new owner449 /// @param tokenId The NFT to transfer450 #[weight(<SelfWeightOf<T>>::transfer_from())]451 fn transfer_from(452 &mut self,453 caller: Caller,454 from: Address,455 to: Address,456 token_id: U256,457 ) -> Result<()> {458 let caller = T::CrossAccountId::from_eth(caller);459 let from = T::CrossAccountId::from_eth(from);460 let to = T::CrossAccountId::from_eth(to);461 let token = token_id.try_into()?;462 let budget = self463 .recorder464 .weight_calls_budget(<StructureWeight<T>>::find_parent());465466 <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)467 .map_err(dispatch_to_evm::<T>)?;468 Ok(())469 }470471 /// @notice Set or reaffirm the approved address for an NFT472 /// @dev The zero address indicates there is no approved address.473 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized474 /// operator of the current owner.475 /// @param approved The new approved NFT controller476 /// @param tokenId The NFT to approve477 #[weight(<SelfWeightOf<T>>::approve())]478 fn approve(&mut self, caller: Caller, approved: Address, token_id: U256) -> Result<()> {479 let caller = T::CrossAccountId::from_eth(caller);480 let approved = T::CrossAccountId::from_eth(approved);481 let token = token_id.try_into()?;482483 <Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))484 .map_err(dispatch_to_evm::<T>)?;485 Ok(())486 }487488 /// @notice Sets or unsets the approval of a given operator.489 /// The `operator` is allowed to transfer all tokens of the `caller` on their behalf.490 /// @param operator Operator491 /// @param approved Should operator status be granted or revoked?492 #[weight(<SelfWeightOf<T>>::set_allowance_for_all())]493 fn set_approval_for_all(494 &mut self,495 caller: Caller,496 operator: Address,497 approved: bool,498 ) -> Result<()> {499 let caller = T::CrossAccountId::from_eth(caller);500 let operator = T::CrossAccountId::from_eth(operator);501502 <Pallet<T>>::set_allowance_for_all(self, &caller, &operator, approved)503 .map_err(dispatch_to_evm::<T>)?;504 Ok(())505 }506507 /// @dev Not implemented508 fn get_approved(&self, _token_id: U256) -> Result<Address> {509 // TODO: Not implemetable510 Err("not implemented".into())511 }512513 /// @notice Tells whether the given `owner` approves the `operator`.514 #[weight(<SelfWeightOf<T>>::allowance_for_all())]515 fn is_approved_for_all(&self, owner: Address, operator: Address) -> Result<bool> {516 let owner = T::CrossAccountId::from_eth(owner);517 let operator = T::CrossAccountId::from_eth(operator);518519 Ok(<Pallet<T>>::allowance_for_all(self, &owner, &operator))520 }521}522523/// @title ERC721 Token that can be irreversibly burned (destroyed).524#[solidity_interface(name = ERC721Burnable, enum(derive(PreDispatch)), enum_attr(weight))]525impl<T: Config> NonfungibleHandle<T> {526 /// @notice Burns a specific ERC721 token.527 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized528 /// operator of the current owner.529 /// @param tokenId The NFT to approve530 #[weight(<SelfWeightOf<T>>::burn_item())]531 fn burn(&mut self, caller: Caller, token_id: U256) -> Result<()> {532 let caller = T::CrossAccountId::from_eth(caller);533 let token = token_id.try_into()?;534535 <Pallet<T>>::burn(self, &caller, token).map_err(dispatch_to_evm::<T>)?;536 Ok(())537 }538}539540/// @title ERC721 minting logic.541#[solidity_interface(name = ERC721UniqueMintable, enum(derive(PreDispatch)), enum_attr(weight))]542impl<T: Config> NonfungibleHandle<T> {543 /// @notice Function to mint a token.544 /// @param to The new owner545 /// @return uint256 The id of the newly minted token546 #[weight(<SelfWeightOf<T>>::create_item())]547 fn mint(&mut self, caller: Caller, to: Address) -> Result<U256> {548 let token_id: U256 = <TokensMinted<T>>::get(self.id)549 .checked_add(1)550 .ok_or("item id overflow")?551 .into();552 self.mint_check_id(caller, to, token_id)?;553 Ok(token_id)554 }555556 /// @notice Function to mint a token.557 /// @dev `tokenId` should be obtained with `nextTokenId` method,558 /// unlike standard, you can't specify it manually559 /// @param to The new owner560 /// @param tokenId ID of the minted NFT561 #[solidity(hide, rename_selector = "mint")]562 #[weight(<SelfWeightOf<T>>::create_item())]563 fn mint_check_id(&mut self, caller: Caller, to: Address, token_id: U256) -> Result<bool> {564 let caller = T::CrossAccountId::from_eth(caller);565 let to = T::CrossAccountId::from_eth(to);566 let token_id: u32 = token_id.try_into()?;567 let budget = self568 .recorder569 .weight_calls_budget(<StructureWeight<T>>::find_parent());570571 if <TokensMinted<T>>::get(self.id)572 .checked_add(1)573 .ok_or("item id overflow")?574 != token_id575 {576 return Err("item id should be next".into());577 }578579 <Pallet<T>>::create_item(580 self,581 &caller,582 CreateItemData::<T> {583 properties: BoundedVec::default(),584 owner: to,585 },586 &budget,587 )588 .map_err(dispatch_to_evm::<T>)?;589590 Ok(true)591 }592593 /// @notice Function to mint token with the given tokenUri.594 /// @param to The new owner595 /// @param tokenUri Token URI that would be stored in the NFT properties596 /// @return uint256 The id of the newly minted token597 #[solidity(rename_selector = "mintWithTokenURI")]598 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]599 fn mint_with_token_uri(600 &mut self,601 caller: Caller,602 to: Address,603 token_uri: String,604 ) -> Result<U256> {605 let token_id: U256 = <TokensMinted<T>>::get(self.id)606 .checked_add(1)607 .ok_or("item id overflow")?608 .into();609 self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;610 Ok(token_id)611 }612613 /// @notice Function to mint token with the given tokenUri.614 /// @dev `tokenId` should be obtained with `nextTokenId` method,615 /// unlike standard, you can't specify it manually616 /// @param to The new owner617 /// @param tokenId ID of the minted NFT618 /// @param tokenUri Token URI that would be stored in the NFT properties619 #[solidity(hide, rename_selector = "mintWithTokenURI")]620 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]621 fn mint_with_token_uri_check_id(622 &mut self,623 caller: Caller,624 to: Address,625 token_id: U256,626 token_uri: String,627 ) -> Result<bool> {628 let key = key::url();629 let permission = get_token_permission::<T>(self.id, &key)?;630 if !permission.collection_admin {631 return Err("Operation is not allowed".into());632 }633634 let caller = T::CrossAccountId::from_eth(caller);635 let to = T::CrossAccountId::from_eth(to);636 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;637 let budget = self638 .recorder639 .weight_calls_budget(<StructureWeight<T>>::find_parent());640641 if <TokensMinted<T>>::get(self.id)642 .checked_add(1)643 .ok_or("item id overflow")?644 != token_id645 {646 return Err("item id should be next".into());647 }648649 let mut properties = CollectionPropertiesVec::default();650 properties651 .try_push(Property {652 key,653 value: token_uri654 .into_bytes()655 .try_into()656 .map_err(|_| "token uri is too long")?,657 })658 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;659660 <Pallet<T>>::create_item(661 self,662 &caller,663 CreateItemData::<T> {664 properties,665 owner: to,666 },667 &budget,668 )669 .map_err(dispatch_to_evm::<T>)?;670 Ok(true)671 }672}673674fn get_token_property<T: Config>(675 collection: &CollectionHandle<T>,676 token_id: u32,677 key: &up_data_structs::PropertyKey,678) -> Result<String> {679 collection.consume_store_reads(1)?;680 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))681 .map_err(|_| Error::Revert("Token properties not found".into()))?;682 if let Some(property) = properties.get(key) {683 return Ok(String::from_utf8_lossy(property).into());684 }685686 Err("Property tokenURI not found".into())687}688689fn get_token_permission<T: Config>(690 collection_id: CollectionId,691 key: &PropertyKey,692) -> Result<PropertyPermission> {693 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)694 .map_err(|_| Error::Revert("No permissions for collection".into()))?;695 let a = token_property_permissions696 .get(key)697 .map(Clone::clone)698 .ok_or_else(|| {699 let key = String::from_utf8(key.clone().into_inner()).unwrap_or_default();700 Error::Revert(alloc::format!("No permission for key {}", key))701 })?;702 Ok(a)703}704705/// @title Unique extensions for ERC721.706#[solidity_interface(name = ERC721UniqueExtensions, enum(derive(PreDispatch)), enum_attr(weight))]707impl<T: Config> NonfungibleHandle<T>708where709 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,710{711 /// @notice A descriptive name for a collection of NFTs in this contract712 fn name(&self) -> String {713 decode_utf16(self.name.iter().copied())714 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))715 .collect::<String>()716 }717718 /// @notice An abbreviated name for NFTs in this contract719 fn symbol(&self) -> String {720 String::from_utf8_lossy(&self.token_prefix).into()721 }722723 /// @notice A description for the collection.724 fn description(&self) -> String {725 decode_utf16(self.description.iter().copied())726 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))727 .collect::<String>()728 }729730 /// Returns the owner (in cross format) of the token.731 ///732 /// @param tokenId Id for the token.733 fn cross_owner_of(&self, token_id: U256) -> Result<eth::CrossAddress> {734 Self::token_owner(&self, token_id.try_into()?)735 .map(|o| eth::CrossAddress::from_sub_cross_account::<T>(&o))736 .map_err(|_| Error::Revert("token not found".into()))737 }738739 /// Returns the token properties.740 ///741 /// @param tokenId Id for the token.742 /// @param keys Properties keys. Empty keys for all propertyes.743 /// @return Vector of properties key/value pairs.744 fn properties(&self, token_id: U256, keys: Vec<String>) -> Result<Vec<eth::Property>> {745 let keys = keys746 .into_iter()747 .map(|key| {748 <Vec<u8>>::from(key)749 .try_into()750 .map_err(|_| Error::Revert("key too large".into()))751 })752 .collect::<Result<Vec<_>>>()?;753754 <Self as CommonCollectionOperations<T>>::token_properties(755 &self,756 token_id.try_into()?,757 if keys.is_empty() { None } else { Some(keys) },758 )759 .into_iter()760 .map(eth::Property::try_from)761 .collect::<Result<Vec<_>>>()762 }763764 /// @notice Set or reaffirm the approved address for an NFT765 /// @dev The zero address indicates there is no approved address.766 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized767 /// operator of the current owner.768 /// @param approved The new substrate address approved NFT controller769 /// @param tokenId The NFT to approve770 #[weight(<SelfWeightOf<T>>::approve())]771 fn approve_cross(772 &mut self,773 caller: Caller,774 approved: eth::CrossAddress,775 token_id: U256,776 ) -> Result<()> {777 let caller = T::CrossAccountId::from_eth(caller);778 let approved = approved.into_sub_cross_account::<T>()?;779 let token = token_id.try_into()?;780781 <Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))782 .map_err(dispatch_to_evm::<T>)?;783 Ok(())784 }785786 /// @notice Transfer ownership of an NFT787 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`788 /// is the zero address. Throws if `tokenId` is not a valid NFT.789 /// @param to The new owner790 /// @param tokenId The NFT to transfer791 #[weight(<SelfWeightOf<T>>::transfer())]792 fn transfer(&mut self, caller: Caller, to: Address, token_id: U256) -> Result<()> {793 let caller = T::CrossAccountId::from_eth(caller);794 let to = T::CrossAccountId::from_eth(to);795 let token = token_id.try_into()?;796 let budget = self797 .recorder798 .weight_calls_budget(<StructureWeight<T>>::find_parent());799800 <Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;801 Ok(())802 }803804 /// @notice Transfer ownership of an NFT805 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`806 /// is the zero address. Throws if `tokenId` is not a valid NFT.807 /// @param to The new owner808 /// @param tokenId The NFT to transfer809 #[weight(<SelfWeightOf<T>>::transfer())]810 fn transfer_cross(811 &mut self,812 caller: Caller,813 to: eth::CrossAddress,814 token_id: U256,815 ) -> Result<()> {816 let caller = T::CrossAccountId::from_eth(caller);817 let to = to.into_sub_cross_account::<T>()?;818 let token = token_id.try_into()?;819 let budget = self820 .recorder821 .weight_calls_budget(<StructureWeight<T>>::find_parent());822823 <Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;824 Ok(())825 }826827 /// @notice Transfer ownership of an NFT from cross account address to cross account address828 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`829 /// is the zero address. Throws if `tokenId` is not a valid NFT.830 /// @param from Cross acccount address of current owner831 /// @param to Cross acccount address of new owner832 /// @param tokenId The NFT to transfer833 #[weight(<SelfWeightOf<T>>::transfer())]834 fn transfer_from_cross(835 &mut self,836 caller: Caller,837 from: eth::CrossAddress,838 to: eth::CrossAddress,839 token_id: U256,840 ) -> Result<()> {841 let caller = T::CrossAccountId::from_eth(caller);842 let from = from.into_sub_cross_account::<T>()?;843 let to = to.into_sub_cross_account::<T>()?;844 let token_id = token_id.try_into()?;845 let budget = self846 .recorder847 .weight_calls_budget(<StructureWeight<T>>::find_parent());848 Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, &budget)849 .map_err(dispatch_to_evm::<T>)?;850 Ok(())851 }852853 /// @notice Burns a specific ERC721 token.854 /// @dev Throws unless `msg.sender` is the current owner or an authorized855 /// operator for this NFT. Throws if `from` is not the current owner. Throws856 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.857 /// @param from The current owner of the NFT858 /// @param tokenId The NFT to transfer859 #[solidity(hide)]860 #[weight(<SelfWeightOf<T>>::burn_from())]861 fn burn_from(&mut self, caller: Caller, from: Address, token_id: U256) -> Result<()> {862 let caller = T::CrossAccountId::from_eth(caller);863 let from = T::CrossAccountId::from_eth(from);864 let token = token_id.try_into()?;865 let budget = self866 .recorder867 .weight_calls_budget(<StructureWeight<T>>::find_parent());868869 <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)870 .map_err(dispatch_to_evm::<T>)?;871 Ok(())872 }873874 /// @notice Burns a specific ERC721 token.875 /// @dev Throws unless `msg.sender` is the current owner or an authorized876 /// operator for this NFT. Throws if `from` is not the current owner. Throws877 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.878 /// @param from The current owner of the NFT879 /// @param tokenId The NFT to transfer880 #[weight(<SelfWeightOf<T>>::burn_from())]881 fn burn_from_cross(882 &mut self,883 caller: Caller,884 from: eth::CrossAddress,885 token_id: U256,886 ) -> Result<()> {887 let caller = T::CrossAccountId::from_eth(caller);888 let from = from.into_sub_cross_account::<T>()?;889 let token = token_id.try_into()?;890 let budget = self891 .recorder892 .weight_calls_budget(<StructureWeight<T>>::find_parent());893894 <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)895 .map_err(dispatch_to_evm::<T>)?;896 Ok(())897 }898899 /// @notice Returns next free NFT ID.900 fn next_token_id(&self) -> Result<U256> {901 self.consume_store_reads(1)?;902 Ok(<TokensMinted<T>>::get(self.id)903 .checked_add(1)904 .ok_or("item id overflow")?905 .into())906 }907908 /// @notice Function to mint multiple tokens.909 /// @dev `tokenIds` should be an array of consecutive numbers and first number910 /// should be obtained with `nextTokenId` method911 /// @param to The new owner912 /// @param tokenIds IDs of the minted NFTs913 #[solidity(hide)]914 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]915 fn mint_bulk(&mut self, caller: Caller, to: Address, token_ids: Vec<U256>) -> Result<bool> {916 let caller = T::CrossAccountId::from_eth(caller);917 let to = T::CrossAccountId::from_eth(to);918 let mut expected_index = <TokensMinted<T>>::get(self.id)919 .checked_add(1)920 .ok_or("item id overflow")?;921 let budget = self922 .recorder923 .weight_calls_budget(<StructureWeight<T>>::find_parent());924925 let total_tokens = token_ids.len();926 for id in token_ids.into_iter() {927 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;928 if id != expected_index {929 return Err("item id should be next".into());930 }931 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;932 }933 let data = (0..total_tokens)934 .map(|_| CreateItemData::<T> {935 properties: BoundedVec::default(),936 owner: to.clone(),937 })938 .collect();939940 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)941 .map_err(dispatch_to_evm::<T>)?;942 Ok(true)943 }944945 /// @notice Function to mint multiple tokens with the given tokenUris.946 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive947 /// numbers and first number should be obtained with `nextTokenId` method948 /// @param to The new owner949 /// @param tokens array of pairs of token ID and token URI for minted tokens950 #[solidity(hide, rename_selector = "mintBulkWithTokenURI")]951 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32) + <SelfWeightOf<T>>::set_token_properties(tokens.len() as u32))]952 fn mint_bulk_with_token_uri(953 &mut self,954 caller: Caller,955 to: Address,956 tokens: Vec<TokenUri>,957 ) -> Result<bool> {958 let key = key::url();959 let caller = T::CrossAccountId::from_eth(caller);960 let to = T::CrossAccountId::from_eth(to);961 let mut expected_index = <TokensMinted<T>>::get(self.id)962 .checked_add(1)963 .ok_or("item id overflow")?;964 let budget = self965 .recorder966 .weight_calls_budget(<StructureWeight<T>>::find_parent());967968 let mut data = Vec::with_capacity(tokens.len());969 for TokenUri { id, uri } in tokens {970 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;971 if id != expected_index {972 return Err("item id should be next".into());973 }974 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;975976 let mut properties = CollectionPropertiesVec::default();977 properties978 .try_push(Property {979 key: key.clone(),980 value: uri981 .into_bytes()982 .try_into()983 .map_err(|_| "token uri is too long")?,984 })985 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;986987 data.push(CreateItemData::<T> {988 properties,989 owner: to.clone(),990 });991 }992993 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)994 .map_err(dispatch_to_evm::<T>)?;995 Ok(true)996 }997998 /// @notice Function to mint a token.999 /// @param to The new owner crossAccountId1000 /// @param properties Properties of minted token1001 /// @return uint256 The id of the newly minted token1002 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]1003 fn mint_cross(1004 &mut self,1005 caller: Caller,1006 to: eth::CrossAddress,1007 properties: Vec<eth::Property>,1008 ) -> Result<U256> {1009 let token_id = <TokensMinted<T>>::get(self.id)1010 .checked_add(1)1011 .ok_or("item id overflow")?;10121013 let to = to.into_sub_cross_account::<T>()?;10141015 let properties = properties1016 .into_iter()1017 .map(eth::Property::try_into)1018 .collect::<Result<Vec<_>>>()?1019 .try_into()1020 .map_err(|_| Error::Revert(alloc::format!("too many properties")))?;10211022 let caller = T::CrossAccountId::from_eth(caller);10231024 let budget = self1025 .recorder1026 .weight_calls_budget(<StructureWeight<T>>::find_parent());10271028 <Pallet<T>>::create_item(1029 self,1030 &caller,1031 CreateItemData::<T> {1032 properties,1033 owner: to,1034 },1035 &budget,1036 )1037 .map_err(dispatch_to_evm::<T>)?;10381039 Ok(token_id.into())1040 }10411042 /// @notice Returns collection helper contract address1043 fn collection_helper_address(&self) -> Address {1044 T::ContractAddress::get()1045 }1046}10471048#[solidity_interface(1049 name = UniqueNFT,1050 is(1051 ERC721,1052 ERC721Enumerable,1053 ERC721UniqueExtensions,1054 ERC721UniqueMintable,1055 ERC721Burnable,1056 ERC721Metadata(if(this.flags.erc721metadata)),1057 Collection(via(common_mut returns CollectionHandle<T>)),1058 TokenProperties,1059 ),1060 enum(derive(PreDispatch)),1061)]1062impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}10631064// Not a tests, but code generators1065generate_stubgen!(gen_impl, UniqueNFTCall<()>, true);1066generate_stubgen!(gen_iface, UniqueNFTCall<()>, false);10671068impl<T: Config> CommonEvmHandler for NonfungibleHandle<T>1069where1070 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1071{1072 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueNFT.raw");10731074 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {1075 call::<T, UniqueNFTCall<T>, _, _>(handle, self)1076 }1077}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::{abi::AbiType, ToLog, generate_stubgen, solidity_interface, types::*};28use frame_support::BoundedVec;29use up_data_structs::{30 TokenId, PropertyPermission, PropertyKeyPermission, Property, CollectionId, PropertyKey,31 CollectionPropertiesVec,32};33use pallet_evm_coder_substrate::{34 dispatch_to_evm, frontier_contract,35 execution::{Result, PreDispatch, Error},36};37use sp_std::{vec::Vec, vec};38use pallet_common::{39 CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,40 erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},41 eth::{self, TokenUri},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::{U256, Get};4748use crate::{49 AccountBalance, Config, CreateItemData, NonfungibleHandle, Pallet, TokenData, TokensMinted,50 TokenProperties, SelfWeightOf, weights::WeightInfo,51};5253/// Nft events.54#[derive(ToLog)]55pub enum ERC721TokenEvent {56 /// The token has been changed.57 TokenChanged {58 /// Collection ID.59 #[indexed]60 collection_id: Address,61 /// Token ID.62 token_id: U256,63 },64}6566frontier_contract! {67 macro_rules! NonfungibleHandle_result {...}68 impl<T: Config> Contract for NonfungibleHandle<T> {...}69}7071/// @title A contract that allows to set and delete token properties and change token property permissions.72#[solidity_interface(name = TokenProperties, events(ERC721TokenEvent), enum(derive(PreDispatch)), enum_attr(weight))]73impl<T: Config> NonfungibleHandle<T> {74 /// @notice Set permissions for token property.75 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.76 /// @param key Property key.77 /// @param isMutable Permission to mutate property.78 /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.79 /// @param tokenOwner Permission to mutate property by token owner if property is mutable.80 #[solidity(hide)]81 #[weight(<SelfWeightOf<T>>::set_token_property_permissions(1))]82 fn set_token_property_permission(83 &mut self,84 caller: Caller,85 key: String,86 is_mutable: bool,87 collection_admin: bool,88 token_owner: bool,89 ) -> Result<()> {90 let caller = T::CrossAccountId::from_eth(caller);91 <Pallet<T>>::set_token_property_permissions(92 self,93 &caller,94 vec![PropertyKeyPermission {95 key: <Vec<u8>>::from(key)96 .try_into()97 .map_err(|_| "too long key")?,98 permission: PropertyPermission {99 mutable: is_mutable,100 collection_admin,101 token_owner,102 },103 }],104 )105 .map_err(dispatch_to_evm::<T>)106 }107108 /// @notice Set permissions for token property.109 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.110 /// @param permissions Permissions for keys.111 #[weight(<SelfWeightOf<T>>::set_token_property_permissions(permissions.len() as u32))]112 fn set_token_property_permissions(113 &mut self,114 caller: Caller,115 permissions: Vec<eth::TokenPropertyPermission>,116 ) -> Result<()> {117 let caller = T::CrossAccountId::from_eth(caller);118 let perms = eth::TokenPropertyPermission::into_property_key_permissions(permissions)?;119120 <Pallet<T>>::set_token_property_permissions(self, &caller, perms)121 .map_err(dispatch_to_evm::<T>)122 }123124 /// @notice Get permissions for token properties.125 fn token_property_permissions(&self) -> Result<Vec<eth::TokenPropertyPermission>> {126 let perms = <Pallet<T>>::token_property_permission(self.id);127 Ok(perms128 .into_iter()129 .map(eth::TokenPropertyPermission::from)130 .collect())131 }132133 /// @notice Set token property value.134 /// @dev Throws error if `msg.sender` has no permission to edit the property.135 /// @param tokenId ID of the token.136 /// @param key Property key.137 /// @param value Property value.138 #[solidity(hide)]139 #[weight(<SelfWeightOf<T>>::set_token_properties(1))]140 fn set_property(141 &mut self,142 caller: Caller,143 token_id: U256,144 key: String,145 value: Bytes,146 ) -> Result<()> {147 let caller = T::CrossAccountId::from_eth(caller);148 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;149 let key = <Vec<u8>>::from(key)150 .try_into()151 .map_err(|_| "key too long")?;152 let value = value.0.try_into().map_err(|_| "value too long")?;153154 let nesting_budget = self155 .recorder156 .weight_calls_budget(<StructureWeight<T>>::find_parent());157158 <Pallet<T>>::set_token_property(159 self,160 &caller,161 TokenId(token_id),162 Property { key, value },163 &nesting_budget,164 )165 .map_err(dispatch_to_evm::<T>)166 }167168 /// @notice Set token properties value.169 /// @dev Throws error if `msg.sender` has no permission to edit the property.170 /// @param tokenId ID of the token.171 /// @param properties settable properties172 #[weight(<SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]173 fn set_properties(174 &mut self,175 caller: Caller,176 token_id: U256,177 properties: Vec<eth::Property>,178 ) -> Result<()> {179 let caller = T::CrossAccountId::from_eth(caller);180 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;181182 let nesting_budget = self183 .recorder184 .weight_calls_budget(<StructureWeight<T>>::find_parent());185186 let properties = properties187 .into_iter()188 .map(eth::Property::try_into)189 .collect::<Result<Vec<_>>>()?;190191 <Pallet<T>>::set_token_properties(192 self,193 &caller,194 TokenId(token_id),195 properties.into_iter(),196 false,197 &nesting_budget,198 )199 .map_err(dispatch_to_evm::<T>)200 }201202 /// @notice Delete token property value.203 /// @dev Throws error if `msg.sender` has no permission to edit the property.204 /// @param tokenId ID of the token.205 /// @param key Property key.206 #[solidity(hide)]207 #[weight(<SelfWeightOf<T>>::delete_token_properties(1))]208 fn delete_property(&mut self, token_id: U256, caller: Caller, key: String) -> Result<()> {209 let caller = T::CrossAccountId::from_eth(caller);210 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;211 let key = <Vec<u8>>::from(key)212 .try_into()213 .map_err(|_| "key too long")?;214215 let nesting_budget = self216 .recorder217 .weight_calls_budget(<StructureWeight<T>>::find_parent());218219 <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)220 .map_err(dispatch_to_evm::<T>)221 }222223 /// @notice Delete token properties value.224 /// @dev Throws error if `msg.sender` has no permission to edit the property.225 /// @param tokenId ID of the token.226 /// @param keys Properties key.227 #[weight(<SelfWeightOf<T>>::delete_token_properties(keys.len() as u32))]228 fn delete_properties(229 &mut self,230 token_id: U256,231 caller: Caller,232 keys: Vec<String>,233 ) -> Result<()> {234 let caller = T::CrossAccountId::from_eth(caller);235 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;236 let keys = keys237 .into_iter()238 .map(|k| Ok(<Vec<u8>>::from(k).try_into().map_err(|_| "key too long")?))239 .collect::<Result<Vec<_>>>()?;240241 let nesting_budget = self242 .recorder243 .weight_calls_budget(<StructureWeight<T>>::find_parent());244245 <Pallet<T>>::delete_token_properties(246 self,247 &caller,248 TokenId(token_id),249 keys.into_iter(),250 &nesting_budget,251 )252 .map_err(dispatch_to_evm::<T>)253 }254255 /// @notice Get token property value.256 /// @dev Throws error if key not found257 /// @param tokenId ID of the token.258 /// @param key Property key.259 /// @return Property value bytes260 fn property(&self, token_id: U256, key: String) -> Result<Bytes> {261 let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;262 let key = <Vec<u8>>::from(key)263 .try_into()264 .map_err(|_| "key too long")?;265266 let props = <TokenProperties<T>>::get((self.id, token_id));267 let prop = props.get(&key).ok_or("key not found")?;268269 Ok(prop.to_vec().into())270 }271}272273#[derive(ToLog)]274pub enum ERC721Events {275 /// @dev This emits when ownership of any NFT changes by any mechanism.276 /// This event emits when NFTs are created (`from` == 0) and destroyed277 /// (`to` == 0). Exception: during contract creation, any number of NFTs278 /// may be created and assigned without emitting Transfer. At the time of279 /// any transfer, the approved address for that NFT (if any) is reset to none.280 Transfer {281 #[indexed]282 from: Address,283 #[indexed]284 to: Address,285 #[indexed]286 token_id: U256,287 },288 /// @dev This emits when the approved address for an NFT is changed or289 /// reaffirmed. The zero address indicates there is no approved address.290 /// When a Transfer event emits, this also indicates that the approved291 /// address for that NFT (if any) is reset to none.292 Approval {293 #[indexed]294 owner: Address,295 #[indexed]296 approved: Address,297 #[indexed]298 token_id: U256,299 },300 /// @dev This emits when an operator is enabled or disabled for an owner.301 /// The operator can manage all NFTs of the owner.302 #[allow(dead_code)]303 ApprovalForAll {304 #[indexed]305 owner: Address,306 #[indexed]307 operator: Address,308 approved: bool,309 },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, enum(derive(PreDispatch)), enum_attr(weight))]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) -> 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) -> 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: U256) -> 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, enum(derive(PreDispatch)), enum_attr(weight))]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: U256) -> U256 {390 index391 }392393 /// @dev Not implemented394 fn token_of_owner_by_index(&self, _owner: Address, _index: U256) -> Result<U256> {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<U256> {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), enum(derive(PreDispatch)), enum_attr(weight), 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<U256> {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: U256) -> 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: U256,443 _data: Bytes,444 ) -> Result<()> {445 // TODO: Not implemetable446 Err("not implemented".into())447 }448 /// @dev Not implemented449 fn safe_transfer_from(&mut self, _from: Address, _to: Address, _token_id: U256) -> Result<()> {450 // TODO: Not implemetable451 Err("not implemented".into())452 }453454 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE455 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE456 /// THEY MAY BE PERMANENTLY LOST457 /// @dev Throws unless `msg.sender` is the current owner or an authorized458 /// operator for this NFT. Throws if `from` is not the current owner. Throws459 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.460 /// @param from The current owner of the NFT461 /// @param to The new owner462 /// @param tokenId The NFT to transfer463 #[weight(<SelfWeightOf<T>>::transfer_from())]464 fn transfer_from(465 &mut self,466 caller: Caller,467 from: Address,468 to: Address,469 token_id: U256,470 ) -> Result<()> {471 let caller = T::CrossAccountId::from_eth(caller);472 let from = T::CrossAccountId::from_eth(from);473 let to = T::CrossAccountId::from_eth(to);474 let token = token_id.try_into()?;475 let budget = self476 .recorder477 .weight_calls_budget(<StructureWeight<T>>::find_parent());478479 <Pallet<T>>::transfer_from(self, &caller, &from, &to, token, &budget)480 .map_err(dispatch_to_evm::<T>)?;481 Ok(())482 }483484 /// @notice Set or reaffirm the approved address for an NFT485 /// @dev The zero address indicates there is no approved address.486 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized487 /// operator of the current owner.488 /// @param approved The new approved NFT controller489 /// @param tokenId The NFT to approve490 #[weight(<SelfWeightOf<T>>::approve())]491 fn approve(&mut self, caller: Caller, approved: Address, token_id: U256) -> Result<()> {492 let caller = T::CrossAccountId::from_eth(caller);493 let approved = T::CrossAccountId::from_eth(approved);494 let token = token_id.try_into()?;495496 <Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))497 .map_err(dispatch_to_evm::<T>)?;498 Ok(())499 }500501 /// @notice Sets or unsets the approval of a given operator.502 /// The `operator` is allowed to transfer all tokens of the `caller` on their behalf.503 /// @param operator Operator504 /// @param approved Should operator status be granted or revoked?505 #[weight(<SelfWeightOf<T>>::set_allowance_for_all())]506 fn set_approval_for_all(507 &mut self,508 caller: Caller,509 operator: Address,510 approved: bool,511 ) -> Result<()> {512 let caller = T::CrossAccountId::from_eth(caller);513 let operator = T::CrossAccountId::from_eth(operator);514515 <Pallet<T>>::set_allowance_for_all(self, &caller, &operator, approved)516 .map_err(dispatch_to_evm::<T>)?;517 Ok(())518 }519520 /// @dev Not implemented521 fn get_approved(&self, _token_id: U256) -> Result<Address> {522 // TODO: Not implemetable523 Err("not implemented".into())524 }525526 /// @notice Tells whether the given `owner` approves the `operator`.527 #[weight(<SelfWeightOf<T>>::allowance_for_all())]528 fn is_approved_for_all(&self, owner: Address, operator: Address) -> Result<bool> {529 let owner = T::CrossAccountId::from_eth(owner);530 let operator = T::CrossAccountId::from_eth(operator);531532 Ok(<Pallet<T>>::allowance_for_all(self, &owner, &operator))533 }534}535536/// @title ERC721 Token that can be irreversibly burned (destroyed).537#[solidity_interface(name = ERC721Burnable, enum(derive(PreDispatch)), enum_attr(weight))]538impl<T: Config> NonfungibleHandle<T> {539 /// @notice Burns a specific ERC721 token.540 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized541 /// operator of the current owner.542 /// @param tokenId The NFT to approve543 #[weight(<SelfWeightOf<T>>::burn_item())]544 fn burn(&mut self, caller: Caller, token_id: U256) -> Result<()> {545 let caller = T::CrossAccountId::from_eth(caller);546 let token = token_id.try_into()?;547548 <Pallet<T>>::burn(self, &caller, token).map_err(dispatch_to_evm::<T>)?;549 Ok(())550 }551}552553/// @title ERC721 minting logic.554#[solidity_interface(name = ERC721UniqueMintable, enum(derive(PreDispatch)), enum_attr(weight))]555impl<T: Config> NonfungibleHandle<T> {556 /// @notice Function to mint a token.557 /// @param to The new owner558 /// @return uint256 The id of the newly minted token559 #[weight(<SelfWeightOf<T>>::create_item())]560 fn mint(&mut self, caller: Caller, to: Address) -> Result<U256> {561 let token_id: U256 = <TokensMinted<T>>::get(self.id)562 .checked_add(1)563 .ok_or("item id overflow")?564 .into();565 self.mint_check_id(caller, to, token_id)?;566 Ok(token_id)567 }568569 /// @notice Function to mint a token.570 /// @dev `tokenId` should be obtained with `nextTokenId` method,571 /// unlike standard, you can't specify it manually572 /// @param to The new owner573 /// @param tokenId ID of the minted NFT574 #[solidity(hide, rename_selector = "mint")]575 #[weight(<SelfWeightOf<T>>::create_item())]576 fn mint_check_id(&mut self, caller: Caller, to: Address, token_id: U256) -> Result<bool> {577 let caller = T::CrossAccountId::from_eth(caller);578 let to = T::CrossAccountId::from_eth(to);579 let token_id: u32 = token_id.try_into()?;580 let budget = self581 .recorder582 .weight_calls_budget(<StructureWeight<T>>::find_parent());583584 if <TokensMinted<T>>::get(self.id)585 .checked_add(1)586 .ok_or("item id overflow")?587 != token_id588 {589 return Err("item id should be next".into());590 }591592 <Pallet<T>>::create_item(593 self,594 &caller,595 CreateItemData::<T> {596 properties: BoundedVec::default(),597 owner: to,598 },599 &budget,600 )601 .map_err(dispatch_to_evm::<T>)?;602603 Ok(true)604 }605606 /// @notice Function to mint token with the given tokenUri.607 /// @param to The new owner608 /// @param tokenUri Token URI that would be stored in the NFT properties609 /// @return uint256 The id of the newly minted token610 #[solidity(rename_selector = "mintWithTokenURI")]611 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]612 fn mint_with_token_uri(613 &mut self,614 caller: Caller,615 to: Address,616 token_uri: String,617 ) -> Result<U256> {618 let token_id: U256 = <TokensMinted<T>>::get(self.id)619 .checked_add(1)620 .ok_or("item id overflow")?621 .into();622 self.mint_with_token_uri_check_id(caller, to, token_id, token_uri)?;623 Ok(token_id)624 }625626 /// @notice Function to mint token with the given tokenUri.627 /// @dev `tokenId` should be obtained with `nextTokenId` method,628 /// unlike standard, you can't specify it manually629 /// @param to The new owner630 /// @param tokenId ID of the minted NFT631 /// @param tokenUri Token URI that would be stored in the NFT properties632 #[solidity(hide, rename_selector = "mintWithTokenURI")]633 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(1))]634 fn mint_with_token_uri_check_id(635 &mut self,636 caller: Caller,637 to: Address,638 token_id: U256,639 token_uri: String,640 ) -> Result<bool> {641 let key = key::url();642 let permission = get_token_permission::<T>(self.id, &key)?;643 if !permission.collection_admin {644 return Err("Operation is not allowed".into());645 }646647 let caller = T::CrossAccountId::from_eth(caller);648 let to = T::CrossAccountId::from_eth(to);649 let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;650 let budget = self651 .recorder652 .weight_calls_budget(<StructureWeight<T>>::find_parent());653654 if <TokensMinted<T>>::get(self.id)655 .checked_add(1)656 .ok_or("item id overflow")?657 != token_id658 {659 return Err("item id should be next".into());660 }661662 let mut properties = CollectionPropertiesVec::default();663 properties664 .try_push(Property {665 key,666 value: token_uri667 .into_bytes()668 .try_into()669 .map_err(|_| "token uri is too long")?,670 })671 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;672673 <Pallet<T>>::create_item(674 self,675 &caller,676 CreateItemData::<T> {677 properties,678 owner: to,679 },680 &budget,681 )682 .map_err(dispatch_to_evm::<T>)?;683 Ok(true)684 }685}686687fn get_token_property<T: Config>(688 collection: &CollectionHandle<T>,689 token_id: u32,690 key: &up_data_structs::PropertyKey,691) -> Result<String> {692 collection.consume_store_reads(1)?;693 let properties = <TokenProperties<T>>::try_get((collection.id, token_id))694 .map_err(|_| Error::Revert("Token properties not found".into()))?;695 if let Some(property) = properties.get(key) {696 return Ok(String::from_utf8_lossy(property).into());697 }698699 Err("Property tokenURI not found".into())700}701702fn get_token_permission<T: Config>(703 collection_id: CollectionId,704 key: &PropertyKey,705) -> Result<PropertyPermission> {706 let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)707 .map_err(|_| Error::Revert("No permissions for collection".into()))?;708 let a = token_property_permissions709 .get(key)710 .map(Clone::clone)711 .ok_or_else(|| {712 let key = String::from_utf8(key.clone().into_inner()).unwrap_or_default();713 Error::Revert(alloc::format!("No permission for key {}", key))714 })?;715 Ok(a)716}717718/// @title Unique extensions for ERC721.719#[solidity_interface(name = ERC721UniqueExtensions, enum(derive(PreDispatch)), enum_attr(weight))]720impl<T: Config> NonfungibleHandle<T>721where722 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,723{724 /// @notice A descriptive name for a collection of NFTs in this contract725 fn name(&self) -> String {726 decode_utf16(self.name.iter().copied())727 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))728 .collect::<String>()729 }730731 /// @notice An abbreviated name for NFTs in this contract732 fn symbol(&self) -> String {733 String::from_utf8_lossy(&self.token_prefix).into()734 }735736 /// @notice A description for the collection.737 fn description(&self) -> String {738 decode_utf16(self.description.iter().copied())739 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))740 .collect::<String>()741 }742743 /// Returns the owner (in cross format) of the token.744 ///745 /// @param tokenId Id for the token.746 fn cross_owner_of(&self, token_id: U256) -> Result<eth::CrossAddress> {747 Self::token_owner(&self, token_id.try_into()?)748 .map(|o| eth::CrossAddress::from_sub_cross_account::<T>(&o))749 .map_err(|_| Error::Revert("token not found".into()))750 }751752 /// Returns the token properties.753 ///754 /// @param tokenId Id for the token.755 /// @param keys Properties keys. Empty keys for all propertyes.756 /// @return Vector of properties key/value pairs.757 fn properties(&self, token_id: U256, keys: Vec<String>) -> Result<Vec<eth::Property>> {758 let keys = keys759 .into_iter()760 .map(|key| {761 <Vec<u8>>::from(key)762 .try_into()763 .map_err(|_| Error::Revert("key too large".into()))764 })765 .collect::<Result<Vec<_>>>()?;766767 <Self as CommonCollectionOperations<T>>::token_properties(768 &self,769 token_id.try_into()?,770 if keys.is_empty() { None } else { Some(keys) },771 )772 .into_iter()773 .map(eth::Property::try_from)774 .collect::<Result<Vec<_>>>()775 }776777 /// @notice Set or reaffirm the approved address for an NFT778 /// @dev The zero address indicates there is no approved address.779 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized780 /// operator of the current owner.781 /// @param approved The new substrate address approved NFT controller782 /// @param tokenId The NFT to approve783 #[weight(<SelfWeightOf<T>>::approve())]784 fn approve_cross(785 &mut self,786 caller: Caller,787 approved: eth::CrossAddress,788 token_id: U256,789 ) -> Result<()> {790 let caller = T::CrossAccountId::from_eth(caller);791 let approved = approved.into_sub_cross_account::<T>()?;792 let token = token_id.try_into()?;793794 <Pallet<T>>::set_allowance(self, &caller, token, Some(&approved))795 .map_err(dispatch_to_evm::<T>)?;796 Ok(())797 }798799 /// @notice Transfer ownership of an NFT800 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`801 /// is the zero address. Throws if `tokenId` is not a valid NFT.802 /// @param to The new owner803 /// @param tokenId The NFT to transfer804 #[weight(<SelfWeightOf<T>>::transfer())]805 fn transfer(&mut self, caller: Caller, to: Address, token_id: U256) -> Result<()> {806 let caller = T::CrossAccountId::from_eth(caller);807 let to = T::CrossAccountId::from_eth(to);808 let token = token_id.try_into()?;809 let budget = self810 .recorder811 .weight_calls_budget(<StructureWeight<T>>::find_parent());812813 <Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;814 Ok(())815 }816817 /// @notice Transfer ownership of an NFT818 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`819 /// is the zero address. Throws if `tokenId` is not a valid NFT.820 /// @param to The new owner821 /// @param tokenId The NFT to transfer822 #[weight(<SelfWeightOf<T>>::transfer())]823 fn transfer_cross(824 &mut self,825 caller: Caller,826 to: eth::CrossAddress,827 token_id: U256,828 ) -> Result<()> {829 let caller = T::CrossAccountId::from_eth(caller);830 let to = to.into_sub_cross_account::<T>()?;831 let token = token_id.try_into()?;832 let budget = self833 .recorder834 .weight_calls_budget(<StructureWeight<T>>::find_parent());835836 <Pallet<T>>::transfer(self, &caller, &to, token, &budget).map_err(dispatch_to_evm::<T>)?;837 Ok(())838 }839840 /// @notice Transfer ownership of an NFT from cross account address to cross account address841 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`842 /// is the zero address. Throws if `tokenId` is not a valid NFT.843 /// @param from Cross acccount address of current owner844 /// @param to Cross acccount address of new owner845 /// @param tokenId The NFT to transfer846 #[weight(<SelfWeightOf<T>>::transfer())]847 fn transfer_from_cross(848 &mut self,849 caller: Caller,850 from: eth::CrossAddress,851 to: eth::CrossAddress,852 token_id: U256,853 ) -> Result<()> {854 let caller = T::CrossAccountId::from_eth(caller);855 let from = from.into_sub_cross_account::<T>()?;856 let to = to.into_sub_cross_account::<T>()?;857 let token_id = token_id.try_into()?;858 let budget = self859 .recorder860 .weight_calls_budget(<StructureWeight<T>>::find_parent());861 Pallet::<T>::transfer_from(self, &caller, &from, &to, token_id, &budget)862 .map_err(dispatch_to_evm::<T>)?;863 Ok(())864 }865866 /// @notice Burns a specific ERC721 token.867 /// @dev Throws unless `msg.sender` is the current owner or an authorized868 /// operator for this NFT. Throws if `from` is not the current owner. Throws869 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.870 /// @param from The current owner of the NFT871 /// @param tokenId The NFT to transfer872 #[solidity(hide)]873 #[weight(<SelfWeightOf<T>>::burn_from())]874 fn burn_from(&mut self, caller: Caller, from: Address, token_id: U256) -> Result<()> {875 let caller = T::CrossAccountId::from_eth(caller);876 let from = T::CrossAccountId::from_eth(from);877 let token = token_id.try_into()?;878 let budget = self879 .recorder880 .weight_calls_budget(<StructureWeight<T>>::find_parent());881882 <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)883 .map_err(dispatch_to_evm::<T>)?;884 Ok(())885 }886887 /// @notice Burns a specific ERC721 token.888 /// @dev Throws unless `msg.sender` is the current owner or an authorized889 /// operator for this NFT. Throws if `from` is not the current owner. Throws890 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.891 /// @param from The current owner of the NFT892 /// @param tokenId The NFT to transfer893 #[weight(<SelfWeightOf<T>>::burn_from())]894 fn burn_from_cross(895 &mut self,896 caller: Caller,897 from: eth::CrossAddress,898 token_id: U256,899 ) -> Result<()> {900 let caller = T::CrossAccountId::from_eth(caller);901 let from = from.into_sub_cross_account::<T>()?;902 let token = token_id.try_into()?;903 let budget = self904 .recorder905 .weight_calls_budget(<StructureWeight<T>>::find_parent());906907 <Pallet<T>>::burn_from(self, &caller, &from, token, &budget)908 .map_err(dispatch_to_evm::<T>)?;909 Ok(())910 }911912 /// @notice Returns next free NFT ID.913 fn next_token_id(&self) -> Result<U256> {914 self.consume_store_reads(1)?;915 Ok(<TokensMinted<T>>::get(self.id)916 .checked_add(1)917 .ok_or("item id overflow")?918 .into())919 }920921 /// @notice Function to mint multiple tokens.922 /// @dev `tokenIds` should be an array of consecutive numbers and first number923 /// should be obtained with `nextTokenId` method924 /// @param to The new owner925 /// @param tokenIds IDs of the minted NFTs926 #[solidity(hide)]927 #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]928 fn mint_bulk(&mut self, caller: Caller, to: Address, token_ids: Vec<U256>) -> Result<bool> {929 let caller = T::CrossAccountId::from_eth(caller);930 let to = T::CrossAccountId::from_eth(to);931 let mut expected_index = <TokensMinted<T>>::get(self.id)932 .checked_add(1)933 .ok_or("item id overflow")?;934 let budget = self935 .recorder936 .weight_calls_budget(<StructureWeight<T>>::find_parent());937938 let total_tokens = token_ids.len();939 for id in token_ids.into_iter() {940 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;941 if id != expected_index {942 return Err("item id should be next".into());943 }944 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;945 }946 let data = (0..total_tokens)947 .map(|_| CreateItemData::<T> {948 properties: BoundedVec::default(),949 owner: to.clone(),950 })951 .collect();952953 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)954 .map_err(dispatch_to_evm::<T>)?;955 Ok(true)956 }957958 /// @notice Function to mint multiple tokens with the given tokenUris.959 /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive960 /// numbers and first number should be obtained with `nextTokenId` method961 /// @param to The new owner962 /// @param tokens array of pairs of token ID and token URI for minted tokens963 #[solidity(hide, rename_selector = "mintBulkWithTokenURI")]964 #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32) + <SelfWeightOf<T>>::set_token_properties(tokens.len() as u32))]965 fn mint_bulk_with_token_uri(966 &mut self,967 caller: Caller,968 to: Address,969 tokens: Vec<TokenUri>,970 ) -> Result<bool> {971 let key = key::url();972 let caller = T::CrossAccountId::from_eth(caller);973 let to = T::CrossAccountId::from_eth(to);974 let mut expected_index = <TokensMinted<T>>::get(self.id)975 .checked_add(1)976 .ok_or("item id overflow")?;977 let budget = self978 .recorder979 .weight_calls_budget(<StructureWeight<T>>::find_parent());980981 let mut data = Vec::with_capacity(tokens.len());982 for TokenUri { id, uri } in tokens {983 let id: u32 = id.try_into().map_err(|_| "token id overflow")?;984 if id != expected_index {985 return Err("item id should be next".into());986 }987 expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;988989 let mut properties = CollectionPropertiesVec::default();990 properties991 .try_push(Property {992 key: key.clone(),993 value: uri994 .into_bytes()995 .try_into()996 .map_err(|_| "token uri is too long")?,997 })998 .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;9991000 data.push(CreateItemData::<T> {1001 properties,1002 owner: to.clone(),1003 });1004 }10051006 <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)1007 .map_err(dispatch_to_evm::<T>)?;1008 Ok(true)1009 }10101011 /// @notice Function to mint a token.1012 /// @param to The new owner crossAccountId1013 /// @param properties Properties of minted token1014 /// @return uint256 The id of the newly minted token1015 #[weight(<SelfWeightOf<T>>::create_item() + <SelfWeightOf<T>>::set_token_properties(properties.len() as u32))]1016 fn mint_cross(1017 &mut self,1018 caller: Caller,1019 to: eth::CrossAddress,1020 properties: Vec<eth::Property>,1021 ) -> Result<U256> {1022 let token_id = <TokensMinted<T>>::get(self.id)1023 .checked_add(1)1024 .ok_or("item id overflow")?;10251026 let to = to.into_sub_cross_account::<T>()?;10271028 let properties = properties1029 .into_iter()1030 .map(eth::Property::try_into)1031 .collect::<Result<Vec<_>>>()?1032 .try_into()1033 .map_err(|_| Error::Revert(alloc::format!("too many properties")))?;10341035 let caller = T::CrossAccountId::from_eth(caller);10361037 let budget = self1038 .recorder1039 .weight_calls_budget(<StructureWeight<T>>::find_parent());10401041 <Pallet<T>>::create_item(1042 self,1043 &caller,1044 CreateItemData::<T> {1045 properties,1046 owner: to,1047 },1048 &budget,1049 )1050 .map_err(dispatch_to_evm::<T>)?;10511052 Ok(token_id.into())1053 }10541055 /// @notice Returns collection helper contract address1056 fn collection_helper_address(&self) -> Address {1057 T::ContractAddress::get()1058 }1059}10601061#[solidity_interface(1062 name = UniqueNFT,1063 is(1064 ERC721,1065 ERC721Enumerable,1066 ERC721UniqueExtensions,1067 ERC721UniqueMintable,1068 ERC721Burnable,1069 ERC721Metadata(if(this.flags.erc721metadata)),1070 Collection(via(common_mut returns CollectionHandle<T>)),1071 TokenProperties,1072 ),1073 enum(derive(PreDispatch)),1074)]1075impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}10761077// Not a tests, but code generators1078generate_stubgen!(gen_impl, UniqueNFTCall<()>, true);1079generate_stubgen!(gen_iface, UniqueNFTCall<()>, false);10801081impl<T: Config> CommonEvmHandler for NonfungibleHandle<T>1082where1083 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,1084{1085 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueNFT.raw");10861087 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {1088 call::<T, UniqueNFTCall<T>, _, _>(handle, self)1089 }1090}pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -112,7 +112,7 @@
};
use pallet_structure::{Pallet as PalletStructure, Error as StructureError};
use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};
-use sp_core::H160;
+use sp_core::{Get, H160};
use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};
use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};
use core::ops::Deref;
@@ -622,6 +622,11 @@
stored_properties,
is_token_owner,
|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),
+ erc::ERC721TokenEvent::TokenChanged {
+ collection_id: collection_id_to_address(collection.id),
+ token_id: token_id.into(),
+ }
+ .to_log(T::ContractAddress::get()),
)
}
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -17,9 +17,14 @@
}
}
+/// @dev inlined interface
+contract ERC721TokenEvent {
+ event TokenChanged(address indexed collectionId, uint256 tokenId);
+}
+
/// @title A contract that allows to set and delete token properties and change token property permissions.
/// @dev the ERC-165 identifier for this interface is 0xde0695c2
-contract TokenProperties is Dummy, ERC165 {
+contract TokenProperties is Dummy, ERC165, ERC721TokenEvent {
// /// @notice Set permissions for token property.
// /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
// /// @param key Property key.
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -59,8 +59,21 @@
pub const ADDRESS_FOR_PARTIALLY_OWNED_TOKENS: H160 = H160::repeat_byte(0xff);
+/// Rft events.
+#[derive(ToLog)]
+pub enum ERC721TokenEvent {
+ /// The token has been changed.
+ TokenChanged {
+ /// Collection ID.
+ #[indexed]
+ collection_id: Address,
+ /// Token ID.
+ token_id: U256,
+ },
+}
+
/// @title A contract that allows to set and delete token properties and change token property permissions.
-#[solidity_interface(name = TokenProperties, enum(derive(PreDispatch)), enum_attr(weight))]
+#[solidity_interface(name = TokenProperties, events(ERC721TokenEvent), enum(derive(PreDispatch)), enum_attr(weight))]
impl<T: Config> RefungibleHandle<T> {
/// @notice Set permissions for token property.
/// @dev Throws error if `msg.sender` is not admin or owner of the collection.
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -100,7 +100,7 @@
Event as CommonEvent, Pallet as PalletCommon,
};
use pallet_structure::Pallet as PalletStructure;
-use sp_core::H160;
+use sp_core::{Get, H160};
use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};
use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};
use up_data_structs::{
@@ -571,6 +571,11 @@
stored_properties,
is_token_owner,
|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),
+ erc::ERC721TokenEvent::TokenChanged {
+ collection_id: collection_id_to_address(collection.id),
+ token_id: token_id.into(),
+ }
+ .to_log(T::ContractAddress::get()),
)
}
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -17,9 +17,14 @@
}
}
+/// @dev inlined interface
+contract ERC721TokenEvent {
+ event TokenChanged(address indexed collectionId, uint256 tokenId);
+}
+
/// @title A contract that allows to set and delete token properties and change token property permissions.
/// @dev the ERC-165 identifier for this interface is 0xde0695c2
-contract TokenProperties is Dummy, ERC165 {
+contract TokenProperties is Dummy, ERC165, ERC721TokenEvent {
// /// @notice Set permissions for token property.
// /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
// /// @param key Property key.
pallets/unique/src/eth/stubs/CollectionHelpers.soldiffbeforeafterboth--- a/pallets/unique/src/eth/stubs/CollectionHelpers.sol
+++ b/pallets/unique/src/eth/stubs/CollectionHelpers.sol
@@ -22,7 +22,6 @@
event CollectionCreated(address indexed owner, address indexed collectionId);
event CollectionDestroyed(address indexed collectionId);
event CollectionChanged(address indexed collectionId);
- event TokenChanged(address indexed collectionId, uint256 tokenId);
}
/// @title Contract, which allows users to operate with collections
tests/src/eth/abi/collectionHelpers.jsondiffbeforeafterboth--- a/tests/src/eth/abi/collectionHelpers.json
+++ b/tests/src/eth/abi/collectionHelpers.json
@@ -45,25 +45,6 @@
"type": "event"
},
{
- "anonymous": false,
- "inputs": [
- {
- "indexed": true,
- "internalType": "address",
- "name": "collectionId",
- "type": "address"
- },
- {
- "indexed": false,
- "internalType": "uint256",
- "name": "tokenId",
- "type": "uint256"
- }
- ],
- "name": "TokenChanged",
- "type": "event"
- },
- {
"inputs": [
{ "internalType": "uint32", "name": "collectionId", "type": "uint32" }
],
tests/src/eth/abi/nonFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/nonFungible.json
+++ b/tests/src/eth/abi/nonFungible.json
@@ -55,6 +55,25 @@
{
"indexed": true,
"internalType": "address",
+ "name": "collectionId",
+ "type": "address"
+ },
+ {
+ "indexed": false,
+ "internalType": "uint256",
+ "name": "tokenId",
+ "type": "uint256"
+ }
+ ],
+ "name": "TokenChanged",
+ "type": "event"
+ },
+ {
+ "anonymous": false,
+ "inputs": [
+ {
+ "indexed": true,
+ "internalType": "address",
"name": "from",
"type": "address"
},
tests/src/eth/abi/reFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungible.json
+++ b/tests/src/eth/abi/reFungible.json
@@ -55,6 +55,25 @@
{
"indexed": true,
"internalType": "address",
+ "name": "collectionId",
+ "type": "address"
+ },
+ {
+ "indexed": false,
+ "internalType": "uint256",
+ "name": "tokenId",
+ "type": "uint256"
+ }
+ ],
+ "name": "TokenChanged",
+ "type": "event"
+ },
+ {
+ "anonymous": false,
+ "inputs": [
+ {
+ "indexed": true,
+ "internalType": "address",
"name": "from",
"type": "address"
},
tests/src/eth/api/CollectionHelpers.soldiffbeforeafterboth--- a/tests/src/eth/api/CollectionHelpers.sol
+++ b/tests/src/eth/api/CollectionHelpers.sol
@@ -17,7 +17,6 @@
event CollectionCreated(address indexed owner, address indexed collectionId);
event CollectionDestroyed(address indexed collectionId);
event CollectionChanged(address indexed collectionId);
- event TokenChanged(address indexed collectionId, uint256 tokenId);
}
/// @title Contract, which allows users to operate with collections
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -12,9 +12,14 @@
function supportsInterface(bytes4 interfaceID) external view returns (bool);
}
+/// @dev inlined interface
+interface ERC721TokenEvent {
+ event TokenChanged(address indexed collectionId, uint256 tokenId);
+}
+
/// @title A contract that allows to set and delete token properties and change token property permissions.
/// @dev the ERC-165 identifier for this interface is 0xde0695c2
-interface TokenProperties is Dummy, ERC165 {
+interface TokenProperties is Dummy, ERC165, ERC721TokenEvent {
// /// @notice Set permissions for token property.
// /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
// /// @param key Property key.
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -12,9 +12,14 @@
function supportsInterface(bytes4 interfaceID) external view returns (bool);
}
+/// @dev inlined interface
+interface ERC721TokenEvent {
+ event TokenChanged(address indexed collectionId, uint256 tokenId);
+}
+
/// @title A contract that allows to set and delete token properties and change token property permissions.
/// @dev the ERC-165 identifier for this interface is 0xde0695c2
-interface TokenProperties is Dummy, ERC165 {
+interface TokenProperties is Dummy, ERC165, ERC721TokenEvent {
// /// @notice Set permissions for token property.
// /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
// /// @param key Property key.
tests/src/eth/events.test.tsdiffbeforeafterboth--- a/tests/src/eth/events.test.ts
+++ b/tests/src/eth/events.test.ts
@@ -29,8 +29,10 @@
});
});
-function clearEvents(ethEvents: NormalizedEvent[], subEvents: IEvent[]) {
- ethEvents.splice(0);
+function clearEvents(ethEvents: NormalizedEvent[] | null, subEvents: IEvent[]) {
+ if (ethEvents !== null) {
+ ethEvents.splice(0);
+ }
subEvents.splice(0);
}
@@ -374,7 +376,6 @@
const owner = await helper.eth.createAccountWithBalance(donor);
const {collectionAddress} = await helper.eth.createCollection(mode, owner, 'A', 'B', 'C');
const collection = await helper.ethNativeContract.collection(collectionAddress, mode, owner);
- const collectionHelper = await helper.ethNativeContract.collectionHelpers(owner);
const result = await collection.methods.mint(owner).send({from: owner});
const tokenId = result.events.Transfer.returnValues.tokenId;
await collection.methods.setTokenPropertyPermissions([
@@ -384,38 +385,31 @@
[TokenPermissionField.CollectionAdmin, true]],
],
]).send({from: owner});
-
- const ethEvents: any = [];
- collectionHelper.events.allEvents((_: any, event: any) => {
- ethEvents.push(event);
- });
const {unsubscribe, collectedEvents: subEvents} = await helper.subscribeEvents([{section: 'common', names: ['TokenPropertySet', 'TokenPropertyDeleted']}]);
{
- await collection.methods.setProperties(tokenId, [{key: 'A', value: [1,2,3]}]).send({from: owner});
+ const result = await collection.methods.setProperties(tokenId, [{key: 'A', value: [1,2,3]}]).send({from: owner});
await helper.wait.newBlocks(1);
- expect(ethEvents).to.containSubset([
- {
- event: 'TokenChanged',
- returnValues: {
- collectionId: collectionAddress,
- },
+ expect(result.events.TokenChanged).to.be.like({
+ event: 'TokenChanged',
+ returnValues: {
+ collectionId: collectionAddress,
+ tokenId: tokenId,
},
- ]);
+ });
expect(subEvents).to.containSubset([{method: 'TokenPropertySet'}]);
- clearEvents(ethEvents, subEvents);
+ clearEvents(null, subEvents);
}
{
- await collection.methods.deleteProperties(tokenId, ['A']).send({from: owner});
+ const result = await collection.methods.deleteProperties(tokenId, ['A']).send({from: owner});
await helper.wait.newBlocks(1);
- expect(ethEvents).to.containSubset([
- {
- event: 'TokenChanged',
- returnValues: {
- collectionId: collectionAddress,
- },
+ expect(result.events.TokenChanged).to.be.like({
+ event: 'TokenChanged',
+ returnValues: {
+ collectionId: collectionAddress,
+ tokenId: tokenId,
},
- ]);
+ });
expect(subEvents).to.containSubset([{method: 'TokenPropertyDeleted'}]);
}
unsubscribe();