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)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).map_err(dispatch_to_evm::<T>)162 }163164 165 166 167 168 169 170 fn collection_property(&self, key: string) -> Result<bytes> {171 let key = <Vec<u8>>::from(key)172 .try_into()173 .map_err(|_| "key too large")?;174175 let props = CollectionProperties::<T>::get(self.id);176 let prop = props.get(&key).ok_or("key not found")?;177178 Ok(bytes(prop.to_vec()))179 }180181 182 183 184 185 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {186 let keys = keys187 .into_iter()188 .map(|key| {189 <Vec<u8>>::from(key)190 .try_into()191 .map_err(|_| Error::Revert("key too large".into()))192 })193 .collect::<Result<Vec<_>>>()?;194195 let properties = Pallet::<T>::filter_collection_properties(196 self.id,197 if keys.is_empty() { None } else { Some(keys) },198 )199 .map_err(dispatch_to_evm::<T>)?;200201 let properties = properties202 .into_iter()203 .map(Property::try_into)204 .collect::<Result<Vec<_>>>()?;205 Ok(properties)206 }207208 209 210 211 212 213 #[solidity(hide)]214 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {215 self.consume_store_reads_and_writes(1, 1)?;216217 let caller = T::CrossAccountId::from_eth(caller);218219 let sponsor = T::CrossAccountId::from_eth(sponsor);220 self.set_sponsor(&caller, sponsor.as_sub().clone())221 .map_err(dispatch_to_evm::<T>)222 }223224 225 226 227 228 229 fn set_collection_sponsor_cross(230 &mut self,231 caller: caller,232 sponsor: eth::CrossAddress,233 ) -> Result<void> {234 self.consume_store_reads_and_writes(1, 1)?;235236 let caller = T::CrossAccountId::from_eth(caller);237238 let sponsor = sponsor.into_sub_cross_account::<T>()?;239 self.set_sponsor(&caller, sponsor.as_sub().clone())240 .map_err(dispatch_to_evm::<T>)241 }242243 244 fn has_collection_pending_sponsor(&self) -> Result<bool> {245 Ok(matches!(246 self.collection.sponsorship,247 SponsorshipState::Unconfirmed(_)248 ))249 }250251 252 253 254 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {255 self.consume_store_writes(1)?;256257 let caller = T::CrossAccountId::from_eth(caller);258 self.confirm_sponsorship(caller.as_sub())259 .map_err(dispatch_to_evm::<T>)260 }261262 263 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {264 self.consume_store_reads_and_writes(1, 1)?;265 let caller = T::CrossAccountId::from_eth(caller);266 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)267 }268269 270 271 272 fn collection_sponsor(&self) -> Result<eth::CrossAddress> {273 let sponsor = match self.collection.sponsorship.sponsor() {274 Some(sponsor) => sponsor,275 None => return Ok(Default::default()),276 };277278 Ok(eth::CrossAddress::from_sub::<T>(&sponsor))279 }280281 282 283 284 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {285 let limits = &self.collection.limits;286287 Ok(vec![288 eth::CollectionLimit::from_opt_int(289 eth::CollectionLimitField::AccountTokenOwnership,290 limits.account_token_ownership_limit,291 ),292 eth::CollectionLimit::from_opt_int(293 eth::CollectionLimitField::SponsoredDataSize,294 limits.sponsored_data_size,295 ),296 limits297 .sponsored_data_rate_limit298 .and_then(|limit| {299 if let SponsoringRateLimit::Blocks(blocks) = limit {300 Some(eth::CollectionLimit::from_int(301 eth::CollectionLimitField::SponsoredDataRateLimit,302 blocks,303 ))304 } else {305 None306 }307 })308 .unwrap_or(eth::CollectionLimit::from_int(309 eth::CollectionLimitField::SponsoredDataRateLimit,310 Default::default(),311 )),312 eth::CollectionLimit::from_opt_int(313 eth::CollectionLimitField::TokenLimit,314 limits.token_limit,315 ),316 eth::CollectionLimit::from_opt_int(317 eth::CollectionLimitField::SponsorTransferTimeout,318 limits.sponsor_transfer_timeout,319 ),320 eth::CollectionLimit::from_opt_int(321 eth::CollectionLimitField::SponsorApproveTimeout,322 limits.sponsor_approve_timeout,323 ),324 eth::CollectionLimit::from_opt_bool(325 eth::CollectionLimitField::OwnerCanTransfer,326 limits.owner_can_transfer,327 ),328 eth::CollectionLimit::from_opt_bool(329 eth::CollectionLimitField::OwnerCanDestroy,330 limits.owner_can_destroy,331 ),332 eth::CollectionLimit::from_opt_bool(333 eth::CollectionLimitField::TransferEnabled,334 limits.transfers_enabled,335 ),336 ])337 }338339 340 341 342 #[solidity(rename_selector = "setCollectionLimit")]343 fn set_collection_limit(344 &mut self,345 caller: caller,346 limit: eth::CollectionLimit,347 ) -> Result<void> {348 self.consume_store_reads_and_writes(1, 1)?;349350 if !limit.has_value() {351 return Err(Error::Revert("user can't disable limits".into()));352 }353354 let caller = T::CrossAccountId::from_eth(caller);355 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)356 }357358 359 fn contract_address(&self) -> Result<address> {360 Ok(crate::eth::collection_id_to_address(self.id))361 }362363 364 365 fn add_collection_admin_cross(366 &mut self,367 caller: caller,368 new_admin: eth::CrossAddress,369 ) -> Result<void> {370 self.consume_store_reads_and_writes(2, 2)?;371372 let caller = T::CrossAccountId::from_eth(caller);373 let new_admin = new_admin.into_sub_cross_account::<T>()?;374 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;375 Ok(())376 }377378 379 380 fn remove_collection_admin_cross(381 &mut self,382 caller: caller,383 admin: eth::CrossAddress,384 ) -> Result<void> {385 self.consume_store_reads_and_writes(2, 2)?;386387 let caller = T::CrossAccountId::from_eth(caller);388 let admin = admin.into_sub_cross_account::<T>()?;389 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;390 Ok(())391 }392393 394 395 #[solidity(hide)]396 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {397 self.consume_store_reads_and_writes(2, 2)?;398399 let caller = T::CrossAccountId::from_eth(caller);400 let new_admin = T::CrossAccountId::from_eth(new_admin);401 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;402 Ok(())403 }404405 406 407 408 #[solidity(hide)]409 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {410 self.consume_store_reads_and_writes(2, 2)?;411412 let caller = T::CrossAccountId::from_eth(caller);413 let admin = T::CrossAccountId::from_eth(admin);414 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;415 Ok(())416 }417418 419 420 421 #[solidity(rename_selector = "setCollectionNesting")]422 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {423 self.consume_store_reads_and_writes(1, 1)?;424425 let caller = T::CrossAccountId::from_eth(caller);426427 let mut permissions = self.collection.permissions.clone();428 let mut nesting = permissions.nesting().clone();429 nesting.token_owner = enable;430 nesting.restricted = None;431 permissions.nesting = Some(nesting);432433 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)434 }435436 437 438 439 440 #[solidity(rename_selector = "setCollectionNesting")]441 fn set_nesting(442 &mut self,443 caller: caller,444 enable: bool,445 collections: Vec<address>,446 ) -> Result<void> {447 self.consume_store_reads_and_writes(1, 1)?;448449 if collections.is_empty() {450 return Err("no addresses provided".into());451 }452 let caller = T::CrossAccountId::from_eth(caller);453454 let mut permissions = self.collection.permissions.clone();455 match enable {456 false => {457 let mut nesting = permissions.nesting().clone();458 nesting.token_owner = false;459 nesting.restricted = None;460 permissions.nesting = Some(nesting);461 }462 true => {463 let mut bv = OwnerRestrictedSet::new();464 for i in collections {465 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {466 Error::Revert("Can't convert address into collection id".into())467 })?)468 .map_err(|_| "too many collections")?;469 }470 let mut nesting = permissions.nesting().clone();471 nesting.token_owner = true;472 nesting.restricted = Some(bv);473 permissions.nesting = Some(nesting);474 }475 };476477 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)478 }479480 481 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]482 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {483 let nesting = self.collection.permissions.nesting();484485 Ok(eth::CollectionNesting::new(486 nesting.token_owner,487 nesting488 .restricted489 .clone()490 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())491 .unwrap_or_default(),492 ))493 }494495 496 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {497 let nesting = self.collection.permissions.nesting();498 Ok(vec![499 eth::CollectionNestingPermission::new(500 eth::CollectionPermissionField::CollectionAdmin,501 nesting.collection_admin,502 ),503 eth::CollectionNestingPermission::new(504 eth::CollectionPermissionField::TokenOwner,505 nesting.token_owner,506 ),507 ])508 }509 510 511 512 513 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {514 self.consume_store_reads_and_writes(1, 1)?;515516 let caller = T::CrossAccountId::from_eth(caller);517 let permissions = CollectionPermissions {518 access: Some(match mode {519 0 => AccessMode::Normal,520 1 => AccessMode::AllowList,521 _ => return Err("not supported access mode".into()),522 }),523 ..Default::default()524 };525 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)526 }527528 529 530 531 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {532 let user = user.into_sub_cross_account::<T>()?;533 Ok(Pallet::<T>::allowed(self.id, user))534 }535536 537 538 539 #[solidity(hide)]540 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {541 self.consume_store_writes(1)?;542543 let caller = T::CrossAccountId::from_eth(caller);544 let user = T::CrossAccountId::from_eth(user);545 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;546 Ok(())547 }548549 550 551 552 fn add_to_collection_allow_list_cross(553 &mut self,554 caller: caller,555 user: eth::CrossAddress,556 ) -> Result<void> {557 self.consume_store_writes(1)?;558559 let caller = T::CrossAccountId::from_eth(caller);560 let user = user.into_sub_cross_account::<T>()?;561 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;562 Ok(())563 }564565 566 567 568 #[solidity(hide)]569 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {570 self.consume_store_writes(1)?;571572 let caller = T::CrossAccountId::from_eth(caller);573 let user = T::CrossAccountId::from_eth(user);574 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;575 Ok(())576 }577578 579 580 581 fn remove_from_collection_allow_list_cross(582 &mut self,583 caller: caller,584 user: eth::CrossAddress,585 ) -> Result<void> {586 self.consume_store_writes(1)?;587588 let caller = T::CrossAccountId::from_eth(caller);589 let user = user.into_sub_cross_account::<T>()?;590 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;591 Ok(())592 }593594 595 596 597 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {598 self.consume_store_reads_and_writes(1, 1)?;599600 let caller = T::CrossAccountId::from_eth(caller);601 let permissions = CollectionPermissions {602 mint_mode: Some(mode),603 ..Default::default()604 };605 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)606 }607608 609 610 611 612 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]613 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {614 let user = T::CrossAccountId::from_eth(user);615 Ok(self.is_owner_or_admin(&user))616 }617618 619 620 621 622 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {623 let user = user.into_sub_cross_account::<T>()?;624 Ok(self.is_owner_or_admin(&user))625 }626627 628 629 630 fn unique_collection_type(&self) -> Result<string> {631 let mode = match self.collection.mode {632 CollectionMode::Fungible(_) => "Fungible",633 CollectionMode::NFT => "NFT",634 CollectionMode::ReFungible => "ReFungible",635 };636 Ok(mode.into())637 }638639 640 641 642 643 fn collection_owner(&self) -> Result<eth::CrossAddress> {644 Ok(eth::CrossAddress::from_sub_cross_account::<T>(645 &T::CrossAccountId::from_sub(self.owner.clone()),646 ))647 }648649 650 651 652 653 #[solidity(hide, rename_selector = "changeCollectionOwner")]654 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {655 self.consume_store_writes(1)?;656657 let caller = T::CrossAccountId::from_eth(caller);658 let new_owner = T::CrossAccountId::from_eth(new_owner);659 self.change_owner(caller, new_owner)660 .map_err(dispatch_to_evm::<T>)661 }662663 664 665 666 667 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {668 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))669 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))670 .collect();671 Ok(result)672 }673674 675 676 677 678 fn change_collection_owner_cross(679 &mut self,680 caller: caller,681 new_owner: eth::CrossAddress,682 ) -> Result<void> {683 self.consume_store_writes(1)?;684685 let caller = T::CrossAccountId::from_eth(caller);686 let new_owner = new_owner.into_sub_cross_account::<T>()?;687 self.change_owner(caller, new_owner)688 .map_err(dispatch_to_evm::<T>)689 }690}691692693pub mod static_property {694 use evm_coder::{695 execution::{Result, Error},696 };697 use alloc::format;698699 const EXPECT_CONVERT_ERROR: &str = "length < limit";700701 702 pub mod key {703 use super::*;704705 706 pub fn base_uri() -> up_data_structs::PropertyKey {707 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)708 }709710 711 pub fn url() -> up_data_structs::PropertyKey {712 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)713 }714715 716 pub fn suffix() -> up_data_structs::PropertyKey {717 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)718 }719720 721 pub fn parent_nft() -> up_data_structs::PropertyKey {722 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)723 }724 }725726 727 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {728 bytes.to_vec().try_into().map_err(|_| {729 Error::Revert(format!(730 "Property key is too long. Max length is {}.",731 up_data_structs::PropertyKey::bound()732 ))733 })734 }735736 737 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {738 bytes.to_vec().try_into().map_err(|_| {739 Error::Revert(format!(740 "Property key is too long. Max length is {}.",741 up_data_structs::PropertyKey::bound()742 ))743 })744 }745}