12345678910111213141516171819pub 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};444546#[derive(ToLog)]47pub enum CollectionHelpersEvents {48 49 CollectionCreated {50 51 #[indexed]52 owner: address,5354 55 #[indexed]56 collection_id: address,57 },58 59 CollectionDestroyed {60 61 #[indexed]62 collection_id: address,63 },64 65 CollectionChanged {66 67 #[indexed]68 collection_id: address,69 },7071 72 TokenChanged {73 74 #[indexed]75 collection_id: address,76 77 token_id: uint256,78 },79}80818283pub trait CommonEvmHandler {84 85 const CODE: &'static [u8];8687 88 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;89}909192#[solidity_interface(name = Collection)]93impl<T: Config> CollectionHandle<T>94where95 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,96{97 98 99 100 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 120 121 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 148 149 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 162 163 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 180 181 182 183 184 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 197 198 199 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 229 230 231 232 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 245 246 247 248 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 264 fn has_collection_pending_sponsor(&self) -> Result<bool> {265 Ok(matches!(266 self.collection.sponsorship,267 SponsorshipState::Unconfirmed(_)268 ))269 }270271 272 273 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 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 290 291 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 309 310 311 312 313 314 315 316 317 318 319 320 321 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {322 let convert_value_limit = |limit: EvmCollectionLimits,323 value: Option<u32>|324 -> (EvmCollectionLimits, bool, uint256) {325 value326 .map(|v| (limit, true, v.into()))327 .unwrap_or((limit, false, Default::default()))328 };329330 let convert_bool_limit = |limit: EvmCollectionLimits,331 value: Option<bool>|332 -> (EvmCollectionLimits, bool, uint256) {333 value334 .map(|v| {335 (336 limit,337 true,338 if v {339 uint256::from(1)340 } else {341 Default::default()342 },343 )344 })345 .unwrap_or((limit, false, Default::default()))346 };347348 let limits = &self.collection.limits;349350 Ok(vec![351 convert_value_limit(352 EvmCollectionLimits::AccountTokenOwnership,353 limits.account_token_ownership_limit,354 ),355 convert_value_limit(356 EvmCollectionLimits::SponsoredDataSize,357 limits.sponsored_data_size,358 ),359 limits360 .sponsored_data_rate_limit361 .map(|limit| {362 (363 EvmCollectionLimits::SponsoredDataRateLimit,364 match limit {365 SponsoringRateLimit::Blocks(_) => true,366 _ => false,367 },368 match limit {369 SponsoringRateLimit::Blocks(blocks) => blocks.into(),370 _ => Default::default(),371 },372 )373 })374 .unwrap_or((375 EvmCollectionLimits::SponsoredDataRateLimit,376 false,377 Default::default(),378 )),379 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),380 convert_value_limit(381 EvmCollectionLimits::SponsorTransferTimeout,382 limits.sponsor_transfer_timeout,383 ),384 convert_value_limit(385 EvmCollectionLimits::SponsorApproveTimeout,386 limits.sponsor_approve_timeout,387 ),388 convert_bool_limit(389 EvmCollectionLimits::OwnerCanTransfer,390 limits.owner_can_transfer,391 ),392 convert_bool_limit(393 EvmCollectionLimits::OwnerCanDestroy,394 limits.owner_can_destroy,395 ),396 convert_bool_limit(397 EvmCollectionLimits::TransferEnabled,398 limits.transfers_enabled,399 ),400 ])401 }402403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 #[solidity(rename_selector = "setCollectionLimit")]418 fn set_collection_limit(419 &mut self,420 caller: caller,421 limit: EvmCollectionLimits,422 status: bool,423 value: uint256,424 ) -> Result<void> {425 self.consume_store_reads_and_writes(1, 1)?;426427 if !status {428 return Err(Error::Revert("user can't disable limits".into()));429 }430431 let value = value432 .try_into()433 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;434435 let convert_value_to_bool = || match value {436 0 => Ok(false),437 1 => Ok(true),438 _ => {439 return Err(Error::Revert(format!(440 "can't convert value to boolean \"{}\"",441 value442 )))443 }444 };445446 let mut limits = self.limits.clone();447448 match limit {449 EvmCollectionLimits::AccountTokenOwnership => {450 limits.account_token_ownership_limit = Some(value);451 }452 EvmCollectionLimits::SponsoredDataSize => {453 limits.sponsored_data_size = Some(value);454 }455 EvmCollectionLimits::SponsoredDataRateLimit => {456 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));457 }458 EvmCollectionLimits::TokenLimit => {459 limits.token_limit = Some(value);460 }461 EvmCollectionLimits::SponsorTransferTimeout => {462 limits.sponsor_transfer_timeout = Some(value);463 }464 EvmCollectionLimits::SponsorApproveTimeout => {465 limits.sponsor_approve_timeout = Some(value);466 }467 EvmCollectionLimits::OwnerCanTransfer => {468 limits.owner_can_transfer = Some(convert_value_to_bool()?);469 }470 EvmCollectionLimits::OwnerCanDestroy => {471 limits.owner_can_destroy = Some(convert_value_to_bool()?);472 }473 EvmCollectionLimits::TransferEnabled => {474 limits.transfers_enabled = Some(convert_value_to_bool()?);475 }476 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),477 }478479 let caller = T::CrossAccountId::from_eth(caller);480 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)481 }482483 484 fn contract_address(&self) -> Result<address> {485 Ok(crate::eth::collection_id_to_address(self.id))486 }487488 489 490 fn add_collection_admin_cross(491 &mut self,492 caller: caller,493 new_admin: EthCrossAccount,494 ) -> Result<void> {495 self.consume_store_reads_and_writes(2, 2)?;496497 let caller = T::CrossAccountId::from_eth(caller);498 let new_admin = new_admin.into_sub_cross_account::<T>()?;499 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;500 Ok(())501 }502503 504 505 fn remove_collection_admin_cross(506 &mut self,507 caller: caller,508 admin: EthCrossAccount,509 ) -> Result<void> {510 self.consume_store_reads_and_writes(2, 2)?;511512 let caller = T::CrossAccountId::from_eth(caller);513 let admin = admin.into_sub_cross_account::<T>()?;514 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;515 Ok(())516 }517518 519 520 #[solidity(hide)]521 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {522 self.consume_store_reads_and_writes(2, 2)?;523524 let caller = T::CrossAccountId::from_eth(caller);525 let new_admin = T::CrossAccountId::from_eth(new_admin);526 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;527 Ok(())528 }529530 531 532 533 #[solidity(hide)]534 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {535 self.consume_store_reads_and_writes(2, 2)?;536537 let caller = T::CrossAccountId::from_eth(caller);538 let admin = T::CrossAccountId::from_eth(admin);539 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;540 Ok(())541 }542543 544 545 546 #[solidity(rename_selector = "setCollectionNesting")]547 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {548 self.consume_store_reads_and_writes(1, 1)?;549550 let caller = T::CrossAccountId::from_eth(caller);551552 let mut permissions = self.collection.permissions.clone();553 let mut nesting = permissions.nesting().clone();554 nesting.token_owner = enable;555 nesting.restricted = None;556 permissions.nesting = Some(nesting);557558 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)559 }560561 562 563 564 565 #[solidity(rename_selector = "setCollectionNesting")]566 fn set_nesting(567 &mut self,568 caller: caller,569 enable: bool,570 collections: Vec<address>,571 ) -> Result<void> {572 self.consume_store_reads_and_writes(1, 1)?;573574 if collections.is_empty() {575 return Err("no addresses provided".into());576 }577 let caller = T::CrossAccountId::from_eth(caller);578579 let mut permissions = self.collection.permissions.clone();580 match enable {581 false => {582 let mut nesting = permissions.nesting().clone();583 nesting.token_owner = false;584 nesting.restricted = None;585 permissions.nesting = Some(nesting);586 }587 true => {588 let mut bv = OwnerRestrictedSet::new();589 for i in collections {590 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {591 Error::Revert("Can't convert address into collection id".into())592 })?)593 .map_err(|_| "too many collections")?;594 }595 let mut nesting = permissions.nesting().clone();596 nesting.token_owner = true;597 nesting.restricted = Some(bv);598 permissions.nesting = Some(nesting);599 }600 };601602 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)603 }604605 606 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]607 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {608 let nesting = self.collection.permissions.nesting();609610 Ok((611 nesting.token_owner,612 nesting613 .restricted614 .clone()615 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())616 .unwrap_or_default(),617 ))618 }619620 621 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {622 let nesting = self.collection.permissions.nesting();623 Ok(vec![624 (EvmPermissions::CollectionAdmin, nesting.collection_admin),625 (EvmPermissions::TokenOwner, nesting.token_owner),626 ])627 }628 629 630 631 632 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {633 self.consume_store_reads_and_writes(1, 1)?;634635 let caller = T::CrossAccountId::from_eth(caller);636 let permissions = CollectionPermissions {637 access: Some(match mode {638 0 => AccessMode::Normal,639 1 => AccessMode::AllowList,640 _ => return Err("not supported access mode".into()),641 }),642 ..Default::default()643 };644 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)645 }646647 648 649 650 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {651 let user = user.into_sub_cross_account::<T>()?;652 Ok(Pallet::<T>::allowed(self.id, user))653 }654655 656 657 658 #[solidity(hide)]659 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {660 self.consume_store_writes(1)?;661662 let caller = T::CrossAccountId::from_eth(caller);663 let user = T::CrossAccountId::from_eth(user);664 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;665 Ok(())666 }667668 669 670 671 fn add_to_collection_allow_list_cross(672 &mut self,673 caller: caller,674 user: EthCrossAccount,675 ) -> Result<void> {676 self.consume_store_writes(1)?;677678 let caller = T::CrossAccountId::from_eth(caller);679 let user = user.into_sub_cross_account::<T>()?;680 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;681 Ok(())682 }683684 685 686 687 #[solidity(hide)]688 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {689 self.consume_store_writes(1)?;690691 let caller = T::CrossAccountId::from_eth(caller);692 let user = T::CrossAccountId::from_eth(user);693 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;694 Ok(())695 }696697 698 699 700 fn remove_from_collection_allow_list_cross(701 &mut self,702 caller: caller,703 user: EthCrossAccount,704 ) -> Result<void> {705 self.consume_store_writes(1)?;706707 let caller = T::CrossAccountId::from_eth(caller);708 let user = user.into_sub_cross_account::<T>()?;709 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;710 Ok(())711 }712713 714 715 716 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {717 self.consume_store_reads_and_writes(1, 1)?;718719 let caller = T::CrossAccountId::from_eth(caller);720 let permissions = CollectionPermissions {721 mint_mode: Some(mode),722 ..Default::default()723 };724 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)725 }726727 728 729 730 731 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]732 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {733 let user = T::CrossAccountId::from_eth(user);734 Ok(self.is_owner_or_admin(&user))735 }736737 738 739 740 741 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {742 let user = user.into_sub_cross_account::<T>()?;743 Ok(self.is_owner_or_admin(&user))744 }745746 747 748 749 fn unique_collection_type(&self) -> Result<string> {750 let mode = match self.collection.mode {751 CollectionMode::Fungible(_) => "Fungible",752 CollectionMode::NFT => "NFT",753 CollectionMode::ReFungible => "ReFungible",754 };755 Ok(mode.into())756 }757758 759 760 761 762 fn collection_owner(&self) -> Result<EthCrossAccount> {763 Ok(EthCrossAccount::from_sub_cross_account::<T>(764 &T::CrossAccountId::from_sub(self.owner.clone()),765 ))766 }767768 769 770 771 772 #[solidity(hide, rename_selector = "changeCollectionOwner")]773 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {774 self.consume_store_writes(1)?;775776 let caller = T::CrossAccountId::from_eth(caller);777 let new_owner = T::CrossAccountId::from_eth(new_owner);778 self.change_owner(caller, new_owner)779 .map_err(dispatch_to_evm::<T>)780 }781782 783 784 785 786 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {787 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))788 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))789 .collect();790 Ok(result)791 }792793 794 795 796 797 fn change_collection_owner_cross(798 &mut self,799 caller: caller,800 new_owner: EthCrossAccount,801 ) -> Result<void> {802 self.consume_store_writes(1)?;803804 let caller = T::CrossAccountId::from_eth(caller);805 let new_owner = new_owner.into_sub_cross_account::<T>()?;806 self.change_owner(caller, new_owner)807 .map_err(dispatch_to_evm::<T>)808 }809}810811812813fn check_is_owner_or_admin<T: Config>(814 caller: caller,815 collection: &CollectionHandle<T>,816) -> Result<T::CrossAccountId> {817 let caller = T::CrossAccountId::from_eth(caller);818 collection819 .check_is_owner_or_admin(&caller)820 .map_err(dispatch_to_evm::<T>)?;821 Ok(caller)822}823824825826fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {827 collection828 .check_is_internal()829 .map_err(dispatch_to_evm::<T>)?;830 collection.save().map_err(dispatch_to_evm::<T>)?;831 Ok(())832}833834835pub mod static_property {836 use evm_coder::{837 execution::{Result, Error},838 };839 use alloc::format;840841 const EXPECT_CONVERT_ERROR: &str = "length < limit";842843 844 pub mod key {845 use super::*;846847 848 pub fn base_uri() -> up_data_structs::PropertyKey {849 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)850 }851852 853 pub fn url() -> up_data_structs::PropertyKey {854 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)855 }856857 858 pub fn suffix() -> up_data_structs::PropertyKey {859 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)860 }861862 863 pub fn parent_nft() -> up_data_structs::PropertyKey {864 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)865 }866 }867868 869 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {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 }877878 879 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {880 bytes.to_vec().try_into().map_err(|_| {881 Error::Revert(format!(882 "Property key is too long. Max length is {}.",883 up_data_structs::PropertyKey::bound()884 ))885 })886 }887}