difftreelog
feat add enum for AccessMode
in: master
12 files changed
pallets/common/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//! This module contains the implementation of pallet methods for evm.1819pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};20use evm_coder::{21 abi::AbiType,22 solidity_interface, solidity, ToLog,23 types::*,24 execution::{Result, Error},25 weight,26};27use pallet_evm_coder_substrate::dispatch_to_evm;28use sp_std::{vec, vec::Vec};29use sp_core::U256;30use up_data_structs::{31 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,32 SponsoringRateLimit, SponsorshipState,33};3435use crate::{36 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf, eth, weights::WeightInfo,37};3839/// Events for ethereum collection helper.40#[derive(ToLog)]41pub enum CollectionHelpersEvents {42 /// The collection has been created.43 CollectionCreated {44 /// Collection owner.45 #[indexed]46 owner: address,4748 /// Collection ID.49 #[indexed]50 collection_id: address,51 },52 /// The collection has been destroyed.53 CollectionDestroyed {54 /// Collection ID.55 #[indexed]56 collection_id: address,57 },58 /// The collection has been changed.59 CollectionChanged {60 /// Collection ID.61 #[indexed]62 collection_id: address,63 },6465 /// The token has been changed.66 TokenChanged {67 /// Collection ID.68 #[indexed]69 collection_id: address,70 /// Token ID.71 token_id: U256,72 },73}7475/// Does not always represent a full collection, for RFT it is either76/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).77pub trait CommonEvmHandler {78 /// Raw compiled binary code of the contract stub79 const CODE: &'static [u8];8081 /// Call precompiled handle.82 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;83}8485/// @title A contract that allows you to work with collections.86#[solidity_interface(name = Collection)]87impl<T: Config> CollectionHandle<T>88where89 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,90{91 /// Set collection property.92 ///93 /// @param key Property key.94 /// @param value Propery value.95 #[solidity(hide)]96 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]97 fn set_collection_property(&mut self, caller: caller, key: string, value: bytes) -> Result<()> {98 let caller = T::CrossAccountId::from_eth(caller);99 let key = <Vec<u8>>::from(key)100 .try_into()101 .map_err(|_| "key too large")?;102 let value = value.0.try_into().map_err(|_| "value too large")?;103104 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })105 .map_err(dispatch_to_evm::<T>)106 }107108 /// Set collection properties.109 ///110 /// @param properties Vector of properties key/value pair.111 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]112 fn set_collection_properties(113 &mut self,114 caller: caller,115 properties: Vec<eth::Property>,116 ) -> Result<()> {117 let caller = T::CrossAccountId::from_eth(caller);118119 let properties = properties120 .into_iter()121 .map(eth::Property::try_into)122 .collect::<Result<Vec<_>>>()?;123124 <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())125 .map_err(dispatch_to_evm::<T>)126 }127128 /// Delete collection property.129 ///130 /// @param key Property key.131 #[solidity(hide)]132 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]133 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {134 let caller = T::CrossAccountId::from_eth(caller);135 let key = <Vec<u8>>::from(key)136 .try_into()137 .map_err(|_| "key too large")?;138139 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)140 }141142 /// Delete collection properties.143 ///144 /// @param keys Properties keys.145 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]146 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {147 let caller = T::CrossAccountId::from_eth(caller);148 let keys = keys149 .into_iter()150 .map(|key| {151 <Vec<u8>>::from(key)152 .try_into()153 .map_err(|_| Error::Revert("key too large".into()))154 })155 .collect::<Result<Vec<_>>>()?;156157 <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())158 .map_err(dispatch_to_evm::<T>)159 }160161 /// Get collection property.162 ///163 /// @dev Throws error if key not found.164 ///165 /// @param key Property key.166 /// @return bytes The property corresponding to the key.167 fn collection_property(&self, key: string) -> Result<bytes> {168 let key = <Vec<u8>>::from(key)169 .try_into()170 .map_err(|_| "key too large")?;171172 let props = CollectionProperties::<T>::get(self.id);173 let prop = props.get(&key).ok_or("key not found")?;174175 Ok(bytes(prop.to_vec()))176 }177178 /// Get collection properties.179 ///180 /// @param keys Properties keys. Empty keys for all propertyes.181 /// @return Vector of properties key/value pairs.182 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {183 let keys = keys184 .into_iter()185 .map(|key| {186 <Vec<u8>>::from(key)187 .try_into()188 .map_err(|_| Error::Revert("key too large".into()))189 })190 .collect::<Result<Vec<_>>>()?;191192 let properties = Pallet::<T>::filter_collection_properties(193 self.id,194 if keys.is_empty() { None } else { Some(keys) },195 )196 .map_err(dispatch_to_evm::<T>)?;197198 let properties = properties199 .into_iter()200 .map(Property::try_into)201 .collect::<Result<Vec<_>>>()?;202 Ok(properties)203 }204205 /// Set the sponsor of the collection.206 ///207 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.208 ///209 /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.210 #[solidity(hide)]211 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<()> {212 self.consume_store_reads_and_writes(1, 1)?;213214 let caller = T::CrossAccountId::from_eth(caller);215216 let sponsor = T::CrossAccountId::from_eth(sponsor);217 self.set_sponsor(&caller, sponsor.as_sub().clone())218 .map_err(dispatch_to_evm::<T>)219 }220221 /// Set the sponsor of the collection.222 ///223 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.224 ///225 /// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.226 fn set_collection_sponsor_cross(227 &mut self,228 caller: caller,229 sponsor: eth::CrossAddress,230 ) -> Result<()> {231 self.consume_store_reads_and_writes(1, 1)?;232233 let caller = T::CrossAccountId::from_eth(caller);234235 let sponsor = sponsor.into_sub_cross_account::<T>()?;236 self.set_sponsor(&caller, sponsor.as_sub().clone())237 .map_err(dispatch_to_evm::<T>)238 }239240 /// Whether there is a pending sponsor.241 fn has_collection_pending_sponsor(&self) -> Result<bool> {242 Ok(matches!(243 self.collection.sponsorship,244 SponsorshipState::Unconfirmed(_)245 ))246 }247248 /// Collection sponsorship confirmation.249 ///250 /// @dev After setting the sponsor for the collection, it must be confirmed with this function.251 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<()> {252 self.consume_store_writes(1)?;253254 let caller = T::CrossAccountId::from_eth(caller);255 self.confirm_sponsorship(caller.as_sub())256 .map_err(dispatch_to_evm::<T>)257 }258259 /// Remove collection sponsor.260 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<()> {261 self.consume_store_reads_and_writes(1, 1)?;262 let caller = T::CrossAccountId::from_eth(caller);263 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)264 }265266 /// Get current sponsor.267 ///268 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.269 fn collection_sponsor(&self) -> Result<eth::CrossAddress> {270 let sponsor = match self.collection.sponsorship.sponsor() {271 Some(sponsor) => sponsor,272 None => return Ok(Default::default()),273 };274275 Ok(eth::CrossAddress::from_sub::<T>(&sponsor))276 }277278 /// Get current collection limits.279 ///280 /// @return Array of collection limits281 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {282 let limits = &self.collection.limits;283284 let convert_value_from_bool = |ob: Option<bool>| match ob {285 Some(b) => Some(b as u32),286 None => None,287 };288289 Ok(vec![290 eth::CollectionLimit::new(291 eth::CollectionLimitField::AccountTokenOwnership,292 limits.account_token_ownership_limit,293 ),294 eth::CollectionLimit::new(295 eth::CollectionLimitField::SponsoredDataSize,296 limits.sponsored_data_size,297 ),298 limits299 .sponsored_data_rate_limit300 .and_then(|limit| {301 if let SponsoringRateLimit::Blocks(blocks) = limit {302 Some(eth::CollectionLimit::new(303 eth::CollectionLimitField::SponsoredDataRateLimit,304 Some(blocks),305 ))306 } else {307 None308 }309 })310 .unwrap_or(eth::CollectionLimit::new(311 eth::CollectionLimitField::SponsoredDataRateLimit,312 Default::default(),313 )),314 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),315 eth::CollectionLimit::new(316 eth::CollectionLimitField::SponsorTransferTimeout,317 limits.sponsor_transfer_timeout,318 ),319 eth::CollectionLimit::new(320 eth::CollectionLimitField::SponsorApproveTimeout,321 limits.sponsor_approve_timeout,322 ),323 eth::CollectionLimit::new(324 eth::CollectionLimitField::OwnerCanTransfer,325 convert_value_from_bool(limits.owner_can_transfer),326 ),327 eth::CollectionLimit::new(328 eth::CollectionLimitField::OwnerCanDestroy,329 convert_value_from_bool(limits.owner_can_destroy),330 ),331 eth::CollectionLimit::new(332 eth::CollectionLimitField::TransferEnabled,333 convert_value_from_bool(limits.transfers_enabled),334 ),335 ])336 }337338 /// Set limits for the collection.339 /// @dev Throws error if limit not found.340 /// @param limit Some limit.341 #[solidity(rename_selector = "setCollectionLimit")]342 fn set_collection_limit(&mut self, caller: caller, limit: eth::CollectionLimit) -> Result<()> {343 self.consume_store_reads_and_writes(1, 1)?;344345 if !limit.has_value() {346 return Err(Error::Revert("user can't disable limits".into()));347 }348349 let caller = T::CrossAccountId::from_eth(caller);350 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)351 }352353 /// Get contract address.354 fn contract_address(&self) -> Result<address> {355 Ok(crate::eth::collection_id_to_address(self.id))356 }357358 /// Add collection admin.359 /// @param newAdmin Cross account administrator address.360 fn add_collection_admin_cross(361 &mut self,362 caller: caller,363 new_admin: eth::CrossAddress,364 ) -> Result<()> {365 self.consume_store_reads_and_writes(2, 2)?;366367 let caller = T::CrossAccountId::from_eth(caller);368 let new_admin = new_admin.into_sub_cross_account::<T>()?;369 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;370 Ok(())371 }372373 /// Remove collection admin.374 /// @param admin Cross account administrator address.375 fn remove_collection_admin_cross(376 &mut self,377 caller: caller,378 admin: eth::CrossAddress,379 ) -> Result<()> {380 self.consume_store_reads_and_writes(2, 2)?;381382 let caller = T::CrossAccountId::from_eth(caller);383 let admin = admin.into_sub_cross_account::<T>()?;384 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;385 Ok(())386 }387388 /// Add collection admin.389 /// @param newAdmin Address of the added administrator.390 #[solidity(hide)]391 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<()> {392 self.consume_store_reads_and_writes(2, 2)?;393394 let caller = T::CrossAccountId::from_eth(caller);395 let new_admin = T::CrossAccountId::from_eth(new_admin);396 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;397 Ok(())398 }399400 /// Remove collection admin.401 ///402 /// @param admin Address of the removed administrator.403 #[solidity(hide)]404 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<()> {405 self.consume_store_reads_and_writes(2, 2)?;406407 let caller = T::CrossAccountId::from_eth(caller);408 let admin = T::CrossAccountId::from_eth(admin);409 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;410 Ok(())411 }412413 /// Toggle accessibility of collection nesting.414 ///415 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'416 #[solidity(rename_selector = "setCollectionNesting")]417 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<()> {418 self.consume_store_reads_and_writes(1, 1)?;419420 let caller = T::CrossAccountId::from_eth(caller);421422 let mut permissions = self.collection.permissions.clone();423 let mut nesting = permissions.nesting().clone();424 nesting.token_owner = enable;425 nesting.restricted = None;426 permissions.nesting = Some(nesting);427428 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)429 }430431 /// Toggle accessibility of collection nesting.432 ///433 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'434 /// @param collections Addresses of collections that will be available for nesting.435 #[solidity(rename_selector = "setCollectionNesting")]436 fn set_nesting(437 &mut self,438 caller: caller,439 enable: bool,440 collections: Vec<address>,441 ) -> Result<()> {442 self.consume_store_reads_and_writes(1, 1)?;443444 if collections.is_empty() {445 return Err("no addresses provided".into());446 }447 let caller = T::CrossAccountId::from_eth(caller);448449 let mut permissions = self.collection.permissions.clone();450 match enable {451 false => {452 let mut nesting = permissions.nesting().clone();453 nesting.token_owner = false;454 nesting.restricted = None;455 permissions.nesting = Some(nesting);456 }457 true => {458 let mut bv = OwnerRestrictedSet::new();459 for i in collections {460 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {461 Error::Revert("Can't convert address into collection id".into())462 })?)463 .map_err(|_| "too many collections")?;464 }465 let mut nesting = permissions.nesting().clone();466 nesting.token_owner = true;467 nesting.restricted = Some(bv);468 permissions.nesting = Some(nesting);469 }470 };471472 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)473 }474475 /// Returns nesting for a collection476 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]477 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {478 let nesting = self.collection.permissions.nesting();479480 Ok(eth::CollectionNesting::new(481 nesting.token_owner,482 nesting483 .restricted484 .clone()485 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())486 .unwrap_or_default(),487 ))488 }489490 /// Returns permissions for a collection491 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {492 let nesting = self.collection.permissions.nesting();493 Ok(vec![494 eth::CollectionNestingPermission::new(495 eth::CollectionPermissionField::CollectionAdmin,496 nesting.collection_admin,497 ),498 eth::CollectionNestingPermission::new(499 eth::CollectionPermissionField::TokenOwner,500 nesting.token_owner,501 ),502 ])503 }504 /// Set the collection access method.505 /// @param mode Access mode506 /// 0 for Normal507 /// 1 for AllowList508 fn set_collection_access(&mut self, caller: caller, mode: u8) -> Result<()> {509 self.consume_store_reads_and_writes(1, 1)?;510511 let caller = T::CrossAccountId::from_eth(caller);512 let permissions = CollectionPermissions {513 access: Some(match mode {514 0 => AccessMode::Normal,515 1 => AccessMode::AllowList,516 _ => return Err("not supported access mode".into()),517 }),518 ..Default::default()519 };520 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)521 }522523 /// Checks that user allowed to operate with collection.524 ///525 /// @param user User address to check.526 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {527 let user = user.into_sub_cross_account::<T>()?;528 Ok(Pallet::<T>::allowed(self.id, user))529 }530531 /// Add the user to the allowed list.532 ///533 /// @param user Address of a trusted user.534 #[solidity(hide)]535 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {536 self.consume_store_writes(1)?;537538 let caller = T::CrossAccountId::from_eth(caller);539 let user = T::CrossAccountId::from_eth(user);540 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;541 Ok(())542 }543544 /// Add user to allowed list.545 ///546 /// @param user User cross account address.547 fn add_to_collection_allow_list_cross(548 &mut self,549 caller: caller,550 user: eth::CrossAddress,551 ) -> Result<()> {552 self.consume_store_writes(1)?;553554 let caller = T::CrossAccountId::from_eth(caller);555 let user = user.into_sub_cross_account::<T>()?;556 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;557 Ok(())558 }559560 /// Remove the user from the allowed list.561 ///562 /// @param user Address of a removed user.563 #[solidity(hide)]564 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {565 self.consume_store_writes(1)?;566567 let caller = T::CrossAccountId::from_eth(caller);568 let user = T::CrossAccountId::from_eth(user);569 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;570 Ok(())571 }572573 /// Remove user from allowed list.574 ///575 /// @param user User cross account address.576 fn remove_from_collection_allow_list_cross(577 &mut self,578 caller: caller,579 user: eth::CrossAddress,580 ) -> Result<()> {581 self.consume_store_writes(1)?;582583 let caller = T::CrossAccountId::from_eth(caller);584 let user = user.into_sub_cross_account::<T>()?;585 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;586 Ok(())587 }588589 /// Switch permission for minting.590 ///591 /// @param mode Enable if "true".592 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<()> {593 self.consume_store_reads_and_writes(1, 1)?;594595 let caller = T::CrossAccountId::from_eth(caller);596 let permissions = CollectionPermissions {597 mint_mode: Some(mode),598 ..Default::default()599 };600 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)601 }602603 /// Check that account is the owner or admin of the collection604 ///605 /// @param user account to verify606 /// @return "true" if account is the owner or admin607 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]608 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {609 let user = T::CrossAccountId::from_eth(user);610 Ok(self.is_owner_or_admin(&user))611 }612613 /// Check that account is the owner or admin of the collection614 ///615 /// @param user User cross account to verify616 /// @return "true" if account is the owner or admin617 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {618 let user = user.into_sub_cross_account::<T>()?;619 Ok(self.is_owner_or_admin(&user))620 }621622 /// Returns collection type623 ///624 /// @return `Fungible` or `NFT` or `ReFungible`625 fn unique_collection_type(&self) -> Result<string> {626 let mode = match self.collection.mode {627 CollectionMode::Fungible(_) => "Fungible",628 CollectionMode::NFT => "NFT",629 CollectionMode::ReFungible => "ReFungible",630 };631 Ok(mode.into())632 }633634 /// Get collection owner.635 ///636 /// @return Tuble with sponsor address and his substrate mirror.637 /// If address is canonical then substrate mirror is zero and vice versa.638 fn collection_owner(&self) -> Result<eth::CrossAddress> {639 Ok(eth::CrossAddress::from_sub_cross_account::<T>(640 &T::CrossAccountId::from_sub(self.owner.clone()),641 ))642 }643644 /// Changes collection owner to another account645 ///646 /// @dev Owner can be changed only by current owner647 /// @param newOwner new owner account648 #[solidity(hide, rename_selector = "changeCollectionOwner")]649 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<()> {650 self.consume_store_writes(1)?;651652 let caller = T::CrossAccountId::from_eth(caller);653 let new_owner = T::CrossAccountId::from_eth(new_owner);654 self.change_owner(caller, new_owner)655 .map_err(dispatch_to_evm::<T>)656 }657658 /// Get collection administrators659 ///660 /// @return Vector of tuples with admins address and his substrate mirror.661 /// If address is canonical then substrate mirror is zero and vice versa.662 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {663 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))664 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))665 .collect();666 Ok(result)667 }668669 /// Changes collection owner to another account670 ///671 /// @dev Owner can be changed only by current owner672 /// @param newOwner new owner cross account673 fn change_collection_owner_cross(674 &mut self,675 caller: caller,676 new_owner: eth::CrossAddress,677 ) -> Result<()> {678 self.consume_store_writes(1)?;679680 let caller = T::CrossAccountId::from_eth(caller);681 let new_owner = new_owner.into_sub_cross_account::<T>()?;682 self.change_owner(caller, new_owner)683 .map_err(dispatch_to_evm::<T>)684 }685}686687/// Contains static property keys and values.688pub mod static_property {689 use evm_coder::{690 execution::{Result, Error},691 };692 use alloc::format;693694 const EXPECT_CONVERT_ERROR: &str = "length < limit";695696 /// Keys.697 pub mod key {698 use super::*;699700 /// Key "baseURI".701 pub fn base_uri() -> up_data_structs::PropertyKey {702 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)703 }704705 /// Key "url".706 pub fn url() -> up_data_structs::PropertyKey {707 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)708 }709710 /// Key "suffix".711 pub fn suffix() -> up_data_structs::PropertyKey {712 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)713 }714715 /// Key "parentNft".716 pub fn parent_nft() -> up_data_structs::PropertyKey {717 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)718 }719 }720721 /// Convert `byte` to [`PropertyKey`].722 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {723 bytes.to_vec().try_into().map_err(|_| {724 Error::Revert(format!(725 "Property key is too long. Max length is {}.",726 up_data_structs::PropertyKey::bound()727 ))728 })729 }730731 /// Convert `bytes` to [`PropertyValue`].732 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {733 bytes.to_vec().try_into().map_err(|_| {734 Error::Revert(format!(735 "Property key is too long. Max length is {}.",736 up_data_structs::PropertyKey::bound()737 ))738 })739 }740}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//! This module contains the implementation of pallet methods for evm.1819pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};20use evm_coder::{21 abi::AbiType,22 solidity_interface, solidity, ToLog,23 types::*,24 execution::{Result, Error},25 weight,26};27use pallet_evm_coder_substrate::dispatch_to_evm;28use sp_std::{vec, vec::Vec};29use sp_core::U256;30use up_data_structs::{31 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,32 SponsoringRateLimit, SponsorshipState,33};3435use crate::{36 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf, eth, weights::WeightInfo,37};3839/// Events for ethereum collection helper.40#[derive(ToLog)]41pub enum CollectionHelpersEvents {42 /// The collection has been created.43 CollectionCreated {44 /// Collection owner.45 #[indexed]46 owner: address,4748 /// Collection ID.49 #[indexed]50 collection_id: address,51 },52 /// The collection has been destroyed.53 CollectionDestroyed {54 /// Collection ID.55 #[indexed]56 collection_id: address,57 },58 /// The collection has been changed.59 CollectionChanged {60 /// Collection ID.61 #[indexed]62 collection_id: address,63 },6465 /// The token has been changed.66 TokenChanged {67 /// Collection ID.68 #[indexed]69 collection_id: address,70 /// Token ID.71 token_id: U256,72 },73}7475/// Does not always represent a full collection, for RFT it is either76/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).77pub trait CommonEvmHandler {78 /// Raw compiled binary code of the contract stub79 const CODE: &'static [u8];8081 /// Call precompiled handle.82 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;83}8485/// @title A contract that allows you to work with collections.86#[solidity_interface(name = Collection)]87impl<T: Config> CollectionHandle<T>88where89 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,90{91 /// Set collection property.92 ///93 /// @param key Property key.94 /// @param value Propery value.95 #[solidity(hide)]96 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]97 fn set_collection_property(&mut self, caller: caller, key: string, value: bytes) -> Result<()> {98 let caller = T::CrossAccountId::from_eth(caller);99 let key = <Vec<u8>>::from(key)100 .try_into()101 .map_err(|_| "key too large")?;102 let value = value.0.try_into().map_err(|_| "value too large")?;103104 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })105 .map_err(dispatch_to_evm::<T>)106 }107108 /// Set collection properties.109 ///110 /// @param properties Vector of properties key/value pair.111 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]112 fn set_collection_properties(113 &mut self,114 caller: caller,115 properties: Vec<eth::Property>,116 ) -> Result<()> {117 let caller = T::CrossAccountId::from_eth(caller);118119 let properties = properties120 .into_iter()121 .map(eth::Property::try_into)122 .collect::<Result<Vec<_>>>()?;123124 <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())125 .map_err(dispatch_to_evm::<T>)126 }127128 /// Delete collection property.129 ///130 /// @param key Property key.131 #[solidity(hide)]132 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]133 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {134 let caller = T::CrossAccountId::from_eth(caller);135 let key = <Vec<u8>>::from(key)136 .try_into()137 .map_err(|_| "key too large")?;138139 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)140 }141142 /// Delete collection properties.143 ///144 /// @param keys Properties keys.145 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]146 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {147 let caller = T::CrossAccountId::from_eth(caller);148 let keys = keys149 .into_iter()150 .map(|key| {151 <Vec<u8>>::from(key)152 .try_into()153 .map_err(|_| Error::Revert("key too large".into()))154 })155 .collect::<Result<Vec<_>>>()?;156157 <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())158 .map_err(dispatch_to_evm::<T>)159 }160161 /// Get collection property.162 ///163 /// @dev Throws error if key not found.164 ///165 /// @param key Property key.166 /// @return bytes The property corresponding to the key.167 fn collection_property(&self, key: string) -> Result<bytes> {168 let key = <Vec<u8>>::from(key)169 .try_into()170 .map_err(|_| "key too large")?;171172 let props = CollectionProperties::<T>::get(self.id);173 let prop = props.get(&key).ok_or("key not found")?;174175 Ok(bytes(prop.to_vec()))176 }177178 /// Get collection properties.179 ///180 /// @param keys Properties keys. Empty keys for all propertyes.181 /// @return Vector of properties key/value pairs.182 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {183 let keys = keys184 .into_iter()185 .map(|key| {186 <Vec<u8>>::from(key)187 .try_into()188 .map_err(|_| Error::Revert("key too large".into()))189 })190 .collect::<Result<Vec<_>>>()?;191192 let properties = Pallet::<T>::filter_collection_properties(193 self.id,194 if keys.is_empty() { None } else { Some(keys) },195 )196 .map_err(dispatch_to_evm::<T>)?;197198 let properties = properties199 .into_iter()200 .map(Property::try_into)201 .collect::<Result<Vec<_>>>()?;202 Ok(properties)203 }204205 /// Set the sponsor of the collection.206 ///207 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.208 ///209 /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.210 #[solidity(hide)]211 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<()> {212 self.consume_store_reads_and_writes(1, 1)?;213214 let caller = T::CrossAccountId::from_eth(caller);215216 let sponsor = T::CrossAccountId::from_eth(sponsor);217 self.set_sponsor(&caller, sponsor.as_sub().clone())218 .map_err(dispatch_to_evm::<T>)219 }220221 /// Set the sponsor of the collection.222 ///223 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.224 ///225 /// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.226 fn set_collection_sponsor_cross(227 &mut self,228 caller: caller,229 sponsor: eth::CrossAddress,230 ) -> Result<()> {231 self.consume_store_reads_and_writes(1, 1)?;232233 let caller = T::CrossAccountId::from_eth(caller);234235 let sponsor = sponsor.into_sub_cross_account::<T>()?;236 self.set_sponsor(&caller, sponsor.as_sub().clone())237 .map_err(dispatch_to_evm::<T>)238 }239240 /// Whether there is a pending sponsor.241 fn has_collection_pending_sponsor(&self) -> Result<bool> {242 Ok(matches!(243 self.collection.sponsorship,244 SponsorshipState::Unconfirmed(_)245 ))246 }247248 /// Collection sponsorship confirmation.249 ///250 /// @dev After setting the sponsor for the collection, it must be confirmed with this function.251 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<()> {252 self.consume_store_writes(1)?;253254 let caller = T::CrossAccountId::from_eth(caller);255 self.confirm_sponsorship(caller.as_sub())256 .map_err(dispatch_to_evm::<T>)257 }258259 /// Remove collection sponsor.260 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<()> {261 self.consume_store_reads_and_writes(1, 1)?;262 let caller = T::CrossAccountId::from_eth(caller);263 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)264 }265266 /// Get current sponsor.267 ///268 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.269 fn collection_sponsor(&self) -> Result<eth::CrossAddress> {270 let sponsor = match self.collection.sponsorship.sponsor() {271 Some(sponsor) => sponsor,272 None => return Ok(Default::default()),273 };274275 Ok(eth::CrossAddress::from_sub::<T>(&sponsor))276 }277278 /// Get current collection limits.279 ///280 /// @return Array of collection limits281 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {282 let limits = &self.collection.limits;283284 let convert_value_from_bool = |ob: Option<bool>| match ob {285 Some(b) => Some(b as u32),286 None => None,287 };288289 Ok(vec![290 eth::CollectionLimit::new(291 eth::CollectionLimitField::AccountTokenOwnership,292 limits.account_token_ownership_limit,293 ),294 eth::CollectionLimit::new(295 eth::CollectionLimitField::SponsoredDataSize,296 limits.sponsored_data_size,297 ),298 limits299 .sponsored_data_rate_limit300 .and_then(|limit| {301 if let SponsoringRateLimit::Blocks(blocks) = limit {302 Some(eth::CollectionLimit::new(303 eth::CollectionLimitField::SponsoredDataRateLimit,304 Some(blocks),305 ))306 } else {307 None308 }309 })310 .unwrap_or(eth::CollectionLimit::new(311 eth::CollectionLimitField::SponsoredDataRateLimit,312 Default::default(),313 )),314 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),315 eth::CollectionLimit::new(316 eth::CollectionLimitField::SponsorTransferTimeout,317 limits.sponsor_transfer_timeout,318 ),319 eth::CollectionLimit::new(320 eth::CollectionLimitField::SponsorApproveTimeout,321 limits.sponsor_approve_timeout,322 ),323 eth::CollectionLimit::new(324 eth::CollectionLimitField::OwnerCanTransfer,325 convert_value_from_bool(limits.owner_can_transfer),326 ),327 eth::CollectionLimit::new(328 eth::CollectionLimitField::OwnerCanDestroy,329 convert_value_from_bool(limits.owner_can_destroy),330 ),331 eth::CollectionLimit::new(332 eth::CollectionLimitField::TransferEnabled,333 convert_value_from_bool(limits.transfers_enabled),334 ),335 ])336 }337338 /// Set limits for the collection.339 /// @dev Throws error if limit not found.340 /// @param limit Some limit.341 #[solidity(rename_selector = "setCollectionLimit")]342 fn set_collection_limit(&mut self, caller: caller, limit: eth::CollectionLimit) -> Result<()> {343 self.consume_store_reads_and_writes(1, 1)?;344345 if !limit.has_value() {346 return Err(Error::Revert("user can't disable limits".into()));347 }348349 let caller = T::CrossAccountId::from_eth(caller);350 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)351 }352353 /// Get contract address.354 fn contract_address(&self) -> Result<address> {355 Ok(crate::eth::collection_id_to_address(self.id))356 }357358 /// Add collection admin.359 /// @param newAdmin Cross account administrator address.360 fn add_collection_admin_cross(361 &mut self,362 caller: caller,363 new_admin: eth::CrossAddress,364 ) -> Result<()> {365 self.consume_store_reads_and_writes(2, 2)?;366367 let caller = T::CrossAccountId::from_eth(caller);368 let new_admin = new_admin.into_sub_cross_account::<T>()?;369 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;370 Ok(())371 }372373 /// Remove collection admin.374 /// @param admin Cross account administrator address.375 fn remove_collection_admin_cross(376 &mut self,377 caller: caller,378 admin: eth::CrossAddress,379 ) -> Result<()> {380 self.consume_store_reads_and_writes(2, 2)?;381382 let caller = T::CrossAccountId::from_eth(caller);383 let admin = admin.into_sub_cross_account::<T>()?;384 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;385 Ok(())386 }387388 /// Add collection admin.389 /// @param newAdmin Address of the added administrator.390 #[solidity(hide)]391 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<()> {392 self.consume_store_reads_and_writes(2, 2)?;393394 let caller = T::CrossAccountId::from_eth(caller);395 let new_admin = T::CrossAccountId::from_eth(new_admin);396 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;397 Ok(())398 }399400 /// Remove collection admin.401 ///402 /// @param admin Address of the removed administrator.403 #[solidity(hide)]404 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<()> {405 self.consume_store_reads_and_writes(2, 2)?;406407 let caller = T::CrossAccountId::from_eth(caller);408 let admin = T::CrossAccountId::from_eth(admin);409 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;410 Ok(())411 }412413 /// Toggle accessibility of collection nesting.414 ///415 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'416 #[solidity(rename_selector = "setCollectionNesting")]417 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<()> {418 self.consume_store_reads_and_writes(1, 1)?;419420 let caller = T::CrossAccountId::from_eth(caller);421422 let mut permissions = self.collection.permissions.clone();423 let mut nesting = permissions.nesting().clone();424 nesting.token_owner = enable;425 nesting.restricted = None;426 permissions.nesting = Some(nesting);427428 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)429 }430431 /// Toggle accessibility of collection nesting.432 ///433 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'434 /// @param collections Addresses of collections that will be available for nesting.435 #[solidity(rename_selector = "setCollectionNesting")]436 fn set_nesting(437 &mut self,438 caller: caller,439 enable: bool,440 collections: Vec<address>,441 ) -> Result<()> {442 self.consume_store_reads_and_writes(1, 1)?;443444 if collections.is_empty() {445 return Err("no addresses provided".into());446 }447 let caller = T::CrossAccountId::from_eth(caller);448449 let mut permissions = self.collection.permissions.clone();450 match enable {451 false => {452 let mut nesting = permissions.nesting().clone();453 nesting.token_owner = false;454 nesting.restricted = None;455 permissions.nesting = Some(nesting);456 }457 true => {458 let mut bv = OwnerRestrictedSet::new();459 for i in collections {460 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {461 Error::Revert("Can't convert address into collection id".into())462 })?)463 .map_err(|_| "too many collections")?;464 }465 let mut nesting = permissions.nesting().clone();466 nesting.token_owner = true;467 nesting.restricted = Some(bv);468 permissions.nesting = Some(nesting);469 }470 };471472 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)473 }474475 /// Returns nesting for a collection476 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]477 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {478 let nesting = self.collection.permissions.nesting();479480 Ok(eth::CollectionNesting::new(481 nesting.token_owner,482 nesting483 .restricted484 .clone()485 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())486 .unwrap_or_default(),487 ))488 }489490 /// Returns permissions for a collection491 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {492 let nesting = self.collection.permissions.nesting();493 Ok(vec![494 eth::CollectionNestingPermission::new(495 eth::CollectionPermissionField::CollectionAdmin,496 nesting.collection_admin,497 ),498 eth::CollectionNestingPermission::new(499 eth::CollectionPermissionField::TokenOwner,500 nesting.token_owner,501 ),502 ])503 }504 /// Set the collection access method.505 /// @param mode Access mode506 fn set_collection_access(&mut self, caller: caller, mode: eth::AccessMode) -> Result<()> {507 self.consume_store_reads_and_writes(1, 1)?;508509 let caller = T::CrossAccountId::from_eth(caller);510 let permissions = CollectionPermissions {511 access: Some(mode.into()),512 ..Default::default()513 };514 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)515 }516517 /// Checks that user allowed to operate with collection.518 ///519 /// @param user User address to check.520 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {521 let user = user.into_sub_cross_account::<T>()?;522 Ok(Pallet::<T>::allowed(self.id, user))523 }524525 /// Add the user to the allowed list.526 ///527 /// @param user Address of a trusted user.528 #[solidity(hide)]529 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {530 self.consume_store_writes(1)?;531532 let caller = T::CrossAccountId::from_eth(caller);533 let user = T::CrossAccountId::from_eth(user);534 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;535 Ok(())536 }537538 /// Add user to allowed list.539 ///540 /// @param user User cross account address.541 fn add_to_collection_allow_list_cross(542 &mut self,543 caller: caller,544 user: eth::CrossAddress,545 ) -> Result<()> {546 self.consume_store_writes(1)?;547548 let caller = T::CrossAccountId::from_eth(caller);549 let user = user.into_sub_cross_account::<T>()?;550 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;551 Ok(())552 }553554 /// Remove the user from the allowed list.555 ///556 /// @param user Address of a removed user.557 #[solidity(hide)]558 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {559 self.consume_store_writes(1)?;560561 let caller = T::CrossAccountId::from_eth(caller);562 let user = T::CrossAccountId::from_eth(user);563 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;564 Ok(())565 }566567 /// Remove user from allowed list.568 ///569 /// @param user User cross account address.570 fn remove_from_collection_allow_list_cross(571 &mut self,572 caller: caller,573 user: eth::CrossAddress,574 ) -> Result<()> {575 self.consume_store_writes(1)?;576577 let caller = T::CrossAccountId::from_eth(caller);578 let user = user.into_sub_cross_account::<T>()?;579 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;580 Ok(())581 }582583 /// Switch permission for minting.584 ///585 /// @param mode Enable if "true".586 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<()> {587 self.consume_store_reads_and_writes(1, 1)?;588589 let caller = T::CrossAccountId::from_eth(caller);590 let permissions = CollectionPermissions {591 mint_mode: Some(mode),592 ..Default::default()593 };594 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)595 }596597 /// Check that account is the owner or admin of the collection598 ///599 /// @param user account to verify600 /// @return "true" if account is the owner or admin601 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]602 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {603 let user = T::CrossAccountId::from_eth(user);604 Ok(self.is_owner_or_admin(&user))605 }606607 /// Check that account is the owner or admin of the collection608 ///609 /// @param user User cross account to verify610 /// @return "true" if account is the owner or admin611 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {612 let user = user.into_sub_cross_account::<T>()?;613 Ok(self.is_owner_or_admin(&user))614 }615616 /// Returns collection type617 ///618 /// @return `Fungible` or `NFT` or `ReFungible`619 fn unique_collection_type(&self) -> Result<string> {620 let mode = match self.collection.mode {621 CollectionMode::Fungible(_) => "Fungible",622 CollectionMode::NFT => "NFT",623 CollectionMode::ReFungible => "ReFungible",624 };625 Ok(mode.into())626 }627628 /// Get collection owner.629 ///630 /// @return Tuble with sponsor address and his substrate mirror.631 /// If address is canonical then substrate mirror is zero and vice versa.632 fn collection_owner(&self) -> Result<eth::CrossAddress> {633 Ok(eth::CrossAddress::from_sub_cross_account::<T>(634 &T::CrossAccountId::from_sub(self.owner.clone()),635 ))636 }637638 /// Changes collection owner to another account639 ///640 /// @dev Owner can be changed only by current owner641 /// @param newOwner new owner account642 #[solidity(hide, rename_selector = "changeCollectionOwner")]643 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<()> {644 self.consume_store_writes(1)?;645646 let caller = T::CrossAccountId::from_eth(caller);647 let new_owner = T::CrossAccountId::from_eth(new_owner);648 self.change_owner(caller, new_owner)649 .map_err(dispatch_to_evm::<T>)650 }651652 /// Get collection administrators653 ///654 /// @return Vector of tuples with admins address and his substrate mirror.655 /// If address is canonical then substrate mirror is zero and vice versa.656 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {657 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))658 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))659 .collect();660 Ok(result)661 }662663 /// Changes collection owner to another account664 ///665 /// @dev Owner can be changed only by current owner666 /// @param newOwner new owner cross account667 fn change_collection_owner_cross(668 &mut self,669 caller: caller,670 new_owner: eth::CrossAddress,671 ) -> Result<()> {672 self.consume_store_writes(1)?;673674 let caller = T::CrossAccountId::from_eth(caller);675 let new_owner = new_owner.into_sub_cross_account::<T>()?;676 self.change_owner(caller, new_owner)677 .map_err(dispatch_to_evm::<T>)678 }679}680681/// Contains static property keys and values.682pub mod static_property {683 use evm_coder::{684 execution::{Result, Error},685 };686 use alloc::format;687688 const EXPECT_CONVERT_ERROR: &str = "length < limit";689690 /// Keys.691 pub mod key {692 use super::*;693694 /// Key "baseURI".695 pub fn base_uri() -> up_data_structs::PropertyKey {696 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)697 }698699 /// Key "url".700 pub fn url() -> up_data_structs::PropertyKey {701 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)702 }703704 /// Key "suffix".705 pub fn suffix() -> up_data_structs::PropertyKey {706 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)707 }708709 /// Key "parentNft".710 pub fn parent_nft() -> up_data_structs::PropertyKey {711 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)712 }713 }714715 /// Convert `byte` to [`PropertyKey`].716 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {717 bytes.to_vec().try_into().map_err(|_| {718 Error::Revert(format!(719 "Property key is too long. Max length is {}.",720 up_data_structs::PropertyKey::bound()721 ))722 })723 }724725 /// Convert `bytes` to [`PropertyValue`].726 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {727 bytes.to_vec().try_into().map_err(|_| {728 Error::Revert(format!(729 "Property key is too long. Max length is {}.",730 up_data_structs::PropertyKey::bound()731 ))732 })733 }734}pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -413,3 +413,32 @@
Self { field, value }
}
}
+
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+#[derive(AbiCoder, Copy, Clone, Default, Debug)]
+#[repr(u8)]
+pub enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ #[default]
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList,
+}
+
+impl From<up_data_structs::AccessMode> for AccessMode {
+ fn from(value: up_data_structs::AccessMode) -> Self {
+ match value {
+ up_data_structs::AccessMode::Normal => AccessMode::Normal,
+ up_data_structs::AccessMode::AllowList => AccessMode::AllowList,
+ }
+ }
+}
+
+impl Into<up_data_structs::AccessMode> for AccessMode {
+ fn into(self) -> up_data_structs::AccessMode {
+ match self {
+ AccessMode::Normal => up_data_structs::AccessMode::Normal,
+ AccessMode::AllowList => up_data_structs::AccessMode::AllowList,
+ }
+ }
+}
pallets/fungible/src/stubs/UniqueFungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/fungible/src/stubs/UniqueFungible.soldiffbeforeafterboth--- a/pallets/fungible/src/stubs/UniqueFungible.sol
+++ b/pallets/fungible/src/stubs/UniqueFungible.sol
@@ -274,11 +274,9 @@
/// Set the collection access method.
/// @param mode Access mode
- /// 0 for Normal
- /// 1 for AllowList
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
- function setCollectionAccess(uint8 mode) public {
+ function setCollectionAccess(AccessMode mode) public {
require(false, stub_error);
mode;
dummy = 0;
@@ -443,6 +441,14 @@
uint256 sub;
}
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -416,11 +416,9 @@
/// Set the collection access method.
/// @param mode Access mode
- /// 0 for Normal
- /// 1 for AllowList
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
- function setCollectionAccess(uint8 mode) public {
+ function setCollectionAccess(AccessMode mode) public {
require(false, stub_error);
mode;
dummy = 0;
@@ -585,6 +583,14 @@
uint256 sub;
}
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -416,11 +416,9 @@
/// Set the collection access method.
/// @param mode Access mode
- /// 0 for Normal
- /// 1 for AllowList
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
- function setCollectionAccess(uint8 mode) public {
+ function setCollectionAccess(AccessMode mode) public {
require(false, stub_error);
mode;
dummy = 0;
@@ -585,6 +583,14 @@
uint256 sub;
}
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
tests/src/eth/abi/fungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/fungible.json
+++ b/tests/src/eth/abi/fungible.json
@@ -488,7 +488,9 @@
"type": "function"
},
{
- "inputs": [{ "internalType": "uint8", "name": "mode", "type": "uint8" }],
+ "inputs": [
+ { "internalType": "enum AccessMode", "name": "mode", "type": "uint8" }
+ ],
"name": "setCollectionAccess",
"outputs": [],
"stateMutability": "nonpayable",
tests/src/eth/abi/nonFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/nonFungible.json
+++ b/tests/src/eth/abi/nonFungible.json
@@ -650,7 +650,9 @@
"type": "function"
},
{
- "inputs": [{ "internalType": "uint8", "name": "mode", "type": "uint8" }],
+ "inputs": [
+ { "internalType": "enum AccessMode", "name": "mode", "type": "uint8" }
+ ],
"name": "setCollectionAccess",
"outputs": [],
"stateMutability": "nonpayable",
tests/src/eth/abi/reFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungible.json
+++ b/tests/src/eth/abi/reFungible.json
@@ -632,7 +632,9 @@
"type": "function"
},
{
- "inputs": [{ "internalType": "uint8", "name": "mode", "type": "uint8" }],
+ "inputs": [
+ { "internalType": "enum AccessMode", "name": "mode", "type": "uint8" }
+ ],
"name": "setCollectionAccess",
"outputs": [],
"stateMutability": "nonpayable",
tests/src/eth/api/UniqueFungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueFungible.sol
+++ b/tests/src/eth/api/UniqueFungible.sol
@@ -175,11 +175,9 @@
/// Set the collection access method.
/// @param mode Access mode
- /// 0 for Normal
- /// 1 for AllowList
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
- function setCollectionAccess(uint8 mode) external;
+ function setCollectionAccess(AccessMode mode) external;
/// Checks that user allowed to operate with collection.
///
@@ -285,6 +283,14 @@
uint256 sub;
}
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -275,11 +275,9 @@
/// Set the collection access method.
/// @param mode Access mode
- /// 0 for Normal
- /// 1 for AllowList
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
- function setCollectionAccess(uint8 mode) external;
+ function setCollectionAccess(AccessMode mode) external;
/// Checks that user allowed to operate with collection.
///
@@ -385,6 +383,14 @@
uint256 sub;
}
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -275,11 +275,9 @@
/// Set the collection access method.
/// @param mode Access mode
- /// 0 for Normal
- /// 1 for AllowList
/// @dev EVM selector for this function is: 0x41835d4c,
/// or in textual repr: setCollectionAccess(uint8)
- function setCollectionAccess(uint8 mode) external;
+ function setCollectionAccess(AccessMode mode) external;
/// Checks that user allowed to operate with collection.
///
@@ -385,6 +383,14 @@
uint256 sub;
}
+/// Ethereum representation of `AccessMode` (see [`up_data_structs::AccessMode`]).
+enum AccessMode {
+ /// Access grant for owner and admins. Used as default.
+ Normal,
+ /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.
+ AllowList
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;