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(&mut self, caller: caller, key: string, value: bytes) -> Result<()> {97 let caller = T::CrossAccountId::from_eth(caller);98 let key = <Vec<u8>>::from(key)99 .try_into()100 .map_err(|_| "key too large")?;101 let value = value.0.try_into().map_err(|_| "value too large")?;102103 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })104 .map_err(dispatch_to_evm::<T>)105 }106107 108 109 110 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]111 fn set_collection_properties(112 &mut self,113 caller: caller,114 properties: Vec<eth::Property>,115 ) -> Result<()> {116 let caller = T::CrossAccountId::from_eth(caller);117118 let properties = properties119 .into_iter()120 .map(eth::Property::try_into)121 .collect::<Result<Vec<_>>>()?;122123 <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())124 .map_err(dispatch_to_evm::<T>)125 }126127 128 129 130 #[solidity(hide)]131 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]132 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {133 let caller = T::CrossAccountId::from_eth(caller);134 let key = <Vec<u8>>::from(key)135 .try_into()136 .map_err(|_| "key too large")?;137138 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)139 }140141 142 143 144 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]145 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {146 let caller = T::CrossAccountId::from_eth(caller);147 let keys = keys148 .into_iter()149 .map(|key| {150 <Vec<u8>>::from(key)151 .try_into()152 .map_err(|_| Error::Revert("key too large".into()))153 })154 .collect::<Result<Vec<_>>>()?;155156 <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())157 .map_err(dispatch_to_evm::<T>)158 }159160 161 162 163 164 165 166 fn collection_property(&self, key: string) -> Result<bytes> {167 let key = <Vec<u8>>::from(key)168 .try_into()169 .map_err(|_| "key too large")?;170171 let props = CollectionProperties::<T>::get(self.id);172 let prop = props.get(&key).ok_or("key not found")?;173174 Ok(bytes(prop.to_vec()))175 }176177 178 179 180 181 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {182 let keys = keys183 .into_iter()184 .map(|key| {185 <Vec<u8>>::from(key)186 .try_into()187 .map_err(|_| Error::Revert("key too large".into()))188 })189 .collect::<Result<Vec<_>>>()?;190191 let properties = Pallet::<T>::filter_collection_properties(192 self.id,193 if keys.is_empty() { None } else { Some(keys) },194 )195 .map_err(dispatch_to_evm::<T>)?;196197 let properties = properties198 .into_iter()199 .map(Property::try_into)200 .collect::<Result<Vec<_>>>()?;201 Ok(properties)202 }203204 205 206 207 208 209 #[solidity(hide)]210 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<()> {211 self.consume_store_reads_and_writes(1, 1)?;212213 let caller = T::CrossAccountId::from_eth(caller);214215 let sponsor = T::CrossAccountId::from_eth(sponsor);216 self.set_sponsor(&caller, sponsor.as_sub().clone())217 .map_err(dispatch_to_evm::<T>)218 }219220 221 222 223 224 225 fn set_collection_sponsor_cross(226 &mut self,227 caller: caller,228 sponsor: eth::CrossAddress,229 ) -> Result<()> {230 self.consume_store_reads_and_writes(1, 1)?;231232 let caller = T::CrossAccountId::from_eth(caller);233234 let sponsor = sponsor.into_sub_cross_account::<T>()?;235 self.set_sponsor(&caller, sponsor.as_sub().clone())236 .map_err(dispatch_to_evm::<T>)237 }238239 240 fn has_collection_pending_sponsor(&self) -> Result<bool> {241 Ok(matches!(242 self.collection.sponsorship,243 SponsorshipState::Unconfirmed(_)244 ))245 }246247 248 249 250 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<()> {251 self.consume_store_writes(1)?;252253 let caller = T::CrossAccountId::from_eth(caller);254 self.confirm_sponsorship(caller.as_sub())255 .map_err(dispatch_to_evm::<T>)256 }257258 259 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<()> {260 self.consume_store_reads_and_writes(1, 1)?;261 let caller = T::CrossAccountId::from_eth(caller);262 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)263 }264265 266 267 268 fn collection_sponsor(&self) -> Result<eth::CrossAddress> {269 let sponsor = match self.collection.sponsorship.sponsor() {270 Some(sponsor) => sponsor,271 None => return Ok(Default::default()),272 };273274 Ok(eth::CrossAddress::from_sub::<T>(&sponsor))275 }276277 278 279 280 fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {281 let limits = &self.collection.limits;282283 let convert_value_from_bool = |ob: Option<bool>| match ob {284 Some(b) => Some(b as u32),285 None => None,286 };287288 Ok(vec![289 eth::CollectionLimit::new(290 eth::CollectionLimitField::AccountTokenOwnership,291 limits.account_token_ownership_limit,292 ),293 eth::CollectionLimit::new(294 eth::CollectionLimitField::SponsoredDataSize,295 limits.sponsored_data_size,296 ),297 limits298 .sponsored_data_rate_limit299 .and_then(|limit| {300 if let SponsoringRateLimit::Blocks(blocks) = limit {301 Some(eth::CollectionLimit::new(302 eth::CollectionLimitField::SponsoredDataRateLimit,303 Some(blocks),304 ))305 } else {306 None307 }308 })309 .unwrap_or(eth::CollectionLimit::new(310 eth::CollectionLimitField::SponsoredDataRateLimit,311 Default::default(),312 )),313 eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),314 eth::CollectionLimit::new(315 eth::CollectionLimitField::SponsorTransferTimeout,316 limits.sponsor_transfer_timeout,317 ),318 eth::CollectionLimit::new(319 eth::CollectionLimitField::SponsorApproveTimeout,320 limits.sponsor_approve_timeout,321 ),322 eth::CollectionLimit::new(323 eth::CollectionLimitField::OwnerCanTransfer,324 convert_value_from_bool(limits.owner_can_transfer),325 ),326 eth::CollectionLimit::new(327 eth::CollectionLimitField::OwnerCanDestroy,328 convert_value_from_bool(limits.owner_can_destroy),329 ),330 eth::CollectionLimit::new(331 eth::CollectionLimitField::TransferEnabled,332 convert_value_from_bool(limits.transfers_enabled),333 ),334 ])335 }336337 338 339 340 #[solidity(rename_selector = "setCollectionLimit")]341 fn set_collection_limit(&mut self, caller: caller, limit: eth::CollectionLimit) -> Result<()> {342 self.consume_store_reads_and_writes(1, 1)?;343344 if !limit.has_value() {345 return Err(Error::Revert("user can't disable limits".into()));346 }347348 let caller = T::CrossAccountId::from_eth(caller);349 <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)350 }351352 353 fn contract_address(&self) -> Result<address> {354 Ok(crate::eth::collection_id_to_address(self.id))355 }356357 358 359 fn add_collection_admin_cross(360 &mut self,361 caller: caller,362 new_admin: eth::CrossAddress,363 ) -> Result<()> {364 self.consume_store_reads_and_writes(2, 2)?;365366 let caller = T::CrossAccountId::from_eth(caller);367 let new_admin = new_admin.into_sub_cross_account::<T>()?;368 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;369 Ok(())370 }371372 373 374 fn remove_collection_admin_cross(375 &mut self,376 caller: caller,377 admin: eth::CrossAddress,378 ) -> Result<()> {379 self.consume_store_reads_and_writes(2, 2)?;380381 let caller = T::CrossAccountId::from_eth(caller);382 let admin = admin.into_sub_cross_account::<T>()?;383 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;384 Ok(())385 }386387 388 389 #[solidity(hide)]390 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<()> {391 self.consume_store_reads_and_writes(2, 2)?;392393 let caller = T::CrossAccountId::from_eth(caller);394 let new_admin = T::CrossAccountId::from_eth(new_admin);395 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;396 Ok(())397 }398399 400 401 402 #[solidity(hide)]403 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<()> {404 self.consume_store_reads_and_writes(2, 2)?;405406 let caller = T::CrossAccountId::from_eth(caller);407 let admin = T::CrossAccountId::from_eth(admin);408 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;409 Ok(())410 }411412 413 414 415 #[solidity(rename_selector = "setCollectionNesting")]416 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<()> {417 self.consume_store_reads_and_writes(1, 1)?;418419 let caller = T::CrossAccountId::from_eth(caller);420421 let mut permissions = self.collection.permissions.clone();422 let mut nesting = permissions.nesting().clone();423 nesting.token_owner = enable;424 nesting.restricted = None;425 permissions.nesting = Some(nesting);426427 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)428 }429430 431 432 433 434 #[solidity(rename_selector = "setCollectionNesting")]435 fn set_nesting(436 &mut self,437 caller: caller,438 enable: bool,439 collections: Vec<address>,440 ) -> Result<()> {441 self.consume_store_reads_and_writes(1, 1)?;442443 if collections.is_empty() {444 return Err("no addresses provided".into());445 }446 let caller = T::CrossAccountId::from_eth(caller);447448 let mut permissions = self.collection.permissions.clone();449 match enable {450 false => {451 let mut nesting = permissions.nesting().clone();452 nesting.token_owner = false;453 nesting.restricted = None;454 permissions.nesting = Some(nesting);455 }456 true => {457 let mut bv = OwnerRestrictedSet::new();458 for i in collections {459 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {460 Error::Revert("Can't convert address into collection id".into())461 })?)462 .map_err(|_| "too many collections")?;463 }464 let mut nesting = permissions.nesting().clone();465 nesting.token_owner = true;466 nesting.restricted = Some(bv);467 permissions.nesting = Some(nesting);468 }469 };470471 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)472 }473474 475 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]476 fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {477 let nesting = self.collection.permissions.nesting();478479 Ok(eth::CollectionNesting::new(480 nesting.token_owner,481 nesting482 .restricted483 .clone()484 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())485 .unwrap_or_default(),486 ))487 }488489 490 fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {491 let nesting = self.collection.permissions.nesting();492 Ok(vec![493 eth::CollectionNestingPermission::new(494 eth::CollectionPermissionField::CollectionAdmin,495 nesting.collection_admin,496 ),497 eth::CollectionNestingPermission::new(498 eth::CollectionPermissionField::TokenOwner,499 nesting.token_owner,500 ),501 ])502 }503 504 505 506 507 fn set_collection_access(&mut self, caller: caller, mode: u8) -> Result<()> {508 self.consume_store_reads_and_writes(1, 1)?;509510 let caller = T::CrossAccountId::from_eth(caller);511 let permissions = CollectionPermissions {512 access: Some(match mode {513 0 => AccessMode::Normal,514 1 => AccessMode::AllowList,515 _ => return Err("not supported access mode".into()),516 }),517 ..Default::default()518 };519 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)520 }521522 523 524 525 fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {526 let user = user.into_sub_cross_account::<T>()?;527 Ok(Pallet::<T>::allowed(self.id, user))528 }529530 531 532 533 #[solidity(hide)]534 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {535 self.consume_store_writes(1)?;536537 let caller = T::CrossAccountId::from_eth(caller);538 let user = T::CrossAccountId::from_eth(user);539 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;540 Ok(())541 }542543 544 545 546 fn add_to_collection_allow_list_cross(547 &mut self,548 caller: caller,549 user: eth::CrossAddress,550 ) -> Result<()> {551 self.consume_store_writes(1)?;552553 let caller = T::CrossAccountId::from_eth(caller);554 let user = user.into_sub_cross_account::<T>()?;555 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;556 Ok(())557 }558559 560 561 562 #[solidity(hide)]563 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<()> {564 self.consume_store_writes(1)?;565566 let caller = T::CrossAccountId::from_eth(caller);567 let user = T::CrossAccountId::from_eth(user);568 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;569 Ok(())570 }571572 573 574 575 fn remove_from_collection_allow_list_cross(576 &mut self,577 caller: caller,578 user: eth::CrossAddress,579 ) -> Result<()> {580 self.consume_store_writes(1)?;581582 let caller = T::CrossAccountId::from_eth(caller);583 let user = user.into_sub_cross_account::<T>()?;584 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;585 Ok(())586 }587588 589 590 591 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<()> {592 self.consume_store_reads_and_writes(1, 1)?;593594 let caller = T::CrossAccountId::from_eth(caller);595 let permissions = CollectionPermissions {596 mint_mode: Some(mode),597 ..Default::default()598 };599 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)600 }601602 603 604 605 606 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]607 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {608 let user = T::CrossAccountId::from_eth(user);609 Ok(self.is_owner_or_admin(&user))610 }611612 613 614 615 616 fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {617 let user = user.into_sub_cross_account::<T>()?;618 Ok(self.is_owner_or_admin(&user))619 }620621 622 623 624 fn unique_collection_type(&self) -> Result<string> {625 let mode = match self.collection.mode {626 CollectionMode::Fungible(_) => "Fungible",627 CollectionMode::NFT => "NFT",628 CollectionMode::ReFungible => "ReFungible",629 };630 Ok(mode.into())631 }632633 634 635 636 637 fn collection_owner(&self) -> Result<eth::CrossAddress> {638 Ok(eth::CrossAddress::from_sub_cross_account::<T>(639 &T::CrossAccountId::from_sub(self.owner.clone()),640 ))641 }642643 644 645 646 647 #[solidity(hide, rename_selector = "changeCollectionOwner")]648 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<()> {649 self.consume_store_writes(1)?;650651 let caller = T::CrossAccountId::from_eth(caller);652 let new_owner = T::CrossAccountId::from_eth(new_owner);653 self.change_owner(caller, new_owner)654 .map_err(dispatch_to_evm::<T>)655 }656657 658 659 660 661 fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {662 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))663 .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))664 .collect();665 Ok(result)666 }667668 669 670 671 672 fn change_collection_owner_cross(673 &mut self,674 caller: caller,675 new_owner: eth::CrossAddress,676 ) -> Result<()> {677 self.consume_store_writes(1)?;678679 let caller = T::CrossAccountId::from_eth(caller);680 let new_owner = new_owner.into_sub_cross_account::<T>()?;681 self.change_owner(caller, new_owner)682 .map_err(dispatch_to_evm::<T>)683 }684}685686687pub mod static_property {688 use evm_coder::{689 execution::{Result, Error},690 };691 use alloc::format;692693 const EXPECT_CONVERT_ERROR: &str = "length < limit";694695 696 pub mod key {697 use super::*;698699 700 pub fn base_uri() -> up_data_structs::PropertyKey {701 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)702 }703704 705 pub fn url() -> up_data_structs::PropertyKey {706 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)707 }708709 710 pub fn suffix() -> up_data_structs::PropertyKey {711 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)712 }713714 715 pub fn parent_nft() -> up_data_structs::PropertyKey {716 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)717 }718 }719720 721 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {722 bytes.to_vec().try_into().map_err(|_| {723 Error::Revert(format!(724 "Property key is too long. Max length is {}.",725 up_data_structs::PropertyKey::bound()726 ))727 })728 }729730 731 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {732 bytes.to_vec().try_into().map_err(|_| {733 Error::Revert(format!(734 "Property key is too long. Max length is {}.",735 up_data_structs::PropertyKey::bound()736 ))737 })738 }739}