difftreelog
refacator: Move Property from evm_codet into pallet_common and derive AbiCoder
in: master
6 files changed
crates/evm-coder/src/abi/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/abi/impls.rs
+++ b/crates/evm-coder/src/abi/impls.rs
@@ -138,42 +138,6 @@
}
}
-impl sealed::CanBePlacedInVec for Property {}
-
-impl AbiType for Property {
- const SIGNATURE: SignatureUnit = make_signature!(new fixed("(string,bytes)"));
- const FIELDS_COUNT: usize = 2;
-
- fn is_dynamic() -> bool {
- string::is_dynamic() || bytes::is_dynamic()
- }
-
- fn size() -> usize {
- <string as AbiType>::size() + <bytes as AbiType>::size()
- }
-}
-
-impl AbiRead for Property {
- fn abi_read(reader: &mut AbiReader) -> Result<Property> {
- let size = if !Property::is_dynamic() {
- Some(<Property as AbiType>::size())
- } else {
- None
- };
- let mut subresult = reader.subresult(size)?;
- let key = <string>::abi_read(&mut subresult)?;
- let value = <bytes>::abi_read(&mut subresult)?;
-
- Ok(Property { key, value })
- }
-}
-
-impl AbiWrite for Property {
- fn abi_write(&self, writer: &mut AbiWriter) {
- (&self.key, &self.value).abi_write(writer);
- }
-}
-
impl<T: AbiWrite + AbiType> AbiWrite for Vec<T> {
fn abi_write(&self, writer: &mut AbiWriter) {
let is_dynamic = T::is_dynamic();
crates/evm-coder/src/lib.rsdiffbeforeafterboth--- a/crates/evm-coder/src/lib.rs
+++ b/crates/evm-coder/src/lib.rs
@@ -196,12 +196,6 @@
self.len() == 0
}
}
-
- #[derive(Debug, Default)]
- pub struct Property {
- pub key: string,
- pub value: bytes,
- }
}
/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro
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, 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<EthCrossAccount> {293 let sponsor = match self.collection.sponsorship.sponsor() {294 Some(sponsor) => sponsor,295 None => return Ok(Default::default()),296 };297298 Ok(EthCrossAccount::from_sub::<T>(&sponsor))299 }300301 /// Get current collection limits.302 ///303 /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:304 /// "accountTokenOwnershipLimit",305 /// "sponsoredDataSize",306 /// "sponsoredDataRateLimit",307 /// "tokenLimit",308 /// "sponsorTransferTimeout",309 /// "sponsorApproveTimeout"310 /// "ownerCanTransfer",311 /// "ownerCanDestroy",312 /// "transfersEnabled"313 /// Return `false` if a limit not set.314 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {315 let convert_value_limit = |limit: EvmCollectionLimits,316 value: Option<u32>|317 -> (EvmCollectionLimits, bool, uint256) {318 value319 .map(|v| (limit, true, v.into()))320 .unwrap_or((limit, false, Default::default()))321 };322323 let convert_bool_limit = |limit: EvmCollectionLimits,324 value: Option<bool>|325 -> (EvmCollectionLimits, bool, uint256) {326 value327 .map(|v| {328 (329 limit,330 true,331 if v {332 uint256::from(1)333 } else {334 Default::default()335 },336 )337 })338 .unwrap_or((limit, false, Default::default()))339 };340341 let limits = &self.collection.limits;342343 Ok(vec![344 convert_value_limit(345 EvmCollectionLimits::AccountTokenOwnership,346 limits.account_token_ownership_limit,347 ),348 convert_value_limit(349 EvmCollectionLimits::SponsoredDataSize,350 limits.sponsored_data_size,351 ),352 limits353 .sponsored_data_rate_limit354 .and_then(|limit| {355 if let SponsoringRateLimit::Blocks(blocks) = limit {356 Some((357 EvmCollectionLimits::SponsoredDataRateLimit,358 true,359 blocks.into(),360 ))361 } else {362 None363 }364 })365 .unwrap_or((366 EvmCollectionLimits::SponsoredDataRateLimit,367 false,368 Default::default(),369 )),370 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),371 convert_value_limit(372 EvmCollectionLimits::SponsorTransferTimeout,373 limits.sponsor_transfer_timeout,374 ),375 convert_value_limit(376 EvmCollectionLimits::SponsorApproveTimeout,377 limits.sponsor_approve_timeout,378 ),379 convert_bool_limit(380 EvmCollectionLimits::OwnerCanTransfer,381 limits.owner_can_transfer,382 ),383 convert_bool_limit(384 EvmCollectionLimits::OwnerCanDestroy,385 limits.owner_can_destroy,386 ),387 convert_bool_limit(388 EvmCollectionLimits::TransferEnabled,389 limits.transfers_enabled,390 ),391 ])392 }393394 /// Set limits for the collection.395 /// @dev Throws error if limit not found.396 /// @param limit Name of the limit. Valid names:397 /// "accountTokenOwnershipLimit",398 /// "sponsoredDataSize",399 /// "sponsoredDataRateLimit",400 /// "tokenLimit",401 /// "sponsorTransferTimeout",402 /// "sponsorApproveTimeout"403 /// "ownerCanTransfer",404 /// "ownerCanDestroy",405 /// "transfersEnabled"406 /// @param status enable\disable limit. Works only with `true`.407 /// @param value Value of the limit.408 #[solidity(rename_selector = "setCollectionLimit")]409 fn set_collection_limit(410 &mut self,411 caller: caller,412 limit: EvmCollectionLimits,413 status: bool,414 value: uint256,415 ) -> Result<void> {416 self.consume_store_reads_and_writes(1, 1)?;417418 if !status {419 return Err(Error::Revert("user can't disable limits".into()));420 }421422 let value = value423 .try_into()424 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;425426 let convert_value_to_bool = || match value {427 0 => Ok(false),428 1 => Ok(true),429 _ => {430 return Err(Error::Revert(format!(431 "can't convert value to boolean \"{}\"",432 value433 )))434 }435 };436437 let mut limits = self.limits.clone();438439 match limit {440 EvmCollectionLimits::AccountTokenOwnership => {441 limits.account_token_ownership_limit = Some(value);442 }443 EvmCollectionLimits::SponsoredDataSize => {444 limits.sponsored_data_size = Some(value);445 }446 EvmCollectionLimits::SponsoredDataRateLimit => {447 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));448 }449 EvmCollectionLimits::TokenLimit => {450 limits.token_limit = Some(value);451 }452 EvmCollectionLimits::SponsorTransferTimeout => {453 limits.sponsor_transfer_timeout = Some(value);454 }455 EvmCollectionLimits::SponsorApproveTimeout => {456 limits.sponsor_approve_timeout = Some(value);457 }458 EvmCollectionLimits::OwnerCanTransfer => {459 limits.owner_can_transfer = Some(convert_value_to_bool()?);460 }461 EvmCollectionLimits::OwnerCanDestroy => {462 limits.owner_can_destroy = Some(convert_value_to_bool()?);463 }464 EvmCollectionLimits::TransferEnabled => {465 limits.transfers_enabled = Some(convert_value_to_bool()?);466 }467 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),468 }469470 let caller = T::CrossAccountId::from_eth(caller);471 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)472 }473474 /// Get contract address.475 fn contract_address(&self) -> Result<address> {476 Ok(crate::eth::collection_id_to_address(self.id))477 }478479 /// Add collection admin.480 /// @param newAdmin Cross account administrator address.481 fn add_collection_admin_cross(482 &mut self,483 caller: caller,484 new_admin: EthCrossAccount,485 ) -> Result<void> {486 self.consume_store_reads_and_writes(2, 2)?;487488 let caller = T::CrossAccountId::from_eth(caller);489 let new_admin = new_admin.into_sub_cross_account::<T>()?;490 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;491 Ok(())492 }493494 /// Remove collection admin.495 /// @param admin Cross account administrator address.496 fn remove_collection_admin_cross(497 &mut self,498 caller: caller,499 admin: EthCrossAccount,500 ) -> Result<void> {501 self.consume_store_reads_and_writes(2, 2)?;502503 let caller = T::CrossAccountId::from_eth(caller);504 let admin = admin.into_sub_cross_account::<T>()?;505 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;506 Ok(())507 }508509 /// Add collection admin.510 /// @param newAdmin Address of the added administrator.511 #[solidity(hide)]512 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {513 self.consume_store_reads_and_writes(2, 2)?;514515 let caller = T::CrossAccountId::from_eth(caller);516 let new_admin = T::CrossAccountId::from_eth(new_admin);517 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;518 Ok(())519 }520521 /// Remove collection admin.522 ///523 /// @param admin Address of the removed administrator.524 #[solidity(hide)]525 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {526 self.consume_store_reads_and_writes(2, 2)?;527528 let caller = T::CrossAccountId::from_eth(caller);529 let admin = T::CrossAccountId::from_eth(admin);530 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;531 Ok(())532 }533534 /// Toggle accessibility of collection nesting.535 ///536 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'537 #[solidity(rename_selector = "setCollectionNesting")]538 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {539 self.consume_store_reads_and_writes(1, 1)?;540541 let caller = T::CrossAccountId::from_eth(caller);542543 let mut permissions = self.collection.permissions.clone();544 let mut nesting = permissions.nesting().clone();545 nesting.token_owner = enable;546 nesting.restricted = None;547 permissions.nesting = Some(nesting);548549 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)550 }551552 /// Toggle accessibility of collection nesting.553 ///554 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'555 /// @param collections Addresses of collections that will be available for nesting.556 #[solidity(rename_selector = "setCollectionNesting")]557 fn set_nesting(558 &mut self,559 caller: caller,560 enable: bool,561 collections: Vec<address>,562 ) -> Result<void> {563 self.consume_store_reads_and_writes(1, 1)?;564565 if collections.is_empty() {566 return Err("no addresses provided".into());567 }568 let caller = T::CrossAccountId::from_eth(caller);569570 let mut permissions = self.collection.permissions.clone();571 match enable {572 false => {573 let mut nesting = permissions.nesting().clone();574 nesting.token_owner = false;575 nesting.restricted = None;576 permissions.nesting = Some(nesting);577 }578 true => {579 let mut bv = OwnerRestrictedSet::new();580 for i in collections {581 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {582 Error::Revert("Can't convert address into collection id".into())583 })?)584 .map_err(|_| "too many collections")?;585 }586 let mut nesting = permissions.nesting().clone();587 nesting.token_owner = true;588 nesting.restricted = Some(bv);589 permissions.nesting = Some(nesting);590 }591 };592593 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)594 }595596 /// Returns nesting for a collection597 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]598 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {599 let nesting = self.collection.permissions.nesting();600601 Ok((602 nesting.token_owner,603 nesting604 .restricted605 .clone()606 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())607 .unwrap_or_default(),608 ))609 }610611 /// Returns permissions for a collection612 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {613 let nesting = self.collection.permissions.nesting();614 Ok(vec![615 (EvmPermissions::CollectionAdmin, nesting.collection_admin),616 (EvmPermissions::TokenOwner, nesting.token_owner),617 ])618 }619 /// Set the collection access method.620 /// @param mode Access mode621 /// 0 for Normal622 /// 1 for AllowList623 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {624 self.consume_store_reads_and_writes(1, 1)?;625626 let caller = T::CrossAccountId::from_eth(caller);627 let permissions = CollectionPermissions {628 access: Some(match mode {629 0 => AccessMode::Normal,630 1 => AccessMode::AllowList,631 _ => return Err("not supported access mode".into()),632 }),633 ..Default::default()634 };635 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)636 }637638 /// Checks that user allowed to operate with collection.639 ///640 /// @param user User address to check.641 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {642 let user = user.into_sub_cross_account::<T>()?;643 Ok(Pallet::<T>::allowed(self.id, user))644 }645646 /// Add the user to the allowed list.647 ///648 /// @param user Address of a trusted user.649 #[solidity(hide)]650 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {651 self.consume_store_writes(1)?;652653 let caller = T::CrossAccountId::from_eth(caller);654 let user = T::CrossAccountId::from_eth(user);655 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;656 Ok(())657 }658659 /// Add user to allowed list.660 ///661 /// @param user User cross account address.662 fn add_to_collection_allow_list_cross(663 &mut self,664 caller: caller,665 user: EthCrossAccount,666 ) -> Result<void> {667 self.consume_store_writes(1)?;668669 let caller = T::CrossAccountId::from_eth(caller);670 let user = user.into_sub_cross_account::<T>()?;671 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;672 Ok(())673 }674675 /// Remove the user from the allowed list.676 ///677 /// @param user Address of a removed user.678 #[solidity(hide)]679 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {680 self.consume_store_writes(1)?;681682 let caller = T::CrossAccountId::from_eth(caller);683 let user = T::CrossAccountId::from_eth(user);684 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;685 Ok(())686 }687688 /// Remove user from allowed list.689 ///690 /// @param user User cross account address.691 fn remove_from_collection_allow_list_cross(692 &mut self,693 caller: caller,694 user: EthCrossAccount,695 ) -> Result<void> {696 self.consume_store_writes(1)?;697698 let caller = T::CrossAccountId::from_eth(caller);699 let user = user.into_sub_cross_account::<T>()?;700 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;701 Ok(())702 }703704 /// Switch permission for minting.705 ///706 /// @param mode Enable if "true".707 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {708 self.consume_store_reads_and_writes(1, 1)?;709710 let caller = T::CrossAccountId::from_eth(caller);711 let permissions = CollectionPermissions {712 mint_mode: Some(mode),713 ..Default::default()714 };715 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)716 }717718 /// Check that account is the owner or admin of the collection719 ///720 /// @param user account to verify721 /// @return "true" if account is the owner or admin722 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]723 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {724 let user = T::CrossAccountId::from_eth(user);725 Ok(self.is_owner_or_admin(&user))726 }727728 /// Check that account is the owner or admin of the collection729 ///730 /// @param user User cross account to verify731 /// @return "true" if account is the owner or admin732 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {733 let user = user.into_sub_cross_account::<T>()?;734 Ok(self.is_owner_or_admin(&user))735 }736737 /// Returns collection type738 ///739 /// @return `Fungible` or `NFT` or `ReFungible`740 fn unique_collection_type(&self) -> Result<string> {741 let mode = match self.collection.mode {742 CollectionMode::Fungible(_) => "Fungible",743 CollectionMode::NFT => "NFT",744 CollectionMode::ReFungible => "ReFungible",745 };746 Ok(mode.into())747 }748749 /// Get collection owner.750 ///751 /// @return Tuble with sponsor address and his substrate mirror.752 /// If address is canonical then substrate mirror is zero and vice versa.753 fn collection_owner(&self) -> Result<EthCrossAccount> {754 Ok(EthCrossAccount::from_sub_cross_account::<T>(755 &T::CrossAccountId::from_sub(self.owner.clone()),756 ))757 }758759 /// Changes collection owner to another account760 ///761 /// @dev Owner can be changed only by current owner762 /// @param newOwner new owner account763 #[solidity(hide, rename_selector = "changeCollectionOwner")]764 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {765 self.consume_store_writes(1)?;766767 let caller = T::CrossAccountId::from_eth(caller);768 let new_owner = T::CrossAccountId::from_eth(new_owner);769 self.change_owner(caller, new_owner)770 .map_err(dispatch_to_evm::<T>)771 }772773 /// Get collection administrators774 ///775 /// @return Vector of tuples with admins address and his substrate mirror.776 /// If address is canonical then substrate mirror is zero and vice versa.777 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {778 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))779 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))780 .collect();781 Ok(result)782 }783784 /// Changes collection owner to another account785 ///786 /// @dev Owner can be changed only by current owner787 /// @param newOwner new owner cross account788 fn change_collection_owner_cross(789 &mut self,790 caller: caller,791 new_owner: EthCrossAccount,792 ) -> Result<void> {793 self.consume_store_writes(1)?;794795 let caller = T::CrossAccountId::from_eth(caller);796 let new_owner = new_owner.into_sub_cross_account::<T>()?;797 self.change_owner(caller, new_owner)798 .map_err(dispatch_to_evm::<T>)799 }800}801802/// ### Note803/// Do not forget to add: `self.consume_store_reads(1)?;`804fn check_is_owner_or_admin<T: Config>(805 caller: caller,806 collection: &CollectionHandle<T>,807) -> Result<T::CrossAccountId> {808 let caller = T::CrossAccountId::from_eth(caller);809 collection810 .check_is_owner_or_admin(&caller)811 .map_err(dispatch_to_evm::<T>)?;812 Ok(caller)813}814815/// ### Note816/// Do not forget to add: `self.consume_store_writes(1)?;`817fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {818 collection819 .check_is_internal()820 .map_err(dispatch_to_evm::<T>)?;821 collection.save().map_err(dispatch_to_evm::<T>)?;822 Ok(())823}824825/// Contains static property keys and values.826pub mod static_property {827 use evm_coder::{828 execution::{Result, Error},829 };830 use alloc::format;831832 const EXPECT_CONVERT_ERROR: &str = "length < limit";833834 /// Keys.835 pub mod key {836 use super::*;837838 /// Key "baseURI".839 pub fn base_uri() -> up_data_structs::PropertyKey {840 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)841 }842843 /// Key "url".844 pub fn url() -> up_data_structs::PropertyKey {845 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)846 }847848 /// Key "suffix".849 pub fn suffix() -> up_data_structs::PropertyKey {850 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)851 }852853 /// Key "parentNft".854 pub fn parent_nft() -> up_data_structs::PropertyKey {855 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)856 }857 }858859 /// Convert `byte` to [`PropertyKey`].860 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {861 bytes.to_vec().try_into().map_err(|_| {862 Error::Revert(format!(863 "Property key is too long. Max length is {}.",864 up_data_structs::PropertyKey::bound()865 ))866 })867 }868869 /// Convert `bytes` to [`PropertyValue`].870 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {871 bytes.to_vec().try_into().map_err(|_| {872 Error::Revert(format!(873 "Property key is too long. Max length is {}.",874 up_data_structs::PropertyKey::bound()875 ))876 })877 }878}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! This module contains the implementation of pallet methods for evm.1819pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};20use evm_coder::{21 abi::AbiType,22 solidity_interface, solidity, ToLog,23 types::*,24 execution::{Result, Error},25 weight,26};27use pallet_evm_coder_substrate::dispatch_to_evm;28use sp_std::{vec, vec::Vec};29use up_data_structs::{30 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,31 SponsoringRateLimit, SponsorshipState,32};33use alloc::format;3435use crate::{36 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,37 eth::{38 Property as PropertyStruct, EthCrossAccount, CollectionPermissions as EvmPermissions,39 CollectionLimits as EvmCollectionLimits,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<EthCrossAccount> {292 let sponsor = match self.collection.sponsorship.sponsor() {293 Some(sponsor) => sponsor,294 None => return Ok(Default::default()),295 };296297 Ok(EthCrossAccount::from_sub::<T>(&sponsor))298 }299300 /// Get current collection limits.301 ///302 /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:303 /// "accountTokenOwnershipLimit",304 /// "sponsoredDataSize",305 /// "sponsoredDataRateLimit",306 /// "tokenLimit",307 /// "sponsorTransferTimeout",308 /// "sponsorApproveTimeout"309 /// "ownerCanTransfer",310 /// "ownerCanDestroy",311 /// "transfersEnabled"312 /// Return `false` if a limit not set.313 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {314 let convert_value_limit = |limit: EvmCollectionLimits,315 value: Option<u32>|316 -> (EvmCollectionLimits, bool, uint256) {317 value318 .map(|v| (limit, true, v.into()))319 .unwrap_or((limit, false, Default::default()))320 };321322 let convert_bool_limit = |limit: EvmCollectionLimits,323 value: Option<bool>|324 -> (EvmCollectionLimits, bool, uint256) {325 value326 .map(|v| {327 (328 limit,329 true,330 if v {331 uint256::from(1)332 } else {333 Default::default()334 },335 )336 })337 .unwrap_or((limit, false, Default::default()))338 };339340 let limits = &self.collection.limits;341342 Ok(vec![343 convert_value_limit(344 EvmCollectionLimits::AccountTokenOwnership,345 limits.account_token_ownership_limit,346 ),347 convert_value_limit(348 EvmCollectionLimits::SponsoredDataSize,349 limits.sponsored_data_size,350 ),351 limits352 .sponsored_data_rate_limit353 .and_then(|limit| {354 if let SponsoringRateLimit::Blocks(blocks) = limit {355 Some((356 EvmCollectionLimits::SponsoredDataRateLimit,357 true,358 blocks.into(),359 ))360 } else {361 None362 }363 })364 .unwrap_or((365 EvmCollectionLimits::SponsoredDataRateLimit,366 false,367 Default::default(),368 )),369 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),370 convert_value_limit(371 EvmCollectionLimits::SponsorTransferTimeout,372 limits.sponsor_transfer_timeout,373 ),374 convert_value_limit(375 EvmCollectionLimits::SponsorApproveTimeout,376 limits.sponsor_approve_timeout,377 ),378 convert_bool_limit(379 EvmCollectionLimits::OwnerCanTransfer,380 limits.owner_can_transfer,381 ),382 convert_bool_limit(383 EvmCollectionLimits::OwnerCanDestroy,384 limits.owner_can_destroy,385 ),386 convert_bool_limit(387 EvmCollectionLimits::TransferEnabled,388 limits.transfers_enabled,389 ),390 ])391 }392393 /// Set limits for the collection.394 /// @dev Throws error if limit not found.395 /// @param limit Name of the limit. Valid names:396 /// "accountTokenOwnershipLimit",397 /// "sponsoredDataSize",398 /// "sponsoredDataRateLimit",399 /// "tokenLimit",400 /// "sponsorTransferTimeout",401 /// "sponsorApproveTimeout"402 /// "ownerCanTransfer",403 /// "ownerCanDestroy",404 /// "transfersEnabled"405 /// @param status enable\disable limit. Works only with `true`.406 /// @param value Value of the limit.407 #[solidity(rename_selector = "setCollectionLimit")]408 fn set_collection_limit(409 &mut self,410 caller: caller,411 limit: EvmCollectionLimits,412 status: bool,413 value: uint256,414 ) -> Result<void> {415 self.consume_store_reads_and_writes(1, 1)?;416417 if !status {418 return Err(Error::Revert("user can't disable limits".into()));419 }420421 let value = value422 .try_into()423 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;424425 let convert_value_to_bool = || match value {426 0 => Ok(false),427 1 => Ok(true),428 _ => {429 return Err(Error::Revert(format!(430 "can't convert value to boolean \"{}\"",431 value432 )))433 }434 };435436 let mut limits = self.limits.clone();437438 match limit {439 EvmCollectionLimits::AccountTokenOwnership => {440 limits.account_token_ownership_limit = Some(value);441 }442 EvmCollectionLimits::SponsoredDataSize => {443 limits.sponsored_data_size = Some(value);444 }445 EvmCollectionLimits::SponsoredDataRateLimit => {446 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));447 }448 EvmCollectionLimits::TokenLimit => {449 limits.token_limit = Some(value);450 }451 EvmCollectionLimits::SponsorTransferTimeout => {452 limits.sponsor_transfer_timeout = Some(value);453 }454 EvmCollectionLimits::SponsorApproveTimeout => {455 limits.sponsor_approve_timeout = Some(value);456 }457 EvmCollectionLimits::OwnerCanTransfer => {458 limits.owner_can_transfer = Some(convert_value_to_bool()?);459 }460 EvmCollectionLimits::OwnerCanDestroy => {461 limits.owner_can_destroy = Some(convert_value_to_bool()?);462 }463 EvmCollectionLimits::TransferEnabled => {464 limits.transfers_enabled = Some(convert_value_to_bool()?);465 }466 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),467 }468469 let caller = T::CrossAccountId::from_eth(caller);470 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)471 }472473 /// Get contract address.474 fn contract_address(&self) -> Result<address> {475 Ok(crate::eth::collection_id_to_address(self.id))476 }477478 /// Add collection admin.479 /// @param newAdmin Cross account administrator address.480 fn add_collection_admin_cross(481 &mut self,482 caller: caller,483 new_admin: EthCrossAccount,484 ) -> Result<void> {485 self.consume_store_reads_and_writes(2, 2)?;486487 let caller = T::CrossAccountId::from_eth(caller);488 let new_admin = new_admin.into_sub_cross_account::<T>()?;489 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;490 Ok(())491 }492493 /// Remove collection admin.494 /// @param admin Cross account administrator address.495 fn remove_collection_admin_cross(496 &mut self,497 caller: caller,498 admin: EthCrossAccount,499 ) -> Result<void> {500 self.consume_store_reads_and_writes(2, 2)?;501502 let caller = T::CrossAccountId::from_eth(caller);503 let admin = admin.into_sub_cross_account::<T>()?;504 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;505 Ok(())506 }507508 /// Add collection admin.509 /// @param newAdmin Address of the added administrator.510 #[solidity(hide)]511 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {512 self.consume_store_reads_and_writes(2, 2)?;513514 let caller = T::CrossAccountId::from_eth(caller);515 let new_admin = T::CrossAccountId::from_eth(new_admin);516 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;517 Ok(())518 }519520 /// Remove collection admin.521 ///522 /// @param admin Address of the removed administrator.523 #[solidity(hide)]524 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {525 self.consume_store_reads_and_writes(2, 2)?;526527 let caller = T::CrossAccountId::from_eth(caller);528 let admin = T::CrossAccountId::from_eth(admin);529 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;530 Ok(())531 }532533 /// Toggle accessibility of collection nesting.534 ///535 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'536 #[solidity(rename_selector = "setCollectionNesting")]537 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {538 self.consume_store_reads_and_writes(1, 1)?;539540 let caller = T::CrossAccountId::from_eth(caller);541542 let mut permissions = self.collection.permissions.clone();543 let mut nesting = permissions.nesting().clone();544 nesting.token_owner = enable;545 nesting.restricted = None;546 permissions.nesting = Some(nesting);547548 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)549 }550551 /// Toggle accessibility of collection nesting.552 ///553 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'554 /// @param collections Addresses of collections that will be available for nesting.555 #[solidity(rename_selector = "setCollectionNesting")]556 fn set_nesting(557 &mut self,558 caller: caller,559 enable: bool,560 collections: Vec<address>,561 ) -> Result<void> {562 self.consume_store_reads_and_writes(1, 1)?;563564 if collections.is_empty() {565 return Err("no addresses provided".into());566 }567 let caller = T::CrossAccountId::from_eth(caller);568569 let mut permissions = self.collection.permissions.clone();570 match enable {571 false => {572 let mut nesting = permissions.nesting().clone();573 nesting.token_owner = false;574 nesting.restricted = None;575 permissions.nesting = Some(nesting);576 }577 true => {578 let mut bv = OwnerRestrictedSet::new();579 for i in collections {580 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {581 Error::Revert("Can't convert address into collection id".into())582 })?)583 .map_err(|_| "too many collections")?;584 }585 let mut nesting = permissions.nesting().clone();586 nesting.token_owner = true;587 nesting.restricted = Some(bv);588 permissions.nesting = Some(nesting);589 }590 };591592 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)593 }594595 /// Returns nesting for a collection596 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]597 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {598 let nesting = self.collection.permissions.nesting();599600 Ok((601 nesting.token_owner,602 nesting603 .restricted604 .clone()605 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())606 .unwrap_or_default(),607 ))608 }609610 /// Returns permissions for a collection611 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {612 let nesting = self.collection.permissions.nesting();613 Ok(vec![614 (EvmPermissions::CollectionAdmin, nesting.collection_admin),615 (EvmPermissions::TokenOwner, nesting.token_owner),616 ])617 }618 /// Set the collection access method.619 /// @param mode Access mode620 /// 0 for Normal621 /// 1 for AllowList622 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {623 self.consume_store_reads_and_writes(1, 1)?;624625 let caller = T::CrossAccountId::from_eth(caller);626 let permissions = CollectionPermissions {627 access: Some(match mode {628 0 => AccessMode::Normal,629 1 => AccessMode::AllowList,630 _ => return Err("not supported access mode".into()),631 }),632 ..Default::default()633 };634 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)635 }636637 /// Checks that user allowed to operate with collection.638 ///639 /// @param user User address to check.640 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {641 let user = user.into_sub_cross_account::<T>()?;642 Ok(Pallet::<T>::allowed(self.id, user))643 }644645 /// Add the user to the allowed list.646 ///647 /// @param user Address of a trusted user.648 #[solidity(hide)]649 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {650 self.consume_store_writes(1)?;651652 let caller = T::CrossAccountId::from_eth(caller);653 let user = T::CrossAccountId::from_eth(user);654 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;655 Ok(())656 }657658 /// Add user to allowed list.659 ///660 /// @param user User cross account address.661 fn add_to_collection_allow_list_cross(662 &mut self,663 caller: caller,664 user: EthCrossAccount,665 ) -> Result<void> {666 self.consume_store_writes(1)?;667668 let caller = T::CrossAccountId::from_eth(caller);669 let user = user.into_sub_cross_account::<T>()?;670 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;671 Ok(())672 }673674 /// Remove the user from the allowed list.675 ///676 /// @param user Address of a removed user.677 #[solidity(hide)]678 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {679 self.consume_store_writes(1)?;680681 let caller = T::CrossAccountId::from_eth(caller);682 let user = T::CrossAccountId::from_eth(user);683 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;684 Ok(())685 }686687 /// Remove user from allowed list.688 ///689 /// @param user User cross account address.690 fn remove_from_collection_allow_list_cross(691 &mut self,692 caller: caller,693 user: EthCrossAccount,694 ) -> Result<void> {695 self.consume_store_writes(1)?;696697 let caller = T::CrossAccountId::from_eth(caller);698 let user = user.into_sub_cross_account::<T>()?;699 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;700 Ok(())701 }702703 /// Switch permission for minting.704 ///705 /// @param mode Enable if "true".706 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {707 self.consume_store_reads_and_writes(1, 1)?;708709 let caller = T::CrossAccountId::from_eth(caller);710 let permissions = CollectionPermissions {711 mint_mode: Some(mode),712 ..Default::default()713 };714 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)715 }716717 /// Check that account is the owner or admin of the collection718 ///719 /// @param user account to verify720 /// @return "true" if account is the owner or admin721 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]722 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {723 let user = T::CrossAccountId::from_eth(user);724 Ok(self.is_owner_or_admin(&user))725 }726727 /// Check that account is the owner or admin of the collection728 ///729 /// @param user User cross account to verify730 /// @return "true" if account is the owner or admin731 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {732 let user = user.into_sub_cross_account::<T>()?;733 Ok(self.is_owner_or_admin(&user))734 }735736 /// Returns collection type737 ///738 /// @return `Fungible` or `NFT` or `ReFungible`739 fn unique_collection_type(&self) -> Result<string> {740 let mode = match self.collection.mode {741 CollectionMode::Fungible(_) => "Fungible",742 CollectionMode::NFT => "NFT",743 CollectionMode::ReFungible => "ReFungible",744 };745 Ok(mode.into())746 }747748 /// Get collection owner.749 ///750 /// @return Tuble with sponsor address and his substrate mirror.751 /// If address is canonical then substrate mirror is zero and vice versa.752 fn collection_owner(&self) -> Result<EthCrossAccount> {753 Ok(EthCrossAccount::from_sub_cross_account::<T>(754 &T::CrossAccountId::from_sub(self.owner.clone()),755 ))756 }757758 /// Changes collection owner to another account759 ///760 /// @dev Owner can be changed only by current owner761 /// @param newOwner new owner account762 #[solidity(hide, rename_selector = "changeCollectionOwner")]763 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {764 self.consume_store_writes(1)?;765766 let caller = T::CrossAccountId::from_eth(caller);767 let new_owner = T::CrossAccountId::from_eth(new_owner);768 self.change_owner(caller, new_owner)769 .map_err(dispatch_to_evm::<T>)770 }771772 /// Get collection administrators773 ///774 /// @return Vector of tuples with admins address and his substrate mirror.775 /// If address is canonical then substrate mirror is zero and vice versa.776 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {777 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))778 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))779 .collect();780 Ok(result)781 }782783 /// Changes collection owner to another account784 ///785 /// @dev Owner can be changed only by current owner786 /// @param newOwner new owner cross account787 fn change_collection_owner_cross(788 &mut self,789 caller: caller,790 new_owner: EthCrossAccount,791 ) -> Result<void> {792 self.consume_store_writes(1)?;793794 let caller = T::CrossAccountId::from_eth(caller);795 let new_owner = new_owner.into_sub_cross_account::<T>()?;796 self.change_owner(caller, new_owner)797 .map_err(dispatch_to_evm::<T>)798 }799}800801/// ### Note802/// Do not forget to add: `self.consume_store_reads(1)?;`803fn check_is_owner_or_admin<T: Config>(804 caller: caller,805 collection: &CollectionHandle<T>,806) -> Result<T::CrossAccountId> {807 let caller = T::CrossAccountId::from_eth(caller);808 collection809 .check_is_owner_or_admin(&caller)810 .map_err(dispatch_to_evm::<T>)?;811 Ok(caller)812}813814/// ### Note815/// Do not forget to add: `self.consume_store_writes(1)?;`816fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {817 collection818 .check_is_internal()819 .map_err(dispatch_to_evm::<T>)?;820 collection.save().map_err(dispatch_to_evm::<T>)?;821 Ok(())822}823824/// Contains static property keys and values.825pub mod static_property {826 use evm_coder::{827 execution::{Result, Error},828 };829 use alloc::format;830831 const EXPECT_CONVERT_ERROR: &str = "length < limit";832833 /// Keys.834 pub mod key {835 use super::*;836837 /// Key "baseURI".838 pub fn base_uri() -> up_data_structs::PropertyKey {839 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)840 }841842 /// Key "url".843 pub fn url() -> up_data_structs::PropertyKey {844 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)845 }846847 /// Key "suffix".848 pub fn suffix() -> up_data_structs::PropertyKey {849 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)850 }851852 /// Key "parentNft".853 pub fn parent_nft() -> up_data_structs::PropertyKey {854 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)855 }856 }857858 /// Convert `byte` to [`PropertyKey`].859 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {860 bytes.to_vec().try_into().map_err(|_| {861 Error::Revert(format!(862 "Property key is too long. Max length is {}.",863 up_data_structs::PropertyKey::bound()864 ))865 })866 }867868 /// Convert `bytes` to [`PropertyValue`].869 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {870 bytes.to_vec().try_into().map_err(|_| {871 Error::Revert(format!(872 "Property key is too long. Max length is {}.",873 up_data_structs::PropertyKey::bound()874 ))875 })876 }877}pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -116,6 +116,15 @@
}
}
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+#[derive(Debug, Default, AbiCoder)]
+pub struct Property {
+ /// Property key.
+ pub key: evm_coder::types::string,
+ /// Property value.
+ pub value: evm_coder::types::bytes,
+}
+
/// [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
#[derive(Debug, Default, Clone, Copy, AbiCoder)]
#[repr(u8)]
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -26,7 +26,7 @@
};
use evm_coder::{
abi::AbiType, ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*,
- types::Property as PropertyStruct, weight,
+ weight,
};
use frame_support::BoundedVec;
use up_data_structs::{
@@ -38,7 +38,7 @@
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},
- eth::{EthCrossAccount, EthTokenPermissions},
+ eth::{Property as PropertyStruct, EthCrossAccount, EthTokenPermissions},
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
use pallet_evm_coder_substrate::call;
@@ -97,17 +97,15 @@
permissions: Vec<(string, Vec<(EthTokenPermissions, bool)>)>,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
- const PERMISSIONS_FIELDS_COUNT: usize = 3;
-
let mut perms = Vec::new();
for (key, pp) in permissions {
- if pp.len() > PERMISSIONS_FIELDS_COUNT {
+ if pp.len() > EthTokenPermissions::FIELDS_COUNT {
return Err(alloc::format!(
"Actual number of fields {} for {}, which exceeds the maximum value of {}",
pp.len(),
stringify!(EthTokenPermissions),
- PERMISSIONS_FIELDS_COUNT
+ EthTokenPermissions::FIELDS_COUNT
)
.as_str()
.into());
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -27,13 +27,13 @@
};
use evm_coder::{
abi::AbiType, ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*,
- types::Property as PropertyStruct, weight,
+ weight,
};
use frame_support::{BoundedBTreeMap, BoundedVec};
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
erc::{CommonEvmHandler, CollectionCall, static_property::key},
- eth::{EthCrossAccount, EthTokenPermissions},
+ eth::{Property as PropertyStruct, EthCrossAccount, EthTokenPermissions},
Error as CommonError,
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};