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 sp_core::U256;30use up_data_structs::{31 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,32 SponsoringRateLimit, SponsorshipState,33};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: U256,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(&mut self, caller: caller, key: string, value: bytes) -> Result<()> {98 let caller = T::CrossAccountId::from_eth(caller);99 let key = <Vec<u8>>::from(key)100 .try_into()101 .map_err(|_| "key too large")?;102 let value = value.0.try_into().map_err(|_| "value too large")?;103104 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })105 .map_err(dispatch_to_evm::<T>)106 }107108 109 110 111 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]112 fn set_collection_properties(113 &mut self,114 caller: caller,115 properties: Vec<eth::Property>,116 ) -> Result<()> {117 let caller = T::CrossAccountId::from_eth(caller);118119 let properties = properties120 .into_iter()121 .map(eth::Property::try_into)122 .collect::<Result<Vec<_>>>()?;123124 <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())125 .map_err(dispatch_to_evm::<T>)126 }127128 129 130 131 #[solidity(hide)]132 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]133 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {134 let caller = T::CrossAccountId::from_eth(caller);135 let key = <Vec<u8>>::from(key)136 .try_into()137 .map_err(|_| "key too large")?;138139 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)140 }141142 143 144 145 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]146 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {147 let caller = T::CrossAccountId::from_eth(caller);148 let keys = keys149 .into_iter()150 .map(|key| {151 <Vec<u8>>::from(key)152 .try_into()153 .map_err(|_| Error::Revert("key too large".into()))154 })155 .collect::<Result<Vec<_>>>()?;156157 <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())158 .map_err(dispatch_to_evm::<T>)159 }160161 162 163 164 165 166 167 fn collection_property(&self, key: string) -> Result<bytes> {168 let key = <Vec<u8>>::from(key)169 .try_into()170 .map_err(|_| "key too large")?;171172 let props = CollectionProperties::<T>::get(self.id);173 let prop = props.get(&key).ok_or("key not found")?;174175 Ok(bytes(prop.to_vec()))176 }177178 179 180 181 182 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {183 let keys = keys184 .into_iter()185 .map(|key| {186 <Vec<u8>>::from(key)187 .try_into()188 .map_err(|_| Error::Revert("key too large".into()))189 })190 .collect::<Result<Vec<_>>>()?;191192 let properties = Pallet::<T>::filter_collection_properties(193 self.id,194 if keys.is_empty() { None } else { Some(keys) },195 )196 .map_err(dispatch_to_evm::<T>)?;197198 let properties = properties199 .into_iter()200 .map(Property::try_into)201 .collect::<Result<Vec<_>>>()?;202 Ok(properties)203 }204205 206 207 208 209 210 #[solidity(hide)]211 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<()> {212 self.consume_store_reads_and_writes(1, 1)?;213214 let caller = T::CrossAccountId::from_eth(caller);215216 let sponsor = T::CrossAccountId::from_eth(sponsor);217 self.set_sponsor(&caller, sponsor.as_sub().clone())218 .map_err(dispatch_to_evm::<T>)219 }220221 222 223 224 225 226 fn set_collection_sponsor_cross(227 &mut self,228 caller: caller,229 sponsor: eth::CrossAddress,230 ) -> Result<()> {231 self.consume_store_reads_and_writes(1, 1)?;232233 let caller = T::CrossAccountId::from_eth(caller);234235 let sponsor = sponsor.into_sub_cross_account::<T>()?;236 self.set_sponsor(&caller, sponsor.as_sub().clone())237 .map_err(dispatch_to_evm::<T>)238 }239240 241 fn has_collection_pending_sponsor(&self) -> Result<bool> {242 Ok(matches!(243 self.collection.sponsorship,244 SponsorshipState::Unconfirmed(_)245 ))246 }247248 249 250 251 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<()> {252 self.consume_store_writes(1)?;253254 let caller = T::CrossAccountId::from_eth(caller);255 self.confirm_sponsorship(caller.as_sub())256 .map_err(dispatch_to_evm::<T>)257 }258259 260 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<()> {261 self.consume_store_reads_and_writes(1, 1)?;262 let caller = T::CrossAccountId::from_eth(caller);263 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)264 }265266 267 268 269 fn collection_sponsor(&self) -> Result<eth::CrossAddress> {270 let sponsor = match self.collection.sponsorship.sponsor() {271 Some(sponsor) => sponsor,272 None => return Ok(Default::default()),273 };274275 Ok(eth::CrossAddress::from_sub::<T>(&sponsor))276 }277278 279 280 281 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {282 let limits = &self.collection.limits;283284 let convert_value_from_bool = |ob: Option<bool>| match ob {285 Some(b) => Some(b as u32),286 None => None,287 };288289 Ok(vec![290 eth::CollectionLimit::new(291 eth::CollectionLimitField::AccountTokenOwnership,292 limits.account_token_ownership_limit,293 ),294 eth::CollectionLimit::new(295 eth::CollectionLimitField::SponsoredDataSize,296 limits.sponsored_data_size,297 ),298 limits299 .sponsored_data_rate_limit300 .and_then(|limit| {301 if let SponsoringRateLimit::Blocks(blocks) = limit {302 Some(eth::CollectionLimit::new(303 eth::CollectionLimitField::SponsoredDataRateLimit,304 Some(blocks),305 ))306 } else {307 None308 }309 })310 .unwrap_or(eth::CollectionLimit::new(311 eth::CollectionLimitField::SponsoredDataRateLimit,312 Default::default(),313 )),314 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),315 eth::CollectionLimit::new(316 eth::CollectionLimitField::SponsorTransferTimeout,317 limits.sponsor_transfer_timeout,318 ),319 eth::CollectionLimit::new(320 eth::CollectionLimitField::SponsorApproveTimeout,321 limits.sponsor_approve_timeout,322 ),323 eth::CollectionLimit::new(324 eth::CollectionLimitField::OwnerCanTransfer,325 convert_value_from_bool(limits.owner_can_transfer),326 ),327 eth::CollectionLimit::new(328 eth::CollectionLimitField::OwnerCanDestroy,329 convert_value_from_bool(limits.owner_can_destroy),330 ),331 eth::CollectionLimit::new(332 eth::CollectionLimitField::TransferEnabled,333 convert_value_from_bool(limits.transfers_enabled),334 ),335 ])336 }337338 339 340 341 #[solidity(rename_selector = "setCollectionLimit")]342 fn set_collection_limit(&mut self, caller: caller, limit: eth::CollectionLimit) -> Result<()> {343 self.consume_store_reads_and_writes(1, 1)?;344345 if !limit.has_value() {346 return Err(Error::Revert("user can't disable limits".into()));347 }348349 let caller = T::CrossAccountId::from_eth(caller);350 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)351 }352353 354 fn contract_address(&self) -> Result<address> {355 Ok(crate::eth::collection_id_to_address(self.id))356 }357358 359 360 fn add_collection_admin_cross(361 &mut self,362 caller: caller,363 new_admin: eth::CrossAddress,364 ) -> Result<()> {365 self.consume_store_reads_and_writes(2, 2)?;366367 let caller = T::CrossAccountId::from_eth(caller);368 let new_admin = new_admin.into_sub_cross_account::<T>()?;369 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;370 Ok(())371 }372373 374 375 fn remove_collection_admin_cross(376 &mut self,377 caller: caller,378 admin: eth::CrossAddress,379 ) -> Result<()> {380 self.consume_store_reads_and_writes(2, 2)?;381382 let caller = T::CrossAccountId::from_eth(caller);383 let admin = admin.into_sub_cross_account::<T>()?;384 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;385 Ok(())386 }387388 389 390 #[solidity(hide)]391 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<()> {392 self.consume_store_reads_and_writes(2, 2)?;393394 let caller = T::CrossAccountId::from_eth(caller);395 let new_admin = T::CrossAccountId::from_eth(new_admin);396 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;397 Ok(())398 }399400 401 402 403 #[solidity(hide)]404 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<()> {405 self.consume_store_reads_and_writes(2, 2)?;406407 let caller = T::CrossAccountId::from_eth(caller);408 let admin = T::CrossAccountId::from_eth(admin);409 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;410 Ok(())411 }412413 414 415 416 #[solidity(rename_selector = "setCollectionNesting")]417 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<()> {418 self.consume_store_reads_and_writes(1, 1)?;419420 let caller = T::CrossAccountId::from_eth(caller);421422 let mut permissions = self.collection.permissions.clone();423 let mut nesting = permissions.nesting().clone();424 nesting.token_owner = enable;425 nesting.restricted = None;426 permissions.nesting = Some(nesting);427428 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)429 }430431 432 433 434 435 #[solidity(rename_selector = "setCollectionNesting")]436 fn set_nesting(437 &mut self,438 caller: caller,439 enable: bool,440 collections: Vec<address>,441 ) -> Result<()> {442 self.consume_store_reads_and_writes(1, 1)?;443444 if collections.is_empty() {445 return Err("no addresses provided".into());446 }447 let caller = T::CrossAccountId::from_eth(caller);448449 let mut permissions = self.collection.permissions.clone();450 match enable {451 false => {452 let mut nesting = permissions.nesting().clone();453 nesting.token_owner = false;454 nesting.restricted = None;455 permissions.nesting = Some(nesting);456 }457 true => {458 let mut bv = OwnerRestrictedSet::new();459 for i in collections {460 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {461 Error::Revert("Can't convert address into collection id".into())462 })?)463 .map_err(|_| "too many collections")?;464 }465 let mut nesting = permissions.nesting().clone();466 nesting.token_owner = true;467 nesting.restricted = Some(bv);468 permissions.nesting = Some(nesting);469 }470 };471472 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)473 }474475 476 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]477 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {478 let nesting = self.collection.permissions.nesting();479480 Ok(eth::CollectionNesting::new(481 nesting.token_owner,482 nesting483 .restricted484 .clone()485 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())486 .unwrap_or_default(),487 ))488 }489490 491 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {492 let nesting = self.collection.permissions.nesting();493 Ok(vec![494 eth::CollectionNestingPermission::new(495 eth::CollectionPermissionField::CollectionAdmin,496 nesting.collection_admin,497 ),498 eth::CollectionNestingPermission::new(499 eth::CollectionPermissionField::TokenOwner,500 nesting.token_owner,501 ),502 ])503 }504 505 506 fn set_collection_access(&mut self, caller: caller, mode: eth::AccessMode) -> Result<()> {507 self.consume_store_reads_and_writes(1, 1)?;508509 let caller = T::CrossAccountId::from_eth(caller);510 let permissions = CollectionPermissions {511 access: Some(mode.into()),512 ..Default::default()513 };514 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)515 }516517 518 519 520 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {521 let user = user.into_sub_cross_account::<T>()?;522 Ok(Pallet::<T>::allowed(self.id, user))523 }524525 526 527 528 #[solidity(hide)]529 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {530 self.consume_store_writes(1)?;531532 let caller = T::CrossAccountId::from_eth(caller);533 let user = T::CrossAccountId::from_eth(user);534 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;535 Ok(())536 }537538 539 540 541 fn add_to_collection_allow_list_cross(542 &mut self,543 caller: caller,544 user: eth::CrossAddress,545 ) -> Result<()> {546 self.consume_store_writes(1)?;547548 let caller = T::CrossAccountId::from_eth(caller);549 let user = user.into_sub_cross_account::<T>()?;550 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;551 Ok(())552 }553554 555 556 557 #[solidity(hide)]558 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {559 self.consume_store_writes(1)?;560561 let caller = T::CrossAccountId::from_eth(caller);562 let user = T::CrossAccountId::from_eth(user);563 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;564 Ok(())565 }566567 568 569 570 fn remove_from_collection_allow_list_cross(571 &mut self,572 caller: caller,573 user: eth::CrossAddress,574 ) -> Result<()> {575 self.consume_store_writes(1)?;576577 let caller = T::CrossAccountId::from_eth(caller);578 let user = user.into_sub_cross_account::<T>()?;579 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;580 Ok(())581 }582583 584 585 586 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<()> {587 self.consume_store_reads_and_writes(1, 1)?;588589 let caller = T::CrossAccountId::from_eth(caller);590 let permissions = CollectionPermissions {591 mint_mode: Some(mode),592 ..Default::default()593 };594 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)595 }596597 598 599 600 601 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]602 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {603 let user = T::CrossAccountId::from_eth(user);604 Ok(self.is_owner_or_admin(&user))605 }606607 608 609 610 611 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {612 let user = user.into_sub_cross_account::<T>()?;613 Ok(self.is_owner_or_admin(&user))614 }615616 617 618 619 fn unique_collection_type(&self) -> Result<string> {620 let mode = match self.collection.mode {621 CollectionMode::Fungible(_) => "Fungible",622 CollectionMode::NFT => "NFT",623 CollectionMode::ReFungible => "ReFungible",624 };625 Ok(mode.into())626 }627628 629 630 631 632 fn collection_owner(&self) -> Result<eth::CrossAddress> {633 Ok(eth::CrossAddress::from_sub_cross_account::<T>(634 &T::CrossAccountId::from_sub(self.owner.clone()),635 ))636 }637638 639 640 641 642 #[solidity(hide, rename_selector = "changeCollectionOwner")]643 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<()> {644 self.consume_store_writes(1)?;645646 let caller = T::CrossAccountId::from_eth(caller);647 let new_owner = T::CrossAccountId::from_eth(new_owner);648 self.change_owner(caller, new_owner)649 .map_err(dispatch_to_evm::<T>)650 }651652 653 654 655 656 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {657 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))658 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))659 .collect();660 Ok(result)661 }662663 664 665 666 667 fn change_collection_owner_cross(668 &mut self,669 caller: caller,670 new_owner: eth::CrossAddress,671 ) -> Result<()> {672 self.consume_store_writes(1)?;673674 let caller = T::CrossAccountId::from_eth(caller);675 let new_owner = new_owner.into_sub_cross_account::<T>()?;676 self.change_owner(caller, new_owner)677 .map_err(dispatch_to_evm::<T>)678 }679}680681682pub mod static_property {683 use evm_coder::{684 execution::{Result, Error},685 };686 use alloc::format;687688 const EXPECT_CONVERT_ERROR: &str = "length < limit";689690 691 pub mod key {692 use super::*;693694 695 pub fn base_uri() -> up_data_structs::PropertyKey {696 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)697 }698699 700 pub fn url() -> up_data_structs::PropertyKey {701 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)702 }703704 705 pub fn suffix() -> up_data_structs::PropertyKey {706 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)707 }708709 710 pub fn parent_nft() -> up_data_structs::PropertyKey {711 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)712 }713 }714715 716 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {717 bytes.to_vec().try_into().map_err(|_| {718 Error::Revert(format!(719 "Property key is too long. Max length is {}.",720 up_data_structs::PropertyKey::bound()721 ))722 })723 }724725 726 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {727 bytes.to_vec().try_into().map_err(|_| {728 Error::Revert(format!(729 "Property key is too long. Max length is {}.",730 up_data_structs::PropertyKey::bound()731 ))732 })733 }734}