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 let convert_value_from_bool = |ob: Option<bool>| match ob {288 Some(b) => Some(b as u32),289 None => None,290 };291292 Ok(vec![293 eth::CollectionLimit::new(294 eth::CollectionLimitField::AccountTokenOwnership,295 limits.account_token_ownership_limit,296 ),297 eth::CollectionLimit::new(298 eth::CollectionLimitField::SponsoredDataSize,299 limits.sponsored_data_size,300 ),301 limits302 .sponsored_data_rate_limit303 .and_then(|limit| {304 if let SponsoringRateLimit::Blocks(blocks) = limit {305 Some(eth::CollectionLimit::new(306 eth::CollectionLimitField::SponsoredDataRateLimit,307 Some(blocks),308 ))309 } else {310 None311 }312 })313 .unwrap_or(eth::CollectionLimit::new(314 eth::CollectionLimitField::SponsoredDataRateLimit,315 Default::default(),316 )),317 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),318 eth::CollectionLimit::new(319 eth::CollectionLimitField::SponsorTransferTimeout,320 limits.sponsor_transfer_timeout,321 ),322 eth::CollectionLimit::new(323 eth::CollectionLimitField::SponsorApproveTimeout,324 limits.sponsor_approve_timeout,325 ),326 eth::CollectionLimit::new(327 eth::CollectionLimitField::OwnerCanTransfer,328 convert_value_from_bool(limits.owner_can_transfer),329 ),330 eth::CollectionLimit::new(331 eth::CollectionLimitField::OwnerCanDestroy,332 convert_value_from_bool(limits.owner_can_destroy),333 ),334 eth::CollectionLimit::new(335 eth::CollectionLimitField::TransferEnabled,336 convert_value_from_bool(limits.transfers_enabled),337 ),338 ])339 }340341 342 343 344 #[solidity(rename_selector = "setCollectionLimit")]345 fn set_collection_limit(346 &mut self,347 caller: caller,348 limit: eth::CollectionLimit,349 ) -> Result<void> {350 self.consume_store_reads_and_writes(1, 1)?;351352 if !limit.has_value() {353 return Err(Error::Revert("user can't disable limits".into()));354 }355356 let caller = T::CrossAccountId::from_eth(caller);357 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)358 }359360 361 fn contract_address(&self) -> Result<address> {362 Ok(crate::eth::collection_id_to_address(self.id))363 }364365 366 367 fn add_collection_admin_cross(368 &mut self,369 caller: caller,370 new_admin: eth::CrossAddress,371 ) -> Result<void> {372 self.consume_store_reads_and_writes(2, 2)?;373374 let caller = T::CrossAccountId::from_eth(caller);375 let new_admin = new_admin.into_sub_cross_account::<T>()?;376 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;377 Ok(())378 }379380 381 382 fn remove_collection_admin_cross(383 &mut self,384 caller: caller,385 admin: eth::CrossAddress,386 ) -> Result<void> {387 self.consume_store_reads_and_writes(2, 2)?;388389 let caller = T::CrossAccountId::from_eth(caller);390 let admin = admin.into_sub_cross_account::<T>()?;391 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;392 Ok(())393 }394395 396 397 #[solidity(hide)]398 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {399 self.consume_store_reads_and_writes(2, 2)?;400401 let caller = T::CrossAccountId::from_eth(caller);402 let new_admin = T::CrossAccountId::from_eth(new_admin);403 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;404 Ok(())405 }406407 408 409 410 #[solidity(hide)]411 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {412 self.consume_store_reads_and_writes(2, 2)?;413414 let caller = T::CrossAccountId::from_eth(caller);415 let admin = T::CrossAccountId::from_eth(admin);416 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;417 Ok(())418 }419420 421 422 423 #[solidity(rename_selector = "setCollectionNesting")]424 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {425 self.consume_store_reads_and_writes(1, 1)?;426427 let caller = T::CrossAccountId::from_eth(caller);428429 let mut permissions = self.collection.permissions.clone();430 let mut nesting = permissions.nesting().clone();431 nesting.token_owner = enable;432 nesting.restricted = None;433 permissions.nesting = Some(nesting);434435 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)436 }437438 439 440 441 442 #[solidity(rename_selector = "setCollectionNesting")]443 fn set_nesting(444 &mut self,445 caller: caller,446 enable: bool,447 collections: Vec<address>,448 ) -> Result<void> {449 self.consume_store_reads_and_writes(1, 1)?;450451 if collections.is_empty() {452 return Err("no addresses provided".into());453 }454 let caller = T::CrossAccountId::from_eth(caller);455456 let mut permissions = self.collection.permissions.clone();457 match enable {458 false => {459 let mut nesting = permissions.nesting().clone();460 nesting.token_owner = false;461 nesting.restricted = None;462 permissions.nesting = Some(nesting);463 }464 true => {465 let mut bv = OwnerRestrictedSet::new();466 for i in collections {467 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {468 Error::Revert("Can't convert address into collection id".into())469 })?)470 .map_err(|_| "too many collections")?;471 }472 let mut nesting = permissions.nesting().clone();473 nesting.token_owner = true;474 nesting.restricted = Some(bv);475 permissions.nesting = Some(nesting);476 }477 };478479 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)480 }481482 483 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]484 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {485 let nesting = self.collection.permissions.nesting();486487 Ok(eth::CollectionNesting::new(488 nesting.token_owner,489 nesting490 .restricted491 .clone()492 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())493 .unwrap_or_default(),494 ))495 }496497 498 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {499 let nesting = self.collection.permissions.nesting();500 Ok(vec![501 eth::CollectionNestingPermission::new(502 eth::CollectionPermissionField::CollectionAdmin,503 nesting.collection_admin,504 ),505 eth::CollectionNestingPermission::new(506 eth::CollectionPermissionField::TokenOwner,507 nesting.token_owner,508 ),509 ])510 }511 512 513 514 515 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {516 self.consume_store_reads_and_writes(1, 1)?;517518 let caller = T::CrossAccountId::from_eth(caller);519 let permissions = CollectionPermissions {520 access: Some(match mode {521 0 => AccessMode::Normal,522 1 => AccessMode::AllowList,523 _ => return Err("not supported access mode".into()),524 }),525 ..Default::default()526 };527 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)528 }529530 531 532 533 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {534 let user = user.into_sub_cross_account::<T>()?;535 Ok(Pallet::<T>::allowed(self.id, user))536 }537538 539 540 541 #[solidity(hide)]542 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {543 self.consume_store_writes(1)?;544545 let caller = T::CrossAccountId::from_eth(caller);546 let user = T::CrossAccountId::from_eth(user);547 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;548 Ok(())549 }550551 552 553 554 fn add_to_collection_allow_list_cross(555 &mut self,556 caller: caller,557 user: eth::CrossAddress,558 ) -> Result<void> {559 self.consume_store_writes(1)?;560561 let caller = T::CrossAccountId::from_eth(caller);562 let user = user.into_sub_cross_account::<T>()?;563 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;564 Ok(())565 }566567 568 569 570 #[solidity(hide)]571 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {572 self.consume_store_writes(1)?;573574 let caller = T::CrossAccountId::from_eth(caller);575 let user = T::CrossAccountId::from_eth(user);576 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;577 Ok(())578 }579580 581 582 583 fn remove_from_collection_allow_list_cross(584 &mut self,585 caller: caller,586 user: eth::CrossAddress,587 ) -> Result<void> {588 self.consume_store_writes(1)?;589590 let caller = T::CrossAccountId::from_eth(caller);591 let user = user.into_sub_cross_account::<T>()?;592 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;593 Ok(())594 }595596 597 598 599 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {600 self.consume_store_reads_and_writes(1, 1)?;601602 let caller = T::CrossAccountId::from_eth(caller);603 let permissions = CollectionPermissions {604 mint_mode: Some(mode),605 ..Default::default()606 };607 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)608 }609610 611 612 613 614 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]615 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {616 let user = T::CrossAccountId::from_eth(user);617 Ok(self.is_owner_or_admin(&user))618 }619620 621 622 623 624 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {625 let user = user.into_sub_cross_account::<T>()?;626 Ok(self.is_owner_or_admin(&user))627 }628629 630 631 632 fn unique_collection_type(&self) -> Result<string> {633 let mode = match self.collection.mode {634 CollectionMode::Fungible(_) => "Fungible",635 CollectionMode::NFT => "NFT",636 CollectionMode::ReFungible => "ReFungible",637 };638 Ok(mode.into())639 }640641 642 643 644 645 fn collection_owner(&self) -> Result<eth::CrossAddress> {646 Ok(eth::CrossAddress::from_sub_cross_account::<T>(647 &T::CrossAccountId::from_sub(self.owner.clone()),648 ))649 }650651 652 653 654 655 #[solidity(hide, rename_selector = "changeCollectionOwner")]656 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {657 self.consume_store_writes(1)?;658659 let caller = T::CrossAccountId::from_eth(caller);660 let new_owner = T::CrossAccountId::from_eth(new_owner);661 self.change_owner(caller, new_owner)662 .map_err(dispatch_to_evm::<T>)663 }664665 666 667 668 669 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {670 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))671 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))672 .collect();673 Ok(result)674 }675676 677 678 679 680 fn change_collection_owner_cross(681 &mut self,682 caller: caller,683 new_owner: eth::CrossAddress,684 ) -> Result<void> {685 self.consume_store_writes(1)?;686687 let caller = T::CrossAccountId::from_eth(caller);688 let new_owner = new_owner.into_sub_cross_account::<T>()?;689 self.change_owner(caller, new_owner)690 .map_err(dispatch_to_evm::<T>)691 }692}693694695pub mod static_property {696 use evm_coder::{697 execution::{Result, Error},698 };699 use alloc::format;700701 const EXPECT_CONVERT_ERROR: &str = "length < limit";702703 704 pub mod key {705 use super::*;706707 708 pub fn base_uri() -> up_data_structs::PropertyKey {709 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)710 }711712 713 pub fn url() -> up_data_structs::PropertyKey {714 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)715 }716717 718 pub fn suffix() -> up_data_structs::PropertyKey {719 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)720 }721722 723 pub fn parent_nft() -> up_data_structs::PropertyKey {724 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)725 }726 }727728 729 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {730 bytes.to_vec().try_into().map_err(|_| {731 Error::Revert(format!(732 "Property key is too long. Max length is {}.",733 up_data_structs::PropertyKey::bound()734 ))735 })736 }737738 739 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {740 bytes.to_vec().try_into().map_err(|_| {741 Error::Revert(format!(742 "Property key is too long. Max length is {}.",743 up_data_structs::PropertyKey::bound()744 ))745 })746 }747}