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};33use alloc::format;3435use crate::{36 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,37 eth::{38 Property as PropertyStruct, EthCrossAccount, CollectionPermissions as EvmPermissions,39 CollectionLimits as EvmCollectionLimits,40 },41 weights::WeightInfo,42};434445#[derive(ToLog)]46pub enum CollectionHelpersEvents {47 48 CollectionCreated {49 50 #[indexed]51 owner: address,5253 54 #[indexed]55 collection_id: address,56 },57 58 CollectionDestroyed {59 60 #[indexed]61 collection_id: address,62 },63 64 CollectionChanged {65 66 #[indexed]67 collection_id: address,68 },6970 71 TokenChanged {72 73 #[indexed]74 collection_id: address,75 76 token_id: uint256,77 },78}79808182pub trait CommonEvmHandler {83 84 const CODE: &'static [u8];8586 87 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;88}899091#[solidity_interface(name = Collection)]92impl<T: Config> CollectionHandle<T>93where94 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,95{96 97 98 99 100 #[solidity(hide)]101 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]102 fn set_collection_property(103 &mut self,104 caller: caller,105 key: string,106 value: bytes,107 ) -> Result<void> {108 let caller = T::CrossAccountId::from_eth(caller);109 let key = <Vec<u8>>::from(key)110 .try_into()111 .map_err(|_| "key too large")?;112 let value = value.0.try_into().map_err(|_| "value too large")?;113114 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })115 .map_err(dispatch_to_evm::<T>)116 }117118 119 120 121 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]122 fn set_collection_properties(123 &mut self,124 caller: caller,125 properties: Vec<PropertyStruct>,126 ) -> Result<void> {127 let caller = T::CrossAccountId::from_eth(caller);128129 let properties = properties130 .into_iter()131 .map(|PropertyStruct { key, value }| {132 let key = <Vec<u8>>::from(key)133 .try_into()134 .map_err(|_| "key too large")?;135136 let value = value.0.try_into().map_err(|_| "value too large")?;137138 Ok(Property { key, value })139 })140 .collect::<Result<Vec<_>>>()?;141142 <Pallet<T>>::set_collection_properties(self, &caller, properties)143 .map_err(dispatch_to_evm::<T>)144 }145146 147 148 149 #[solidity(hide)]150 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]151 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {152 let caller = T::CrossAccountId::from_eth(caller);153 let key = <Vec<u8>>::from(key)154 .try_into()155 .map_err(|_| "key too large")?;156157 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)158 }159160 161 162 163 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]164 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {165 let caller = T::CrossAccountId::from_eth(caller);166 let keys = keys167 .into_iter()168 .map(|key| {169 <Vec<u8>>::from(key)170 .try_into()171 .map_err(|_| Error::Revert("key too large".into()))172 })173 .collect::<Result<Vec<_>>>()?;174175 <Pallet<T>>::delete_collection_properties(self, &caller, keys).map_err(dispatch_to_evm::<T>)176 }177178 179 180 181 182 183 184 fn collection_property(&self, key: string) -> Result<bytes> {185 let key = <Vec<u8>>::from(key)186 .try_into()187 .map_err(|_| "key too large")?;188189 let props = CollectionProperties::<T>::get(self.id);190 let prop = props.get(&key).ok_or("key not found")?;191192 Ok(bytes(prop.to_vec()))193 }194195 196 197 198 199 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {200 let keys = keys201 .into_iter()202 .map(|key| {203 <Vec<u8>>::from(key)204 .try_into()205 .map_err(|_| Error::Revert("key too large".into()))206 })207 .collect::<Result<Vec<_>>>()?;208209 let properties = Pallet::<T>::filter_collection_properties(210 self.id,211 if keys.is_empty() { None } else { Some(keys) },212 )213 .map_err(dispatch_to_evm::<T>)?;214215 let properties = properties216 .into_iter()217 .map(|p| {218 let key =219 string::from_utf8(p.key.into()).map_err(|e| Error::Revert(format!("{}", e)))?;220 let value = bytes(p.value.to_vec());221 Ok(PropertyStruct { key, value })222 })223 .collect::<Result<Vec<_>>>()?;224 Ok(properties)225 }226227 228 229 230 231 232 #[solidity(hide)]233 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {234 self.consume_store_reads_and_writes(1, 1)?;235236 let caller = T::CrossAccountId::from_eth(caller);237238 let sponsor = T::CrossAccountId::from_eth(sponsor);239 self.set_sponsor(&caller, sponsor.as_sub().clone())240 .map_err(dispatch_to_evm::<T>)241 }242243 244 245 246 247 248 fn set_collection_sponsor_cross(249 &mut self,250 caller: caller,251 sponsor: EthCrossAccount,252 ) -> Result<void> {253 self.consume_store_reads_and_writes(1, 1)?;254255 let caller = T::CrossAccountId::from_eth(caller);256257 let sponsor = sponsor.into_sub_cross_account::<T>()?;258 self.set_sponsor(&caller, sponsor.as_sub().clone())259 .map_err(dispatch_to_evm::<T>)260 }261262 263 fn has_collection_pending_sponsor(&self) -> Result<bool> {264 Ok(matches!(265 self.collection.sponsorship,266 SponsorshipState::Unconfirmed(_)267 ))268 }269270 271 272 273 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {274 self.consume_store_writes(1)?;275276 let caller = T::CrossAccountId::from_eth(caller);277 self.confirm_sponsorship(caller.as_sub())278 .map_err(dispatch_to_evm::<T>)279 }280281 282 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {283 self.consume_store_reads_and_writes(1, 1)?;284 let caller = T::CrossAccountId::from_eth(caller);285 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)286 }287288 289 290 291 fn collection_sponsor(&self) -> Result<EthCrossAccount> {292 let sponsor = match self.collection.sponsorship.sponsor() {293 Some(sponsor) => sponsor,294 None => return Ok(Default::default()),295 };296297 Ok(EthCrossAccount::from_sub::<T>(&sponsor))298 }299300 301 302 303 304 305 306 307 308 309 310 311 312 313 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {314 let convert_value_limit = |limit: EvmCollectionLimits,315 value: Option<u32>|316 -> (EvmCollectionLimits, bool, uint256) {317 value318 .map(|v| (limit, true, v.into()))319 .unwrap_or((limit, false, Default::default()))320 };321322 let convert_bool_limit = |limit: EvmCollectionLimits,323 value: Option<bool>|324 -> (EvmCollectionLimits, bool, uint256) {325 value326 .map(|v| {327 (328 limit,329 true,330 if v {331 uint256::from(1)332 } else {333 Default::default()334 },335 )336 })337 .unwrap_or((limit, false, Default::default()))338 };339340 let limits = &self.collection.limits;341342 Ok(vec![343 convert_value_limit(344 EvmCollectionLimits::AccountTokenOwnership,345 limits.account_token_ownership_limit,346 ),347 convert_value_limit(348 EvmCollectionLimits::SponsoredDataSize,349 limits.sponsored_data_size,350 ),351 limits352 .sponsored_data_rate_limit353 .and_then(|limit| {354 if let SponsoringRateLimit::Blocks(blocks) = limit {355 Some((356 EvmCollectionLimits::SponsoredDataRateLimit,357 true,358 blocks.into(),359 ))360 } else {361 None362 }363 })364 .unwrap_or((365 EvmCollectionLimits::SponsoredDataRateLimit,366 false,367 Default::default(),368 )),369 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),370 convert_value_limit(371 EvmCollectionLimits::SponsorTransferTimeout,372 limits.sponsor_transfer_timeout,373 ),374 convert_value_limit(375 EvmCollectionLimits::SponsorApproveTimeout,376 limits.sponsor_approve_timeout,377 ),378 convert_bool_limit(379 EvmCollectionLimits::OwnerCanTransfer,380 limits.owner_can_transfer,381 ),382 convert_bool_limit(383 EvmCollectionLimits::OwnerCanDestroy,384 limits.owner_can_destroy,385 ),386 convert_bool_limit(387 EvmCollectionLimits::TransferEnabled,388 limits.transfers_enabled,389 ),390 ])391 }392393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 #[solidity(rename_selector = "setCollectionLimit")]408 fn set_collection_limit(409 &mut self,410 caller: caller,411 limit: EvmCollectionLimits,412 status: bool,413 value: uint256,414 ) -> Result<void> {415 self.consume_store_reads_and_writes(1, 1)?;416417 if !status {418 return Err(Error::Revert("user can't disable limits".into()));419 }420421 let value = value422 .try_into()423 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;424425 let convert_value_to_bool = || match value {426 0 => Ok(false),427 1 => Ok(true),428 _ => {429 return Err(Error::Revert(format!(430 "can't convert value to boolean \"{}\"",431 value432 )))433 }434 };435436 let mut limits = self.limits.clone();437438 match limit {439 EvmCollectionLimits::AccountTokenOwnership => {440 limits.account_token_ownership_limit = Some(value);441 }442 EvmCollectionLimits::SponsoredDataSize => {443 limits.sponsored_data_size = Some(value);444 }445 EvmCollectionLimits::SponsoredDataRateLimit => {446 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));447 }448 EvmCollectionLimits::TokenLimit => {449 limits.token_limit = Some(value);450 }451 EvmCollectionLimits::SponsorTransferTimeout => {452 limits.sponsor_transfer_timeout = Some(value);453 }454 EvmCollectionLimits::SponsorApproveTimeout => {455 limits.sponsor_approve_timeout = Some(value);456 }457 EvmCollectionLimits::OwnerCanTransfer => {458 limits.owner_can_transfer = Some(convert_value_to_bool()?);459 }460 EvmCollectionLimits::OwnerCanDestroy => {461 limits.owner_can_destroy = Some(convert_value_to_bool()?);462 }463 EvmCollectionLimits::TransferEnabled => {464 limits.transfers_enabled = Some(convert_value_to_bool()?);465 }466 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),467 }468469 let caller = T::CrossAccountId::from_eth(caller);470 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)471 }472473 474 fn contract_address(&self) -> Result<address> {475 Ok(crate::eth::collection_id_to_address(self.id))476 }477478 479 480 fn add_collection_admin_cross(481 &mut self,482 caller: caller,483 new_admin: EthCrossAccount,484 ) -> Result<void> {485 self.consume_store_reads_and_writes(2, 2)?;486487 let caller = T::CrossAccountId::from_eth(caller);488 let new_admin = new_admin.into_sub_cross_account::<T>()?;489 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;490 Ok(())491 }492493 494 495 fn remove_collection_admin_cross(496 &mut self,497 caller: caller,498 admin: EthCrossAccount,499 ) -> Result<void> {500 self.consume_store_reads_and_writes(2, 2)?;501502 let caller = T::CrossAccountId::from_eth(caller);503 let admin = admin.into_sub_cross_account::<T>()?;504 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;505 Ok(())506 }507508 509 510 #[solidity(hide)]511 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {512 self.consume_store_reads_and_writes(2, 2)?;513514 let caller = T::CrossAccountId::from_eth(caller);515 let new_admin = T::CrossAccountId::from_eth(new_admin);516 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;517 Ok(())518 }519520 521 522 523 #[solidity(hide)]524 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {525 self.consume_store_reads_and_writes(2, 2)?;526527 let caller = T::CrossAccountId::from_eth(caller);528 let admin = T::CrossAccountId::from_eth(admin);529 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;530 Ok(())531 }532533 534 535 536 #[solidity(rename_selector = "setCollectionNesting")]537 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {538 self.consume_store_reads_and_writes(1, 1)?;539540 let caller = T::CrossAccountId::from_eth(caller);541542 let mut permissions = self.collection.permissions.clone();543 let mut nesting = permissions.nesting().clone();544 nesting.token_owner = enable;545 nesting.restricted = None;546 permissions.nesting = Some(nesting);547548 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)549 }550551 552 553 554 555 #[solidity(rename_selector = "setCollectionNesting")]556 fn set_nesting(557 &mut self,558 caller: caller,559 enable: bool,560 collections: Vec<address>,561 ) -> Result<void> {562 self.consume_store_reads_and_writes(1, 1)?;563564 if collections.is_empty() {565 return Err("no addresses provided".into());566 }567 let caller = T::CrossAccountId::from_eth(caller);568569 let mut permissions = self.collection.permissions.clone();570 match enable {571 false => {572 let mut nesting = permissions.nesting().clone();573 nesting.token_owner = false;574 nesting.restricted = None;575 permissions.nesting = Some(nesting);576 }577 true => {578 let mut bv = OwnerRestrictedSet::new();579 for i in collections {580 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {581 Error::Revert("Can't convert address into collection id".into())582 })?)583 .map_err(|_| "too many collections")?;584 }585 let mut nesting = permissions.nesting().clone();586 nesting.token_owner = true;587 nesting.restricted = Some(bv);588 permissions.nesting = Some(nesting);589 }590 };591592 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)593 }594595 596 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]597 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {598 let nesting = self.collection.permissions.nesting();599600 Ok((601 nesting.token_owner,602 nesting603 .restricted604 .clone()605 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())606 .unwrap_or_default(),607 ))608 }609610 611 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {612 let nesting = self.collection.permissions.nesting();613 Ok(vec![614 (EvmPermissions::CollectionAdmin, nesting.collection_admin),615 (EvmPermissions::TokenOwner, nesting.token_owner),616 ])617 }618 619 620 621 622 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {623 self.consume_store_reads_and_writes(1, 1)?;624625 let caller = T::CrossAccountId::from_eth(caller);626 let permissions = CollectionPermissions {627 access: Some(match mode {628 0 => AccessMode::Normal,629 1 => AccessMode::AllowList,630 _ => return Err("not supported access mode".into()),631 }),632 ..Default::default()633 };634 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)635 }636637 638 639 640 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {641 let user = user.into_sub_cross_account::<T>()?;642 Ok(Pallet::<T>::allowed(self.id, user))643 }644645 646 647 648 #[solidity(hide)]649 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {650 self.consume_store_writes(1)?;651652 let caller = T::CrossAccountId::from_eth(caller);653 let user = T::CrossAccountId::from_eth(user);654 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;655 Ok(())656 }657658 659 660 661 fn add_to_collection_allow_list_cross(662 &mut self,663 caller: caller,664 user: EthCrossAccount,665 ) -> Result<void> {666 self.consume_store_writes(1)?;667668 let caller = T::CrossAccountId::from_eth(caller);669 let user = user.into_sub_cross_account::<T>()?;670 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;671 Ok(())672 }673674 675 676 677 #[solidity(hide)]678 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {679 self.consume_store_writes(1)?;680681 let caller = T::CrossAccountId::from_eth(caller);682 let user = T::CrossAccountId::from_eth(user);683 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;684 Ok(())685 }686687 688 689 690 fn remove_from_collection_allow_list_cross(691 &mut self,692 caller: caller,693 user: EthCrossAccount,694 ) -> Result<void> {695 self.consume_store_writes(1)?;696697 let caller = T::CrossAccountId::from_eth(caller);698 let user = user.into_sub_cross_account::<T>()?;699 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;700 Ok(())701 }702703 704 705 706 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {707 self.consume_store_reads_and_writes(1, 1)?;708709 let caller = T::CrossAccountId::from_eth(caller);710 let permissions = CollectionPermissions {711 mint_mode: Some(mode),712 ..Default::default()713 };714 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)715 }716717 718 719 720 721 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]722 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {723 let user = T::CrossAccountId::from_eth(user);724 Ok(self.is_owner_or_admin(&user))725 }726727 728 729 730 731 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {732 let user = user.into_sub_cross_account::<T>()?;733 Ok(self.is_owner_or_admin(&user))734 }735736 737 738 739 fn unique_collection_type(&self) -> Result<string> {740 let mode = match self.collection.mode {741 CollectionMode::Fungible(_) => "Fungible",742 CollectionMode::NFT => "NFT",743 CollectionMode::ReFungible => "ReFungible",744 };745 Ok(mode.into())746 }747748 749 750 751 752 fn collection_owner(&self) -> Result<EthCrossAccount> {753 Ok(EthCrossAccount::from_sub_cross_account::<T>(754 &T::CrossAccountId::from_sub(self.owner.clone()),755 ))756 }757758 759 760 761 762 #[solidity(hide, rename_selector = "changeCollectionOwner")]763 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {764 self.consume_store_writes(1)?;765766 let caller = T::CrossAccountId::from_eth(caller);767 let new_owner = T::CrossAccountId::from_eth(new_owner);768 self.change_owner(caller, new_owner)769 .map_err(dispatch_to_evm::<T>)770 }771772 773 774 775 776 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {777 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))778 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))779 .collect();780 Ok(result)781 }782783 784 785 786 787 fn change_collection_owner_cross(788 &mut self,789 caller: caller,790 new_owner: EthCrossAccount,791 ) -> Result<void> {792 self.consume_store_writes(1)?;793794 let caller = T::CrossAccountId::from_eth(caller);795 let new_owner = new_owner.into_sub_cross_account::<T>()?;796 self.change_owner(caller, new_owner)797 .map_err(dispatch_to_evm::<T>)798 }799}800801802803fn check_is_owner_or_admin<T: Config>(804 caller: caller,805 collection: &CollectionHandle<T>,806) -> Result<T::CrossAccountId> {807 let caller = T::CrossAccountId::from_eth(caller);808 collection809 .check_is_owner_or_admin(&caller)810 .map_err(dispatch_to_evm::<T>)?;811 Ok(caller)812}813814815816fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {817 collection818 .check_is_internal()819 .map_err(dispatch_to_evm::<T>)?;820 collection.save().map_err(dispatch_to_evm::<T>)?;821 Ok(())822}823824825pub mod static_property {826 use evm_coder::{827 execution::{Result, Error},828 };829 use alloc::format;830831 const EXPECT_CONVERT_ERROR: &str = "length < limit";832833 834 pub mod key {835 use super::*;836837 838 pub fn base_uri() -> up_data_structs::PropertyKey {839 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)840 }841842 843 pub fn url() -> up_data_structs::PropertyKey {844 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)845 }846847 848 pub fn suffix() -> up_data_structs::PropertyKey {849 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)850 }851852 853 pub fn parent_nft() -> up_data_structs::PropertyKey {854 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)855 }856 }857858 859 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {860 bytes.to_vec().try_into().map_err(|_| {861 Error::Revert(format!(862 "Property key is too long. Max length is {}.",863 up_data_structs::PropertyKey::bound()864 ))865 })866 }867868 869 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {870 bytes.to_vec().try_into().map_err(|_| {871 Error::Revert(format!(872 "Property key is too long. Max length is {}.",873 up_data_structs::PropertyKey::bound()874 ))875 })876 }877}