12345678910111213141516171819pub 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};3334use crate::{35 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf, eth, weights::WeightInfo,36};373839#[derive(ToLog)]40pub enum CollectionHelpersEvents {41 42 CollectionCreated {43 44 #[indexed]45 owner: address,4647 48 #[indexed]49 collection_id: address,50 },51 52 CollectionDestroyed {53 54 #[indexed]55 collection_id: address,56 },57 58 CollectionChanged {59 60 #[indexed]61 collection_id: address,62 },6364 65 TokenChanged {66 67 #[indexed]68 collection_id: address,69 70 token_id: uint256,71 },72}73747576pub trait CommonEvmHandler {77 78 const CODE: &'static [u8];7980 81 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;82}838485#[solidity_interface(name = Collection)]86impl<T: Config> CollectionHandle<T>87where88 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,89{90 91 92 93 94 #[solidity(hide)]95 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]96 fn set_collection_property(97 &mut self,98 caller: caller,99 key: string,100 value: bytes,101 ) -> Result<void> {102 let caller = T::CrossAccountId::from_eth(caller);103 let key = <Vec<u8>>::from(key)104 .try_into()105 .map_err(|_| "key too large")?;106 let value = value.0.try_into().map_err(|_| "value too large")?;107108 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })109 .map_err(dispatch_to_evm::<T>)110 }111112 113 114 115 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]116 fn set_collection_properties(117 &mut self,118 caller: caller,119 properties: Vec<eth::Property>,120 ) -> Result<void> {121 let caller = T::CrossAccountId::from_eth(caller);122123 let properties = properties124 .into_iter()125 .map(eth::Property::try_into)126 .collect::<Result<Vec<_>>>()?;127128 <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())129 .map_err(dispatch_to_evm::<T>)130 }131132 133 134 135 #[solidity(hide)]136 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]137 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {138 let caller = T::CrossAccountId::from_eth(caller);139 let key = <Vec<u8>>::from(key)140 .try_into()141 .map_err(|_| "key too large")?;142143 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)144 }145146 147 148 149 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]150 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {151 let caller = T::CrossAccountId::from_eth(caller);152 let keys = keys153 .into_iter()154 .map(|key| {155 <Vec<u8>>::from(key)156 .try_into()157 .map_err(|_| Error::Revert("key too large".into()))158 })159 .collect::<Result<Vec<_>>>()?;160161 <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())162 .map_err(dispatch_to_evm::<T>)163 }164165 166 167 168 169 170 171 fn collection_property(&self, key: string) -> Result<bytes> {172 let key = <Vec<u8>>::from(key)173 .try_into()174 .map_err(|_| "key too large")?;175176 let props = CollectionProperties::<T>::get(self.id);177 let prop = props.get(&key).ok_or("key not found")?;178179 Ok(bytes(prop.to_vec()))180 }181182 183 184 185 186 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {187 let keys = keys188 .into_iter()189 .map(|key| {190 <Vec<u8>>::from(key)191 .try_into()192 .map_err(|_| Error::Revert("key too large".into()))193 })194 .collect::<Result<Vec<_>>>()?;195196 let properties = Pallet::<T>::filter_collection_properties(197 self.id,198 if keys.is_empty() { None } else { Some(keys) },199 )200 .map_err(dispatch_to_evm::<T>)?;201202 let properties = properties203 .into_iter()204 .map(Property::try_into)205 .collect::<Result<Vec<_>>>()?;206 Ok(properties)207 }208209 210 211 212 213 214 #[solidity(hide)]215 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {216 self.consume_store_reads_and_writes(1, 1)?;217218 let caller = T::CrossAccountId::from_eth(caller);219220 let sponsor = T::CrossAccountId::from_eth(sponsor);221 self.set_sponsor(&caller, sponsor.as_sub().clone())222 .map_err(dispatch_to_evm::<T>)223 }224225 226 227 228 229 230 fn set_collection_sponsor_cross(231 &mut self,232 caller: caller,233 sponsor: eth::CrossAddress,234 ) -> Result<void> {235 self.consume_store_reads_and_writes(1, 1)?;236237 let caller = T::CrossAccountId::from_eth(caller);238239 let sponsor = sponsor.into_sub_cross_account::<T>()?;240 self.set_sponsor(&caller, sponsor.as_sub().clone())241 .map_err(dispatch_to_evm::<T>)242 }243244 245 fn has_collection_pending_sponsor(&self) -> Result<bool> {246 Ok(matches!(247 self.collection.sponsorship,248 SponsorshipState::Unconfirmed(_)249 ))250 }251252 253 254 255 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {256 self.consume_store_writes(1)?;257258 let caller = T::CrossAccountId::from_eth(caller);259 self.confirm_sponsorship(caller.as_sub())260 .map_err(dispatch_to_evm::<T>)261 }262263 264 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {265 self.consume_store_reads_and_writes(1, 1)?;266 let caller = T::CrossAccountId::from_eth(caller);267 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)268 }269270 271 272 273 fn collection_sponsor(&self) -> Result<eth::CrossAddress> {274 let sponsor = match self.collection.sponsorship.sponsor() {275 Some(sponsor) => sponsor,276 None => return Ok(Default::default()),277 };278279 Ok(eth::CrossAddress::from_sub::<T>(&sponsor))280 }281282 283 284 285 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {286 let limits = &self.collection.limits;287288 let convert_value_from_bool = |ob: Option<bool>| match ob {289 Some(b) => Some(b as u32),290 None => None,291 };292293 Ok(vec![294 eth::CollectionLimit::new(295 eth::CollectionLimitField::AccountTokenOwnership,296 limits.account_token_ownership_limit,297 ),298 eth::CollectionLimit::new(299 eth::CollectionLimitField::SponsoredDataSize,300 limits.sponsored_data_size,301 ),302 limits303 .sponsored_data_rate_limit304 .and_then(|limit| {305 if let SponsoringRateLimit::Blocks(blocks) = limit {306 Some(eth::CollectionLimit::new(307 eth::CollectionLimitField::SponsoredDataRateLimit,308 Some(blocks),309 ))310 } else {311 None312 }313 })314 .unwrap_or(eth::CollectionLimit::new(315 eth::CollectionLimitField::SponsoredDataRateLimit,316 Default::default(),317 )),318 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),319 eth::CollectionLimit::new(320 eth::CollectionLimitField::SponsorTransferTimeout,321 limits.sponsor_transfer_timeout,322 ),323 eth::CollectionLimit::new(324 eth::CollectionLimitField::SponsorApproveTimeout,325 limits.sponsor_approve_timeout,326 ),327 eth::CollectionLimit::new(328 eth::CollectionLimitField::OwnerCanTransfer,329 convert_value_from_bool(limits.owner_can_transfer),330 ),331 eth::CollectionLimit::new(332 eth::CollectionLimitField::OwnerCanDestroy,333 convert_value_from_bool(limits.owner_can_destroy),334 ),335 eth::CollectionLimit::new(336 eth::CollectionLimitField::TransferEnabled,337 convert_value_from_bool(limits.transfers_enabled),338 ),339 ])340 }341342 343 344 345 #[solidity(rename_selector = "setCollectionLimit")]346 fn set_collection_limit(347 &mut self,348 caller: caller,349 limit: eth::CollectionLimit,350 ) -> Result<void> {351 self.consume_store_reads_and_writes(1, 1)?;352353 if !limit.has_value() {354 return Err(Error::Revert("user can't disable limits".into()));355 }356357 let caller = T::CrossAccountId::from_eth(caller);358 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)359 }360361 362 fn contract_address(&self) -> Result<address> {363 Ok(crate::eth::collection_id_to_address(self.id))364 }365366 367 368 fn add_collection_admin_cross(369 &mut self,370 caller: caller,371 new_admin: eth::CrossAddress,372 ) -> Result<void> {373 self.consume_store_reads_and_writes(2, 2)?;374375 let caller = T::CrossAccountId::from_eth(caller);376 let new_admin = new_admin.into_sub_cross_account::<T>()?;377 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;378 Ok(())379 }380381 382 383 fn remove_collection_admin_cross(384 &mut self,385 caller: caller,386 admin: eth::CrossAddress,387 ) -> Result<void> {388 self.consume_store_reads_and_writes(2, 2)?;389390 let caller = T::CrossAccountId::from_eth(caller);391 let admin = admin.into_sub_cross_account::<T>()?;392 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;393 Ok(())394 }395396 397 398 #[solidity(hide)]399 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {400 self.consume_store_reads_and_writes(2, 2)?;401402 let caller = T::CrossAccountId::from_eth(caller);403 let new_admin = T::CrossAccountId::from_eth(new_admin);404 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;405 Ok(())406 }407408 409 410 411 #[solidity(hide)]412 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {413 self.consume_store_reads_and_writes(2, 2)?;414415 let caller = T::CrossAccountId::from_eth(caller);416 let admin = T::CrossAccountId::from_eth(admin);417 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;418 Ok(())419 }420421 422 423 424 #[solidity(rename_selector = "setCollectionNesting")]425 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {426 self.consume_store_reads_and_writes(1, 1)?;427428 let caller = T::CrossAccountId::from_eth(caller);429430 let mut permissions = self.collection.permissions.clone();431 let mut nesting = permissions.nesting().clone();432 nesting.token_owner = enable;433 nesting.restricted = None;434 permissions.nesting = Some(nesting);435436 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)437 }438439 440 441 442 443 #[solidity(rename_selector = "setCollectionNesting")]444 fn set_nesting(445 &mut self,446 caller: caller,447 enable: bool,448 collections: Vec<address>,449 ) -> Result<void> {450 self.consume_store_reads_and_writes(1, 1)?;451452 if collections.is_empty() {453 return Err("no addresses provided".into());454 }455 let caller = T::CrossAccountId::from_eth(caller);456457 let mut permissions = self.collection.permissions.clone();458 match enable {459 false => {460 let mut nesting = permissions.nesting().clone();461 nesting.token_owner = false;462 nesting.restricted = None;463 permissions.nesting = Some(nesting);464 }465 true => {466 let mut bv = OwnerRestrictedSet::new();467 for i in collections {468 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {469 Error::Revert("Can't convert address into collection id".into())470 })?)471 .map_err(|_| "too many collections")?;472 }473 let mut nesting = permissions.nesting().clone();474 nesting.token_owner = true;475 nesting.restricted = Some(bv);476 permissions.nesting = Some(nesting);477 }478 };479480 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)481 }482483 484 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]485 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {486 let nesting = self.collection.permissions.nesting();487488 Ok(eth::CollectionNesting::new(489 nesting.token_owner,490 nesting491 .restricted492 .clone()493 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())494 .unwrap_or_default(),495 ))496 }497498 499 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {500 let nesting = self.collection.permissions.nesting();501 Ok(vec![502 eth::CollectionNestingPermission::new(503 eth::CollectionPermissionField::CollectionAdmin,504 nesting.collection_admin,505 ),506 eth::CollectionNestingPermission::new(507 eth::CollectionPermissionField::TokenOwner,508 nesting.token_owner,509 ),510 ])511 }512 513 514 515 516 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {517 self.consume_store_reads_and_writes(1, 1)?;518519 let caller = T::CrossAccountId::from_eth(caller);520 let permissions = CollectionPermissions {521 access: Some(match mode {522 0 => AccessMode::Normal,523 1 => AccessMode::AllowList,524 _ => return Err("not supported access mode".into()),525 }),526 ..Default::default()527 };528 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)529 }530531 532 533 534 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {535 let user = user.into_sub_cross_account::<T>()?;536 Ok(Pallet::<T>::allowed(self.id, user))537 }538539 540 541 542 #[solidity(hide)]543 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {544 self.consume_store_writes(1)?;545546 let caller = T::CrossAccountId::from_eth(caller);547 let user = T::CrossAccountId::from_eth(user);548 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;549 Ok(())550 }551552 553 554 555 fn add_to_collection_allow_list_cross(556 &mut self,557 caller: caller,558 user: eth::CrossAddress,559 ) -> Result<void> {560 self.consume_store_writes(1)?;561562 let caller = T::CrossAccountId::from_eth(caller);563 let user = user.into_sub_cross_account::<T>()?;564 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;565 Ok(())566 }567568 569 570 571 #[solidity(hide)]572 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {573 self.consume_store_writes(1)?;574575 let caller = T::CrossAccountId::from_eth(caller);576 let user = T::CrossAccountId::from_eth(user);577 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;578 Ok(())579 }580581 582 583 584 fn remove_from_collection_allow_list_cross(585 &mut self,586 caller: caller,587 user: eth::CrossAddress,588 ) -> Result<void> {589 self.consume_store_writes(1)?;590591 let caller = T::CrossAccountId::from_eth(caller);592 let user = user.into_sub_cross_account::<T>()?;593 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;594 Ok(())595 }596597 598 599 600 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {601 self.consume_store_reads_and_writes(1, 1)?;602603 let caller = T::CrossAccountId::from_eth(caller);604 let permissions = CollectionPermissions {605 mint_mode: Some(mode),606 ..Default::default()607 };608 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)609 }610611 612 613 614 615 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]616 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {617 let user = T::CrossAccountId::from_eth(user);618 Ok(self.is_owner_or_admin(&user))619 }620621 622 623 624 625 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {626 let user = user.into_sub_cross_account::<T>()?;627 Ok(self.is_owner_or_admin(&user))628 }629630 631 632 633 fn unique_collection_type(&self) -> Result<string> {634 let mode = match self.collection.mode {635 CollectionMode::Fungible(_) => "Fungible",636 CollectionMode::NFT => "NFT",637 CollectionMode::ReFungible => "ReFungible",638 };639 Ok(mode.into())640 }641642 643 644 645 646 fn collection_owner(&self) -> Result<eth::CrossAddress> {647 Ok(eth::CrossAddress::from_sub_cross_account::<T>(648 &T::CrossAccountId::from_sub(self.owner.clone()),649 ))650 }651652 653 654 655 656 #[solidity(hide, rename_selector = "changeCollectionOwner")]657 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {658 self.consume_store_writes(1)?;659660 let caller = T::CrossAccountId::from_eth(caller);661 let new_owner = T::CrossAccountId::from_eth(new_owner);662 self.change_owner(caller, new_owner)663 .map_err(dispatch_to_evm::<T>)664 }665666 667 668 669 670 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {671 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))672 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))673 .collect();674 Ok(result)675 }676677 678 679 680 681 fn change_collection_owner_cross(682 &mut self,683 caller: caller,684 new_owner: eth::CrossAddress,685 ) -> Result<void> {686 self.consume_store_writes(1)?;687688 let caller = T::CrossAccountId::from_eth(caller);689 let new_owner = new_owner.into_sub_cross_account::<T>()?;690 self.change_owner(caller, new_owner)691 .map_err(dispatch_to_evm::<T>)692 }693}694695696pub mod static_property {697 use evm_coder::{698 execution::{Result, Error},699 };700 use alloc::format;701702 const EXPECT_CONVERT_ERROR: &str = "length < limit";703704 705 pub mod key {706 use super::*;707708 709 pub fn base_uri() -> up_data_structs::PropertyKey {710 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)711 }712713 714 pub fn url() -> up_data_structs::PropertyKey {715 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)716 }717718 719 pub fn suffix() -> up_data_structs::PropertyKey {720 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)721 }722723 724 pub fn parent_nft() -> up_data_structs::PropertyKey {725 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)726 }727 }728729 730 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {731 bytes.to_vec().try_into().map_err(|_| {732 Error::Revert(format!(733 "Property key is too long. Max length is {}.",734 up_data_structs::PropertyKey::bound()735 ))736 })737 }738739 740 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {741 bytes.to_vec().try_into().map_err(|_| {742 Error::Revert(format!(743 "Property key is too long. Max length is {}.",744 up_data_structs::PropertyKey::bound()745 ))746 })747 }748}