difftreelog
Merge pull request #197 from UniqueNetwork/feature/CORE-167
in: master
Limits logic fixed. Tests added
5 files changed
pallets/nft/src/lib.rsdiffbeforeafterboth1//2// This file is subject to the terms and conditions defined in3// file 'LICENSE', which is part of this source code package.4//56#![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_event, decl_module, decl_storage, decl_error,20 dispatch::DispatchResult,21 ensure, fail, parameter_types,22 traits::{23 Currency, ExistenceRequirement, Get, Imbalance, KeyOwnerProofSystem, OnUnbalanced,24 Randomness, 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};3334use frame_system::{self as system, ensure_signed};35use sp_core::H160;36use sp_std::vec;37use sp_runtime::{DispatchError, sp_std::prelude::Vec};38use core::ops::{Deref, DerefMut};39use nft_data_structs::{40 MAX_DECIMAL_POINTS, MAX_SPONSOR_TIMEOUT, MAX_TOKEN_OWNERSHIP, MAX_REFUNGIBLE_PIECES,41 CUSTOM_DATA_LIMIT, COLLECTION_NUMBER_LIMIT, ACCOUNT_TOKEN_OWNERSHIP_LIMIT,42 VARIABLE_ON_CHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, COLLECTION_ADMINS_LIMIT,43 OFFCHAIN_SCHEMA_LIMIT, MAX_TOKEN_PREFIX_LENGTH, MAX_COLLECTION_NAME_LENGTH,44 MAX_COLLECTION_DESCRIPTION_LENGTH, AccessMode, Collection, CreateItemData, CollectionLimits,45 CollectionId, CollectionMode, TokenId, SchemaVersion, SponsorshipState, Ownership, NftItemType,46 MetaUpdatePermission, FungibleItemType, ReFungibleItemType,47};4849#[cfg(test)]50mod mock;5152#[cfg(test)]53mod tests;5455mod eth;56mod sponsorship;57pub use sponsorship::NftSponsorshipHandler;58pub use eth::sponsoring::NftEthSponsorshipHandler;5960pub use eth::NftErcSupport;61pub use eth::account::*;62use eth::erc::{ERC20Events, ERC721Events};6364#[cfg(feature = "runtime-benchmarks")]65mod benchmarking;66pub mod weights;67use weights::WeightInfo;6869decl_error! {70 /// Error for non-fungible-token module.71 pub enum Error for Module<T: Config> {72 /// Total collections bound exceeded.73 TotalCollectionsLimitExceeded,74 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.75 CollectionDecimalPointLimitExceeded,76 /// Collection name can not be longer than 63 char.77 CollectionNameLimitExceeded,78 /// Collection description can not be longer than 255 char.79 CollectionDescriptionLimitExceeded,80 /// Token prefix can not be longer than 15 char.81 CollectionTokenPrefixLimitExceeded,82 /// This collection does not exist.83 CollectionNotFound,84 /// Item not exists.85 TokenNotFound,86 /// Admin not found87 AdminNotFound,88 /// Arithmetic calculation overflow.89 NumOverflow,90 /// Account already has admin role.91 AlreadyAdmin,92 /// You do not own this collection.93 NoPermission,94 /// This address is not set as sponsor, use setCollectionSponsor first.95 ConfirmUnsetSponsorFail,96 /// Collection is not in mint mode.97 PublicMintingNotAllowed,98 /// Sender parameter and item owner must be equal.99 MustBeTokenOwner,100 /// Item balance not enough.101 TokenValueTooLow,102 /// Size of item is too large.103 NftSizeLimitExceeded,104 /// No approve found105 ApproveNotFound,106 /// Requested value more than approved.107 TokenValueNotEnough,108 /// Only approved addresses can call this method.109 ApproveRequired,110 /// Address is not in white list.111 AddresNotInWhiteList,112 /// Number of collection admins bound exceeded.113 CollectionAdminsLimitExceeded,114 /// Owned tokens by a single address bound exceeded.115 AddressOwnershipLimitExceeded,116 /// Length of items properties must be greater than 0.117 EmptyArgument,118 /// const_data exceeded data limit.119 TokenConstDataLimitExceeded,120 /// variable_data exceeded data limit.121 TokenVariableDataLimitExceeded,122 /// Not NFT item data used to mint in NFT collection.123 NotNftDataUsedToMintNftCollectionToken,124 /// Not Fungible item data used to mint in Fungible collection.125 NotFungibleDataUsedToMintFungibleCollectionToken,126 /// Not Re Fungible item data used to mint in Re Fungible collection.127 NotReFungibleDataUsedToMintReFungibleCollectionToken,128 /// Unexpected collection type.129 UnexpectedCollectionType,130 /// Can't store metadata in fungible tokens.131 CantStoreMetadataInFungibleTokens,132 /// Collection token limit exceeded133 CollectionTokenLimitExceeded,134 /// Account token limit exceeded per collection135 AccountTokenLimitExceeded,136 /// Collection limit bounds per collection exceeded137 CollectionLimitBoundsExceeded,138 /// Tried to enable permissions which are only permitted to be disabled139 OwnerPermissionsCantBeReverted,140 /// Schema data size limit bound exceeded141 SchemaDataLimitExceeded,142 /// Maximum refungibility exceeded143 WrongRefungiblePieces,144 /// createRefungible should be called with one owner145 BadCreateRefungibleCall,146 /// Gas limit exceeded147 OutOfGas,148 /// Metadata update denied by collection settings149 MetadataUpdateDenied,150 /// Metadata update flag become unmutable with None option151 MetadataFlagFrozen,152 /// Collection settings not allowing items transferring153 TransferNotAllowed,154 /// Can't transfer tokens to ethereum zero address155 AddressIsZero,156 }157}158159#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]160pub struct CollectionHandle<T: Config> {161 pub id: CollectionId,162 collection: Collection<T>,163 recorder: pallet_evm_coder_substrate::SubstrateRecorder<T>,164}165impl<T: Config> CollectionHandle<T> {166 pub fn get_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {167 <CollectionById<T>>::get(id).map(|collection| Self {168 id,169 collection,170 recorder: pallet_evm_coder_substrate::SubstrateRecorder::new(171 eth::collection_id_to_address(id),172 gas_limit,173 ),174 })175 }176 pub fn get(id: CollectionId) -> Option<Self> {177 Self::get_with_gas_limit(id, u64::MAX)178 }179 pub fn log(&self, log: impl evm_coder::ToLog) -> DispatchResult {180 self.recorder.log_sub(log)181 }182 #[allow(dead_code)]183 fn consume_gas(&self, gas: u64) -> DispatchResult {184 self.recorder.consume_gas_sub(gas)185 }186 fn consume_sload(&self) -> DispatchResult {187 self.recorder.consume_sload_sub()188 }189 fn consume_sstore(&self) -> DispatchResult {190 self.recorder.consume_sstore_sub()191 }192 pub fn submit_logs(self) -> DispatchResult {193 self.recorder.submit_logs()194 }195 pub fn save(self) -> DispatchResult {196 self.recorder.submit_logs()?;197 <CollectionById<T>>::insert(self.id, self.collection);198 Ok(())199 }200}201impl<T: Config> Deref for CollectionHandle<T> {202 type Target = Collection<T>;203204 fn deref(&self) -> &Self::Target {205 &self.collection206 }207}208209impl<T: Config> DerefMut for CollectionHandle<T> {210 fn deref_mut(&mut self) -> &mut Self::Target {211 &mut self.collection212 }213}214215pub trait Config: system::Config + pallet_evm_coder_substrate::Config + Sized {216 type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;217218 /// Weight information for extrinsics in this pallet.219 type WeightInfo: WeightInfo;220221 type EvmAddressMapping: pallet_evm::AddressMapping<Self::AccountId>;222 type EvmBackwardsAddressMapping: EvmBackwardsAddressMapping<Self::AccountId>;223224 type CrossAccountId: CrossAccountId<Self::AccountId>;225 type Currency: Currency<Self::AccountId>;226 type CollectionCreationPrice: Get<227 <<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,228 >;229 type TreasuryAccountId: Get<Self::AccountId>;230}231232type SelfWeightOf<T> = <T as Config>::WeightInfo;233234trait WeightInfoHelpers: WeightInfo {235 fn transfer() -> Weight {236 Self::transfer_nft()237 .max(Self::transfer_fungible())238 .max(Self::transfer_refungible())239 }240 fn transfer_from() -> Weight {241 Self::transfer_from_nft()242 .max(Self::transfer_from_fungible())243 .max(Self::transfer_from_refungible())244 }245 fn approve() -> Weight {246 // TODO: refungible, fungible247 Self::approve_nft()248 }249 fn set_variable_meta_data(data: u32) -> Weight {250 // TODO: refungible251 Self::set_variable_meta_data_nft(data)252 }253 fn create_item(data: u32) -> Weight {254 Self::create_item_nft(data)255 .max(Self::create_item_fungible())256 .max(Self::create_item_refungible(data))257 }258 fn create_multiple_items(amount: u32) -> Weight {259 Self::create_multiple_items_nft(amount)260 .max(Self::create_multiple_items_fungible(amount))261 .max(Self::create_multiple_items_refungible(amount))262 }263 fn burn_item() -> Weight {264 // TODO: refungible, fungible265 Self::burn_item_nft()266 }267}268impl<T: WeightInfo> WeightInfoHelpers for T {}269270// # Used definitions271//272// ## User control levels273//274// chain-controlled - key is uncontrolled by user275// i.e autoincrementing index276// can use non-cryptographic hash277// real - key is controlled by user278// but it is hard to generate enough colliding values, i.e owner of signed txs279// can use non-cryptographic hash280// controlled - key is completly controlled by users281// i.e maps with mutable keys282// should use cryptographic hash283//284// ## User control level downgrade reasons285//286// ?1 - chain-controlled -> controlled287// collections/tokens can be destroyed, resulting in massive holes288// ?2 - chain-controlled -> controlled289// same as ?1, but can be only added, resulting in easier exploitation290// ?3 - real -> controlled291// no confirmation required, so addresses can be easily generated292decl_storage! {293 trait Store for Module<T: Config> as Nft {294295 //#region Private members296 /// Id of next collection297 CreatedCollectionCount: u32;298 /// Used for migrations299 ChainVersion: u64;300 /// Id of last collection token301 /// Collection id (controlled?1)302 ItemListIndex: map hasher(blake2_128_concat) CollectionId => TokenId;303 //#endregion304305 //#region Bound counters306 /// Amount of collections destroyed, used for total amount tracking with307 /// CreatedCollectionCount308 DestroyedCollectionCount: u32;309 /// Total amount of account owned tokens (NFTs + RFTs + unique fungibles)310 /// Account id (real)311 pub AccountItemCount get(fn account_item_count): map hasher(twox_64_concat) T::AccountId => u32;312 //#endregion313314 //#region Basic collections315 /// Collection info316 /// Collection id (controlled?1)317 pub CollectionById get(fn collection_id) config(): map hasher(blake2_128_concat) CollectionId => Option<Collection<T>> = None;318 /// List of collection admins319 /// Collection id (controlled?2)320 pub AdminList get(fn admin_list_collection): map hasher(blake2_128_concat) CollectionId => Vec<T::CrossAccountId>;321 /// Whitelisted collection users322 /// Collection id (controlled?2), user id (controlled?3)323 pub WhiteList get(fn white_list): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) T::AccountId => bool;324 //#endregion325326 /// How many of collection items user have327 /// Collection id (controlled?2), account id (real)328 pub Balance get(fn balance_count): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => u128;329330 /// Amount of items which spender can transfer out of owners account (via transferFrom)331 /// Collection id (controlled?2), (token id (controlled ?2) + owner account id (real) + spender account id (controlled?3))332 /// TODO: Off chain worker should remove from this map when token gets removed333 pub Allowances get(fn approved): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) (TokenId, T::AccountId, T::AccountId) => u128;334335 //#region Item collections336 /// Collection id (controlled?2), token id (controlled?1)337 pub NftItemList get(fn nft_item_id) config(): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<NftItemType<T::CrossAccountId>>;338 /// Collection id (controlled?2), owner (controlled?2)339 pub FungibleItemList get(fn fungible_item_id) config(): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) T::AccountId => FungibleItemType;340 /// Collection id (controlled?2), token id (controlled?1)341 pub ReFungibleItemList get(fn refungible_item_id) config(): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<ReFungibleItemType<T::CrossAccountId>>;342 //#endregion343344 //#region Index list345 /// Collection id (controlled?2), tokens owner (controlled?2)346 pub AddressTokens get(fn address_tokens): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) T::AccountId => Vec<TokenId>;347 //#endregion348349 //#region Tokens transfer rate limit baskets350 /// (Collection id (controlled?2), who created (real))351 /// TODO: Off chain worker should remove from this map when collection gets removed352 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => T::BlockNumber;353 /// Collection id (controlled?2), token id (controlled?2)354 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;355 /// Collection id (controlled?2), owning user (real)356 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => T::BlockNumber;357 /// Collection id (controlled?2), token id (controlled?2)358 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;359 //#endregion360361 /// Variable metadata sponsoring362 /// Collection id (controlled?2), token id (controlled?2)363 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber> = None;364 }365 add_extra_genesis {366 build(|config: &GenesisConfig<T>| {367 // Modification of storage368 for (_num, _c) in &config.collection_id {369 <Module<T>>::init_collection(_c);370 }371372 for (_num, _c, _i) in &config.nft_item_id {373 <Module<T>>::init_nft_token(*_c, _i);374 }375376 for (collection_id, account_id, fungible_item) in &config.fungible_item_id {377 <Module<T>>::init_fungible_token(*collection_id, &T::CrossAccountId::from_sub(account_id.clone()), fungible_item);378 }379380 for (_num, _c, _i) in &config.refungible_item_id {381 <Module<T>>::init_refungible_token(*_c, _i);382 }383 })384 }385}386387decl_event!(388 pub enum Event<T>389 where390 AccountId = <T as frame_system::Config>::AccountId,391 CrossAccountId = <T as Config>::CrossAccountId,392 {393 /// New collection was created394 ///395 /// # Arguments396 ///397 /// * collection_id: Globally unique identifier of newly created collection.398 ///399 /// * mode: [CollectionMode] converted into u8.400 ///401 /// * account_id: Collection owner.402 CollectionCreated(CollectionId, u8, AccountId),403404 /// New item was created.405 ///406 /// # Arguments407 ///408 /// * collection_id: Id of the collection where item was created.409 ///410 /// * item_id: Id of an item. Unique within the collection.411 ///412 /// * recipient: Owner of newly created item413 ItemCreated(CollectionId, TokenId, CrossAccountId),414415 /// Collection item was burned.416 ///417 /// # Arguments418 ///419 /// collection_id.420 ///421 /// item_id: Identifier of burned NFT.422 ItemDestroyed(CollectionId, TokenId),423424 /// Item was transferred425 ///426 /// * collection_id: Id of collection to which item is belong427 ///428 /// * item_id: Id of an item429 ///430 /// * sender: Original owner of item431 ///432 /// * recipient: New owner of item433 ///434 /// * amount: Always 1 for NFT435 Transfer(CollectionId, TokenId, CrossAccountId, CrossAccountId, u128),436437 /// * collection_id438 ///439 /// * item_id440 ///441 /// * sender442 ///443 /// * spender444 ///445 /// * amount446 Approved(CollectionId, TokenId, CrossAccountId, CrossAccountId, u128),447 }448);449450decl_module! {451 pub struct Module<T: Config> for enum Call452 where453 origin: T::Origin454 {455 fn deposit_event() = default;456 const CollectionAdminsLimit: u64 = COLLECTION_ADMINS_LIMIT;457 type Error = Error<T>;458459 fn on_initialize(_now: T::BlockNumber) -> Weight {460 0461 }462463 /// This method creates a Collection of NFTs. Each Token may have multiple properties encoded as an array of bytes of certain length. The initial owner and admin of the collection are set to the address that signed the transaction. Both addresses can be changed later.464 ///465 /// # Permissions466 ///467 /// * Anyone.468 ///469 /// # Arguments470 ///471 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.472 ///473 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.474 ///475 /// * token_prefix: UTF-8 string with token prefix.476 ///477 /// * mode: [CollectionMode] collection type and type dependent data.478 // returns collection ID479 #[weight = <SelfWeightOf<T>>::create_collection()]480 #[transactional]481 pub fn create_collection(origin,482 collection_name: Vec<u16>,483 collection_description: Vec<u16>,484 token_prefix: Vec<u8>,485 mode: CollectionMode) -> DispatchResult {486487 // Anyone can create a collection488 let who = ensure_signed(origin)?;489490 // Take a (non-refundable) deposit of collection creation491 let mut imbalance = <<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();492 imbalance.subsume(<<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(493 &T::TreasuryAccountId::get(),494 T::CollectionCreationPrice::get(),495 ));496 <T as Config>::Currency::settle(497 &who,498 imbalance,499 WithdrawReasons::TRANSFER,500 ExistenceRequirement::KeepAlive,501 ).map_err(|_| Error::<T>::NoPermission)?;502503 let decimal_points = match mode {504 CollectionMode::Fungible(points) => points,505 _ => 0506 };507508 let created_count = CreatedCollectionCount::get();509 let destroyed_count = DestroyedCollectionCount::get();510511 // bound Total number of collections512 ensure!(created_count - destroyed_count < COLLECTION_NUMBER_LIMIT, Error::<T>::TotalCollectionsLimitExceeded);513514 // check params515 ensure!(decimal_points <= MAX_DECIMAL_POINTS, Error::<T>::CollectionDecimalPointLimitExceeded);516 ensure!(collection_name.len() <= MAX_COLLECTION_NAME_LENGTH, Error::<T>::CollectionNameLimitExceeded);517 ensure!(collection_description.len() <= MAX_COLLECTION_DESCRIPTION_LENGTH, Error::<T>::CollectionDescriptionLimitExceeded);518 ensure!(token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH, Error::<T>::CollectionTokenPrefixLimitExceeded);519520 // Generate next collection ID521 let next_id = created_count522 .checked_add(1)523 .ok_or(Error::<T>::NumOverflow)?;524525 CreatedCollectionCount::put(next_id);526527 let limits = CollectionLimits {528 sponsored_data_size: CUSTOM_DATA_LIMIT,529 ..Default::default()530 };531532 // Create new collection533 let new_collection = Collection {534 owner: who.clone(),535 name: collection_name,536 mode: mode.clone(),537 mint_mode: false,538 access: AccessMode::Normal,539 description: collection_description,540 decimal_points,541 token_prefix,542 offchain_schema: Vec::new(),543 schema_version: SchemaVersion::ImageURL,544 sponsorship: SponsorshipState::Disabled,545 variable_on_chain_schema: Vec::new(),546 const_on_chain_schema: Vec::new(),547 limits,548 meta_update_permission: MetaUpdatePermission::default(),549 transfers_enabled: true,550 };551552 // Add new collection to map553 <CollectionById<T>>::insert(next_id, new_collection);554555 // call event556 Self::deposit_event(RawEvent::CollectionCreated(next_id, mode.id(), who));557558 Ok(())559 }560561 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.562 ///563 /// # Permissions564 ///565 /// * Collection Owner.566 ///567 /// # Arguments568 ///569 /// * collection_id: collection to destroy.570 #[weight = <SelfWeightOf<T>>::destroy_collection()]571 #[transactional]572 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {573574 let sender = ensure_signed(origin)?;575 let collection = Self::get_collection(collection_id)?;576 Self::check_owner_permissions(&collection, &sender)?;577 if !collection.limits.owner_can_destroy {578 fail!(Error::<T>::NoPermission);579 }580581 <AddressTokens<T>>::remove_prefix(collection_id, None);582 <Allowances<T>>::remove_prefix(collection_id, None);583 <Balance<T>>::remove_prefix(collection_id, None);584 <ItemListIndex>::remove(collection_id);585 <AdminList<T>>::remove(collection_id);586 <CollectionById<T>>::remove(collection_id);587 <WhiteList<T>>::remove_prefix(collection_id, None);588589 <NftItemList<T>>::remove_prefix(collection_id, None);590 <FungibleItemList<T>>::remove_prefix(collection_id, None);591 <ReFungibleItemList<T>>::remove_prefix(collection_id, None);592593 <NftTransferBasket<T>>::remove_prefix(collection_id, None);594 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);595 <ReFungibleTransferBasket<T>>::remove_prefix(collection_id, None);596597 <VariableMetaDataBasket<T>>::remove_prefix(collection_id, None);598599 DestroyedCollectionCount::put(DestroyedCollectionCount::get()600 .checked_add(1)601 .ok_or(Error::<T>::NumOverflow)?);602603 Ok(())604 }605606 /// Add an address to white list.607 ///608 /// # Permissions609 ///610 /// * Collection Owner611 /// * Collection Admin612 ///613 /// # Arguments614 ///615 /// * collection_id.616 ///617 /// * address.618 #[weight = <SelfWeightOf<T>>::add_to_white_list()]619 #[transactional]620 pub fn add_to_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{621622 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);623 let collection = Self::get_collection(collection_id)?;624625 Self::toggle_white_list_internal(626 &sender,627 &collection,628 &address,629 true,630 )?;631632 Ok(())633 }634635 /// Remove an address from white list.636 ///637 /// # Permissions638 ///639 /// * Collection Owner640 /// * Collection Admin641 ///642 /// # Arguments643 ///644 /// * collection_id.645 ///646 /// * address.647 #[weight = <SelfWeightOf<T>>::remove_from_white_list()]648 #[transactional]649 pub fn remove_from_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{650651 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);652 let collection = Self::get_collection(collection_id)?;653654 Self::toggle_white_list_internal(655 &sender,656 &collection,657 &address,658 false,659 )?;660661 Ok(())662 }663664 /// Toggle between normal and white list access for the methods with access for `Anyone`.665 ///666 /// # Permissions667 ///668 /// * Collection Owner.669 ///670 /// # Arguments671 ///672 /// * collection_id.673 ///674 /// * mode: [AccessMode]675 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]676 #[transactional]677 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult678 {679 let sender = ensure_signed(origin)?;680681 let mut target_collection = Self::get_collection(collection_id)?;682 Self::check_owner_permissions(&target_collection, &sender)?;683 target_collection.access = mode;684 target_collection.save()685 }686687 /// Allows Anyone to create tokens if:688 /// * White List is enabled, and689 /// * Address is added to white list, and690 /// * This method was called with True parameter691 ///692 /// # Permissions693 /// * Collection Owner694 ///695 /// # Arguments696 ///697 /// * collection_id.698 ///699 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.700 #[weight = <SelfWeightOf<T>>::set_mint_permission()]701 #[transactional]702 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult703 {704 let sender = ensure_signed(origin)?;705706 let mut target_collection = Self::get_collection(collection_id)?;707 Self::check_owner_permissions(&target_collection, &sender)?;708 target_collection.mint_mode = mint_permission;709 target_collection.save()710 }711712 /// Change the owner of the collection.713 ///714 /// # Permissions715 ///716 /// * Collection Owner.717 ///718 /// # Arguments719 ///720 /// * collection_id.721 ///722 /// * new_owner.723 #[weight = <SelfWeightOf<T>>::change_collection_owner()]724 #[transactional]725 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {726727 let sender = ensure_signed(origin)?;728 let mut target_collection = Self::get_collection(collection_id)?;729 Self::check_owner_permissions(&target_collection, &sender)?;730 target_collection.owner = new_owner;731 target_collection.save()732 }733734 /// Adds an admin of the Collection.735 /// NFT Collection can be controlled by multiple admin addresses (some which can also be servers, for example). Admins can issue and burn NFTs, as well as add and remove other admins, but cannot change NFT or Collection ownership.736 ///737 /// # Permissions738 ///739 /// * Collection Owner.740 /// * Collection Admin.741 ///742 /// # Arguments743 ///744 /// * collection_id: ID of the Collection to add admin for.745 ///746 /// * new_admin_id: Address of new admin to add.747 #[weight = <SelfWeightOf<T>>::add_collection_admin()]748 #[transactional]749 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {750 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);751 let collection = Self::get_collection(collection_id)?;752 Self::check_owner_or_admin_permissions(&collection, &sender)?;753 let mut admin_arr = <AdminList<T>>::get(collection_id);754755 match admin_arr.binary_search(&new_admin_id) {756 Ok(_) => {},757 Err(idx) => {758 ensure!(admin_arr.len() < COLLECTION_ADMINS_LIMIT as usize, Error::<T>::CollectionAdminsLimitExceeded);759 admin_arr.insert(idx, new_admin_id);760 <AdminList<T>>::insert(collection_id, admin_arr);761 }762 }763 Ok(())764 }765766 /// Remove admin address of the Collection. An admin address can remove itself. List of admins may become empty, in which case only Collection Owner will be able to add an Admin.767 ///768 /// # Permissions769 ///770 /// * Collection Owner.771 /// * Collection Admin.772 ///773 /// # Arguments774 ///775 /// * collection_id: ID of the Collection to remove admin for.776 ///777 /// * account_id: Address of admin to remove.778 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]779 #[transactional]780 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {781 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);782 let collection = Self::get_collection(collection_id)?;783 Self::check_owner_or_admin_permissions(&collection, &sender)?;784 let mut admin_arr = <AdminList<T>>::get(collection_id);785786 if let Ok(idx) = admin_arr.binary_search(&account_id) {787 admin_arr.remove(idx);788 <AdminList<T>>::insert(collection_id, admin_arr);789 }790 Ok(())791 }792793 /// # Permissions794 ///795 /// * Collection Owner796 ///797 /// # Arguments798 ///799 /// * collection_id.800 ///801 /// * new_sponsor.802 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]803 #[transactional]804 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {805 let sender = ensure_signed(origin)?;806 let mut target_collection = Self::get_collection(collection_id)?;807 Self::check_owner_permissions(&target_collection, &sender)?;808809 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor);810 target_collection.save()811 }812813 /// # Permissions814 ///815 /// * Sponsor.816 ///817 /// # Arguments818 ///819 /// * collection_id.820 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]821 #[transactional]822 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {823 let sender = ensure_signed(origin)?;824825 let mut target_collection = Self::get_collection(collection_id)?;826 ensure!(827 target_collection.sponsorship.pending_sponsor() == Some(&sender),828 Error::<T>::ConfirmUnsetSponsorFail829 );830831 target_collection.sponsorship = SponsorshipState::Confirmed(sender);832 target_collection.save()833 }834835 /// Switch back to pay-per-own-transaction model.836 ///837 /// # Permissions838 ///839 /// * Collection owner.840 ///841 /// # Arguments842 ///843 /// * collection_id.844 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]845 #[transactional]846 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {847 let sender = ensure_signed(origin)?;848849 let mut target_collection = Self::get_collection(collection_id)?;850 Self::check_owner_permissions(&target_collection, &sender)?;851852 target_collection.sponsorship = SponsorshipState::Disabled;853 target_collection.save()854 }855856 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.857 ///858 /// # Permissions859 ///860 /// * Collection Owner.861 /// * Collection Admin.862 /// * Anyone if863 /// * White List is enabled, and864 /// * Address is added to white list, and865 /// * MintPermission is enabled (see SetMintPermission method)866 ///867 /// # Arguments868 ///869 /// * collection_id: ID of the collection.870 ///871 /// * owner: Address, initial owner of the NFT.872 ///873 /// * data: Token data to store on chain.874 // #[weight =875 // (130_000_000 as Weight)876 // .saturating_add((2135 as Weight).saturating_mul((properties.len() as u64) as Weight))877 // .saturating_add(RocksDbWeight::get().reads(10 as Weight))878 // .saturating_add(RocksDbWeight::get().writes(8 as Weight))]879880 #[weight = <SelfWeightOf<T>>::create_item(data.data_size() as u32)]881 #[transactional]882 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResult {883 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);884 let collection = Self::get_collection(collection_id)?;885886 Self::create_item_internal(&sender, &collection, &owner, data)?;887888 collection.submit_logs()889 }890891 /// This method creates multiple items in a collection created with CreateCollection method.892 ///893 /// # Permissions894 ///895 /// * Collection Owner.896 /// * Collection Admin.897 /// * Anyone if898 /// * White List is enabled, and899 /// * Address is added to white list, and900 /// * MintPermission is enabled (see SetMintPermission method)901 ///902 /// # Arguments903 ///904 /// * collection_id: ID of the collection.905 ///906 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].907 ///908 /// * owner: Address, initial owner of the NFT.909 #[weight = <SelfWeightOf<T>>::create_multiple_items(items_data.len() as u32)]910 #[transactional]911 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResult {912913 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);914 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);915 let collection = Self::get_collection(collection_id)?;916917 Self::create_multiple_items_internal(&sender, &collection, &owner, items_data)?;918919 collection.submit_logs()920 }921922 // TODO! transaction weight923924 /// Set transfers_enabled value for particular collection925 ///926 /// # Permissions927 ///928 /// * Collection Owner.929 ///930 /// # Arguments931 ///932 /// * collection_id: ID of the collection.933 ///934 /// * value: New flag value.935 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]936 #[transactional]937 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {938939 let sender = ensure_signed(origin)?;940 let mut target_collection = Self::get_collection(collection_id)?;941942 Self::check_owner_permissions(&target_collection, &sender)?;943944 target_collection.transfers_enabled = value;945 target_collection.save()946 }947948 // TODO! transaction weight949 /// Set meta_update_permission value for particular collection950 ///951 /// # Permissions952 ///953 /// * Collection Owner.954 ///955 /// # Arguments956 ///957 /// * collection_id: ID of the collection.958 ///959 /// * value: New flag value.960 #[weight = <T as Config>::WeightInfo::burn_item()]961 #[transactional]962 pub fn set_meta_update_permission_flag(origin, collection_id: CollectionId, value: MetaUpdatePermission) -> DispatchResult {963964 let sender = ensure_signed(origin)?;965 let mut target_collection = Self::get_collection(collection_id)?;966967 ensure!(968 target_collection.meta_update_permission != MetaUpdatePermission::None,969 Error::<T>::MetadataFlagFrozen970 );971 Self::check_owner_permissions(&target_collection, &sender)?;972973 target_collection.meta_update_permission = value;974975 target_collection.save()976 }977978 /// Destroys a concrete instance of NFT.979 ///980 /// # Permissions981 ///982 /// * Collection Owner.983 /// * Collection Admin.984 /// * Current NFT Owner.985 ///986 /// # Arguments987 ///988 /// * collection_id: ID of the collection.989 ///990 /// * item_id: ID of NFT to burn.991 #[weight = <SelfWeightOf<T>>::burn_item()]992 #[transactional]993 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResult {994995 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);996 let target_collection = Self::get_collection(collection_id)?;997998 Self::burn_item_internal(&sender, &target_collection, item_id, value)?;9991000 target_collection.submit_logs()1001 }10021003 /// Change ownership of the token.1004 ///1005 /// # Permissions1006 ///1007 /// * Collection Owner1008 /// * Collection Admin1009 /// * Current NFT owner1010 ///1011 /// # Arguments1012 ///1013 /// * recipient: Address of token recipient.1014 ///1015 /// * collection_id.1016 ///1017 /// * item_id: ID of the item1018 /// * Non-Fungible Mode: Required.1019 /// * Fungible Mode: Ignored.1020 /// * Re-Fungible Mode: Required.1021 ///1022 /// * value: Amount to transfer.1023 /// * Non-Fungible Mode: Ignored1024 /// * Fungible Mode: Must specify transferred amount1025 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)1026 #[weight = <SelfWeightOf<T>>::transfer()]1027 #[transactional]1028 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResult {1029 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1030 let collection = Self::get_collection(collection_id)?;10311032 Self::transfer_internal(&sender, &recipient, &collection, item_id, value)?;10331034 collection.submit_logs()1035 }10361037 /// Set, change, or remove approved address to transfer the ownership of the NFT.1038 ///1039 /// # Permissions1040 ///1041 /// * Collection Owner1042 /// * Collection Admin1043 /// * Current NFT owner1044 ///1045 /// # Arguments1046 ///1047 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).1048 ///1049 /// * collection_id.1050 ///1051 /// * item_id: ID of the item.1052 #[weight = <SelfWeightOf<T>>::approve()]1053 #[transactional]1054 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResult {1055 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1056 let collection = Self::get_collection(collection_id)?;10571058 Self::approve_internal(&sender, &spender, &collection, item_id, amount)?;10591060 collection.submit_logs()1061 }10621063 /// Change ownership of a NFT on behalf of the owner. See Approve method for additional information. After this method executes, the approval is removed so that the approved address will not be able to transfer this NFT again from this owner.1064 ///1065 /// # Permissions1066 /// * Collection Owner1067 /// * Collection Admin1068 /// * Current NFT owner1069 /// * Address approved by current NFT owner1070 ///1071 /// # Arguments1072 ///1073 /// * from: Address that owns token.1074 ///1075 /// * recipient: Address of token recipient.1076 ///1077 /// * collection_id.1078 ///1079 /// * item_id: ID of the item.1080 ///1081 /// * value: Amount to transfer.1082 #[weight = <SelfWeightOf<T>>::transfer_from()]1083 #[transactional]1084 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResult {1085 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1086 let collection = Self::get_collection(collection_id)?;10871088 Self::transfer_from_internal(&sender, &from, &recipient, &collection, item_id, value)?;10891090 collection.submit_logs()1091 }1092 // #[weight = 0]1093 // // let no_perm_mes = "You do not have permissions to modify this collection";1094 // // ensure!(<ApprovedList<T>>::contains_key((collection_id, item_id)), no_perm_mes);1095 // // let list_itm = <ApprovedList<T>>::get((collection_id, item_id));1096 // // ensure!(list_itm.contains(&new_owner.clone()), no_perm_mes);10971098 // // // on_nft_received call10991100 // // Self::transfer(origin, collection_id, item_id, new_owner)?;11011102 // Ok(())1103 // }11041105 /// Set off-chain data schema.1106 ///1107 /// # Permissions1108 ///1109 /// * Collection Owner1110 /// * Collection Admin1111 ///1112 /// # Arguments1113 ///1114 /// * collection_id.1115 ///1116 /// * schema: String representing the offchain data schema.1117 #[weight = <SelfWeightOf<T>>::set_variable_meta_data(data.len() as u32)]1118 #[transactional]1119 pub fn set_variable_meta_data (1120 origin,1121 collection_id: CollectionId,1122 item_id: TokenId,1123 data: Vec<u8>1124 ) -> DispatchResult {1125 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);11261127 let collection = Self::get_collection(collection_id)?;11281129 Self::set_variable_meta_data_internal(&sender, &collection, item_id, data)?;11301131 Ok(())1132 }11331134 /// Set schema standard1135 /// ImageURL1136 /// Unique1137 ///1138 /// # Permissions1139 ///1140 /// * Collection Owner1141 /// * Collection Admin1142 ///1143 /// # Arguments1144 ///1145 /// * collection_id.1146 ///1147 /// * schema: SchemaVersion: enum1148 #[weight = <SelfWeightOf<T>>::set_schema_version()]1149 #[transactional]1150 pub fn set_schema_version(1151 origin,1152 collection_id: CollectionId,1153 version: SchemaVersion1154 ) -> DispatchResult {1155 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1156 let mut target_collection = Self::get_collection(collection_id)?;1157 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;1158 target_collection.schema_version = version;1159 target_collection.save()1160 }11611162 /// Set off-chain data schema.1163 ///1164 /// # Permissions1165 ///1166 /// * Collection Owner1167 /// * Collection Admin1168 ///1169 /// # Arguments1170 ///1171 /// * collection_id.1172 ///1173 /// * schema: String representing the offchain data schema.1174 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]1175 #[transactional]1176 pub fn set_offchain_schema(1177 origin,1178 collection_id: CollectionId,1179 schema: Vec<u8>1180 ) -> DispatchResult {1181 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1182 let mut target_collection = Self::get_collection(collection_id)?;1183 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;11841185 // check schema limit1186 ensure!(schema.len() as u32 <= OFFCHAIN_SCHEMA_LIMIT, "");11871188 target_collection.offchain_schema = schema;1189 target_collection.save()1190 }11911192 /// Set const on-chain data schema.1193 ///1194 /// # Permissions1195 ///1196 /// * Collection Owner1197 /// * Collection Admin1198 ///1199 /// # Arguments1200 ///1201 /// * collection_id.1202 ///1203 /// * schema: String representing the const on-chain data schema.1204 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1205 #[transactional]1206 pub fn set_const_on_chain_schema (1207 origin,1208 collection_id: CollectionId,1209 schema: Vec<u8>1210 ) -> DispatchResult {1211 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1212 let mut target_collection = Self::get_collection(collection_id)?;1213 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;12141215 // check schema limit1216 ensure!(schema.len() as u32 <= CONST_ON_CHAIN_SCHEMA_LIMIT, "");12171218 target_collection.const_on_chain_schema = schema;1219 target_collection.save()1220 }12211222 /// Set variable on-chain data schema.1223 ///1224 /// # Permissions1225 ///1226 /// * Collection Owner1227 /// * Collection Admin1228 ///1229 /// # Arguments1230 ///1231 /// * collection_id.1232 ///1233 /// * schema: String representing the variable on-chain data schema.1234 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1235 #[transactional]1236 pub fn set_variable_on_chain_schema (1237 origin,1238 collection_id: CollectionId,1239 schema: Vec<u8>1240 ) -> DispatchResult {1241 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1242 let mut target_collection = Self::get_collection(collection_id)?;1243 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;12441245 // check schema limit1246 ensure!(schema.len() as u32 <= VARIABLE_ON_CHAIN_SCHEMA_LIMIT, "");12471248 target_collection.variable_on_chain_schema = schema;1249 target_collection.save()1250 }12511252 #[weight = <SelfWeightOf<T>>::set_collection_limits()]1253 #[transactional]1254 pub fn set_collection_limits(1255 origin,1256 collection_id: u32,1257 new_limits: CollectionLimits<T::BlockNumber>,1258 ) -> DispatchResult {1259 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1260 let mut target_collection = Self::get_collection(collection_id)?;1261 Self::check_owner_permissions(&target_collection, sender.as_sub())?;1262 let old_limits = &target_collection.limits;12631264 // collection bounds1265 ensure!(new_limits.sponsor_transfer_timeout <= MAX_SPONSOR_TIMEOUT &&1266 new_limits.account_token_ownership_limit <= MAX_TOKEN_OWNERSHIP &&1267 new_limits.sponsored_data_size <= CUSTOM_DATA_LIMIT,1268 Error::<T>::CollectionLimitBoundsExceeded);12691270 // token_limit check prev1271 ensure!(old_limits.token_limit >= new_limits.token_limit, Error::<T>::CollectionTokenLimitExceeded);1272 ensure!(new_limits.token_limit > 0, Error::<T>::CollectionTokenLimitExceeded);12731274 ensure!(1275 (old_limits.owner_can_transfer || !new_limits.owner_can_transfer) &&1276 (old_limits.owner_can_destroy || !new_limits.owner_can_destroy),1277 Error::<T>::OwnerPermissionsCantBeReverted,1278 );12791280 target_collection.limits = new_limits;12811282 target_collection.save()1283 }1284 }1285}12861287impl<T: Config> Module<T> {1288 pub fn create_item_internal(1289 sender: &T::CrossAccountId,1290 collection: &CollectionHandle<T>,1291 owner: &T::CrossAccountId,1292 data: CreateItemData,1293 ) -> DispatchResult {1294 ensure!(1295 owner != &T::CrossAccountId::from_eth(H160([0; 20])),1296 Error::<T>::AddressIsZero1297 );12981299 Self::can_create_items_in_collection(collection, sender, owner, 1)?;1300 Self::validate_create_item_args(collection, &data)?;1301 Self::create_item_no_validation(collection, owner, data)?;13021303 Ok(())1304 }13051306 pub fn transfer_internal(1307 sender: &T::CrossAccountId,1308 recipient: &T::CrossAccountId,1309 target_collection: &CollectionHandle<T>,1310 item_id: TokenId,1311 value: u128,1312 ) -> DispatchResult {1313 ensure!(1314 recipient != &T::CrossAccountId::from_eth(H160([0; 20])),1315 Error::<T>::AddressIsZero1316 );13171318 // Limits check1319 Self::is_correct_transfer(target_collection, recipient)?;13201321 // Transfer permissions check1322 ensure!(1323 Self::is_item_owner(sender, target_collection, item_id)?1324 || Self::is_owner_or_admin_permissions(target_collection, sender)?,1325 Error::<T>::NoPermission1326 );13271328 if target_collection.access == AccessMode::WhiteList {1329 Self::check_white_list(target_collection, sender)?;1330 Self::check_white_list(target_collection, recipient)?;1331 }13321333 match target_collection.mode {1334 CollectionMode::NFT => Self::transfer_nft(1335 target_collection,1336 item_id,1337 sender.clone(),1338 recipient.clone(),1339 )?,1340 CollectionMode::Fungible(_) => {1341 Self::transfer_fungible(target_collection, value, sender, recipient)?1342 }1343 CollectionMode::ReFungible => Self::transfer_refungible(1344 target_collection,1345 item_id,1346 value,1347 sender.clone(),1348 recipient.clone(),1349 )?,1350 };13511352 Self::deposit_event(RawEvent::Transfer(1353 target_collection.id,1354 item_id,1355 sender.clone(),1356 recipient.clone(),1357 value,1358 ));13591360 Ok(())1361 }13621363 pub fn approve_internal(1364 sender: &T::CrossAccountId,1365 spender: &T::CrossAccountId,1366 collection: &CollectionHandle<T>,1367 item_id: TokenId,1368 amount: u128,1369 ) -> DispatchResult {1370 Self::token_exists(collection, item_id)?;13711372 // Transfer permissions check1373 let bypasses_limits = collection.limits.owner_can_transfer1374 && Self::is_owner_or_admin_permissions(collection, sender)?;13751376 let allowance_limit = if bypasses_limits {1377 None1378 } else if let Some(amount) = Self::owned_amount(sender, collection, item_id)? {1379 Some(amount)1380 } else {1381 fail!(Error::<T>::NoPermission);1382 };13831384 if collection.access == AccessMode::WhiteList {1385 Self::check_white_list(collection, sender)?;1386 Self::check_white_list(collection, spender)?;1387 }13881389 collection.consume_sload()?;1390 let allowance: u128 = amount1391 .checked_add(<Allowances<T>>::get(1392 collection.id,1393 (item_id, sender.as_sub(), spender.as_sub()),1394 ))1395 .ok_or(Error::<T>::NumOverflow)?;1396 if let Some(limit) = allowance_limit {1397 ensure!(limit >= allowance, Error::<T>::TokenValueTooLow);1398 }1399 collection.consume_sstore()?;1400 <Allowances<T>>::insert(1401 collection.id,1402 (item_id, sender.as_sub(), spender.as_sub()),1403 allowance,1404 );14051406 if matches!(collection.mode, CollectionMode::NFT) {1407 // TODO: NFT: only one owner may exist for token in ERC7211408 collection.log(ERC721Events::Approval {1409 owner: *sender.as_eth(),1410 approved: *spender.as_eth(),1411 token_id: item_id.into(),1412 })?;1413 }14141415 if matches!(collection.mode, CollectionMode::Fungible(_)) {1416 // TODO: NFT: only one owner may exist for token in ERC201417 collection.log(ERC20Events::Approval {1418 owner: *sender.as_eth(),1419 spender: *spender.as_eth(),1420 value: allowance.into(),1421 })?;1422 }14231424 Self::deposit_event(RawEvent::Approved(1425 collection.id,1426 item_id,1427 sender.clone(),1428 spender.clone(),1429 allowance,1430 ));1431 Ok(())1432 }14331434 pub fn transfer_from_internal(1435 sender: &T::CrossAccountId,1436 from: &T::CrossAccountId,1437 recipient: &T::CrossAccountId,1438 collection: &CollectionHandle<T>,1439 item_id: TokenId,1440 amount: u128,1441 ) -> DispatchResult {1442 if sender == from {1443 // Transfer by `from`, because it is either equal to sender, or derived from him1444 return Self::transfer_internal(from, recipient, collection, item_id, amount);1445 }14461447 // Check approval1448 collection.consume_sload()?;1449 let approval: u128 =1450 <Allowances<T>>::get(collection.id, (item_id, from.as_sub(), sender.as_sub()));14511452 // Limits check1453 Self::is_correct_transfer(collection, recipient)?;14541455 // Transfer permissions check1456 ensure!(1457 approval >= amount1458 || (collection.limits.owner_can_transfer1459 && Self::is_owner_or_admin_permissions(collection, sender)?),1460 Error::<T>::NoPermission1461 );14621463 if collection.access == AccessMode::WhiteList {1464 Self::check_white_list(collection, sender)?;1465 Self::check_white_list(collection, recipient)?;1466 }14671468 // Reduce approval by transferred amount or remove if remaining approval drops to 01469 let allowance = approval.saturating_sub(amount);1470 collection.consume_sstore()?;1471 if allowance > 0 {1472 <Allowances<T>>::insert(1473 collection.id,1474 (item_id, from.as_sub(), sender.as_sub()),1475 allowance,1476 );1477 } else {1478 <Allowances<T>>::remove(collection.id, (item_id, from.as_sub(), sender.as_sub()));1479 }14801481 match collection.mode {1482 CollectionMode::NFT => {1483 Self::transfer_nft(collection, item_id, from.clone(), recipient.clone())?1484 }1485 CollectionMode::Fungible(_) => {1486 Self::transfer_fungible(collection, amount, from, recipient)?1487 }1488 CollectionMode::ReFungible => Self::transfer_refungible(1489 collection,1490 item_id,1491 amount,1492 from.clone(),1493 recipient.clone(),1494 )?,1495 };14961497 if matches!(collection.mode, CollectionMode::Fungible(_)) {1498 collection.log(ERC20Events::Approval {1499 owner: *from.as_eth(),1500 spender: *sender.as_eth(),1501 value: allowance.into(),1502 })?;1503 }15041505 Ok(())1506 }15071508 pub fn set_variable_meta_data_internal(1509 sender: &T::CrossAccountId,1510 collection: &CollectionHandle<T>,1511 item_id: TokenId,1512 data: Vec<u8>,1513 ) -> DispatchResult {1514 Self::token_exists(collection, item_id)?;15151516 ensure!(1517 CUSTOM_DATA_LIMIT >= data.len() as u32,1518 Error::<T>::TokenVariableDataLimitExceeded1519 );15201521 ensure!(1522 (Self::is_item_owner(sender, collection, item_id)?1523 && collection.meta_update_permission == MetaUpdatePermission::ItemOwner)1524 || (Self::is_owner_or_admin_permissions(collection, sender)?1525 && collection.meta_update_permission == MetaUpdatePermission::Admin),1526 Error::<T>::NoPermission1527 );15281529 match collection.mode {1530 CollectionMode::NFT => Self::set_nft_variable_data(collection, item_id, data)?,1531 CollectionMode::ReFungible => {1532 Self::set_re_fungible_variable_data(collection, item_id, data)?1533 }1534 CollectionMode::Fungible(_) => fail!(Error::<T>::CantStoreMetadataInFungibleTokens),1535 };15361537 Ok(())1538 }15391540 pub fn meta_update_check(1541 sender: &T::CrossAccountId,1542 collection: &CollectionHandle<T>,1543 item_id: TokenId,1544 ) -> DispatchResult {1545 match collection.meta_update_permission {1546 MetaUpdatePermission::ItemOwner => ensure!(1547 Self::is_item_owner(sender, collection, item_id)?,1548 Error::<T>::NoPermission1549 ),1550 MetaUpdatePermission::Admin => ensure!(1551 Self::is_owner_or_admin_permissions(collection, sender)?,1552 Error::<T>::NoPermission1553 ),1554 MetaUpdatePermission::None => fail!(Error::<T>::MetadataUpdateDenied),1555 }15561557 Ok(())1558 }15591560 pub fn get_variable_metadata(1561 collection: &CollectionHandle<T>,1562 item_id: TokenId,1563 ) -> Result<Vec<u8>, DispatchError> {1564 Ok(match collection.mode {1565 CollectionMode::NFT => {1566 <NftItemList<T>>::get(collection.id, item_id)1567 .ok_or(Error::<T>::TokenNotFound)?1568 .variable_data1569 }1570 CollectionMode::ReFungible => {1571 <ReFungibleItemList<T>>::get(collection.id, item_id)1572 .ok_or(Error::<T>::TokenNotFound)?1573 .variable_data1574 }1575 _ => fail!(Error::<T>::UnexpectedCollectionType),1576 })1577 }15781579 pub fn create_multiple_items_internal(1580 sender: &T::CrossAccountId,1581 collection: &CollectionHandle<T>,1582 owner: &T::CrossAccountId,1583 items_data: Vec<CreateItemData>,1584 ) -> DispatchResult {1585 Self::can_create_items_in_collection(collection, sender, owner, items_data.len() as u32)?;15861587 for data in &items_data {1588 Self::validate_create_item_args(collection, data)?;1589 }1590 for data in &items_data {1591 Self::create_item_no_validation(collection, owner, data.clone())?;1592 }15931594 Ok(())1595 }15961597 pub fn burn_item_internal(1598 sender: &T::CrossAccountId,1599 collection: &CollectionHandle<T>,1600 item_id: TokenId,1601 value: u128,1602 ) -> DispatchResult {1603 ensure!(1604 Self::is_item_owner(sender, collection, item_id)?1605 || (collection.limits.owner_can_transfer1606 && Self::is_owner_or_admin_permissions(collection, sender)?),1607 Error::<T>::NoPermission1608 );16091610 if collection.access == AccessMode::WhiteList {1611 Self::check_white_list(collection, sender)?;1612 }16131614 match collection.mode {1615 CollectionMode::NFT => Self::burn_nft_item(collection, item_id)?,1616 CollectionMode::Fungible(_) => Self::burn_fungible_item(sender, collection, value)?,1617 CollectionMode::ReFungible => Self::burn_refungible_item(collection, item_id, sender)?,1618 };16191620 Ok(())1621 }16221623 pub fn toggle_white_list_internal(1624 sender: &T::CrossAccountId,1625 collection: &CollectionHandle<T>,1626 address: &T::CrossAccountId,1627 whitelisted: bool,1628 ) -> DispatchResult {1629 Self::check_owner_or_admin_permissions(collection, sender)?;16301631 if whitelisted {1632 <WhiteList<T>>::insert(collection.id, address.as_sub(), true);1633 } else {1634 <WhiteList<T>>::remove(collection.id, address.as_sub());1635 }16361637 Ok(())1638 }16391640 fn is_correct_transfer(1641 collection: &CollectionHandle<T>,1642 recipient: &T::CrossAccountId,1643 ) -> DispatchResult {1644 let collection_id = collection.id;16451646 // check token limit and account token limit1647 collection.consume_sload()?;1648 let account_items: u32 =1649 <AddressTokens<T>>::get(collection_id, recipient.as_sub()).len() as u32;1650 ensure!(1651 collection.limits.account_token_ownership_limit > account_items,1652 Error::<T>::AccountTokenLimitExceeded1653 );16541655 // preliminary transfer check1656 ensure!(collection.transfers_enabled, Error::<T>::TransferNotAllowed);16571658 Ok(())1659 }16601661 fn can_create_items_in_collection(1662 collection: &CollectionHandle<T>,1663 sender: &T::CrossAccountId,1664 owner: &T::CrossAccountId,1665 amount: u32,1666 ) -> DispatchResult {1667 let collection_id = collection.id;16681669 // check token limit and account token limit1670 let total_items: u32 = ItemListIndex::get(collection_id)1671 .checked_add(amount)1672 .ok_or(Error::<T>::CollectionTokenLimitExceeded)?;1673 let account_items: u32 = (<AddressTokens<T>>::get(collection_id, owner.as_sub()).len()1674 as u32)1675 .checked_add(amount)1676 .ok_or(Error::<T>::AccountTokenLimitExceeded)?;1677 ensure!(1678 collection.limits.token_limit >= total_items,1679 Error::<T>::CollectionTokenLimitExceeded1680 );1681 ensure!(1682 collection.limits.account_token_ownership_limit >= account_items,1683 Error::<T>::AccountTokenLimitExceeded1684 );16851686 if !Self::is_owner_or_admin_permissions(collection, sender)? {1687 ensure!(collection.mint_mode, Error::<T>::PublicMintingNotAllowed);1688 Self::check_white_list(collection, owner)?;1689 Self::check_white_list(collection, sender)?;1690 }16911692 Ok(())1693 }16941695 fn validate_create_item_args(1696 target_collection: &CollectionHandle<T>,1697 data: &CreateItemData,1698 ) -> DispatchResult {1699 match target_collection.mode {1700 CollectionMode::NFT => {1701 if !matches!(data, CreateItemData::NFT(_)) {1702 fail!(Error::<T>::NotNftDataUsedToMintNftCollectionToken);1703 }1704 }1705 CollectionMode::Fungible(_) => {1706 if !matches!(data, CreateItemData::Fungible(_)) {1707 fail!(Error::<T>::NotFungibleDataUsedToMintFungibleCollectionToken);1708 }1709 }1710 CollectionMode::ReFungible => {1711 if let CreateItemData::ReFungible(data) = data {1712 // Check refungibility limits1713 ensure!(1714 data.pieces <= MAX_REFUNGIBLE_PIECES,1715 Error::<T>::WrongRefungiblePieces1716 );1717 ensure!(data.pieces > 0, Error::<T>::WrongRefungiblePieces);1718 } else {1719 fail!(Error::<T>::NotReFungibleDataUsedToMintReFungibleCollectionToken);1720 }1721 }1722 };17231724 Ok(())1725 }17261727 fn create_item_no_validation(1728 collection: &CollectionHandle<T>,1729 owner: &T::CrossAccountId,1730 data: CreateItemData,1731 ) -> DispatchResult {1732 match data {1733 CreateItemData::NFT(data) => {1734 let item = NftItemType {1735 owner: owner.clone(),1736 const_data: data.const_data.into_inner(),1737 variable_data: data.variable_data.into_inner(),1738 };17391740 Self::add_nft_item(collection, item)?;1741 }1742 CreateItemData::Fungible(data) => {1743 Self::add_fungible_item(collection, owner, data.value)?;1744 }1745 CreateItemData::ReFungible(data) => {1746 let owner_list = vec![Ownership {1747 owner: owner.clone(),1748 fraction: data.pieces,1749 }];17501751 let item = ReFungibleItemType {1752 owner: owner_list,1753 const_data: data.const_data.into_inner(),1754 variable_data: data.variable_data.into_inner(),1755 };17561757 Self::add_refungible_item(collection, item)?;1758 }1759 };17601761 Ok(())1762 }17631764 fn add_fungible_item(1765 collection: &CollectionHandle<T>,1766 owner: &T::CrossAccountId,1767 value: u128,1768 ) -> DispatchResult {1769 let collection_id = collection.id;17701771 // Does new owner already have an account?1772 collection.consume_sload()?;1773 let balance: u128 = <FungibleItemList<T>>::get(collection_id, owner.as_sub()).value;17741775 // Mint1776 let item = FungibleItemType {1777 value: balance.checked_add(value).ok_or(Error::<T>::NumOverflow)?,1778 };1779 collection.consume_sstore()?;1780 <FungibleItemList<T>>::insert(collection_id, owner.as_sub(), item);17811782 // Update balance1783 collection.consume_sload()?;1784 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())1785 .checked_add(value)1786 .ok_or(Error::<T>::NumOverflow)?;1787 collection.consume_sstore()?;1788 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);17891790 collection.log(ERC20Events::Transfer {1791 from: H160::default(),1792 to: *owner.as_eth(),1793 value: value.into(),1794 })?;1795 Self::deposit_event(RawEvent::ItemCreated(collection_id, 0, owner.clone()));1796 Ok(())1797 }17981799 fn add_refungible_item(1800 collection: &CollectionHandle<T>,1801 item: ReFungibleItemType<T::CrossAccountId>,1802 ) -> DispatchResult {1803 let collection_id = collection.id;18041805 let current_index = <ItemListIndex>::get(collection_id)1806 .checked_add(1)1807 .ok_or(Error::<T>::NumOverflow)?;1808 let itemcopy = item.clone();18091810 ensure!(item.owner.len() == 1, Error::<T>::BadCreateRefungibleCall,);1811 let item_owner = item.owner.first().expect("only one owner is defined");18121813 let value = item_owner.fraction;1814 let owner = item_owner.owner.clone();18151816 Self::add_token_index(collection, current_index, &owner)?;18171818 <ItemListIndex>::insert(collection_id, current_index);1819 <ReFungibleItemList<T>>::insert(collection_id, current_index, itemcopy);18201821 // Update balance1822 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())1823 .checked_add(value)1824 .ok_or(Error::<T>::NumOverflow)?;1825 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);18261827 Self::deposit_event(RawEvent::ItemCreated(collection_id, current_index, owner));1828 Ok(())1829 }18301831 fn add_nft_item(1832 collection: &CollectionHandle<T>,1833 item: NftItemType<T::CrossAccountId>,1834 ) -> DispatchResult {1835 let collection_id = collection.id;18361837 let current_index = <ItemListIndex>::get(collection_id)1838 .checked_add(1)1839 .ok_or(Error::<T>::NumOverflow)?;18401841 let item_owner = item.owner.clone();1842 Self::add_token_index(collection, current_index, &item.owner)?;18431844 <ItemListIndex>::insert(collection_id, current_index);1845 <NftItemList<T>>::insert(collection_id, current_index, item);18461847 // Update balance1848 let new_balance = <Balance<T>>::get(collection_id, item_owner.as_sub())1849 .checked_add(1)1850 .ok_or(Error::<T>::NumOverflow)?;1851 <Balance<T>>::insert(collection_id, item_owner.as_sub(), new_balance);18521853 collection.log(ERC721Events::Transfer {1854 from: H160::default(),1855 to: *item_owner.as_eth(),1856 token_id: current_index.into(),1857 })?;1858 Self::deposit_event(RawEvent::ItemCreated(1859 collection_id,1860 current_index,1861 item_owner,1862 ));1863 Ok(())1864 }18651866 fn burn_refungible_item(1867 collection: &CollectionHandle<T>,1868 item_id: TokenId,1869 owner: &T::CrossAccountId,1870 ) -> DispatchResult {1871 let collection_id = collection.id;18721873 let mut token = <ReFungibleItemList<T>>::get(collection_id, item_id)1874 .ok_or(Error::<T>::TokenNotFound)?;1875 let rft_balance = token1876 .owner1877 .iter()1878 .find(|&i| i.owner == *owner)1879 .ok_or(Error::<T>::TokenNotFound)?;1880 Self::remove_token_index(collection, item_id, owner)?;18811882 // update balance1883 let new_balance = <Balance<T>>::get(collection_id, rft_balance.owner.as_sub())1884 .checked_sub(rft_balance.fraction)1885 .ok_or(Error::<T>::NumOverflow)?;1886 <Balance<T>>::insert(collection_id, rft_balance.owner.as_sub(), new_balance);18871888 // Re-create owners list with sender removed1889 let index = token1890 .owner1891 .iter()1892 .position(|i| i.owner == *owner)1893 .expect("owned item is exists");1894 token.owner.remove(index);1895 let owner_count = token.owner.len();18961897 // Burn the token completely if this was the last (only) owner1898 if owner_count == 0 {1899 <ReFungibleItemList<T>>::remove(collection_id, item_id);1900 <VariableMetaDataBasket<T>>::remove(collection_id, item_id);1901 } else {1902 <ReFungibleItemList<T>>::insert(collection_id, item_id, token);1903 }19041905 Ok(())1906 }19071908 fn burn_nft_item(collection: &CollectionHandle<T>, item_id: TokenId) -> DispatchResult {1909 let collection_id = collection.id;19101911 let item =1912 <NftItemList<T>>::get(collection_id, item_id).ok_or(Error::<T>::TokenNotFound)?;1913 Self::remove_token_index(collection, item_id, &item.owner)?;19141915 // update balance1916 let new_balance = <Balance<T>>::get(collection_id, item.owner.as_sub())1917 .checked_sub(1)1918 .ok_or(Error::<T>::NumOverflow)?;1919 <Balance<T>>::insert(collection_id, item.owner.as_sub(), new_balance);1920 <NftItemList<T>>::remove(collection_id, item_id);1921 <VariableMetaDataBasket<T>>::remove(collection_id, item_id);19221923 collection.log(ERC721Events::Transfer {1924 from: *item.owner.as_eth(),1925 to: H160::default(),1926 token_id: item_id.into(),1927 })?;1928 Self::deposit_event(RawEvent::ItemDestroyed(collection.id, item_id));1929 Ok(())1930 }19311932 fn burn_fungible_item(1933 owner: &T::CrossAccountId,1934 collection: &CollectionHandle<T>,1935 value: u128,1936 ) -> DispatchResult {1937 let collection_id = collection.id;19381939 let mut balance = <FungibleItemList<T>>::get(collection_id, owner.as_sub());1940 ensure!(balance.value >= value, Error::<T>::TokenValueNotEnough);19411942 // update balance1943 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())1944 .checked_sub(value)1945 .ok_or(Error::<T>::NumOverflow)?;1946 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);19471948 if balance.value - value > 0 {1949 balance.value -= value;1950 <FungibleItemList<T>>::insert(collection_id, owner.as_sub(), balance);1951 } else {1952 <FungibleItemList<T>>::remove(collection_id, owner.as_sub());1953 }19541955 collection.log(ERC20Events::Transfer {1956 from: *owner.as_eth(),1957 to: H160::default(),1958 value: value.into(),1959 })?;1960 Ok(())1961 }19621963 pub fn get_collection(1964 collection_id: CollectionId,1965 ) -> Result<CollectionHandle<T>, sp_runtime::DispatchError> {1966 Ok(<CollectionHandle<T>>::get(collection_id).ok_or(Error::<T>::CollectionNotFound)?)1967 }19681969 fn check_owner_permissions(1970 target_collection: &CollectionHandle<T>,1971 subject: &T::AccountId,1972 ) -> DispatchResult {1973 ensure!(1974 *subject == target_collection.owner,1975 Error::<T>::NoPermission1976 );19771978 Ok(())1979 }19801981 fn is_owner_or_admin_permissions(1982 collection: &CollectionHandle<T>,1983 subject: &T::CrossAccountId,1984 ) -> Result<bool, DispatchError> {1985 collection.consume_sload()?;1986 Ok(*subject.as_sub() == collection.owner1987 || <AdminList<T>>::get(collection.id).contains(subject))1988 }19891990 fn check_owner_or_admin_permissions(1991 collection: &CollectionHandle<T>,1992 subject: &T::CrossAccountId,1993 ) -> DispatchResult {1994 ensure!(1995 Self::is_owner_or_admin_permissions(collection, subject)?,1996 Error::<T>::NoPermission1997 );19981999 Ok(())2000 }20012002 fn owned_amount(2003 subject: &T::CrossAccountId,2004 collection: &CollectionHandle<T>,2005 item_id: TokenId,2006 ) -> Result<Option<u128>, DispatchError> {2007 collection.consume_sload()?;2008 Ok(Self::owned_amount_unchecked(subject, collection, item_id))2009 }20102011 fn owned_amount_unchecked(2012 subject: &T::CrossAccountId,2013 target_collection: &CollectionHandle<T>,2014 item_id: TokenId,2015 ) -> Option<u128> {2016 let collection_id = target_collection.id;20172018 match target_collection.mode {2019 CollectionMode::NFT => {2020 (<NftItemList<T>>::get(collection_id, item_id)?.owner == *subject).then(|| 1)2021 }2022 CollectionMode::Fungible(_) => {2023 Some(<FungibleItemList<T>>::get(collection_id, &subject.as_sub()).value)2024 }2025 CollectionMode::ReFungible => <ReFungibleItemList<T>>::get(collection_id, item_id)?2026 .owner2027 .iter()2028 .find(|i| i.owner == *subject)2029 .map(|i| i.fraction),2030 }2031 }20322033 fn is_item_owner(2034 subject: &T::CrossAccountId,2035 target_collection: &CollectionHandle<T>,2036 item_id: TokenId,2037 ) -> Result<bool, DispatchError> {2038 Ok(match target_collection.mode {2039 CollectionMode::Fungible(_) => true,2040 _ => Self::owned_amount(subject, target_collection, item_id)?.is_some(),2041 })2042 }20432044 fn check_white_list(2045 collection: &CollectionHandle<T>,2046 address: &T::CrossAccountId,2047 ) -> DispatchResult {2048 collection.consume_sload()?;2049 ensure!(2050 <WhiteList<T>>::contains_key(collection.id, address.as_sub()),2051 Error::<T>::AddresNotInWhiteList,2052 );2053 Ok(())2054 }20552056 /// Check if token exists. In case of Fungible, check if there is an entry for2057 /// the owner in fungible balances double map2058 fn token_exists(target_collection: &CollectionHandle<T>, item_id: TokenId) -> DispatchResult {2059 let collection_id = target_collection.id;2060 let exists = match target_collection.mode {2061 CollectionMode::NFT => <NftItemList<T>>::contains_key(collection_id, item_id),2062 CollectionMode::Fungible(_) => true,2063 CollectionMode::ReFungible => {2064 <ReFungibleItemList<T>>::contains_key(collection_id, item_id)2065 }2066 };20672068 ensure!(exists, Error::<T>::TokenNotFound);2069 Ok(())2070 }20712072 fn transfer_fungible(2073 collection: &CollectionHandle<T>,2074 value: u128,2075 owner: &T::CrossAccountId,2076 recipient: &T::CrossAccountId,2077 ) -> DispatchResult {2078 let collection_id = collection.id;20792080 collection.consume_sload()?;2081 collection.consume_sload()?;2082 let mut recipient_balance = <FungibleItemList<T>>::get(collection_id, recipient.as_sub());2083 let mut balance = <FungibleItemList<T>>::get(collection_id, owner.as_sub());20842085 recipient_balance.value = recipient_balance2086 .value2087 .checked_add(value)2088 .ok_or(Error::<T>::NumOverflow)?;2089 balance.value = balance2090 .value2091 .checked_sub(value)2092 .ok_or(Error::<T>::TokenValueTooLow)?;20932094 // update balanceOf2095 collection.consume_sstore()?;2096 collection.consume_sstore()?;2097 if balance.value != 0 {2098 <Balance<T>>::insert(collection_id, owner.as_sub(), balance.value);2099 } else {2100 <Balance<T>>::remove(collection_id, owner.as_sub());2101 }2102 <Balance<T>>::insert(collection_id, recipient.as_sub(), recipient_balance.value);21032104 // Reduce or remove sender2105 collection.consume_sstore()?;2106 collection.consume_sstore()?;2107 if balance.value != 0 {2108 <FungibleItemList<T>>::insert(collection_id, owner.as_sub(), balance);2109 } else {2110 <FungibleItemList<T>>::remove(collection_id, owner.as_sub());2111 }2112 <FungibleItemList<T>>::insert(collection_id, recipient.as_sub(), recipient_balance);21132114 collection.log(ERC20Events::Transfer {2115 from: *owner.as_eth(),2116 to: *recipient.as_eth(),2117 value: value.into(),2118 })?;2119 Self::deposit_event(RawEvent::Transfer(2120 collection.id,2121 1,2122 owner.clone(),2123 recipient.clone(),2124 value,2125 ));21262127 Ok(())2128 }21292130 fn transfer_refungible(2131 collection: &CollectionHandle<T>,2132 item_id: TokenId,2133 value: u128,2134 owner: T::CrossAccountId,2135 new_owner: T::CrossAccountId,2136 ) -> DispatchResult {2137 let collection_id = collection.id;2138 collection.consume_sload()?;2139 let full_item = <ReFungibleItemList<T>>::get(collection_id, item_id)2140 .ok_or(Error::<T>::TokenNotFound)?;21412142 let item = full_item2143 .owner2144 .iter()2145 .find(|i| i.owner == owner)2146 .ok_or(Error::<T>::TokenNotFound)?;2147 let amount = item.fraction;21482149 ensure!(amount >= value, Error::<T>::TokenValueTooLow);21502151 collection.consume_sload()?;2152 // update balance2153 let balance_old_owner = <Balance<T>>::get(collection_id, item.owner.as_sub())2154 .checked_sub(value)2155 .ok_or(Error::<T>::NumOverflow)?;2156 collection.consume_sstore()?;2157 <Balance<T>>::insert(collection_id, item.owner.as_sub(), balance_old_owner);21582159 collection.consume_sload()?;2160 let balance_new_owner = <Balance<T>>::get(collection_id, new_owner.as_sub())2161 .checked_add(value)2162 .ok_or(Error::<T>::NumOverflow)?;2163 collection.consume_sstore()?;2164 <Balance<T>>::insert(collection_id, new_owner.as_sub(), balance_new_owner);21652166 let old_owner = item.owner.clone();2167 let new_owner_has_account = full_item.owner.iter().any(|i| i.owner == new_owner);21682169 let mut new_full_item = full_item.clone();2170 // transfer2171 if amount == value && !new_owner_has_account {2172 // change owner2173 // new owner do not have account2174 new_full_item2175 .owner2176 .iter_mut()2177 .find(|i| i.owner == owner)2178 .expect("old owner does present in refungible")2179 .owner = new_owner.clone();2180 collection.consume_sstore()?;2181 <ReFungibleItemList<T>>::insert(collection_id, item_id, new_full_item);21822183 // update index collection2184 Self::move_token_index(collection, item_id, &old_owner, &new_owner)?;2185 } else {2186 new_full_item2187 .owner2188 .iter_mut()2189 .find(|i| i.owner == owner)2190 .expect("old owner does present in refungible")2191 .fraction -= value;21922193 // separate amount2194 if new_owner_has_account {2195 // new owner has account2196 new_full_item2197 .owner2198 .iter_mut()2199 .find(|i| i.owner == new_owner)2200 .expect("new owner has account")2201 .fraction += value;2202 } else {2203 // new owner do not have account2204 new_full_item.owner.push(Ownership {2205 owner: new_owner.clone(),2206 fraction: value,2207 });2208 Self::add_token_index(collection, item_id, &new_owner)?;2209 }22102211 collection.consume_sstore()?;2212 <ReFungibleItemList<T>>::insert(collection_id, item_id, new_full_item);2213 }22142215 Self::deposit_event(RawEvent::Transfer(2216 collection.id,2217 item_id,2218 owner,2219 new_owner,2220 amount,2221 ));22222223 Ok(())2224 }22252226 fn transfer_nft(2227 collection: &CollectionHandle<T>,2228 item_id: TokenId,2229 sender: T::CrossAccountId,2230 new_owner: T::CrossAccountId,2231 ) -> DispatchResult {2232 let collection_id = collection.id;2233 collection.consume_sload()?;2234 let mut item =2235 <NftItemList<T>>::get(collection_id, item_id).ok_or(Error::<T>::TokenNotFound)?;22362237 ensure!(sender == item.owner, Error::<T>::MustBeTokenOwner);22382239 collection.consume_sload()?;2240 // update balance2241 let balance_old_owner = <Balance<T>>::get(collection_id, item.owner.as_sub())2242 .checked_sub(1)2243 .ok_or(Error::<T>::NumOverflow)?;2244 collection.consume_sstore()?;2245 <Balance<T>>::insert(collection_id, item.owner.as_sub(), balance_old_owner);22462247 collection.consume_sload()?;2248 let balance_new_owner = <Balance<T>>::get(collection_id, new_owner.as_sub())2249 .checked_add(1)2250 .ok_or(Error::<T>::NumOverflow)?;2251 collection.consume_sstore()?;2252 <Balance<T>>::insert(collection_id, new_owner.as_sub(), balance_new_owner);22532254 // change owner2255 let old_owner = item.owner.clone();2256 item.owner = new_owner.clone();2257 collection.consume_sstore()?;2258 <NftItemList<T>>::insert(collection_id, item_id, item);22592260 // update index collection2261 Self::move_token_index(collection, item_id, &old_owner, &new_owner)?;22622263 collection.log(ERC721Events::Transfer {2264 from: *sender.as_eth(),2265 to: *new_owner.as_eth(),2266 token_id: item_id.into(),2267 })?;2268 Self::deposit_event(RawEvent::Transfer(2269 collection.id,2270 item_id,2271 sender,2272 new_owner,2273 1,2274 ));22752276 Ok(())2277 }22782279 fn set_re_fungible_variable_data(2280 collection: &CollectionHandle<T>,2281 item_id: TokenId,2282 data: Vec<u8>,2283 ) -> DispatchResult {2284 let collection_id = collection.id;2285 let mut item = <ReFungibleItemList<T>>::get(collection_id, item_id)2286 .ok_or(Error::<T>::TokenNotFound)?;22872288 item.variable_data = data;22892290 <ReFungibleItemList<T>>::insert(collection_id, item_id, item);22912292 Ok(())2293 }22942295 fn set_nft_variable_data(2296 collection: &CollectionHandle<T>,2297 item_id: TokenId,2298 data: Vec<u8>,2299 ) -> DispatchResult {2300 let collection_id = collection.id;2301 let mut item =2302 <NftItemList<T>>::get(collection_id, item_id).ok_or(Error::<T>::TokenNotFound)?;23032304 item.variable_data = data;23052306 <NftItemList<T>>::insert(collection_id, item_id, item);23072308 Ok(())2309 }23102311 #[allow(dead_code)]2312 fn init_collection(item: &Collection<T>) {2313 // check params2314 assert!(2315 item.decimal_points <= MAX_DECIMAL_POINTS,2316 "decimal_points parameter must be lower than MAX_DECIMAL_POINTS"2317 );2318 assert!(2319 item.name.len() <= 64,2320 "Collection name can not be longer than 63 char"2321 );2322 assert!(2323 item.name.len() <= 256,2324 "Collection description can not be longer than 255 char"2325 );2326 assert!(2327 item.token_prefix.len() <= 16,2328 "Token prefix can not be longer than 15 char"2329 );23302331 // Generate next collection ID2332 let next_id = CreatedCollectionCount::get().checked_add(1).unwrap();23332334 CreatedCollectionCount::put(next_id);2335 }23362337 #[allow(dead_code)]2338 fn init_nft_token(collection_id: CollectionId, item: &NftItemType<T::CrossAccountId>) {2339 let current_index = <ItemListIndex>::get(collection_id).checked_add(1).unwrap();23402341 Self::add_token_index(2342 &CollectionHandle::get(collection_id).unwrap(),2343 current_index,2344 &item.owner,2345 )2346 .unwrap();23472348 <ItemListIndex>::insert(collection_id, current_index);23492350 // Update balance2351 let new_balance = <Balance<T>>::get(collection_id, item.owner.as_sub())2352 .checked_add(1)2353 .unwrap();2354 <Balance<T>>::insert(collection_id, item.owner.as_sub(), new_balance);2355 }23562357 #[allow(dead_code)]2358 fn init_fungible_token(2359 collection_id: CollectionId,2360 owner: &T::CrossAccountId,2361 item: &FungibleItemType,2362 ) {2363 let current_index = <ItemListIndex>::get(collection_id).checked_add(1).unwrap();23642365 Self::add_token_index(2366 &CollectionHandle::get(collection_id).unwrap(),2367 current_index,2368 owner,2369 )2370 .unwrap();23712372 <ItemListIndex>::insert(collection_id, current_index);23732374 // Update balance2375 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())2376 .checked_add(item.value)2377 .unwrap();2378 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);2379 }23802381 #[allow(dead_code)]2382 fn init_refungible_token(2383 collection_id: CollectionId,2384 item: &ReFungibleItemType<T::CrossAccountId>,2385 ) {2386 let current_index = <ItemListIndex>::get(collection_id).checked_add(1).unwrap();23872388 let value = item.owner.first().unwrap().fraction;2389 let owner = item.owner.first().unwrap().owner.clone();23902391 Self::add_token_index(2392 &CollectionHandle::get(collection_id).unwrap(),2393 current_index,2394 &owner,2395 )2396 .unwrap();23972398 <ItemListIndex>::insert(collection_id, current_index);23992400 // Update balance2401 let new_balance = <Balance<T>>::get(collection_id, &owner.as_sub())2402 .checked_add(value)2403 .unwrap();2404 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);2405 }24062407 fn add_token_index(2408 collection: &CollectionHandle<T>,2409 item_index: TokenId,2410 owner: &T::CrossAccountId,2411 ) -> DispatchResult {2412 // add to account limit2413 collection.consume_sload()?;2414 if <AccountItemCount<T>>::contains_key(owner.as_sub()) {2415 // bound Owned tokens by a single address2416 collection.consume_sload()?;2417 let count = <AccountItemCount<T>>::get(owner.as_sub());2418 ensure!(2419 count < ACCOUNT_TOKEN_OWNERSHIP_LIMIT,2420 Error::<T>::AddressOwnershipLimitExceeded2421 );24222423 collection.consume_sstore()?;2424 <AccountItemCount<T>>::insert(2425 owner.as_sub(),2426 count.checked_add(1).ok_or(Error::<T>::NumOverflow)?,2427 );2428 } else {2429 collection.consume_sstore()?;2430 <AccountItemCount<T>>::insert(owner.as_sub(), 1);2431 }24322433 collection.consume_sload()?;2434 let list_exists = <AddressTokens<T>>::contains_key(collection.id, owner.as_sub());2435 if list_exists {2436 collection.consume_sload()?;2437 let mut list = <AddressTokens<T>>::get(collection.id, owner.as_sub());2438 let item_contains = list.contains(&item_index.clone());24392440 if !item_contains {2441 list.push(item_index);2442 }24432444 collection.consume_sstore()?;2445 <AddressTokens<T>>::insert(collection.id, owner.as_sub(), list);2446 } else {2447 let itm = vec![item_index];2448 collection.consume_sstore()?;2449 <AddressTokens<T>>::insert(collection.id, owner.as_sub(), itm);2450 }24512452 Ok(())2453 }24542455 fn remove_token_index(2456 collection: &CollectionHandle<T>,2457 item_index: TokenId,2458 owner: &T::CrossAccountId,2459 ) -> DispatchResult {2460 // update counter2461 collection.consume_sload()?;2462 collection.consume_sstore()?;2463 <AccountItemCount<T>>::insert(2464 owner.as_sub(),2465 <AccountItemCount<T>>::get(owner.as_sub())2466 .checked_sub(1)2467 .ok_or(Error::<T>::NumOverflow)?,2468 );24692470 collection.consume_sload()?;2471 let list_exists = <AddressTokens<T>>::contains_key(collection.id, owner.as_sub());2472 if list_exists {2473 collection.consume_sload()?;2474 let mut list = <AddressTokens<T>>::get(collection.id, owner.as_sub());2475 let item_contains = list.contains(&item_index.clone());24762477 if item_contains {2478 list.retain(|&item| item != item_index);2479 collection.consume_sstore()?;2480 <AddressTokens<T>>::insert(collection.id, owner.as_sub(), list);2481 }2482 }24832484 Ok(())2485 }24862487 fn move_token_index(2488 collection: &CollectionHandle<T>,2489 item_index: TokenId,2490 old_owner: &T::CrossAccountId,2491 new_owner: &T::CrossAccountId,2492 ) -> DispatchResult {2493 Self::remove_token_index(collection, item_index, old_owner)?;2494 Self::add_token_index(collection, item_index, new_owner)?;24952496 Ok(())2497 }2498}24992500sp_api::decl_runtime_apis! {2501 pub trait NftApi {2502 /// Used for ethereum integration2503 fn eth_contract_code(account: H160) -> Option<Vec<u8>>;2504 }2505}1//2// This file is subject to the terms and conditions defined in3// file 'LICENSE', which is part of this source code package.4//56#![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_event, decl_module, decl_storage, decl_error,20 dispatch::DispatchResult,21 ensure, fail, parameter_types,22 traits::{23 Currency, ExistenceRequirement, Get, Imbalance, KeyOwnerProofSystem, OnUnbalanced,24 Randomness, 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};3334use frame_system::{self as system, ensure_signed};35use sp_core::H160;36use sp_std::vec;37use sp_runtime::{DispatchError, sp_std::prelude::Vec};38use core::ops::{Deref, DerefMut};39use nft_data_structs::{40 MAX_DECIMAL_POINTS, MAX_SPONSOR_TIMEOUT, MAX_TOKEN_OWNERSHIP, MAX_REFUNGIBLE_PIECES,41 CUSTOM_DATA_LIMIT, COLLECTION_NUMBER_LIMIT, ACCOUNT_TOKEN_OWNERSHIP_LIMIT,42 VARIABLE_ON_CHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, COLLECTION_ADMINS_LIMIT,43 OFFCHAIN_SCHEMA_LIMIT, MAX_TOKEN_PREFIX_LENGTH, MAX_COLLECTION_NAME_LENGTH,44 MAX_COLLECTION_DESCRIPTION_LENGTH, AccessMode, Collection, CreateItemData, CollectionLimits,45 CollectionId, CollectionMode, TokenId, SchemaVersion, SponsorshipState, Ownership, NftItemType,46 MetaUpdatePermission, FungibleItemType, ReFungibleItemType,47};4849#[cfg(test)]50mod mock;5152#[cfg(test)]53mod tests;5455mod eth;56mod sponsorship;57pub use sponsorship::NftSponsorshipHandler;58pub use eth::sponsoring::NftEthSponsorshipHandler;5960pub use eth::NftErcSupport;61pub use eth::account::*;62use eth::erc::{ERC20Events, ERC721Events};6364#[cfg(feature = "runtime-benchmarks")]65mod benchmarking;66pub mod weights;67use weights::WeightInfo;6869decl_error! {70 /// Error for non-fungible-token module.71 pub enum Error for Module<T: Config> {72 /// Total collections bound exceeded.73 TotalCollectionsLimitExceeded,74 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.75 CollectionDecimalPointLimitExceeded,76 /// Collection name can not be longer than 63 char.77 CollectionNameLimitExceeded,78 /// Collection description can not be longer than 255 char.79 CollectionDescriptionLimitExceeded,80 /// Token prefix can not be longer than 15 char.81 CollectionTokenPrefixLimitExceeded,82 /// This collection does not exist.83 CollectionNotFound,84 /// Item not exists.85 TokenNotFound,86 /// Admin not found87 AdminNotFound,88 /// Arithmetic calculation overflow.89 NumOverflow,90 /// Account already has admin role.91 AlreadyAdmin,92 /// You do not own this collection.93 NoPermission,94 /// This address is not set as sponsor, use setCollectionSponsor first.95 ConfirmUnsetSponsorFail,96 /// Collection is not in mint mode.97 PublicMintingNotAllowed,98 /// Sender parameter and item owner must be equal.99 MustBeTokenOwner,100 /// Item balance not enough.101 TokenValueTooLow,102 /// Size of item is too large.103 NftSizeLimitExceeded,104 /// No approve found105 ApproveNotFound,106 /// Requested value more than approved.107 TokenValueNotEnough,108 /// Only approved addresses can call this method.109 ApproveRequired,110 /// Address is not in white list.111 AddresNotInWhiteList,112 /// Number of collection admins bound exceeded.113 CollectionAdminsLimitExceeded,114 /// Owned tokens by a single address bound exceeded.115 AddressOwnershipLimitExceeded,116 /// Length of items properties must be greater than 0.117 EmptyArgument,118 /// const_data exceeded data limit.119 TokenConstDataLimitExceeded,120 /// variable_data exceeded data limit.121 TokenVariableDataLimitExceeded,122 /// Not NFT item data used to mint in NFT collection.123 NotNftDataUsedToMintNftCollectionToken,124 /// Not Fungible item data used to mint in Fungible collection.125 NotFungibleDataUsedToMintFungibleCollectionToken,126 /// Not Re Fungible item data used to mint in Re Fungible collection.127 NotReFungibleDataUsedToMintReFungibleCollectionToken,128 /// Unexpected collection type.129 UnexpectedCollectionType,130 /// Can't store metadata in fungible tokens.131 CantStoreMetadataInFungibleTokens,132 /// Collection token limit exceeded133 CollectionTokenLimitExceeded,134 /// Account token limit exceeded per collection135 AccountTokenLimitExceeded,136 /// Collection limit bounds per collection exceeded137 CollectionLimitBoundsExceeded,138 /// Tried to enable permissions which are only permitted to be disabled139 OwnerPermissionsCantBeReverted,140 /// Schema data size limit bound exceeded141 SchemaDataLimitExceeded,142 /// Maximum refungibility exceeded143 WrongRefungiblePieces,144 /// createRefungible should be called with one owner145 BadCreateRefungibleCall,146 /// Gas limit exceeded147 OutOfGas,148 /// Metadata update denied by collection settings149 MetadataUpdateDenied,150 /// Metadata update flag become unmutable with None option151 MetadataFlagFrozen,152 /// Collection settings not allowing items transferring153 TransferNotAllowed,154 /// Can't transfer tokens to ethereum zero address155 AddressIsZero,156 }157}158159#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]160pub struct CollectionHandle<T: Config> {161 pub id: CollectionId,162 collection: Collection<T>,163 recorder: pallet_evm_coder_substrate::SubstrateRecorder<T>,164}165impl<T: Config> CollectionHandle<T> {166 pub fn get_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {167 <CollectionById<T>>::get(id).map(|collection| Self {168 id,169 collection,170 recorder: pallet_evm_coder_substrate::SubstrateRecorder::new(171 eth::collection_id_to_address(id),172 gas_limit,173 ),174 })175 }176 pub fn get(id: CollectionId) -> Option<Self> {177 Self::get_with_gas_limit(id, u64::MAX)178 }179 pub fn log(&self, log: impl evm_coder::ToLog) -> DispatchResult {180 self.recorder.log_sub(log)181 }182 #[allow(dead_code)]183 fn consume_gas(&self, gas: u64) -> DispatchResult {184 self.recorder.consume_gas_sub(gas)185 }186 fn consume_sload(&self) -> DispatchResult {187 self.recorder.consume_sload_sub()188 }189 fn consume_sstore(&self) -> DispatchResult {190 self.recorder.consume_sstore_sub()191 }192 pub fn submit_logs(self) -> DispatchResult {193 self.recorder.submit_logs()194 }195 pub fn save(self) -> DispatchResult {196 self.recorder.submit_logs()?;197 <CollectionById<T>>::insert(self.id, self.collection);198 Ok(())199 }200}201impl<T: Config> Deref for CollectionHandle<T> {202 type Target = Collection<T>;203204 fn deref(&self) -> &Self::Target {205 &self.collection206 }207}208209impl<T: Config> DerefMut for CollectionHandle<T> {210 fn deref_mut(&mut self) -> &mut Self::Target {211 &mut self.collection212 }213}214215pub trait Config: system::Config + pallet_evm_coder_substrate::Config + Sized {216 type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;217218 /// Weight information for extrinsics in this pallet.219 type WeightInfo: WeightInfo;220221 type EvmAddressMapping: pallet_evm::AddressMapping<Self::AccountId>;222 type EvmBackwardsAddressMapping: EvmBackwardsAddressMapping<Self::AccountId>;223224 type CrossAccountId: CrossAccountId<Self::AccountId>;225 type Currency: Currency<Self::AccountId>;226 type CollectionCreationPrice: Get<227 <<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,228 >;229 type TreasuryAccountId: Get<Self::AccountId>;230}231232type SelfWeightOf<T> = <T as Config>::WeightInfo;233234trait WeightInfoHelpers: WeightInfo {235 fn transfer() -> Weight {236 Self::transfer_nft()237 .max(Self::transfer_fungible())238 .max(Self::transfer_refungible())239 }240 fn transfer_from() -> Weight {241 Self::transfer_from_nft()242 .max(Self::transfer_from_fungible())243 .max(Self::transfer_from_refungible())244 }245 fn approve() -> Weight {246 // TODO: refungible, fungible247 Self::approve_nft()248 }249 fn set_variable_meta_data(data: u32) -> Weight {250 // TODO: refungible251 Self::set_variable_meta_data_nft(data)252 }253 fn create_item(data: u32) -> Weight {254 Self::create_item_nft(data)255 .max(Self::create_item_fungible())256 .max(Self::create_item_refungible(data))257 }258 fn create_multiple_items(amount: u32) -> Weight {259 Self::create_multiple_items_nft(amount)260 .max(Self::create_multiple_items_fungible(amount))261 .max(Self::create_multiple_items_refungible(amount))262 }263 fn burn_item() -> Weight {264 // TODO: refungible, fungible265 Self::burn_item_nft()266 }267}268impl<T: WeightInfo> WeightInfoHelpers for T {}269270// # Used definitions271//272// ## User control levels273//274// chain-controlled - key is uncontrolled by user275// i.e autoincrementing index276// can use non-cryptographic hash277// real - key is controlled by user278// but it is hard to generate enough colliding values, i.e owner of signed txs279// can use non-cryptographic hash280// controlled - key is completly controlled by users281// i.e maps with mutable keys282// should use cryptographic hash283//284// ## User control level downgrade reasons285//286// ?1 - chain-controlled -> controlled287// collections/tokens can be destroyed, resulting in massive holes288// ?2 - chain-controlled -> controlled289// same as ?1, but can be only added, resulting in easier exploitation290// ?3 - real -> controlled291// no confirmation required, so addresses can be easily generated292decl_storage! {293 trait Store for Module<T: Config> as Nft {294295 //#region Private members296 /// Id of next collection297 CreatedCollectionCount: u32;298 /// Used for migrations299 ChainVersion: u64;300 /// Id of last collection token301 /// Collection id (controlled?1)302 ItemListIndex: map hasher(blake2_128_concat) CollectionId => TokenId;303 //#endregion304305 //#region Bound counters306 /// Amount of collections destroyed, used for total amount tracking with307 /// CreatedCollectionCount308 DestroyedCollectionCount: u32;309 //#endregion310311 //#region Basic collections312 /// Collection info313 /// Collection id (controlled?1)314 pub CollectionById get(fn collection_id) config(): map hasher(blake2_128_concat) CollectionId => Option<Collection<T>> = None;315 /// List of collection admins316 /// Collection id (controlled?2)317 pub AdminList get(fn admin_list_collection): map hasher(blake2_128_concat) CollectionId => Vec<T::CrossAccountId>;318 /// Whitelisted collection users319 /// Collection id (controlled?2), user id (controlled?3)320 pub WhiteList get(fn white_list): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) T::AccountId => bool;321 //#endregion322323 /// How many of collection items user have324 /// Collection id (controlled?2), account id (real)325 pub Balance get(fn balance_count): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => u128;326327 /// Amount of items which spender can transfer out of owners account (via transferFrom)328 /// Collection id (controlled?2), (token id (controlled ?2) + owner account id (real) + spender account id (controlled?3))329 /// TODO: Off chain worker should remove from this map when token gets removed330 pub Allowances get(fn approved): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) (TokenId, T::AccountId, T::AccountId) => u128;331332 //#region Item collections333 /// Collection id (controlled?2), token id (controlled?1)334 pub NftItemList get(fn nft_item_id) config(): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<NftItemType<T::CrossAccountId>>;335 /// Collection id (controlled?2), owner (controlled?2)336 pub FungibleItemList get(fn fungible_item_id) config(): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) T::AccountId => FungibleItemType;337 /// Collection id (controlled?2), token id (controlled?1)338 pub ReFungibleItemList get(fn refungible_item_id) config(): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<ReFungibleItemType<T::CrossAccountId>>;339 //#endregion340341 //#region Index list342 /// Collection id (controlled?2), tokens owner (controlled?2)343 pub AddressTokens get(fn address_tokens): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) T::AccountId => Vec<TokenId>;344 //#endregion345346 //#region Tokens transfer rate limit baskets347 /// (Collection id (controlled?2), who created (real))348 /// TODO: Off chain worker should remove from this map when collection gets removed349 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => T::BlockNumber;350 /// Collection id (controlled?2), token id (controlled?2)351 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;352 /// Collection id (controlled?2), owning user (real)353 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => T::BlockNumber;354 /// Collection id (controlled?2), token id (controlled?2)355 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;356 //#endregion357358 /// Variable metadata sponsoring359 /// Collection id (controlled?2), token id (controlled?2)360 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber> = None;361 }362 add_extra_genesis {363 build(|config: &GenesisConfig<T>| {364 // Modification of storage365 for (_num, _c) in &config.collection_id {366 <Module<T>>::init_collection(_c);367 }368369 for (_num, _c, _i) in &config.nft_item_id {370 <Module<T>>::init_nft_token(*_c, _i);371 }372373 for (collection_id, account_id, fungible_item) in &config.fungible_item_id {374 <Module<T>>::init_fungible_token(*collection_id, &T::CrossAccountId::from_sub(account_id.clone()), fungible_item);375 }376377 for (_num, _c, _i) in &config.refungible_item_id {378 <Module<T>>::init_refungible_token(*_c, _i);379 }380 })381 }382}383384decl_event!(385 pub enum Event<T>386 where387 AccountId = <T as frame_system::Config>::AccountId,388 CrossAccountId = <T as Config>::CrossAccountId,389 {390 /// New collection was created391 ///392 /// # Arguments393 ///394 /// * collection_id: Globally unique identifier of newly created collection.395 ///396 /// * mode: [CollectionMode] converted into u8.397 ///398 /// * account_id: Collection owner.399 CollectionCreated(CollectionId, u8, AccountId),400401 /// New item was created.402 ///403 /// # Arguments404 ///405 /// * collection_id: Id of the collection where item was created.406 ///407 /// * item_id: Id of an item. Unique within the collection.408 ///409 /// * recipient: Owner of newly created item410 ItemCreated(CollectionId, TokenId, CrossAccountId),411412 /// Collection item was burned.413 ///414 /// # Arguments415 ///416 /// collection_id.417 ///418 /// item_id: Identifier of burned NFT.419 ItemDestroyed(CollectionId, TokenId),420421 /// Item was transferred422 ///423 /// * collection_id: Id of collection to which item is belong424 ///425 /// * item_id: Id of an item426 ///427 /// * sender: Original owner of item428 ///429 /// * recipient: New owner of item430 ///431 /// * amount: Always 1 for NFT432 Transfer(CollectionId, TokenId, CrossAccountId, CrossAccountId, u128),433434 /// * collection_id435 ///436 /// * item_id437 ///438 /// * sender439 ///440 /// * spender441 ///442 /// * amount443 Approved(CollectionId, TokenId, CrossAccountId, CrossAccountId, u128),444 }445);446447decl_module! {448 pub struct Module<T: Config> for enum Call449 where450 origin: T::Origin451 {452 fn deposit_event() = default;453 const CollectionAdminsLimit: u64 = COLLECTION_ADMINS_LIMIT;454 type Error = Error<T>;455456 fn on_initialize(_now: T::BlockNumber) -> Weight {457 0458 }459460 /// This method creates a Collection of NFTs. Each Token may have multiple properties encoded as an array of bytes of certain length. The initial owner and admin of the collection are set to the address that signed the transaction. Both addresses can be changed later.461 ///462 /// # Permissions463 ///464 /// * Anyone.465 ///466 /// # Arguments467 ///468 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.469 ///470 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.471 ///472 /// * token_prefix: UTF-8 string with token prefix.473 ///474 /// * mode: [CollectionMode] collection type and type dependent data.475 // returns collection ID476 #[weight = <SelfWeightOf<T>>::create_collection()]477 #[transactional]478 pub fn create_collection(origin,479 collection_name: Vec<u16>,480 collection_description: Vec<u16>,481 token_prefix: Vec<u8>,482 mode: CollectionMode) -> DispatchResult {483484 // Anyone can create a collection485 let who = ensure_signed(origin)?;486487 // Take a (non-refundable) deposit of collection creation488 let mut imbalance = <<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();489 imbalance.subsume(<<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(490 &T::TreasuryAccountId::get(),491 T::CollectionCreationPrice::get(),492 ));493 <T as Config>::Currency::settle(494 &who,495 imbalance,496 WithdrawReasons::TRANSFER,497 ExistenceRequirement::KeepAlive,498 ).map_err(|_| Error::<T>::NoPermission)?;499500 let decimal_points = match mode {501 CollectionMode::Fungible(points) => points,502 _ => 0503 };504505 let created_count = CreatedCollectionCount::get();506 let destroyed_count = DestroyedCollectionCount::get();507508 // bound Total number of collections509 ensure!(created_count - destroyed_count < COLLECTION_NUMBER_LIMIT, Error::<T>::TotalCollectionsLimitExceeded);510511 // check params512 ensure!(decimal_points <= MAX_DECIMAL_POINTS, Error::<T>::CollectionDecimalPointLimitExceeded);513 ensure!(collection_name.len() <= MAX_COLLECTION_NAME_LENGTH, Error::<T>::CollectionNameLimitExceeded);514 ensure!(collection_description.len() <= MAX_COLLECTION_DESCRIPTION_LENGTH, Error::<T>::CollectionDescriptionLimitExceeded);515 ensure!(token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH, Error::<T>::CollectionTokenPrefixLimitExceeded);516517 // Generate next collection ID518 let next_id = created_count519 .checked_add(1)520 .ok_or(Error::<T>::NumOverflow)?;521522 CreatedCollectionCount::put(next_id);523524 let limits = CollectionLimits {525 sponsored_data_size: CUSTOM_DATA_LIMIT,526 ..Default::default()527 };528529 // Create new collection530 let new_collection = Collection {531 owner: who.clone(),532 name: collection_name,533 mode: mode.clone(),534 mint_mode: false,535 access: AccessMode::Normal,536 description: collection_description,537 decimal_points,538 token_prefix,539 offchain_schema: Vec::new(),540 schema_version: SchemaVersion::ImageURL,541 sponsorship: SponsorshipState::Disabled,542 variable_on_chain_schema: Vec::new(),543 const_on_chain_schema: Vec::new(),544 limits,545 meta_update_permission: MetaUpdatePermission::default(),546 transfers_enabled: true,547 };548549 // Add new collection to map550 <CollectionById<T>>::insert(next_id, new_collection);551552 // call event553 Self::deposit_event(RawEvent::CollectionCreated(next_id, mode.id(), who));554555 Ok(())556 }557558 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.559 ///560 /// # Permissions561 ///562 /// * Collection Owner.563 ///564 /// # Arguments565 ///566 /// * collection_id: collection to destroy.567 #[weight = <SelfWeightOf<T>>::destroy_collection()]568 #[transactional]569 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {570571 let sender = ensure_signed(origin)?;572 let collection = Self::get_collection(collection_id)?;573 Self::check_owner_permissions(&collection, &sender)?;574 if !collection.limits.owner_can_destroy {575 fail!(Error::<T>::NoPermission);576 }577578 <AddressTokens<T>>::remove_prefix(collection_id, None);579 <Allowances<T>>::remove_prefix(collection_id, None);580 <Balance<T>>::remove_prefix(collection_id, None);581 <ItemListIndex>::remove(collection_id);582 <AdminList<T>>::remove(collection_id);583 <CollectionById<T>>::remove(collection_id);584 <WhiteList<T>>::remove_prefix(collection_id, None);585586 <NftItemList<T>>::remove_prefix(collection_id, None);587 <FungibleItemList<T>>::remove_prefix(collection_id, None);588 <ReFungibleItemList<T>>::remove_prefix(collection_id, None);589590 <NftTransferBasket<T>>::remove_prefix(collection_id, None);591 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);592 <ReFungibleTransferBasket<T>>::remove_prefix(collection_id, None);593594 <VariableMetaDataBasket<T>>::remove_prefix(collection_id, None);595596 DestroyedCollectionCount::put(DestroyedCollectionCount::get()597 .checked_add(1)598 .ok_or(Error::<T>::NumOverflow)?);599600 Ok(())601 }602603 /// Add an address to white list.604 ///605 /// # Permissions606 ///607 /// * Collection Owner608 /// * Collection Admin609 ///610 /// # Arguments611 ///612 /// * collection_id.613 ///614 /// * address.615 #[weight = <SelfWeightOf<T>>::add_to_white_list()]616 #[transactional]617 pub fn add_to_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{618619 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);620 let collection = Self::get_collection(collection_id)?;621622 Self::toggle_white_list_internal(623 &sender,624 &collection,625 &address,626 true,627 )?;628629 Ok(())630 }631632 /// Remove an address from white list.633 ///634 /// # Permissions635 ///636 /// * Collection Owner637 /// * Collection Admin638 ///639 /// # Arguments640 ///641 /// * collection_id.642 ///643 /// * address.644 #[weight = <SelfWeightOf<T>>::remove_from_white_list()]645 #[transactional]646 pub fn remove_from_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{647648 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);649 let collection = Self::get_collection(collection_id)?;650651 Self::toggle_white_list_internal(652 &sender,653 &collection,654 &address,655 false,656 )?;657658 Ok(())659 }660661 /// Toggle between normal and white list access for the methods with access for `Anyone`.662 ///663 /// # Permissions664 ///665 /// * Collection Owner.666 ///667 /// # Arguments668 ///669 /// * collection_id.670 ///671 /// * mode: [AccessMode]672 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]673 #[transactional]674 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult675 {676 let sender = ensure_signed(origin)?;677678 let mut target_collection = Self::get_collection(collection_id)?;679 Self::check_owner_permissions(&target_collection, &sender)?;680 target_collection.access = mode;681 target_collection.save()682 }683684 /// Allows Anyone to create tokens if:685 /// * White List is enabled, and686 /// * Address is added to white list, and687 /// * This method was called with True parameter688 ///689 /// # Permissions690 /// * Collection Owner691 ///692 /// # Arguments693 ///694 /// * collection_id.695 ///696 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.697 #[weight = <SelfWeightOf<T>>::set_mint_permission()]698 #[transactional]699 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult700 {701 let sender = ensure_signed(origin)?;702703 let mut target_collection = Self::get_collection(collection_id)?;704 Self::check_owner_permissions(&target_collection, &sender)?;705 target_collection.mint_mode = mint_permission;706 target_collection.save()707 }708709 /// Change the owner of the collection.710 ///711 /// # Permissions712 ///713 /// * Collection Owner.714 ///715 /// # Arguments716 ///717 /// * collection_id.718 ///719 /// * new_owner.720 #[weight = <SelfWeightOf<T>>::change_collection_owner()]721 #[transactional]722 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {723724 let sender = ensure_signed(origin)?;725 let mut target_collection = Self::get_collection(collection_id)?;726 Self::check_owner_permissions(&target_collection, &sender)?;727 target_collection.owner = new_owner;728 target_collection.save()729 }730731 /// Adds an admin of the Collection.732 /// NFT Collection can be controlled by multiple admin addresses (some which can also be servers, for example). Admins can issue and burn NFTs, as well as add and remove other admins, but cannot change NFT or Collection ownership.733 ///734 /// # Permissions735 ///736 /// * Collection Owner.737 /// * Collection Admin.738 ///739 /// # Arguments740 ///741 /// * collection_id: ID of the Collection to add admin for.742 ///743 /// * new_admin_id: Address of new admin to add.744 #[weight = <SelfWeightOf<T>>::add_collection_admin()]745 #[transactional]746 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {747 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);748 let collection = Self::get_collection(collection_id)?;749 Self::check_owner_or_admin_permissions(&collection, &sender)?;750 let mut admin_arr = <AdminList<T>>::get(collection_id);751752 match admin_arr.binary_search(&new_admin_id) {753 Ok(_) => {},754 Err(idx) => {755 ensure!(admin_arr.len() < COLLECTION_ADMINS_LIMIT as usize, Error::<T>::CollectionAdminsLimitExceeded);756 admin_arr.insert(idx, new_admin_id);757 <AdminList<T>>::insert(collection_id, admin_arr);758 }759 }760 Ok(())761 }762763 /// Remove admin address of the Collection. An admin address can remove itself. List of admins may become empty, in which case only Collection Owner will be able to add an Admin.764 ///765 /// # Permissions766 ///767 /// * Collection Owner.768 /// * Collection Admin.769 ///770 /// # Arguments771 ///772 /// * collection_id: ID of the Collection to remove admin for.773 ///774 /// * account_id: Address of admin to remove.775 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]776 #[transactional]777 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {778 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);779 let collection = Self::get_collection(collection_id)?;780 Self::check_owner_or_admin_permissions(&collection, &sender)?;781 let mut admin_arr = <AdminList<T>>::get(collection_id);782783 if let Ok(idx) = admin_arr.binary_search(&account_id) {784 admin_arr.remove(idx);785 <AdminList<T>>::insert(collection_id, admin_arr);786 }787 Ok(())788 }789790 /// # Permissions791 ///792 /// * Collection Owner793 ///794 /// # Arguments795 ///796 /// * collection_id.797 ///798 /// * new_sponsor.799 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]800 #[transactional]801 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {802 let sender = ensure_signed(origin)?;803 let mut target_collection = Self::get_collection(collection_id)?;804 Self::check_owner_permissions(&target_collection, &sender)?;805806 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor);807 target_collection.save()808 }809810 /// # Permissions811 ///812 /// * Sponsor.813 ///814 /// # Arguments815 ///816 /// * collection_id.817 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]818 #[transactional]819 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {820 let sender = ensure_signed(origin)?;821822 let mut target_collection = Self::get_collection(collection_id)?;823 ensure!(824 target_collection.sponsorship.pending_sponsor() == Some(&sender),825 Error::<T>::ConfirmUnsetSponsorFail826 );827828 target_collection.sponsorship = SponsorshipState::Confirmed(sender);829 target_collection.save()830 }831832 /// Switch back to pay-per-own-transaction model.833 ///834 /// # Permissions835 ///836 /// * Collection owner.837 ///838 /// # Arguments839 ///840 /// * collection_id.841 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]842 #[transactional]843 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {844 let sender = ensure_signed(origin)?;845846 let mut target_collection = Self::get_collection(collection_id)?;847 Self::check_owner_permissions(&target_collection, &sender)?;848849 target_collection.sponsorship = SponsorshipState::Disabled;850 target_collection.save()851 }852853 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.854 ///855 /// # Permissions856 ///857 /// * Collection Owner.858 /// * Collection Admin.859 /// * Anyone if860 /// * White List is enabled, and861 /// * Address is added to white list, and862 /// * MintPermission is enabled (see SetMintPermission method)863 ///864 /// # Arguments865 ///866 /// * collection_id: ID of the collection.867 ///868 /// * owner: Address, initial owner of the NFT.869 ///870 /// * data: Token data to store on chain.871 // #[weight =872 // (130_000_000 as Weight)873 // .saturating_add((2135 as Weight).saturating_mul((properties.len() as u64) as Weight))874 // .saturating_add(RocksDbWeight::get().reads(10 as Weight))875 // .saturating_add(RocksDbWeight::get().writes(8 as Weight))]876877 #[weight = <SelfWeightOf<T>>::create_item(data.data_size() as u32)]878 #[transactional]879 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResult {880 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);881 let collection = Self::get_collection(collection_id)?;882883 Self::create_item_internal(&sender, &collection, &owner, data)?;884885 collection.submit_logs()886 }887888 /// This method creates multiple items in a collection created with CreateCollection method.889 ///890 /// # Permissions891 ///892 /// * Collection Owner.893 /// * Collection Admin.894 /// * Anyone if895 /// * White List is enabled, and896 /// * Address is added to white list, and897 /// * MintPermission is enabled (see SetMintPermission method)898 ///899 /// # Arguments900 ///901 /// * collection_id: ID of the collection.902 ///903 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].904 ///905 /// * owner: Address, initial owner of the NFT.906 #[weight = <SelfWeightOf<T>>::create_multiple_items(items_data.len() as u32)]907 #[transactional]908 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResult {909910 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);911 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);912 let collection = Self::get_collection(collection_id)?;913914 Self::create_multiple_items_internal(&sender, &collection, &owner, items_data)?;915916 collection.submit_logs()917 }918919 // TODO! transaction weight920921 /// Set transfers_enabled value for particular collection922 ///923 /// # Permissions924 ///925 /// * Collection Owner.926 ///927 /// # Arguments928 ///929 /// * collection_id: ID of the collection.930 ///931 /// * value: New flag value.932 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]933 #[transactional]934 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {935936 let sender = ensure_signed(origin)?;937 let mut target_collection = Self::get_collection(collection_id)?;938939 Self::check_owner_permissions(&target_collection, &sender)?;940941 target_collection.transfers_enabled = value;942 target_collection.save()943 }944945 // TODO! transaction weight946 /// Set meta_update_permission value for particular collection947 ///948 /// # Permissions949 ///950 /// * Collection Owner.951 ///952 /// # Arguments953 ///954 /// * collection_id: ID of the collection.955 ///956 /// * value: New flag value.957 #[weight = <T as Config>::WeightInfo::burn_item()]958 #[transactional]959 pub fn set_meta_update_permission_flag(origin, collection_id: CollectionId, value: MetaUpdatePermission) -> DispatchResult {960961 let sender = ensure_signed(origin)?;962 let mut target_collection = Self::get_collection(collection_id)?;963964 ensure!(965 target_collection.meta_update_permission != MetaUpdatePermission::None,966 Error::<T>::MetadataFlagFrozen967 );968 Self::check_owner_permissions(&target_collection, &sender)?;969970 target_collection.meta_update_permission = value;971972 target_collection.save()973 }974975 /// Destroys a concrete instance of NFT.976 ///977 /// # Permissions978 ///979 /// * Collection Owner.980 /// * Collection Admin.981 /// * Current NFT Owner.982 ///983 /// # Arguments984 ///985 /// * collection_id: ID of the collection.986 ///987 /// * item_id: ID of NFT to burn.988 #[weight = <SelfWeightOf<T>>::burn_item()]989 #[transactional]990 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResult {991992 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);993 let target_collection = Self::get_collection(collection_id)?;994995 Self::burn_item_internal(&sender, &target_collection, item_id, value)?;996997 target_collection.submit_logs()998 }9991000 /// Change ownership of the token.1001 ///1002 /// # Permissions1003 ///1004 /// * Collection Owner1005 /// * Collection Admin1006 /// * Current NFT owner1007 ///1008 /// # Arguments1009 ///1010 /// * recipient: Address of token recipient.1011 ///1012 /// * collection_id.1013 ///1014 /// * item_id: ID of the item1015 /// * Non-Fungible Mode: Required.1016 /// * Fungible Mode: Ignored.1017 /// * Re-Fungible Mode: Required.1018 ///1019 /// * value: Amount to transfer.1020 /// * Non-Fungible Mode: Ignored1021 /// * Fungible Mode: Must specify transferred amount1022 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)1023 #[weight = <SelfWeightOf<T>>::transfer()]1024 #[transactional]1025 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResult {1026 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1027 let collection = Self::get_collection(collection_id)?;10281029 Self::transfer_internal(&sender, &recipient, &collection, item_id, value)?;10301031 collection.submit_logs()1032 }10331034 /// Set, change, or remove approved address to transfer the ownership of the NFT.1035 ///1036 /// # Permissions1037 ///1038 /// * Collection Owner1039 /// * Collection Admin1040 /// * Current NFT owner1041 ///1042 /// # Arguments1043 ///1044 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).1045 ///1046 /// * collection_id.1047 ///1048 /// * item_id: ID of the item.1049 #[weight = <SelfWeightOf<T>>::approve()]1050 #[transactional]1051 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResult {1052 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1053 let collection = Self::get_collection(collection_id)?;10541055 Self::approve_internal(&sender, &spender, &collection, item_id, amount)?;10561057 collection.submit_logs()1058 }10591060 /// Change ownership of a NFT on behalf of the owner. See Approve method for additional information. After this method executes, the approval is removed so that the approved address will not be able to transfer this NFT again from this owner.1061 ///1062 /// # Permissions1063 /// * Collection Owner1064 /// * Collection Admin1065 /// * Current NFT owner1066 /// * Address approved by current NFT owner1067 ///1068 /// # Arguments1069 ///1070 /// * from: Address that owns token.1071 ///1072 /// * recipient: Address of token recipient.1073 ///1074 /// * collection_id.1075 ///1076 /// * item_id: ID of the item.1077 ///1078 /// * value: Amount to transfer.1079 #[weight = <SelfWeightOf<T>>::transfer_from()]1080 #[transactional]1081 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResult {1082 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1083 let collection = Self::get_collection(collection_id)?;10841085 Self::transfer_from_internal(&sender, &from, &recipient, &collection, item_id, value)?;10861087 collection.submit_logs()1088 }1089 // #[weight = 0]1090 // // let no_perm_mes = "You do not have permissions to modify this collection";1091 // // ensure!(<ApprovedList<T>>::contains_key((collection_id, item_id)), no_perm_mes);1092 // // let list_itm = <ApprovedList<T>>::get((collection_id, item_id));1093 // // ensure!(list_itm.contains(&new_owner.clone()), no_perm_mes);10941095 // // // on_nft_received call10961097 // // Self::transfer(origin, collection_id, item_id, new_owner)?;10981099 // Ok(())1100 // }11011102 /// Set off-chain data schema.1103 ///1104 /// # Permissions1105 ///1106 /// * Collection Owner1107 /// * Collection Admin1108 ///1109 /// # Arguments1110 ///1111 /// * collection_id.1112 ///1113 /// * schema: String representing the offchain data schema.1114 #[weight = <SelfWeightOf<T>>::set_variable_meta_data(data.len() as u32)]1115 #[transactional]1116 pub fn set_variable_meta_data (1117 origin,1118 collection_id: CollectionId,1119 item_id: TokenId,1120 data: Vec<u8>1121 ) -> DispatchResult {1122 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);11231124 let collection = Self::get_collection(collection_id)?;1125 Self::meta_update_check(&sender, &collection, item_id)?;11261127 Self::set_variable_meta_data_internal(&sender, &collection, item_id, data)?;11281129 Ok(())1130 }11311132 /// Set schema standard1133 /// ImageURL1134 /// Unique1135 ///1136 /// # Permissions1137 ///1138 /// * Collection Owner1139 /// * Collection Admin1140 ///1141 /// # Arguments1142 ///1143 /// * collection_id.1144 ///1145 /// * schema: SchemaVersion: enum1146 #[weight = <SelfWeightOf<T>>::set_schema_version()]1147 #[transactional]1148 pub fn set_schema_version(1149 origin,1150 collection_id: CollectionId,1151 version: SchemaVersion1152 ) -> DispatchResult {1153 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1154 let mut target_collection = Self::get_collection(collection_id)?;1155 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;1156 target_collection.schema_version = version;1157 target_collection.save()1158 }11591160 /// Set off-chain data schema.1161 ///1162 /// # Permissions1163 ///1164 /// * Collection Owner1165 /// * Collection Admin1166 ///1167 /// # Arguments1168 ///1169 /// * collection_id.1170 ///1171 /// * schema: String representing the offchain data schema.1172 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]1173 #[transactional]1174 pub fn set_offchain_schema(1175 origin,1176 collection_id: CollectionId,1177 schema: Vec<u8>1178 ) -> DispatchResult {1179 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1180 let mut target_collection = Self::get_collection(collection_id)?;1181 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;11821183 // check schema limit1184 ensure!(schema.len() as u32 <= OFFCHAIN_SCHEMA_LIMIT, "");11851186 target_collection.offchain_schema = schema;1187 target_collection.save()1188 }11891190 /// Set const on-chain data schema.1191 ///1192 /// # Permissions1193 ///1194 /// * Collection Owner1195 /// * Collection Admin1196 ///1197 /// # Arguments1198 ///1199 /// * collection_id.1200 ///1201 /// * schema: String representing the const on-chain data schema.1202 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1203 #[transactional]1204 pub fn set_const_on_chain_schema (1205 origin,1206 collection_id: CollectionId,1207 schema: Vec<u8>1208 ) -> DispatchResult {1209 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1210 let mut target_collection = Self::get_collection(collection_id)?;1211 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;12121213 // check schema limit1214 ensure!(schema.len() as u32 <= CONST_ON_CHAIN_SCHEMA_LIMIT, "");12151216 target_collection.const_on_chain_schema = schema;1217 target_collection.save()1218 }12191220 /// Set variable on-chain data schema.1221 ///1222 /// # Permissions1223 ///1224 /// * Collection Owner1225 /// * Collection Admin1226 ///1227 /// # Arguments1228 ///1229 /// * collection_id.1230 ///1231 /// * schema: String representing the variable on-chain data schema.1232 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]1233 #[transactional]1234 pub fn set_variable_on_chain_schema (1235 origin,1236 collection_id: CollectionId,1237 schema: Vec<u8>1238 ) -> DispatchResult {1239 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1240 let mut target_collection = Self::get_collection(collection_id)?;1241 Self::check_owner_or_admin_permissions(&target_collection, &sender)?;12421243 // check schema limit1244 ensure!(schema.len() as u32 <= VARIABLE_ON_CHAIN_SCHEMA_LIMIT, "");12451246 target_collection.variable_on_chain_schema = schema;1247 target_collection.save()1248 }12491250 #[weight = <SelfWeightOf<T>>::set_collection_limits()]1251 #[transactional]1252 pub fn set_collection_limits(1253 origin,1254 collection_id: u32,1255 new_limits: CollectionLimits<T::BlockNumber>,1256 ) -> DispatchResult {1257 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);1258 let mut target_collection = Self::get_collection(collection_id)?;1259 Self::check_owner_permissions(&target_collection, sender.as_sub())?;1260 let old_limits = &target_collection.limits;12611262 // collection bounds1263 ensure!(new_limits.sponsor_transfer_timeout <= MAX_SPONSOR_TIMEOUT &&1264 new_limits.account_token_ownership_limit <= MAX_TOKEN_OWNERSHIP &&1265 new_limits.sponsored_data_size <= CUSTOM_DATA_LIMIT,1266 Error::<T>::CollectionLimitBoundsExceeded);12671268 // token_limit check prev1269 ensure!(old_limits.token_limit >= new_limits.token_limit, Error::<T>::CollectionTokenLimitExceeded);1270 ensure!(new_limits.token_limit > 0, Error::<T>::CollectionTokenLimitExceeded);12711272 ensure!(1273 (old_limits.owner_can_transfer || !new_limits.owner_can_transfer) &&1274 (old_limits.owner_can_destroy || !new_limits.owner_can_destroy),1275 Error::<T>::OwnerPermissionsCantBeReverted,1276 );12771278 target_collection.limits = new_limits;12791280 target_collection.save()1281 }1282 }1283}12841285impl<T: Config> Module<T> {1286 pub fn create_item_internal(1287 sender: &T::CrossAccountId,1288 collection: &CollectionHandle<T>,1289 owner: &T::CrossAccountId,1290 data: CreateItemData,1291 ) -> DispatchResult {1292 ensure!(1293 owner != &T::CrossAccountId::from_eth(H160([0; 20])),1294 Error::<T>::AddressIsZero1295 );12961297 Self::can_create_items_in_collection(collection, sender, owner, 1)?;1298 Self::validate_create_item_args(collection, &data)?;1299 Self::create_item_no_validation(collection, owner, data)?;13001301 Ok(())1302 }13031304 pub fn transfer_internal(1305 sender: &T::CrossAccountId,1306 recipient: &T::CrossAccountId,1307 target_collection: &CollectionHandle<T>,1308 item_id: TokenId,1309 value: u128,1310 ) -> DispatchResult {1311 ensure!(1312 recipient != &T::CrossAccountId::from_eth(H160([0; 20])),1313 Error::<T>::AddressIsZero1314 );13151316 // Limits check1317 Self::is_correct_transfer(target_collection, recipient)?;13181319 // Transfer permissions check1320 ensure!(1321 Self::is_item_owner(sender, target_collection, item_id)?1322 || Self::is_owner_or_admin_permissions(target_collection, sender)?,1323 Error::<T>::NoPermission1324 );13251326 if target_collection.access == AccessMode::WhiteList {1327 Self::check_white_list(target_collection, sender)?;1328 Self::check_white_list(target_collection, recipient)?;1329 }13301331 match target_collection.mode {1332 CollectionMode::NFT => Self::transfer_nft(1333 target_collection,1334 item_id,1335 sender.clone(),1336 recipient.clone(),1337 )?,1338 CollectionMode::Fungible(_) => {1339 Self::transfer_fungible(target_collection, value, sender, recipient)?1340 }1341 CollectionMode::ReFungible => Self::transfer_refungible(1342 target_collection,1343 item_id,1344 value,1345 sender.clone(),1346 recipient.clone(),1347 )?,1348 };13491350 Self::deposit_event(RawEvent::Transfer(1351 target_collection.id,1352 item_id,1353 sender.clone(),1354 recipient.clone(),1355 value,1356 ));13571358 Ok(())1359 }13601361 pub fn approve_internal(1362 sender: &T::CrossAccountId,1363 spender: &T::CrossAccountId,1364 collection: &CollectionHandle<T>,1365 item_id: TokenId,1366 amount: u128,1367 ) -> DispatchResult {1368 Self::token_exists(collection, item_id)?;13691370 // Transfer permissions check1371 let bypasses_limits = collection.limits.owner_can_transfer1372 && Self::is_owner_or_admin_permissions(collection, sender)?;13731374 let allowance_limit = if bypasses_limits {1375 None1376 } else if let Some(amount) = Self::owned_amount(sender, collection, item_id)? {1377 Some(amount)1378 } else {1379 fail!(Error::<T>::NoPermission);1380 };13811382 if collection.access == AccessMode::WhiteList {1383 Self::check_white_list(collection, sender)?;1384 Self::check_white_list(collection, spender)?;1385 }13861387 collection.consume_sload()?;1388 let allowance: u128 = amount1389 .checked_add(<Allowances<T>>::get(1390 collection.id,1391 (item_id, sender.as_sub(), spender.as_sub()),1392 ))1393 .ok_or(Error::<T>::NumOverflow)?;1394 if let Some(limit) = allowance_limit {1395 ensure!(limit >= allowance, Error::<T>::TokenValueTooLow);1396 }1397 collection.consume_sstore()?;1398 <Allowances<T>>::insert(1399 collection.id,1400 (item_id, sender.as_sub(), spender.as_sub()),1401 allowance,1402 );14031404 if matches!(collection.mode, CollectionMode::NFT) {1405 // TODO: NFT: only one owner may exist for token in ERC7211406 collection.log(ERC721Events::Approval {1407 owner: *sender.as_eth(),1408 approved: *spender.as_eth(),1409 token_id: item_id.into(),1410 })?;1411 }14121413 if matches!(collection.mode, CollectionMode::Fungible(_)) {1414 // TODO: NFT: only one owner may exist for token in ERC201415 collection.log(ERC20Events::Approval {1416 owner: *sender.as_eth(),1417 spender: *spender.as_eth(),1418 value: allowance.into(),1419 })?;1420 }14211422 Self::deposit_event(RawEvent::Approved(1423 collection.id,1424 item_id,1425 sender.clone(),1426 spender.clone(),1427 allowance,1428 ));1429 Ok(())1430 }14311432 pub fn transfer_from_internal(1433 sender: &T::CrossAccountId,1434 from: &T::CrossAccountId,1435 recipient: &T::CrossAccountId,1436 collection: &CollectionHandle<T>,1437 item_id: TokenId,1438 amount: u128,1439 ) -> DispatchResult {1440 if sender == from {1441 // Transfer by `from`, because it is either equal to sender, or derived from him1442 return Self::transfer_internal(from, recipient, collection, item_id, amount);1443 }14441445 // Check approval1446 collection.consume_sload()?;1447 let approval: u128 =1448 <Allowances<T>>::get(collection.id, (item_id, from.as_sub(), sender.as_sub()));14491450 // Limits check1451 Self::is_correct_transfer(collection, recipient)?;14521453 // Transfer permissions check1454 ensure!(1455 approval >= amount1456 || (collection.limits.owner_can_transfer1457 && Self::is_owner_or_admin_permissions(collection, sender)?),1458 Error::<T>::NoPermission1459 );14601461 if collection.access == AccessMode::WhiteList {1462 Self::check_white_list(collection, sender)?;1463 Self::check_white_list(collection, recipient)?;1464 }14651466 // Reduce approval by transferred amount or remove if remaining approval drops to 01467 let allowance = approval.saturating_sub(amount);1468 collection.consume_sstore()?;1469 if allowance > 0 {1470 <Allowances<T>>::insert(1471 collection.id,1472 (item_id, from.as_sub(), sender.as_sub()),1473 allowance,1474 );1475 } else {1476 <Allowances<T>>::remove(collection.id, (item_id, from.as_sub(), sender.as_sub()));1477 }14781479 match collection.mode {1480 CollectionMode::NFT => {1481 Self::transfer_nft(collection, item_id, from.clone(), recipient.clone())?1482 }1483 CollectionMode::Fungible(_) => {1484 Self::transfer_fungible(collection, amount, from, recipient)?1485 }1486 CollectionMode::ReFungible => Self::transfer_refungible(1487 collection,1488 item_id,1489 amount,1490 from.clone(),1491 recipient.clone(),1492 )?,1493 };14941495 if matches!(collection.mode, CollectionMode::Fungible(_)) {1496 collection.log(ERC20Events::Approval {1497 owner: *from.as_eth(),1498 spender: *sender.as_eth(),1499 value: allowance.into(),1500 })?;1501 }15021503 Ok(())1504 }15051506 pub fn set_variable_meta_data_internal(1507 sender: &T::CrossAccountId,1508 collection: &CollectionHandle<T>,1509 item_id: TokenId,1510 data: Vec<u8>,1511 ) -> DispatchResult {1512 Self::token_exists(collection, item_id)?;15131514 ensure!(1515 CUSTOM_DATA_LIMIT >= data.len() as u32,1516 Error::<T>::TokenVariableDataLimitExceeded1517 );15181519 ensure!(1520 (Self::is_item_owner(sender, collection, item_id)?1521 && collection.meta_update_permission == MetaUpdatePermission::ItemOwner)1522 || (Self::is_owner_or_admin_permissions(collection, sender)?1523 && collection.meta_update_permission == MetaUpdatePermission::Admin),1524 Error::<T>::NoPermission1525 );15261527 match collection.mode {1528 CollectionMode::NFT => Self::set_nft_variable_data(collection, item_id, data)?,1529 CollectionMode::ReFungible => {1530 Self::set_re_fungible_variable_data(collection, item_id, data)?1531 }1532 CollectionMode::Fungible(_) => fail!(Error::<T>::CantStoreMetadataInFungibleTokens),1533 };15341535 Ok(())1536 }15371538 pub fn meta_update_check(1539 sender: &T::CrossAccountId,1540 collection: &CollectionHandle<T>,1541 item_id: TokenId,1542 ) -> DispatchResult {1543 match collection.meta_update_permission {1544 MetaUpdatePermission::ItemOwner => ensure!(1545 Self::is_item_owner(sender, collection, item_id)?,1546 Error::<T>::NoPermission1547 ),1548 MetaUpdatePermission::Admin => ensure!(1549 Self::is_owner_or_admin_permissions(collection, sender)?,1550 Error::<T>::NoPermission1551 ),1552 MetaUpdatePermission::None => fail!(Error::<T>::MetadataUpdateDenied),1553 }15541555 Ok(())1556 }15571558 pub fn get_variable_metadata(1559 collection: &CollectionHandle<T>,1560 item_id: TokenId,1561 ) -> Result<Vec<u8>, DispatchError> {1562 Ok(match collection.mode {1563 CollectionMode::NFT => {1564 <NftItemList<T>>::get(collection.id, item_id)1565 .ok_or(Error::<T>::TokenNotFound)?1566 .variable_data1567 }1568 CollectionMode::ReFungible => {1569 <ReFungibleItemList<T>>::get(collection.id, item_id)1570 .ok_or(Error::<T>::TokenNotFound)?1571 .variable_data1572 }1573 _ => fail!(Error::<T>::UnexpectedCollectionType),1574 })1575 }15761577 pub fn create_multiple_items_internal(1578 sender: &T::CrossAccountId,1579 collection: &CollectionHandle<T>,1580 owner: &T::CrossAccountId,1581 items_data: Vec<CreateItemData>,1582 ) -> DispatchResult {1583 Self::can_create_items_in_collection(collection, sender, owner, items_data.len() as u32)?;15841585 for data in &items_data {1586 Self::validate_create_item_args(collection, data)?;1587 }1588 for data in &items_data {1589 Self::create_item_no_validation(collection, owner, data.clone())?;1590 }15911592 Ok(())1593 }15941595 pub fn burn_item_internal(1596 sender: &T::CrossAccountId,1597 collection: &CollectionHandle<T>,1598 item_id: TokenId,1599 value: u128,1600 ) -> DispatchResult {1601 ensure!(1602 Self::is_item_owner(sender, collection, item_id)?1603 || (collection.limits.owner_can_transfer1604 && Self::is_owner_or_admin_permissions(collection, sender)?),1605 Error::<T>::NoPermission1606 );16071608 if collection.access == AccessMode::WhiteList {1609 Self::check_white_list(collection, sender)?;1610 }16111612 match collection.mode {1613 CollectionMode::NFT => Self::burn_nft_item(collection, item_id)?,1614 CollectionMode::Fungible(_) => Self::burn_fungible_item(sender, collection, value)?,1615 CollectionMode::ReFungible => Self::burn_refungible_item(collection, item_id, sender)?,1616 };16171618 Ok(())1619 }16201621 pub fn toggle_white_list_internal(1622 sender: &T::CrossAccountId,1623 collection: &CollectionHandle<T>,1624 address: &T::CrossAccountId,1625 whitelisted: bool,1626 ) -> DispatchResult {1627 Self::check_owner_or_admin_permissions(collection, sender)?;16281629 if whitelisted {1630 <WhiteList<T>>::insert(collection.id, address.as_sub(), true);1631 } else {1632 <WhiteList<T>>::remove(collection.id, address.as_sub());1633 }16341635 Ok(())1636 }16371638 fn is_correct_transfer(1639 collection: &CollectionHandle<T>,1640 recipient: &T::CrossAccountId,1641 ) -> DispatchResult {1642 let collection_id = collection.id;16431644 // check token limit and account token limit1645 collection.consume_sload()?;1646 let account_items: u32 =1647 <AddressTokens<T>>::get(collection_id, recipient.as_sub()).len() as u32;16481649 // zero limit means collection limit is disabled1650 // otherwise get lower value1651 let limit = if collection.limits.account_token_ownership_limit == 01652 || collection.limits.account_token_ownership_limit > ACCOUNT_TOKEN_OWNERSHIP_LIMIT1653 {1654 ACCOUNT_TOKEN_OWNERSHIP_LIMIT1655 } else {1656 collection.limits.account_token_ownership_limit1657 };16581659 ensure!(limit > account_items, Error::<T>::AccountTokenLimitExceeded);16601661 // preliminary transfer check1662 ensure!(collection.transfers_enabled, Error::<T>::TransferNotAllowed);16631664 Ok(())1665 }16661667 fn can_create_items_in_collection(1668 collection: &CollectionHandle<T>,1669 sender: &T::CrossAccountId,1670 owner: &T::CrossAccountId,1671 amount: u32,1672 ) -> DispatchResult {1673 let collection_id = collection.id;16741675 // check token limit and account token limit1676 let total_items: u32 = ItemListIndex::get(collection_id)1677 .checked_add(amount)1678 .ok_or(Error::<T>::CollectionTokenLimitExceeded)?;1679 let account_items: u32 = (<AddressTokens<T>>::get(collection_id, owner.as_sub()).len()1680 as u32)1681 .checked_add(amount)1682 .ok_or(Error::<T>::AccountTokenLimitExceeded)?;16831684 // zero limit means collection limit is disabled1685 // otherwise get lower value1686 let account_token_limit = if collection.limits.account_token_ownership_limit == 01687 || collection.limits.account_token_ownership_limit > ACCOUNT_TOKEN_OWNERSHIP_LIMIT1688 {1689 ACCOUNT_TOKEN_OWNERSHIP_LIMIT1690 } else {1691 collection.limits.account_token_ownership_limit1692 };16931694 ensure!(1695 collection.limits.token_limit >= total_items,1696 Error::<T>::CollectionTokenLimitExceeded1697 );1698 ensure!(1699 account_token_limit >= account_items,1700 Error::<T>::AccountTokenLimitExceeded1701 );17021703 if !Self::is_owner_or_admin_permissions(collection, sender)? {1704 ensure!(collection.mint_mode, Error::<T>::PublicMintingNotAllowed);1705 Self::check_white_list(collection, owner)?;1706 Self::check_white_list(collection, sender)?;1707 }17081709 Ok(())1710 }17111712 fn validate_create_item_args(1713 target_collection: &CollectionHandle<T>,1714 data: &CreateItemData,1715 ) -> DispatchResult {1716 match target_collection.mode {1717 CollectionMode::NFT => {1718 if !matches!(data, CreateItemData::NFT(_)) {1719 fail!(Error::<T>::NotNftDataUsedToMintNftCollectionToken);1720 }1721 }1722 CollectionMode::Fungible(_) => {1723 if !matches!(data, CreateItemData::Fungible(_)) {1724 fail!(Error::<T>::NotFungibleDataUsedToMintFungibleCollectionToken);1725 }1726 }1727 CollectionMode::ReFungible => {1728 if let CreateItemData::ReFungible(data) = data {1729 // Check refungibility limits1730 ensure!(1731 data.pieces <= MAX_REFUNGIBLE_PIECES,1732 Error::<T>::WrongRefungiblePieces1733 );1734 ensure!(data.pieces > 0, Error::<T>::WrongRefungiblePieces);1735 } else {1736 fail!(Error::<T>::NotReFungibleDataUsedToMintReFungibleCollectionToken);1737 }1738 }1739 };17401741 Ok(())1742 }17431744 fn create_item_no_validation(1745 collection: &CollectionHandle<T>,1746 owner: &T::CrossAccountId,1747 data: CreateItemData,1748 ) -> DispatchResult {1749 match data {1750 CreateItemData::NFT(data) => {1751 let item = NftItemType {1752 owner: owner.clone(),1753 const_data: data.const_data.into_inner(),1754 variable_data: data.variable_data.into_inner(),1755 };17561757 Self::add_nft_item(collection, item)?;1758 }1759 CreateItemData::Fungible(data) => {1760 Self::add_fungible_item(collection, owner, data.value)?;1761 }1762 CreateItemData::ReFungible(data) => {1763 let owner_list = vec![Ownership {1764 owner: owner.clone(),1765 fraction: data.pieces,1766 }];17671768 let item = ReFungibleItemType {1769 owner: owner_list,1770 const_data: data.const_data.into_inner(),1771 variable_data: data.variable_data.into_inner(),1772 };17731774 Self::add_refungible_item(collection, item)?;1775 }1776 };17771778 Ok(())1779 }17801781 fn add_fungible_item(1782 collection: &CollectionHandle<T>,1783 owner: &T::CrossAccountId,1784 value: u128,1785 ) -> DispatchResult {1786 let collection_id = collection.id;17871788 // Does new owner already have an account?1789 collection.consume_sload()?;1790 let balance: u128 = <FungibleItemList<T>>::get(collection_id, owner.as_sub()).value;17911792 // Mint1793 let item = FungibleItemType {1794 value: balance.checked_add(value).ok_or(Error::<T>::NumOverflow)?,1795 };1796 collection.consume_sstore()?;1797 <FungibleItemList<T>>::insert(collection_id, owner.as_sub(), item);17981799 // Update balance1800 collection.consume_sload()?;1801 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())1802 .checked_add(value)1803 .ok_or(Error::<T>::NumOverflow)?;1804 collection.consume_sstore()?;1805 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);18061807 collection.log(ERC20Events::Transfer {1808 from: H160::default(),1809 to: *owner.as_eth(),1810 value: value.into(),1811 })?;1812 Self::deposit_event(RawEvent::ItemCreated(collection_id, 0, owner.clone()));1813 Ok(())1814 }18151816 fn add_refungible_item(1817 collection: &CollectionHandle<T>,1818 item: ReFungibleItemType<T::CrossAccountId>,1819 ) -> DispatchResult {1820 let collection_id = collection.id;18211822 let current_index = <ItemListIndex>::get(collection_id)1823 .checked_add(1)1824 .ok_or(Error::<T>::NumOverflow)?;1825 let itemcopy = item.clone();18261827 ensure!(item.owner.len() == 1, Error::<T>::BadCreateRefungibleCall,);1828 let item_owner = item.owner.first().expect("only one owner is defined");18291830 let value = item_owner.fraction;1831 let owner = item_owner.owner.clone();18321833 Self::add_token_index(collection, current_index, &owner)?;18341835 <ItemListIndex>::insert(collection_id, current_index);1836 <ReFungibleItemList<T>>::insert(collection_id, current_index, itemcopy);18371838 // Update balance1839 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())1840 .checked_add(value)1841 .ok_or(Error::<T>::NumOverflow)?;1842 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);18431844 Self::deposit_event(RawEvent::ItemCreated(collection_id, current_index, owner));1845 Ok(())1846 }18471848 fn add_nft_item(1849 collection: &CollectionHandle<T>,1850 item: NftItemType<T::CrossAccountId>,1851 ) -> DispatchResult {1852 let collection_id = collection.id;18531854 let current_index = <ItemListIndex>::get(collection_id)1855 .checked_add(1)1856 .ok_or(Error::<T>::NumOverflow)?;18571858 let item_owner = item.owner.clone();1859 Self::add_token_index(collection, current_index, &item.owner)?;18601861 <ItemListIndex>::insert(collection_id, current_index);1862 <NftItemList<T>>::insert(collection_id, current_index, item);18631864 // Update balance1865 let new_balance = <Balance<T>>::get(collection_id, item_owner.as_sub())1866 .checked_add(1)1867 .ok_or(Error::<T>::NumOverflow)?;1868 <Balance<T>>::insert(collection_id, item_owner.as_sub(), new_balance);18691870 collection.log(ERC721Events::Transfer {1871 from: H160::default(),1872 to: *item_owner.as_eth(),1873 token_id: current_index.into(),1874 })?;1875 Self::deposit_event(RawEvent::ItemCreated(1876 collection_id,1877 current_index,1878 item_owner,1879 ));1880 Ok(())1881 }18821883 fn burn_refungible_item(1884 collection: &CollectionHandle<T>,1885 item_id: TokenId,1886 owner: &T::CrossAccountId,1887 ) -> DispatchResult {1888 let collection_id = collection.id;18891890 let mut token = <ReFungibleItemList<T>>::get(collection_id, item_id)1891 .ok_or(Error::<T>::TokenNotFound)?;1892 let rft_balance = token1893 .owner1894 .iter()1895 .find(|&i| i.owner == *owner)1896 .ok_or(Error::<T>::TokenNotFound)?;1897 Self::remove_token_index(collection, item_id, owner)?;18981899 // update balance1900 let new_balance = <Balance<T>>::get(collection_id, rft_balance.owner.as_sub())1901 .checked_sub(rft_balance.fraction)1902 .ok_or(Error::<T>::NumOverflow)?;1903 <Balance<T>>::insert(collection_id, rft_balance.owner.as_sub(), new_balance);19041905 // Re-create owners list with sender removed1906 let index = token1907 .owner1908 .iter()1909 .position(|i| i.owner == *owner)1910 .expect("owned item is exists");1911 token.owner.remove(index);1912 let owner_count = token.owner.len();19131914 // Burn the token completely if this was the last (only) owner1915 if owner_count == 0 {1916 <ReFungibleItemList<T>>::remove(collection_id, item_id);1917 <VariableMetaDataBasket<T>>::remove(collection_id, item_id);1918 } else {1919 <ReFungibleItemList<T>>::insert(collection_id, item_id, token);1920 }19211922 Ok(())1923 }19241925 fn burn_nft_item(collection: &CollectionHandle<T>, item_id: TokenId) -> DispatchResult {1926 let collection_id = collection.id;19271928 let item =1929 <NftItemList<T>>::get(collection_id, item_id).ok_or(Error::<T>::TokenNotFound)?;1930 Self::remove_token_index(collection, item_id, &item.owner)?;19311932 // update balance1933 let new_balance = <Balance<T>>::get(collection_id, item.owner.as_sub())1934 .checked_sub(1)1935 .ok_or(Error::<T>::NumOverflow)?;1936 <Balance<T>>::insert(collection_id, item.owner.as_sub(), new_balance);1937 <NftItemList<T>>::remove(collection_id, item_id);1938 <VariableMetaDataBasket<T>>::remove(collection_id, item_id);19391940 collection.log(ERC721Events::Transfer {1941 from: *item.owner.as_eth(),1942 to: H160::default(),1943 token_id: item_id.into(),1944 })?;1945 Self::deposit_event(RawEvent::ItemDestroyed(collection.id, item_id));1946 Ok(())1947 }19481949 fn burn_fungible_item(1950 owner: &T::CrossAccountId,1951 collection: &CollectionHandle<T>,1952 value: u128,1953 ) -> DispatchResult {1954 let collection_id = collection.id;19551956 let mut balance = <FungibleItemList<T>>::get(collection_id, owner.as_sub());1957 ensure!(balance.value >= value, Error::<T>::TokenValueNotEnough);19581959 // update balance1960 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())1961 .checked_sub(value)1962 .ok_or(Error::<T>::NumOverflow)?;1963 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);19641965 if balance.value - value > 0 {1966 balance.value -= value;1967 <FungibleItemList<T>>::insert(collection_id, owner.as_sub(), balance);1968 } else {1969 <FungibleItemList<T>>::remove(collection_id, owner.as_sub());1970 }19711972 collection.log(ERC20Events::Transfer {1973 from: *owner.as_eth(),1974 to: H160::default(),1975 value: value.into(),1976 })?;1977 Ok(())1978 }19791980 pub fn get_collection(1981 collection_id: CollectionId,1982 ) -> Result<CollectionHandle<T>, sp_runtime::DispatchError> {1983 Ok(<CollectionHandle<T>>::get(collection_id).ok_or(Error::<T>::CollectionNotFound)?)1984 }19851986 fn check_owner_permissions(1987 target_collection: &CollectionHandle<T>,1988 subject: &T::AccountId,1989 ) -> DispatchResult {1990 ensure!(1991 *subject == target_collection.owner,1992 Error::<T>::NoPermission1993 );19941995 Ok(())1996 }19971998 fn is_owner_or_admin_permissions(1999 collection: &CollectionHandle<T>,2000 subject: &T::CrossAccountId,2001 ) -> Result<bool, DispatchError> {2002 collection.consume_sload()?;2003 Ok(*subject.as_sub() == collection.owner2004 || <AdminList<T>>::get(collection.id).contains(subject))2005 }20062007 fn check_owner_or_admin_permissions(2008 collection: &CollectionHandle<T>,2009 subject: &T::CrossAccountId,2010 ) -> DispatchResult {2011 ensure!(2012 Self::is_owner_or_admin_permissions(collection, subject)?,2013 Error::<T>::NoPermission2014 );20152016 Ok(())2017 }20182019 fn owned_amount(2020 subject: &T::CrossAccountId,2021 collection: &CollectionHandle<T>,2022 item_id: TokenId,2023 ) -> Result<Option<u128>, DispatchError> {2024 collection.consume_sload()?;2025 Ok(Self::owned_amount_unchecked(subject, collection, item_id))2026 }20272028 fn owned_amount_unchecked(2029 subject: &T::CrossAccountId,2030 target_collection: &CollectionHandle<T>,2031 item_id: TokenId,2032 ) -> Option<u128> {2033 let collection_id = target_collection.id;20342035 match target_collection.mode {2036 CollectionMode::NFT => {2037 (<NftItemList<T>>::get(collection_id, item_id)?.owner == *subject).then(|| 1)2038 }2039 CollectionMode::Fungible(_) => {2040 Some(<FungibleItemList<T>>::get(collection_id, &subject.as_sub()).value)2041 }2042 CollectionMode::ReFungible => <ReFungibleItemList<T>>::get(collection_id, item_id)?2043 .owner2044 .iter()2045 .find(|i| i.owner == *subject)2046 .map(|i| i.fraction),2047 }2048 }20492050 fn is_item_owner(2051 subject: &T::CrossAccountId,2052 target_collection: &CollectionHandle<T>,2053 item_id: TokenId,2054 ) -> Result<bool, DispatchError> {2055 Ok(match target_collection.mode {2056 CollectionMode::Fungible(_) => true,2057 _ => Self::owned_amount(subject, target_collection, item_id)?.is_some(),2058 })2059 }20602061 fn check_white_list(2062 collection: &CollectionHandle<T>,2063 address: &T::CrossAccountId,2064 ) -> DispatchResult {2065 collection.consume_sload()?;2066 ensure!(2067 <WhiteList<T>>::contains_key(collection.id, address.as_sub()),2068 Error::<T>::AddresNotInWhiteList,2069 );2070 Ok(())2071 }20722073 /// Check if token exists. In case of Fungible, check if there is an entry for2074 /// the owner in fungible balances double map2075 fn token_exists(target_collection: &CollectionHandle<T>, item_id: TokenId) -> DispatchResult {2076 let collection_id = target_collection.id;2077 let exists = match target_collection.mode {2078 CollectionMode::NFT => <NftItemList<T>>::contains_key(collection_id, item_id),2079 CollectionMode::Fungible(_) => true,2080 CollectionMode::ReFungible => {2081 <ReFungibleItemList<T>>::contains_key(collection_id, item_id)2082 }2083 };20842085 ensure!(exists, Error::<T>::TokenNotFound);2086 Ok(())2087 }20882089 fn transfer_fungible(2090 collection: &CollectionHandle<T>,2091 value: u128,2092 owner: &T::CrossAccountId,2093 recipient: &T::CrossAccountId,2094 ) -> DispatchResult {2095 let collection_id = collection.id;20962097 collection.consume_sload()?;2098 collection.consume_sload()?;2099 let mut recipient_balance = <FungibleItemList<T>>::get(collection_id, recipient.as_sub());2100 let mut balance = <FungibleItemList<T>>::get(collection_id, owner.as_sub());21012102 recipient_balance.value = recipient_balance2103 .value2104 .checked_add(value)2105 .ok_or(Error::<T>::NumOverflow)?;2106 balance.value = balance2107 .value2108 .checked_sub(value)2109 .ok_or(Error::<T>::TokenValueTooLow)?;21102111 // update balanceOf2112 collection.consume_sstore()?;2113 collection.consume_sstore()?;2114 if balance.value != 0 {2115 <Balance<T>>::insert(collection_id, owner.as_sub(), balance.value);2116 } else {2117 <Balance<T>>::remove(collection_id, owner.as_sub());2118 }2119 <Balance<T>>::insert(collection_id, recipient.as_sub(), recipient_balance.value);21202121 // Reduce or remove sender2122 collection.consume_sstore()?;2123 collection.consume_sstore()?;2124 if balance.value != 0 {2125 <FungibleItemList<T>>::insert(collection_id, owner.as_sub(), balance);2126 } else {2127 <FungibleItemList<T>>::remove(collection_id, owner.as_sub());2128 }2129 <FungibleItemList<T>>::insert(collection_id, recipient.as_sub(), recipient_balance);21302131 collection.log(ERC20Events::Transfer {2132 from: *owner.as_eth(),2133 to: *recipient.as_eth(),2134 value: value.into(),2135 })?;2136 Self::deposit_event(RawEvent::Transfer(2137 collection.id,2138 1,2139 owner.clone(),2140 recipient.clone(),2141 value,2142 ));21432144 Ok(())2145 }21462147 fn transfer_refungible(2148 collection: &CollectionHandle<T>,2149 item_id: TokenId,2150 value: u128,2151 owner: T::CrossAccountId,2152 new_owner: T::CrossAccountId,2153 ) -> DispatchResult {2154 let collection_id = collection.id;2155 collection.consume_sload()?;2156 let full_item = <ReFungibleItemList<T>>::get(collection_id, item_id)2157 .ok_or(Error::<T>::TokenNotFound)?;21582159 let item = full_item2160 .owner2161 .iter()2162 .find(|i| i.owner == owner)2163 .ok_or(Error::<T>::TokenNotFound)?;2164 let amount = item.fraction;21652166 ensure!(amount >= value, Error::<T>::TokenValueTooLow);21672168 collection.consume_sload()?;2169 // update balance2170 let balance_old_owner = <Balance<T>>::get(collection_id, item.owner.as_sub())2171 .checked_sub(value)2172 .ok_or(Error::<T>::NumOverflow)?;2173 collection.consume_sstore()?;2174 <Balance<T>>::insert(collection_id, item.owner.as_sub(), balance_old_owner);21752176 collection.consume_sload()?;2177 let balance_new_owner = <Balance<T>>::get(collection_id, new_owner.as_sub())2178 .checked_add(value)2179 .ok_or(Error::<T>::NumOverflow)?;2180 collection.consume_sstore()?;2181 <Balance<T>>::insert(collection_id, new_owner.as_sub(), balance_new_owner);21822183 let old_owner = item.owner.clone();2184 let new_owner_has_account = full_item.owner.iter().any(|i| i.owner == new_owner);21852186 let mut new_full_item = full_item.clone();2187 // transfer2188 if amount == value && !new_owner_has_account {2189 // change owner2190 // new owner do not have account2191 new_full_item2192 .owner2193 .iter_mut()2194 .find(|i| i.owner == owner)2195 .expect("old owner does present in refungible")2196 .owner = new_owner.clone();2197 collection.consume_sstore()?;2198 <ReFungibleItemList<T>>::insert(collection_id, item_id, new_full_item);21992200 // update index collection2201 Self::move_token_index(collection, item_id, &old_owner, &new_owner)?;2202 } else {2203 new_full_item2204 .owner2205 .iter_mut()2206 .find(|i| i.owner == owner)2207 .expect("old owner does present in refungible")2208 .fraction -= value;22092210 // separate amount2211 if new_owner_has_account {2212 // new owner has account2213 new_full_item2214 .owner2215 .iter_mut()2216 .find(|i| i.owner == new_owner)2217 .expect("new owner has account")2218 .fraction += value;2219 } else {2220 // new owner do not have account2221 new_full_item.owner.push(Ownership {2222 owner: new_owner.clone(),2223 fraction: value,2224 });2225 Self::add_token_index(collection, item_id, &new_owner)?;2226 }22272228 collection.consume_sstore()?;2229 <ReFungibleItemList<T>>::insert(collection_id, item_id, new_full_item);2230 }22312232 Self::deposit_event(RawEvent::Transfer(2233 collection.id,2234 item_id,2235 owner,2236 new_owner,2237 amount,2238 ));22392240 Ok(())2241 }22422243 fn transfer_nft(2244 collection: &CollectionHandle<T>,2245 item_id: TokenId,2246 sender: T::CrossAccountId,2247 new_owner: T::CrossAccountId,2248 ) -> DispatchResult {2249 let collection_id = collection.id;2250 collection.consume_sload()?;2251 let mut item =2252 <NftItemList<T>>::get(collection_id, item_id).ok_or(Error::<T>::TokenNotFound)?;22532254 ensure!(sender == item.owner, Error::<T>::MustBeTokenOwner);22552256 collection.consume_sload()?;2257 // update balance2258 let balance_old_owner = <Balance<T>>::get(collection_id, item.owner.as_sub())2259 .checked_sub(1)2260 .ok_or(Error::<T>::NumOverflow)?;2261 collection.consume_sstore()?;2262 <Balance<T>>::insert(collection_id, item.owner.as_sub(), balance_old_owner);22632264 collection.consume_sload()?;2265 let balance_new_owner = <Balance<T>>::get(collection_id, new_owner.as_sub())2266 .checked_add(1)2267 .ok_or(Error::<T>::NumOverflow)?;2268 collection.consume_sstore()?;2269 <Balance<T>>::insert(collection_id, new_owner.as_sub(), balance_new_owner);22702271 // change owner2272 let old_owner = item.owner.clone();2273 item.owner = new_owner.clone();2274 collection.consume_sstore()?;2275 <NftItemList<T>>::insert(collection_id, item_id, item);22762277 // update index collection2278 Self::move_token_index(collection, item_id, &old_owner, &new_owner)?;22792280 collection.log(ERC721Events::Transfer {2281 from: *sender.as_eth(),2282 to: *new_owner.as_eth(),2283 token_id: item_id.into(),2284 })?;2285 Self::deposit_event(RawEvent::Transfer(2286 collection.id,2287 item_id,2288 sender,2289 new_owner,2290 1,2291 ));22922293 Ok(())2294 }22952296 fn set_re_fungible_variable_data(2297 collection: &CollectionHandle<T>,2298 item_id: TokenId,2299 data: Vec<u8>,2300 ) -> DispatchResult {2301 let collection_id = collection.id;2302 let mut item = <ReFungibleItemList<T>>::get(collection_id, item_id)2303 .ok_or(Error::<T>::TokenNotFound)?;23042305 item.variable_data = data;23062307 <ReFungibleItemList<T>>::insert(collection_id, item_id, item);23082309 Ok(())2310 }23112312 fn set_nft_variable_data(2313 collection: &CollectionHandle<T>,2314 item_id: TokenId,2315 data: Vec<u8>,2316 ) -> DispatchResult {2317 let collection_id = collection.id;2318 let mut item =2319 <NftItemList<T>>::get(collection_id, item_id).ok_or(Error::<T>::TokenNotFound)?;23202321 item.variable_data = data;23222323 <NftItemList<T>>::insert(collection_id, item_id, item);23242325 Ok(())2326 }23272328 #[allow(dead_code)]2329 fn init_collection(item: &Collection<T>) {2330 // check params2331 assert!(2332 item.decimal_points <= MAX_DECIMAL_POINTS,2333 "decimal_points parameter must be lower than MAX_DECIMAL_POINTS"2334 );2335 assert!(2336 item.name.len() <= 64,2337 "Collection name can not be longer than 63 char"2338 );2339 assert!(2340 item.name.len() <= 256,2341 "Collection description can not be longer than 255 char"2342 );2343 assert!(2344 item.token_prefix.len() <= 16,2345 "Token prefix can not be longer than 15 char"2346 );23472348 // Generate next collection ID2349 let next_id = CreatedCollectionCount::get().checked_add(1).unwrap();23502351 CreatedCollectionCount::put(next_id);2352 }23532354 #[allow(dead_code)]2355 fn init_nft_token(collection_id: CollectionId, item: &NftItemType<T::CrossAccountId>) {2356 let current_index = <ItemListIndex>::get(collection_id).checked_add(1).unwrap();23572358 Self::add_token_index(2359 &CollectionHandle::get(collection_id).unwrap(),2360 current_index,2361 &item.owner,2362 )2363 .unwrap();23642365 <ItemListIndex>::insert(collection_id, current_index);23662367 // Update balance2368 let new_balance = <Balance<T>>::get(collection_id, item.owner.as_sub())2369 .checked_add(1)2370 .unwrap();2371 <Balance<T>>::insert(collection_id, item.owner.as_sub(), new_balance);2372 }23732374 #[allow(dead_code)]2375 fn init_fungible_token(2376 collection_id: CollectionId,2377 owner: &T::CrossAccountId,2378 item: &FungibleItemType,2379 ) {2380 let current_index = <ItemListIndex>::get(collection_id).checked_add(1).unwrap();23812382 Self::add_token_index(2383 &CollectionHandle::get(collection_id).unwrap(),2384 current_index,2385 owner,2386 )2387 .unwrap();23882389 <ItemListIndex>::insert(collection_id, current_index);23902391 // Update balance2392 let new_balance = <Balance<T>>::get(collection_id, owner.as_sub())2393 .checked_add(item.value)2394 .unwrap();2395 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);2396 }23972398 #[allow(dead_code)]2399 fn init_refungible_token(2400 collection_id: CollectionId,2401 item: &ReFungibleItemType<T::CrossAccountId>,2402 ) {2403 let current_index = <ItemListIndex>::get(collection_id).checked_add(1).unwrap();24042405 let value = item.owner.first().unwrap().fraction;2406 let owner = item.owner.first().unwrap().owner.clone();24072408 Self::add_token_index(2409 &CollectionHandle::get(collection_id).unwrap(),2410 current_index,2411 &owner,2412 )2413 .unwrap();24142415 <ItemListIndex>::insert(collection_id, current_index);24162417 // Update balance2418 let new_balance = <Balance<T>>::get(collection_id, &owner.as_sub())2419 .checked_add(value)2420 .unwrap();2421 <Balance<T>>::insert(collection_id, owner.as_sub(), new_balance);2422 }24232424 fn add_token_index(2425 collection: &CollectionHandle<T>,2426 item_index: TokenId,2427 owner: &T::CrossAccountId,2428 ) -> DispatchResult {2429 collection.consume_sload()?;2430 let list_exists = <AddressTokens<T>>::contains_key(collection.id, owner.as_sub());2431 if list_exists {2432 collection.consume_sload()?;2433 let mut list = <AddressTokens<T>>::get(collection.id, owner.as_sub());24342435 // bound Owned tokens by a single address in collection2436 let account_items: u32 = list.len() as u32;2437 ensure!(2438 account_items < ACCOUNT_TOKEN_OWNERSHIP_LIMIT,2439 Error::<T>::AddressOwnershipLimitExceeded2440 );24412442 let item_contains = list.contains(&item_index.clone());24432444 if !item_contains {2445 list.push(item_index);2446 }24472448 collection.consume_sstore()?;2449 <AddressTokens<T>>::insert(collection.id, owner.as_sub(), list);2450 } else {2451 let itm = vec![item_index];2452 collection.consume_sstore()?;2453 <AddressTokens<T>>::insert(collection.id, owner.as_sub(), itm);2454 }24552456 Ok(())2457 }24582459 fn remove_token_index(2460 collection: &CollectionHandle<T>,2461 item_index: TokenId,2462 owner: &T::CrossAccountId,2463 ) -> DispatchResult {2464 collection.consume_sload()?;2465 let list_exists = <AddressTokens<T>>::contains_key(collection.id, owner.as_sub());2466 if list_exists {2467 collection.consume_sload()?;2468 let mut list = <AddressTokens<T>>::get(collection.id, owner.as_sub());2469 let item_contains = list.contains(&item_index.clone());24702471 if item_contains {2472 list.retain(|&item| item != item_index);2473 collection.consume_sstore()?;2474 <AddressTokens<T>>::insert(collection.id, owner.as_sub(), list);2475 }2476 }24772478 Ok(())2479 }24802481 fn move_token_index(2482 collection: &CollectionHandle<T>,2483 item_index: TokenId,2484 old_owner: &T::CrossAccountId,2485 new_owner: &T::CrossAccountId,2486 ) -> DispatchResult {2487 Self::remove_token_index(collection, item_index, old_owner)?;2488 Self::add_token_index(collection, item_index, new_owner)?;24892490 Ok(())2491 }2492}24932494sp_api::decl_runtime_apis! {2495 pub trait NftApi {2496 /// Used for ethereum integration2497 fn eth_contract_code(account: H160) -> Option<Vec<u8>>;2498 }2499}pallets/nft/src/sponsorship.rsdiffbeforeafterboth--- a/pallets/nft/src/sponsorship.rs
+++ b/pallets/nft/src/sponsorship.rs
@@ -61,10 +61,15 @@
sponsor_transfer = match collection_mode {
CollectionMode::NFT => {
// get correct limit
- let limit: u32 = if collection_limits.sponsor_transfer_timeout > 0 {
- collection_limits.sponsor_transfer_timeout
+ let limit: u32 = if collection_limits.sponsor_transfer_timeout != 0 {
+ if collection_limits.sponsor_transfer_timeout > NFT_SPONSOR_TRANSFER_TIMEOUT
+ {
+ collection_limits.sponsor_transfer_timeout
+ } else {
+ NFT_SPONSOR_TRANSFER_TIMEOUT
+ }
} else {
- NFT_SPONSOR_TRANSFER_TIMEOUT
+ 0
};
let mut sponsored = true;
@@ -83,13 +88,18 @@
}
CollectionMode::Fungible(_) => {
// get correct limit
- let limit: u32 = if collection_limits.sponsor_transfer_timeout > 0 {
- collection_limits.sponsor_transfer_timeout
+ let limit: u32 = if collection_limits.sponsor_transfer_timeout != 0 {
+ if collection_limits.sponsor_transfer_timeout
+ > FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT
+ {
+ collection_limits.sponsor_transfer_timeout
+ } else {
+ FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT
+ }
} else {
- FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT
+ 0
};
- let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;
let mut sponsored = true;
if FungibleTransferBasket::<T>::contains_key(collection_id, who) {
let last_tx_block = FungibleTransferBasket::<T>::get(collection_id, who);
@@ -106,10 +116,16 @@
}
CollectionMode::ReFungible => {
// get correct limit
- let limit: u32 = if collection_limits.sponsor_transfer_timeout > 0 {
- collection_limits.sponsor_transfer_timeout
+ let limit: u32 = if collection_limits.sponsor_transfer_timeout != 0 {
+ if collection_limits.sponsor_transfer_timeout
+ > REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT
+ {
+ collection_limits.sponsor_transfer_timeout
+ } else {
+ REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT
+ }
} else {
- REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT
+ 0
};
let mut sponsored = true;
pallets/nft/src/tests.rsdiffbeforeafterboth--- a/pallets/nft/src/tests.rs
+++ b/pallets/nft/src/tests.rs
@@ -1789,7 +1789,7 @@
let data = default_nft_data();
assert_noop!(
TemplateModule::create_item(origin1, 1, account(1), data.into()),
- Error::<Test>::AddressOwnershipLimitExceeded
+ Error::<Test>::AccountTokenLimitExceeded
);
});
}
@@ -2016,11 +2016,11 @@
let data = default_nft_data();
create_test_item(1, &data.into());
- TemplateModule::set_meta_update_permission_flag(
+ assert_ok!(TemplateModule::set_meta_update_permission_flag(
origin1.clone(),
collection_id,
MetaUpdatePermission::ItemOwner,
- );
+ ));
let variable_data = b"ten chars.".to_vec();
assert_ok!(TemplateModule::set_variable_meta_data(
@@ -2042,20 +2042,17 @@
#[test]
fn set_variable_meta_data_on_nft_with_item_owner_permission_flag_neg() {
new_test_ext().execute_with(|| {
- // default_limits();
-
- let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
+ let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 1, 1);
let origin1 = Origin::signed(1);
- let origin2 = Origin::signed(2);
assert_ok!(TemplateModule::set_mint_permission(
- origin2.clone(),
+ origin1.clone(),
collection_id,
true
));
assert_ok!(TemplateModule::add_to_white_list(
- origin2.clone(),
+ origin1.clone(),
collection_id,
account(1)
));
@@ -2064,226 +2061,226 @@
create_test_item(1, &data.into());
assert_ok!(TemplateModule::set_meta_update_permission_flag(
- origin2.clone(),
+ origin1.clone(),
collection_id,
MetaUpdatePermission::ItemOwner,
));
- let variable_data = b"ten chars.++".to_vec();
+ let variable_data = b"1234567890123".to_vec();
assert_noop!(
TemplateModule::set_variable_meta_data(
- origin2,
+ origin1,
collection_id,
1,
variable_data.clone()
),
Error::<Test>::TokenVariableDataLimitExceeded
);
+ })
+}
- #[test]
- fn collection_transfer_flag_works() {
- new_test_ext().execute_with(|| {
- let origin1 = Origin::signed(1);
+#[test]
+fn collection_transfer_flag_works() {
+ new_test_ext().execute_with(|| {
+ let origin1 = Origin::signed(1);
- let collection_id = create_test_collection(&CollectionMode::NFT, 1);
- assert_ok!(TemplateModule::set_transfers_enabled_flag(origin1, 1, true));
+ let collection_id = create_test_collection(&CollectionMode::NFT, 1);
+ assert_ok!(TemplateModule::set_transfers_enabled_flag(origin1, 1, true));
- let data = default_nft_data();
- create_test_item(collection_id, &data.into());
- assert_eq!(TemplateModule::balance_count(1, 1), 1);
- assert_eq!(TemplateModule::address_tokens(1, 1), [1]);
+ let data = default_nft_data();
+ create_test_item(collection_id, &data.into());
+ assert_eq!(TemplateModule::balance_count(1, 1), 1);
+ assert_eq!(TemplateModule::address_tokens(1, 1), [1]);
- let origin1 = Origin::signed(1);
+ let origin1 = Origin::signed(1);
- // default scenario
- assert_ok!(TemplateModule::transfer(origin1, account(2), 1, 1, 1000));
- assert_eq!(TemplateModule::nft_item_id(1, 1).unwrap().owner, account(2));
- assert_eq!(TemplateModule::balance_count(1, 1), 0);
- assert_eq!(TemplateModule::balance_count(1, 2), 1);
+ // default scenario
+ assert_ok!(TemplateModule::transfer(origin1, account(2), 1, 1, 1000));
+ assert_eq!(TemplateModule::nft_item_id(1, 1).unwrap().owner, account(2));
+ assert_eq!(TemplateModule::balance_count(1, 1), 0);
+ assert_eq!(TemplateModule::balance_count(1, 2), 1);
- assert_eq!(TemplateModule::address_tokens(1, 2), [1]);
- });
- }
+ assert_eq!(TemplateModule::address_tokens(1, 2), [1]);
+ });
+}
- #[test]
- fn set_variable_meta_data_on_nft_with_admin_flag() {
- new_test_ext().execute_with(|| {
- // default_limits();
+#[test]
+fn set_variable_meta_data_on_nft_with_admin_flag() {
+ new_test_ext().execute_with(|| {
+ // default_limits();
- let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
+ let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
- let origin1 = Origin::signed(1);
- let origin2 = Origin::signed(2);
+ let origin1 = Origin::signed(1);
+ let origin2 = Origin::signed(2);
- assert_ok!(TemplateModule::set_mint_permission(
- origin2.clone(),
- collection_id,
- true
- ));
- assert_ok!(TemplateModule::add_to_white_list(
- origin2.clone(),
- collection_id,
- account(1)
- ));
+ assert_ok!(TemplateModule::set_mint_permission(
+ origin2.clone(),
+ collection_id,
+ true
+ ));
+ assert_ok!(TemplateModule::add_to_white_list(
+ origin2.clone(),
+ collection_id,
+ account(1)
+ ));
- assert_ok!(TemplateModule::add_collection_admin(
- origin2.clone(),
- collection_id,
- account(1)
- ));
+ assert_ok!(TemplateModule::add_collection_admin(
+ origin2.clone(),
+ collection_id,
+ account(1)
+ ));
- let data = default_nft_data();
- create_test_item(1, &data.into());
+ let data = default_nft_data();
+ create_test_item(1, &data.into());
- assert_ok!(TemplateModule::set_meta_update_permission_flag(
- origin2.clone(),
- collection_id,
- MetaUpdatePermission::Admin,
- ));
+ assert_ok!(TemplateModule::set_meta_update_permission_flag(
+ origin2.clone(),
+ collection_id,
+ MetaUpdatePermission::Admin,
+ ));
- let variable_data = b"test set_variable_meta_data method.".to_vec();
- assert_ok!(TemplateModule::set_variable_meta_data(
- origin1,
- collection_id,
- 1,
- variable_data.clone()
- ));
+ let variable_data = b"test.".to_vec();
+ assert_ok!(TemplateModule::set_variable_meta_data(
+ origin1,
+ collection_id,
+ 1,
+ variable_data.clone()
+ ));
- assert_eq!(
- TemplateModule::nft_item_id(collection_id, 1)
- .unwrap()
- .variable_data,
- variable_data
- );
- });
- }
+ assert_eq!(
+ TemplateModule::nft_item_id(collection_id, 1)
+ .unwrap()
+ .variable_data,
+ variable_data
+ );
+ });
+}
- #[test]
- fn set_variable_meta_data_on_nft_with_admin_flag_neg() {
- new_test_ext().execute_with(|| {
- // default_limits();
+#[test]
+fn set_variable_meta_data_on_nft_with_admin_flag_neg() {
+ new_test_ext().execute_with(|| {
+ // default_limits();
- let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
+ let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
- let origin1 = Origin::signed(1);
- let origin2 = Origin::signed(2);
+ let origin1 = Origin::signed(1);
+ let origin2 = Origin::signed(2);
- assert_ok!(TemplateModule::set_mint_permission(
- origin2.clone(),
- collection_id,
- true
- ));
- assert_ok!(TemplateModule::add_to_white_list(
- origin2.clone(),
- collection_id,
- account(1)
- ));
+ assert_ok!(TemplateModule::set_mint_permission(
+ origin2.clone(),
+ collection_id,
+ true
+ ));
+ assert_ok!(TemplateModule::add_to_white_list(
+ origin2.clone(),
+ collection_id,
+ account(1)
+ ));
- let data = default_nft_data();
- create_test_item(1, &data.into());
+ let data = default_nft_data();
+ create_test_item(1, &data.into());
- assert_ok!(TemplateModule::set_meta_update_permission_flag(
- origin2.clone(),
- collection_id,
- MetaUpdatePermission::Admin,
- ));
+ assert_ok!(TemplateModule::set_meta_update_permission_flag(
+ origin2.clone(),
+ collection_id,
+ MetaUpdatePermission::Admin,
+ ));
- let variable_data = b"test set_variable_meta_data method.".to_vec();
- assert_noop!(
- TemplateModule::set_variable_meta_data(
- origin1,
- collection_id,
- 1,
- variable_data.clone()
- ),
- Error::<Test>::NoPermission
- );
- });
- }
+ let variable_data = b"test.".to_vec();
+ assert_noop!(
+ TemplateModule::set_variable_meta_data(
+ origin1,
+ collection_id,
+ 1,
+ variable_data.clone()
+ ),
+ Error::<Test>::NoPermission
+ );
+ });
+}
- #[test]
- fn set_variable_meta_flag_after_freeze() {
- new_test_ext().execute_with(|| {
- // default_limits();
+#[test]
+fn set_variable_meta_flag_after_freeze() {
+ new_test_ext().execute_with(|| {
+ // default_limits();
- let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
+ let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 2, 1);
- let origin2 = Origin::signed(2);
+ let origin2 = Origin::signed(2);
- assert_ok!(TemplateModule::set_meta_update_permission_flag(
- origin2.clone(),
- collection_id,
- MetaUpdatePermission::None,
- ));
- assert_noop!(
- TemplateModule::set_meta_update_permission_flag(
- origin2.clone(),
- collection_id,
- MetaUpdatePermission::Admin
- ),
- Error::<Test>::MetadataFlagFrozen
- );
- });
- }
+ assert_ok!(TemplateModule::set_meta_update_permission_flag(
+ origin2.clone(),
+ collection_id,
+ MetaUpdatePermission::None,
+ ));
+ assert_noop!(
+ TemplateModule::set_meta_update_permission_flag(
+ origin2.clone(),
+ collection_id,
+ MetaUpdatePermission::Admin
+ ),
+ Error::<Test>::MetadataFlagFrozen
+ );
+ });
+}
- #[test]
- fn set_variable_meta_data_on_nft_with_none_flag_neg() {
- new_test_ext().execute_with(|| {
- // default_limits();
+#[test]
+fn set_variable_meta_data_on_nft_with_none_flag_neg() {
+ new_test_ext().execute_with(|| {
+ // default_limits();
- let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 1, 1);
- let origin1 = Origin::signed(1);
+ let collection_id = create_test_collection_for_owner(&CollectionMode::NFT, 1, 1);
+ let origin1 = Origin::signed(1);
- let data = default_nft_data();
- create_test_item(1, &data.into());
+ let data = default_nft_data();
+ create_test_item(1, &data.into());
- assert_ok!(TemplateModule::set_meta_update_permission_flag(
- origin1.clone(),
- collection_id,
- MetaUpdatePermission::None,
- ));
+ assert_ok!(TemplateModule::set_meta_update_permission_flag(
+ origin1.clone(),
+ collection_id,
+ MetaUpdatePermission::None,
+ ));
- let variable_data = b"test set_variable_meta_data method.".to_vec();
- assert_noop!(
- TemplateModule::set_variable_meta_data(
- origin1.clone(),
- collection_id,
- 1,
- variable_data.clone()
- ),
- Error::<Test>::MetadataUpdateDenied
- );
- });
- }
+ let variable_data = b"test.".to_vec();
+ assert_noop!(
+ TemplateModule::set_variable_meta_data(
+ origin1.clone(),
+ collection_id,
+ 1,
+ variable_data.clone()
+ ),
+ Error::<Test>::MetadataUpdateDenied
+ );
+ });
+}
- #[test]
- fn collection_transfer_flag_works_neg() {
- new_test_ext().execute_with(|| {
- let origin1 = Origin::signed(1);
+#[test]
+fn collection_transfer_flag_works_neg() {
+ new_test_ext().execute_with(|| {
+ let origin1 = Origin::signed(1);
- let collection_id = create_test_collection(&CollectionMode::NFT, 1);
- assert_ok!(TemplateModule::set_transfers_enabled_flag(
- origin1, 1, false
- ));
+ let collection_id = create_test_collection(&CollectionMode::NFT, 1);
+ assert_ok!(TemplateModule::set_transfers_enabled_flag(
+ origin1, 1, false
+ ));
- let data = default_nft_data();
- create_test_item(collection_id, &data.into());
- assert_eq!(TemplateModule::balance_count(1, 1), 1);
- assert_eq!(TemplateModule::address_tokens(1, 1), [1]);
+ let data = default_nft_data();
+ create_test_item(collection_id, &data.into());
+ assert_eq!(TemplateModule::balance_count(1, 1), 1);
+ assert_eq!(TemplateModule::address_tokens(1, 1), [1]);
- let origin1 = Origin::signed(1);
+ let origin1 = Origin::signed(1);
- // default scenario
- assert_noop!(
- TemplateModule::transfer(origin1, account(2), 1, 1, 1000),
- Error::<Test>::TransferNotAllowed
- );
- assert_eq!(TemplateModule::nft_item_id(1, 1).unwrap().owner, account(1));
- assert_eq!(TemplateModule::balance_count(1, 1), 1);
- assert_eq!(TemplateModule::balance_count(1, 2), 0);
+ // default scenario
+ assert_noop!(
+ TemplateModule::transfer(origin1, account(2), 1, 1, 1000),
+ Error::<Test>::TransferNotAllowed
+ );
+ assert_eq!(TemplateModule::nft_item_id(1, 1).unwrap().owner, account(1));
+ assert_eq!(TemplateModule::balance_count(1, 1), 1);
+ assert_eq!(TemplateModule::balance_count(1, 2), 0);
- assert_eq!(TemplateModule::address_tokens(1, 1), [1]);
- });
- }
+ assert_eq!(TemplateModule::address_tokens(1, 1), [1]);
});
}
tests/src/limits.test.tsdiffbeforeafterboth--- /dev/null
+++ b/tests/src/limits.test.ts
@@ -0,0 +1,378 @@
+//
+// This file is subject to the terms and conditions defined in
+// file 'LICENSE', which is part of this source code package.
+//
+
+import { IKeyringPair } from '@polkadot/types/types';
+import privateKey from './substrate/privateKey';
+import usingApi from './substrate/substrate-api';
+import {
+ createCollectionExpectSuccess,
+ destroyCollectionExpectSuccess,
+ setCollectionLimitsExpectSuccess,
+ setCollectionSponsorExpectSuccess,
+ confirmSponsorshipExpectSuccess,
+ createItemExpectSuccess,
+ createItemExpectFailure,
+ transferExpectSuccess,
+ getFreeBalance,
+ waitNewBlocks,
+} from './util/helpers';
+import { expect } from 'chai';
+
+describe('Number of tokens per address (NFT)', () => {
+ let Alice: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ });
+ });
+
+ it('Collection limits allow greater number than chain limits, chain limits are enforced', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { AccountTokenOwnershipLimit: 20 });
+ for(let i = 0; i < 10; i++){
+ await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ }
+ await createItemExpectFailure(Alice, collectionId, 'NFT');
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+
+ it('Collection limits allow lower number than chain limits, collection limits are enforced', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { AccountTokenOwnershipLimit: 1 });
+ await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ await createItemExpectFailure(Alice, collectionId, 'NFT');
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+});
+
+describe('Number of tokens per address (ReFungible)', () => {
+ let Alice: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ });
+ });
+
+ it('Collection limits allow greater number than chain limits, chain limits are enforced', async () => {
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'ReFungible' }});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { AccountTokenOwnershipLimit: 20 });
+ for(let i = 0; i < 10; i++){
+ await createItemExpectSuccess(Alice, collectionId, 'ReFungible');
+ }
+ await createItemExpectFailure(Alice, collectionId, 'ReFungible');
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+
+ it('Collection limits allow lower number than chain limits, collection limits are enforced', async () => {
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'ReFungible' }});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { AccountTokenOwnershipLimit: 1 });
+ await createItemExpectSuccess(Alice, collectionId, 'ReFungible');
+ await createItemExpectFailure(Alice, collectionId, 'ReFungible');
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+});
+
+describe('Sponsor timeout (NFT)', () => {
+ let Alice: IKeyringPair;
+ let Bob: IKeyringPair;
+ let Charlie: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ Bob = privateKey('//Bob');
+ Charlie = privateKey('//Charlie');
+ });
+ });
+
+ it('Collection limits have greater timeout value than chain limits, collection limits are enforced', async () => {
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 7 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob);
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 5, fail
+ await waitNewBlocks(5);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie);
+ const aliceBalanceAfterUnsponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterUnsponsoredTransaction).to.be.equals(aliceBalanceBefore);
+
+ // check setting SponsorTimeout = 7, success
+ await waitNewBlocks(2); // 5 + 2
+ await transferExpectSuccess(collectionId, tokenId, Charlie, Bob);
+ const aliceBalanceAfterSponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction).to.be.lessThan(aliceBalanceBefore);
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+
+ it('Collection limits have lower timeout value than chain limits, chain limits are enforced', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 1 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob);
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 1, fail
+ await waitNewBlocks(1);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie);
+ const aliceBalanceAfterUnsponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterUnsponsoredTransaction).to.be.equals(aliceBalanceBefore);
+
+ // check setting SponsorTimeout = 5, success
+ await waitNewBlocks(4);
+ await transferExpectSuccess(collectionId, tokenId, Charlie, Bob);
+ const aliceBalanceAfterSponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction).to.be.lessThan(aliceBalanceBefore);
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+});
+
+describe('Sponsor timeout (Fungible)', () => {
+ let Alice: IKeyringPair;
+ let Bob: IKeyringPair;
+ let Charlie: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ Bob = privateKey('//Bob');
+ Charlie = privateKey('//Charlie');
+ });
+ });
+
+ it('Collection limits have greater timeout value than chain limits, collection limits are enforced', async () => {
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 7 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'Fungible');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob, 10, 'Fungible');
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 5, fail
+ await waitNewBlocks(5);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceAfterUnsponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterUnsponsoredTransaction).to.be.equals(aliceBalanceBefore);
+
+ // check setting SponsorTimeout = 7, success
+ await waitNewBlocks(2); // 5 + 2
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceAfterSponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction).to.be.lessThan(aliceBalanceBefore);
+
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+
+ it('Collection limits have lower timeout value than chain limits, chain limits are enforced', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 1 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'Fungible');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob, 10, 'Fungible');
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 1, fail
+ await waitNewBlocks(1);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceAfterUnsponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterUnsponsoredTransaction).to.be.equals(aliceBalanceBefore);
+
+ // check setting SponsorTimeout = 5, success
+ await waitNewBlocks(4);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceAfterSponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction).to.be.lessThan(aliceBalanceBefore);
+
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+});
+
+describe('Sponsor timeout (ReFungible)', () => {
+ let Alice: IKeyringPair;
+ let Bob: IKeyringPair;
+ let Charlie: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ Bob = privateKey('//Bob');
+ Charlie = privateKey('//Charlie');
+ });
+ });
+
+ it('Collection limits have greater timeout value than chain limits, collection limits are enforced', async () => {
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'ReFungible' }});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 7 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'ReFungible');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob, 100, 'ReFungible');
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 5, fail
+ await waitNewBlocks(5);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 20, 'ReFungible');
+ const aliceBalanceAfterUnsponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterUnsponsoredTransaction).to.be.equals(aliceBalanceBefore);
+
+ // check setting SponsorTimeout = 7, success
+ await waitNewBlocks(2); // 5 + 2
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 20, 'ReFungible');
+ const aliceBalanceAfterSponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction).to.be.lessThan(aliceBalanceBefore);
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+
+ it('Collection limits have lower timeout value than chain limits, chain limits are enforced', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 1 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob);
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 1, fail
+ await waitNewBlocks(1);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie);
+ const aliceBalanceAfterUnsponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterUnsponsoredTransaction).to.be.equals(aliceBalanceBefore);
+
+ // check setting SponsorTimeout = 5, success
+ await waitNewBlocks(4);
+ await transferExpectSuccess(collectionId, tokenId, Charlie, Bob);
+ const aliceBalanceAfterSponsoredTransaction = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction).to.be.lessThan(aliceBalanceBefore);
+ await destroyCollectionExpectSuccess(collectionId);
+ });
+});
+
+describe('Collection zero limits (NFT)', () => {
+ let Alice: IKeyringPair;
+ let Bob: IKeyringPair;
+ let Charlie: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ Bob = privateKey('//Bob');
+ Charlie = privateKey('//Charlie');
+ });
+ });
+
+ it('Limits have 0 in tokens per address field, the chain limits are applied', async () => {
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { AccountTokenOwnershipLimit: 0 });
+ for(let i = 0; i < 10; i++){
+ await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ }
+ await createItemExpectFailure(Alice, collectionId, 'NFT');
+ });
+
+ it('Limits have 0 in sponsor timeout, no limits are applied', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 0 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'NFT');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob);
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 0, success with next block
+ await waitNewBlocks(1);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie);
+ const aliceBalanceAfterSponsoredTransaction1 = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction1).to.be.lessThan(aliceBalanceBefore);
+ });
+});
+
+describe.only('Collection zero limits (Fungible)', () => {
+ let Alice: IKeyringPair;
+ let Bob: IKeyringPair;
+ let Charlie: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ Bob = privateKey('//Bob');
+ Charlie = privateKey('//Charlie');
+ });
+ });
+
+ it('Limits have 0 in sponsor timeout, no limits are applied', async () => {
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 0 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'Fungible');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob, 10, 'Fungible');
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+
+ // check setting SponsorTimeout = 0, success with next block
+ await waitNewBlocks(1);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 2, 'Fungible');
+ const aliceBalanceAfterSponsoredTransaction1 = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction1).to.be.lessThan(aliceBalanceBefore);
+ });
+});
+
+describe.only('Collection zero limits (ReFungible)', () => {
+ let Alice: IKeyringPair;
+ let Bob: IKeyringPair;
+ let Charlie: IKeyringPair;
+
+ before(async () => {
+ await usingApi(async () => {
+ Alice = privateKey('//Alice');
+ Bob = privateKey('//Bob');
+ Charlie = privateKey('//Charlie');
+ });
+ });
+
+ it('Limits have 0 in tokens per address field, the chain limits are applied', async () => {
+ const collectionId = await createCollectionExpectSuccess({mode: {type: 'ReFungible' }});
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { AccountTokenOwnershipLimit: 0 });
+ for(let i = 0; i < 10; i++){
+ await createItemExpectSuccess(Alice, collectionId, 'ReFungible');
+ }
+ await createItemExpectFailure(Alice, collectionId, 'ReFungible');
+ });
+
+ it('Limits have 0 in sponsor timeout, no limits are applied', async () => {
+
+ const collectionId = await createCollectionExpectSuccess({ mode: { type: 'ReFungible' } });
+ await setCollectionLimitsExpectSuccess(Alice, collectionId, { SponsorTimeout: 0 });
+ const tokenId = await createItemExpectSuccess(Alice, collectionId, 'ReFungible');
+ await setCollectionSponsorExpectSuccess(collectionId, Alice.address);
+ await confirmSponsorshipExpectSuccess(collectionId, '//Alice');
+ await transferExpectSuccess(collectionId, tokenId, Alice, Bob, 100, 'ReFungible');
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 20, 'ReFungible');
+ const aliceBalanceBefore = (await getFreeBalance(Alice)).toNumber();
+
+ // check setting SponsorTimeout = 0, success with next block
+ await waitNewBlocks(1);
+ await transferExpectSuccess(collectionId, tokenId, Bob, Charlie, 20, 'ReFungible');
+ const aliceBalanceAfterSponsoredTransaction1 = (await getFreeBalance(Alice)).toNumber();
+ expect(aliceBalanceAfterSponsoredTransaction1).to.be.lessThan(aliceBalanceBefore);
+ });
+});
tests/src/util/helpers.tsdiffbeforeafterboth--- a/tests/src/util/helpers.ts
+++ b/tests/src/util/helpers.ts
@@ -811,6 +811,17 @@
}
export async function
+getFreeBalance(account: IKeyringPair) : Promise<BigNumber>
+{
+ let balance = new BigNumber(0) ;
+ await usingApi(async (api) => {
+ balance = new BigNumber((await api.query.system.account(account.address)).data.free.toString());
+ });
+
+ return balance;
+}
+
+export async function
scheduleTransferExpectSuccess(
collectionId: number,
tokenId: number,
@@ -884,8 +895,11 @@
if (type === 'ReFungible') {
const nftItemData =
(await api.query.nft.reFungibleItemList(collectionId, tokenId)).toJSON() as unknown as IReFungibleTokenDataType;
- expect(nftItemData.Owner[0].Owner).to.be.deep.equal(to);
- expect(nftItemData.Owner[0].Fraction.toString()).to.be.equal(value.toString());
+ const expectedOwner = toSubstrateAddress(to);
+ const ownerIndex = nftItemData.Owner.findIndex(v => toSubstrateAddress(v.Owner as any as string) == expectedOwner);
+ expect(ownerIndex).to.not.equal(-1);
+ expect(nftItemData.Owner[ownerIndex].Owner).to.be.deep.equal(normalizeAccountId(to));
+ expect(nftItemData.Owner[ownerIndex].Fraction).to.be.greaterThanOrEqual(value as number);
}
});
}
@@ -1190,7 +1204,6 @@
export async function waitNewBlocks(blocksCount = 1): Promise<void> {
await usingApi(async (api) => {
const promise = new Promise<void>(async (resolve) => {
-
const unsubscribe = await api.rpc.chain.subscribeNewHeads(() => {
if (blocksCount > 0) {
blocksCount--;