12345678910111213141516171819pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId};20use evm_coder::{21 abi::AbiType,22 solidity_interface, solidity, ToLog,23 types::*,24 types::Property as PropertyStruct,25 execution::{Result, Error},26 weight,27};28use pallet_evm_coder_substrate::dispatch_to_evm;29use sp_std::{vec, vec::Vec};30use up_data_structs::{31 AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,32 SponsoringRateLimit, SponsorshipState,33};34use alloc::format;3536use crate::{37 Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,38 eth::{39 EthCrossAccount, convert_cross_account_to_uint256, CollectionPermissions as EvmPermissions,40 CollectionLimits as EvmCollectionLimits,41 },42 weights::WeightInfo,43};444546#[derive(ToLog)]47pub enum CollectionHelpersEvents {48 49 CollectionCreated {50 51 #[indexed]52 owner: address,5354 55 #[indexed]56 collection_id: address,57 },58 59 CollectionDestroyed {60 61 #[indexed]62 collection_id: address,63 },64 65 CollectionChanged {66 67 #[indexed]68 collection_id: address,69 },7071 72 TokenChanged {73 74 #[indexed]75 collection_id: address,76 77 token_id: uint256,78 },79}80818283pub trait CommonEvmHandler {84 85 const CODE: &'static [u8];8687 88 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult>;89}909192#[solidity_interface(name = Collection)]93impl<T: Config> CollectionHandle<T>94where95 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,96{97 98 99 100 101 #[solidity(hide)]102 #[weight(<SelfWeightOf<T>>::set_collection_properties(1))]103 fn set_collection_property(104 &mut self,105 caller: caller,106 key: string,107 value: bytes,108 ) -> Result<void> {109 let caller = T::CrossAccountId::from_eth(caller);110 let key = <Vec<u8>>::from(key)111 .try_into()112 .map_err(|_| "key too large")?;113 let value = value.0.try_into().map_err(|_| "value too large")?;114115 <Pallet<T>>::set_collection_property(self, &caller, Property { key, value })116 .map_err(dispatch_to_evm::<T>)117 }118119 120 121 122 #[weight(<SelfWeightOf<T>>::set_collection_properties(properties.len() as u32))]123 fn set_collection_properties(124 &mut self,125 caller: caller,126 properties: Vec<PropertyStruct>,127 ) -> Result<void> {128 let caller = T::CrossAccountId::from_eth(caller);129130 let properties = properties131 .into_iter()132 .map(|PropertyStruct { key, value }| {133 let key = <Vec<u8>>::from(key)134 .try_into()135 .map_err(|_| "key too large")?;136137 let value = value.0.try_into().map_err(|_| "value too large")?;138139 Ok(Property { key, value })140 })141 .collect::<Result<Vec<_>>>()?;142143 <Pallet<T>>::set_collection_properties(self, &caller, properties)144 .map_err(dispatch_to_evm::<T>)145 }146147 148 149 150 #[solidity(hide)]151 #[weight(<SelfWeightOf<T>>::delete_collection_properties(1))]152 fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> {153 let caller = T::CrossAccountId::from_eth(caller);154 let key = <Vec<u8>>::from(key)155 .try_into()156 .map_err(|_| "key too large")?;157158 <Pallet<T>>::delete_collection_property(self, &caller, key).map_err(dispatch_to_evm::<T>)159 }160161 162 163 164 #[weight(<SelfWeightOf<T>>::delete_collection_properties(keys.len() as u32))]165 fn delete_collection_properties(&mut self, caller: caller, keys: Vec<string>) -> Result<()> {166 let caller = T::CrossAccountId::from_eth(caller);167 let keys = keys168 .into_iter()169 .map(|key| {170 <Vec<u8>>::from(key)171 .try_into()172 .map_err(|_| Error::Revert("key too large".into()))173 })174 .collect::<Result<Vec<_>>>()?;175176 <Pallet<T>>::delete_collection_properties(self, &caller, keys).map_err(dispatch_to_evm::<T>)177 }178179 180 181 182 183 184 185 fn collection_property(&self, key: string) -> Result<bytes> {186 let key = <Vec<u8>>::from(key)187 .try_into()188 .map_err(|_| "key too large")?;189190 let props = CollectionProperties::<T>::get(self.id);191 let prop = props.get(&key).ok_or("key not found")?;192193 Ok(bytes(prop.to_vec()))194 }195196 197 198 199 200 fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {201 let keys = keys202 .into_iter()203 .map(|key| {204 <Vec<u8>>::from(key)205 .try_into()206 .map_err(|_| Error::Revert("key too large".into()))207 })208 .collect::<Result<Vec<_>>>()?;209210 let properties = Pallet::<T>::filter_collection_properties(211 self.id,212 if keys.is_empty() { None } else { Some(keys) },213 )214 .map_err(dispatch_to_evm::<T>)?;215216 let properties = properties217 .into_iter()218 .map(|p| {219 let key =220 string::from_utf8(p.key.into()).map_err(|e| Error::Revert(format!("{}", e)))?;221 let value = bytes(p.value.to_vec());222 Ok(PropertyStruct { key, value })223 })224 .collect::<Result<Vec<_>>>()?;225 Ok(properties)226 }227228 229 230 231 232 233 #[solidity(hide)]234 fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result<void> {235 self.consume_store_reads_and_writes(1, 1)?;236237 let caller = T::CrossAccountId::from_eth(caller);238239 let sponsor = T::CrossAccountId::from_eth(sponsor);240 self.set_sponsor(&caller, sponsor.as_sub().clone())241 .map_err(dispatch_to_evm::<T>)242 }243244 245 246 247 248 249 fn set_collection_sponsor_cross(250 &mut self,251 caller: caller,252 sponsor: EthCrossAccount,253 ) -> Result<void> {254 self.consume_store_reads_and_writes(1, 1)?;255256 let caller = T::CrossAccountId::from_eth(caller);257258 let sponsor = sponsor.into_sub_cross_account::<T>()?;259 self.set_sponsor(&caller, sponsor.as_sub().clone())260 .map_err(dispatch_to_evm::<T>)261 }262263 264 fn has_collection_pending_sponsor(&self) -> Result<bool> {265 Ok(matches!(266 self.collection.sponsorship,267 SponsorshipState::Unconfirmed(_)268 ))269 }270271 272 273 274 fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result<void> {275 self.consume_store_writes(1)?;276277 let caller = T::CrossAccountId::from_eth(caller);278 self.confirm_sponsorship(caller.as_sub())279 .map_err(dispatch_to_evm::<T>)280 }281282 283 fn remove_collection_sponsor(&mut self, caller: caller) -> Result<void> {284 self.consume_store_reads_and_writes(1, 1)?;285 let caller = T::CrossAccountId::from_eth(caller);286 self.remove_sponsor(&caller).map_err(dispatch_to_evm::<T>)287 }288289 290 291 292 fn collection_sponsor(&self) -> Result<(address, uint256)> {293 let sponsor = match self.collection.sponsorship.sponsor() {294 Some(sponsor) => sponsor,295 None => return Ok(Default::default()),296 };297 let sponsor = T::CrossAccountId::from_sub(sponsor.clone());298 let result: (address, uint256) = if sponsor.is_canonical_substrate() {299 let sponsor = convert_cross_account_to_uint256::<T>(&sponsor);300 (Default::default(), sponsor)301 } else {302 let sponsor = *sponsor.as_eth();303 (sponsor, Default::default())304 };305 Ok(result)306 }307308 309 310 311 312 313 314 315 316 317 318 319 320 321 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {322 let convert_value_limit = |limit: EvmCollectionLimits,323 value: Option<u32>|324 -> (EvmCollectionLimits, bool, uint256) {325 value326 .map(|v| (limit, true, v.into()))327 .unwrap_or((limit, false, Default::default()))328 };329330 let convert_bool_limit = |limit: EvmCollectionLimits,331 value: Option<bool>|332 -> (EvmCollectionLimits, bool, uint256) {333 value334 .map(|v| {335 (336 limit,337 true,338 if v {339 uint256::from(1)340 } else {341 Default::default()342 },343 )344 })345 .unwrap_or((limit, false, Default::default()))346 };347348 let limits = &self.collection.limits;349350 Ok(vec![351 convert_value_limit(352 EvmCollectionLimits::AccountTokenOwnership,353 limits.account_token_ownership_limit,354 ),355 convert_value_limit(356 EvmCollectionLimits::SponsoredDataSize,357 limits.sponsored_data_size,358 ),359 limits360 .sponsored_data_rate_limit361 .and_then(|limit| {362 if let SponsoringRateLimit::Blocks(blocks) = limit {363 Some((364 EvmCollectionLimits::SponsoredDataRateLimit,365 true,366 blocks.into(),367 ))368 } else {369 None370 }371 })372 .unwrap_or((373 EvmCollectionLimits::SponsoredDataRateLimit,374 false,375 Default::default(),376 )),377 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),378 convert_value_limit(379 EvmCollectionLimits::SponsorTransferTimeout,380 limits.sponsor_transfer_timeout,381 ),382 convert_value_limit(383 EvmCollectionLimits::SponsorApproveTimeout,384 limits.sponsor_approve_timeout,385 ),386 convert_bool_limit(387 EvmCollectionLimits::OwnerCanTransfer,388 limits.owner_can_transfer,389 ),390 convert_bool_limit(391 EvmCollectionLimits::OwnerCanDestroy,392 limits.owner_can_destroy,393 ),394 convert_bool_limit(395 EvmCollectionLimits::TransferEnabled,396 limits.transfers_enabled,397 ),398 ])399 }400401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 #[solidity(rename_selector = "setCollectionLimit")]416 fn set_collection_limit(417 &mut self,418 caller: caller,419 limit: EvmCollectionLimits,420 status: bool,421 value: uint256,422 ) -> Result<void> {423 self.consume_store_reads_and_writes(1, 1)?;424425 if !status {426 return Err(Error::Revert("user can't disable limits".into()));427 }428429 let value = value430 .try_into()431 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;432433 let convert_value_to_bool = || match value {434 0 => Ok(false),435 1 => Ok(true),436 _ => {437 return Err(Error::Revert(format!(438 "can't convert value to boolean \"{}\"",439 value440 )))441 }442 };443444 let mut limits = self.limits.clone();445446 match limit {447 EvmCollectionLimits::AccountTokenOwnership => {448 limits.account_token_ownership_limit = Some(value);449 }450 EvmCollectionLimits::SponsoredDataSize => {451 limits.sponsored_data_size = Some(value);452 }453 EvmCollectionLimits::SponsoredDataRateLimit => {454 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));455 }456 EvmCollectionLimits::TokenLimit => {457 limits.token_limit = Some(value);458 }459 EvmCollectionLimits::SponsorTransferTimeout => {460 limits.sponsor_transfer_timeout = Some(value);461 }462 EvmCollectionLimits::SponsorApproveTimeout => {463 limits.sponsor_approve_timeout = Some(value);464 }465 EvmCollectionLimits::OwnerCanTransfer => {466 limits.owner_can_transfer = Some(convert_value_to_bool()?);467 }468 EvmCollectionLimits::OwnerCanDestroy => {469 limits.owner_can_destroy = Some(convert_value_to_bool()?);470 }471 EvmCollectionLimits::TransferEnabled => {472 limits.transfers_enabled = Some(convert_value_to_bool()?);473 }474 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),475 }476477 let caller = T::CrossAccountId::from_eth(caller);478 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)479 }480481 482 fn contract_address(&self) -> Result<address> {483 Ok(crate::eth::collection_id_to_address(self.id))484 }485486 487 488 fn add_collection_admin_cross(489 &mut self,490 caller: caller,491 new_admin: EthCrossAccount,492 ) -> Result<void> {493 self.consume_store_reads_and_writes(2, 2)?;494495 let caller = T::CrossAccountId::from_eth(caller);496 let new_admin = new_admin.into_sub_cross_account::<T>()?;497 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;498 Ok(())499 }500501 502 503 fn remove_collection_admin_cross(504 &mut self,505 caller: caller,506 admin: EthCrossAccount,507 ) -> Result<void> {508 self.consume_store_reads_and_writes(2, 2)?;509510 let caller = T::CrossAccountId::from_eth(caller);511 let admin = admin.into_sub_cross_account::<T>()?;512 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;513 Ok(())514 }515516 517 518 #[solidity(hide)]519 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {520 self.consume_store_reads_and_writes(2, 2)?;521522 let caller = T::CrossAccountId::from_eth(caller);523 let new_admin = T::CrossAccountId::from_eth(new_admin);524 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;525 Ok(())526 }527528 529 530 531 #[solidity(hide)]532 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {533 self.consume_store_reads_and_writes(2, 2)?;534535 let caller = T::CrossAccountId::from_eth(caller);536 let admin = T::CrossAccountId::from_eth(admin);537 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;538 Ok(())539 }540541 542 543 544 #[solidity(rename_selector = "setCollectionNesting")]545 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {546 self.consume_store_reads_and_writes(1, 1)?;547548 let caller = T::CrossAccountId::from_eth(caller);549550 let mut permissions = self.collection.permissions.clone();551 let mut nesting = permissions.nesting().clone();552 nesting.token_owner = enable;553 nesting.restricted = None;554 permissions.nesting = Some(nesting);555556 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)557 }558559 560 561 562 563 #[solidity(rename_selector = "setCollectionNesting")]564 fn set_nesting(565 &mut self,566 caller: caller,567 enable: bool,568 collections: Vec<address>,569 ) -> Result<void> {570 self.consume_store_reads_and_writes(1, 1)?;571572 if collections.is_empty() {573 return Err("no addresses provided".into());574 }575 let caller = T::CrossAccountId::from_eth(caller);576577 let mut permissions = self.collection.permissions.clone();578 match enable {579 false => {580 let mut nesting = permissions.nesting().clone();581 nesting.token_owner = false;582 nesting.restricted = None;583 permissions.nesting = Some(nesting);584 }585 true => {586 let mut bv = OwnerRestrictedSet::new();587 for i in collections {588 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {589 Error::Revert("Can't convert address into collection id".into())590 })?)591 .map_err(|_| "too many collections")?;592 }593 let mut nesting = permissions.nesting().clone();594 nesting.token_owner = true;595 nesting.restricted = Some(bv);596 permissions.nesting = Some(nesting);597 }598 };599600 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)601 }602603 604 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]605 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {606 let nesting = self.collection.permissions.nesting();607608 Ok((609 nesting.token_owner,610 nesting611 .restricted612 .clone()613 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())614 .unwrap_or_default(),615 ))616 }617618 619 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {620 let nesting = self.collection.permissions.nesting();621 Ok(vec![622 (EvmPermissions::CollectionAdmin, nesting.collection_admin),623 (EvmPermissions::TokenOwner, nesting.token_owner),624 ])625 }626 627 628 629 630 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {631 self.consume_store_reads_and_writes(1, 1)?;632633 let caller = T::CrossAccountId::from_eth(caller);634 let permissions = CollectionPermissions {635 access: Some(match mode {636 0 => AccessMode::Normal,637 1 => AccessMode::AllowList,638 _ => return Err("not supported access mode".into()),639 }),640 ..Default::default()641 };642 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)643 }644645 646 647 648 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {649 let user = user.into_sub_cross_account::<T>()?;650 Ok(Pallet::<T>::allowed(self.id, user))651 }652653 654 655 656 #[solidity(hide)]657 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {658 self.consume_store_writes(1)?;659660 let caller = T::CrossAccountId::from_eth(caller);661 let user = T::CrossAccountId::from_eth(user);662 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;663 Ok(())664 }665666 667 668 669 fn add_to_collection_allow_list_cross(670 &mut self,671 caller: caller,672 user: EthCrossAccount,673 ) -> Result<void> {674 self.consume_store_writes(1)?;675676 let caller = T::CrossAccountId::from_eth(caller);677 let user = user.into_sub_cross_account::<T>()?;678 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;679 Ok(())680 }681682 683 684 685 #[solidity(hide)]686 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {687 self.consume_store_writes(1)?;688689 let caller = T::CrossAccountId::from_eth(caller);690 let user = T::CrossAccountId::from_eth(user);691 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;692 Ok(())693 }694695 696 697 698 fn remove_from_collection_allow_list_cross(699 &mut self,700 caller: caller,701 user: EthCrossAccount,702 ) -> Result<void> {703 self.consume_store_writes(1)?;704705 let caller = T::CrossAccountId::from_eth(caller);706 let user = user.into_sub_cross_account::<T>()?;707 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;708 Ok(())709 }710711 712 713 714 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {715 self.consume_store_reads_and_writes(1, 1)?;716717 let caller = T::CrossAccountId::from_eth(caller);718 let permissions = CollectionPermissions {719 mint_mode: Some(mode),720 ..Default::default()721 };722 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)723 }724725 726 727 728 729 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]730 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {731 let user = T::CrossAccountId::from_eth(user);732 Ok(self.is_owner_or_admin(&user))733 }734735 736 737 738 739 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {740 let user = user.into_sub_cross_account::<T>()?;741 Ok(self.is_owner_or_admin(&user))742 }743744 745 746 747 fn unique_collection_type(&self) -> Result<string> {748 let mode = match self.collection.mode {749 CollectionMode::Fungible(_) => "Fungible",750 CollectionMode::NFT => "NFT",751 CollectionMode::ReFungible => "ReFungible",752 };753 Ok(mode.into())754 }755756 757 758 759 760 fn collection_owner(&self) -> Result<EthCrossAccount> {761 Ok(EthCrossAccount::from_sub_cross_account::<T>(762 &T::CrossAccountId::from_sub(self.owner.clone()),763 ))764 }765766 767 768 769 770 #[solidity(hide, rename_selector = "changeCollectionOwner")]771 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {772 self.consume_store_writes(1)?;773774 let caller = T::CrossAccountId::from_eth(caller);775 let new_owner = T::CrossAccountId::from_eth(new_owner);776 self.change_owner(caller, new_owner)777 .map_err(dispatch_to_evm::<T>)778 }779780 781 782 783 784 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {785 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))786 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))787 .collect();788 Ok(result)789 }790791 792 793 794 795 fn change_collection_owner_cross(796 &mut self,797 caller: caller,798 new_owner: EthCrossAccount,799 ) -> Result<void> {800 self.consume_store_writes(1)?;801802 let caller = T::CrossAccountId::from_eth(caller);803 let new_owner = new_owner.into_sub_cross_account::<T>()?;804 self.change_owner(caller, new_owner)805 .map_err(dispatch_to_evm::<T>)806 }807}808809810811fn check_is_owner_or_admin<T: Config>(812 caller: caller,813 collection: &CollectionHandle<T>,814) -> Result<T::CrossAccountId> {815 let caller = T::CrossAccountId::from_eth(caller);816 collection817 .check_is_owner_or_admin(&caller)818 .map_err(dispatch_to_evm::<T>)?;819 Ok(caller)820}821822823824fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {825 collection826 .check_is_internal()827 .map_err(dispatch_to_evm::<T>)?;828 collection.save().map_err(dispatch_to_evm::<T>)?;829 Ok(())830}831832833pub mod static_property {834 use evm_coder::{835 execution::{Result, Error},836 };837 use alloc::format;838839 const EXPECT_CONVERT_ERROR: &str = "length < limit";840841 842 pub mod key {843 use super::*;844845 846 pub fn base_uri() -> up_data_structs::PropertyKey {847 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)848 }849850 851 pub fn url() -> up_data_structs::PropertyKey {852 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)853 }854855 856 pub fn suffix() -> up_data_structs::PropertyKey {857 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)858 }859860 861 pub fn parent_nft() -> up_data_structs::PropertyKey {862 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)863 }864 }865866 867 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {868 bytes.to_vec().try_into().map_err(|_| {869 Error::Revert(format!(870 "Property key is too long. Max length is {}.",871 up_data_structs::PropertyKey::bound()872 ))873 })874 }875876 877 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {878 bytes.to_vec().try_into().map_err(|_| {879 Error::Revert(format!(880 "Property key is too long. Max length is {}.",881 up_data_structs::PropertyKey::bound()882 ))883 })884 }885}