12345678910111213141516171819pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};20use pallet_evm_coder_substrate::{21 abi::AbiType,22 solidity_interface, ToLog,23 types::*,24 execution::{Result, Error, PreDispatch},25 frontier_contract,26};27use pallet_evm_coder_substrate::dispatch_to_evm;28use sp_std::{vec, vec::Vec};29use up_data_structs::{30 CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property, SponsoringRateLimit,31 SponsorshipState,32};3334use crate::{35 Pallet, CollectionHandle, Config, CollectionProperties, eth, SelfWeightOf, weights::WeightInfo,36};3738frontier_contract! {39 macro_rules! CollectionHandle_result {...}40 impl<T: Config> Contract for CollectionHandle<T> {...}41}424344#[derive(ToLog)]45pub enum CollectionHelpersEvents {46 47 CollectionCreated {48 49 #[indexed]50 owner: Address,5152 53 #[indexed]54 collection_id: Address,55 },56 57 CollectionDestroyed {58 59 #[indexed]60 collection_id: Address,61 },62 63 CollectionChanged {64 65 #[indexed]66 collection_id: Address,67 },68}69707172pub trait CommonEvmHandler {73 74 const CODE: &'static [u8];7576 77 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;78}7980impl CommonEvmHandler for () {81 const CODE: &'static [u8] = &[];8283 fn call(self, _handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {84 None85 }86}878889#[solidity_interface(name = Collection, enum(derive(PreDispatch)), enum_attr(weight))]90impl<T: Config> CollectionHandle<T>91where92 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,93{94 95 96 97 98 #[solidity(hide)]99 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]100 fn set_collection_property(&mut self, caller: Caller, key: String, value: Bytes) -> Result<()> {101 let caller = T::CrossAccountId::from_eth(caller);102 let key = <Vec<u8>>::from(key)103 .try_into()104 .map_err(|_| "key too large")?;105 let value = value.0.try_into().map_err(|_| "value too large")?;106107 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })108 .map_err(dispatch_to_evm::<T>)109 }110111 112 113 114 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]115 fn set_collection_properties(116 &mut self,117 caller: Caller,118 properties: Vec<eth::Property>,119 ) -> Result<()> {120 let caller = T::CrossAccountId::from_eth(caller);121122 let properties = properties123 .into_iter()124 .map(eth::Property::try_into)125 .collect::<Result<Vec<_>>>()?;126127 <Pallet<T>>::set_collection_properties(self, &caller, properties.into_iter())128 .map_err(dispatch_to_evm::<T>)129 }130131 132 133 134 #[solidity(hide)]135 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]136 fn delete_collection_property(&mut self, caller: Caller, key: String) -> Result<()> {137 let caller = T::CrossAccountId::from_eth(caller);138 let key = <Vec<u8>>::from(key)139 .try_into()140 .map_err(|_| "key too large")?;141142 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)143 }144145 146 147 148 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]149 fn delete_collection_properties(&mut self, caller: Caller, keys: Vec<String>) -> Result<()> {150 let caller = T::CrossAccountId::from_eth(caller);151 let keys = keys152 .into_iter()153 .map(|key| {154 <Vec<u8>>::from(key)155 .try_into()156 .map_err(|_| Error::Revert("key too large".into()))157 })158 .collect::<Result<Vec<_>>>()?;159160 <Pallet<T>>::delete_collection_properties(self, &caller, keys.into_iter())161 .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<()> {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<()> {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<()> {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<()> {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(301 eth::CollectionLimitField::SponsoredDataRateLimit,302 Some(blocks),303 ))304 } else {305 None306 }307 })308 .unwrap_or_else(|| {309 eth::CollectionLimit::new(310 eth::CollectionLimitField::SponsoredDataRateLimit,311 Default::default(),312 )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 limits.owner_can_transfer.map(u32::from),326 ),327 eth::CollectionLimit::new(328 eth::CollectionLimitField::OwnerCanDestroy,329 limits.owner_can_destroy.map(u32::from),330 ),331 eth::CollectionLimit::new(332 eth::CollectionLimitField::TransferEnabled,333 limits.transfers_enabled.map(u32::from),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 pallet_evm_coder_substrate::{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}