difftreelog
feat track and limit admin amount
in: master
3 files changed
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -11,7 +11,8 @@
use nft_data_structs::{
COLLECTION_NUMBER_LIMIT, Collection, CollectionId, CreateItemData, ExistenceRequirement,
MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_COLLECTION_NAME_LENGTH, MAX_TOKEN_PREFIX_LENGTH,
- MetaUpdatePermission, Pays, PostDispatchInfo, TokenId, Weight, WithdrawReasons,
+ COLLECTION_ADMINS_LIMIT, MetaUpdatePermission, Pays, PostDispatchInfo, TokenId, Weight,
+ WithdrawReasons,
};
pub use pallet::*;
use sp_core::H160;
@@ -165,6 +166,13 @@
#[pallet::generate_store(pub(super) trait Store)]
pub struct Pallet<T>(_);
+ #[pallet::extra_constants]
+ impl<T: Config> Pallet<T> {
+ pub fn collection_admins_limit() -> u32 {
+ COLLECTION_ADMINS_LIMIT
+ }
+ }
+
#[pallet::event]
#[pallet::generate_deposit(pub fn deposit_event)]
pub enum Event<T: Config> {
@@ -265,6 +273,8 @@
TotalCollectionsLimitExceeded,
/// variable_data exceeded data limit.
TokenVariableDataLimitExceeded,
+ /// Exceeded max admin amount
+ CollectionAdminAmountExceeded,
/// Collection settings not allowing items transferring
TransferNotAllowed,
@@ -305,6 +315,14 @@
QueryKind = OptionQuery,
>;
+ #[pallet::storage]
+ pub type AdminAmount<T> = StorageMap<
+ Hasher = Blake2_128Concat,
+ Key = CollectionId,
+ Value = u32,
+ QueryKind = ValueQuery,
+ >;
+
/// List of collection admins
#[pallet::storage]
pub type IsAdmin<T: Config> = StorageNMap<
@@ -419,6 +437,7 @@
<DestroyedCollectionCount<T>>::put(destroyed_collections);
<CollectionById<T>>::remove(collection.id);
+ <AdminAmount<T>>::remove(collection.id);
<IsAdmin<T>>::remove_prefix((collection.id,), None);
<Allowlist<T>>::remove_prefix((collection.id,), None);
Ok(())
@@ -435,9 +454,44 @@
// =========
if allowed {
- <Allowlist<T>>::insert((collection.id, user.as_sub()), true);
+ <Allowlist<T>>::insert((collection.id, user), true);
+ } else {
+ <Allowlist<T>>::remove((collection.id, user));
+ }
+
+ Ok(())
+ }
+
+ pub fn toggle_admin(
+ collection: &CollectionHandle<T>,
+ sender: &T::CrossAccountId,
+ user: &T::CrossAccountId,
+ admin: bool,
+ ) -> DispatchResult {
+ collection.check_is_owner_or_admin(&sender)?;
+
+ let was_admin = <IsAdmin<T>>::get((collection.id, user));
+ if was_admin == admin {
+ return Ok(());
+ }
+ let amount = <AdminAmount<T>>::get(collection.id);
+
+ if admin {
+ let amount = amount
+ .checked_add(1)
+ .ok_or(<Error<T>>::CollectionAdminAmountExceeded)?;
+ ensure!(
+ amount <= Self::collection_admins_limit(),
+ <Error<T>>::CollectionAdminAmountExceeded,
+ );
+
+ // =========
+
+ <AdminAmount<T>>::insert(collection.id, amount);
+ <IsAdmin<T>>::insert((collection.id, user), true);
} else {
- <Allowlist<T>>::remove((collection.id, user.as_sub()));
+ <AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));
+ <IsAdmin<T>>::remove((collection.id, user));
}
Ok(())
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_module, decl_storage, decl_error,20 dispatch::DispatchResult,21 ensure, fail, parameter_types,22 traits::{23 ExistenceRequirement, Get, Imbalance, KeyOwnerProofSystem, OnUnbalanced, Randomness,24 IsSubType, WithdrawReasons,25 },26 weights::{27 constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},28 DispatchInfo, GetDispatchInfo, IdentityFee, Pays, PostDispatchInfo, Weight,29 WeightToFeePolynomial, DispatchClass,30 },31 StorageValue, transactional,32 pallet_prelude::DispatchResultWithPostInfo,33};34use scale_info::TypeInfo;35use frame_system::{self as system, ensure_signed};36use sp_runtime::{sp_std::prelude::Vec};37use nft_data_structs::{38 MAX_DECIMAL_POINTS, MAX_SPONSOR_TIMEOUT, MAX_TOKEN_OWNERSHIP, CUSTOM_DATA_LIMIT,39 VARIABLE_ON_CHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, COLLECTION_ADMINS_LIMIT,40 OFFCHAIN_SCHEMA_LIMIT, FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT, REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,41 NFT_SPONSOR_TRANSFER_TIMEOUT, AccessMode, Collection, CreateItemData, CollectionLimits,42 CollectionId, CollectionMode, TokenId, SchemaVersion, SponsorshipState, MetaUpdatePermission,43};44use pallet_common::{45 account::CrossAccountId, CollectionHandle, IsAdmin, Pallet as PalletCommon,46 Error as CommonError, CommonWeightInfo, Allowlist,47};48use pallet_refungible::{Pallet as PalletRefungible, RefungibleHandle};49use pallet_fungible::{Pallet as PalletFungible, FungibleHandle};50use pallet_nonfungible::{Pallet as PalletNonfungible, NonfungibleHandle};5152#[cfg(test)]53mod mock;5455#[cfg(test)]56mod tests;5758mod eth;59mod sponsorship;60pub use sponsorship::NftSponsorshipHandler;61pub use eth::sponsoring::NftEthSponsorshipHandler;6263pub use eth::NftErcSupport;6465pub mod common;66use common::CommonWeights;67pub mod dispatch;68use dispatch::dispatch_call;6970#[cfg(feature = "runtime-benchmarks")]71mod benchmarking;72pub mod weights;73use weights::WeightInfo;7475decl_error! {76 /// Error for non-fungible-token module.77 pub enum Error for Module<T: Config> {78 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.79 CollectionDecimalPointLimitExceeded,80 /// This address is not set as sponsor, use setCollectionSponsor first.81 ConfirmUnsetSponsorFail,82 /// Length of items properties must be greater than 0.83 EmptyArgument,84 /// Collection limit bounds per collection exceeded85 CollectionLimitBoundsExceeded,86 /// Tried to enable permissions which are only permitted to be disabled87 OwnerPermissionsCantBeReverted,88 }89}90pub trait Config:91 system::Config92 + pallet_evm_coder_substrate::Config93 + pallet_common::Config94 + pallet_nonfungible::Config95 + pallet_refungible::Config96 + pallet_fungible::Config97 + Sized98 + TypeInfo99{100 /// Weight information for extrinsics in this pallet.101 type WeightInfo: WeightInfo;102}103104type SelfWeightOf<T> = <T as Config>::WeightInfo;105106// # Used definitions107//108// ## User control levels109//110// chain-controlled - key is uncontrolled by user111// i.e autoincrementing index112// can use non-cryptographic hash113// real - key is controlled by user114// but it is hard to generate enough colliding values, i.e owner of signed txs115// can use non-cryptographic hash116// controlled - key is completly controlled by users117// i.e maps with mutable keys118// should use cryptographic hash119//120// ## User control level downgrade reasons121//122// ?1 - chain-controlled -> controlled123// collections/tokens can be destroyed, resulting in massive holes124// ?2 - chain-controlled -> controlled125// same as ?1, but can be only added, resulting in easier exploitation126// ?3 - real -> controlled127// no confirmation required, so addresses can be easily generated128decl_storage! {129 trait Store for Module<T: Config> as Nft {130131 //#region Private members132 /// Used for migrations133 ChainVersion: u64;134 //#endregion135136 //#region Tokens transfer rate limit baskets137 /// (Collection id (controlled?2), who created (real))138 /// TODO: Off chain worker should remove from this map when collection gets removed139 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => T::BlockNumber;140 /// Collection id (controlled?2), token id (controlled?2)141 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;142 /// Collection id (controlled?2), owning user (real)143 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => T::BlockNumber;144 /// Collection id (controlled?2), token id (controlled?2)145 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;146 //#endregion147148 /// Variable metadata sponsoring149 /// Collection id (controlled?2), token id (controlled?2)150 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber> = None;151 }152}153154decl_module! {155 pub struct Module<T: Config> for enum Call156 where157 origin: T::Origin158 {159 const CollectionAdminsLimit: u64 = COLLECTION_ADMINS_LIMIT;160 type Error = Error<T>;161162 fn on_initialize(_now: T::BlockNumber) -> Weight {163 0164 }165166 /// 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.167 ///168 /// # Permissions169 ///170 /// * Anyone.171 ///172 /// # Arguments173 ///174 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.175 ///176 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.177 ///178 /// * token_prefix: UTF-8 string with token prefix.179 ///180 /// * mode: [CollectionMode] collection type and type dependent data.181 // returns collection ID182 #[weight = <SelfWeightOf<T>>::create_collection()]183 #[transactional]184 pub fn create_collection(origin,185 collection_name: Vec<u16>,186 collection_description: Vec<u16>,187 token_prefix: Vec<u8>,188 mode: CollectionMode) -> DispatchResult {189190 // Anyone can create a collection191 let who = ensure_signed(origin)?;192193 // Create new collection194 let new_collection = Collection::<T> {195 owner: who.clone(),196 name: collection_name,197 mode: mode.clone(),198 mint_mode: false,199 access: AccessMode::Normal,200 description: collection_description,201 token_prefix,202 offchain_schema: Vec::new(),203 schema_version: SchemaVersion::ImageURL,204 sponsorship: SponsorshipState::Disabled,205 variable_on_chain_schema: Vec::new(),206 const_on_chain_schema: Vec::new(),207 limits: Default::default(),208 meta_update_permission: Default::default(),209 };210211 let _id = match mode {212 CollectionMode::NFT => {PalletNonfungible::init_collection(new_collection)?},213 CollectionMode::Fungible(decimal_points) => {214 // check params215 ensure!(decimal_points <= MAX_DECIMAL_POINTS, Error::<T>::CollectionDecimalPointLimitExceeded);216 PalletFungible::init_collection(new_collection)?217 }218 CollectionMode::ReFungible => {219 PalletRefungible::init_collection(new_collection)?220 }221 };222223 Ok(())224 }225226 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.227 ///228 /// # Permissions229 ///230 /// * Collection Owner.231 ///232 /// # Arguments233 ///234 /// * collection_id: collection to destroy.235 #[weight = <SelfWeightOf<T>>::destroy_collection()]236 #[transactional]237 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {238 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);239240 let collection = <CollectionHandle<T>>::try_get(collection_id)?;241 collection.check_is_owner(&sender)?;242243 // =========244245 match collection.mode {246 CollectionMode::ReFungible => PalletRefungible::destroy_collection(RefungibleHandle::cast(collection), &sender)?,247 CollectionMode::Fungible(_) => PalletFungible::destroy_collection(FungibleHandle::cast(collection), &sender)?,248 CollectionMode::NFT => PalletNonfungible::destroy_collection(NonfungibleHandle::cast(collection), &sender)?,249 }250251 <NftTransferBasket<T>>::remove_prefix(collection_id, None);252 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);253 <ReFungibleTransferBasket<T>>::remove_prefix(collection_id, None);254255 <VariableMetaDataBasket<T>>::remove_prefix(collection_id, None);256257 Ok(())258 }259260 /// Add an address to white list.261 ///262 /// # Permissions263 ///264 /// * Collection Owner265 /// * Collection Admin266 ///267 /// # Arguments268 ///269 /// * collection_id.270 ///271 /// * address.272 #[weight = <SelfWeightOf<T>>::add_to_white_list()]273 #[transactional]274 pub fn add_to_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{275276 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);277 let collection = <CollectionHandle<T>>::try_get(collection_id)?;278279 <PalletCommon<T>>::toggle_allowlist(280 &collection,281 &sender,282 &address,283 true,284 )?;285286 Ok(())287 }288289 /// Remove an address from white list.290 ///291 /// # Permissions292 ///293 /// * Collection Owner294 /// * Collection Admin295 ///296 /// # Arguments297 ///298 /// * collection_id.299 ///300 /// * address.301 #[weight = <SelfWeightOf<T>>::remove_from_white_list()]302 #[transactional]303 pub fn remove_from_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{304305 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);306 let collection = <CollectionHandle<T>>::try_get(collection_id)?;307308 <PalletCommon<T>>::toggle_allowlist(309 &collection,310 &sender,311 &address,312 false,313 )?;314315 Ok(())316 }317318 /// Toggle between normal and white list access for the methods with access for `Anyone`.319 ///320 /// # Permissions321 ///322 /// * Collection Owner.323 ///324 /// # Arguments325 ///326 /// * collection_id.327 ///328 /// * mode: [AccessMode]329 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]330 #[transactional]331 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult332 {333 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);334335 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;336 target_collection.check_is_owner(&sender)?;337338 target_collection.access = mode;339 target_collection.save()340 }341342 /// Allows Anyone to create tokens if:343 /// * White List is enabled, and344 /// * Address is added to white list, and345 /// * This method was called with True parameter346 ///347 /// # Permissions348 /// * Collection Owner349 ///350 /// # Arguments351 ///352 /// * collection_id.353 ///354 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.355 #[weight = <SelfWeightOf<T>>::set_mint_permission()]356 #[transactional]357 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult358 {359 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);360361 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;362 target_collection.check_is_owner(&sender)?;363364 target_collection.mint_mode = mint_permission;365 target_collection.save()366 }367368 /// Change the owner of the collection.369 ///370 /// # Permissions371 ///372 /// * Collection Owner.373 ///374 /// # Arguments375 ///376 /// * collection_id.377 ///378 /// * new_owner.379 #[weight = <SelfWeightOf<T>>::change_collection_owner()]380 #[transactional]381 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {382383 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);384385 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;386 target_collection.check_is_owner(&sender)?;387388 target_collection.owner = new_owner;389 target_collection.save()390 }391392 /// Adds an admin of the Collection.393 /// 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.394 ///395 /// # Permissions396 ///397 /// * Collection Owner.398 /// * Collection Admin.399 ///400 /// # Arguments401 ///402 /// * collection_id: ID of the Collection to add admin for.403 ///404 /// * new_admin_id: Address of new admin to add.405 #[weight = <SelfWeightOf<T>>::add_collection_admin()]406 #[transactional]407 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {408 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);409410 let collection = <CollectionHandle<T>>::try_get(collection_id)?;411 collection.check_is_owner_or_admin(&sender)?;412413 <IsAdmin<T>>::insert((collection_id, new_admin_id.as_sub()), true);414 Ok(())415 }416417 /// 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.418 ///419 /// # Permissions420 ///421 /// * Collection Owner.422 /// * Collection Admin.423 ///424 /// # Arguments425 ///426 /// * collection_id: ID of the Collection to remove admin for.427 ///428 /// * account_id: Address of admin to remove.429 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]430 #[transactional]431 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {432 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);433434 let collection = <CollectionHandle<T>>::try_get(collection_id)?;435 collection.check_is_owner_or_admin(&sender)?;436437 <IsAdmin<T>>::remove((collection_id, account_id.as_sub()));438 Ok(())439 }440441 /// # Permissions442 ///443 /// * Collection Owner444 ///445 /// # Arguments446 ///447 /// * collection_id.448 ///449 /// * new_sponsor.450 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]451 #[transactional]452 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {453 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);454455 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;456 target_collection.check_is_owner_or_admin(&sender)?;457458 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor);459 target_collection.save()460 }461462 /// # Permissions463 ///464 /// * Sponsor.465 ///466 /// # Arguments467 ///468 /// * collection_id.469 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]470 #[transactional]471 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {472 let sender = ensure_signed(origin)?;473474 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;475 ensure!(476 target_collection.sponsorship.pending_sponsor() == Some(&sender),477 Error::<T>::ConfirmUnsetSponsorFail478 );479480 target_collection.sponsorship = SponsorshipState::Confirmed(sender);481 target_collection.save()482 }483484 /// Switch back to pay-per-own-transaction model.485 ///486 /// # Permissions487 ///488 /// * Collection owner.489 ///490 /// # Arguments491 ///492 /// * collection_id.493 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]494 #[transactional]495 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {496 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);497498 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;499 target_collection.check_is_owner(&sender)?;500501 target_collection.sponsorship = SponsorshipState::Disabled;502 target_collection.save()503 }504505 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.506 ///507 /// # Permissions508 ///509 /// * Collection Owner.510 /// * Collection Admin.511 /// * Anyone if512 /// * White List is enabled, and513 /// * Address is added to white list, and514 /// * MintPermission is enabled (see SetMintPermission method)515 ///516 /// # Arguments517 ///518 /// * collection_id: ID of the collection.519 ///520 /// * owner: Address, initial owner of the NFT.521 ///522 /// * data: Token data to store on chain.523 #[weight = <CommonWeights<T>>::create_item()]524 #[transactional]525 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {526 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);527528 dispatch_call::<T, _>(collection_id, |d| d.create_item(sender, owner, data))529 }530531 /// This method creates multiple items in a collection created with CreateCollection method.532 ///533 /// # Permissions534 ///535 /// * Collection Owner.536 /// * Collection Admin.537 /// * Anyone if538 /// * White List is enabled, and539 /// * Address is added to white list, and540 /// * MintPermission is enabled (see SetMintPermission method)541 ///542 /// # Arguments543 ///544 /// * collection_id: ID of the collection.545 ///546 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].547 ///548 /// * owner: Address, initial owner of the NFT.549 #[weight = <CommonWeights<T>>::create_multiple_items(items_data.len() as u32)]550 #[transactional]551 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {552 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);553 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);554555 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data))556 }557558 // TODO! transaction weight559560 /// Set transfers_enabled value for particular collection561 ///562 /// # Permissions563 ///564 /// * Collection Owner.565 ///566 /// # Arguments567 ///568 /// * collection_id: ID of the collection.569 ///570 /// * value: New flag value.571 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]572 #[transactional]573 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {574 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);575 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;576 target_collection.check_is_owner(&sender)?;577578 // =========579580 target_collection.limits.transfers_enabled = Some(value);581 target_collection.save()582 }583584 /// Destroys a concrete instance of NFT.585 ///586 /// # Permissions587 ///588 /// * Collection Owner.589 /// * Collection Admin.590 /// * Current NFT Owner.591 ///592 /// # Arguments593 ///594 /// * collection_id: ID of the collection.595 ///596 /// * item_id: ID of NFT to burn.597 #[weight = <CommonWeights<T>>::burn_item()]598 #[transactional]599 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {600 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);601602 dispatch_call::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))603 }604605 /// Destroys a concrete instance of NFT on behalf of the owner606 /// See also: [`approve`]607 ///608 /// # Permissions609 ///610 /// * Collection Owner.611 /// * Collection Admin.612 /// * Current NFT Owner.613 ///614 /// # Arguments615 ///616 /// * collection_id: ID of the collection.617 ///618 /// * item_id: ID of NFT to burn.619 ///620 /// * from: owner of item621 #[weight = <CommonWeights<T>>::burn_from()]622 #[transactional]623 pub fn burn_from(origin, collection_id: CollectionId, from: T::CrossAccountId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {624 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);625626 dispatch_call::<T, _>(collection_id, |d| d.burn_from(sender, from, item_id, value))627 }628629 /// Change ownership of the token.630 ///631 /// # Permissions632 ///633 /// * Collection Owner634 /// * Collection Admin635 /// * Current NFT owner636 ///637 /// # Arguments638 ///639 /// * recipient: Address of token recipient.640 ///641 /// * collection_id.642 ///643 /// * item_id: ID of the item644 /// * Non-Fungible Mode: Required.645 /// * Fungible Mode: Ignored.646 /// * Re-Fungible Mode: Required.647 ///648 /// * value: Amount to transfer.649 /// * Non-Fungible Mode: Ignored650 /// * Fungible Mode: Must specify transferred amount651 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)652 #[weight = <CommonWeights<T>>::transfer()]653 #[transactional]654 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {655 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);656657 dispatch_call::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value))658 }659660 /// Set, change, or remove approved address to transfer the ownership of the NFT.661 ///662 /// # Permissions663 ///664 /// * Collection Owner665 /// * Collection Admin666 /// * Current NFT owner667 ///668 /// # Arguments669 ///670 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).671 ///672 /// * collection_id.673 ///674 /// * item_id: ID of the item.675 #[weight = <CommonWeights<T>>::approve()]676 #[transactional]677 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {678 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);679680 dispatch_call::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))681 }682683 /// 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.684 ///685 /// # Permissions686 /// * Collection Owner687 /// * Collection Admin688 /// * Current NFT owner689 /// * Address approved by current NFT owner690 ///691 /// # Arguments692 ///693 /// * from: Address that owns token.694 ///695 /// * recipient: Address of token recipient.696 ///697 /// * collection_id.698 ///699 /// * item_id: ID of the item.700 ///701 /// * value: Amount to transfer.702 #[weight = <CommonWeights<T>>::transfer_from()]703 #[transactional]704 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {705 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);706707 dispatch_call::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value))708 }709710 /// Set off-chain data schema.711 ///712 /// # Permissions713 ///714 /// * Collection Owner715 /// * Collection Admin716 ///717 /// # Arguments718 ///719 /// * collection_id.720 ///721 /// * schema: String representing the offchain data schema.722 #[weight = <CommonWeights<T>>::set_variable_metadata(data.len() as u32)]723 #[transactional]724 pub fn set_variable_meta_data (725 origin,726 collection_id: CollectionId,727 item_id: TokenId,728 data: Vec<u8>729 ) -> DispatchResultWithPostInfo {730 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);731732 dispatch_call::<T, _>(collection_id, |d| d.set_variable_metadata(sender, item_id, data))733 }734735 /// Set meta_update_permission value for particular collection736 ///737 /// # Permissions738 ///739 /// * Collection Owner.740 ///741 /// # Arguments742 ///743 /// * collection_id: ID of the collection.744 ///745 /// * value: New flag value.746 #[weight = <SelfWeightOf<T>>::set_meta_update_permission_flag()]747 #[transactional]748 pub fn set_meta_update_permission_flag(origin, collection_id: CollectionId, value: MetaUpdatePermission) -> DispatchResult {749 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);750 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;751752 ensure!(753 target_collection.meta_update_permission != MetaUpdatePermission::None,754 <CommonError<T>>::MetadataFlagFrozen,755 );756 target_collection.check_is_owner(&sender)?;757758 target_collection.meta_update_permission = value;759760 target_collection.save()761 }762763 /// Set schema standard764 /// ImageURL765 /// Unique766 ///767 /// # Permissions768 ///769 /// * Collection Owner770 /// * Collection Admin771 ///772 /// # Arguments773 ///774 /// * collection_id.775 ///776 /// * schema: SchemaVersion: enum777 #[weight = <SelfWeightOf<T>>::set_schema_version()]778 #[transactional]779 pub fn set_schema_version(780 origin,781 collection_id: CollectionId,782 version: SchemaVersion783 ) -> DispatchResult {784 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);785 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;786 target_collection.check_is_owner_or_admin(&sender)?;787 target_collection.schema_version = version;788 target_collection.save()789 }790791 /// Set off-chain data schema.792 ///793 /// # Permissions794 ///795 /// * Collection Owner796 /// * Collection Admin797 ///798 /// # Arguments799 ///800 /// * collection_id.801 ///802 /// * schema: String representing the offchain data schema.803 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]804 #[transactional]805 pub fn set_offchain_schema(806 origin,807 collection_id: CollectionId,808 schema: Vec<u8>809 ) -> DispatchResult {810 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);811 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;812 target_collection.check_is_owner_or_admin(&sender)?;813814 // check schema limit815 ensure!(schema.len() as u32 <= OFFCHAIN_SCHEMA_LIMIT, "");816817 target_collection.offchain_schema = schema;818 target_collection.save()819 }820821 /// Set const on-chain data schema.822 ///823 /// # Permissions824 ///825 /// * Collection Owner826 /// * Collection Admin827 ///828 /// # Arguments829 ///830 /// * collection_id.831 ///832 /// * schema: String representing the const on-chain data schema.833 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]834 #[transactional]835 pub fn set_const_on_chain_schema (836 origin,837 collection_id: CollectionId,838 schema: Vec<u8>839 ) -> DispatchResult {840 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);841 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;842 target_collection.check_is_owner_or_admin(&sender)?;843844 // check schema limit845 ensure!(schema.len() as u32 <= CONST_ON_CHAIN_SCHEMA_LIMIT, "");846847 target_collection.const_on_chain_schema = schema;848 target_collection.save()849 }850851 /// Set variable on-chain data schema.852 ///853 /// # Permissions854 ///855 /// * Collection Owner856 /// * Collection Admin857 ///858 /// # Arguments859 ///860 /// * collection_id.861 ///862 /// * schema: String representing the variable on-chain data schema.863 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]864 #[transactional]865 pub fn set_variable_on_chain_schema (866 origin,867 collection_id: CollectionId,868 schema: Vec<u8>869 ) -> DispatchResult {870 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);871 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;872 target_collection.check_is_owner_or_admin(&sender)?;873874 // check schema limit875 ensure!(schema.len() as u32 <= VARIABLE_ON_CHAIN_SCHEMA_LIMIT, "");876877 target_collection.variable_on_chain_schema = schema;878 target_collection.save()879 }880881 #[weight = <SelfWeightOf<T>>::set_collection_limits()]882 #[transactional]883 pub fn set_collection_limits(884 origin,885 collection_id: CollectionId,886 new_limit: CollectionLimits,887 ) -> DispatchResult {888 let mut new_limit = new_limit;889 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);890 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;891 target_collection.check_is_owner(&sender)?;892 let old_limit = &target_collection.limits;893894 macro_rules! limit_default {895 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{896 $(897 if let Some($new) = $new.$field {898 let $old = $old.$field($($arg)?);899 let _ = $new;900 let _ = $old;901 $check902 } else {903 $new.$field = $old.$field904 }905 )*906 }};907 }908909 limit_default!(old_limit, new_limit,910 account_token_ownership_limit => ensure!(911 new_limit <= MAX_TOKEN_OWNERSHIP,912 <Error<T>>::CollectionLimitBoundsExceeded,913 ),914 sponsor_transfer_timeout(match target_collection.mode {915 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,916 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,917 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,918 }) => ensure!(919 new_limit <= MAX_SPONSOR_TIMEOUT,920 <Error<T>>::CollectionLimitBoundsExceeded,921 ),922 sponsored_data_size => ensure!(923 new_limit <= CUSTOM_DATA_LIMIT,924 <Error<T>>::CollectionLimitBoundsExceeded,925 ),926 token_limit => ensure!(927 old_limit >= new_limit && new_limit > 0,928 <CommonError<T>>::CollectionTokenLimitExceeded929 ),930 owner_can_transfer => ensure!(931 old_limit || !new_limit,932 <Error<T>>::OwnerPermissionsCantBeReverted,933 ),934 owner_can_destroy => ensure!(935 old_limit || !new_limit,936 <Error<T>>::OwnerPermissionsCantBeReverted,937 ),938 sponsored_data_rate_limit => {},939 transfers_enabled => {},940 );941942 target_collection.limits = new_limit;943944 target_collection.save()945 }946 }947}948949// TODO: limit returned entries?950impl<T: Config> Pallet<T> {951 pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {952 <IsAdmin<T>>::iter_prefix((collection,))953 .map(|(a, _)| a)954 .collect()955 }956 pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {957 <Allowlist<T>>::iter_prefix((collection,))958 .map(|(a, _)| a)959 .collect()960 }961}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_module, decl_storage, decl_error,20 dispatch::DispatchResult,21 ensure, fail, parameter_types,22 traits::{23 ExistenceRequirement, Get, Imbalance, KeyOwnerProofSystem, OnUnbalanced, Randomness,24 IsSubType, WithdrawReasons,25 },26 weights::{27 constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},28 DispatchInfo, GetDispatchInfo, IdentityFee, Pays, PostDispatchInfo, Weight,29 WeightToFeePolynomial, DispatchClass,30 },31 StorageValue, transactional,32 pallet_prelude::DispatchResultWithPostInfo,33};34use scale_info::TypeInfo;35use frame_system::{self as system, ensure_signed};36use sp_runtime::{sp_std::prelude::Vec};37use nft_data_structs::{38 MAX_DECIMAL_POINTS, MAX_SPONSOR_TIMEOUT, MAX_TOKEN_OWNERSHIP, CUSTOM_DATA_LIMIT,39 VARIABLE_ON_CHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, OFFCHAIN_SCHEMA_LIMIT,40 FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT, REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,41 NFT_SPONSOR_TRANSFER_TIMEOUT, AccessMode, Collection, CreateItemData, CollectionLimits,42 CollectionId, CollectionMode, TokenId, SchemaVersion, SponsorshipState, MetaUpdatePermission,43};44use pallet_common::{45 account::CrossAccountId, CollectionHandle, IsAdmin, Pallet as PalletCommon,46 Error as CommonError, CommonWeightInfo, Allowlist,47};48use pallet_refungible::{Pallet as PalletRefungible, RefungibleHandle};49use pallet_fungible::{Pallet as PalletFungible, FungibleHandle};50use pallet_nonfungible::{Pallet as PalletNonfungible, NonfungibleHandle};5152#[cfg(test)]53mod mock;5455#[cfg(test)]56mod tests;5758mod eth;59mod sponsorship;60pub use sponsorship::NftSponsorshipHandler;61pub use eth::sponsoring::NftEthSponsorshipHandler;6263pub use eth::NftErcSupport;6465pub mod common;66use common::CommonWeights;67pub mod dispatch;68use dispatch::dispatch_call;6970#[cfg(feature = "runtime-benchmarks")]71mod benchmarking;72pub mod weights;73use weights::WeightInfo;7475decl_error! {76 /// Error for non-fungible-token module.77 pub enum Error for Module<T: Config> {78 /// Decimal_points parameter must be lower than MAX_DECIMAL_POINTS constant, currently it is 30.79 CollectionDecimalPointLimitExceeded,80 /// This address is not set as sponsor, use setCollectionSponsor first.81 ConfirmUnsetSponsorFail,82 /// Length of items properties must be greater than 0.83 EmptyArgument,84 /// Collection limit bounds per collection exceeded85 CollectionLimitBoundsExceeded,86 /// Tried to enable permissions which are only permitted to be disabled87 OwnerPermissionsCantBeReverted,88 }89}90pub trait Config:91 system::Config92 + pallet_evm_coder_substrate::Config93 + pallet_common::Config94 + pallet_nonfungible::Config95 + pallet_refungible::Config96 + pallet_fungible::Config97 + Sized98 + TypeInfo99{100 /// Weight information for extrinsics in this pallet.101 type WeightInfo: WeightInfo;102}103104type SelfWeightOf<T> = <T as Config>::WeightInfo;105106// # Used definitions107//108// ## User control levels109//110// chain-controlled - key is uncontrolled by user111// i.e autoincrementing index112// can use non-cryptographic hash113// real - key is controlled by user114// but it is hard to generate enough colliding values, i.e owner of signed txs115// can use non-cryptographic hash116// controlled - key is completly controlled by users117// i.e maps with mutable keys118// should use cryptographic hash119//120// ## User control level downgrade reasons121//122// ?1 - chain-controlled -> controlled123// collections/tokens can be destroyed, resulting in massive holes124// ?2 - chain-controlled -> controlled125// same as ?1, but can be only added, resulting in easier exploitation126// ?3 - real -> controlled127// no confirmation required, so addresses can be easily generated128decl_storage! {129 trait Store for Module<T: Config> as Nft {130131 //#region Private members132 /// Used for migrations133 ChainVersion: u64;134 //#endregion135136 //#region Tokens transfer rate limit baskets137 /// (Collection id (controlled?2), who created (real))138 /// TODO: Off chain worker should remove from this map when collection gets removed139 pub CreateItemBasket get(fn create_item_basket): map hasher(blake2_128_concat) (CollectionId, T::AccountId) => T::BlockNumber;140 /// Collection id (controlled?2), token id (controlled?2)141 pub NftTransferBasket get(fn nft_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;142 /// Collection id (controlled?2), owning user (real)143 pub FungibleTransferBasket get(fn fungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(twox_64_concat) T::AccountId => T::BlockNumber;144 /// Collection id (controlled?2), token id (controlled?2)145 pub ReFungibleTransferBasket get(fn refungible_transfer_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => T::BlockNumber;146 //#endregion147148 /// Variable metadata sponsoring149 /// Collection id (controlled?2), token id (controlled?2)150 pub VariableMetaDataBasket get(fn variable_meta_data_basket): double_map hasher(blake2_128_concat) CollectionId, hasher(blake2_128_concat) TokenId => Option<T::BlockNumber> = None;151 }152}153154decl_module! {155 pub struct Module<T: Config> for enum Call156 where157 origin: T::Origin158 {159 type Error = Error<T>;160161 fn on_initialize(_now: T::BlockNumber) -> Weight {162 0163 }164165 /// 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.166 ///167 /// # Permissions168 ///169 /// * Anyone.170 ///171 /// # Arguments172 ///173 /// * collection_name: UTF-16 string with collection name (limit 64 characters), will be stored as zero-terminated.174 ///175 /// * collection_description: UTF-16 string with collection description (limit 256 characters), will be stored as zero-terminated.176 ///177 /// * token_prefix: UTF-8 string with token prefix.178 ///179 /// * mode: [CollectionMode] collection type and type dependent data.180 // returns collection ID181 #[weight = <SelfWeightOf<T>>::create_collection()]182 #[transactional]183 pub fn create_collection(origin,184 collection_name: Vec<u16>,185 collection_description: Vec<u16>,186 token_prefix: Vec<u8>,187 mode: CollectionMode) -> DispatchResult {188189 // Anyone can create a collection190 let who = ensure_signed(origin)?;191192 // Create new collection193 let new_collection = Collection::<T> {194 owner: who.clone(),195 name: collection_name,196 mode: mode.clone(),197 mint_mode: false,198 access: AccessMode::Normal,199 description: collection_description,200 token_prefix,201 offchain_schema: Vec::new(),202 schema_version: SchemaVersion::ImageURL,203 sponsorship: SponsorshipState::Disabled,204 variable_on_chain_schema: Vec::new(),205 const_on_chain_schema: Vec::new(),206 limits: Default::default(),207 meta_update_permission: Default::default(),208 };209210 let _id = match mode {211 CollectionMode::NFT => {PalletNonfungible::init_collection(new_collection)?},212 CollectionMode::Fungible(decimal_points) => {213 // check params214 ensure!(decimal_points <= MAX_DECIMAL_POINTS, Error::<T>::CollectionDecimalPointLimitExceeded);215 PalletFungible::init_collection(new_collection)?216 }217 CollectionMode::ReFungible => {218 PalletRefungible::init_collection(new_collection)?219 }220 };221222 Ok(())223 }224225 /// **DANGEROUS**: Destroys collection and all NFTs within this collection. Users irrecoverably lose their assets and may lose real money.226 ///227 /// # Permissions228 ///229 /// * Collection Owner.230 ///231 /// # Arguments232 ///233 /// * collection_id: collection to destroy.234 #[weight = <SelfWeightOf<T>>::destroy_collection()]235 #[transactional]236 pub fn destroy_collection(origin, collection_id: CollectionId) -> DispatchResult {237 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);238239 let collection = <CollectionHandle<T>>::try_get(collection_id)?;240 collection.check_is_owner(&sender)?;241242 // =========243244 match collection.mode {245 CollectionMode::ReFungible => PalletRefungible::destroy_collection(RefungibleHandle::cast(collection), &sender)?,246 CollectionMode::Fungible(_) => PalletFungible::destroy_collection(FungibleHandle::cast(collection), &sender)?,247 CollectionMode::NFT => PalletNonfungible::destroy_collection(NonfungibleHandle::cast(collection), &sender)?,248 }249250 <NftTransferBasket<T>>::remove_prefix(collection_id, None);251 <FungibleTransferBasket<T>>::remove_prefix(collection_id, None);252 <ReFungibleTransferBasket<T>>::remove_prefix(collection_id, None);253254 <VariableMetaDataBasket<T>>::remove_prefix(collection_id, None);255256 Ok(())257 }258259 /// Add an address to white list.260 ///261 /// # Permissions262 ///263 /// * Collection Owner264 /// * Collection Admin265 ///266 /// # Arguments267 ///268 /// * collection_id.269 ///270 /// * address.271 #[weight = <SelfWeightOf<T>>::add_to_white_list()]272 #[transactional]273 pub fn add_to_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{274275 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);276 let collection = <CollectionHandle<T>>::try_get(collection_id)?;277278 <PalletCommon<T>>::toggle_allowlist(279 &collection,280 &sender,281 &address,282 true,283 )?;284285 Ok(())286 }287288 /// Remove an address from white list.289 ///290 /// # Permissions291 ///292 /// * Collection Owner293 /// * Collection Admin294 ///295 /// # Arguments296 ///297 /// * collection_id.298 ///299 /// * address.300 #[weight = <SelfWeightOf<T>>::remove_from_white_list()]301 #[transactional]302 pub fn remove_from_white_list(origin, collection_id: CollectionId, address: T::CrossAccountId) -> DispatchResult{303304 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);305 let collection = <CollectionHandle<T>>::try_get(collection_id)?;306307 <PalletCommon<T>>::toggle_allowlist(308 &collection,309 &sender,310 &address,311 false,312 )?;313314 Ok(())315 }316317 /// Toggle between normal and white list access for the methods with access for `Anyone`.318 ///319 /// # Permissions320 ///321 /// * Collection Owner.322 ///323 /// # Arguments324 ///325 /// * collection_id.326 ///327 /// * mode: [AccessMode]328 #[weight = <SelfWeightOf<T>>::set_public_access_mode()]329 #[transactional]330 pub fn set_public_access_mode(origin, collection_id: CollectionId, mode: AccessMode) -> DispatchResult331 {332 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);333334 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;335 target_collection.check_is_owner(&sender)?;336337 target_collection.access = mode;338 target_collection.save()339 }340341 /// Allows Anyone to create tokens if:342 /// * White List is enabled, and343 /// * Address is added to white list, and344 /// * This method was called with True parameter345 ///346 /// # Permissions347 /// * Collection Owner348 ///349 /// # Arguments350 ///351 /// * collection_id.352 ///353 /// * mint_permission: Boolean parameter. If True, allows minting to Anyone with conditions above.354 #[weight = <SelfWeightOf<T>>::set_mint_permission()]355 #[transactional]356 pub fn set_mint_permission(origin, collection_id: CollectionId, mint_permission: bool) -> DispatchResult357 {358 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);359360 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;361 target_collection.check_is_owner(&sender)?;362363 target_collection.mint_mode = mint_permission;364 target_collection.save()365 }366367 /// Change the owner of the collection.368 ///369 /// # Permissions370 ///371 /// * Collection Owner.372 ///373 /// # Arguments374 ///375 /// * collection_id.376 ///377 /// * new_owner.378 #[weight = <SelfWeightOf<T>>::change_collection_owner()]379 #[transactional]380 pub fn change_collection_owner(origin, collection_id: CollectionId, new_owner: T::AccountId) -> DispatchResult {381382 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);383384 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;385 target_collection.check_is_owner(&sender)?;386387 target_collection.owner = new_owner;388 target_collection.save()389 }390391 /// Adds an admin of the Collection.392 /// 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.393 ///394 /// # Permissions395 ///396 /// * Collection Owner.397 /// * Collection Admin.398 ///399 /// # Arguments400 ///401 /// * collection_id: ID of the Collection to add admin for.402 ///403 /// * new_admin_id: Address of new admin to add.404 #[weight = <SelfWeightOf<T>>::add_collection_admin()]405 #[transactional]406 pub fn add_collection_admin(origin, collection_id: CollectionId, new_admin_id: T::CrossAccountId) -> DispatchResult {407 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);408 let collection = <CollectionHandle<T>>::try_get(collection_id)?;409410 <PalletCommon<T>>::toggle_admin(&collection, &sender, &new_admin_id, true)411 }412413 /// 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.414 ///415 /// # Permissions416 ///417 /// * Collection Owner.418 /// * Collection Admin.419 ///420 /// # Arguments421 ///422 /// * collection_id: ID of the Collection to remove admin for.423 ///424 /// * account_id: Address of admin to remove.425 #[weight = <SelfWeightOf<T>>::remove_collection_admin()]426 #[transactional]427 pub fn remove_collection_admin(origin, collection_id: CollectionId, account_id: T::CrossAccountId) -> DispatchResult {428 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);429 let collection = <CollectionHandle<T>>::try_get(collection_id)?;430431 <PalletCommon<T>>::toggle_admin(&collection, &sender, &account_id, false)432 }433434 /// # Permissions435 ///436 /// * Collection Owner437 ///438 /// # Arguments439 ///440 /// * collection_id.441 ///442 /// * new_sponsor.443 #[weight = <SelfWeightOf<T>>::set_collection_sponsor()]444 #[transactional]445 pub fn set_collection_sponsor(origin, collection_id: CollectionId, new_sponsor: T::AccountId) -> DispatchResult {446 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);447448 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;449 target_collection.check_is_owner_or_admin(&sender)?;450451 target_collection.sponsorship = SponsorshipState::Unconfirmed(new_sponsor);452 target_collection.save()453 }454455 /// # Permissions456 ///457 /// * Sponsor.458 ///459 /// # Arguments460 ///461 /// * collection_id.462 #[weight = <SelfWeightOf<T>>::confirm_sponsorship()]463 #[transactional]464 pub fn confirm_sponsorship(origin, collection_id: CollectionId) -> DispatchResult {465 let sender = ensure_signed(origin)?;466467 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;468 ensure!(469 target_collection.sponsorship.pending_sponsor() == Some(&sender),470 Error::<T>::ConfirmUnsetSponsorFail471 );472473 target_collection.sponsorship = SponsorshipState::Confirmed(sender);474 target_collection.save()475 }476477 /// Switch back to pay-per-own-transaction model.478 ///479 /// # Permissions480 ///481 /// * Collection owner.482 ///483 /// # Arguments484 ///485 /// * collection_id.486 #[weight = <SelfWeightOf<T>>::remove_collection_sponsor()]487 #[transactional]488 pub fn remove_collection_sponsor(origin, collection_id: CollectionId) -> DispatchResult {489 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);490491 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;492 target_collection.check_is_owner(&sender)?;493494 target_collection.sponsorship = SponsorshipState::Disabled;495 target_collection.save()496 }497498 /// This method creates a concrete instance of NFT Collection created with CreateCollection method.499 ///500 /// # Permissions501 ///502 /// * Collection Owner.503 /// * Collection Admin.504 /// * Anyone if505 /// * White List is enabled, and506 /// * Address is added to white list, and507 /// * MintPermission is enabled (see SetMintPermission method)508 ///509 /// # Arguments510 ///511 /// * collection_id: ID of the collection.512 ///513 /// * owner: Address, initial owner of the NFT.514 ///515 /// * data: Token data to store on chain.516 #[weight = <CommonWeights<T>>::create_item()]517 #[transactional]518 pub fn create_item(origin, collection_id: CollectionId, owner: T::CrossAccountId, data: CreateItemData) -> DispatchResultWithPostInfo {519 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);520521 dispatch_call::<T, _>(collection_id, |d| d.create_item(sender, owner, data))522 }523524 /// This method creates multiple items in a collection created with CreateCollection method.525 ///526 /// # Permissions527 ///528 /// * Collection Owner.529 /// * Collection Admin.530 /// * Anyone if531 /// * White List is enabled, and532 /// * Address is added to white list, and533 /// * MintPermission is enabled (see SetMintPermission method)534 ///535 /// # Arguments536 ///537 /// * collection_id: ID of the collection.538 ///539 /// * itemsData: Array items properties. Each property is an array of bytes itself, see [create_item].540 ///541 /// * owner: Address, initial owner of the NFT.542 #[weight = <CommonWeights<T>>::create_multiple_items(items_data.len() as u32)]543 #[transactional]544 pub fn create_multiple_items(origin, collection_id: CollectionId, owner: T::CrossAccountId, items_data: Vec<CreateItemData>) -> DispatchResultWithPostInfo {545 ensure!(!items_data.is_empty(), Error::<T>::EmptyArgument);546 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);547548 dispatch_call::<T, _>(collection_id, |d| d.create_multiple_items(sender, owner, items_data))549 }550551 // TODO! transaction weight552553 /// Set transfers_enabled value for particular collection554 ///555 /// # Permissions556 ///557 /// * Collection Owner.558 ///559 /// # Arguments560 ///561 /// * collection_id: ID of the collection.562 ///563 /// * value: New flag value.564 #[weight = <SelfWeightOf<T>>::set_transfers_enabled_flag()]565 #[transactional]566 pub fn set_transfers_enabled_flag(origin, collection_id: CollectionId, value: bool) -> DispatchResult {567 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);568 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;569 target_collection.check_is_owner(&sender)?;570571 // =========572573 target_collection.limits.transfers_enabled = Some(value);574 target_collection.save()575 }576577 /// Destroys a concrete instance of NFT.578 ///579 /// # Permissions580 ///581 /// * Collection Owner.582 /// * Collection Admin.583 /// * Current NFT Owner.584 ///585 /// # Arguments586 ///587 /// * collection_id: ID of the collection.588 ///589 /// * item_id: ID of NFT to burn.590 #[weight = <CommonWeights<T>>::burn_item()]591 #[transactional]592 pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {593 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);594595 dispatch_call::<T, _>(collection_id, |d| d.burn_item(sender, item_id, value))596 }597598 /// Destroys a concrete instance of NFT on behalf of the owner599 /// See also: [`approve`]600 ///601 /// # Permissions602 ///603 /// * Collection Owner.604 /// * Collection Admin.605 /// * Current NFT Owner.606 ///607 /// # Arguments608 ///609 /// * collection_id: ID of the collection.610 ///611 /// * item_id: ID of NFT to burn.612 ///613 /// * from: owner of item614 #[weight = <CommonWeights<T>>::burn_from()]615 #[transactional]616 pub fn burn_from(origin, collection_id: CollectionId, from: T::CrossAccountId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {617 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);618619 dispatch_call::<T, _>(collection_id, |d| d.burn_from(sender, from, item_id, value))620 }621622 /// Change ownership of the token.623 ///624 /// # Permissions625 ///626 /// * Collection Owner627 /// * Collection Admin628 /// * Current NFT owner629 ///630 /// # Arguments631 ///632 /// * recipient: Address of token recipient.633 ///634 /// * collection_id.635 ///636 /// * item_id: ID of the item637 /// * Non-Fungible Mode: Required.638 /// * Fungible Mode: Ignored.639 /// * Re-Fungible Mode: Required.640 ///641 /// * value: Amount to transfer.642 /// * Non-Fungible Mode: Ignored643 /// * Fungible Mode: Must specify transferred amount644 /// * Re-Fungible Mode: Must specify transferred portion (between 0 and 1)645 #[weight = <CommonWeights<T>>::transfer()]646 #[transactional]647 pub fn transfer(origin, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResultWithPostInfo {648 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);649650 dispatch_call::<T, _>(collection_id, |d| d.transfer(sender, recipient, item_id, value))651 }652653 /// Set, change, or remove approved address to transfer the ownership of the NFT.654 ///655 /// # Permissions656 ///657 /// * Collection Owner658 /// * Collection Admin659 /// * Current NFT owner660 ///661 /// # Arguments662 ///663 /// * approved: Address that is approved to transfer this NFT or zero (if needed to remove approval).664 ///665 /// * collection_id.666 ///667 /// * item_id: ID of the item.668 #[weight = <CommonWeights<T>>::approve()]669 #[transactional]670 pub fn approve(origin, spender: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, amount: u128) -> DispatchResultWithPostInfo {671 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);672673 dispatch_call::<T, _>(collection_id, |d| d.approve(sender, spender, item_id, amount))674 }675676 /// 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.677 ///678 /// # Permissions679 /// * Collection Owner680 /// * Collection Admin681 /// * Current NFT owner682 /// * Address approved by current NFT owner683 ///684 /// # Arguments685 ///686 /// * from: Address that owns token.687 ///688 /// * recipient: Address of token recipient.689 ///690 /// * collection_id.691 ///692 /// * item_id: ID of the item.693 ///694 /// * value: Amount to transfer.695 #[weight = <CommonWeights<T>>::transfer_from()]696 #[transactional]697 pub fn transfer_from(origin, from: T::CrossAccountId, recipient: T::CrossAccountId, collection_id: CollectionId, item_id: TokenId, value: u128 ) -> DispatchResultWithPostInfo {698 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);699700 dispatch_call::<T, _>(collection_id, |d| d.transfer_from(sender, from, recipient, item_id, value))701 }702703 /// Set off-chain data schema.704 ///705 /// # Permissions706 ///707 /// * Collection Owner708 /// * Collection Admin709 ///710 /// # Arguments711 ///712 /// * collection_id.713 ///714 /// * schema: String representing the offchain data schema.715 #[weight = <CommonWeights<T>>::set_variable_metadata(data.len() as u32)]716 #[transactional]717 pub fn set_variable_meta_data (718 origin,719 collection_id: CollectionId,720 item_id: TokenId,721 data: Vec<u8>722 ) -> DispatchResultWithPostInfo {723 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);724725 dispatch_call::<T, _>(collection_id, |d| d.set_variable_metadata(sender, item_id, data))726 }727728 /// Set meta_update_permission value for particular collection729 ///730 /// # Permissions731 ///732 /// * Collection Owner.733 ///734 /// # Arguments735 ///736 /// * collection_id: ID of the collection.737 ///738 /// * value: New flag value.739 #[weight = <SelfWeightOf<T>>::set_meta_update_permission_flag()]740 #[transactional]741 pub fn set_meta_update_permission_flag(origin, collection_id: CollectionId, value: MetaUpdatePermission) -> DispatchResult {742 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);743 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;744745 ensure!(746 target_collection.meta_update_permission != MetaUpdatePermission::None,747 <CommonError<T>>::MetadataFlagFrozen,748 );749 target_collection.check_is_owner(&sender)?;750751 target_collection.meta_update_permission = value;752753 target_collection.save()754 }755756 /// Set schema standard757 /// ImageURL758 /// Unique759 ///760 /// # Permissions761 ///762 /// * Collection Owner763 /// * Collection Admin764 ///765 /// # Arguments766 ///767 /// * collection_id.768 ///769 /// * schema: SchemaVersion: enum770 #[weight = <SelfWeightOf<T>>::set_schema_version()]771 #[transactional]772 pub fn set_schema_version(773 origin,774 collection_id: CollectionId,775 version: SchemaVersion776 ) -> DispatchResult {777 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);778 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;779 target_collection.check_is_owner_or_admin(&sender)?;780 target_collection.schema_version = version;781 target_collection.save()782 }783784 /// Set off-chain data schema.785 ///786 /// # Permissions787 ///788 /// * Collection Owner789 /// * Collection Admin790 ///791 /// # Arguments792 ///793 /// * collection_id.794 ///795 /// * schema: String representing the offchain data schema.796 #[weight = <SelfWeightOf<T>>::set_offchain_schema(schema.len() as u32)]797 #[transactional]798 pub fn set_offchain_schema(799 origin,800 collection_id: CollectionId,801 schema: Vec<u8>802 ) -> DispatchResult {803 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);804 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;805 target_collection.check_is_owner_or_admin(&sender)?;806807 // check schema limit808 ensure!(schema.len() as u32 <= OFFCHAIN_SCHEMA_LIMIT, "");809810 target_collection.offchain_schema = schema;811 target_collection.save()812 }813814 /// Set const on-chain data schema.815 ///816 /// # Permissions817 ///818 /// * Collection Owner819 /// * Collection Admin820 ///821 /// # Arguments822 ///823 /// * collection_id.824 ///825 /// * schema: String representing the const on-chain data schema.826 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]827 #[transactional]828 pub fn set_const_on_chain_schema (829 origin,830 collection_id: CollectionId,831 schema: Vec<u8>832 ) -> DispatchResult {833 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);834 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;835 target_collection.check_is_owner_or_admin(&sender)?;836837 // check schema limit838 ensure!(schema.len() as u32 <= CONST_ON_CHAIN_SCHEMA_LIMIT, "");839840 target_collection.const_on_chain_schema = schema;841 target_collection.save()842 }843844 /// Set variable on-chain data schema.845 ///846 /// # Permissions847 ///848 /// * Collection Owner849 /// * Collection Admin850 ///851 /// # Arguments852 ///853 /// * collection_id.854 ///855 /// * schema: String representing the variable on-chain data schema.856 #[weight = <SelfWeightOf<T>>::set_const_on_chain_schema(schema.len() as u32)]857 #[transactional]858 pub fn set_variable_on_chain_schema (859 origin,860 collection_id: CollectionId,861 schema: Vec<u8>862 ) -> DispatchResult {863 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);864 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;865 target_collection.check_is_owner_or_admin(&sender)?;866867 // check schema limit868 ensure!(schema.len() as u32 <= VARIABLE_ON_CHAIN_SCHEMA_LIMIT, "");869870 target_collection.variable_on_chain_schema = schema;871 target_collection.save()872 }873874 #[weight = <SelfWeightOf<T>>::set_collection_limits()]875 #[transactional]876 pub fn set_collection_limits(877 origin,878 collection_id: CollectionId,879 new_limit: CollectionLimits,880 ) -> DispatchResult {881 let mut new_limit = new_limit;882 let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);883 let mut target_collection = <CollectionHandle<T>>::try_get(collection_id)?;884 target_collection.check_is_owner(&sender)?;885 let old_limit = &target_collection.limits;886887 macro_rules! limit_default {888 ($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{889 $(890 if let Some($new) = $new.$field {891 let $old = $old.$field($($arg)?);892 let _ = $new;893 let _ = $old;894 $check895 } else {896 $new.$field = $old.$field897 }898 )*899 }};900 }901902 limit_default!(old_limit, new_limit,903 account_token_ownership_limit => ensure!(904 new_limit <= MAX_TOKEN_OWNERSHIP,905 <Error<T>>::CollectionLimitBoundsExceeded,906 ),907 sponsor_transfer_timeout(match target_collection.mode {908 CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,909 CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,910 CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,911 }) => ensure!(912 new_limit <= MAX_SPONSOR_TIMEOUT,913 <Error<T>>::CollectionLimitBoundsExceeded,914 ),915 sponsored_data_size => ensure!(916 new_limit <= CUSTOM_DATA_LIMIT,917 <Error<T>>::CollectionLimitBoundsExceeded,918 ),919 token_limit => ensure!(920 old_limit >= new_limit && new_limit > 0,921 <CommonError<T>>::CollectionTokenLimitExceeded922 ),923 owner_can_transfer => ensure!(924 old_limit || !new_limit,925 <Error<T>>::OwnerPermissionsCantBeReverted,926 ),927 owner_can_destroy => ensure!(928 old_limit || !new_limit,929 <Error<T>>::OwnerPermissionsCantBeReverted,930 ),931 sponsored_data_rate_limit => {},932 transfers_enabled => {},933 );934935 target_collection.limits = new_limit;936937 target_collection.save()938 }939 }940}941942// TODO: limit returned entries?943impl<T: Config> Pallet<T> {944 pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {945 <IsAdmin<T>>::iter_prefix((collection,))946 .map(|(a, _)| a)947 .collect()948 }949 pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {950 <Allowlist<T>>::iter_prefix((collection,))951 .map(|(a, _)| a)952 .collect()953 }954}primitives/nft/src/lib.rsdiffbeforeafterboth--- a/primitives/nft/src/lib.rs
+++ b/primitives/nft/src/lib.rs
@@ -41,7 +41,7 @@
} else {
10
};
-pub const COLLECTION_ADMINS_LIMIT: u64 = 5;
+pub const COLLECTION_ADMINS_LIMIT: u32 = 5;
pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;
pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {
1000000