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<EthCrossAccount> {293 let sponsor = match self.collection.sponsorship.sponsor() {294 Some(sponsor) => sponsor,295 None => return Ok(Default::default()),296 };297298 Ok(EthCrossAccount::from_sub::<T>(&sponsor))299 }300301 302 303 304 305 306 307 308 309 310 311 312 313 314 fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {315 let convert_value_limit = |limit: EvmCollectionLimits,316 value: Option<u32>|317 -> (EvmCollectionLimits, bool, uint256) {318 value319 .map(|v| (limit, true, v.into()))320 .unwrap_or((limit, false, Default::default()))321 };322323 let convert_bool_limit = |limit: EvmCollectionLimits,324 value: Option<bool>|325 -> (EvmCollectionLimits, bool, uint256) {326 value327 .map(|v| {328 (329 limit,330 true,331 if v {332 uint256::from(1)333 } else {334 Default::default()335 },336 )337 })338 .unwrap_or((limit, false, Default::default()))339 };340341 let limits = &self.collection.limits;342343 Ok(vec![344 convert_value_limit(345 EvmCollectionLimits::AccountTokenOwnership,346 limits.account_token_ownership_limit,347 ),348 convert_value_limit(349 EvmCollectionLimits::SponsoredDataSize,350 limits.sponsored_data_size,351 ),352 limits353 .sponsored_data_rate_limit354 .and_then(|limit| {355 if let SponsoringRateLimit::Blocks(blocks) = limit {356 Some((357 EvmCollectionLimits::SponsoredDataRateLimit,358 true,359 blocks.into(),360 ))361 } else {362 None363 }364 })365 .unwrap_or((366 EvmCollectionLimits::SponsoredDataRateLimit,367 false,368 Default::default(),369 )),370 convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),371 convert_value_limit(372 EvmCollectionLimits::SponsorTransferTimeout,373 limits.sponsor_transfer_timeout,374 ),375 convert_value_limit(376 EvmCollectionLimits::SponsorApproveTimeout,377 limits.sponsor_approve_timeout,378 ),379 convert_bool_limit(380 EvmCollectionLimits::OwnerCanTransfer,381 limits.owner_can_transfer,382 ),383 convert_bool_limit(384 EvmCollectionLimits::OwnerCanDestroy,385 limits.owner_can_destroy,386 ),387 convert_bool_limit(388 EvmCollectionLimits::TransferEnabled,389 limits.transfers_enabled,390 ),391 ])392 }393394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 #[solidity(rename_selector = "setCollectionLimit")]409 fn set_collection_limit(410 &mut self,411 caller: caller,412 limit: EvmCollectionLimits,413 status: bool,414 value: uint256,415 ) -> Result<void> {416 self.consume_store_reads_and_writes(1, 1)?;417418 if !status {419 return Err(Error::Revert("user can't disable limits".into()));420 }421422 let value = value423 .try_into()424 .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;425426 let convert_value_to_bool = || match value {427 0 => Ok(false),428 1 => Ok(true),429 _ => {430 return Err(Error::Revert(format!(431 "can't convert value to boolean \"{}\"",432 value433 )))434 }435 };436437 let mut limits = self.limits.clone();438439 match limit {440 EvmCollectionLimits::AccountTokenOwnership => {441 limits.account_token_ownership_limit = Some(value);442 }443 EvmCollectionLimits::SponsoredDataSize => {444 limits.sponsored_data_size = Some(value);445 }446 EvmCollectionLimits::SponsoredDataRateLimit => {447 limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));448 }449 EvmCollectionLimits::TokenLimit => {450 limits.token_limit = Some(value);451 }452 EvmCollectionLimits::SponsorTransferTimeout => {453 limits.sponsor_transfer_timeout = Some(value);454 }455 EvmCollectionLimits::SponsorApproveTimeout => {456 limits.sponsor_approve_timeout = Some(value);457 }458 EvmCollectionLimits::OwnerCanTransfer => {459 limits.owner_can_transfer = Some(convert_value_to_bool()?);460 }461 EvmCollectionLimits::OwnerCanDestroy => {462 limits.owner_can_destroy = Some(convert_value_to_bool()?);463 }464 EvmCollectionLimits::TransferEnabled => {465 limits.transfers_enabled = Some(convert_value_to_bool()?);466 }467 _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),468 }469470 let caller = T::CrossAccountId::from_eth(caller);471 <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)472 }473474 475 fn contract_address(&self) -> Result<address> {476 Ok(crate::eth::collection_id_to_address(self.id))477 }478479 480 481 fn add_collection_admin_cross(482 &mut self,483 caller: caller,484 new_admin: EthCrossAccount,485 ) -> Result<void> {486 self.consume_store_reads_and_writes(2, 2)?;487488 let caller = T::CrossAccountId::from_eth(caller);489 let new_admin = new_admin.into_sub_cross_account::<T>()?;490 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;491 Ok(())492 }493494 495 496 fn remove_collection_admin_cross(497 &mut self,498 caller: caller,499 admin: EthCrossAccount,500 ) -> Result<void> {501 self.consume_store_reads_and_writes(2, 2)?;502503 let caller = T::CrossAccountId::from_eth(caller);504 let admin = admin.into_sub_cross_account::<T>()?;505 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;506 Ok(())507 }508509 510 511 #[solidity(hide)]512 fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result<void> {513 self.consume_store_reads_and_writes(2, 2)?;514515 let caller = T::CrossAccountId::from_eth(caller);516 let new_admin = T::CrossAccountId::from_eth(new_admin);517 <Pallet<T>>::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::<T>)?;518 Ok(())519 }520521 522 523 524 #[solidity(hide)]525 fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result<void> {526 self.consume_store_reads_and_writes(2, 2)?;527528 let caller = T::CrossAccountId::from_eth(caller);529 let admin = T::CrossAccountId::from_eth(admin);530 <Pallet<T>>::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::<T>)?;531 Ok(())532 }533534 535 536 537 #[solidity(rename_selector = "setCollectionNesting")]538 fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result<void> {539 self.consume_store_reads_and_writes(1, 1)?;540541 let caller = T::CrossAccountId::from_eth(caller);542543 let mut permissions = self.collection.permissions.clone();544 let mut nesting = permissions.nesting().clone();545 nesting.token_owner = enable;546 nesting.restricted = None;547 permissions.nesting = Some(nesting);548549 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)550 }551552 553 554 555 556 #[solidity(rename_selector = "setCollectionNesting")]557 fn set_nesting(558 &mut self,559 caller: caller,560 enable: bool,561 collections: Vec<address>,562 ) -> Result<void> {563 self.consume_store_reads_and_writes(1, 1)?;564565 if collections.is_empty() {566 return Err("no addresses provided".into());567 }568 let caller = T::CrossAccountId::from_eth(caller);569570 let mut permissions = self.collection.permissions.clone();571 match enable {572 false => {573 let mut nesting = permissions.nesting().clone();574 nesting.token_owner = false;575 nesting.restricted = None;576 permissions.nesting = Some(nesting);577 }578 true => {579 let mut bv = OwnerRestrictedSet::new();580 for i in collections {581 bv.try_insert(crate::eth::map_eth_to_id(&i).ok_or_else(|| {582 Error::Revert("Can't convert address into collection id".into())583 })?)584 .map_err(|_| "too many collections")?;585 }586 let mut nesting = permissions.nesting().clone();587 nesting.token_owner = true;588 nesting.restricted = Some(bv);589 permissions.nesting = Some(nesting);590 }591 };592593 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)594 }595596 597 #[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]598 fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {599 let nesting = self.collection.permissions.nesting();600601 Ok((602 nesting.token_owner,603 nesting604 .restricted605 .clone()606 .map(|b| b.0.into_inner().iter().map(|id| id.0.into()).collect())607 .unwrap_or_default(),608 ))609 }610611 612 fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {613 let nesting = self.collection.permissions.nesting();614 Ok(vec![615 (EvmPermissions::CollectionAdmin, nesting.collection_admin),616 (EvmPermissions::TokenOwner, nesting.token_owner),617 ])618 }619 620 621 622 623 fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result<void> {624 self.consume_store_reads_and_writes(1, 1)?;625626 let caller = T::CrossAccountId::from_eth(caller);627 let permissions = CollectionPermissions {628 access: Some(match mode {629 0 => AccessMode::Normal,630 1 => AccessMode::AllowList,631 _ => return Err("not supported access mode".into()),632 }),633 ..Default::default()634 };635 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)636 }637638 639 640 641 fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {642 let user = user.into_sub_cross_account::<T>()?;643 Ok(Pallet::<T>::allowed(self.id, user))644 }645646 647 648 649 #[solidity(hide)]650 fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {651 self.consume_store_writes(1)?;652653 let caller = T::CrossAccountId::from_eth(caller);654 let user = T::CrossAccountId::from_eth(user);655 <Pallet<T>>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;656 Ok(())657 }658659 660 661 662 fn add_to_collection_allow_list_cross(663 &mut self,664 caller: caller,665 user: EthCrossAccount,666 ) -> Result<void> {667 self.consume_store_writes(1)?;668669 let caller = T::CrossAccountId::from_eth(caller);670 let user = user.into_sub_cross_account::<T>()?;671 Pallet::<T>::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::<T>)?;672 Ok(())673 }674675 676 677 678 #[solidity(hide)]679 fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result<void> {680 self.consume_store_writes(1)?;681682 let caller = T::CrossAccountId::from_eth(caller);683 let user = T::CrossAccountId::from_eth(user);684 <Pallet<T>>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;685 Ok(())686 }687688 689 690 691 fn remove_from_collection_allow_list_cross(692 &mut self,693 caller: caller,694 user: EthCrossAccount,695 ) -> Result<void> {696 self.consume_store_writes(1)?;697698 let caller = T::CrossAccountId::from_eth(caller);699 let user = user.into_sub_cross_account::<T>()?;700 Pallet::<T>::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::<T>)?;701 Ok(())702 }703704 705 706 707 fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result<void> {708 self.consume_store_reads_and_writes(1, 1)?;709710 let caller = T::CrossAccountId::from_eth(caller);711 let permissions = CollectionPermissions {712 mint_mode: Some(mode),713 ..Default::default()714 };715 <Pallet<T>>::update_permissions(&caller, self, permissions).map_err(dispatch_to_evm::<T>)716 }717718 719 720 721 722 #[solidity(hide, rename_selector = "isOwnerOrAdmin")]723 fn is_owner_or_admin_eth(&self, user: address) -> Result<bool> {724 let user = T::CrossAccountId::from_eth(user);725 Ok(self.is_owner_or_admin(&user))726 }727728 729 730 731 732 fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {733 let user = user.into_sub_cross_account::<T>()?;734 Ok(self.is_owner_or_admin(&user))735 }736737 738 739 740 fn unique_collection_type(&self) -> Result<string> {741 let mode = match self.collection.mode {742 CollectionMode::Fungible(_) => "Fungible",743 CollectionMode::NFT => "NFT",744 CollectionMode::ReFungible => "ReFungible",745 };746 Ok(mode.into())747 }748749 750 751 752 753 fn collection_owner(&self) -> Result<EthCrossAccount> {754 Ok(EthCrossAccount::from_sub_cross_account::<T>(755 &T::CrossAccountId::from_sub(self.owner.clone()),756 ))757 }758759 760 761 762 763 #[solidity(hide, rename_selector = "changeCollectionOwner")]764 fn set_owner(&mut self, caller: caller, new_owner: address) -> Result<void> {765 self.consume_store_writes(1)?;766767 let caller = T::CrossAccountId::from_eth(caller);768 let new_owner = T::CrossAccountId::from_eth(new_owner);769 self.change_owner(caller, new_owner)770 .map_err(dispatch_to_evm::<T>)771 }772773 774 775 776 777 fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {778 let result = crate::IsAdmin::<T>::iter_prefix((self.id,))779 .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))780 .collect();781 Ok(result)782 }783784 785 786 787 788 fn change_collection_owner_cross(789 &mut self,790 caller: caller,791 new_owner: EthCrossAccount,792 ) -> Result<void> {793 self.consume_store_writes(1)?;794795 let caller = T::CrossAccountId::from_eth(caller);796 let new_owner = new_owner.into_sub_cross_account::<T>()?;797 self.change_owner(caller, new_owner)798 .map_err(dispatch_to_evm::<T>)799 }800}801802803804fn check_is_owner_or_admin<T: Config>(805 caller: caller,806 collection: &CollectionHandle<T>,807) -> Result<T::CrossAccountId> {808 let caller = T::CrossAccountId::from_eth(caller);809 collection810 .check_is_owner_or_admin(&caller)811 .map_err(dispatch_to_evm::<T>)?;812 Ok(caller)813}814815816817fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {818 collection819 .check_is_internal()820 .map_err(dispatch_to_evm::<T>)?;821 collection.save().map_err(dispatch_to_evm::<T>)?;822 Ok(())823}824825826pub mod static_property {827 use evm_coder::{828 execution::{Result, Error},829 };830 use alloc::format;831832 const EXPECT_CONVERT_ERROR: &str = "length < limit";833834 835 pub mod key {836 use super::*;837838 839 pub fn base_uri() -> up_data_structs::PropertyKey {840 property_key_from_bytes(b"baseURI").expect(EXPECT_CONVERT_ERROR)841 }842843 844 pub fn url() -> up_data_structs::PropertyKey {845 property_key_from_bytes(b"URI").expect(EXPECT_CONVERT_ERROR)846 }847848 849 pub fn suffix() -> up_data_structs::PropertyKey {850 property_key_from_bytes(b"URISuffix").expect(EXPECT_CONVERT_ERROR)851 }852853 854 pub fn parent_nft() -> up_data_structs::PropertyKey {855 property_key_from_bytes(b"parentNft").expect(EXPECT_CONVERT_ERROR)856 }857 }858859 860 pub fn property_key_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyKey> {861 bytes.to_vec().try_into().map_err(|_| {862 Error::Revert(format!(863 "Property key is too long. Max length is {}.",864 up_data_structs::PropertyKey::bound()865 ))866 })867 }868869 870 pub fn property_value_from_bytes(bytes: &[u8]) -> Result<up_data_structs::PropertyValue> {871 bytes.to_vec().try_into().map_err(|_| {872 Error::Revert(format!(873 "Property key is too long. Max length is {}.",874 up_data_structs::PropertyKey::bound()875 ))876 })877 }878}