difftreelog
Merge branch 'develop' into tests/eth-helpers
in: master
21 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 .and_then(|limit| {362 if let SponsoringRateLimit::Blocks(blocks) = limit {363 Some((364 EvmCollectionLimits::SponsoredDataRateLimit,365 true,366 blocks.into(),367 ))368 } else {369 None370 }371 })372 .unwrap_or((373 EvmCollectionLimits::SponsoredDataRateLimit,374 false,375 Default::default(),376 )),377 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),378 convert_value_limit(379 EvmCollectionLimits::SponsorTransferTimeout,380 limits.sponsor_transfer_timeout,381 ),382 convert_value_limit(383 EvmCollectionLimits::SponsorApproveTimeout,384 limits.sponsor_approve_timeout,385 ),386 convert_bool_limit(387 EvmCollectionLimits::OwnerCanTransfer,388 limits.owner_can_transfer,389 ),390 convert_bool_limit(391 EvmCollectionLimits::OwnerCanDestroy,392 limits.owner_can_destroy,393 ),394 convert_bool_limit(395 EvmCollectionLimits::TransferEnabled,396 limits.transfers_enabled,397 ),398 ])399 }400401 /// Set limits for the collection.402 /// @dev Throws error if limit not found.403 /// @param limit Name of the limit. Valid names:404 /// "accountTokenOwnershipLimit",405 /// "sponsoredDataSize",406 /// "sponsoredDataRateLimit",407 /// "tokenLimit",408 /// "sponsorTransferTimeout",409 /// "sponsorApproveTimeout"410 /// "ownerCanTransfer",411 /// "ownerCanDestroy",412 /// "transfersEnabled"413 /// @param status enable\disable limit. Works only with `true`.414 /// @param value Value of the limit.415 #[solidity(rename_selector = "setCollectionLimit")]416 fn set_collection_limit(417 &mut self,418 caller: caller,419 limit: EvmCollectionLimits,420 status: bool,421 value: uint256,422 ) -> Result<void> {423 self.consume_store_reads_and_writes(1, 1)?;424425 if !status {426 return Err(Error::Revert("user can't disable limits".into()));427 }428429 let value = value430 .try_into()431 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;432433 let convert_value_to_bool = || match value {434 0 => Ok(false),435 1 => Ok(true),436 _ => {437 return Err(Error::Revert(format!(438 "can't convert value to boolean \"{}\"",439 value440 )))441 }442 };443444 let mut limits = self.limits.clone();445446 match limit {447 EvmCollectionLimits::AccountTokenOwnership => {448 limits.account_token_ownership_limit = Some(value);449 }450 EvmCollectionLimits::SponsoredDataSize => {451 limits.sponsored_data_size = Some(value);452 }453 EvmCollectionLimits::SponsoredDataRateLimit => {454 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));455 }456 EvmCollectionLimits::TokenLimit => {457 limits.token_limit = Some(value);458 }459 EvmCollectionLimits::SponsorTransferTimeout => {460 limits.sponsor_transfer_timeout = Some(value);461 }462 EvmCollectionLimits::SponsorApproveTimeout => {463 limits.sponsor_approve_timeout = Some(value);464 }465 EvmCollectionLimits::OwnerCanTransfer => {466 limits.owner_can_transfer = Some(convert_value_to_bool()?);467 }468 EvmCollectionLimits::OwnerCanDestroy => {469 limits.owner_can_destroy = Some(convert_value_to_bool()?);470 }471 EvmCollectionLimits::TransferEnabled => {472 limits.transfers_enabled = Some(convert_value_to_bool()?);473 }474 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),475 }476477 let caller = T::CrossAccountId::from_eth(caller);478 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)479 }480481 /// Get contract address.482 fn contract_address(&self) -> Result<address> {483 Ok(crate::eth::collection_id_to_address(self.id))484 }485486 /// Add collection admin.487 /// @param newAdmin Cross account administrator address.488 fn add_collection_admin_cross(489 &mut self,490 caller: caller,491 new_admin: EthCrossAccount,492 ) -> Result<void> {493 self.consume_store_reads_and_writes(2, 2)?;494495 let caller = T::CrossAccountId::from_eth(caller);496 let new_admin = new_admin.into_sub_cross_account::<T>()?;497 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;498 Ok(())499 }500501 /// Remove collection admin.502 /// @param admin Cross account administrator address.503 fn remove_collection_admin_cross(504 &mut self,505 caller: caller,506 admin: EthCrossAccount,507 ) -> Result<void> {508 self.consume_store_reads_and_writes(2, 2)?;509510 let caller = T::CrossAccountId::from_eth(caller);511 let admin = admin.into_sub_cross_account::<T>()?;512 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;513 Ok(())514 }515516 /// Add collection admin.517 /// @param newAdmin Address of the added administrator.518 #[solidity(hide)]519 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {520 self.consume_store_reads_and_writes(2, 2)?;521522 let caller = T::CrossAccountId::from_eth(caller);523 let new_admin = T::CrossAccountId::from_eth(new_admin);524 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;525 Ok(())526 }527528 /// Remove collection admin.529 ///530 /// @param admin Address of the removed administrator.531 #[solidity(hide)]532 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {533 self.consume_store_reads_and_writes(2, 2)?;534535 let caller = T::CrossAccountId::from_eth(caller);536 let admin = T::CrossAccountId::from_eth(admin);537 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;538 Ok(())539 }540541 /// Toggle accessibility of collection nesting.542 ///543 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'544 #[solidity(rename_selector = "setCollectionNesting")]545 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {546 self.consume_store_reads_and_writes(1, 1)?;547548 let caller = T::CrossAccountId::from_eth(caller);549550 let mut permissions = self.collection.permissions.clone();551 let mut nesting = permissions.nesting().clone();552 nesting.token_owner = enable;553 nesting.restricted = None;554 permissions.nesting = Some(nesting);555556 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)557 }558559 /// Toggle accessibility of collection nesting.560 ///561 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'562 /// @param collections Addresses of collections that will be available for nesting.563 #[solidity(rename_selector = "setCollectionNesting")]564 fn set_nesting(565 &mut self,566 caller: caller,567 enable: bool,568 collections: Vec<address>,569 ) -> Result<void> {570 self.consume_store_reads_and_writes(1, 1)?;571572 if collections.is_empty() {573 return Err("no addresses provided".into());574 }575 let caller = T::CrossAccountId::from_eth(caller);576577 let mut permissions = self.collection.permissions.clone();578 match enable {579 false => {580 let mut nesting = permissions.nesting().clone();581 nesting.token_owner = false;582 nesting.restricted = None;583 permissions.nesting = Some(nesting);584 }585 true => {586 let mut bv = OwnerRestrictedSet::new();587 for i in collections {588 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {589 Error::Revert("Can't convert address into collection id".into())590 })?)591 .map_err(|_| "too many collections")?;592 }593 let mut nesting = permissions.nesting().clone();594 nesting.token_owner = true;595 nesting.restricted = Some(bv);596 permissions.nesting = Some(nesting);597 }598 };599600 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)601 }602603 /// Returns nesting for a collection604 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]605 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {606 let nesting = self.collection.permissions.nesting();607608 Ok((609 nesting.token_owner,610 nesting611 .restricted612 .clone()613 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())614 .unwrap_or_default(),615 ))616 }617618 /// Returns permissions for a collection619 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {620 let nesting = self.collection.permissions.nesting();621 Ok(vec![622 (EvmPermissions::CollectionAdmin, nesting.collection_admin),623 (EvmPermissions::TokenOwner, nesting.token_owner),624 ])625 }626 /// Set the collection access method.627 /// @param mode Access mode628 /// 0 for Normal629 /// 1 for AllowList630 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {631 self.consume_store_reads_and_writes(1, 1)?;632633 let caller = T::CrossAccountId::from_eth(caller);634 let permissions = CollectionPermissions {635 access: Some(match mode {636 0 => AccessMode::Normal,637 1 => AccessMode::AllowList,638 _ => return Err("not supported access mode".into()),639 }),640 ..Default::default()641 };642 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)643 }644645 /// Checks that user allowed to operate with collection.646 ///647 /// @param user User address to check.648 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {649 let user = user.into_sub_cross_account::<T>()?;650 Ok(Pallet::<T>::allowed(self.id, user))651 }652653 /// Add the user to the allowed list.654 ///655 /// @param user Address of a trusted user.656 #[solidity(hide)]657 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {658 self.consume_store_writes(1)?;659660 let caller = T::CrossAccountId::from_eth(caller);661 let user = T::CrossAccountId::from_eth(user);662 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;663 Ok(())664 }665666 /// Add user to allowed list.667 ///668 /// @param user User cross account address.669 fn add_to_collection_allow_list_cross(670 &mut self,671 caller: caller,672 user: EthCrossAccount,673 ) -> Result<void> {674 self.consume_store_writes(1)?;675676 let caller = T::CrossAccountId::from_eth(caller);677 let user = user.into_sub_cross_account::<T>()?;678 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;679 Ok(())680 }681682 /// Remove the user from the allowed list.683 ///684 /// @param user Address of a removed user.685 #[solidity(hide)]686 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {687 self.consume_store_writes(1)?;688689 let caller = T::CrossAccountId::from_eth(caller);690 let user = T::CrossAccountId::from_eth(user);691 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;692 Ok(())693 }694695 /// Remove user from allowed list.696 ///697 /// @param user User cross account address.698 fn remove_from_collection_allow_list_cross(699 &mut self,700 caller: caller,701 user: EthCrossAccount,702 ) -> Result<void> {703 self.consume_store_writes(1)?;704705 let caller = T::CrossAccountId::from_eth(caller);706 let user = user.into_sub_cross_account::<T>()?;707 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;708 Ok(())709 }710711 /// Switch permission for minting.712 ///713 /// @param mode Enable if "true".714 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {715 self.consume_store_reads_and_writes(1, 1)?;716717 let caller = T::CrossAccountId::from_eth(caller);718 let permissions = CollectionPermissions {719 mint_mode: Some(mode),720 ..Default::default()721 };722 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)723 }724725 /// Check that account is the owner or admin of the collection726 ///727 /// @param user account to verify728 /// @return "true" if account is the owner or admin729 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]730 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {731 let user = T::CrossAccountId::from_eth(user);732 Ok(self.is_owner_or_admin(&user))733 }734735 /// Check that account is the owner or admin of the collection736 ///737 /// @param user User cross account to verify738 /// @return "true" if account is the owner or admin739 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {740 let user = user.into_sub_cross_account::<T>()?;741 Ok(self.is_owner_or_admin(&user))742 }743744 /// Returns collection type745 ///746 /// @return `Fungible` or `NFT` or `ReFungible`747 fn unique_collection_type(&self) -> Result<string> {748 let mode = match self.collection.mode {749 CollectionMode::Fungible(_) => "Fungible",750 CollectionMode::NFT => "NFT",751 CollectionMode::ReFungible => "ReFungible",752 };753 Ok(mode.into())754 }755756 /// Get collection owner.757 ///758 /// @return Tuble with sponsor address and his substrate mirror.759 /// If address is canonical then substrate mirror is zero and vice versa.760 fn collection_owner(&self) -> Result<EthCrossAccount> {761 Ok(EthCrossAccount::from_sub_cross_account::<T>(762 &T::CrossAccountId::from_sub(self.owner.clone()),763 ))764 }765766 /// Changes collection owner to another account767 ///768 /// @dev Owner can be changed only by current owner769 /// @param newOwner new owner account770 #[solidity(hide, rename_selector = "changeCollectionOwner")]771 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {772 self.consume_store_writes(1)?;773774 let caller = T::CrossAccountId::from_eth(caller);775 let new_owner = T::CrossAccountId::from_eth(new_owner);776 self.change_owner(caller, new_owner)777 .map_err(dispatch_to_evm::<T>)778 }779780 /// Get collection administrators781 ///782 /// @return Vector of tuples with admins address and his substrate mirror.783 /// If address is canonical then substrate mirror is zero and vice versa.784 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {785 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))786 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))787 .collect();788 Ok(result)789 }790791 /// Changes collection owner to another account792 ///793 /// @dev Owner can be changed only by current owner794 /// @param newOwner new owner cross account795 fn change_collection_owner_cross(796 &mut self,797 caller: caller,798 new_owner: EthCrossAccount,799 ) -> Result<void> {800 self.consume_store_writes(1)?;801802 let caller = T::CrossAccountId::from_eth(caller);803 let new_owner = new_owner.into_sub_cross_account::<T>()?;804 self.change_owner(caller, new_owner)805 .map_err(dispatch_to_evm::<T>)806 }807}808809/// ### Note810/// Do not forget to add: `self.consume_store_reads(1)?;`811fn check_is_owner_or_admin<T: Config>(812 caller: caller,813 collection: &CollectionHandle<T>,814) -> Result<T::CrossAccountId> {815 let caller = T::CrossAccountId::from_eth(caller);816 collection817 .check_is_owner_or_admin(&caller)818 .map_err(dispatch_to_evm::<T>)?;819 Ok(caller)820}821822/// ### Note823/// Do not forget to add: `self.consume_store_writes(1)?;`824fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {825 collection826 .check_is_internal()827 .map_err(dispatch_to_evm::<T>)?;828 collection.save().map_err(dispatch_to_evm::<T>)?;829 Ok(())830}831832/// Contains static property keys and values.833pub mod static_property {834 use evm_coder::{835 execution::{Result, Error},836 };837 use alloc::format;838839 const EXPECT_CONVERT_ERROR: &str = "length < limit";840841 /// Keys.842 pub mod key {843 use super::*;844845 /// Key "baseURI".846 pub fn base_uri() -> up_data_structs::PropertyKey {847 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)848 }849850 /// Key "url".851 pub fn url() -> up_data_structs::PropertyKey {852 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)853 }854855 /// Key "suffix".856 pub fn suffix() -> up_data_structs::PropertyKey {857 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)858 }859860 /// Key "parentNft".861 pub fn parent_nft() -> up_data_structs::PropertyKey {862 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)863 }864 }865866 /// Convert `byte` to [`PropertyKey`].867 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {868 bytes.to_vec().try_into().map_err(|_| {869 Error::Revert(format!(870 "Property key is too long. Max length is {}.",871 up_data_structs::PropertyKey::bound()872 ))873 })874 }875876 /// Convert `bytes` to [`PropertyValue`].877 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {878 bytes.to_vec().try_into().map_err(|_| {879 Error::Revert(format!(880 "Property key is too long. Max length is {}.",881 up_data_structs::PropertyKey::bound()882 ))883 })884 }885}pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -155,6 +155,31 @@
}
}
}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+#[derive(Debug, Default, Clone, Copy, AbiCoder)]
+#[repr(u8)]
+pub enum CollectionLimits {
+ /// How many tokens can a user have on one account.
+ #[default]
+ AccountTokenOwnership,
+ /// How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// How many tokens can be mined into this collection.
+ TokenLimit,
+ /// Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// Is it possible to send tokens from this collection between users.
+ TransferEnabled,
+}
#[derive(Default, Debug, Clone, Copy, AbiCoder)]
#[repr(u8)]
pub enum CollectionPermissions {
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
@@ -18,7 +18,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+/// @dev the ERC-165 identifier for this interface is 0x81172a75
contract Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -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:
@@ -170,12 +191,18 @@
/// "ownerCanTransfer",
/// "ownerCanDestroy",
/// "transfersEnabled"
+ /// @param status enable\disable limit. Works only with `true`.
/// @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;
}
@@ -257,19 +284,19 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() public view returns (Tuple21 memory) {
+ function collectionNestingRestrictedCollectionIds() public view returns (Tuple26 memory) {
require(false, stub_error);
dummy;
- return Tuple21(false, new uint256[](0));
+ return Tuple26(false, new uint256[](0));
}
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() public view returns (Tuple24[] memory) {
+ function collectionNestingPermissions() public view returns (Tuple29[] memory) {
require(false, stub_error);
dummy;
- return new Tuple24[](0);
+ return new Tuple29[](0);
}
/// Set the collection access method.
@@ -449,17 +476,46 @@
}
/// @dev anonymous struct
-struct Tuple24 {
+struct Tuple29 {
CollectionPermissions field_0;
bool field_1;
}
/// @dev anonymous struct
-struct Tuple21 {
+struct Tuple26 {
bool field_0;
uint256[] field_1;
}
+/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+enum CollectionLimits {
+ /// @dev How many tokens can a user have on one account.
+ AccountTokenOwnership,
+ /// @dev How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// @dev How many tokens can be mined into this collection.
+ TokenLimit,
+ /// @dev Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// @dev Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// @dev Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// @dev Is it possible to send tokens from this collection between users.
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple20 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev Property struct
struct Property {
string key;
pallets/nonfungible/src/stubs/UniqueNFT.rawdiffbeforeafterbothbinary blob — no preview
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -42,18 +42,19 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple48[] memory permissions) public {
+ function setTokenPropertyPermissions(Tuple59[] memory permissions) public {
require(false, stub_error);
permissions;
dummy = 0;
}
+ /// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() public view returns (Tuple48[] memory) {
+ function tokenPropertyPermissions() public view returns (Tuple59[] memory) {
require(false, stub_error);
dummy;
- return new Tuple48[](0);
+ return new Tuple59[](0);
}
// /// @notice Set token property value.
@@ -132,26 +133,30 @@
bytes value;
}
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum EthTokenPermissions {
+ /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
+ /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
+ /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
/// @dev anonymous struct
-struct Tuple48 {
+struct Tuple59 {
string field_0;
- Tuple46[] field_1;
+ Tuple57[] field_1;
}
/// @dev anonymous struct
-struct Tuple46 {
+struct Tuple57 {
EthTokenPermissions field_0;
bool field_1;
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+/// @dev the ERC-165 identifier for this interface is 0x81172a75
contract Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -291,6 +296,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:
@@ -303,12 +329,18 @@
/// "ownerCanTransfer",
/// "ownerCanDestroy",
/// "transfersEnabled"
+ /// @param status enable\disable limit. Works only with `true`.
/// @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;
}
@@ -390,19 +422,19 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() public view returns (Tuple34 memory) {
+ function collectionNestingRestrictedCollectionIds() public view returns (Tuple39 memory) {
require(false, stub_error);
dummy;
- return Tuple34(false, new uint256[](0));
+ return Tuple39(false, new uint256[](0));
}
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() public view returns (Tuple37[] memory) {
+ function collectionNestingPermissions() public view returns (Tuple42[] memory) {
require(false, stub_error);
dummy;
- return new Tuple37[](0);
+ return new Tuple42[](0);
}
/// Set the collection access method.
@@ -582,17 +614,46 @@
}
/// @dev anonymous struct
-struct Tuple37 {
+struct Tuple42 {
CollectionPermissions field_0;
bool field_1;
}
/// @dev anonymous struct
-struct Tuple34 {
+struct Tuple39 {
bool field_0;
uint256[] field_1;
}
+/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+enum CollectionLimits {
+ /// @dev How many tokens can a user have on one account.
+ AccountTokenOwnership,
+ /// @dev How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// @dev How many tokens can be mined into this collection.
+ TokenLimit,
+ /// @dev Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// @dev Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// @dev Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// @dev Is it possible to send tokens from this collection between users.
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple33 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev anonymous struct
struct Tuple30 {
address field_0;
pallets/refungible/src/stubs/UniqueRefungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -42,7 +42,7 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple53[] memory permissions) public {
+ function setTokenPropertyPermissions(Tuple58[] memory permissions) public {
require(false, stub_error);
permissions;
dummy = 0;
@@ -51,10 +51,10 @@
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() public view returns (Tuple53[] memory) {
+ function tokenPropertyPermissions() public view returns (Tuple58[] memory) {
require(false, stub_error);
dummy;
- return new Tuple53[](0);
+ return new Tuple58[](0);
}
// /// @notice Set token property value.
@@ -133,26 +133,30 @@
bytes value;
}
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum EthTokenPermissions {
+ /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
+ /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
+ /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
/// @dev anonymous struct
-struct Tuple53 {
+struct Tuple58 {
string field_0;
- Tuple51[] field_1;
+ Tuple56[] field_1;
}
/// @dev anonymous struct
-struct Tuple51 {
+struct Tuple56 {
EthTokenPermissions field_0;
bool field_1;
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+/// @dev the ERC-165 identifier for this interface is 0x81172a75
contract Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -292,6 +296,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:
@@ -304,12 +329,18 @@
/// "ownerCanTransfer",
/// "ownerCanDestroy",
/// "transfersEnabled"
+ /// @param status enable\disable limit. Works only with `true`.
/// @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;
}
@@ -391,19 +422,19 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() public view returns (Tuple33 memory) {
+ function collectionNestingRestrictedCollectionIds() public view returns (Tuple38 memory) {
require(false, stub_error);
dummy;
- return Tuple33(false, new uint256[](0));
+ return Tuple38(false, new uint256[](0));
}
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() public view returns (Tuple36[] memory) {
+ function collectionNestingPermissions() public view returns (Tuple41[] memory) {
require(false, stub_error);
dummy;
- return new Tuple36[](0);
+ return new Tuple41[](0);
}
/// Set the collection access method.
@@ -583,17 +614,46 @@
}
/// @dev anonymous struct
-struct Tuple36 {
+struct Tuple41 {
CollectionPermissions field_0;
bool field_1;
}
/// @dev anonymous struct
-struct Tuple33 {
+struct Tuple38 {
bool field_0;
uint256[] field_1;
}
+/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+enum CollectionLimits {
+ /// @dev How many tokens can a user have on one account.
+ AccountTokenOwnership,
+ /// @dev How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// @dev How many tokens can be mined into this collection.
+ TokenLimit,
+ /// @dev Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// @dev Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// @dev Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// @dev Is it possible to send tokens from this collection between users.
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple32 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev anonymous struct
struct Tuple29 {
address field_0;
tests/src/eth/abi/fungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/fungible.json
+++ b/tests/src/eth/abi/fungible.json
@@ -208,6 +208,28 @@
},
{
"inputs": [],
+ "name": "collectionLimits",
+ "outputs": [
+ {
+ "components": [
+ {
+ "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[]",
+ "name": "",
+ "type": "tuple[]"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [],
"name": "collectionNestingPermissions",
"outputs": [
{
@@ -219,7 +241,7 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple24[]",
+ "internalType": "struct Tuple29[]",
"name": "",
"type": "tuple[]"
}
@@ -240,7 +262,7 @@
"type": "uint256[]"
}
],
- "internalType": "struct Tuple21",
+ "internalType": "struct Tuple26",
"name": "",
"type": "tuple"
}
@@ -453,7 +475,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
@@ -238,6 +238,28 @@
},
{
"inputs": [],
+ "name": "collectionLimits",
+ "outputs": [
+ {
+ "components": [
+ {
+ "internalType": "enum CollectionLimits",
+ "name": "field_0",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "field_1", "type": "bool" },
+ { "internalType": "uint256", "name": "field_2", "type": "uint256" }
+ ],
+ "internalType": "struct Tuple33[]",
+ "name": "",
+ "type": "tuple[]"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [],
"name": "collectionNestingPermissions",
"outputs": [
{
@@ -249,7 +271,7 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple37[]",
+ "internalType": "struct Tuple42[]",
"name": "",
"type": "tuple[]"
}
@@ -270,7 +292,7 @@
"type": "uint256[]"
}
],
- "internalType": "struct Tuple34",
+ "internalType": "struct Tuple39",
"name": "",
"type": "tuple"
}
@@ -607,7 +629,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",
@@ -709,12 +736,12 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple46[]",
+ "internalType": "struct Tuple57[]",
"name": "field_1",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple48[]",
+ "internalType": "struct Tuple59[]",
"name": "permissions",
"type": "tuple[]"
}
@@ -775,12 +802,12 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple46[]",
+ "internalType": "struct Tuple57[]",
"name": "field_1",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple48[]",
+ "internalType": "struct Tuple59[]",
"name": "",
"type": "tuple[]"
}
tests/src/eth/abi/reFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungible.json
+++ b/tests/src/eth/abi/reFungible.json
@@ -220,6 +220,28 @@
},
{
"inputs": [],
+ "name": "collectionLimits",
+ "outputs": [
+ {
+ "components": [
+ {
+ "internalType": "enum CollectionLimits",
+ "name": "field_0",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "field_1", "type": "bool" },
+ { "internalType": "uint256", "name": "field_2", "type": "uint256" }
+ ],
+ "internalType": "struct Tuple32[]",
+ "name": "",
+ "type": "tuple[]"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [],
"name": "collectionNestingPermissions",
"outputs": [
{
@@ -231,7 +253,7 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple36[]",
+ "internalType": "struct Tuple41[]",
"name": "",
"type": "tuple[]"
}
@@ -252,7 +274,7 @@
"type": "uint256[]"
}
],
- "internalType": "struct Tuple33",
+ "internalType": "struct Tuple38",
"name": "",
"type": "tuple"
}
@@ -589,7 +611,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",
@@ -691,12 +718,12 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple51[]",
+ "internalType": "struct Tuple56[]",
"name": "field_1",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple53[]",
+ "internalType": "struct Tuple58[]",
"name": "permissions",
"type": "tuple[]"
}
@@ -766,12 +793,12 @@
},
{ "internalType": "bool", "name": "field_1", "type": "bool" }
],
- "internalType": "struct Tuple51[]",
+ "internalType": "struct Tuple56[]",
"name": "field_1",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple53[]",
+ "internalType": "struct Tuple58[]",
"name": "",
"type": "tuple[]"
}
tests/src/eth/api/UniqueFungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueFungible.sol
+++ b/tests/src/eth/api/UniqueFungible.sol
@@ -13,7 +13,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+/// @dev the ERC-165 identifier for this interface is 0x81172a75
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -104,6 +104,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:
@@ -116,10 +133,15 @@
/// "ownerCanTransfer",
/// "ownerCanDestroy",
/// "transfersEnabled"
+ /// @param status enable\disable limit. Works only with `true`.
/// @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,
@@ -169,12 +191,12 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() external view returns (Tuple20 memory);
+ function collectionNestingRestrictedCollectionIds() external view returns (Tuple24 memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() external view returns (Tuple23[] memory);
+ function collectionNestingPermissions() external view returns (Tuple27[] memory);
/// Set the collection access method.
/// @param mode Access mode
@@ -289,7 +311,7 @@
}
/// @dev anonymous struct
-struct Tuple23 {
+struct Tuple27 {
CollectionPermissions field_0;
bool field_1;
}
@@ -300,11 +322,40 @@
}
/// @dev anonymous struct
-struct Tuple20 {
+struct Tuple24 {
bool field_0;
uint256[] field_1;
}
+/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+enum CollectionLimits {
+ /// @dev How many tokens can a user have on one account.
+ AccountTokenOwnership,
+ /// @dev How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// @dev How many tokens can be mined into this collection.
+ TokenLimit,
+ /// @dev Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// @dev Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// @dev Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// @dev Is it possible to send tokens from this collection between users.
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple19 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev Property struct
struct Property {
string key;
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -30,11 +30,12 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple43[] memory permissions) external;
+ function setTokenPropertyPermissions(Tuple52[] memory permissions) external;
+ /// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() external view returns (Tuple43[] memory);
+ function tokenPropertyPermissions() external view returns (Tuple52[] memory);
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
@@ -85,26 +86,30 @@
bytes value;
}
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum EthTokenPermissions {
+ /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
+ /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
+ /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
/// @dev anonymous struct
-struct Tuple43 {
+struct Tuple52 {
string field_0;
- Tuple41[] field_1;
+ Tuple50[] field_1;
}
/// @dev anonymous struct
-struct Tuple41 {
+struct Tuple50 {
EthTokenPermissions field_0;
bool field_1;
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+/// @dev the ERC-165 identifier for this interface is 0x81172a75
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -195,6 +200,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:
@@ -207,10 +229,15 @@
/// "ownerCanTransfer",
/// "ownerCanDestroy",
/// "transfersEnabled"
+ /// @param status enable\disable limit. Works only with `true`.
/// @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,
@@ -260,12 +287,12 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() external view returns (Tuple31 memory);
+ function collectionNestingRestrictedCollectionIds() external view returns (Tuple35 memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() external view returns (Tuple34[] memory);
+ function collectionNestingPermissions() external view returns (Tuple38[] memory);
/// Set the collection access method.
/// @param mode Access mode
@@ -380,7 +407,7 @@
}
/// @dev anonymous struct
-struct Tuple34 {
+struct Tuple38 {
CollectionPermissions field_0;
bool field_1;
}
@@ -391,11 +418,40 @@
}
/// @dev anonymous struct
-struct Tuple31 {
+struct Tuple35 {
bool field_0;
uint256[] field_1;
}
+/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+enum CollectionLimits {
+ /// @dev How many tokens can a user have on one account.
+ AccountTokenOwnership,
+ /// @dev How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// @dev How many tokens can be mined into this collection.
+ TokenLimit,
+ /// @dev Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// @dev Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// @dev Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// @dev Is it possible to send tokens from this collection between users.
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple30 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev anonymous struct
struct Tuple27 {
address field_0;
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -30,12 +30,12 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple47[] memory permissions) external;
+ function setTokenPropertyPermissions(Tuple51[] memory permissions) external;
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() external view returns (Tuple47[] memory);
+ function tokenPropertyPermissions() external view returns (Tuple51[] memory);
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
@@ -86,26 +86,30 @@
bytes value;
}
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum EthTokenPermissions {
+ /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
+ /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
+ /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
/// @dev anonymous struct
-struct Tuple47 {
+struct Tuple51 {
string field_0;
- Tuple45[] field_1;
+ Tuple49[] field_1;
}
/// @dev anonymous struct
-struct Tuple45 {
+struct Tuple49 {
EthTokenPermissions field_0;
bool field_1;
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
+/// @dev the ERC-165 identifier for this interface is 0x81172a75
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:
@@ -208,10 +229,15 @@
/// "ownerCanTransfer",
/// "ownerCanDestroy",
/// "transfersEnabled"
+ /// @param status enable\disable limit. Works only with `true`.
/// @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,
@@ -261,12 +287,12 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() external view returns (Tuple30 memory);
+ function collectionNestingRestrictedCollectionIds() external view returns (Tuple34 memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() external view returns (Tuple33[] memory);
+ function collectionNestingPermissions() external view returns (Tuple37[] memory);
/// Set the collection access method.
/// @param mode Access mode
@@ -381,7 +407,7 @@
}
/// @dev anonymous struct
-struct Tuple33 {
+struct Tuple37 {
CollectionPermissions field_0;
bool field_1;
}
@@ -392,11 +418,40 @@
}
/// @dev anonymous struct
-struct Tuple30 {
+struct Tuple34 {
bool field_0;
uint256[] field_1;
}
+/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+enum CollectionLimits {
+ /// @dev How many tokens can a user have on one account.
+ AccountTokenOwnership,
+ /// @dev How many bytes of data are available for sponsorship.
+ SponsoredDataSize,
+ /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ SponsoredDataRateLimit,
+ /// @dev How many tokens can be mined into this collection.
+ TokenLimit,
+ /// @dev Timeouts for transfer sponsoring.
+ SponsorTransferTimeout,
+ /// @dev Timeout for sponsoring an approval in passed blocks.
+ SponsorApproveTimeout,
+ /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ OwnerCanTransfer,
+ /// @dev Can the collection owner burn other people's tokens.
+ OwnerCanDestroy,
+ /// @dev Is it possible to send tokens from this collection between users.
+ TransferEnabled
+}
+
+/// @dev anonymous struct
+struct Tuple29 {
+ CollectionLimits field_0;
+ bool field_1;
+ uint256 field_2;
+}
+
/// @dev anonymous struct
struct Tuple26 {
address field_0;
tests/src/eth/collectionLimits.test.tsdiffbeforeafterboth--- a/tests/src/eth/collectionLimits.test.ts
+++ b/tests/src/eth/collectionLimits.test.ts
@@ -1,6 +1,7 @@
import {IKeyringPair} from '@polkadot/types/types';
import {Pallets} from '../util';
import {expect, itEth, usingEthPlaygrounds} from './util';
+import {CollectionLimits} from './util/playgrounds/types';
describe('Can set collection limits', () => {
@@ -44,20 +45,33 @@
transfersEnabled: false,
};
- const collection = helper.ethNativeContract.collection(collectionAddress, testCase.case, owner);
- await collection.methods.setCollectionLimit('accountTokenOwnershipLimit', limits.accountTokenOwnershipLimit).send();
- await collection.methods.setCollectionLimit('sponsoredDataSize', limits.sponsoredDataSize).send();
- await collection.methods.setCollectionLimit('sponsoredDataRateLimit', limits.sponsoredDataRateLimit).send();
- await collection.methods.setCollectionLimit('tokenLimit', limits.tokenLimit).send();
- await collection.methods.setCollectionLimit('sponsorTransferTimeout', limits.sponsorTransferTimeout).send();
- await collection.methods.setCollectionLimit('sponsorApproveTimeout', limits.sponsorApproveTimeout).send();
- await collection.methods.setCollectionLimit('ownerCanTransfer', limits.ownerCanTransfer).send();
- await collection.methods.setCollectionLimit('ownerCanDestroy', limits.ownerCanDestroy).send();
- await collection.methods.setCollectionLimit('transfersEnabled', limits.transfersEnabled).send();
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, testCase.case, owner);
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, limits.accountTokenOwnershipLimit).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsoredDataSize, true, limits.sponsoredDataSize).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsoredDataRateLimit, true, limits.sponsoredDataRateLimit).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.TokenLimit, true, limits.tokenLimit).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsorTransferTimeout, true, limits.sponsorTransferTimeout).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsorApproveTimeout, true, limits.sponsorApproveTimeout).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, limits.ownerCanTransfer).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.OwnerCanDestroy, true, limits.ownerCanDestroy).send();
+ await collectionEvm.methods.setCollectionLimit(CollectionLimits.TransferEnabled, true, limits.transfersEnabled).send();
+ // Check limits from sub:
const data = (await helper.rft.getData(collectionId))!;
expect(data.raw.limits).to.deep.eq(expectedLimits);
expect(await helper.collection.getEffectiveLimits(collectionId)).to.deep.eq(expectedLimits);
+ // Check limits from eth:
+ const limitsEvm = await collectionEvm.methods.collectionLimits().call({from: owner});
+ expect(limitsEvm).to.have.length(9);
+ expect(limitsEvm[0]).to.deep.eq([CollectionLimits.AccountTokenOwnership.toString(), true, limits.accountTokenOwnershipLimit.toString()]);
+ expect(limitsEvm[1]).to.deep.eq([CollectionLimits.SponsoredDataSize.toString(), true, limits.sponsoredDataSize.toString()]);
+ expect(limitsEvm[2]).to.deep.eq([CollectionLimits.SponsoredDataRateLimit.toString(), true, limits.sponsoredDataRateLimit.toString()]);
+ expect(limitsEvm[3]).to.deep.eq([CollectionLimits.TokenLimit.toString(), true, limits.tokenLimit.toString()]);
+ expect(limitsEvm[4]).to.deep.eq([CollectionLimits.SponsorTransferTimeout.toString(), true, limits.sponsorTransferTimeout.toString()]);
+ expect(limitsEvm[5]).to.deep.eq([CollectionLimits.SponsorApproveTimeout.toString(), true, limits.sponsorApproveTimeout.toString()]);
+ expect(limitsEvm[6]).to.deep.eq([CollectionLimits.OwnerCanTransfer.toString(), true, limits.ownerCanTransfer.toString()]);
+ expect(limitsEvm[7]).to.deep.eq([CollectionLimits.OwnerCanDestroy.toString(), true, limits.ownerCanDestroy.toString()]);
+ expect(limitsEvm[8]).to.deep.eq([CollectionLimits.TransferEnabled.toString(), true, limits.transfersEnabled.toString()]);
}));
});
@@ -84,17 +98,48 @@
const owner = await helper.eth.createAccountWithBalance(donor);
const {collectionAddress} = await helper.eth.createCollection(testCase.case, owner, 'Limits', 'absolutely anything', 'ISNI', 18);
const collectionEvm = helper.ethNativeContract.collection(collectionAddress, testCase.case, owner);
+
+ // Cannot set non-existing limit
await expect(collectionEvm.methods
- .setCollectionLimit('badLimit', '1')
- .call()).to.be.rejectedWith('unknown limit "badLimit"');
-
+ .setCollectionLimit(9, true, 1)
+ .call()).to.be.rejectedWith('Returned error: VM Exception while processing transaction: revert Value not convertible into enum "CollectionLimits"');
+
+ // Cannot disable limits
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, false, 200)
+ .call()).to.be.rejectedWith('Returned error: VM Exception while processing transaction: revert user can\'t disable limits');
+
await expect(collectionEvm.methods
- .setCollectionLimit(Object.keys(invalidLimits)[0], invalidLimits.accountTokenOwnershipLimit)
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, invalidLimits.accountTokenOwnershipLimit)
.call()).to.be.rejectedWith(`can't convert value to u32 "${invalidLimits.accountTokenOwnershipLimit}"`);
-
+
await expect(collectionEvm.methods
- .setCollectionLimit(Object.keys(invalidLimits)[1], invalidLimits.transfersEnabled)
+ .setCollectionLimit(CollectionLimits.TransferEnabled, true, 3)
.call()).to.be.rejectedWith(`can't convert value to boolean "${invalidLimits.transfersEnabled}"`);
+
+ expect(() => collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.SponsoredDataSize, true, -1).send()).to.throw('value out-of-bounds');
}));
+
+ [
+ {case: 'nft' as const, requiredPallets: []},
+ {case: 'rft' as const, requiredPallets: [Pallets.ReFungible]},
+ {case: 'ft' as const, requiredPallets: []},
+ ].map(testCase =>
+ itEth.ifWithPallets(`Non-owner and non-admin cannot set collection limits for ${testCase.case}`, testCase.requiredPallets || [], async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const nonOwner = await helper.eth.createAccountWithBalance(donor);
+ const {collectionAddress} = await helper.eth.createCollection(testCase.case, owner, 'Limits', 'absolutely anything', 'FLO', 18);
+
+ const collectionEvm = helper.ethNativeContract.collection(collectionAddress, testCase.case, owner);
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .call({from: nonOwner}))
+ .to.be.rejectedWith('NoPermission');
+
+ await expect(collectionEvm.methods
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .send({from: nonOwner}))
+ .to.be.rejected;
+ }));
});
-
\ No newline at end of file
tests/src/eth/createFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createFTCollection.test.ts
+++ b/tests/src/eth/createFTCollection.test.ts
@@ -18,6 +18,7 @@
import {evmToAddress} from '@polkadot/util-crypto';
import {Pallets, requirePalletsOrSkip} from '../util';
import {expect, itEth, usingEthPlaygrounds} from './util';
+import { CollectionLimits } from './util/playgrounds/types';
const DECIMALS = 18;
@@ -196,7 +197,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -221,7 +222,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
tests/src/eth/createNFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createNFTCollection.test.ts
+++ b/tests/src/eth/createNFTCollection.test.ts
@@ -17,6 +17,7 @@
import {evmToAddress} from '@polkadot/util-crypto';
import {IKeyringPair} from '@polkadot/types/types';
import {expect, itEth, usingEthPlaygrounds} from './util';
+import { CollectionLimits } from './util/playgrounds/types';
describe('Create NFT collection from EVM', () => {
@@ -207,7 +208,7 @@
}
{
await expect(malfeasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -232,7 +233,7 @@
}
{
await expect(malfeasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
tests/src/eth/createRFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createRFTCollection.test.ts
+++ b/tests/src/eth/createRFTCollection.test.ts
@@ -18,6 +18,7 @@
import {IKeyringPair} from '@polkadot/types/types';
import {Pallets, requirePalletsOrSkip} from '../util';
import {expect, itEth, usingEthPlaygrounds} from './util';
+import {CollectionLimits} from './util/playgrounds/types';
describe('Create RFT collection from EVM', () => {
@@ -239,7 +240,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -264,7 +265,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit('accountTokenOwnershipLimit', '1000')
+ .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
tests/src/eth/events.test.tsdiffbeforeafterboth--- a/tests/src/eth/events.test.ts
+++ b/tests/src/eth/events.test.ts
@@ -19,7 +19,7 @@
import {EthUniqueHelper, itEth, usingEthPlaygrounds} from './util';
import {IEvent, TCollectionMode} from '../util/playgrounds/types';
import {Pallets, requirePalletsOrSkip} from '../util';
-import {EthTokenPermissions, NormalizedEvent} from './util/playgrounds/types';
+import {CollectionLimits, EthTokenPermissions, NormalizedEvent} from './util/playgrounds/types';
let donor: IKeyringPair;
@@ -234,7 +234,7 @@
});
const {unsubscribe, collectedEvents: subEvents} = await helper.subscribeEvents([{section: 'common', names: ['CollectionLimitSet']}]);
{
- await collection.methods.setCollectionLimit('ownerCanTransfer', 0n).send({from: owner});
+ await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, 0).send({from: owner});
await helper.wait.newBlocks(1);
expect(ethEvents).to.be.like([
{
tests/src/eth/util/playgrounds/types.tsdiffbeforeafterboth--- a/tests/src/eth/util/playgrounds/types.ts
+++ b/tests/src/eth/util/playgrounds/types.ts
@@ -24,4 +24,15 @@
Mutable,
TokenOwner,
CollectionAdmin
-}
\ No newline at end of file
+}
+export enum CollectionLimits {
+ AccountTokenOwnership,
+ SponsoredDataSize,
+ SponsoredDataRateLimit,
+ TokenLimit,
+ SponsorTransferTimeout,
+ SponsorApproveTimeout,
+ OwnerCanTransfer,
+ OwnerCanDestroy,
+ TransferEnabled
+}
tests/src/pallet-presence.test.tsdiffbeforeafterboth--- a/tests/src/pallet-presence.test.ts
+++ b/tests/src/pallet-presence.test.ts
@@ -84,6 +84,7 @@
);
} else if (chain.eq('UNIQUE')) {
// Insert Unique additional pallets here
+ requiredPallets.push(foreignAssets);
}
});
});