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::new(289 eth::CollectionLimitField::AccountTokenOwnership,290 limits.account_token_ownership_limit,291 ),292 eth::CollectionLimit::new(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::new::<u32>(301 eth::CollectionLimitField::SponsoredDataRateLimit,302 blocks,303 ))304 } else {305 None306 }307 })308 .unwrap_or(eth::CollectionLimit::new::<u32>(309 eth::CollectionLimitField::SponsoredDataRateLimit,310 Default::default(),311 )),312 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),313 eth::CollectionLimit::new(314 eth::CollectionLimitField::SponsorTransferTimeout,315 limits.sponsor_transfer_timeout,316 ),317 eth::CollectionLimit::new(318 eth::CollectionLimitField::SponsorApproveTimeout,319 limits.sponsor_approve_timeout,320 ),321 eth::CollectionLimit::new(322 eth::CollectionLimitField::OwnerCanTransfer,323 limits.owner_can_transfer,324 ),325 eth::CollectionLimit::new(326 eth::CollectionLimitField::OwnerCanDestroy,327 limits.owner_can_destroy,328 ),329 eth::CollectionLimit::new(330 eth::CollectionLimitField::TransferEnabled,331 limits.transfers_enabled,332 ),333 ])334 }335336 337 338 339 #[solidity(rename_selector = "setCollectionLimit")]340 fn set_collection_limit(341 &mut self,342 caller: caller,343 limit: eth::CollectionLimit,344 ) -> Result<void> {345 self.consume_store_reads_and_writes(1, 1)?;346347 if !limit.has_value() {348 return Err(Error::Revert("user can't disable limits".into()));349 }350351 let caller = T::CrossAccountId::from_eth(caller);352 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)353 }354355 356 fn contract_address(&self) -> Result<address> {357 Ok(crate::eth::collection_id_to_address(self.id))358 }359360 361 362 fn add_collection_admin_cross(363 &mut self,364 caller: caller,365 new_admin: eth::CrossAddress,366 ) -> Result<void> {367 self.consume_store_reads_and_writes(2, 2)?;368369 let caller = T::CrossAccountId::from_eth(caller);370 let new_admin = new_admin.into_sub_cross_account::<T>()?;371 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;372 Ok(())373 }374375 376 377 fn remove_collection_admin_cross(378 &mut self,379 caller: caller,380 admin: eth::CrossAddress,381 ) -> Result<void> {382 self.consume_store_reads_and_writes(2, 2)?;383384 let caller = T::CrossAccountId::from_eth(caller);385 let admin = admin.into_sub_cross_account::<T>()?;386 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;387 Ok(())388 }389390 391 392 #[solidity(hide)]393 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {394 self.consume_store_reads_and_writes(2, 2)?;395396 let caller = T::CrossAccountId::from_eth(caller);397 let new_admin = T::CrossAccountId::from_eth(new_admin);398 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;399 Ok(())400 }401402 403 404 405 #[solidity(hide)]406 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {407 self.consume_store_reads_and_writes(2, 2)?;408409 let caller = T::CrossAccountId::from_eth(caller);410 let admin = T::CrossAccountId::from_eth(admin);411 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;412 Ok(())413 }414415 416 417 418 #[solidity(rename_selector = "setCollectionNesting")]419 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {420 self.consume_store_reads_and_writes(1, 1)?;421422 let caller = T::CrossAccountId::from_eth(caller);423424 let mut permissions = self.collection.permissions.clone();425 let mut nesting = permissions.nesting().clone();426 nesting.token_owner = enable;427 nesting.restricted = None;428 permissions.nesting = Some(nesting);429430 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)431 }432433 434 435 436 437 #[solidity(rename_selector = "setCollectionNesting")]438 fn set_nesting(439 &mut self,440 caller: caller,441 enable: bool,442 collections: Vec<address>,443 ) -> Result<void> {444 self.consume_store_reads_and_writes(1, 1)?;445446 if collections.is_empty() {447 return Err("no addresses provided".into());448 }449 let caller = T::CrossAccountId::from_eth(caller);450451 let mut permissions = self.collection.permissions.clone();452 match enable {453 false => {454 let mut nesting = permissions.nesting().clone();455 nesting.token_owner = false;456 nesting.restricted = None;457 permissions.nesting = Some(nesting);458 }459 true => {460 let mut bv = OwnerRestrictedSet::new();461 for i in collections {462 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {463 Error::Revert("Can't convert address into collection id".into())464 })?)465 .map_err(|_| "too many collections")?;466 }467 let mut nesting = permissions.nesting().clone();468 nesting.token_owner = true;469 nesting.restricted = Some(bv);470 permissions.nesting = Some(nesting);471 }472 };473474 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)475 }476477 478 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]479 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {480 let nesting = self.collection.permissions.nesting();481482 Ok(eth::CollectionNesting::new(483 nesting.token_owner,484 nesting485 .restricted486 .clone()487 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())488 .unwrap_or_default(),489 ))490 }491492 493 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {494 let nesting = self.collection.permissions.nesting();495 Ok(vec![496 eth::CollectionNestingPermission::new(497 eth::CollectionPermissionField::CollectionAdmin,498 nesting.collection_admin,499 ),500 eth::CollectionNestingPermission::new(501 eth::CollectionPermissionField::TokenOwner,502 nesting.token_owner,503 ),504 ])505 }506 507 508 509 510 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {511 self.consume_store_reads_and_writes(1, 1)?;512513 let caller = T::CrossAccountId::from_eth(caller);514 let permissions = CollectionPermissions {515 access: Some(match mode {516 0 => AccessMode::Normal,517 1 => AccessMode::AllowList,518 _ => return Err("not supported access mode".into()),519 }),520 ..Default::default()521 };522 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)523 }524525 526 527 528 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {529 let user = user.into_sub_cross_account::<T>()?;530 Ok(Pallet::<T>::allowed(self.id, user))531 }532533 534 535 536 #[solidity(hide)]537 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {538 self.consume_store_writes(1)?;539540 let caller = T::CrossAccountId::from_eth(caller);541 let user = T::CrossAccountId::from_eth(user);542 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;543 Ok(())544 }545546 547 548 549 fn add_to_collection_allow_list_cross(550 &mut self,551 caller: caller,552 user: eth::CrossAddress,553 ) -> Result<void> {554 self.consume_store_writes(1)?;555556 let caller = T::CrossAccountId::from_eth(caller);557 let user = user.into_sub_cross_account::<T>()?;558 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;559 Ok(())560 }561562 563 564 565 #[solidity(hide)]566 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {567 self.consume_store_writes(1)?;568569 let caller = T::CrossAccountId::from_eth(caller);570 let user = T::CrossAccountId::from_eth(user);571 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;572 Ok(())573 }574575 576 577 578 fn remove_from_collection_allow_list_cross(579 &mut self,580 caller: caller,581 user: eth::CrossAddress,582 ) -> Result<void> {583 self.consume_store_writes(1)?;584585 let caller = T::CrossAccountId::from_eth(caller);586 let user = user.into_sub_cross_account::<T>()?;587 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;588 Ok(())589 }590591 592 593 594 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {595 self.consume_store_reads_and_writes(1, 1)?;596597 let caller = T::CrossAccountId::from_eth(caller);598 let permissions = CollectionPermissions {599 mint_mode: Some(mode),600 ..Default::default()601 };602 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)603 }604605 606 607 608 609 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]610 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {611 let user = T::CrossAccountId::from_eth(user);612 Ok(self.is_owner_or_admin(&user))613 }614615 616 617 618 619 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {620 let user = user.into_sub_cross_account::<T>()?;621 Ok(self.is_owner_or_admin(&user))622 }623624 625 626 627 fn unique_collection_type(&self) -> Result<string> {628 let mode = match self.collection.mode {629 CollectionMode::Fungible(_) => "Fungible",630 CollectionMode::NFT => "NFT",631 CollectionMode::ReFungible => "ReFungible",632 };633 Ok(mode.into())634 }635636 637 638 639 640 fn collection_owner(&self) -> Result<eth::CrossAddress> {641 Ok(eth::CrossAddress::from_sub_cross_account::<T>(642 &T::CrossAccountId::from_sub(self.owner.clone()),643 ))644 }645646 647 648 649 650 #[solidity(hide, rename_selector = "changeCollectionOwner")]651 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {652 self.consume_store_writes(1)?;653654 let caller = T::CrossAccountId::from_eth(caller);655 let new_owner = T::CrossAccountId::from_eth(new_owner);656 self.change_owner(caller, new_owner)657 .map_err(dispatch_to_evm::<T>)658 }659660 661 662 663 664 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {665 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))666 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))667 .collect();668 Ok(result)669 }670671 672 673 674 675 fn change_collection_owner_cross(676 &mut self,677 caller: caller,678 new_owner: eth::CrossAddress,679 ) -> Result<void> {680 self.consume_store_writes(1)?;681682 let caller = T::CrossAccountId::from_eth(caller);683 let new_owner = new_owner.into_sub_cross_account::<T>()?;684 self.change_owner(caller, new_owner)685 .map_err(dispatch_to_evm::<T>)686 }687}688689690pub mod static_property {691 use evm_coder::{692 execution::{Result, Error},693 };694 use alloc::format;695696 const EXPECT_CONVERT_ERROR: &str = "length < limit";697698 699 pub mod key {700 use super::*;701702 703 pub fn base_uri() -> up_data_structs::PropertyKey {704 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)705 }706707 708 pub fn url() -> up_data_structs::PropertyKey {709 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)710 }711712 713 pub fn suffix() -> up_data_structs::PropertyKey {714 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)715 }716717 718 pub fn parent_nft() -> up_data_structs::PropertyKey {719 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)720 }721 }722723 724 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {725 bytes.to_vec().try_into().map_err(|_| {726 Error::Revert(format!(727 "Property key is too long. Max length is {}.",728 up_data_structs::PropertyKey::bound()729 ))730 })731 }732733 734 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {735 bytes.to_vec().try_into().map_err(|_| {736 Error::Revert(format!(737 "Property key is too long. Max length is {}.",738 up_data_structs::PropertyKey::bound()739 ))740 })741 }742}