123456#![recursion_limit = "1024"]7#![cfg_attr(not(feature = "std"), no_std)]8#![allow(9 clippy::too_many_arguments,10 clippy::unnecessary_mut_passed,11 clippy::unused_unit12)]1314extern crate alloc;1516pub use serde::{Serialize, Deserialize};1718pub use frame_support::{19 construct_runtime, decl_module, decl_storage, decl_error,20 dispatch::DispatchResult,21 ensure, fail, parameter_types,22 traits::{23 ExistenceRequirement, Get, Imbalance, KeyOwnerProofSystem, OnUnbalanced, Randomness,24 IsSubType, WithdrawReasons,25 },26 weights::{27 constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},28 DispatchInfo, GetDispatchInfo, IdentityFee, Pays, PostDispatchInfo, Weight,29 WeightToFeePolynomial, DispatchClass,30 },31 StorageValue, transactional,32 pallet_prelude::DispatchResultWithPostInfo,33};34use scale_info::TypeInfo;35use frame_system::{self as system, ensure_signed};36use sp_runtime::{sp_std::prelude::Vec};37use nft_data_structs::{38 MAX_DECIMAL_POINTS, MAX_SPONSOR_TIMEOUT, MAX_TOKEN_OWNERSHIP, CUSTOM_DATA_LIMIT,39 VARIABLE_ON_CHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, COLLECTION_ADMINS_LIMIT,40 OFFCHAIN_SCHEMA_LIMIT, AccessMode, Collection, CreateItemData, CollectionLimits, CollectionId,41 CollectionMode, TokenId, SchemaVersion, SponsorshipState, MetaUpdatePermission,42};43use pallet_common::{44 account::CrossAccountId, CollectionHandle, IsAdmin, Pallet as PalletCommon,45 Error as CommonError, CommonWeightInfo, Allowlist,46};47use pallet_refungible::{Pallet as PalletRefungible, RefungibleHandle};48use pallet_fungible::{Pallet as PalletFungible, FungibleHandle};49use pallet_nonfungible::{Pallet as PalletNonfungible, NonfungibleHandle};5051#[cfg(test)]52mod mock;5354#[cfg(test)]55mod tests;5657mod eth;58mod sponsorship;59pub use sponsorship::NftSponsorshipHandler;60pub use eth::sponsoring::NftEthSponsorshipHandler;6162pub use eth::NftErcSupport;6364pub mod common;65use common::CommonWeights;66pub mod dispatch;67use dispatch::dispatch_call;6869#[cfg(feature = "runtime-benchmarks")]70mod benchmarking;71pub mod weights;72use weights::WeightInfo;7374decl_error! {75 76 pub enum Error for Module<T: Config> {77 78 CollectionDecimalPointLimitExceeded,79 80 ConfirmUnsetSponsorFail,81 82 EmptyArgument,83 84 CollectionLimitBoundsExceeded,85 86 OwnerPermissionsCantBeReverted,87 }88}89pub trait Config:90 system::Config91 + pallet_evm_coder_substrate::Config92 + pallet_common::Config93 + pallet_nonfungible::Config94 + pallet_refungible::Config95 + pallet_fungible::Config96 + Sized97 + TypeInfo98{99 100 type WeightInfo: WeightInfo;101}102103type SelfWeightOf<T> = <T as Config>::WeightInfo;104105106107108109110111112113114115116117118119120121122123124125126127decl_storage! {128 trait Store for Module<T: Config> as Nft {129130 131 132 ChainVersion: u64;133 134135 136 137 138 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => T::BlockNumber;139 140 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;141 142 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => T::BlockNumber;143 144 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;145 146147 148 149 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber> = None;150 }151}152153decl_module! {154 pub struct Module<T: Config> for enum Call155 where156 origin: T::Origin157 {158 const CollectionAdminsLimit: u64 = COLLECTION_ADMINS_LIMIT;159 type Error = Error<T>;160161 fn on_initialize(_now: T::BlockNumber) -> Weight {162 0163 }164165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 #[weight = <SelfWeightOf<T>>::create_collection()]182 #[transactional]183 pub fn create_collection(origin,184 collection_name: Vec<u16>,185 collection_description: Vec<u16>,186 token_prefix: Vec<u8>,187 mode: CollectionMode) -> DispatchResult {188189 190 let who = ensure_signed(origin)?;191192 let limits = CollectionLimits::<T::BlockNumber> {193 sponsored_data_size: CUSTOM_DATA_LIMIT,194 ..Default::default()195 };196197 198 let new_collection = Collection::<T> {199 owner: who.clone(),200 name: collection_name,201 mode: mode.clone(),202 mint_mode: false,203 access: AccessMode::Normal,204 description: collection_description,205 token_prefix,206 offchain_schema: Vec::new(),207 schema_version: SchemaVersion::ImageURL,208 sponsorship: SponsorshipState::Disabled,209 variable_on_chain_schema: Vec::new(),210 const_on_chain_schema: Vec::new(),211 limits,212 transfers_enabled: true,213 meta_update_permission: Default::default(),214 };215216 let _id = match mode {217 CollectionMode::NFT => {PalletNonfungible::init_collection(new_collection)?},218 CollectionMode::Fungible(decimal_points) => {219 220 ensure!(decimal_points <= MAX_DECIMAL_POINTS, Error::<T>::CollectionDecimalPointLimitExceeded);221 PalletFungible::init_collection(new_collection)?222 }223 CollectionMode::ReFungible => {224 PalletRefungible::init_collection(new_collection)?225 }226 };227228 Ok(())229 }230231 232 233 234 235 236 237 238 239 240 #[weight = <SelfWeightOf<T>>::destroy_collection()]241 #[transactional]242 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {243 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);244245 let collection = <CollectionHandle<T>>::try_get(collection_id)?;246 collection.check_is_owner(&sender)?;247248 249250 match collection.mode {251 CollectionMode::ReFungible => PalletRefungible::destroy_collection(RefungibleHandle::cast(collection), &sender)?,252 CollectionMode::Fungible(_) => PalletFungible::destroy_collection(FungibleHandle::cast(collection), &sender)?,253 CollectionMode::NFT => PalletNonfungible::destroy_collection(NonfungibleHandle::cast(collection), &sender)?,254 }255256 <NftTransferBasket<T>>::remove_prefix(collection_id, None);257 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);258 <ReFungibleTransferBasket<T>>::remove_prefix(collection_id, None);259260 <VariableMetaDataBasket<T>>::remove_prefix(collection_id, None);261262 Ok(())263 }264265 266 267 268 269 270 271 272 273 274 275 276 277 #[weight = <SelfWeightOf<T>>::add_to_white_list()]278 #[transactional]279 pub fn add_to_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{280281 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);282 let collection = <CollectionHandle<T>>::try_get(collection_id)?;283284 <PalletCommon<T>>::toggle_allowlist(285 &collection,286 &sender,287 &address,288 true,289 )?;290291 Ok(())292 }293294 295 296 297 298 299 300 301 302 303 304 305 306 #[weight = <SelfWeightOf<T>>::remove_from_white_list()]307 #[transactional]308 pub fn remove_from_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{309310 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);311 let collection = <CollectionHandle<T>>::try_get(collection_id)?;312313 <PalletCommon<T>>::toggle_allowlist(314 &collection,315 &sender,316 &address,317 false,318 )?;319320 Ok(())321 }322323 324 325 326 327 328 329 330 331 332 333 334 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]335 #[transactional]336 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult337 {338 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);339340 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;341 target_collection.check_is_owner(&sender)?;342343 target_collection.access = mode;344 target_collection.save()345 }346347 348 349 350 351 352 353 354 355 356 357 358 359 360 #[weight = <SelfWeightOf<T>>::set_mint_permission()]361 #[transactional]362 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult363 {364 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);365366 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;367 target_collection.check_is_owner(&sender)?;368369 target_collection.mint_mode = mint_permission;370 target_collection.save()371 }372373 374 375 376 377 378 379 380 381 382 383 384 #[weight = <SelfWeightOf<T>>::change_collection_owner()]385 #[transactional]386 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {387388 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);389390 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;391 target_collection.check_is_owner(&sender)?;392393 target_collection.owner = new_owner;394 target_collection.save()395 }396397 398 399 400 401 402 403 404 405 406 407 408 409 410 #[weight = <SelfWeightOf<T>>::add_collection_admin()]411 #[transactional]412 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {413 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);414415 let collection = <CollectionHandle<T>>::try_get(collection_id)?;416 collection.check_is_owner_or_admin(&sender)?;417418 <IsAdmin<T>>::insert((collection_id, new_admin_id.as_sub()), true);419 Ok(())420 }421422 423 424 425 426 427 428 429 430 431 432 433 434 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]435 #[transactional]436 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {437 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);438439 let collection = <CollectionHandle<T>>::try_get(collection_id)?;440 collection.check_is_owner_or_admin(&sender)?;441442 <IsAdmin<T>>::remove((collection_id, account_id.as_sub()));443 Ok(())444 }445446 447 448 449 450 451 452 453 454 455 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]456 #[transactional]457 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {458 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);459460 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;461 target_collection.check_is_owner_or_admin(&sender)?;462463 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor);464 target_collection.save()465 }466467 468 469 470 471 472 473 474 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]475 #[transactional]476 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {477 let sender = ensure_signed(origin)?;478479 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;480 ensure!(481 target_collection.sponsorship.pending_sponsor() == Some(&sender),482 Error::<T>::ConfirmUnsetSponsorFail483 );484485 target_collection.sponsorship = SponsorshipState::Confirmed(sender);486 target_collection.save()487 }488489 490 491 492 493 494 495 496 497 498 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]499 #[transactional]500 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {501 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);502503 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;504 target_collection.check_is_owner(&sender)?;505506 target_collection.sponsorship = SponsorshipState::Disabled;507 target_collection.save()508 }509510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 #[weight = <CommonWeights<T>>::create_item()]529 #[transactional]530 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {531 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);532533 dispatch_call::<T, _>(collection_id, |d| d.create_item(sender, owner, data))534 }535536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 #[weight = <CommonWeights<T>>::create_multiple_items(items_data.len() as u32)]555 #[transactional]556 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {557 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);558 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);559560 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data))561 }562563 564565 566 567 568 569 570 571 572 573 574 575 576 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]577 #[transactional]578 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {579 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);580 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;581 target_collection.check_is_owner(&sender)?;582583 584585 target_collection.transfers_enabled = value;586 target_collection.save()587 }588589 590 591 592 593 594 595 596 597 598 599 600 601 602 #[weight = <CommonWeights<T>>::burn_item()]603 #[transactional]604 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {605 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);606607 dispatch_call::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))608 }609610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630631 632 633 634635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 #[weight = <CommonWeights<T>>::transfer()]659 #[transactional]660 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {661 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);662663 dispatch_call::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value))664 }665666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 #[weight = <CommonWeights<T>>::approve()]682 #[transactional]683 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {684 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);685686 dispatch_call::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))687 }688689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 #[weight = <CommonWeights<T>>::transfer_from()]709 #[transactional]710 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {711 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);712713 dispatch_call::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value))714 }715716 717 718 719 720 721 722 723 724 725 726 727 728 #[weight = <CommonWeights<T>>::set_variable_metadata(data.len() as u32)]729 #[transactional]730 pub fn set_variable_meta_data (731 origin,732 collection_id: CollectionId,733 item_id: TokenId,734 data: Vec<u8>735 ) -> DispatchResultWithPostInfo {736 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);737738 dispatch_call::<T, _>(collection_id, |d| d.set_variable_metadata(sender, item_id, data))739 }740741 742 743 744 745 746 747 748 749 750 751 752 #[weight = <SelfWeightOf<T>>::set_meta_update_permission_flag()]753 #[transactional]754 pub fn set_meta_update_permission_flag(origin, collection_id: CollectionId, value: MetaUpdatePermission) -> DispatchResult {755 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);756 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;757758 ensure!(759 target_collection.meta_update_permission != MetaUpdatePermission::None,760 <CommonError<T>>::MetadataFlagFrozen,761 );762 target_collection.check_is_owner(&sender)?;763764 target_collection.meta_update_permission = value;765766 target_collection.save()767 }768769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 #[weight = <SelfWeightOf<T>>::set_schema_version()]784 #[transactional]785 pub fn set_schema_version(786 origin,787 collection_id: CollectionId,788 version: SchemaVersion789 ) -> DispatchResult {790 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);791 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;792 target_collection.check_is_owner_or_admin(&sender)?;793 target_collection.schema_version = version;794 target_collection.save()795 }796797 798 799 800 801 802 803 804 805 806 807 808 809 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]810 #[transactional]811 pub fn set_offchain_schema(812 origin,813 collection_id: CollectionId,814 schema: Vec<u8>815 ) -> DispatchResult {816 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);817 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;818 target_collection.check_is_owner_or_admin(&sender)?;819820 821 ensure!(schema.len() as u32 <= OFFCHAIN_SCHEMA_LIMIT, "");822823 target_collection.offchain_schema = schema;824 target_collection.save()825 }826827 828 829 830 831 832 833 834 835 836 837 838 839 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]840 #[transactional]841 pub fn set_const_on_chain_schema (842 origin,843 collection_id: CollectionId,844 schema: Vec<u8>845 ) -> DispatchResult {846 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);847 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;848 target_collection.check_is_owner_or_admin(&sender)?;849850 851 ensure!(schema.len() as u32 <= CONST_ON_CHAIN_SCHEMA_LIMIT, "");852853 target_collection.const_on_chain_schema = schema;854 target_collection.save()855 }856857 858 859 860 861 862 863 864 865 866 867 868 869 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]870 #[transactional]871 pub fn set_variable_on_chain_schema (872 origin,873 collection_id: CollectionId,874 schema: Vec<u8>875 ) -> DispatchResult {876 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);877 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;878 target_collection.check_is_owner_or_admin(&sender)?;879880 881 ensure!(schema.len() as u32 <= VARIABLE_ON_CHAIN_SCHEMA_LIMIT, "");882883 target_collection.variable_on_chain_schema = schema;884 target_collection.save()885 }886887 #[weight = <SelfWeightOf<T>>::set_collection_limits()]888 #[transactional]889 pub fn set_collection_limits(890 origin,891 collection_id: CollectionId,892 new_limits: CollectionLimits<T::BlockNumber>,893 ) -> DispatchResult {894 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);895 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;896 target_collection.check_is_owner(&sender)?;897 let old_limits = &target_collection.limits;898899 900 ensure!(new_limits.sponsor_transfer_timeout <= MAX_SPONSOR_TIMEOUT &&901 new_limits.account_token_ownership_limit.unwrap_or(0) <= MAX_TOKEN_OWNERSHIP &&902 new_limits.sponsored_data_size <= CUSTOM_DATA_LIMIT,903 Error::<T>::CollectionLimitBoundsExceeded);904905 906 ensure!(old_limits.token_limit >= new_limits.token_limit, <CommonError<T>>::CollectionTokenLimitExceeded);907 ensure!(new_limits.token_limit > 0, <CommonError<T>>::CollectionTokenLimitExceeded);908909 ensure!(910 (old_limits.owner_can_transfer || !new_limits.owner_can_transfer) &&911 (old_limits.owner_can_destroy || !new_limits.owner_can_destroy),912 Error::<T>::OwnerPermissionsCantBeReverted,913 );914915 target_collection.limits = new_limits;916917 target_collection.save()918 }919 }920}921922923impl<T: Config> Pallet<T> {924 pub fn adminlist(collection: CollectionId) -> Vec<T::AccountId> {925 <IsAdmin<T>>::iter_prefix((collection,))926 .map(|(a, _)| a)927 .collect()928 }929 pub fn allowlist(collection: CollectionId) -> Vec<T::AccountId> {930 <Allowlist<T>>::iter_prefix((collection,))931 .map(|(a, _)| a)932 .collect()933 }934}