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 let caller = T::CrossAccountId::from_eth(caller);351 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)352 }353354 355 fn contract_address(&self) -> Result<address> {356 Ok(crate::eth::collection_id_to_address(self.id))357 }358359 360 361 fn add_collection_admin_cross(362 &mut self,363 caller: caller,364 new_admin: eth::CrossAddress,365 ) -> Result<void> {366 self.consume_store_reads_and_writes(2, 2)?;367368 let caller = T::CrossAccountId::from_eth(caller);369 let new_admin = new_admin.into_sub_cross_account::<T>()?;370 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;371 Ok(())372 }373374 375 376 fn remove_collection_admin_cross(377 &mut self,378 caller: caller,379 admin: eth::CrossAddress,380 ) -> Result<void> {381 self.consume_store_reads_and_writes(2, 2)?;382383 let caller = T::CrossAccountId::from_eth(caller);384 let admin = admin.into_sub_cross_account::<T>()?;385 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;386 Ok(())387 }388389 390 391 #[solidity(hide)]392 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {393 self.consume_store_reads_and_writes(2, 2)?;394395 let caller = T::CrossAccountId::from_eth(caller);396 let new_admin = T::CrossAccountId::from_eth(new_admin);397 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;398 Ok(())399 }400401 402 403 404 #[solidity(hide)]405 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {406 self.consume_store_reads_and_writes(2, 2)?;407408 let caller = T::CrossAccountId::from_eth(caller);409 let admin = T::CrossAccountId::from_eth(admin);410 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;411 Ok(())412 }413414 415 416 417 #[solidity(rename_selector = "setCollectionNesting")]418 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {419 self.consume_store_reads_and_writes(1, 1)?;420421 let caller = T::CrossAccountId::from_eth(caller);422423 let mut permissions = self.collection.permissions.clone();424 let mut nesting = permissions.nesting().clone();425 nesting.token_owner = enable;426 nesting.restricted = None;427 permissions.nesting = Some(nesting);428429 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)430 }431432 433 434 435 436 #[solidity(rename_selector = "setCollectionNesting")]437 fn set_nesting(438 &mut self,439 caller: caller,440 enable: bool,441 collections: Vec<address>,442 ) -> Result<void> {443 self.consume_store_reads_and_writes(1, 1)?;444445 if collections.is_empty() {446 return Err("no addresses provided".into());447 }448 let caller = T::CrossAccountId::from_eth(caller);449450 let mut permissions = self.collection.permissions.clone();451 match enable {452 false => {453 let mut nesting = permissions.nesting().clone();454 nesting.token_owner = false;455 nesting.restricted = None;456 permissions.nesting = Some(nesting);457 }458 true => {459 let mut bv = OwnerRestrictedSet::new();460 for i in collections {461 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {462 Error::Revert("Can't convert address into collection id".into())463 })?)464 .map_err(|_| "too many collections")?;465 }466 let mut nesting = permissions.nesting().clone();467 nesting.token_owner = true;468 nesting.restricted = Some(bv);469 permissions.nesting = Some(nesting);470 }471 };472473 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)474 }475476 477 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]478 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {479 let nesting = self.collection.permissions.nesting();480481 Ok(eth::CollectionNesting::new(482 nesting.token_owner,483 nesting484 .restricted485 .clone()486 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())487 .unwrap_or_default(),488 ))489 }490491 492 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {493 let nesting = self.collection.permissions.nesting();494 Ok(vec![495 eth::CollectionNestingPermission::new(496 eth::CollectionPermissionField::CollectionAdmin,497 nesting.collection_admin,498 ),499 eth::CollectionNestingPermission::new(500 eth::CollectionPermissionField::TokenOwner,501 nesting.token_owner,502 ),503 ])504 }505 506 507 508 509 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {510 self.consume_store_reads_and_writes(1, 1)?;511512 let caller = T::CrossAccountId::from_eth(caller);513 let permissions = CollectionPermissions {514 access: Some(match mode {515 0 => AccessMode::Normal,516 1 => AccessMode::AllowList,517 _ => return Err("not supported access mode".into()),518 }),519 ..Default::default()520 };521 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)522 }523524 525 526 527 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {528 let user = user.into_sub_cross_account::<T>()?;529 Ok(Pallet::<T>::allowed(self.id, user))530 }531532 533 534 535 #[solidity(hide)]536 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {537 self.consume_store_writes(1)?;538539 let caller = T::CrossAccountId::from_eth(caller);540 let user = T::CrossAccountId::from_eth(user);541 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;542 Ok(())543 }544545 546 547 548 fn add_to_collection_allow_list_cross(549 &mut self,550 caller: caller,551 user: eth::CrossAddress,552 ) -> Result<void> {553 self.consume_store_writes(1)?;554555 let caller = T::CrossAccountId::from_eth(caller);556 let user = user.into_sub_cross_account::<T>()?;557 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;558 Ok(())559 }560561 562 563 564 #[solidity(hide)]565 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {566 self.consume_store_writes(1)?;567568 let caller = T::CrossAccountId::from_eth(caller);569 let user = T::CrossAccountId::from_eth(user);570 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;571 Ok(())572 }573574 575 576 577 fn remove_from_collection_allow_list_cross(578 &mut self,579 caller: caller,580 user: eth::CrossAddress,581 ) -> Result<void> {582 self.consume_store_writes(1)?;583584 let caller = T::CrossAccountId::from_eth(caller);585 let user = user.into_sub_cross_account::<T>()?;586 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;587 Ok(())588 }589590 591 592 593 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {594 self.consume_store_reads_and_writes(1, 1)?;595596 let caller = T::CrossAccountId::from_eth(caller);597 let permissions = CollectionPermissions {598 mint_mode: Some(mode),599 ..Default::default()600 };601 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)602 }603604 605 606 607 608 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]609 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {610 let user = T::CrossAccountId::from_eth(user);611 Ok(self.is_owner_or_admin(&user))612 }613614 615 616 617 618 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {619 let user = user.into_sub_cross_account::<T>()?;620 Ok(self.is_owner_or_admin(&user))621 }622623 624 625 626 fn unique_collection_type(&self) -> Result<string> {627 let mode = match self.collection.mode {628 CollectionMode::Fungible(_) => "Fungible",629 CollectionMode::NFT => "NFT",630 CollectionMode::ReFungible => "ReFungible",631 };632 Ok(mode.into())633 }634635 636 637 638 639 fn collection_owner(&self) -> Result<eth::CrossAddress> {640 Ok(eth::CrossAddress::from_sub_cross_account::<T>(641 &T::CrossAccountId::from_sub(self.owner.clone()),642 ))643 }644645 646 647 648 649 #[solidity(hide, rename_selector = "changeCollectionOwner")]650 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {651 self.consume_store_writes(1)?;652653 let caller = T::CrossAccountId::from_eth(caller);654 let new_owner = T::CrossAccountId::from_eth(new_owner);655 self.change_owner(caller, new_owner)656 .map_err(dispatch_to_evm::<T>)657 }658659 660 661 662 663 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {664 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))665 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))666 .collect();667 Ok(result)668 }669670 671 672 673 674 fn change_collection_owner_cross(675 &mut self,676 caller: caller,677 new_owner: eth::CrossAddress,678 ) -> Result<void> {679 self.consume_store_writes(1)?;680681 let caller = T::CrossAccountId::from_eth(caller);682 let new_owner = new_owner.into_sub_cross_account::<T>()?;683 self.change_owner(caller, new_owner)684 .map_err(dispatch_to_evm::<T>)685 }686}687688689pub mod static_property {690 use evm_coder::{691 execution::{Result, Error},692 };693 use alloc::format;694695 const EXPECT_CONVERT_ERROR: &str = "length < limit";696697 698 pub mod key {699 use super::*;700701 702 pub fn base_uri() -> up_data_structs::PropertyKey {703 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)704 }705706 707 pub fn url() -> up_data_structs::PropertyKey {708 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)709 }710711 712 pub fn suffix() -> up_data_structs::PropertyKey {713 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)714 }715716 717 pub fn parent_nft() -> up_data_structs::PropertyKey {718 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)719 }720 }721722 723 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {724 bytes.to_vec().try_into().map_err(|_| {725 Error::Revert(format!(726 "Property key is too long. Max length is {}.",727 up_data_structs::PropertyKey::bound()728 ))729 })730 }731732 733 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {734 bytes.to_vec().try_into().map_err(|_| {735 Error::Revert(format!(736 "Property key is too long. Max length is {}.",737 up_data_structs::PropertyKey::bound()738 ))739 })740 }741}