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};33use alloc::format;3435use crate::{36 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf, eth, weights::WeightInfo,37};383940#[derive(ToLog)]41pub enum CollectionHelpersEvents {42 43 CollectionCreated {44 45 #[indexed]46 owner: address,4748 49 #[indexed]50 collection_id: address,51 },52 53 CollectionDestroyed {54 55 #[indexed]56 collection_id: address,57 },58 59 CollectionChanged {60 61 #[indexed]62 collection_id: address,63 },6465 66 TokenChanged {67 68 #[indexed]69 collection_id: address,70 71 token_id: uint256,72 },73}74757677pub trait CommonEvmHandler {78 79 const CODE: &'static [u8];8081 82 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;83}848586#[solidity_interface(name = Collection)]87impl<T: Config> CollectionHandle<T>88where89 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,90{91 92 93 94 95 #[solidity(hide)]96 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]97 fn set_collection_property(98 &mut self,99 caller: caller,100 key: string,101 value: bytes,102 ) -> Result<void> {103 let caller = T::CrossAccountId::from_eth(caller);104 let key = <Vec<u8>>::from(key)105 .try_into()106 .map_err(|_| "key too large")?;107 let value = value.0.try_into().map_err(|_| "value too large")?;108109 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })110 .map_err(dispatch_to_evm::<T>)111 }112113 114 115 116 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]117 fn set_collection_properties(118 &mut self,119 caller: caller,120 properties: Vec<eth::Property>,121 ) -> Result<void> {122 let caller = T::CrossAccountId::from_eth(caller);123124 let properties = properties125 .into_iter()126 .map(|property| {127 let (key, value) = property.take_key_value();128 let key = <Vec<u8>>::from(key)129 .try_into()130 .map_err(|_| "key too large")?;131132 let value = value.0.try_into().map_err(|_| "value too large")?;133134 Ok(Property { key, value })135 })136 .collect::<Result<Vec<_>>>()?;137138 <Pallet<T>>::set_collection_properties(self, &caller, properties)139 .map_err(dispatch_to_evm::<T>)140 }141142 143 144 145 #[solidity(hide)]146 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]147 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {148 let caller = T::CrossAccountId::from_eth(caller);149 let key = <Vec<u8>>::from(key)150 .try_into()151 .map_err(|_| "key too large")?;152153 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)154 }155156 157 158 159 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]160 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {161 let caller = T::CrossAccountId::from_eth(caller);162 let keys = keys163 .into_iter()164 .map(|key| {165 <Vec<u8>>::from(key)166 .try_into()167 .map_err(|_| Error::Revert("key too large".into()))168 })169 .collect::<Result<Vec<_>>>()?;170171 <Pallet<T>>::delete_collection_properties(self, &caller, keys).map_err(dispatch_to_evm::<T>)172 }173174 175 176 177 178 179 180 fn collection_property(&self, key: string) -> Result<bytes> {181 let key = <Vec<u8>>::from(key)182 .try_into()183 .map_err(|_| "key too large")?;184185 let props = CollectionProperties::<T>::get(self.id);186 let prop = props.get(&key).ok_or("key not found")?;187188 Ok(bytes(prop.to_vec()))189 }190191 192 193 194 195 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {196 let keys = keys197 .into_iter()198 .map(|key| {199 <Vec<u8>>::from(key)200 .try_into()201 .map_err(|_| Error::Revert("key too large".into()))202 })203 .collect::<Result<Vec<_>>>()?;204205 let properties = Pallet::<T>::filter_collection_properties(206 self.id,207 if keys.is_empty() { None } else { Some(keys) },208 )209 .map_err(dispatch_to_evm::<T>)?;210211 let properties = properties212 .into_iter()213 .map(|p| {214 let key =215 string::from_utf8(p.key.into()).map_err(|e| Error::Revert(format!("{}", e)))?;216 let value = bytes(p.value.to_vec());217 Ok(eth::Property::new(key, value))218 })219 .collect::<Result<Vec<_>>>()?;220 Ok(properties)221 }222223 224 225 226 227 228 #[solidity(hide)]229 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {230 self.consume_store_reads_and_writes(1, 1)?;231232 let caller = T::CrossAccountId::from_eth(caller);233234 let sponsor = T::CrossAccountId::from_eth(sponsor);235 self.set_sponsor(&caller, sponsor.as_sub().clone())236 .map_err(dispatch_to_evm::<T>)237 }238239 240 241 242 243 244 fn set_collection_sponsor_cross(245 &mut self,246 caller: caller,247 sponsor: eth::CrossAccount,248 ) -> Result<void> {249 self.consume_store_reads_and_writes(1, 1)?;250251 let caller = T::CrossAccountId::from_eth(caller);252253 let sponsor = sponsor.into_sub_cross_account::<T>()?;254 self.set_sponsor(&caller, sponsor.as_sub().clone())255 .map_err(dispatch_to_evm::<T>)256 }257258 259 fn has_collection_pending_sponsor(&self) -> Result<bool> {260 Ok(matches!(261 self.collection.sponsorship,262 SponsorshipState::Unconfirmed(_)263 ))264 }265266 267 268 269 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {270 self.consume_store_writes(1)?;271272 let caller = T::CrossAccountId::from_eth(caller);273 self.confirm_sponsorship(caller.as_sub())274 .map_err(dispatch_to_evm::<T>)275 }276277 278 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {279 self.consume_store_reads_and_writes(1, 1)?;280 let caller = T::CrossAccountId::from_eth(caller);281 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)282 }283284 285 286 287 fn collection_sponsor(&self) -> Result<eth::CrossAccount> {288 let sponsor = match self.collection.sponsorship.sponsor() {289 Some(sponsor) => sponsor,290 None => return Ok(Default::default()),291 };292293 Ok(eth::CrossAccount::from_sub::<T>(&sponsor))294 }295296 297 298 299 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {300 let limits = &self.collection.limits;301302 Ok(vec![303 eth::CollectionLimit::from_opt_int(304 eth::CollectionLimitField::AccountTokenOwnership,305 limits.account_token_ownership_limit,306 ),307 eth::CollectionLimit::from_opt_int(308 eth::CollectionLimitField::SponsoredDataSize,309 limits.sponsored_data_size,310 ),311 limits312 .sponsored_data_rate_limit313 .and_then(|limit| {314 if let SponsoringRateLimit::Blocks(blocks) = limit {315 Some(eth::CollectionLimit::from_int(316 eth::CollectionLimitField::SponsoredDataRateLimit,317 blocks,318 ))319 } else {320 None321 }322 })323 .unwrap_or(eth::CollectionLimit::from_int(324 eth::CollectionLimitField::SponsoredDataRateLimit,325 Default::default(),326 )),327 eth::CollectionLimit::from_opt_int(328 eth::CollectionLimitField::TokenLimit,329 limits.token_limit,330 ),331 eth::CollectionLimit::from_opt_int(332 eth::CollectionLimitField::SponsorTransferTimeout,333 limits.sponsor_transfer_timeout,334 ),335 eth::CollectionLimit::from_opt_int(336 eth::CollectionLimitField::SponsorApproveTimeout,337 limits.sponsor_approve_timeout,338 ),339 eth::CollectionLimit::from_opt_bool(340 eth::CollectionLimitField::OwnerCanTransfer,341 limits.owner_can_transfer,342 ),343 eth::CollectionLimit::from_opt_bool(344 eth::CollectionLimitField::OwnerCanDestroy,345 limits.owner_can_destroy,346 ),347 eth::CollectionLimit::from_opt_bool(348 eth::CollectionLimitField::TransferEnabled,349 limits.transfers_enabled,350 ),351 ])352 }353354 355 356 357 #[solidity(rename_selector = "setCollectionLimit")]358 fn set_collection_limit(359 &mut self,360 caller: caller,361 limit: eth::CollectionLimit,362 ) -> Result<void> {363 self.consume_store_reads_and_writes(1, 1)?;364365 let caller = T::CrossAccountId::from_eth(caller);366 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)367 }368369 370 fn contract_address(&self) -> Result<address> {371 Ok(crate::eth::collection_id_to_address(self.id))372 }373374 375 376 fn add_collection_admin_cross(377 &mut self,378 caller: caller,379 new_admin: eth::CrossAccount,380 ) -> Result<void> {381 self.consume_store_reads_and_writes(2, 2)?;382383 let caller = T::CrossAccountId::from_eth(caller);384 let new_admin = new_admin.into_sub_cross_account::<T>()?;385 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;386 Ok(())387 }388389 390 391 fn remove_collection_admin_cross(392 &mut self,393 caller: caller,394 admin: eth::CrossAccount,395 ) -> Result<void> {396 self.consume_store_reads_and_writes(2, 2)?;397398 let caller = T::CrossAccountId::from_eth(caller);399 let admin = admin.into_sub_cross_account::<T>()?;400 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;401 Ok(())402 }403404 405 406 #[solidity(hide)]407 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {408 self.consume_store_reads_and_writes(2, 2)?;409410 let caller = T::CrossAccountId::from_eth(caller);411 let new_admin = T::CrossAccountId::from_eth(new_admin);412 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;413 Ok(())414 }415416 417 418 419 #[solidity(hide)]420 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {421 self.consume_store_reads_and_writes(2, 2)?;422423 let caller = T::CrossAccountId::from_eth(caller);424 let admin = T::CrossAccountId::from_eth(admin);425 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;426 Ok(())427 }428429 430 431 432 #[solidity(rename_selector = "setCollectionNesting")]433 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {434 self.consume_store_reads_and_writes(1, 1)?;435436 let caller = T::CrossAccountId::from_eth(caller);437438 let mut permissions = self.collection.permissions.clone();439 let mut nesting = permissions.nesting().clone();440 nesting.token_owner = enable;441 nesting.restricted = None;442 permissions.nesting = Some(nesting);443444 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)445 }446447 448 449 450 451 #[solidity(rename_selector = "setCollectionNesting")]452 fn set_nesting(453 &mut self,454 caller: caller,455 enable: bool,456 collections: Vec<address>,457 ) -> Result<void> {458 self.consume_store_reads_and_writes(1, 1)?;459460 if collections.is_empty() {461 return Err("no addresses provided".into());462 }463 let caller = T::CrossAccountId::from_eth(caller);464465 let mut permissions = self.collection.permissions.clone();466 match enable {467 false => {468 let mut nesting = permissions.nesting().clone();469 nesting.token_owner = false;470 nesting.restricted = None;471 permissions.nesting = Some(nesting);472 }473 true => {474 let mut bv = OwnerRestrictedSet::new();475 for i in collections {476 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {477 Error::Revert("Can't convert address into collection id".into())478 })?)479 .map_err(|_| "too many collections")?;480 }481 let mut nesting = permissions.nesting().clone();482 nesting.token_owner = true;483 nesting.restricted = Some(bv);484 permissions.nesting = Some(nesting);485 }486 };487488 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)489 }490491 492 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]493 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {494 let nesting = self.collection.permissions.nesting();495496 Ok(eth::CollectionNesting::new(497 nesting.token_owner,498 nesting499 .restricted500 .clone()501 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())502 .unwrap_or_default(),503 ))504 }505506 507 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {508 let nesting = self.collection.permissions.nesting();509 Ok(vec![510 eth::CollectionNestingPermission::new(511 eth::CollectionPermissionField::CollectionAdmin,512 nesting.collection_admin,513 ),514 eth::CollectionNestingPermission::new(515 eth::CollectionPermissionField::TokenOwner,516 nesting.token_owner,517 ),518 ])519 }520 521 522 523 524 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {525 self.consume_store_reads_and_writes(1, 1)?;526527 let caller = T::CrossAccountId::from_eth(caller);528 let permissions = CollectionPermissions {529 access: Some(match mode {530 0 => AccessMode::Normal,531 1 => AccessMode::AllowList,532 _ => return Err("not supported access mode".into()),533 }),534 ..Default::default()535 };536 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)537 }538539 540 541 542 fn allowlisted_cross(&self, user: eth::CrossAccount) -> Result<bool> {543 let user = user.into_sub_cross_account::<T>()?;544 Ok(Pallet::<T>::allowed(self.id, user))545 }546547 548 549 550 #[solidity(hide)]551 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {552 self.consume_store_writes(1)?;553554 let caller = T::CrossAccountId::from_eth(caller);555 let user = T::CrossAccountId::from_eth(user);556 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;557 Ok(())558 }559560 561 562 563 fn add_to_collection_allow_list_cross(564 &mut self,565 caller: caller,566 user: eth::CrossAccount,567 ) -> Result<void> {568 self.consume_store_writes(1)?;569570 let caller = T::CrossAccountId::from_eth(caller);571 let user = user.into_sub_cross_account::<T>()?;572 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;573 Ok(())574 }575576 577 578 579 #[solidity(hide)]580 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {581 self.consume_store_writes(1)?;582583 let caller = T::CrossAccountId::from_eth(caller);584 let user = T::CrossAccountId::from_eth(user);585 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;586 Ok(())587 }588589 590 591 592 fn remove_from_collection_allow_list_cross(593 &mut self,594 caller: caller,595 user: eth::CrossAccount,596 ) -> Result<void> {597 self.consume_store_writes(1)?;598599 let caller = T::CrossAccountId::from_eth(caller);600 let user = user.into_sub_cross_account::<T>()?;601 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;602 Ok(())603 }604605 606 607 608 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {609 self.consume_store_reads_and_writes(1, 1)?;610611 let caller = T::CrossAccountId::from_eth(caller);612 let permissions = CollectionPermissions {613 mint_mode: Some(mode),614 ..Default::default()615 };616 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)617 }618619 620 621 622 623 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]624 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {625 let user = T::CrossAccountId::from_eth(user);626 Ok(self.is_owner_or_admin(&user))627 }628629 630 631 632 633 fn is_owner_or_admin_cross(&self, user: eth::CrossAccount) -> Result<bool> {634 let user = user.into_sub_cross_account::<T>()?;635 Ok(self.is_owner_or_admin(&user))636 }637638 639 640 641 fn unique_collection_type(&self) -> Result<string> {642 let mode = match self.collection.mode {643 CollectionMode::Fungible(_) => "Fungible",644 CollectionMode::NFT => "NFT",645 CollectionMode::ReFungible => "ReFungible",646 };647 Ok(mode.into())648 }649650 651 652 653 654 fn collection_owner(&self) -> Result<eth::CrossAccount> {655 Ok(eth::CrossAccount::from_sub_cross_account::<T>(656 &T::CrossAccountId::from_sub(self.owner.clone()),657 ))658 }659660 661 662 663 664 #[solidity(hide, rename_selector = "changeCollectionOwner")]665 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {666 self.consume_store_writes(1)?;667668 let caller = T::CrossAccountId::from_eth(caller);669 let new_owner = T::CrossAccountId::from_eth(new_owner);670 self.change_owner(caller, new_owner)671 .map_err(dispatch_to_evm::<T>)672 }673674 675 676 677 678 fn collection_admins(&self) -> Result<Vec<eth::CrossAccount>> {679 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))680 .map(|(admin, _)| eth::CrossAccount::from_sub_cross_account::<T>(&admin))681 .collect();682 Ok(result)683 }684685 686 687 688 689 fn change_collection_owner_cross(690 &mut self,691 caller: caller,692 new_owner: eth::CrossAccount,693 ) -> Result<void> {694 self.consume_store_writes(1)?;695696 let caller = T::CrossAccountId::from_eth(caller);697 let new_owner = new_owner.into_sub_cross_account::<T>()?;698 self.change_owner(caller, new_owner)699 .map_err(dispatch_to_evm::<T>)700 }701}702703704pub mod static_property {705 use evm_coder::{706 execution::{Result, Error},707 };708 use alloc::format;709710 const EXPECT_CONVERT_ERROR: &str = "length < limit";711712 713 pub mod key {714 use super::*;715716 717 pub fn base_uri() -> up_data_structs::PropertyKey {718 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)719 }720721 722 pub fn url() -> up_data_structs::PropertyKey {723 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)724 }725726 727 pub fn suffix() -> up_data_structs::PropertyKey {728 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)729 }730731 732 pub fn parent_nft() -> up_data_structs::PropertyKey {733 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)734 }735 }736737 738 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {739 bytes.to_vec().try_into().map_err(|_| {740 Error::Revert(format!(741 "Property key is too long. Max length is {}.",742 up_data_structs::PropertyKey::bound()743 ))744 })745 }746747 748 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {749 bytes.to_vec().try_into().map_err(|_| {750 Error::Revert(format!(751 "Property key is too long. Max length is {}.",752 up_data_structs::PropertyKey::bound()753 ))754 })755 }756}