12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879#![cfg_attr(not(feature = "std"), no_std)]8081use core::ops::Deref;8283use evm_coder::ToLog;84use frame_support::{dispatch::PostDispatchInfo, ensure, pallet_prelude::*};85pub use pallet::*;86use pallet_common::{87 eth::collection_id_to_address, helpers::add_weight_to_post_info,88 weights::WeightInfo as CommonWeightInfo, Error as CommonError, Event as CommonEvent,89 Pallet as PalletCommon, SelfWeightOf as PalletCommonWeightOf,90};91use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};92use pallet_evm_coder_substrate::WithRecorder;93use pallet_structure::Pallet as PalletStructure;94use sp_core::H160;95use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};96use sp_std::{collections::btree_map::BTreeMap, vec::Vec};97use up_data_structs::{98 budget::Budget, mapping::TokenAddressMapping, AccessMode, CollectionId, Property, PropertyKey,99 TokenId,100};101use weights::WeightInfo;102103use crate::erc::ERC20Events;104#[cfg(feature = "runtime-benchmarks")]105pub mod benchmarking;106pub mod common;107pub mod erc;108pub mod weights;109110pub type CreateItemData<T> = (<T as pallet_evm::Config>::CrossAccountId, u128);111pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;112113#[frame_support::pallet]114pub mod pallet {115 use frame_support::{116 pallet_prelude::*, storage::Key, Blake2_128, Blake2_128Concat, Twox64Concat,117 };118 use up_data_structs::CollectionId;119120 use super::weights::WeightInfo;121122 #[pallet::error]123 pub enum Error<T> {124 125 FungibleItemsDontHaveData,126 127 FungibleDisallowsNesting,128 129 SettingPropertiesNotAllowed,130 131 SettingAllowanceForAllNotAllowed,132 133 FungibleTokensAreAlwaysValid,134 }135136 #[pallet::config]137 pub trait Config:138 frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config139 {140 type WeightInfo: WeightInfo;141 }142143 #[pallet::pallet]144 pub struct Pallet<T>(_);145146 147 #[pallet::storage]148 pub type TotalSupply<T: Config> =149 StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u128, QueryKind = ValueQuery>;150151 152 #[pallet::storage]153 pub type Balance<T: Config> = StorageNMap<154 Key = (155 Key<Twox64Concat, CollectionId>,156 Key<Blake2_128Concat, T::CrossAccountId>,157 ),158 Value = u128,159 QueryKind = ValueQuery,160 >;161162 163 #[pallet::storage]164 pub type Allowance<T: Config> = StorageNMap<165 Key = (166 Key<Twox64Concat, CollectionId>,167 Key<Blake2_128, T::CrossAccountId>, 168 Key<Blake2_128Concat, T::CrossAccountId>, 169 ),170 Value = u128,171 QueryKind = ValueQuery,172 >;173}174175176177pub struct FungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);178179180impl<T: Config> FungibleHandle<T> {181 182 pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {183 Self(inner)184 }185186 187 pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {188 self.0189 }190 191 pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {192 &mut self.0193 }194}195impl<T: Config> WithRecorder<T> for FungibleHandle<T> {196 fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {197 self.0.recorder()198 }199 fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {200 self.0.into_recorder()201 }202}203impl<T: Config> Deref for FungibleHandle<T> {204 type Target = pallet_common::CollectionHandle<T>;205206 fn deref(&self) -> &Self::Target {207 &self.0208 }209}210211212impl<T: Config> Pallet<T> {213 214 pub fn destroy_collection(215 collection: FungibleHandle<T>,216 sender: &T::CrossAccountId,217 ) -> DispatchResult {218 let id = collection.id;219220 if Self::collection_has_tokens(id) {221 return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());222 }223224 225226 PalletCommon::destroy_collection(collection.0, sender)?;227228 <TotalSupply<T>>::remove(id);229 let _ = <Balance<T>>::clear_prefix((id,), u32::MAX, None);230 let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);231 Ok(())232 }233234 235 pub fn set_collection_properties(236 collection: &FungibleHandle<T>,237 sender: &T::CrossAccountId,238 properties: Vec<Property>,239 ) -> DispatchResult {240 <PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())241 }242243 244 pub fn delete_collection_properties(245 collection: &FungibleHandle<T>,246 sender: &T::CrossAccountId,247 property_keys: Vec<PropertyKey>,248 ) -> DispatchResult {249 <PalletCommon<T>>::delete_collection_properties(250 collection,251 sender,252 property_keys.into_iter(),253 )254 }255256 257 fn collection_has_tokens(collection_id: CollectionId) -> bool {258 <TotalSupply<T>>::get(collection_id) != 0259 }260261 262 263 264 pub fn burn(265 collection: &FungibleHandle<T>,266 owner: &T::CrossAccountId,267 amount: u128,268 ) -> DispatchResult {269 let total_supply = <TotalSupply<T>>::get(collection.id)270 .checked_sub(amount)271 .ok_or(<CommonError<T>>::TokenValueTooLow)?;272273 let balance = <Balance<T>>::get((collection.id, owner))274 .checked_sub(amount)275 .ok_or(<CommonError<T>>::TokenValueTooLow)?;276277 if collection.permissions.access() == AccessMode::AllowList {278 collection.check_allowlist(owner)?;279 }280281 282283 if balance == 0 {284 <Balance<T>>::remove((collection.id, owner));285 <PalletStructure<T>>::unnest_if_nested(owner, collection.id, TokenId::default());286 } else {287 <Balance<T>>::insert((collection.id, owner), balance);288 }289 <TotalSupply<T>>::insert(collection.id, total_supply);290291 <PalletEvm<T>>::deposit_log(292 ERC20Events::Transfer {293 from: *owner.as_eth(),294 to: H160::default(),295 value: amount.into(),296 }297 .to_log(collection_id_to_address(collection.id)),298 );299 <PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(300 collection.id,301 TokenId::default(),302 owner.clone(),303 amount,304 ));305 Ok(())306 }307308 309 310 311 312 313 314 315 pub fn transfer(316 collection: &FungibleHandle<T>,317 from: &T::CrossAccountId,318 to: &T::CrossAccountId,319 amount: u128,320 nesting_budget: &dyn Budget,321 ) -> DispatchResultWithPostInfo {322 let depositor = from;323 Self::transfer_internal(collection, depositor, from, to, amount, nesting_budget)324 }325326 327 328 329 fn transfer_internal(330 collection: &FungibleHandle<T>,331 depositor: &T::CrossAccountId,332 from: &T::CrossAccountId,333 to: &T::CrossAccountId,334 amount: u128,335 nesting_budget: &dyn Budget,336 ) -> DispatchResultWithPostInfo {337 ensure!(338 collection.limits.transfers_enabled(),339 <CommonError<T>>::TransferNotAllowed,340 );341342 let mut actual_weight = <SelfWeightOf<T>>::transfer_raw();343344 if collection.permissions.access() == AccessMode::AllowList {345 collection.check_allowlist(from)?;346 collection.check_allowlist(to)?;347 actual_weight += <PalletCommonWeightOf<T>>::check_accesslist() * 2;348 }349 <PalletCommon<T>>::ensure_correct_receiver(to)?;350 let balance_from = <Balance<T>>::get((collection.id, from))351 .checked_sub(amount)352 .ok_or(<CommonError<T>>::TokenValueTooLow)?;353 let balance_to = if from != to && amount != 0 {354 Some(355 <Balance<T>>::get((collection.id, to))356 .checked_add(amount)357 .ok_or(ArithmeticError::Overflow)?,358 )359 } else {360 None361 };362363 364365 if let Some(balance_to) = balance_to {366 367368 <PalletStructure<T>>::nest_if_sent_to_token(369 depositor,370 to,371 collection.id,372 TokenId::default(),373 nesting_budget,374 )?;375376 if balance_from == 0 {377 <Balance<T>>::remove((collection.id, from));378 <PalletStructure<T>>::unnest_if_nested(from, collection.id, TokenId::default());379 } else {380 <Balance<T>>::insert((collection.id, from), balance_from);381 }382 <Balance<T>>::insert((collection.id, to), balance_to);383 }384385 <PalletEvm<T>>::deposit_log(386 ERC20Events::Transfer {387 from: *from.as_eth(),388 to: *to.as_eth(),389 value: amount.into(),390 }391 .to_log(collection_id_to_address(collection.id)),392 );393 <PalletCommon<T>>::deposit_event(CommonEvent::Transfer(394 collection.id,395 TokenId::default(),396 from.clone(),397 to.clone(),398 amount,399 ));400401 Ok(PostDispatchInfo {402 actual_weight: Some(actual_weight),403 pays_fee: Pays::Yes,404 })405 }406407 408 409 pub fn create_multiple_items(410 collection: &FungibleHandle<T>,411 depositor: &T::CrossAccountId,412 data: BTreeMap<T::CrossAccountId, u128>,413 nesting_budget: &dyn Budget,414 ) -> DispatchResult {415 if !collection.is_owner_or_admin(depositor) {416 ensure!(417 collection.permissions.mint_mode(),418 <CommonError<T>>::PublicMintingNotAllowed419 );420 collection.check_allowlist(depositor)?;421422 for (owner, _) in data.iter() {423 collection.check_allowlist(owner)?;424 }425 }426427 let total_supply = data428 .values()429 .copied()430 .try_fold(<TotalSupply<T>>::get(collection.id), |acc, v| {431 acc.checked_add(v)432 })433 .ok_or(ArithmeticError::Overflow)?;434435 for (to, _) in data.iter() {436 <PalletStructure<T>>::check_nesting(437 depositor,438 to,439 collection.id,440 TokenId::default(),441 nesting_budget,442 )?;443 }444445 let updated_balances = data446 .into_iter()447 .map(|(user, amount)| {448 let updated_balance = <Balance<T>>::get((collection.id, &user))449 .checked_add(amount)450 .ok_or(ArithmeticError::Overflow)?;451 Ok((user, amount, updated_balance))452 })453 .collect::<Result<Vec<_>, DispatchError>>()?;454455 456457 <TotalSupply<T>>::insert(collection.id, total_supply);458 for (user, amount, updated_balance) in updated_balances {459 <Balance<T>>::insert((collection.id, &user), updated_balance);460 <PalletStructure<T>>::nest_if_sent_to_token_unchecked(461 &user,462 collection.id,463 TokenId::default(),464 );465 <PalletEvm<T>>::deposit_log(466 ERC20Events::Transfer {467 from: H160::default(),468 to: *user.as_eth(),469 value: amount.into(),470 }471 .to_log(collection_id_to_address(collection.id)),472 );473 <PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(474 collection.id,475 TokenId::default(),476 user.clone(),477 amount,478 ));479 }480481 Ok(())482 }483484 fn set_allowance_unchecked(485 collection: &FungibleHandle<T>,486 owner: &T::CrossAccountId,487 spender: &T::CrossAccountId,488 amount: u128,489 ) {490 if amount == 0 {491 <Allowance<T>>::remove((collection.id, owner, spender));492 } else {493 <Allowance<T>>::insert((collection.id, owner, spender), amount);494 }495496 <PalletEvm<T>>::deposit_log(497 ERC20Events::Approval {498 owner: *owner.as_eth(),499 spender: *spender.as_eth(),500 value: amount.into(),501 }502 .to_log(collection_id_to_address(collection.id)),503 );504 <PalletCommon<T>>::deposit_event(CommonEvent::Approved(505 collection.id,506 TokenId(0),507 owner.clone(),508 spender.clone(),509 amount,510 ));511 }512513 514 515 516 517 518 519 pub fn set_allowance(520 collection: &FungibleHandle<T>,521 owner: &T::CrossAccountId,522 spender: &T::CrossAccountId,523 amount: u128,524 ) -> DispatchResult {525 if collection.permissions.access() == AccessMode::AllowList {526 collection.check_allowlist(owner)?;527 collection.check_allowlist(spender)?;528 }529530 if <Balance<T>>::get((collection.id, owner)) < amount {531 ensure!(532 collection.ignores_owned_amount(owner),533 <CommonError<T>>::CantApproveMoreThanOwned534 );535 }536537 538539 Self::set_allowance_unchecked(collection, owner, spender, amount);540 Ok(())541 }542543 544 545 546 547 548 549 550 pub fn set_allowance_from(551 collection: &FungibleHandle<T>,552 sender: &T::CrossAccountId,553 from: &T::CrossAccountId,554 to: &T::CrossAccountId,555 amount: u128,556 ) -> DispatchResult {557 if collection.permissions.access() == AccessMode::AllowList {558 collection.check_allowlist(sender)?;559 collection.check_allowlist(from)?;560 collection.check_allowlist(to)?;561 }562563 ensure!(564 sender.conv_eq(from),565 <CommonError<T>>::AddressIsNotEthMirror566 );567568 if <Balance<T>>::get((collection.id, from)) < amount {569 ensure!(570 collection.limits.owner_can_transfer()571 && (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),572 <CommonError<T>>::CantApproveMoreThanOwned573 );574 }575576 577578 Self::set_allowance_unchecked(collection, from, to, amount);579 Ok(())580 }581582 583 584 585 586 587 588 589 fn check_allowed(590 collection: &FungibleHandle<T>,591 spender: &T::CrossAccountId,592 from: &T::CrossAccountId,593 amount: u128,594 nesting_budget: &dyn Budget,595 ) -> Result<Option<u128>, DispatchError> {596 if spender.conv_eq(from) {597 return Ok(None);598 }599 if collection.permissions.access() == AccessMode::AllowList {600 601 collection.check_allowlist(spender)?;602 }603604 if collection.ignores_token_restrictions(spender) {605 return Ok(Self::compute_allowance_decrease(606 collection, from, spender, amount,607 ));608 }609610 if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {611 ensure!(612 <PalletStructure<T>>::check_indirectly_owned(613 spender.clone(),614 source.0,615 source.1,616 None,617 nesting_budget618 )?,619 <CommonError<T>>::ApprovedValueTooLow,620 );621 return Ok(None);622 }623624 let allowance = Self::compute_allowance_decrease(collection, from, spender, amount);625 ensure!(allowance.is_some(), <CommonError<T>>::ApprovedValueTooLow);626627 Ok(allowance)628 }629630 631 632 fn compute_allowance_decrease(633 collection: &FungibleHandle<T>,634 from: &T::CrossAccountId,635 spender: &T::CrossAccountId,636 amount: u128,637 ) -> Option<u128> {638 <Allowance<T>>::get((collection.id, from, spender)).checked_sub(amount)639 }640641 642 643 644 645 pub fn transfer_from(646 collection: &FungibleHandle<T>,647 spender: &T::CrossAccountId,648 from: &T::CrossAccountId,649 to: &T::CrossAccountId,650 amount: u128,651 nesting_budget: &dyn Budget,652 ) -> DispatchResultWithPostInfo {653 let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;654655 656657 let mut result =658 Self::transfer_internal(collection, spender, from, to, amount, nesting_budget);659 add_weight_to_post_info(&mut result, <SelfWeightOf<T>>::check_allowed_raw());660 result?;661662 if let Some(allowance) = allowance {663 Self::set_allowance_unchecked(collection, from, spender, allowance);664 add_weight_to_post_info(665 &mut result,666 <SelfWeightOf<T>>::set_allowance_unchecked_raw(),667 )668 }669 result670 }671672 673 674 675 676 677 pub fn burn_from(678 collection: &FungibleHandle<T>,679 spender: &T::CrossAccountId,680 from: &T::CrossAccountId,681 amount: u128,682 nesting_budget: &dyn Budget,683 ) -> DispatchResult {684 let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;685686 687688 Self::burn(collection, from, amount)?;689 if let Some(allowance) = allowance {690 Self::set_allowance_unchecked(collection, from, spender, allowance);691 }692 Ok(())693 }694695 696 697 698 699 700 701 702 pub fn create_item(703 collection: &FungibleHandle<T>,704 sender: &T::CrossAccountId,705 data: CreateItemData<T>,706 nesting_budget: &dyn Budget,707 ) -> DispatchResult {708 Self::create_multiple_items(709 collection,710 sender,711 [(data.0, data.1)].into_iter().collect(),712 nesting_budget,713 )714 }715716 717 718 719 720 721 722 pub fn token_owners(723 collection: CollectionId,724 _token: TokenId,725 ) -> Option<Vec<T::CrossAccountId>> {726 let res: Vec<T::CrossAccountId> = <Balance<T>>::iter_prefix((collection,))727 .map(|(owner, _amount)| owner)728 .take(10)729 .collect();730731 if res.is_empty() {732 None733 } else {734 Some(res)735 }736 }737}