difftreelog
added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
in: master
15 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 types::Property as PropertyStruct,25 execution::{Result, Error},26 weight,27};28use pallet_evm_coder_substrate::dispatch_to_evm;29use sp_std::{vec, vec::Vec};30use up_data_structs::{31 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,32 SponsoringRateLimit, SponsorshipState,33};34use alloc::format;3536use crate::{37 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,38 eth::{39 EthCrossAccount, convert_cross_account_to_uint256, CollectionPermissions as EvmPermissions,40 },41 weights::WeightInfo,42};4344/// Events for ethereum collection helper.45#[derive(ToLog)]46pub enum CollectionHelpersEvents {47 /// The collection has been created.48 CollectionCreated {49 /// Collection owner.50 #[indexed]51 owner: address,5253 /// Collection ID.54 #[indexed]55 collection_id: address,56 },57 /// The collection has been destroyed.58 CollectionDestroyed {59 /// Collection ID.60 #[indexed]61 collection_id: address,62 },63 /// The collection has been changed.64 CollectionChanged {65 /// Collection ID.66 #[indexed]67 collection_id: address,68 },6970 /// The token has been changed.71 TokenChanged {72 /// Collection ID.73 #[indexed]74 collection_id: address,75 /// Token ID.76 token_id: uint256,77 },78}7980/// Does not always represent a full collection, for RFT it is either81/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).82pub trait CommonEvmHandler {83 /// Raw compiled binary code of the contract stub84 const CODE: &'static [u8];8586 /// Call precompiled handle.87 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;88}8990/// @title A contract that allows you to work with collections.91#[solidity_interface(name = Collection)]92impl<T: Config> CollectionHandle<T>93where94 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,95{96 /// Set collection property.97 ///98 /// @param key Property key.99 /// @param value Propery value.100 #[solidity(hide)]101 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]102 fn set_collection_property(103 &mut self,104 caller: caller,105 key: string,106 value: bytes,107 ) -> Result<void> {108 let caller = T::CrossAccountId::from_eth(caller);109 let key = <Vec<u8>>::from(key)110 .try_into()111 .map_err(|_| "key too large")?;112 let value = value.0.try_into().map_err(|_| "value too large")?;113114 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })115 .map_err(dispatch_to_evm::<T>)116 }117118 /// Set collection properties.119 ///120 /// @param properties Vector of properties key/value pair.121 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]122 fn set_collection_properties(123 &mut self,124 caller: caller,125 properties: Vec<PropertyStruct>,126 ) -> Result<void> {127 let caller = T::CrossAccountId::from_eth(caller);128129 let properties = properties130 .into_iter()131 .map(|PropertyStruct { key, value }| {132 let key = <Vec<u8>>::from(key)133 .try_into()134 .map_err(|_| "key too large")?;135136 let value = value.0.try_into().map_err(|_| "value too large")?;137138 Ok(Property { key, value })139 })140 .collect::<Result<Vec<_>>>()?;141142 <Pallet<T>>::set_collection_properties(self, &caller, properties)143 .map_err(dispatch_to_evm::<T>)144 }145146 /// Delete collection property.147 ///148 /// @param key Property key.149 #[solidity(hide)]150 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]151 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {152 let caller = T::CrossAccountId::from_eth(caller);153 let key = <Vec<u8>>::from(key)154 .try_into()155 .map_err(|_| "key too large")?;156157 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)158 }159160 /// Delete collection properties.161 ///162 /// @param keys Properties keys.163 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]164 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {165 let caller = T::CrossAccountId::from_eth(caller);166 let keys = keys167 .into_iter()168 .map(|key| {169 <Vec<u8>>::from(key)170 .try_into()171 .map_err(|_| Error::Revert("key too large".into()))172 })173 .collect::<Result<Vec<_>>>()?;174175 <Pallet<T>>::delete_collection_properties(self, &caller, keys).map_err(dispatch_to_evm::<T>)176 }177178 /// Get collection property.179 ///180 /// @dev Throws error if key not found.181 ///182 /// @param key Property key.183 /// @return bytes The property corresponding to the key.184 fn collection_property(&self, key: string) -> Result<bytes> {185 let key = <Vec<u8>>::from(key)186 .try_into()187 .map_err(|_| "key too large")?;188189 let props = CollectionProperties::<T>::get(self.id);190 let prop = props.get(&key).ok_or("key not found")?;191192 Ok(bytes(prop.to_vec()))193 }194195 /// Get collection properties.196 ///197 /// @param keys Properties keys. Empty keys for all propertyes.198 /// @return Vector of properties key/value pairs.199 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {200 let keys = keys201 .into_iter()202 .map(|key| {203 <Vec<u8>>::from(key)204 .try_into()205 .map_err(|_| Error::Revert("key too large".into()))206 })207 .collect::<Result<Vec<_>>>()?;208209 let properties = Pallet::<T>::filter_collection_properties(210 self.id,211 if keys.is_empty() { None } else { Some(keys) },212 )213 .map_err(dispatch_to_evm::<T>)?;214215 let properties = properties216 .into_iter()217 .map(|p| {218 let key =219 string::from_utf8(p.key.into()).map_err(|e| Error::Revert(format!("{}", e)))?;220 let value = bytes(p.value.to_vec());221 Ok(PropertyStruct { key, value })222 })223 .collect::<Result<Vec<_>>>()?;224 Ok(properties)225 }226227 /// Set the sponsor of the collection.228 ///229 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.230 ///231 /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.232 #[solidity(hide)]233 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {234 self.consume_store_reads_and_writes(1, 1)?;235236 let caller = T::CrossAccountId::from_eth(caller);237238 let sponsor = T::CrossAccountId::from_eth(sponsor);239 self.set_sponsor(&caller, sponsor.as_sub().clone())240 .map_err(dispatch_to_evm::<T>)241 }242243 /// Set the sponsor of the collection.244 ///245 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.246 ///247 /// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.248 fn set_collection_sponsor_cross(249 &mut self,250 caller: caller,251 sponsor: EthCrossAccount,252 ) -> Result<void> {253 self.consume_store_reads_and_writes(1, 1)?;254255 let caller = T::CrossAccountId::from_eth(caller);256257 let sponsor = sponsor.into_sub_cross_account::<T>()?;258 self.set_sponsor(&caller, sponsor.as_sub().clone())259 .map_err(dispatch_to_evm::<T>)260 }261262 /// Whether there is a pending sponsor.263 fn has_collection_pending_sponsor(&self) -> Result<bool> {264 Ok(matches!(265 self.collection.sponsorship,266 SponsorshipState::Unconfirmed(_)267 ))268 }269270 /// Collection sponsorship confirmation.271 ///272 /// @dev After setting the sponsor for the collection, it must be confirmed with this function.273 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {274 self.consume_store_writes(1)?;275276 let caller = T::CrossAccountId::from_eth(caller);277 self.confirm_sponsorship(caller.as_sub())278 .map_err(dispatch_to_evm::<T>)279 }280281 /// Remove collection sponsor.282 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {283 self.consume_store_reads_and_writes(1, 1)?;284 let caller = T::CrossAccountId::from_eth(caller);285 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)286 }287288 /// Get current sponsor.289 ///290 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.291 fn collection_sponsor(&self) -> Result<(address, uint256)> {292 let sponsor = match self.collection.sponsorship.sponsor() {293 Some(sponsor) => sponsor,294 None => return Ok(Default::default()),295 };296 let sponsor = T::CrossAccountId::from_sub(sponsor.clone());297 let result: (address, uint256) = if sponsor.is_canonical_substrate() {298 let sponsor = convert_cross_account_to_uint256::<T>(&sponsor);299 (Default::default(), sponsor)300 } else {301 let sponsor = *sponsor.as_eth();302 (sponsor, Default::default())303 };304 Ok(result)305 }306307 /// Set limits for the collection.308 /// @dev Throws error if limit not found.309 /// @param limit Name of the limit. Valid names:310 /// "accountTokenOwnershipLimit",311 /// "sponsoredDataSize",312 /// "sponsoredDataRateLimit",313 /// "tokenLimit",314 /// "sponsorTransferTimeout",315 /// "sponsorApproveTimeout"316 /// "ownerCanTransfer",317 /// "ownerCanDestroy",318 /// "transfersEnabled"319 /// @param value Value of the limit.320 #[solidity(rename_selector = "setCollectionLimit")]321 fn set_int_limit(&mut self, caller: caller, limit: string, value: uint256) -> Result<void> {322 self.consume_store_reads_and_writes(1, 1)?;323324 let value = value325 .try_into()326 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;327328 let convert_value_to_bool = || match value {329 0 => Ok(false),330 1 => Ok(true),331 _ => {332 return Err(Error::Revert(format!(333 "can't convert value to boolean \"{}\"",334 value335 )))336 }337 };338339 let mut limits = self.limits.clone();340341 match limit.as_str() {342 "accountTokenOwnershipLimit" => {343 limits.account_token_ownership_limit = Some(value);344 }345 "sponsoredDataSize" => {346 limits.sponsored_data_size = Some(value);347 }348 "sponsoredDataRateLimit" => {349 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));350 }351 "tokenLimit" => {352 limits.token_limit = Some(value);353 }354 "sponsorTransferTimeout" => {355 limits.sponsor_transfer_timeout = Some(value);356 }357 "sponsorApproveTimeout" => {358 limits.sponsor_approve_timeout = Some(value);359 }360 "ownerCanTransfer" => {361 limits.owner_can_transfer = Some(convert_value_to_bool()?);362 }363 "ownerCanDestroy" => {364 limits.owner_can_destroy = Some(convert_value_to_bool()?);365 }366 "transfersEnabled" => {367 limits.transfers_enabled = Some(convert_value_to_bool()?);368 }369 _ => return Err(Error::Revert(format!("unknown limit \"{}\"", limit))),370 }371372 let caller = T::CrossAccountId::from_eth(caller);373 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)374 }375376 /// Get contract address.377 fn contract_address(&self) -> Result<address> {378 Ok(crate::eth::collection_id_to_address(self.id))379 }380381 /// Add collection admin.382 /// @param newAdmin Cross account administrator address.383 fn add_collection_admin_cross(384 &mut self,385 caller: caller,386 new_admin: EthCrossAccount,387 ) -> Result<void> {388 self.consume_store_reads_and_writes(2, 2)?;389390 let caller = T::CrossAccountId::from_eth(caller);391 let new_admin = new_admin.into_sub_cross_account::<T>()?;392 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;393 Ok(())394 }395396 /// Remove collection admin.397 /// @param admin Cross account administrator address.398 fn remove_collection_admin_cross(399 &mut self,400 caller: caller,401 admin: EthCrossAccount,402 ) -> Result<void> {403 self.consume_store_reads_and_writes(2, 2)?;404405 let caller = T::CrossAccountId::from_eth(caller);406 let admin = admin.into_sub_cross_account::<T>()?;407 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;408 Ok(())409 }410411 /// Add collection admin.412 /// @param newAdmin Address of the added administrator.413 #[solidity(hide)]414 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {415 self.consume_store_reads_and_writes(2, 2)?;416417 let caller = T::CrossAccountId::from_eth(caller);418 let new_admin = T::CrossAccountId::from_eth(new_admin);419 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;420 Ok(())421 }422423 /// Remove collection admin.424 ///425 /// @param admin Address of the removed administrator.426 #[solidity(hide)]427 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {428 self.consume_store_reads_and_writes(2, 2)?;429430 let caller = T::CrossAccountId::from_eth(caller);431 let admin = T::CrossAccountId::from_eth(admin);432 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;433 Ok(())434 }435436 /// Toggle accessibility of collection nesting.437 ///438 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'439 #[solidity(rename_selector = "setCollectionNesting")]440 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {441 self.consume_store_reads_and_writes(1, 1)?;442443 let caller = T::CrossAccountId::from_eth(caller);444445 let mut permissions = self.collection.permissions.clone();446 let mut nesting = permissions.nesting().clone();447 nesting.token_owner = enable;448 nesting.restricted = None;449 permissions.nesting = Some(nesting);450451 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)452 }453454 /// Toggle accessibility of collection nesting.455 ///456 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'457 /// @param collections Addresses of collections that will be available for nesting.458 #[solidity(rename_selector = "setCollectionNesting")]459 fn set_nesting(460 &mut self,461 caller: caller,462 enable: bool,463 collections: Vec<address>,464 ) -> Result<void> {465 self.consume_store_reads_and_writes(1, 1)?;466467 if collections.is_empty() {468 return Err("no addresses provided".into());469 }470 let caller = T::CrossAccountId::from_eth(caller);471472 let mut permissions = self.collection.permissions.clone();473 match enable {474 false => {475 let mut nesting = permissions.nesting().clone();476 nesting.token_owner = false;477 nesting.restricted = None;478 permissions.nesting = Some(nesting);479 }480 true => {481 let mut bv = OwnerRestrictedSet::new();482 for i in collections {483 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {484 Error::Revert("Can't convert address into collection id".into())485 })?)486 .map_err(|_| "too many collections")?;487 }488 let mut nesting = permissions.nesting().clone();489 nesting.token_owner = true;490 nesting.restricted = Some(bv);491 permissions.nesting = Some(nesting);492 }493 };494495 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)496 }497498 /// Returns nesting for a collection499 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]500 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {501 let nesting = self.collection.permissions.nesting();502503 Ok((504 nesting.token_owner,505 nesting506 .restricted507 .clone()508 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())509 .unwrap_or_default(),510 ))511 }512513 /// Returns permissions for a collection514 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {515 let nesting = self.collection.permissions.nesting();516 Ok(vec![517 (EvmPermissions::CollectionAdmin, nesting.collection_admin),518 (EvmPermissions::TokenOwner, nesting.token_owner),519 ])520 }521 /// Set the collection access method.522 /// @param mode Access mode523 /// 0 for Normal524 /// 1 for AllowList525 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {526 self.consume_store_reads_and_writes(1, 1)?;527528 let caller = T::CrossAccountId::from_eth(caller);529 let permissions = CollectionPermissions {530 access: Some(match mode {531 0 => AccessMode::Normal,532 1 => AccessMode::AllowList,533 _ => return Err("not supported access mode".into()),534 }),535 ..Default::default()536 };537 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)538 }539540 /// Checks that user allowed to operate with collection.541 ///542 /// @param user User address to check.543 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {544 let user = user.into_sub_cross_account::<T>()?;545 Ok(Pallet::<T>::allowed(self.id, user))546 }547548 /// Add the user to the allowed list.549 ///550 /// @param user Address of a trusted user.551 #[solidity(hide)]552 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {553 self.consume_store_writes(1)?;554555 let caller = T::CrossAccountId::from_eth(caller);556 let user = T::CrossAccountId::from_eth(user);557 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;558 Ok(())559 }560561 /// Add user to allowed list.562 ///563 /// @param user User cross account address.564 fn add_to_collection_allow_list_cross(565 &mut self,566 caller: caller,567 user: EthCrossAccount,568 ) -> Result<void> {569 self.consume_store_writes(1)?;570571 let caller = T::CrossAccountId::from_eth(caller);572 let user = user.into_sub_cross_account::<T>()?;573 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;574 Ok(())575 }576577 /// Remove the user from the allowed list.578 ///579 /// @param user Address of a removed user.580 #[solidity(hide)]581 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {582 self.consume_store_writes(1)?;583584 let caller = T::CrossAccountId::from_eth(caller);585 let user = T::CrossAccountId::from_eth(user);586 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;587 Ok(())588 }589590 /// Remove user from allowed list.591 ///592 /// @param user User cross account address.593 fn remove_from_collection_allow_list_cross(594 &mut self,595 caller: caller,596 user: EthCrossAccount,597 ) -> Result<void> {598 self.consume_store_writes(1)?;599600 let caller = T::CrossAccountId::from_eth(caller);601 let user = user.into_sub_cross_account::<T>()?;602 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;603 Ok(())604 }605606 /// Switch permission for minting.607 ///608 /// @param mode Enable if "true".609 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {610 self.consume_store_reads_and_writes(1, 1)?;611612 let caller = T::CrossAccountId::from_eth(caller);613 let permissions = CollectionPermissions {614 mint_mode: Some(mode),615 ..Default::default()616 };617 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)618 }619620 /// Check that account is the owner or admin of the collection621 ///622 /// @param user account to verify623 /// @return "true" if account is the owner or admin624 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]625 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {626 let user = T::CrossAccountId::from_eth(user);627 Ok(self.is_owner_or_admin(&user))628 }629630 /// Check that account is the owner or admin of the collection631 ///632 /// @param user User cross account to verify633 /// @return "true" if account is the owner or admin634 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {635 let user = user.into_sub_cross_account::<T>()?;636 Ok(self.is_owner_or_admin(&user))637 }638639 /// Returns collection type640 ///641 /// @return `Fungible` or `NFT` or `ReFungible`642 fn unique_collection_type(&self) -> Result<string> {643 let mode = match self.collection.mode {644 CollectionMode::Fungible(_) => "Fungible",645 CollectionMode::NFT => "NFT",646 CollectionMode::ReFungible => "ReFungible",647 };648 Ok(mode.into())649 }650651 /// Get collection owner.652 ///653 /// @return Tuble with sponsor address and his substrate mirror.654 /// If address is canonical then substrate mirror is zero and vice versa.655 fn collection_owner(&self) -> Result<EthCrossAccount> {656 Ok(EthCrossAccount::from_sub_cross_account::<T>(657 &T::CrossAccountId::from_sub(self.owner.clone()),658 ))659 }660661 /// Changes collection owner to another account662 ///663 /// @dev Owner can be changed only by current owner664 /// @param newOwner new owner account665 #[solidity(hide, rename_selector = "changeCollectionOwner")]666 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {667 self.consume_store_writes(1)?;668669 let caller = T::CrossAccountId::from_eth(caller);670 let new_owner = T::CrossAccountId::from_eth(new_owner);671 self.change_owner(caller, new_owner)672 .map_err(dispatch_to_evm::<T>)673 }674675 /// Get collection administrators676 ///677 /// @return Vector of tuples with admins address and his substrate mirror.678 /// If address is canonical then substrate mirror is zero and vice versa.679 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {680 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))681 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))682 .collect();683 Ok(result)684 }685686 /// Changes collection owner to another account687 ///688 /// @dev Owner can be changed only by current owner689 /// @param newOwner new owner cross account690 fn change_collection_owner_cross(691 &mut self,692 caller: caller,693 new_owner: EthCrossAccount,694 ) -> Result<void> {695 self.consume_store_writes(1)?;696697 let caller = T::CrossAccountId::from_eth(caller);698 let new_owner = new_owner.into_sub_cross_account::<T>()?;699 self.change_owner(caller, new_owner)700 .map_err(dispatch_to_evm::<T>)701 }702}703704/// ### Note705/// Do not forget to add: `self.consume_store_reads(1)?;`706fn check_is_owner_or_admin<T: Config>(707 caller: caller,708 collection: &CollectionHandle<T>,709) -> Result<T::CrossAccountId> {710 let caller = T::CrossAccountId::from_eth(caller);711 collection712 .check_is_owner_or_admin(&caller)713 .map_err(dispatch_to_evm::<T>)?;714 Ok(caller)715}716717/// ### Note718/// Do not forget to add: `self.consume_store_writes(1)?;`719fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {720 collection721 .check_is_internal()722 .map_err(dispatch_to_evm::<T>)?;723 collection.save().map_err(dispatch_to_evm::<T>)?;724 Ok(())725}726727/// Contains static property keys and values.728pub mod static_property {729 use evm_coder::{730 execution::{Result, Error},731 };732 use alloc::format;733734 const EXPECT_CONVERT_ERROR: &str = "length < limit";735736 /// Keys.737 pub mod key {738 use super::*;739740 /// Key "baseURI".741 pub fn base_uri() -> up_data_structs::PropertyKey {742 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)743 }744745 /// Key "url".746 pub fn url() -> up_data_structs::PropertyKey {747 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)748 }749750 /// Key "suffix".751 pub fn suffix() -> up_data_structs::PropertyKey {752 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)753 }754755 /// Key "parentNft".756 pub fn parent_nft() -> up_data_structs::PropertyKey {757 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)758 }759 }760761 /// Convert `byte` to [`PropertyKey`].762 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {763 bytes.to_vec().try_into().map_err(|_| {764 Error::Revert(format!(765 "Property key is too long. Max length is {}.",766 up_data_structs::PropertyKey::bound()767 ))768 })769 }770771 /// Convert `bytes` to [`PropertyValue`].772 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {773 bytes.to_vec().try_into().map_err(|_| {774 Error::Revert(format!(775 "Property key is too long. Max length is {}.",776 up_data_structs::PropertyKey::bound()777 ))778 })779 }780}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 types::Property as PropertyStruct,25 execution::{Result, Error},26 weight,27};28use pallet_evm_coder_substrate::dispatch_to_evm;29use sp_std::{vec, vec::Vec};30use up_data_structs::{31 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,32 SponsoringRateLimit, SponsorshipState,33};34use alloc::format;3536use crate::{37 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,38 eth::{39 EthCrossAccount, convert_cross_account_to_uint256, CollectionPermissions as EvmPermissions,40 CollectionLimits as EvmCollectionLimits,41 },42 weights::WeightInfo,43};4445/// Events for ethereum collection helper.46#[derive(ToLog)]47pub enum CollectionHelpersEvents {48 /// The collection has been created.49 CollectionCreated {50 /// Collection owner.51 #[indexed]52 owner: address,5354 /// Collection ID.55 #[indexed]56 collection_id: address,57 },58 /// The collection has been destroyed.59 CollectionDestroyed {60 /// Collection ID.61 #[indexed]62 collection_id: address,63 },64 /// The collection has been changed.65 CollectionChanged {66 /// Collection ID.67 #[indexed]68 collection_id: address,69 },7071 /// The token has been changed.72 TokenChanged {73 /// Collection ID.74 #[indexed]75 collection_id: address,76 /// Token ID.77 token_id: uint256,78 },79}8081/// Does not always represent a full collection, for RFT it is either82/// collection (Implementing ERC721), or specific collection token (Implementing ERC20).83pub trait CommonEvmHandler {84 /// Raw compiled binary code of the contract stub85 const CODE: &'static [u8];8687 /// Call precompiled handle.88 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;89}9091/// @title A contract that allows you to work with collections.92#[solidity_interface(name = Collection)]93impl<T: Config> CollectionHandle<T>94where95 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,96{97 /// Set collection property.98 ///99 /// @param key Property key.100 /// @param value Propery value.101 #[solidity(hide)]102 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]103 fn set_collection_property(104 &mut self,105 caller: caller,106 key: string,107 value: bytes,108 ) -> Result<void> {109 let caller = T::CrossAccountId::from_eth(caller);110 let key = <Vec<u8>>::from(key)111 .try_into()112 .map_err(|_| "key too large")?;113 let value = value.0.try_into().map_err(|_| "value too large")?;114115 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })116 .map_err(dispatch_to_evm::<T>)117 }118119 /// Set collection properties.120 ///121 /// @param properties Vector of properties key/value pair.122 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]123 fn set_collection_properties(124 &mut self,125 caller: caller,126 properties: Vec<PropertyStruct>,127 ) -> Result<void> {128 let caller = T::CrossAccountId::from_eth(caller);129130 let properties = properties131 .into_iter()132 .map(|PropertyStruct { key, value }| {133 let key = <Vec<u8>>::from(key)134 .try_into()135 .map_err(|_| "key too large")?;136137 let value = value.0.try_into().map_err(|_| "value too large")?;138139 Ok(Property { key, value })140 })141 .collect::<Result<Vec<_>>>()?;142143 <Pallet<T>>::set_collection_properties(self, &caller, properties)144 .map_err(dispatch_to_evm::<T>)145 }146147 /// Delete collection property.148 ///149 /// @param key Property key.150 #[solidity(hide)]151 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]152 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {153 let caller = T::CrossAccountId::from_eth(caller);154 let key = <Vec<u8>>::from(key)155 .try_into()156 .map_err(|_| "key too large")?;157158 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)159 }160161 /// Delete collection properties.162 ///163 /// @param keys Properties keys.164 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]165 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {166 let caller = T::CrossAccountId::from_eth(caller);167 let keys = keys168 .into_iter()169 .map(|key| {170 <Vec<u8>>::from(key)171 .try_into()172 .map_err(|_| Error::Revert("key too large".into()))173 })174 .collect::<Result<Vec<_>>>()?;175176 <Pallet<T>>::delete_collection_properties(self, &caller, keys).map_err(dispatch_to_evm::<T>)177 }178179 /// Get collection property.180 ///181 /// @dev Throws error if key not found.182 ///183 /// @param key Property key.184 /// @return bytes The property corresponding to the key.185 fn collection_property(&self, key: string) -> Result<bytes> {186 let key = <Vec<u8>>::from(key)187 .try_into()188 .map_err(|_| "key too large")?;189190 let props = CollectionProperties::<T>::get(self.id);191 let prop = props.get(&key).ok_or("key not found")?;192193 Ok(bytes(prop.to_vec()))194 }195196 /// Get collection properties.197 ///198 /// @param keys Properties keys. Empty keys for all propertyes.199 /// @return Vector of properties key/value pairs.200 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {201 let keys = keys202 .into_iter()203 .map(|key| {204 <Vec<u8>>::from(key)205 .try_into()206 .map_err(|_| Error::Revert("key too large".into()))207 })208 .collect::<Result<Vec<_>>>()?;209210 let properties = Pallet::<T>::filter_collection_properties(211 self.id,212 if keys.is_empty() { None } else { Some(keys) },213 )214 .map_err(dispatch_to_evm::<T>)?;215216 let properties = properties217 .into_iter()218 .map(|p| {219 let key =220 string::from_utf8(p.key.into()).map_err(|e| Error::Revert(format!("{}", e)))?;221 let value = bytes(p.value.to_vec());222 Ok(PropertyStruct { key, value })223 })224 .collect::<Result<Vec<_>>>()?;225 Ok(properties)226 }227228 /// Set the sponsor of the collection.229 ///230 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.231 ///232 /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.233 #[solidity(hide)]234 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {235 self.consume_store_reads_and_writes(1, 1)?;236237 let caller = T::CrossAccountId::from_eth(caller);238239 let sponsor = T::CrossAccountId::from_eth(sponsor);240 self.set_sponsor(&caller, sponsor.as_sub().clone())241 .map_err(dispatch_to_evm::<T>)242 }243244 /// Set the sponsor of the collection.245 ///246 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.247 ///248 /// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.249 fn set_collection_sponsor_cross(250 &mut self,251 caller: caller,252 sponsor: EthCrossAccount,253 ) -> Result<void> {254 self.consume_store_reads_and_writes(1, 1)?;255256 let caller = T::CrossAccountId::from_eth(caller);257258 let sponsor = sponsor.into_sub_cross_account::<T>()?;259 self.set_sponsor(&caller, sponsor.as_sub().clone())260 .map_err(dispatch_to_evm::<T>)261 }262263 /// Whether there is a pending sponsor.264 fn has_collection_pending_sponsor(&self) -> Result<bool> {265 Ok(matches!(266 self.collection.sponsorship,267 SponsorshipState::Unconfirmed(_)268 ))269 }270271 /// Collection sponsorship confirmation.272 ///273 /// @dev After setting the sponsor for the collection, it must be confirmed with this function.274 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {275 self.consume_store_writes(1)?;276277 let caller = T::CrossAccountId::from_eth(caller);278 self.confirm_sponsorship(caller.as_sub())279 .map_err(dispatch_to_evm::<T>)280 }281282 /// Remove collection sponsor.283 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {284 self.consume_store_reads_and_writes(1, 1)?;285 let caller = T::CrossAccountId::from_eth(caller);286 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)287 }288289 /// Get current sponsor.290 ///291 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.292 fn collection_sponsor(&self) -> Result<(address, uint256)> {293 let sponsor = match self.collection.sponsorship.sponsor() {294 Some(sponsor) => sponsor,295 None => return Ok(Default::default()),296 };297 let sponsor = T::CrossAccountId::from_sub(sponsor.clone());298 let result: (address, uint256) = if sponsor.is_canonical_substrate() {299 let sponsor = convert_cross_account_to_uint256::<T>(&sponsor);300 (Default::default(), sponsor)301 } else {302 let sponsor = *sponsor.as_eth();303 (sponsor, Default::default())304 };305 Ok(result)306 }307308 /// Get current collection limits.309 ///310 /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:311 /// "accountTokenOwnershipLimit",312 /// "sponsoredDataSize",313 /// "sponsoredDataRateLimit",314 /// "tokenLimit",315 /// "sponsorTransferTimeout",316 /// "sponsorApproveTimeout"317 /// "ownerCanTransfer",318 /// "ownerCanDestroy",319 /// "transfersEnabled"320 /// Return `false` if a limit not set.321 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {322 let convert_value_limit = |limit: EvmCollectionLimits,323 value: Option<u32>|324 -> (EvmCollectionLimits, bool, uint256) {325 value326 .map(|v| (limit, true, v.into()))327 .unwrap_or((limit, false, Default::default()))328 };329330 let convert_bool_limit = |limit: EvmCollectionLimits,331 value: Option<bool>|332 -> (EvmCollectionLimits, bool, uint256) {333 value334 .map(|v| {335 (336 limit,337 true,338 if v {339 uint256::from(1)340 } else {341 Default::default()342 },343 )344 })345 .unwrap_or((limit, false, Default::default()))346 };347348 let limits = &self.collection.limits;349350 Ok(vec![351 convert_value_limit(352 EvmCollectionLimits::AccountTokenOwnership,353 limits.account_token_ownership_limit,354 ),355 convert_value_limit(356 EvmCollectionLimits::SponsoredDataSize,357 limits.sponsored_data_size,358 ),359 limits360 .sponsored_data_rate_limit361 .map(|limit| {362 (363 EvmCollectionLimits::SponsoredDataRateLimit,364 match limit {365 SponsoringRateLimit::Blocks(_) => true,366 _ => false,367 },368 match limit {369 SponsoringRateLimit::Blocks(blocks) => blocks.into(),370 _ => Default::default(),371 },372 )373 })374 .unwrap_or((375 EvmCollectionLimits::SponsoredDataRateLimit,376 false,377 Default::default(),378 )),379 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),380 convert_value_limit(381 EvmCollectionLimits::SponsorTransferTimeout,382 limits.sponsor_transfer_timeout,383 ),384 convert_value_limit(385 EvmCollectionLimits::SponsorApproveTimeout,386 limits.sponsor_approve_timeout,387 ),388 convert_bool_limit(389 EvmCollectionLimits::OwnerCanTransfer,390 limits.owner_can_transfer,391 ),392 convert_bool_limit(393 EvmCollectionLimits::OwnerCanDestroy,394 limits.owner_can_destroy,395 ),396 convert_bool_limit(397 EvmCollectionLimits::TransferEnabled,398 limits.transfers_enabled,399 ),400 ])401 }402403 /// Set limits for the collection.404 /// @dev Throws error if limit not found.405 /// @param limit Name of the limit. Valid names:406 /// "accountTokenOwnershipLimit",407 /// "sponsoredDataSize",408 /// "sponsoredDataRateLimit",409 /// "tokenLimit",410 /// "sponsorTransferTimeout",411 /// "sponsorApproveTimeout"412 /// "ownerCanTransfer",413 /// "ownerCanDestroy",414 /// "transfersEnabled"415 /// @param value Value of the limit.416 #[solidity(rename_selector = "setCollectionLimit")]417 fn set_collection_limit(418 &mut self,419 caller: caller,420 limit: EvmCollectionLimits,421 status: bool,422 value: uint256,423 ) -> Result<void> {424 self.consume_store_reads_and_writes(1, 1)?;425426 if !status {427 return Err(Error::Revert("user can't disable limits".into()));428 }429430 let value = value431 .try_into()432 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;433434 let convert_value_to_bool = || match value {435 0 => Ok(false),436 1 => Ok(true),437 _ => {438 return Err(Error::Revert(format!(439 "can't convert value to boolean \"{}\"",440 value441 )))442 }443 };444445 let mut limits = self.limits.clone();446447 match limit {448 EvmCollectionLimits::AccountTokenOwnership => {449 limits.account_token_ownership_limit = Some(value);450 }451 EvmCollectionLimits::SponsoredDataSize => {452 limits.sponsored_data_size = Some(value);453 }454 EvmCollectionLimits::SponsoredDataRateLimit => {455 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));456 }457 EvmCollectionLimits::TokenLimit => {458 limits.token_limit = Some(value);459 }460 EvmCollectionLimits::SponsorTransferTimeout => {461 limits.sponsor_transfer_timeout = Some(value);462 }463 EvmCollectionLimits::SponsorApproveTimeout => {464 limits.sponsor_approve_timeout = Some(value);465 }466 EvmCollectionLimits::OwnerCanTransfer => {467 limits.owner_can_transfer = Some(convert_value_to_bool()?);468 }469 EvmCollectionLimits::OwnerCanDestroy => {470 limits.owner_can_destroy = Some(convert_value_to_bool()?);471 }472 EvmCollectionLimits::TransferEnabled => {473 limits.transfers_enabled = Some(convert_value_to_bool()?);474 }475 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),476 }477478 let caller = T::CrossAccountId::from_eth(caller);479 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)480 }481482 /// Get contract address.483 fn contract_address(&self) -> Result<address> {484 Ok(crate::eth::collection_id_to_address(self.id))485 }486487 /// Add collection admin.488 /// @param newAdmin Cross account administrator address.489 fn add_collection_admin_cross(490 &mut self,491 caller: caller,492 new_admin: EthCrossAccount,493 ) -> Result<void> {494 self.consume_store_reads_and_writes(2, 2)?;495496 let caller = T::CrossAccountId::from_eth(caller);497 let new_admin = new_admin.into_sub_cross_account::<T>()?;498 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;499 Ok(())500 }501502 /// Remove collection admin.503 /// @param admin Cross account administrator address.504 fn remove_collection_admin_cross(505 &mut self,506 caller: caller,507 admin: EthCrossAccount,508 ) -> Result<void> {509 self.consume_store_reads_and_writes(2, 2)?;510511 let caller = T::CrossAccountId::from_eth(caller);512 let admin = admin.into_sub_cross_account::<T>()?;513 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;514 Ok(())515 }516517 /// Add collection admin.518 /// @param newAdmin Address of the added administrator.519 #[solidity(hide)]520 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {521 self.consume_store_reads_and_writes(2, 2)?;522523 let caller = T::CrossAccountId::from_eth(caller);524 let new_admin = T::CrossAccountId::from_eth(new_admin);525 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;526 Ok(())527 }528529 /// Remove collection admin.530 ///531 /// @param admin Address of the removed administrator.532 #[solidity(hide)]533 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {534 self.consume_store_reads_and_writes(2, 2)?;535536 let caller = T::CrossAccountId::from_eth(caller);537 let admin = T::CrossAccountId::from_eth(admin);538 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;539 Ok(())540 }541542 /// Toggle accessibility of collection nesting.543 ///544 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'545 #[solidity(rename_selector = "setCollectionNesting")]546 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {547 self.consume_store_reads_and_writes(1, 1)?;548549 let caller = T::CrossAccountId::from_eth(caller);550551 let mut permissions = self.collection.permissions.clone();552 let mut nesting = permissions.nesting().clone();553 nesting.token_owner = enable;554 nesting.restricted = None;555 permissions.nesting = Some(nesting);556557 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)558 }559560 /// Toggle accessibility of collection nesting.561 ///562 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'563 /// @param collections Addresses of collections that will be available for nesting.564 #[solidity(rename_selector = "setCollectionNesting")]565 fn set_nesting(566 &mut self,567 caller: caller,568 enable: bool,569 collections: Vec<address>,570 ) -> Result<void> {571 self.consume_store_reads_and_writes(1, 1)?;572573 if collections.is_empty() {574 return Err("no addresses provided".into());575 }576 let caller = T::CrossAccountId::from_eth(caller);577578 let mut permissions = self.collection.permissions.clone();579 match enable {580 false => {581 let mut nesting = permissions.nesting().clone();582 nesting.token_owner = false;583 nesting.restricted = None;584 permissions.nesting = Some(nesting);585 }586 true => {587 let mut bv = OwnerRestrictedSet::new();588 for i in collections {589 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {590 Error::Revert("Can't convert address into collection id".into())591 })?)592 .map_err(|_| "too many collections")?;593 }594 let mut nesting = permissions.nesting().clone();595 nesting.token_owner = true;596 nesting.restricted = Some(bv);597 permissions.nesting = Some(nesting);598 }599 };600601 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)602 }603604 /// Returns nesting for a collection605 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]606 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {607 let nesting = self.collection.permissions.nesting();608609 Ok((610 nesting.token_owner,611 nesting612 .restricted613 .clone()614 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())615 .unwrap_or_default(),616 ))617 }618619 /// Returns permissions for a collection620 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {621 let nesting = self.collection.permissions.nesting();622 Ok(vec![623 (EvmPermissions::CollectionAdmin, nesting.collection_admin),624 (EvmPermissions::TokenOwner, nesting.token_owner),625 ])626 }627 /// Set the collection access method.628 /// @param mode Access mode629 /// 0 for Normal630 /// 1 for AllowList631 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {632 self.consume_store_reads_and_writes(1, 1)?;633634 let caller = T::CrossAccountId::from_eth(caller);635 let permissions = CollectionPermissions {636 access: Some(match mode {637 0 => AccessMode::Normal,638 1 => AccessMode::AllowList,639 _ => return Err("not supported access mode".into()),640 }),641 ..Default::default()642 };643 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)644 }645646 /// Checks that user allowed to operate with collection.647 ///648 /// @param user User address to check.649 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {650 let user = user.into_sub_cross_account::<T>()?;651 Ok(Pallet::<T>::allowed(self.id, user))652 }653654 /// Add the user to the allowed list.655 ///656 /// @param user Address of a trusted user.657 #[solidity(hide)]658 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {659 self.consume_store_writes(1)?;660661 let caller = T::CrossAccountId::from_eth(caller);662 let user = T::CrossAccountId::from_eth(user);663 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;664 Ok(())665 }666667 /// Add user to allowed list.668 ///669 /// @param user User cross account address.670 fn add_to_collection_allow_list_cross(671 &mut self,672 caller: caller,673 user: EthCrossAccount,674 ) -> Result<void> {675 self.consume_store_writes(1)?;676677 let caller = T::CrossAccountId::from_eth(caller);678 let user = user.into_sub_cross_account::<T>()?;679 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;680 Ok(())681 }682683 /// Remove the user from the allowed list.684 ///685 /// @param user Address of a removed user.686 #[solidity(hide)]687 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {688 self.consume_store_writes(1)?;689690 let caller = T::CrossAccountId::from_eth(caller);691 let user = T::CrossAccountId::from_eth(user);692 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;693 Ok(())694 }695696 /// Remove user from allowed list.697 ///698 /// @param user User cross account address.699 fn remove_from_collection_allow_list_cross(700 &mut self,701 caller: caller,702 user: EthCrossAccount,703 ) -> Result<void> {704 self.consume_store_writes(1)?;705706 let caller = T::CrossAccountId::from_eth(caller);707 let user = user.into_sub_cross_account::<T>()?;708 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;709 Ok(())710 }711712 /// Switch permission for minting.713 ///714 /// @param mode Enable if "true".715 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {716 self.consume_store_reads_and_writes(1, 1)?;717718 let caller = T::CrossAccountId::from_eth(caller);719 let permissions = CollectionPermissions {720 mint_mode: Some(mode),721 ..Default::default()722 };723 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)724 }725726 /// Check that account is the owner or admin of the collection727 ///728 /// @param user account to verify729 /// @return "true" if account is the owner or admin730 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]731 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {732 let user = T::CrossAccountId::from_eth(user);733 Ok(self.is_owner_or_admin(&user))734 }735736 /// Check that account is the owner or admin of the collection737 ///738 /// @param user User cross account to verify739 /// @return "true" if account is the owner or admin740 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {741 let user = user.into_sub_cross_account::<T>()?;742 Ok(self.is_owner_or_admin(&user))743 }744745 /// Returns collection type746 ///747 /// @return `Fungible` or `NFT` or `ReFungible`748 fn unique_collection_type(&self) -> Result<string> {749 let mode = match self.collection.mode {750 CollectionMode::Fungible(_) => "Fungible",751 CollectionMode::NFT => "NFT",752 CollectionMode::ReFungible => "ReFungible",753 };754 Ok(mode.into())755 }756757 /// Get collection owner.758 ///759 /// @return Tuble with sponsor address and his substrate mirror.760 /// If address is canonical then substrate mirror is zero and vice versa.761 fn collection_owner(&self) -> Result<EthCrossAccount> {762 Ok(EthCrossAccount::from_sub_cross_account::<T>(763 &T::CrossAccountId::from_sub(self.owner.clone()),764 ))765 }766767 /// Changes collection owner to another account768 ///769 /// @dev Owner can be changed only by current owner770 /// @param newOwner new owner account771 #[solidity(hide, rename_selector = "changeCollectionOwner")]772 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {773 self.consume_store_writes(1)?;774775 let caller = T::CrossAccountId::from_eth(caller);776 let new_owner = T::CrossAccountId::from_eth(new_owner);777 self.change_owner(caller, new_owner)778 .map_err(dispatch_to_evm::<T>)779 }780781 /// Get collection administrators782 ///783 /// @return Vector of tuples with admins address and his substrate mirror.784 /// If address is canonical then substrate mirror is zero and vice versa.785 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {786 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))787 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))788 .collect();789 Ok(result)790 }791792 /// Changes collection owner to another account793 ///794 /// @dev Owner can be changed only by current owner795 /// @param newOwner new owner cross account796 fn change_collection_owner_cross(797 &mut self,798 caller: caller,799 new_owner: EthCrossAccount,800 ) -> Result<void> {801 self.consume_store_writes(1)?;802803 let caller = T::CrossAccountId::from_eth(caller);804 let new_owner = new_owner.into_sub_cross_account::<T>()?;805 self.change_owner(caller, new_owner)806 .map_err(dispatch_to_evm::<T>)807 }808}809810/// ### Note811/// Do not forget to add: `self.consume_store_reads(1)?;`812fn check_is_owner_or_admin<T: Config>(813 caller: caller,814 collection: &CollectionHandle<T>,815) -> Result<T::CrossAccountId> {816 let caller = T::CrossAccountId::from_eth(caller);817 collection818 .check_is_owner_or_admin(&caller)819 .map_err(dispatch_to_evm::<T>)?;820 Ok(caller)821}822823/// ### Note824/// Do not forget to add: `self.consume_store_writes(1)?;`825fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {826 collection827 .check_is_internal()828 .map_err(dispatch_to_evm::<T>)?;829 collection.save().map_err(dispatch_to_evm::<T>)?;830 Ok(())831}832833/// Contains static property keys and values.834pub mod static_property {835 use evm_coder::{836 execution::{Result, Error},837 };838 use alloc::format;839840 const EXPECT_CONVERT_ERROR: &str = "length < limit";841842 /// Keys.843 pub mod key {844 use super::*;845846 /// Key "baseURI".847 pub fn base_uri() -> up_data_structs::PropertyKey {848 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)849 }850851 /// Key "url".852 pub fn url() -> up_data_structs::PropertyKey {853 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)854 }855856 /// Key "suffix".857 pub fn suffix() -> up_data_structs::PropertyKey {858 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)859 }860861 /// Key "parentNft".862 pub fn parent_nft() -> up_data_structs::PropertyKey {863 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)864 }865 }866867 /// Convert `byte` to [`PropertyKey`].868 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {869 bytes.to_vec().try_into().map_err(|_| {870 Error::Revert(format!(871 "Property key is too long. Max length is {}.",872 up_data_structs::PropertyKey::bound()873 ))874 })875 }876877 /// Convert `bytes` to [`PropertyValue`].878 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {879 bytes.to_vec().try_into().map_err(|_| {880 Error::Revert(format!(881 "Property key is too long. Max length is {}.",882 up_data_structs::PropertyKey::bound()883 ))884 })885 }886}887888fn convert_value_limit<V: Into<uint256> + Copy>(889 limit: EvmCollectionLimits,890 value: &Option<V>,891) -> (EvmCollectionLimits, bool, uint256) {892 value893 .map(|v| (limit, true, v.into()))894 .unwrap_or((limit, false, Default::default()))895}896897fn convert_bool_limit(898 limit: EvmCollectionLimits,899 value: &Option<bool>,900) -> (EvmCollectionLimits, bool, uint256) {901 value902 .map(|v| {903 (904 limit,905 true,906 if v {907 uint256::from(1)908 } else {909 Default::default()910 },911 )912 })913 .unwrap_or((limit, false, Default::default()))914}pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -155,6 +155,20 @@
}
}
}
+#[derive(Debug, Default, Clone, Copy, AbiCoder)]
+#[repr(u8)]
+pub enum CollectionLimits {
+ #[default]
+ AccountTokenOwnership,
+ SponsoredDataSize,
+ SponsoredDataRateLimit,
+ TokenLimit,
+ SponsorTransferTimeout,
+ SponsorApproveTimeout,
+ OwnerCanTransfer,
+ OwnerCanDestroy,
+ TransferEnabled,
+}
#[derive(Default, Debug, Clone, Copy, AbiCoder)]
#[repr(u8)]
pub enum CollectionPermissions {
pallets/fungible/src/stubs/UniqueFungible.soldiffbeforeafterboth--- a/pallets/fungible/src/stubs/UniqueFungible.sol
+++ b/pallets/fungible/src/stubs/UniqueFungible.sol
@@ -158,6 +158,27 @@
return Tuple8(0x0000000000000000000000000000000000000000, 0);
}
+ /// Get current collection limits.
+ ///
+ /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
+ /// "accountTokenOwnershipLimit",
+ /// "sponsoredDataSize",
+ /// "sponsoredDataRateLimit",
+ /// "tokenLimit",
+ /// "sponsorTransferTimeout",
+ /// "sponsorApproveTimeout"
+ /// "ownerCanTransfer",
+ /// "ownerCanDestroy",
+ /// "transfersEnabled"
+ /// Return `false` if a limit not set.
+ /// @dev EVM selector for this function is: 0xf63bc572,
+ /// or in textual repr: collectionLimits()
+ function collectionLimits() public view returns (Tuple20[] memory) {
+ require(false, stub_error);
+ dummy;
+ return new Tuple20[](0);
+ }
+
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Name of the limit. Valid names:
@@ -171,11 +192,16 @@
/// "ownerCanDestroy",
/// "transfersEnabled"
/// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x4ad890a8,
- /// or in textual repr: setCollectionLimit(string,uint256)
- function setCollectionLimit(string memory limit, uint256 value) public {
+ /// @dev EVM selector for this function is: 0x88150bd0,
+ /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
+ function setCollectionLimit(
+ CollectionLimits limit,
+ bool status,
+ uint256 value
+ ) public {
require(false, stub_error);
limit;
+ status;
value;
dummy = 0;
}
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -291,6 +291,27 @@
return Tuple30(0x0000000000000000000000000000000000000000, 0);
}
+ /// Get current collection limits.
+ ///
+ /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
+ /// "accountTokenOwnershipLimit",
+ /// "sponsoredDataSize",
+ /// "sponsoredDataRateLimit",
+ /// "tokenLimit",
+ /// "sponsorTransferTimeout",
+ /// "sponsorApproveTimeout"
+ /// "ownerCanTransfer",
+ /// "ownerCanDestroy",
+ /// "transfersEnabled"
+ /// Return `false` if a limit not set.
+ /// @dev EVM selector for this function is: 0xf63bc572,
+ /// or in textual repr: collectionLimits()
+ function collectionLimits() public view returns (Tuple33[] memory) {
+ require(false, stub_error);
+ dummy;
+ return new Tuple33[](0);
+ }
+
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Name of the limit. Valid names:
@@ -304,11 +325,16 @@
/// "ownerCanDestroy",
/// "transfersEnabled"
/// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x4ad890a8,
- /// or in textual repr: setCollectionLimit(string,uint256)
- function setCollectionLimit(string memory limit, uint256 value) public {
+ /// @dev EVM selector for this function is: 0x88150bd0,
+ /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
+ function setCollectionLimit(
+ CollectionLimits limit,
+ bool status,
+ uint256 value
+ ) public {
require(false, stub_error);
limit;
+ status;
value;
dummy = 0;
}
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -292,6 +292,27 @@
return Tuple29(0x0000000000000000000000000000000000000000, 0);
}
+ /// Get current collection limits.
+ ///
+ /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
+ /// "accountTokenOwnershipLimit",
+ /// "sponsoredDataSize",
+ /// "sponsoredDataRateLimit",
+ /// "tokenLimit",
+ /// "sponsorTransferTimeout",
+ /// "sponsorApproveTimeout"
+ /// "ownerCanTransfer",
+ /// "ownerCanDestroy",
+ /// "transfersEnabled"
+ /// Return `false` if a limit not set.
+ /// @dev EVM selector for this function is: 0xf63bc572,
+ /// or in textual repr: collectionLimits()
+ function collectionLimits() public view returns (Tuple32[] memory) {
+ require(false, stub_error);
+ dummy;
+ return new Tuple32[](0);
+ }
+
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Name of the limit. Valid names:
@@ -305,11 +326,16 @@
/// "ownerCanDestroy",
/// "transfersEnabled"
/// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x4ad890a8,
- /// or in textual repr: setCollectionLimit(string,uint256)
- function setCollectionLimit(string memory limit, uint256 value) public {
+ /// @dev EVM selector for this function is: 0x88150bd0,
+ /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
+ function setCollectionLimit(
+ CollectionLimits limit,
+ bool status,
+ uint256 value
+ ) public {
require(false, stub_error);
limit;
+ status;
value;
dummy = 0;
}
tests/src/eth/abi/fungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/fungible.json
+++ b/tests/src/eth/abi/fungible.json
@@ -208,11 +208,16 @@
},
{
"inputs": [],
+<<<<<<< HEAD
"name": "collectionNestingPermissions",
+=======
+ "name": "collectionLimits",
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
"outputs": [
{
"components": [
{
+<<<<<<< HEAD
"internalType": "enum CollectionPermissions",
"name": "field_0",
"type": "uint8"
@@ -220,6 +225,16 @@
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
"internalType": "struct Tuple24[]",
+=======
+ "internalType": "enum CollectionLimits",
+ "name": "field_0",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "field_1", "type": "bool" },
+ { "internalType": "uint256", "name": "field_2", "type": "uint256" }
+ ],
+ "internalType": "struct Tuple20[]",
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
"name": "",
"type": "tuple[]"
}
@@ -229,6 +244,7 @@
},
{
"inputs": [],
+<<<<<<< HEAD
"name": "collectionNestingRestrictedCollectionIds",
"outputs": [
{
@@ -250,6 +266,8 @@
},
{
"inputs": [],
+=======
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
"name": "collectionOwner",
"outputs": [
{
@@ -453,7 +471,12 @@
},
{
"inputs": [
- { "internalType": "string", "name": "limit", "type": "string" },
+ {
+ "internalType": "enum CollectionLimits",
+ "name": "limit",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "status", "type": "bool" },
{ "internalType": "uint256", "name": "value", "type": "uint256" }
],
"name": "setCollectionLimit",
tests/src/eth/abi/nonFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/nonFungible.json
+++ b/tests/src/eth/abi/nonFungible.json
@@ -607,7 +607,12 @@
},
{
"inputs": [
- { "internalType": "string", "name": "limit", "type": "string" },
+ {
+ "internalType": "enum CollectionLimits",
+ "name": "limit",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "status", "type": "bool" },
{ "internalType": "uint256", "name": "value", "type": "uint256" }
],
"name": "setCollectionLimit",
tests/src/eth/abi/reFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungible.json
+++ b/tests/src/eth/abi/reFungible.json
@@ -589,7 +589,12 @@
},
{
"inputs": [
- { "internalType": "string", "name": "limit", "type": "string" },
+ {
+ "internalType": "enum CollectionLimits",
+ "name": "limit",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "status", "type": "bool" },
{ "internalType": "uint256", "name": "value", "type": "uint256" }
],
"name": "setCollectionLimit",
tests/src/eth/api/UniqueFungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueFungible.sol
+++ b/tests/src/eth/api/UniqueFungible.sol
@@ -13,7 +13,11 @@
}
/// @title A contract that allows you to work with collections.
+<<<<<<< HEAD
/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+=======
+/// @dev the ERC-165 identifier for this interface is 0xf8ebdec0
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -104,6 +108,23 @@
/// or in textual repr: collectionSponsor()
function collectionSponsor() external view returns (Tuple8 memory);
+ /// Get current collection limits.
+ ///
+ /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
+ /// "accountTokenOwnershipLimit",
+ /// "sponsoredDataSize",
+ /// "sponsoredDataRateLimit",
+ /// "tokenLimit",
+ /// "sponsorTransferTimeout",
+ /// "sponsorApproveTimeout"
+ /// "ownerCanTransfer",
+ /// "ownerCanDestroy",
+ /// "transfersEnabled"
+ /// Return `false` if a limit not set.
+ /// @dev EVM selector for this function is: 0xf63bc572,
+ /// or in textual repr: collectionLimits()
+ function collectionLimits() external view returns (Tuple19[] memory);
+
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Name of the limit. Valid names:
@@ -117,9 +138,13 @@
/// "ownerCanDestroy",
/// "transfersEnabled"
/// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x4ad890a8,
- /// or in textual repr: setCollectionLimit(string,uint256)
- function setCollectionLimit(string memory limit, uint256 value) external;
+ /// @dev EVM selector for this function is: 0x88150bd0,
+ /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
+ function setCollectionLimit(
+ CollectionLimits limit,
+ bool status,
+ uint256 value
+ ) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
@@ -288,6 +313,7 @@
uint256 sub;
}
+<<<<<<< HEAD
/// @dev anonymous struct
struct Tuple23 {
CollectionPermissions field_0;
@@ -303,6 +329,25 @@
struct Tuple20 {
bool field_0;
uint256[] field_1;
+=======
+enum CollectionLimits {
+ AccountTokenOwnership,
+ SponsoredDataSize,
+ SponsoredDataRateLimit,
+ TokenLimit,
+ SponsorTransferTimeout,
+ SponsorApproveTimeout,
+ OwnerCanTransfer,
+ OwnerCanDestroy,
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple19 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
}
/// @dev Property struct
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -104,7 +104,11 @@
}
/// @title A contract that allows you to work with collections.
+<<<<<<< HEAD
/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+=======
+/// @dev the ERC-165 identifier for this interface is 0xf8ebdec0
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -195,6 +199,23 @@
/// or in textual repr: collectionSponsor()
function collectionSponsor() external view returns (Tuple27 memory);
+ /// Get current collection limits.
+ ///
+ /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
+ /// "accountTokenOwnershipLimit",
+ /// "sponsoredDataSize",
+ /// "sponsoredDataRateLimit",
+ /// "tokenLimit",
+ /// "sponsorTransferTimeout",
+ /// "sponsorApproveTimeout"
+ /// "ownerCanTransfer",
+ /// "ownerCanDestroy",
+ /// "transfersEnabled"
+ /// Return `false` if a limit not set.
+ /// @dev EVM selector for this function is: 0xf63bc572,
+ /// or in textual repr: collectionLimits()
+ function collectionLimits() external view returns (Tuple30[] memory);
+
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Name of the limit. Valid names:
@@ -208,9 +229,13 @@
/// "ownerCanDestroy",
/// "transfersEnabled"
/// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x4ad890a8,
- /// or in textual repr: setCollectionLimit(string,uint256)
- function setCollectionLimit(string memory limit, uint256 value) external;
+ /// @dev EVM selector for this function is: 0x88150bd0,
+ /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
+ function setCollectionLimit(
+ CollectionLimits limit,
+ bool status,
+ uint256 value
+ ) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
@@ -379,6 +404,25 @@
uint256 sub;
}
+enum CollectionLimits {
+ AccountTokenOwnership,
+ SponsoredDataSize,
+ SponsoredDataRateLimit,
+ TokenLimit,
+ SponsorTransferTimeout,
+ SponsorApproveTimeout,
+ OwnerCanTransfer,
+ OwnerCanDestroy,
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple30 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev anonymous struct
struct Tuple34 {
CollectionPermissions field_0;
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -105,7 +105,11 @@
}
/// @title A contract that allows you to work with collections.
+<<<<<<< HEAD
/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+=======
+/// @dev the ERC-165 identifier for this interface is 0xf8ebdec0
+>>>>>>> 32e011ce... added `collectionLimits` function in `Collection` interface, changed signture for `setCollectionLimit`
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -196,6 +200,23 @@
/// or in textual repr: collectionSponsor()
function collectionSponsor() external view returns (Tuple26 memory);
+ /// Get current collection limits.
+ ///
+ /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
+ /// "accountTokenOwnershipLimit",
+ /// "sponsoredDataSize",
+ /// "sponsoredDataRateLimit",
+ /// "tokenLimit",
+ /// "sponsorTransferTimeout",
+ /// "sponsorApproveTimeout"
+ /// "ownerCanTransfer",
+ /// "ownerCanDestroy",
+ /// "transfersEnabled"
+ /// Return `false` if a limit not set.
+ /// @dev EVM selector for this function is: 0xf63bc572,
+ /// or in textual repr: collectionLimits()
+ function collectionLimits() external view returns (Tuple29[] memory);
+
/// Set limits for the collection.
/// @dev Throws error if limit not found.
/// @param limit Name of the limit. Valid names:
@@ -209,9 +230,13 @@
/// "ownerCanDestroy",
/// "transfersEnabled"
/// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x4ad890a8,
- /// or in textual repr: setCollectionLimit(string,uint256)
- function setCollectionLimit(string memory limit, uint256 value) external;
+ /// @dev EVM selector for this function is: 0x88150bd0,
+ /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
+ function setCollectionLimit(
+ CollectionLimits limit,
+ bool status,
+ uint256 value
+ ) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
@@ -380,6 +405,25 @@
uint256 sub;
}
+enum CollectionLimits {
+ AccountTokenOwnership,
+ SponsoredDataSize,
+ SponsoredDataRateLimit,
+ TokenLimit,
+ SponsorTransferTimeout,
+ SponsorApproveTimeout,
+ OwnerCanTransfer,
+ OwnerCanDestroy,
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple29 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev anonymous struct
struct Tuple33 {
CollectionPermissions field_0;
tests/src/eth/createFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createFTCollection.test.ts
+++ b/tests/src/eth/createFTCollection.test.ts
@@ -17,7 +17,7 @@
import {IKeyringPair} from '@polkadot/types/types';
import {evmToAddress} from '@polkadot/util-crypto';
import {Pallets, requirePalletsOrSkip} from '../util';
-import {expect, itEth, usingEthPlaygrounds} from './util';
+import {CollectionLimits, expect, itEth, usingEthPlaygrounds} from './util';
const DECIMALS = 18;
@@ -79,6 +79,56 @@
expect(await collection.methods.description().call()).to.deep.equal(description);
});
+ itEth('Set limits', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionId, collectionAddress} = await helper.eth.createFungibleCollection(owner, 'Limits', DECIMALS, 'absolutely anything', 'INSI');
+ const limits = {
+ accountTokenOwnershipLimit: 1000,
+ sponsoredDataSize: 1024,
+ sponsoredDataRateLimit: 30,
+ tokenLimit: 1000000,
+ sponsorTransferTimeout: 6,
+ sponsorApproveTimeout: 6,
+ ownerCanTransfer: 0,
+ ownerCanDestroy: 0,
+ transfersEnabled: 0,
+ };
+
+ const expectedLimits = {
+ accountTokenOwnershipLimit: 1000,
+ sponsoredDataSize: 1024,
+ sponsoredDataRateLimit: 30,
+ tokenLimit: 1000000,
+ sponsorTransferTimeout: 6,
+ sponsorApproveTimeout: 6,
+ ownerCanTransfer: false,
+ ownerCanDestroy: false,
+ transfersEnabled: false,
+ };
+
+ const collection = helper.ethNativeContract.collection(collectionAddress, 'ft', owner);
+ await collection.methods.setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, limits.accountTokenOwnershipLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsoredDataSize, true, limits.sponsoredDataSize).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsoredDataRateLimit, true, limits.sponsoredDataRateLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.TokenLimit, true, limits.tokenLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsorTransferTimeout, true, limits.sponsorTransferTimeout).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsorApproveTimeout, true, limits.sponsorApproveTimeout).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, limits.ownerCanTransfer).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanDestroy, true, limits.ownerCanDestroy).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.TransferEnabled, true, limits.transfersEnabled).send();
+
+ const data = (await helper.rft.getData(collectionId))!;
+ expect(data.raw.limits.accountTokenOwnershipLimit).to.be.eq(expectedLimits.accountTokenOwnershipLimit);
+ expect(data.raw.limits.sponsoredDataSize).to.be.eq(expectedLimits.sponsoredDataSize);
+ expect(data.raw.limits.sponsoredDataRateLimit.blocks).to.be.eq(expectedLimits.sponsoredDataRateLimit);
+ expect(data.raw.limits.tokenLimit).to.be.eq(expectedLimits.tokenLimit);
+ expect(data.raw.limits.sponsorTransferTimeout).to.be.eq(expectedLimits.sponsorTransferTimeout);
+ expect(data.raw.limits.sponsorApproveTimeout).to.be.eq(expectedLimits.sponsorApproveTimeout);
+ expect(data.raw.limits.ownerCanTransfer).to.be.eq(expectedLimits.ownerCanTransfer);
+ expect(data.raw.limits.ownerCanDestroy).to.be.eq(expectedLimits.ownerCanDestroy);
+ expect(data.raw.limits.transfersEnabled).to.be.eq(expectedLimits.transfersEnabled);
+ });
+
itEth('Collection address exist', async ({helper}) => {
const owner = await helper.eth.createAccountWithBalance(donor);
const collectionAddressForNonexistentCollection = '0x17C4E6453CC49AAAAEACA894E6D9683E00112233';
@@ -197,6 +247,7 @@
{
await expect(peasantCollection.methods
.setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -224,5 +275,31 @@
.setCollectionLimit('accountTokenOwnershipLimit', '1000')
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
- });
+ });
+
+ itEth('(!negative test!) Set limits', async ({helper}) => {
+
+ const invalidLimits = {
+ accountTokenOwnershipLimit: BigInt(Number.MAX_SAFE_INTEGER),
+ transfersEnabled: 3,
+ };
+
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionAddress} = await helper.eth.createFungibleCollection(owner, 'Limits', DECIMALS, 'absolutely anything', 'ISNI');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'ft', owner);
+ await expect(collectionEvm.methods
+ .setCollectionLimit(20, true, '1')
+ .call()).to.be.rejectedWith('Returned error: VM Exception while processing transaction: revert Value not convertible into enum "CollectionLimits"');
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, invalidLimits.accountTokenOwnershipLimit)
+ .call()).to.be.rejectedWith(`can't convert value to u32 "${invalidLimits.accountTokenOwnershipLimit}"`);
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.TransferEnabled, true, invalidLimits.transfersEnabled)
+ .call()).to.be.rejectedWith(`can't convert value to boolean "${invalidLimits.transfersEnabled}"`);
+ });
+
+
+
});
tests/src/eth/createNFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createNFTCollection.test.ts
+++ b/tests/src/eth/createNFTCollection.test.ts
@@ -16,7 +16,7 @@
import {evmToAddress} from '@polkadot/util-crypto';
import {IKeyringPair} from '@polkadot/types/types';
-import {expect, itEth, usingEthPlaygrounds} from './util';
+import {CollectionLimits, expect, itEth, usingEthPlaygrounds} from './util';
describe('Create NFT collection from EVM', () => {
@@ -120,6 +120,56 @@
expect(await sponsorCollection.methods.description().call()).to.deep.equal(description);
});
+ itEth('Set limits', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionId, collectionAddress} = await helper.eth.createNFTCollection(owner, 'Limits', 'absolutely anything', 'FLO');
+ const limits = {
+ accountTokenOwnershipLimit: 1000,
+ sponsoredDataSize: 1024,
+ sponsoredDataRateLimit: 30,
+ tokenLimit: 1000000,
+ sponsorTransferTimeout: 6,
+ sponsorApproveTimeout: 6,
+ ownerCanTransfer: 0,
+ ownerCanDestroy: 0,
+ transfersEnabled: 0,
+ };
+
+ const expectedLimits = {
+ accountTokenOwnershipLimit: 1000,
+ sponsoredDataSize: 1024,
+ sponsoredDataRateLimit: 30,
+ tokenLimit: 1000000,
+ sponsorTransferTimeout: 6,
+ sponsorApproveTimeout: 6,
+ ownerCanTransfer: false,
+ ownerCanDestroy: false,
+ transfersEnabled: false,
+ };
+
+ const collection = helper.ethNativeContract.collection(collectionAddress, 'nft', owner);
+ await collection.methods.setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, limits.accountTokenOwnershipLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsoredDataSize, true, limits.sponsoredDataSize).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsoredDataRateLimit, true, limits.sponsoredDataRateLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.TokenLimit, true, limits.tokenLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsorTransferTimeout, true, limits.sponsorTransferTimeout).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsorApproveTimeout, true, limits.sponsorApproveTimeout).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, limits.ownerCanTransfer).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanDestroy, true, limits.ownerCanDestroy).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.TransferEnabled, true, limits.transfersEnabled).send();
+
+ const data = (await helper.rft.getData(collectionId))!;
+ expect(data.raw.limits.accountTokenOwnershipLimit).to.be.eq(expectedLimits.accountTokenOwnershipLimit);
+ expect(data.raw.limits.sponsoredDataSize).to.be.eq(expectedLimits.sponsoredDataSize);
+ expect(data.raw.limits.sponsoredDataRateLimit.blocks).to.be.eq(expectedLimits.sponsoredDataRateLimit);
+ expect(data.raw.limits.tokenLimit).to.be.eq(expectedLimits.tokenLimit);
+ expect(data.raw.limits.sponsorTransferTimeout).to.be.eq(expectedLimits.sponsorTransferTimeout);
+ expect(data.raw.limits.sponsorApproveTimeout).to.be.eq(expectedLimits.sponsorApproveTimeout);
+ expect(data.raw.limits.ownerCanTransfer).to.be.eq(expectedLimits.ownerCanTransfer);
+ expect(data.raw.limits.ownerCanDestroy).to.be.eq(expectedLimits.ownerCanDestroy);
+ expect(data.raw.limits.transfersEnabled).to.be.eq(expectedLimits.transfersEnabled);
+ });
+
itEth('Collection address exist', async ({helper}) => {
const owner = await helper.eth.createAccountWithBalance(donor);
const collectionAddressForNonexistentCollection = '0x17C4E6453CC49AAAAEACA894E6D9683E00112233';
@@ -207,7 +257,7 @@
}
{
await expect(malfeasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -232,11 +282,30 @@
}
{
await expect(malfeasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
+ itEth('(!negative test!) Set limits', async ({helper}) => {
+ const invalidLimits = {
+ accountTokenOwnershipLimit: BigInt(Number.MAX_SAFE_INTEGER),
+ transfersEnabled: 3,
+ };
+
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionAddress} = await helper.eth.createNFTCollection(owner, 'Limits', 'absolutely anything', 'OLF');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner);
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, invalidLimits.accountTokenOwnershipLimit)
+ .call()).to.be.rejectedWith(`can't convert value to u32 "${invalidLimits.accountTokenOwnershipLimit}"`);
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.TransferEnabled, true, invalidLimits.transfersEnabled)
+ .call()).to.be.rejectedWith(`can't convert value to boolean "${invalidLimits.transfersEnabled}"`);
+ });
+
itEth('destroyCollection', async ({helper}) => {
const owner = await helper.eth.createAccountWithBalance(donor);
const {collectionAddress, collectionId} = await helper.eth.createNFTCollection(owner, 'Limits', 'absolutely anything', 'OLF');
tests/src/eth/createRFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createRFTCollection.test.ts
+++ b/tests/src/eth/createRFTCollection.test.ts
@@ -17,7 +17,7 @@
import {evmToAddress} from '@polkadot/util-crypto';
import {IKeyringPair} from '@polkadot/types/types';
import {Pallets, requirePalletsOrSkip} from '../util';
-import {expect, itEth, usingEthPlaygrounds} from './util';
+import {CollectionLimits, expect, itEth, usingEthPlaygrounds} from './util';
describe('Create RFT collection from EVM', () => {
@@ -152,6 +152,56 @@
expect(data.raw.sponsorship.Confirmed).to.be.equal(evmToAddress(sponsor, Number(ss58Format)));
});
+ itEth('Set limits', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionId, collectionAddress} = await helper.eth.createRFTCollection(owner, 'Limits', 'absolutely anything', 'INSI');
+ const limits = {
+ accountTokenOwnershipLimit: 1000,
+ sponsoredDataSize: 1024,
+ sponsoredDataRateLimit: 30,
+ tokenLimit: 1000000,
+ sponsorTransferTimeout: 6,
+ sponsorApproveTimeout: 6,
+ ownerCanTransfer: 0,
+ ownerCanDestroy: 0,
+ transfersEnabled: 0,
+ };
+
+ const expectedLimits = {
+ accountTokenOwnershipLimit: 1000,
+ sponsoredDataSize: 1024,
+ sponsoredDataRateLimit: 30,
+ tokenLimit: 1000000,
+ sponsorTransferTimeout: 6,
+ sponsorApproveTimeout: 6,
+ ownerCanTransfer: false,
+ ownerCanDestroy: false,
+ transfersEnabled: false,
+ };
+
+ const collection = helper.ethNativeContract.collection(collectionAddress, 'rft', owner);
+ await collection.methods.setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, limits.accountTokenOwnershipLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsoredDataSize, true, limits.sponsoredDataSize).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsoredDataRateLimit, true, limits.sponsoredDataRateLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.TokenLimit, true, limits.tokenLimit).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsorTransferTimeout, true, limits.sponsorTransferTimeout).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.SponsorApproveTimeout, true, limits.sponsorApproveTimeout).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, limits.ownerCanTransfer).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanDestroy, true, limits.ownerCanDestroy).send();
+ await collection.methods.setCollectionLimit(CollectionLimits.TransferEnabled, true, limits.transfersEnabled).send();
+
+ const data = (await helper.rft.getData(collectionId))!;
+ expect(data.raw.limits.accountTokenOwnershipLimit).to.be.eq(expectedLimits.accountTokenOwnershipLimit);
+ expect(data.raw.limits.sponsoredDataSize).to.be.eq(expectedLimits.sponsoredDataSize);
+ expect(data.raw.limits.sponsoredDataRateLimit.blocks).to.be.eq(expectedLimits.sponsoredDataRateLimit);
+ expect(data.raw.limits.tokenLimit).to.be.eq(expectedLimits.tokenLimit);
+ expect(data.raw.limits.sponsorTransferTimeout).to.be.eq(expectedLimits.sponsorTransferTimeout);
+ expect(data.raw.limits.sponsorApproveTimeout).to.be.eq(expectedLimits.sponsorApproveTimeout);
+ expect(data.raw.limits.ownerCanTransfer).to.be.eq(expectedLimits.ownerCanTransfer);
+ expect(data.raw.limits.ownerCanDestroy).to.be.eq(expectedLimits.ownerCanDestroy);
+ expect(data.raw.limits.transfersEnabled).to.be.eq(expectedLimits.transfersEnabled);
+ });
+
itEth('Collection address exist', async ({helper}) => {
const owner = await helper.eth.createAccountWithBalance(donor);
const collectionAddressForNonexistentCollection = '0x17C4E6453CC49AAAAEACA894E6D9683E00112233';
@@ -239,7 +289,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -264,10 +314,29 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
+
+ itEth('(!negative test!) Set limits', async ({helper}) => {
+ const invalidLimits = {
+ accountTokenOwnershipLimit: BigInt(Number.MAX_SAFE_INTEGER),
+ transfersEnabled: 3,
+ };
+
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionAddress} = await helper.eth.createRFTCollection(owner, 'Limits', 'absolutely anything', 'ISNI');
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'rft', owner);
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, invalidLimits.accountTokenOwnershipLimit)
+ .call()).to.be.rejectedWith(`can't convert value to u32 "${invalidLimits.accountTokenOwnershipLimit}"`);
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.TransferEnabled, true, invalidLimits.transfersEnabled)
+ .call()).to.be.rejectedWith(`can't convert value to boolean "${invalidLimits.transfersEnabled}"`);
+ });
itEth('destroyCollection', async ({helper}) => {
const owner = await helper.eth.createAccountWithBalance(donor);
tests/src/eth/util/index.tsdiffbeforeafterboth--- a/tests/src/eth/util/index.ts
+++ b/tests/src/eth/util/index.ts
@@ -26,6 +26,17 @@
Allowlisted = 1,
Generous = 2,
}
+export enum CollectionLimits {
+ AccountTokenOwnership,
+ SponsoredDataSize,
+ SponsoredDataRateLimit,
+ TokenLimit,
+ SponsorTransferTimeout,
+ SponsorApproveTimeout,
+ OwnerCanTransfer,
+ OwnerCanDestroy,
+ TransferEnabled
+}
export const usingEthPlaygrounds = async (code: (helper: EthUniqueHelper, privateKey: (seed: string | {filename: string}) => Promise<IKeyringPair>) => Promise<void>) => {
const silentConsole = new SilentConsole();