git.delta.rocks / unique-network / refs/commits / f8b7b18b80b5

difftreelog

refactor move erc721metadata to flags

Yaroslav Bolyukin2022-10-13parent: #d4f43b6.patch.diff
in: master

6 files changed

modifiedpallets/common/src/erc.rsdiffbeforeafterboth
--- a/pallets/common/src/erc.rs
+++ b/pallets/common/src/erc.rs
@@ -706,9 +706,6 @@
 		/// Value "ERC721Metadata".
 		pub const ERC721_METADATA: &[u8] = b"ERC721Metadata";
 
-		/// Value "1" ERC721 metadata supported.
-		pub const ERC721_METADATA_SUPPORTED: &[u8] = b"1";
-
 		/// Value for [`ERC721_METADATA`].
 		pub fn erc721() -> up_data_structs::PropertyValue {
 			property_value_from_bytes(ERC721_METADATA).expect(EXPECT_CONVERT_ERROR)
@@ -717,11 +714,6 @@
 		/// Value for [`SCHEMA_VERSION`].
 		pub fn schema_version() -> up_data_structs::PropertyValue {
 			property_value_from_bytes(SCHEMA_VERSION).expect(EXPECT_CONVERT_ERROR)
-		}
-
-		/// Value for [`ERC721_METADATA_SUPPORTED`].
-		pub fn erc721_metadata_supported() -> up_data_structs::PropertyValue {
-			property_value_from_bytes(ERC721_METADATA_SUPPORTED).expect(EXPECT_CONVERT_ERROR)
 		}
 	}
 
modifiedpallets/common/src/lib.rsdiffbeforeafterboth
--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -71,6 +71,7 @@
 	Collection,
 	RpcCollection,
 	CollectionFlags,
+	RpcCollectionFlags,
 	CollectionId,
 	CreateItemData,
 	MAX_TOKEN_PREFIX_LENGTH,
@@ -824,7 +825,11 @@
 			token_property_permissions,
 			properties,
 			read_only: flags.external,
-			foreign: flags.foreign,
+
+			flags: RpcCollectionFlags {
+				foreign: flags.foreign,
+				erc721metadata: flags.erc721metadata,
+			},
 		})
 	}
 }
modifiedpallets/nonfungible/src/erc.rsdiffbeforeafterboth
--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -708,22 +708,6 @@
 	}
 }
 
-impl<T: Config> NonfungibleHandle<T> {
-	pub fn supports_metadata(&self) -> bool {
-		let has_metadata_support_enabled = if let Some(erc721_metadata) =
-			pallet_common::Pallet::<T>::get_collection_property(self.id, &key::erc721_metadata())
-		{
-			*erc721_metadata.into_inner() == *value::ERC721_METADATA_SUPPORTED
-		} else {
-			false
-		};
-
-		let has_url_property_permissions = get_token_permission::<T>(self.id, &key::url()).is_ok();
-
-		has_metadata_support_enabled && has_url_property_permissions
-	}
-}
-
 #[solidity_interface(
 	name = UniqueNFT,
 	is(
@@ -732,9 +716,9 @@
 		ERC721UniqueExtensions,
 		ERC721Mintable,
 		ERC721Burnable,
+		ERC721Metadata(if(this.flags.erc721metadata)),
 		Collection(via(common_mut returns CollectionHandle<T>)),
 		TokenProperties,
-		ERC721Metadata(if(this.supports_metadata())),
 	)
 )]
 impl<T: Config> NonfungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}
modifiedpallets/refungible/src/erc.rsdiffbeforeafterboth
--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -764,22 +764,6 @@
 	}
 }
 
-impl<T: Config> RefungibleHandle<T> {
-	pub fn supports_metadata(&self) -> bool {
-		let has_metadata_support_enabled = if let Some(erc721_metadata) =
-			pallet_common::Pallet::<T>::get_collection_property(self.id, &key::erc721_metadata())
-		{
-			*erc721_metadata.into_inner() == *value::ERC721_METADATA_SUPPORTED
-		} else {
-			false
-		};
-
-		let has_url_property_permissions = get_token_permission::<T>(self.id, &key::url()).is_ok();
-
-		has_metadata_support_enabled && has_url_property_permissions
-	}
-}
-
 #[solidity_interface(
 	name = UniqueRefungible,
 	is(
@@ -788,9 +772,9 @@
 		ERC721UniqueExtensions,
 		ERC721Mintable,
 		ERC721Burnable,
+		ERC721Metadata(if(this.flags.erc721metadata)),
 		Collection(via(common_mut returns CollectionHandle<T>)),
 		TokenProperties,
-		ERC721Metadata(if(this.supports_metadata())),
 	)
 )]
 impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}
modifiedpallets/unique/src/eth/mod.rsdiffbeforeafterboth
--- a/pallets/unique/src/eth/mod.rs
+++ b/pallets/unique/src/eth/mod.rs
@@ -89,6 +89,26 @@
 	Ok((caller, name, description, token_prefix, base_uri_value))
 }
 
+fn default_url_pkp() -> up_data_structs::PropertyKeyPermission {
+	up_data_structs::PropertyKeyPermission {
+		key: key::url(),
+		permission: up_data_structs::PropertyPermission {
+			mutable: true,
+			collection_admin: true,
+			token_owner: false,
+		},
+	}
+}
+fn default_suffix_pkp() -> up_data_structs::PropertyKeyPermission {
+	up_data_structs::PropertyKeyPermission {
+		key: key::suffix(),
+		permission: up_data_structs::PropertyPermission {
+			mutable: true,
+			collection_admin: true,
+			token_owner: false,
+		},
+	}
+}
 fn make_data<T: Config>(
 	name: CollectionName,
 	mode: CollectionMode,
@@ -98,26 +118,9 @@
 	add_properties: bool,
 ) -> Result<CreateCollectionData<T::AccountId>> {
 	let token_property_permissions = if add_properties {
-		vec![
-			up_data_structs::PropertyKeyPermission {
-				key: key::url(),
-				permission: up_data_structs::PropertyPermission {
-					mutable: true,
-					collection_admin: true,
-					token_owner: false,
-				},
-			},
-			up_data_structs::PropertyKeyPermission {
-				key: key::suffix(),
-				permission: up_data_structs::PropertyPermission {
-					mutable: true,
-					collection_admin: true,
-					token_owner: false,
-				},
-			},
-		]
-		.try_into()
-		.map_err(|e| Error::Revert(format!("{:?}", e)))?
+		vec![default_url_pkp(), default_suffix_pkp()]
+			.try_into()
+			.map_err(|e| Error::Revert(format!("{:?}", e)))?
 	} else {
 		up_data_structs::CollectionPropertiesPermissionsVec::default()
 	};
@@ -130,10 +133,6 @@
 			up_data_structs::Property {
 				key: key::schema_version(),
 				value: property_value::schema_version(),
-			},
-			up_data_structs::Property {
-				key: key::erc721_metadata(),
-				value: property_value::erc721_metadata_supported(),
 			},
 		];
 		if !base_uri_value.is_empty() {
modifiedprimitives/data-structs/src/lib.rsdiffbeforeafterboth
before · primitives/data-structs/src/lib.rs
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Primitives crate.18//!19//! This crate contains types, traits and constants.2021#![cfg_attr(not(feature = "std"), no_std)]2223use core::{24	convert::{TryFrom, TryInto},25	fmt,26};27use frame_support::{28	storage::{bounded_btree_map::BoundedBTreeMap, bounded_btree_set::BoundedBTreeSet},29	traits::Get,30	parameter_types,31};3233#[cfg(feature = "serde")]34use serde::{Serialize, Deserialize};3536use sp_core::U256;37use sp_runtime::{ArithmeticError, sp_std::prelude::Vec, Permill};38use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};39use bondrewd::Bitfields;40use frame_support::{BoundedVec, traits::ConstU32};41use derivative::Derivative;42use scale_info::TypeInfo;4344// RMRK45use rmrk_traits::{46	CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme, ThemeProperty,47	ResourceTypes, BasicResource, ComposableResource, SlotResource, EquippableList,48};49pub use rmrk_traits::{50	primitives::{51		CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,52		SlotId as RmrkSlotId, PartId as RmrkPartId, ResourceId as RmrkResourceId,53	},54	NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,55	FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart,56};5758mod bondrewd_codec;59mod bounded;60pub mod budget;61pub mod mapping;62mod migration;6364/// Maximum of decimal points.65pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;6667/// Maximum pieces for refungible token.68pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;69pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;7071/// Maximum tokens for user.72pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {73	100_00074} else {75	1076};7778/// Maximum for collections can be created.79pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {80	100_00081} else {82	1083};8485/// Maximum for various custom data of token.86pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {87	204888} else {89	1090};9192/// Maximum admins per collection.93pub const COLLECTION_ADMINS_LIMIT: u32 = 5;9495/// Maximum tokens per collection.96pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;9798/// Maximum tokens per account.99pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {100	1_000_000101} else {102	10103};104105/// Default timeout for transfer sponsoring NFT item.106pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;107/// Default timeout for transfer sponsoring fungible item.108pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;109/// Default timeout for transfer sponsoring refungible item.110pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;111112/// Default timeout for sponsored approving.113pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;114115// Schema limits116pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;117pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;118pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;119120// TODO: not used. Delete?121pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;122123/// Maximum length for collection name.124pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;125126/// Maximum length for collection description.127pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;128129/// Maximal token prefix length.130pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;131132/// Maximal lenght of property key.133pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;134135/// Maximal lenght of property value.136pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;137138/// Maximum properties that can be assigned to token.139pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;140141/// Maximal lenght of extended property value.142pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;143144/// Maximum size for all collection properties.145pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;146147/// Maximum size for all token properties.148pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;149150/// How much items can be created per single151/// create_many call.152pub const MAX_ITEMS_PER_BATCH: u32 = 200;153154/// Used for limit bounded types of token custom data.155pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;156157/// Collection id.158#[derive(159	Encode,160	Decode,161	PartialEq,162	Eq,163	PartialOrd,164	Ord,165	Clone,166	Copy,167	Debug,168	Default,169	TypeInfo,170	MaxEncodedLen,171)]172#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]173pub struct CollectionId(pub u32);174impl EncodeLike<u32> for CollectionId {}175impl EncodeLike<CollectionId> for u32 {}176177/// Token id.178#[derive(179	Encode,180	Decode,181	PartialEq,182	Eq,183	PartialOrd,184	Ord,185	Clone,186	Copy,187	Debug,188	Default,189	TypeInfo,190	MaxEncodedLen,191)]192#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]193pub struct TokenId(pub u32);194impl EncodeLike<u32> for TokenId {}195impl EncodeLike<TokenId> for u32 {}196197impl TokenId {198	/// Try to get next token id.199	///200	/// If next id cause overflow, then [`ArithmeticError::Overflow`] returned.201	pub fn try_next(self) -> Result<TokenId, ArithmeticError> {202		self.0203			.checked_add(1)204			.ok_or(ArithmeticError::Overflow)205			.map(Self)206	}207}208209impl From<TokenId> for U256 {210	fn from(t: TokenId) -> Self {211		t.0.into()212	}213}214215impl TryFrom<U256> for TokenId {216	type Error = &'static str;217218	fn try_from(value: U256) -> Result<Self, Self::Error> {219		Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))220	}221}222223/// Token data.224#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]225#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]226pub struct TokenData<CrossAccountId> {227	/// Properties of token.228	pub properties: Vec<Property>,229230	/// Token owner.231	pub owner: Option<CrossAccountId>,232233	/// Token pieces.234	pub pieces: u128,235}236237// TODO: unused type238pub struct OverflowError;239impl From<OverflowError> for &'static str {240	fn from(_: OverflowError) -> Self {241		"overflow occured"242	}243}244245/// Alias for decimal points type.246pub type DecimalPoints = u8;247248/// Collection mode.249///250/// Collection can represent various types of tokens.251/// Each collection can contain only one type of tokens at a time.252/// This type helps to understand which tokens the collection contains.253#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]254#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]255pub enum CollectionMode {256	/// Non fungible tokens.257	NFT,258	/// Fungible tokens.259	Fungible(DecimalPoints),260	/// Refungible tokens.261	ReFungible,262}263264impl CollectionMode {265	/// Get collection mod as number.266	pub fn id(&self) -> u8 {267		match self {268			CollectionMode::NFT => 1,269			CollectionMode::Fungible(_) => 2,270			CollectionMode::ReFungible => 3,271		}272	}273}274275// TODO: unused trait276pub trait SponsoringResolve<AccountId, Call> {277	fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;278}279280/// Access mode for some token operations.281#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]282#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]283pub enum AccessMode {284	/// Access grant for owner and admins. Used as default.285	Normal,286	/// Like a [`Normal`](AccessMode::Normal) but also users in allow list.287	AllowList,288}289impl Default for AccessMode {290	fn default() -> Self {291		Self::Normal292	}293}294295// TODO: remove in future.296#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]297#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]298pub enum SchemaVersion {299	ImageURL,300	Unique,301}302impl Default for SchemaVersion {303	fn default() -> Self {304		Self::ImageURL305	}306}307308// TODO: unused type309#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]310#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]311pub struct Ownership<AccountId> {312	pub owner: AccountId,313	pub fraction: u128,314}315316/// The state of collection sponsorship.317#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]318#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]319pub enum SponsorshipState<AccountId> {320	/// The fees are applied to the transaction sender.321	Disabled,322	/// The sponsor is under consideration. Until the sponsor gives his consent,323	/// the fee will still be charged to sender.324	Unconfirmed(AccountId),325	/// Transactions are sponsored by specified account.326	Confirmed(AccountId),327}328329impl<AccountId> SponsorshipState<AccountId> {330	/// Get a sponsor of the collection who has confirmed his status.331	pub fn sponsor(&self) -> Option<&AccountId> {332		match self {333			Self::Confirmed(sponsor) => Some(sponsor),334			_ => None,335		}336	}337338	/// Get a sponsor of the collection who has pending or confirmed status.339	pub fn pending_sponsor(&self) -> Option<&AccountId> {340		match self {341			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),342			_ => None,343		}344	}345346	/// Whether the sponsorship is confirmed.347	pub fn confirmed(&self) -> bool {348		matches!(self, Self::Confirmed(_))349	}350}351352impl<T> Default for SponsorshipState<T> {353	fn default() -> Self {354		Self::Disabled355	}356}357358pub type CollectionName = BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>;359pub type CollectionDescription = BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>;360pub type CollectionTokenPrefix = BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>;361362#[derive(Bitfields, Clone, Copy, PartialEq, Eq, Debug, Default)]363#[bondrewd(enforce_bytes = 1)]364pub struct CollectionFlags {365	/// Tokens in foreign collections can be transferred, but not burnt366	#[bondrewd(bits = "0..1")]367	pub foreign: bool,368	/// External collections can't be managed using `unique` api369	#[bondrewd(bits = "7..8")]370	pub external: bool,371372	#[bondrewd(reserve, bits = "1..7")]373	pub reserved: u8,374}375bondrewd_codec!(CollectionFlags);376377/// Base structure for represent collection.378///379/// Used to provide basic functionality for all types of collections.380///381/// #### Note382/// Collection parameters, used in storage (see [`RpcCollection`] for the RPC version).383#[struct_versioning::versioned(version = 2, upper)]384#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]385pub struct Collection<AccountId> {386	/// Collection owner account.387	pub owner: AccountId,388389	/// Collection mode.390	pub mode: CollectionMode,391392	/// Access mode.393	#[version(..2)]394	pub access: AccessMode,395396	/// Collection name.397	pub name: CollectionName,398399	/// Collection description.400	pub description: CollectionDescription,401402	/// Token prefix.403	pub token_prefix: CollectionTokenPrefix,404405	#[version(..2)]406	pub mint_mode: bool,407408	#[version(..2)]409	pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,410411	#[version(..2)]412	pub schema_version: SchemaVersion,413414	/// The state of sponsorship of the collection.415	pub sponsorship: SponsorshipState<AccountId>,416417	/// Collection limits.418	pub limits: CollectionLimits,419420	/// Collection permissions.421	#[version(2.., upper(Default::default()))]422	pub permissions: CollectionPermissions,423424	#[version(2.., upper(Default::default()))]425	pub flags: CollectionFlags,426427	#[version(..2)]428	pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,429430	#[version(..2)]431	pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,432433	#[version(..2)]434	pub meta_update_permission: MetaUpdatePermission,435}436437/// Collection parameters, used in RPC calls (see [`Collection`] for the storage version).438#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]439#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]440pub struct RpcCollection<AccountId> {441	/// Collection owner account.442	pub owner: AccountId,443444	/// Collection mode.445	pub mode: CollectionMode,446447	/// Collection name.448	pub name: Vec<u16>,449450	/// Collection description.451	pub description: Vec<u16>,452453	/// Token prefix.454	pub token_prefix: Vec<u8>,455456	/// The state of sponsorship of the collection.457	pub sponsorship: SponsorshipState<AccountId>,458459	/// Collection limits.460	pub limits: CollectionLimits,461462	/// Collection permissions.463	pub permissions: CollectionPermissions,464465	/// Token property permissions.466	pub token_property_permissions: Vec<PropertyKeyPermission>,467468	/// Collection properties.469	pub properties: Vec<Property>,470471	/// Is collection read only.472	pub read_only: bool,473474	/// Is collection is foreign.475	pub foreign: bool,476}477478/// Data used for create collection.479///480/// All fields are wrapped in [`Option`], where `None` means chain default.481#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]482#[derivative(Debug, Default(bound = ""))]483pub struct CreateCollectionData<AccountId> {484	/// Collection mode.485	#[derivative(Default(value = "CollectionMode::NFT"))]486	pub mode: CollectionMode,487488	/// Access mode.489	pub access: Option<AccessMode>,490491	/// Collection name.492	pub name: CollectionName,493494	/// Collection description.495	pub description: CollectionDescription,496497	/// Token prefix.498	pub token_prefix: CollectionTokenPrefix,499500	/// Pending collection sponsor.501	pub pending_sponsor: Option<AccountId>,502503	/// Collection limits.504	pub limits: Option<CollectionLimits>,505506	/// Collection permissions.507	pub permissions: Option<CollectionPermissions>,508509	/// Token property permissions.510	pub token_property_permissions: CollectionPropertiesPermissionsVec,511512	/// Collection properties.513	pub properties: CollectionPropertiesVec,514}515516/// Bounded vector of properties permissions. Max length is [`MAX_PROPERTIES_PER_ITEM`].517// TODO: maybe rename to PropertiesPermissionsVec518pub type CollectionPropertiesPermissionsVec =519	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;520521/// Bounded vector of properties. Max length is [`MAX_PROPERTIES_PER_ITEM`].522pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;523524/// Limits and restrictions of a collection.525///526/// All fields are wrapped in [`Option`], where `None` means chain default.527///528/// Update with `pallet_common::Pallet::clamp_limits`.529// IMPORTANT: When adding/removing fields from this struct - don't forget to also530#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]531#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]532// When adding/removing fields from this struct - don't forget to also update with `pallet_common::Pallet::clamp_limits`.533// TODO: move `pallet_common::Pallet::clamp_limits` into `impl CollectionLimits`.534// TODO: may be remove [`Option`] and **pub** from fields and create struct with default values.535pub struct CollectionLimits {536	/// How many tokens can a user have on one account.537	/// * Default - [`ACCOUNT_TOKEN_OWNERSHIP_LIMIT`].538	/// * Limit - [`MAX_TOKEN_OWNERSHIP`].539	pub account_token_ownership_limit: Option<u32>,540541	/// How many bytes of data are available for sponsorship.542	/// * Default - [`CUSTOM_DATA_LIMIT`].543	/// * Limit - [`CUSTOM_DATA_LIMIT`].544	pub sponsored_data_size: Option<u32>,545546	// FIXME should we delete this or repurpose it?547	/// Times in how many blocks we sponsor data.548	///549	/// If is `Some(v)` then **setVariableMetadata** is sponsored if there is `v` block between transactions.550	///551	/// * Default - [`SponsoringDisabled`](SponsoringRateLimit::SponsoringDisabled).552	/// * Limit - [`MAX_SPONSOR_TIMEOUT`].553	///554	/// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]555	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,556	/// Maximum amount of tokens inside the collection. Chain default: [`COLLECTION_TOKEN_LIMIT`]557558	/// How many tokens can be mined into this collection.559	///560	/// * Default - [`COLLECTION_TOKEN_LIMIT`].561	/// * Limit - [`COLLECTION_TOKEN_LIMIT`].562	pub token_limit: Option<u32>,563564	/// Timeouts for transfer sponsoring.565	///566	/// * Default567	///   - **Fungible** - [`FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]568	///   - **NFT** - [`NFT_SPONSOR_TRANSFER_TIMEOUT`]569	///   - **Refungible** - [`REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]570	/// * Limit - [`MAX_SPONSOR_TIMEOUT`].571	pub sponsor_transfer_timeout: Option<u32>,572573	/// Timeout for sponsoring an approval in passed blocks.574	///575	/// * Default - [`SPONSOR_APPROVE_TIMEOUT`].576	/// * Limit - [`MAX_SPONSOR_TIMEOUT`].577	pub sponsor_approve_timeout: Option<u32>,578579	/// Whether the collection owner of the collection can send tokens (which belong to other users).580	///581	/// * Default - **false**.582	pub owner_can_transfer: Option<bool>,583584	/// Can the collection owner burn other people's tokens.585	///586	/// * Default - **true**.587	pub owner_can_destroy: Option<bool>,588589	/// Is it possible to send tokens from this collection between users.590	///591	/// * Default - **true**.592	pub transfers_enabled: Option<bool>,593}594595impl CollectionLimits {596	/// Get effective value for [`account_token_ownership_limit`](self.account_token_ownership_limit).597	pub fn account_token_ownership_limit(&self) -> u32 {598		self.account_token_ownership_limit599			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)600			.min(MAX_TOKEN_OWNERSHIP)601	}602603	/// Get effective value for [`sponsored_data_size`](self.sponsored_data_size).604	pub fn sponsored_data_size(&self) -> u32 {605		self.sponsored_data_size606			.unwrap_or(CUSTOM_DATA_LIMIT)607			.min(CUSTOM_DATA_LIMIT)608	}609610	/// Get effective value for [`token_limit`](self.token_limit).611	pub fn token_limit(&self) -> u32 {612		self.token_limit613			.unwrap_or(COLLECTION_TOKEN_LIMIT)614			.min(COLLECTION_TOKEN_LIMIT)615	}616617	// TODO: may be replace u32 to mode?618	/// Get effective value for [`sponsor_transfer_timeout`](self.sponsor_transfer_timeout).619	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {620		self.sponsor_transfer_timeout621			.unwrap_or(default)622			.min(MAX_SPONSOR_TIMEOUT)623	}624625	/// Get effective value for [`sponsor_approve_timeout`](self.sponsor_approve_timeout).626	pub fn sponsor_approve_timeout(&self) -> u32 {627		self.sponsor_approve_timeout628			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)629			.min(MAX_SPONSOR_TIMEOUT)630	}631632	/// Get effective value for [`owner_can_transfer`](self.owner_can_transfer).633	pub fn owner_can_transfer(&self) -> bool {634		self.owner_can_transfer.unwrap_or(false)635	}636637	/// Get effective value for [`owner_can_transfer_instaled`](self.owner_can_transfer_instaled).638	pub fn owner_can_transfer_instaled(&self) -> bool {639		self.owner_can_transfer.is_some()640	}641642	/// Get effective value for [`owner_can_destroy`](self.owner_can_destroy).643	pub fn owner_can_destroy(&self) -> bool {644		self.owner_can_destroy.unwrap_or(true)645	}646647	/// Get effective value for [`transfers_enabled`](self.transfers_enabled).648	pub fn transfers_enabled(&self) -> bool {649		self.transfers_enabled.unwrap_or(true)650	}651652	/// Get effective value for [`sponsored_data_rate_limit`](self.sponsored_data_rate_limit).653	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {654		match self655			.sponsored_data_rate_limit656			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)657		{658			SponsoringRateLimit::SponsoringDisabled => None,659			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),660		}661	}662}663664/// Permissions on certain operations within a collection.665///666/// Some fields are wrapped in [`Option`], where `None` means chain default.667///668/// Update with `pallet_common::Pallet::clamp_permissions`.669#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]670#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]671// When adding/removing fields from this struct - don't forget to also update `pallet_common::Pallet::clamp_permissions`.672// TODO: move `pallet_common::Pallet::clamp_permissions` into `impl CollectionPermissions`.673pub struct CollectionPermissions {674	/// Access mode.675	///676	/// * Default - [`AccessMode::Normal`].677	pub access: Option<AccessMode>,678679	/// Minting allowance.680	///681	/// * Default - **false**.682	pub mint_mode: Option<bool>,683684	/// Permissions for nesting.685	///686	/// * Default687	///   - `token_owner` - **false**688	///   - `collection_admin` - **false**689	///   - `restricted` - **None**690	pub nesting: Option<NestingPermissions>,691}692693impl CollectionPermissions {694	/// Get effective value for [`access`](self.access).695	pub fn access(&self) -> AccessMode {696		self.access.unwrap_or(AccessMode::Normal)697	}698699	/// Get effective value for [`mint_mode`](self.mint_mode).700	pub fn mint_mode(&self) -> bool {701		self.mint_mode.unwrap_or(false)702	}703704	/// Get effective value for [`nesting`](self.nesting).705	pub fn nesting(&self) -> &NestingPermissions {706		static DEFAULT: NestingPermissions = NestingPermissions {707			token_owner: false,708			collection_admin: false,709			restricted: None,710			#[cfg(feature = "runtime-benchmarks")]711			permissive: false,712		};713		self.nesting.as_ref().unwrap_or(&DEFAULT)714	}715}716717/// Inner set for collections allowed to nest.718type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;719720/// Wraper for collections set allowing nest.721#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]722#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]723#[derivative(Debug)]724pub struct OwnerRestrictedSet(725	#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]726	#[derivative(Debug(format_with = "bounded::set_debug"))]727	pub OwnerRestrictedSetInner,728);729730impl OwnerRestrictedSet {731	/// Create new set.732	pub fn new() -> Self {733		Self(Default::default())734	}735}736impl core::ops::Deref for OwnerRestrictedSet {737	type Target = OwnerRestrictedSetInner;738	fn deref(&self) -> &Self::Target {739		&self.0740	}741}742impl core::ops::DerefMut for OwnerRestrictedSet {743	fn deref_mut(&mut self) -> &mut Self::Target {744		&mut self.0745	}746}747748/// Part of collection permissions, if set, defines who is able to nest tokens into other tokens.749#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]750#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]751#[derivative(Debug)]752pub struct NestingPermissions {753	/// Owner of token can nest tokens under it.754	pub token_owner: bool,755	/// Admin of token collection can nest tokens under token.756	pub collection_admin: bool,757	/// If set - only tokens from specified collections can be nested.758	pub restricted: Option<OwnerRestrictedSet>,759760	#[cfg(feature = "runtime-benchmarks")]761	/// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`.762	pub permissive: bool,763}764765/// Enum denominating how often can sponsoring occur if it is enabled.766///767/// Used for [`collection limits`](CollectionLimits).768#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]769#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]770pub enum SponsoringRateLimit {771	/// Sponsoring is disabled, and the collection sponsor will not pay for transactions772	SponsoringDisabled,773	/// Once per how many blocks can sponsorship of a transaction type occur774	Blocks(u32),775}776777/// Data used to describe an NFT at creation.778#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]779#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]780#[derivative(Debug)]781pub struct CreateNftData {782	/// Key-value pairs used to describe the token as metadata783	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]784	#[derivative(Debug(format_with = "bounded::vec_debug"))]785	/// Properties that wil be assignet to created item.786	pub properties: CollectionPropertiesVec,787}788789/// Data used to describe a Fungible token at creation.790#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]791#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]792pub struct CreateFungibleData {793	/// Number of fungible coins minted794	pub value: u128,795}796797/// Data used to describe a Refungible token at creation.798#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]799#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]800#[derivative(Debug)]801pub struct CreateReFungibleData {802	/// Number of pieces the RFT is split into803	pub pieces: u128,804805	/// Key-value pairs used to describe the token as metadata806	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]807	#[derivative(Debug(format_with = "bounded::vec_debug"))]808	pub properties: CollectionPropertiesVec,809}810811// TODO: remove this.812#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]813#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]814pub enum MetaUpdatePermission {815	ItemOwner,816	Admin,817	None,818}819820/// Enum holding data used for creation of all three item types.821/// Unified data for create item.822#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]823#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]824pub enum CreateItemData {825	/// Data for create NFT.826	NFT(CreateNftData),827	/// Data for create Fungible item.828	Fungible(CreateFungibleData),829	/// Data for create ReFungible item.830	ReFungible(CreateReFungibleData),831}832833/// Extended data for create NFT.834#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]835#[derivative(Debug)]836pub struct CreateNftExData<CrossAccountId> {837	/// Properties that wil be assignet to created item.838	#[derivative(Debug(format_with = "bounded::vec_debug"))]839	pub properties: CollectionPropertiesVec,840841	/// Owner of creating item.842	pub owner: CrossAccountId,843}844845/// Extended data for create ReFungible item.846#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]847#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]848pub struct CreateRefungibleExMultipleOwners<CrossAccountId> {849	#[derivative(Debug(format_with = "bounded::map_debug"))]850	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,851	#[derivative(Debug(format_with = "bounded::vec_debug"))]852	pub properties: CollectionPropertiesVec,853}854855/// Extended data for create ReFungible item.856#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]857#[derivative(Debug(bound = "CrossAccountId: fmt::Debug"))]858pub struct CreateRefungibleExSingleOwner<CrossAccountId> {859	pub user: CrossAccountId,860	pub pieces: u128,861	#[derivative(Debug(format_with = "bounded::vec_debug"))]862	pub properties: CollectionPropertiesVec,863}864865/// Unified extended data for creating item.866#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]867#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]868pub enum CreateItemExData<CrossAccountId> {869	/// Extended data for create NFT.870	NFT(871		#[derivative(Debug(format_with = "bounded::vec_debug"))]872		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,873	),874875	/// Extended data for create Fungible item.876	Fungible(877		#[derivative(Debug(format_with = "bounded::map_debug"))]878		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,879	),880881	/// Extended data for create ReFungible item in case of882	/// many tokens, each may have only one owner883	RefungibleMultipleItems(884		#[derivative(Debug(format_with = "bounded::vec_debug"))]885		BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,886	),887888	/// Extended data for create ReFungible item in case of889	/// single token, which may have many owners890	RefungibleMultipleOwners(CreateRefungibleExMultipleOwners<CrossAccountId>),891}892893impl From<CreateNftData> for CreateItemData {894	fn from(item: CreateNftData) -> Self {895		CreateItemData::NFT(item)896	}897}898899impl From<CreateReFungibleData> for CreateItemData {900	fn from(item: CreateReFungibleData) -> Self {901		CreateItemData::ReFungible(item)902	}903}904905impl From<CreateFungibleData> for CreateItemData {906	fn from(item: CreateFungibleData) -> Self {907		CreateItemData::Fungible(item)908	}909}910911/// Token's address, dictated by its collection and token IDs.912#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]913#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]914// todo possibly rename to be used generally as an address pair915pub struct TokenChild {916	/// Token id.917	pub token: TokenId,918919	/// Collection id.920	pub collection: CollectionId,921}922923/// Collection statistics.924#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]925#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]926pub struct CollectionStats {927	/// Number of created items.928	pub created: u32,929930	/// Number of burned items.931	pub destroyed: u32,932933	/// Number of current items.934	pub alive: u32,935}936937/// This type works like [`PhantomData`] but supports generating _scale-info_ descriptions to generate node metadata.938#[derive(Encode, Decode, Clone, Debug)]939#[cfg_attr(feature = "std", derive(PartialEq))]940pub struct PhantomType<T>(core::marker::PhantomData<T>);941942impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {943	type Identity = PhantomType<T>;944945	fn type_info() -> scale_info::Type {946		use scale_info::{947			Type, Path,948			build::{FieldsBuilder, UnnamedFields},949			type_params,950		};951		Type::builder()952			.path(Path::new("up_data_structs", "PhantomType"))953			.type_params(type_params!(T))954			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))955	}956}957impl<T> MaxEncodedLen for PhantomType<T> {958	fn max_encoded_len() -> usize {959		0960	}961}962963/// Bounded vector of bytes.964pub type BoundedBytes<S> = BoundedVec<u8, S>;965966/// Extra properties for external collections.967pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;968969/// Property key.970pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;971972/// Property value.973pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;974975/// Property permission.976#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]977#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]978pub struct PropertyPermission {979	/// Permission to change the property and property permission.980	///981	/// If it **false** then you can not change corresponding property even if [`collection_admin`] and [`token_owner`] are **true**.982	pub mutable: bool,983984	/// Change permission for the collection administrator.985	pub collection_admin: bool,986987	/// Permission to change the property for the owner of the token.988	pub token_owner: bool,989}990991impl PropertyPermission {992	/// Creates mutable property permission but changes restricted for collection admin and token owner.993	pub fn none() -> Self {994		Self {995			mutable: true,996			collection_admin: false,997			token_owner: false,998		}999	}1000}10011002/// Property is simpl key-value record.1003#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1004#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1005pub struct Property {1006	/// Property key.1007	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1008	pub key: PropertyKey,10091010	/// Property value.1011	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1012	pub value: PropertyValue,1013}10141015impl Into<(PropertyKey, PropertyValue)> for Property {1016	fn into(self) -> (PropertyKey, PropertyValue) {1017		(self.key, self.value)1018	}1019}10201021/// Record for proprty key permission.1022#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1023#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1024pub struct PropertyKeyPermission {1025	/// Key.1026	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1027	pub key: PropertyKey,10281029	/// Permission.1030	pub permission: PropertyPermission,1031}10321033impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1034	fn into(self) -> (PropertyKey, PropertyPermission) {1035		(self.key, self.permission)1036	}1037}10381039/// Errors for properties actions.1040#[derive(Debug)]1041pub enum PropertiesError {1042	/// The space allocated for properties has run out.1043	///1044	/// * Limit for colection - [`MAX_COLLECTION_PROPERTIES_SIZE`].1045	/// * Limit for token - [`MAX_TOKEN_PROPERTIES_SIZE`].1046	NoSpaceForProperty,10471048	/// The property limit has been reached.1049	///1050	/// * Limit - [`MAX_PROPERTIES_PER_ITEM`].1051	PropertyLimitReached,10521053	/// Property key contains not allowed character.1054	InvalidCharacterInPropertyKey,10551056	/// Property key length is too long.1057	///1058	/// * Limit - [`MAX_PROPERTY_KEY_LENGTH`].1059	PropertyKeyIsTooLong,10601061	/// Property key is empty.1062	EmptyPropertyKey,1063}10641065/// Marker for scope of property.1066///1067/// Scoped property can't be changed by user. Used for external collections.1068#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1069pub enum PropertyScope {1070	None,1071	Rmrk,1072}10731074impl PropertyScope {1075	/// Apply scope to property key.1076	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {1077		let scope_str: &[u8] = match self {1078			Self::None => return Ok(key),1079			Self::Rmrk => b"rmrk",1080		};10811082		[scope_str, b":", key.as_slice()]1083			.concat()1084			.try_into()1085			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)1086	}1087}10881089/// Trait for operate with properties.1090pub trait TrySetProperty: Sized {1091	type Value;10921093	/// Try to set property with scope.1094	fn try_scoped_set(1095		&mut self,1096		scope: PropertyScope,1097		key: PropertyKey,1098		value: Self::Value,1099	) -> Result<(), PropertiesError>;11001101	/// Try to set property with scope from iterator.1102	fn try_scoped_set_from_iter<I, KV>(1103		&mut self,1104		scope: PropertyScope,1105		iter: I,1106	) -> Result<(), PropertiesError>1107	where1108		I: Iterator<Item = KV>,1109		KV: Into<(PropertyKey, Self::Value)>,1110	{1111		for kv in iter {1112			let (key, value) = kv.into();1113			self.try_scoped_set(scope, key, value)?;1114		}11151116		Ok(())1117	}11181119	/// Try to set property.1120	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {1121		self.try_scoped_set(PropertyScope::None, key, value)1122	}11231124	/// Try to set property from iterator.1125	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>1126	where1127		I: Iterator<Item = KV>,1128		KV: Into<(PropertyKey, Self::Value)>,1129	{1130		self.try_scoped_set_from_iter(PropertyScope::None, iter)1131	}1132}11331134/// Wrapped map for storing properties.1135#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]1136#[derivative(Default(bound = ""))]1137pub struct PropertiesMap<Value>(1138	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,1139);11401141impl<Value> PropertiesMap<Value> {1142	/// Create new property map.1143	pub fn new() -> Self {1144		Self(BoundedBTreeMap::new())1145	}11461147	/// Remove property from map.1148	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {1149		Self::check_property_key(key)?;11501151		Ok(self.0.remove(key))1152	}11531154	/// Get property with appropriate key from map.1155	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1156		self.0.get(key)1157	}11581159	/// Check if map contains key.1160	pub fn contains_key(&self, key: &PropertyKey) -> bool {1161		self.0.contains_key(key)1162	}11631164	/// Check if map contains key with key validation.1165	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {1166		if key.is_empty() {1167			return Err(PropertiesError::EmptyPropertyKey);1168		}11691170		for byte in key.as_slice().iter() {1171			let byte = *byte;11721173			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {1174				return Err(PropertiesError::InvalidCharacterInPropertyKey);1175			}1176		}11771178		Ok(())1179	}1180}11811182impl<Value> IntoIterator for PropertiesMap<Value> {1183	type Item = (PropertyKey, Value);1184	type IntoIter = <1185		BoundedBTreeMap<1186			PropertyKey,1187			Value,1188			ConstU32<MAX_PROPERTIES_PER_ITEM>1189		> as IntoIterator1190	>::IntoIter;11911192	fn into_iter(self) -> Self::IntoIter {1193		self.0.into_iter()1194	}1195}11961197impl<Value> TrySetProperty for PropertiesMap<Value> {1198	type Value = Value;11991200	fn try_scoped_set(1201		&mut self,1202		scope: PropertyScope,1203		key: PropertyKey,1204		value: Self::Value,1205	) -> Result<(), PropertiesError> {1206		Self::check_property_key(&key)?;12071208		let key = scope.apply(key)?;1209		self.01210			.try_insert(key, value)1211			.map_err(|_| PropertiesError::PropertyLimitReached)?;12121213		Ok(())1214	}1215}12161217/// Alias for property permissions map.1218pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;12191220/// Wrapper for properties map with consumed space control.1221#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1222pub struct Properties {1223	map: PropertiesMap<PropertyValue>,1224	consumed_space: u32,1225	space_limit: u32,1226}12271228impl Properties {1229	/// Create new properies container.1230	pub fn new(space_limit: u32) -> Self {1231		Self {1232			map: PropertiesMap::new(),1233			consumed_space: 0,1234			space_limit,1235		}1236	}12371238	/// Remove propery with appropiate key.1239	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {1240		let value = self.map.remove(key)?;12411242		if let Some(ref value) = value {1243			let value_len = value.len() as u32;1244			self.consumed_space -= value_len;1245		}12461247		Ok(value)1248	}12491250	/// Get property with appropriate key.1251	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {1252		self.map.get(key)1253	}1254}12551256impl IntoIterator for Properties {1257	type Item = (PropertyKey, PropertyValue);1258	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;12591260	fn into_iter(self) -> Self::IntoIter {1261		self.map.into_iter()1262	}1263}12641265impl TrySetProperty for Properties {1266	type Value = PropertyValue;12671268	fn try_scoped_set(1269		&mut self,1270		scope: PropertyScope,1271		key: PropertyKey,1272		value: Self::Value,1273	) -> Result<(), PropertiesError> {1274		let value_len = value.len();12751276		if self.consumed_space as usize + value_len > self.space_limit as usize1277			&& !cfg!(feature = "runtime-benchmarks")1278		{1279			return Err(PropertiesError::NoSpaceForProperty);1280		}12811282		self.map.try_scoped_set(scope, key, value)?;12831284		self.consumed_space += value_len as u32;12851286		Ok(())1287	}1288}12891290/// Utility struct for using in `StorageMap`.1291pub struct CollectionProperties;12921293impl Get<Properties> for CollectionProperties {1294	fn get() -> Properties {1295		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)1296	}1297}12981299/// Utility struct for using in `StorageMap`.1300pub struct TokenProperties;13011302impl Get<Properties> for TokenProperties {1303	fn get() -> Properties {1304		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)1305	}1306}13071308// RMRK1309// todo document?1310parameter_types! {1311	#[derive(PartialEq, TypeInfo)]1312	pub const RmrkStringLimit: u32 = 128;1313	#[derive(PartialEq)]1314	pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1315	#[derive(PartialEq)]1316	pub const RmrkResourceSymbolLimit: u32 = 10;1317	#[derive(PartialEq)]1318	pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1319	#[derive(PartialEq)]1320	pub const RmrkKeyLimit: u32 = 32;1321	#[derive(PartialEq)]1322	pub const RmrkValueLimit: u32 = 256;1323	#[derive(PartialEq)]1324	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1325	#[derive(PartialEq)]1326	pub const MaxPropertiesPerTheme: u32 = 5;1327	#[derive(PartialEq)]1328	pub const RmrkPartsLimit: u32 = 25;1329	#[derive(PartialEq)]1330	pub const RmrkMaxPriorities: u32 = 25;1331	#[derive(PartialEq)]1332	pub const MaxResourcesOnMint: u32 = 100;1333}13341335impl From<RmrkCollectionId> for CollectionId {1336	fn from(id: RmrkCollectionId) -> Self {1337		Self(id)1338	}1339}13401341impl From<RmrkNftId> for TokenId {1342	fn from(id: RmrkNftId) -> Self {1343		Self(id)1344	}1345}13461347pub type RmrkCollectionInfo<AccountId> =1348	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1349pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1350pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1351pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1352pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1353pub type BoundedEquippableCollectionIds =1354	BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1355pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1356pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1357pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1358pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1359pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1360pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;13611362pub type RmrkBasicResource = BasicResource<RmrkString>;1363pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1364pub type RmrkSlotResource = SlotResource<RmrkString>;13651366pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1367pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1368pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1369pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1370pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1371pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1372pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed13731374pub type RmrkRpcString = Vec<u8>;1375pub type RmrkThemeName = RmrkRpcString;1376pub type RmrkPropertyKey = RmrkRpcString;
after · primitives/data-structs/src/lib.rs
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Primitives crate.18//!19//! This crate contains types, traits and constants.2021#![cfg_attr(not(feature = "std"), no_std)]2223use core::{24	convert::{TryFrom, TryInto},25	fmt,26};27use frame_support::{28	storage::{bounded_btree_map::BoundedBTreeMap, bounded_btree_set::BoundedBTreeSet},29	traits::Get,30	parameter_types,31};3233#[cfg(feature = "serde")]34use serde::{Serialize, Deserialize};3536use sp_core::U256;37use sp_runtime::{ArithmeticError, sp_std::prelude::Vec, Permill};38use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};39use bondrewd::Bitfields;40use frame_support::{BoundedVec, traits::ConstU32};41use derivative::Derivative;42use scale_info::TypeInfo;4344// RMRK45use rmrk_traits::{46	CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme, ThemeProperty,47	ResourceTypes, BasicResource, ComposableResource, SlotResource, EquippableList,48};49pub use rmrk_traits::{50	primitives::{51		CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,52		SlotId as RmrkSlotId, PartId as RmrkPartId, ResourceId as RmrkResourceId,53	},54	NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,55	FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart,56};5758mod bondrewd_codec;59mod bounded;60pub mod budget;61pub mod mapping;62mod migration;6364/// Maximum of decimal points.65pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;6667/// Maximum pieces for refungible token.68pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;69pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;7071/// Maximum tokens for user.72pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {73	100_00074} else {75	1076};7778/// Maximum for collections can be created.79pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {80	100_00081} else {82	1083};8485/// Maximum for various custom data of token.86pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {87	204888} else {89	1090};9192/// Maximum admins per collection.93pub const COLLECTION_ADMINS_LIMIT: u32 = 5;9495/// Maximum tokens per collection.96pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;9798/// Maximum tokens per account.99pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {100	1_000_000101} else {102	10103};104105/// Default timeout for transfer sponsoring NFT item.106pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;107/// Default timeout for transfer sponsoring fungible item.108pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;109/// Default timeout for transfer sponsoring refungible item.110pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;111112/// Default timeout for sponsored approving.113pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;114115// Schema limits116pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;117pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;118pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;119120// TODO: not used. Delete?121pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;122123/// Maximum length for collection name.124pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;125126/// Maximum length for collection description.127pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;128129/// Maximal token prefix length.130pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;131132/// Maximal lenght of property key.133pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;134135/// Maximal lenght of property value.136pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;137138/// Maximum properties that can be assigned to token.139pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;140141/// Maximal lenght of extended property value.142pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;143144/// Maximum size for all collection properties.145pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;146147/// Maximum size for all token properties.148pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;149150/// How much items can be created per single151/// create_many call.152pub const MAX_ITEMS_PER_BATCH: u32 = 200;153154/// Used for limit bounded types of token custom data.155pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;156157/// Collection id.158#[derive(159	Encode,160	Decode,161	PartialEq,162	Eq,163	PartialOrd,164	Ord,165	Clone,166	Copy,167	Debug,168	Default,169	TypeInfo,170	MaxEncodedLen,171)]172#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]173pub struct CollectionId(pub u32);174impl EncodeLike<u32> for CollectionId {}175impl EncodeLike<CollectionId> for u32 {}176177/// Token id.178#[derive(179	Encode,180	Decode,181	PartialEq,182	Eq,183	PartialOrd,184	Ord,185	Clone,186	Copy,187	Debug,188	Default,189	TypeInfo,190	MaxEncodedLen,191)]192#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]193pub struct TokenId(pub u32);194impl EncodeLike<u32> for TokenId {}195impl EncodeLike<TokenId> for u32 {}196197impl TokenId {198	/// Try to get next token id.199	///200	/// If next id cause overflow, then [`ArithmeticError::Overflow`] returned.201	pub fn try_next(self) -> Result<TokenId, ArithmeticError> {202		self.0203			.checked_add(1)204			.ok_or(ArithmeticError::Overflow)205			.map(Self)206	}207}208209impl From<TokenId> for U256 {210	fn from(t: TokenId) -> Self {211		t.0.into()212	}213}214215impl TryFrom<U256> for TokenId {216	type Error = &'static str;217218	fn try_from(value: U256) -> Result<Self, Self::Error> {219		Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))220	}221}222223/// Token data.224#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]225#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]226pub struct TokenData<CrossAccountId> {227	/// Properties of token.228	pub properties: Vec<Property>,229230	/// Token owner.231	pub owner: Option<CrossAccountId>,232233	/// Token pieces.234	pub pieces: u128,235}236237// TODO: unused type238pub struct OverflowError;239impl From<OverflowError> for &'static str {240	fn from(_: OverflowError) -> Self {241		"overflow occured"242	}243}244245/// Alias for decimal points type.246pub type DecimalPoints = u8;247248/// Collection mode.249///250/// Collection can represent various types of tokens.251/// Each collection can contain only one type of tokens at a time.252/// This type helps to understand which tokens the collection contains.253#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]254#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]255pub enum CollectionMode {256	/// Non fungible tokens.257	NFT,258	/// Fungible tokens.259	Fungible(DecimalPoints),260	/// Refungible tokens.261	ReFungible,262}263264impl CollectionMode {265	/// Get collection mod as number.266	pub fn id(&self) -> u8 {267		match self {268			CollectionMode::NFT => 1,269			CollectionMode::Fungible(_) => 2,270			CollectionMode::ReFungible => 3,271		}272	}273}274275// TODO: unused trait276pub trait SponsoringResolve<AccountId, Call> {277	fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;278}279280/// Access mode for some token operations.281#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]282#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]283pub enum AccessMode {284	/// Access grant for owner and admins. Used as default.285	Normal,286	/// Like a [`Normal`](AccessMode::Normal) but also users in allow list.287	AllowList,288}289impl Default for AccessMode {290	fn default() -> Self {291		Self::Normal292	}293}294295// TODO: remove in future.296#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]297#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]298pub enum SchemaVersion {299	ImageURL,300	Unique,301}302impl Default for SchemaVersion {303	fn default() -> Self {304		Self::ImageURL305	}306}307308// TODO: unused type309#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]310#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]311pub struct Ownership<AccountId> {312	pub owner: AccountId,313	pub fraction: u128,314}315316/// The state of collection sponsorship.317#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]318#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]319pub enum SponsorshipState<AccountId> {320	/// The fees are applied to the transaction sender.321	Disabled,322	/// The sponsor is under consideration. Until the sponsor gives his consent,323	/// the fee will still be charged to sender.324	Unconfirmed(AccountId),325	/// Transactions are sponsored by specified account.326	Confirmed(AccountId),327}328329impl<AccountId> SponsorshipState<AccountId> {330	/// Get a sponsor of the collection who has confirmed his status.331	pub fn sponsor(&self) -> Option<&AccountId> {332		match self {333			Self::Confirmed(sponsor) => Some(sponsor),334			_ => None,335		}336	}337338	/// Get a sponsor of the collection who has pending or confirmed status.339	pub fn pending_sponsor(&self) -> Option<&AccountId> {340		match self {341			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),342			_ => None,343		}344	}345346	/// Whether the sponsorship is confirmed.347	pub fn confirmed(&self) -> bool {348		matches!(self, Self::Confirmed(_))349	}350}351352impl<T> Default for SponsorshipState<T> {353	fn default() -> Self {354		Self::Disabled355	}356}357358pub type CollectionName = BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>;359pub type CollectionDescription = BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>;360pub type CollectionTokenPrefix = BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>;361362#[derive(Bitfields, Clone, Copy, PartialEq, Eq, Debug, Default)]363#[bondrewd(enforce_bytes = 1)]364pub struct CollectionFlags {365	/// Tokens in foreign collections can be transferred, but not burnt366	#[bondrewd(bits = "0..1")]367	pub foreign: bool,368	/// Supports ERC721Metadata369	#[bondrewd(bits = "1..2")]370	pub erc721metadata: bool,371	/// External collections can't be managed using `unique` api372	#[bondrewd(bits = "7..8")]373	pub external: bool,374375	#[bondrewd(reserve, bits = "2..7")]376	pub reserved: u8,377}378bondrewd_codec!(CollectionFlags);379380/// Base structure for represent collection.381///382/// Used to provide basic functionality for all types of collections.383///384/// #### Note385/// Collection parameters, used in storage (see [`RpcCollection`] for the RPC version).386#[struct_versioning::versioned(version = 2, upper)]387#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]388pub struct Collection<AccountId> {389	/// Collection owner account.390	pub owner: AccountId,391392	/// Collection mode.393	pub mode: CollectionMode,394395	/// Access mode.396	#[version(..2)]397	pub access: AccessMode,398399	/// Collection name.400	pub name: CollectionName,401402	/// Collection description.403	pub description: CollectionDescription,404405	/// Token prefix.406	pub token_prefix: CollectionTokenPrefix,407408	#[version(..2)]409	pub mint_mode: bool,410411	#[version(..2)]412	pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,413414	#[version(..2)]415	pub schema_version: SchemaVersion,416417	/// The state of sponsorship of the collection.418	pub sponsorship: SponsorshipState<AccountId>,419420	/// Collection limits.421	pub limits: CollectionLimits,422423	/// Collection permissions.424	#[version(2.., upper(Default::default()))]425	pub permissions: CollectionPermissions,426427	#[version(2.., upper(Default::default()))]428	pub flags: CollectionFlags,429430	#[version(..2)]431	pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,432433	#[version(..2)]434	pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,435436	#[version(..2)]437	pub meta_update_permission: MetaUpdatePermission,438}439440#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]441#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]442pub struct RpcCollectionFlags {443	/// Is collection is foreign.444	pub foreign: bool,445	/// Collection supports ERC721Metadata.446	pub erc721metadata: bool,447}448449/// Collection parameters, used in RPC calls (see [`Collection`] for the storage version).450#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]451#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]452pub struct RpcCollection<AccountId> {453	/// Collection owner account.454	pub owner: AccountId,455456	/// Collection mode.457	pub mode: CollectionMode,458459	/// Collection name.460	pub name: Vec<u16>,461462	/// Collection description.463	pub description: Vec<u16>,464465	/// Token prefix.466	pub token_prefix: Vec<u8>,467468	/// The state of sponsorship of the collection.469	pub sponsorship: SponsorshipState<AccountId>,470471	/// Collection limits.472	pub limits: CollectionLimits,473474	/// Collection permissions.475	pub permissions: CollectionPermissions,476477	/// Token property permissions.478	pub token_property_permissions: Vec<PropertyKeyPermission>,479480	/// Collection properties.481	pub properties: Vec<Property>,482483	/// Is collection read only.484	pub read_only: bool,485486	/// Extra collection flags487	pub flags: RpcCollectionFlags,488}489490/// Data used for create collection.491///492/// All fields are wrapped in [`Option`], where `None` means chain default.493#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]494#[derivative(Debug, Default(bound = ""))]495pub struct CreateCollectionData<AccountId> {496	/// Collection mode.497	#[derivative(Default(value = "CollectionMode::NFT"))]498	pub mode: CollectionMode,499500	/// Access mode.501	pub access: Option<AccessMode>,502503	/// Collection name.504	pub name: CollectionName,505506	/// Collection description.507	pub description: CollectionDescription,508509	/// Token prefix.510	pub token_prefix: CollectionTokenPrefix,511512	/// Pending collection sponsor.513	pub pending_sponsor: Option<AccountId>,514515	/// Collection limits.516	pub limits: Option<CollectionLimits>,517518	/// Collection permissions.519	pub permissions: Option<CollectionPermissions>,520521	/// Token property permissions.522	pub token_property_permissions: CollectionPropertiesPermissionsVec,523524	/// Collection properties.525	pub properties: CollectionPropertiesVec,526}527528/// Bounded vector of properties permissions. Max length is [`MAX_PROPERTIES_PER_ITEM`].529// TODO: maybe rename to PropertiesPermissionsVec530pub type CollectionPropertiesPermissionsVec =531	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;532533/// Bounded vector of properties. Max length is [`MAX_PROPERTIES_PER_ITEM`].534pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;535536/// Limits and restrictions of a collection.537///538/// All fields are wrapped in [`Option`], where `None` means chain default.539///540/// Update with `pallet_common::Pallet::clamp_limits`.541// IMPORTANT: When adding/removing fields from this struct - don't forget to also542#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]543#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]544// When adding/removing fields from this struct - don't forget to also update with `pallet_common::Pallet::clamp_limits`.545// TODO: move `pallet_common::Pallet::clamp_limits` into `impl CollectionLimits`.546// TODO: may be remove [`Option`] and **pub** from fields and create struct with default values.547pub struct CollectionLimits {548	/// How many tokens can a user have on one account.549	/// * Default - [`ACCOUNT_TOKEN_OWNERSHIP_LIMIT`].550	/// * Limit - [`MAX_TOKEN_OWNERSHIP`].551	pub account_token_ownership_limit: Option<u32>,552553	/// How many bytes of data are available for sponsorship.554	/// * Default - [`CUSTOM_DATA_LIMIT`].555	/// * Limit - [`CUSTOM_DATA_LIMIT`].556	pub sponsored_data_size: Option<u32>,557558	// FIXME should we delete this or repurpose it?559	/// Times in how many blocks we sponsor data.560	///561	/// If is `Some(v)` then **setVariableMetadata** is sponsored if there is `v` block between transactions.562	///563	/// * Default - [`SponsoringDisabled`](SponsoringRateLimit::SponsoringDisabled).564	/// * Limit - [`MAX_SPONSOR_TIMEOUT`].565	///566	/// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]567	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,568	/// Maximum amount of tokens inside the collection. Chain default: [`COLLECTION_TOKEN_LIMIT`]569570	/// How many tokens can be mined into this collection.571	///572	/// * Default - [`COLLECTION_TOKEN_LIMIT`].573	/// * Limit - [`COLLECTION_TOKEN_LIMIT`].574	pub token_limit: Option<u32>,575576	/// Timeouts for transfer sponsoring.577	///578	/// * Default579	///   - **Fungible** - [`FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]580	///   - **NFT** - [`NFT_SPONSOR_TRANSFER_TIMEOUT`]581	///   - **Refungible** - [`REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]582	/// * Limit - [`MAX_SPONSOR_TIMEOUT`].583	pub sponsor_transfer_timeout: Option<u32>,584585	/// Timeout for sponsoring an approval in passed blocks.586	///587	/// * Default - [`SPONSOR_APPROVE_TIMEOUT`].588	/// * Limit - [`MAX_SPONSOR_TIMEOUT`].589	pub sponsor_approve_timeout: Option<u32>,590591	/// Whether the collection owner of the collection can send tokens (which belong to other users).592	///593	/// * Default - **false**.594	pub owner_can_transfer: Option<bool>,595596	/// Can the collection owner burn other people's tokens.597	///598	/// * Default - **true**.599	pub owner_can_destroy: Option<bool>,600601	/// Is it possible to send tokens from this collection between users.602	///603	/// * Default - **true**.604	pub transfers_enabled: Option<bool>,605}606607impl CollectionLimits {608	/// Get effective value for [`account_token_ownership_limit`](self.account_token_ownership_limit).609	pub fn account_token_ownership_limit(&self) -> u32 {610		self.account_token_ownership_limit611			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)612			.min(MAX_TOKEN_OWNERSHIP)613	}614615	/// Get effective value for [`sponsored_data_size`](self.sponsored_data_size).616	pub fn sponsored_data_size(&self) -> u32 {617		self.sponsored_data_size618			.unwrap_or(CUSTOM_DATA_LIMIT)619			.min(CUSTOM_DATA_LIMIT)620	}621622	/// Get effective value for [`token_limit`](self.token_limit).623	pub fn token_limit(&self) -> u32 {624		self.token_limit625			.unwrap_or(COLLECTION_TOKEN_LIMIT)626			.min(COLLECTION_TOKEN_LIMIT)627	}628629	// TODO: may be replace u32 to mode?630	/// Get effective value for [`sponsor_transfer_timeout`](self.sponsor_transfer_timeout).631	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {632		self.sponsor_transfer_timeout633			.unwrap_or(default)634			.min(MAX_SPONSOR_TIMEOUT)635	}636637	/// Get effective value for [`sponsor_approve_timeout`](self.sponsor_approve_timeout).638	pub fn sponsor_approve_timeout(&self) -> u32 {639		self.sponsor_approve_timeout640			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)641			.min(MAX_SPONSOR_TIMEOUT)642	}643644	/// Get effective value for [`owner_can_transfer`](self.owner_can_transfer).645	pub fn owner_can_transfer(&self) -> bool {646		self.owner_can_transfer.unwrap_or(false)647	}648649	/// Get effective value for [`owner_can_transfer_instaled`](self.owner_can_transfer_instaled).650	pub fn owner_can_transfer_instaled(&self) -> bool {651		self.owner_can_transfer.is_some()652	}653654	/// Get effective value for [`owner_can_destroy`](self.owner_can_destroy).655	pub fn owner_can_destroy(&self) -> bool {656		self.owner_can_destroy.unwrap_or(true)657	}658659	/// Get effective value for [`transfers_enabled`](self.transfers_enabled).660	pub fn transfers_enabled(&self) -> bool {661		self.transfers_enabled.unwrap_or(true)662	}663664	/// Get effective value for [`sponsored_data_rate_limit`](self.sponsored_data_rate_limit).665	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {666		match self667			.sponsored_data_rate_limit668			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)669		{670			SponsoringRateLimit::SponsoringDisabled => None,671			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),672		}673	}674}675676/// Permissions on certain operations within a collection.677///678/// Some fields are wrapped in [`Option`], where `None` means chain default.679///680/// Update with `pallet_common::Pallet::clamp_permissions`.681#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]682#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]683// When adding/removing fields from this struct - don't forget to also update `pallet_common::Pallet::clamp_permissions`.684// TODO: move `pallet_common::Pallet::clamp_permissions` into `impl CollectionPermissions`.685pub struct CollectionPermissions {686	/// Access mode.687	///688	/// * Default - [`AccessMode::Normal`].689	pub access: Option<AccessMode>,690691	/// Minting allowance.692	///693	/// * Default - **false**.694	pub mint_mode: Option<bool>,695696	/// Permissions for nesting.697	///698	/// * Default699	///   - `token_owner` - **false**700	///   - `collection_admin` - **false**701	///   - `restricted` - **None**702	pub nesting: Option<NestingPermissions>,703}704705impl CollectionPermissions {706	/// Get effective value for [`access`](self.access).707	pub fn access(&self) -> AccessMode {708		self.access.unwrap_or(AccessMode::Normal)709	}710711	/// Get effective value for [`mint_mode`](self.mint_mode).712	pub fn mint_mode(&self) -> bool {713		self.mint_mode.unwrap_or(false)714	}715716	/// Get effective value for [`nesting`](self.nesting).717	pub fn nesting(&self) -> &NestingPermissions {718		static DEFAULT: NestingPermissions = NestingPermissions {719			token_owner: false,720			collection_admin: false,721			restricted: None,722			#[cfg(feature = "runtime-benchmarks")]723			permissive: false,724		};725		self.nesting.as_ref().unwrap_or(&DEFAULT)726	}727}728729/// Inner set for collections allowed to nest.730type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;731732/// Wraper for collections set allowing nest.733#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]734#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]735#[derivative(Debug)]736pub struct OwnerRestrictedSet(737	#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]738	#[derivative(Debug(format_with = "bounded::set_debug"))]739	pub OwnerRestrictedSetInner,740);741742impl OwnerRestrictedSet {743	/// Create new set.744	pub fn new() -> Self {745		Self(Default::default())746	}747}748impl core::ops::Deref for OwnerRestrictedSet {749	type Target = OwnerRestrictedSetInner;750	fn deref(&self) -> &Self::Target {751		&self.0752	}753}754impl core::ops::DerefMut for OwnerRestrictedSet {755	fn deref_mut(&mut self) -> &mut Self::Target {756		&mut self.0757	}758}759760/// Part of collection permissions, if set, defines who is able to nest tokens into other tokens.761#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]762#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]763#[derivative(Debug)]764pub struct NestingPermissions {765	/// Owner of token can nest tokens under it.766	pub token_owner: bool,767	/// Admin of token collection can nest tokens under token.768	pub collection_admin: bool,769	/// If set - only tokens from specified collections can be nested.770	pub restricted: Option<OwnerRestrictedSet>,771772	#[cfg(feature = "runtime-benchmarks")]773	/// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`.774	pub permissive: bool,775}776777/// Enum denominating how often can sponsoring occur if it is enabled.778///779/// Used for [`collection limits`](CollectionLimits).780#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]781#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]782pub enum SponsoringRateLimit {783	/// Sponsoring is disabled, and the collection sponsor will not pay for transactions784	SponsoringDisabled,785	/// Once per how many blocks can sponsorship of a transaction type occur786	Blocks(u32),787}788789/// Data used to describe an NFT at creation.790#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]791#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]792#[derivative(Debug)]793pub struct CreateNftData {794	/// Key-value pairs used to describe the token as metadata795	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]796	#[derivative(Debug(format_with = "bounded::vec_debug"))]797	/// Properties that wil be assignet to created item.798	pub properties: CollectionPropertiesVec,799}800801/// Data used to describe a Fungible token at creation.802#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]803#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]804pub struct CreateFungibleData {805	/// Number of fungible coins minted806	pub value: u128,807}808809/// Data used to describe a Refungible token at creation.810#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]811#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]812#[derivative(Debug)]813pub struct CreateReFungibleData {814	/// Number of pieces the RFT is split into815	pub pieces: u128,816817	/// Key-value pairs used to describe the token as metadata818	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]819	#[derivative(Debug(format_with = "bounded::vec_debug"))]820	pub properties: CollectionPropertiesVec,821}822823// TODO: remove this.824#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]825#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]826pub enum MetaUpdatePermission {827	ItemOwner,828	Admin,829	None,830}831832/// Enum holding data used for creation of all three item types.833/// Unified data for create item.834#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]835#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]836pub enum CreateItemData {837	/// Data for create NFT.838	NFT(CreateNftData),839	/// Data for create Fungible item.840	Fungible(CreateFungibleData),841	/// Data for create ReFungible item.842	ReFungible(CreateReFungibleData),843}844845/// Extended data for create NFT.846#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]847#[derivative(Debug)]848pub struct CreateNftExData<CrossAccountId> {849	/// Properties that wil be assignet to created item.850	#[derivative(Debug(format_with = "bounded::vec_debug"))]851	pub properties: CollectionPropertiesVec,852853	/// Owner of creating item.854	pub owner: CrossAccountId,855}856857/// Extended data for create ReFungible item.858#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]859#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]860pub struct CreateRefungibleExMultipleOwners<CrossAccountId> {861	#[derivative(Debug(format_with = "bounded::map_debug"))]862	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,863	#[derivative(Debug(format_with = "bounded::vec_debug"))]864	pub properties: CollectionPropertiesVec,865}866867/// Extended data for create ReFungible item.868#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]869#[derivative(Debug(bound = "CrossAccountId: fmt::Debug"))]870pub struct CreateRefungibleExSingleOwner<CrossAccountId> {871	pub user: CrossAccountId,872	pub pieces: u128,873	#[derivative(Debug(format_with = "bounded::vec_debug"))]874	pub properties: CollectionPropertiesVec,875}876877/// Unified extended data for creating item.878#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]879#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]880pub enum CreateItemExData<CrossAccountId> {881	/// Extended data for create NFT.882	NFT(883		#[derivative(Debug(format_with = "bounded::vec_debug"))]884		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,885	),886887	/// Extended data for create Fungible item.888	Fungible(889		#[derivative(Debug(format_with = "bounded::map_debug"))]890		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,891	),892893	/// Extended data for create ReFungible item in case of894	/// many tokens, each may have only one owner895	RefungibleMultipleItems(896		#[derivative(Debug(format_with = "bounded::vec_debug"))]897		BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,898	),899900	/// Extended data for create ReFungible item in case of901	/// single token, which may have many owners902	RefungibleMultipleOwners(CreateRefungibleExMultipleOwners<CrossAccountId>),903}904905impl From<CreateNftData> for CreateItemData {906	fn from(item: CreateNftData) -> Self {907		CreateItemData::NFT(item)908	}909}910911impl From<CreateReFungibleData> for CreateItemData {912	fn from(item: CreateReFungibleData) -> Self {913		CreateItemData::ReFungible(item)914	}915}916917impl From<CreateFungibleData> for CreateItemData {918	fn from(item: CreateFungibleData) -> Self {919		CreateItemData::Fungible(item)920	}921}922923/// Token's address, dictated by its collection and token IDs.924#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]925#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]926// todo possibly rename to be used generally as an address pair927pub struct TokenChild {928	/// Token id.929	pub token: TokenId,930931	/// Collection id.932	pub collection: CollectionId,933}934935/// Collection statistics.936#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]937#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]938pub struct CollectionStats {939	/// Number of created items.940	pub created: u32,941942	/// Number of burned items.943	pub destroyed: u32,944945	/// Number of current items.946	pub alive: u32,947}948949/// This type works like [`PhantomData`] but supports generating _scale-info_ descriptions to generate node metadata.950#[derive(Encode, Decode, Clone, Debug)]951#[cfg_attr(feature = "std", derive(PartialEq))]952pub struct PhantomType<T>(core::marker::PhantomData<T>);953954impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {955	type Identity = PhantomType<T>;956957	fn type_info() -> scale_info::Type {958		use scale_info::{959			Type, Path,960			build::{FieldsBuilder, UnnamedFields},961			type_params,962		};963		Type::builder()964			.path(Path::new("up_data_structs", "PhantomType"))965			.type_params(type_params!(T))966			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))967	}968}969impl<T> MaxEncodedLen for PhantomType<T> {970	fn max_encoded_len() -> usize {971		0972	}973}974975/// Bounded vector of bytes.976pub type BoundedBytes<S> = BoundedVec<u8, S>;977978/// Extra properties for external collections.979pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;980981/// Property key.982pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;983984/// Property value.985pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;986987/// Property permission.988#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]989#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]990pub struct PropertyPermission {991	/// Permission to change the property and property permission.992	///993	/// If it **false** then you can not change corresponding property even if [`collection_admin`] and [`token_owner`] are **true**.994	pub mutable: bool,995996	/// Change permission for the collection administrator.997	pub collection_admin: bool,998999	/// Permission to change the property for the owner of the token.1000	pub token_owner: bool,1001}10021003impl PropertyPermission {1004	/// Creates mutable property permission but changes restricted for collection admin and token owner.1005	pub fn none() -> Self {1006		Self {1007			mutable: true,1008			collection_admin: false,1009			token_owner: false,1010		}1011	}1012}10131014/// Property is simpl key-value record.1015#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1016#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1017pub struct Property {1018	/// Property key.1019	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1020	pub key: PropertyKey,10211022	/// Property value.1023	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1024	pub value: PropertyValue,1025}10261027impl Into<(PropertyKey, PropertyValue)> for Property {1028	fn into(self) -> (PropertyKey, PropertyValue) {1029		(self.key, self.value)1030	}1031}10321033/// Record for proprty key permission.1034#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1035#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1036pub struct PropertyKeyPermission {1037	/// Key.1038	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1039	pub key: PropertyKey,10401041	/// Permission.1042	pub permission: PropertyPermission,1043}10441045impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1046	fn into(self) -> (PropertyKey, PropertyPermission) {1047		(self.key, self.permission)1048	}1049}10501051/// Errors for properties actions.1052#[derive(Debug)]1053pub enum PropertiesError {1054	/// The space allocated for properties has run out.1055	///1056	/// * Limit for colection - [`MAX_COLLECTION_PROPERTIES_SIZE`].1057	/// * Limit for token - [`MAX_TOKEN_PROPERTIES_SIZE`].1058	NoSpaceForProperty,10591060	/// The property limit has been reached.1061	///1062	/// * Limit - [`MAX_PROPERTIES_PER_ITEM`].1063	PropertyLimitReached,10641065	/// Property key contains not allowed character.1066	InvalidCharacterInPropertyKey,10671068	/// Property key length is too long.1069	///1070	/// * Limit - [`MAX_PROPERTY_KEY_LENGTH`].1071	PropertyKeyIsTooLong,10721073	/// Property key is empty.1074	EmptyPropertyKey,1075}10761077/// Marker for scope of property.1078///1079/// Scoped property can't be changed by user. Used for external collections.1080#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1081pub enum PropertyScope {1082	None,1083	Rmrk,1084}10851086impl PropertyScope {1087	/// Apply scope to property key.1088	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {1089		let scope_str: &[u8] = match self {1090			Self::None => return Ok(key),1091			Self::Rmrk => b"rmrk",1092		};10931094		[scope_str, b":", key.as_slice()]1095			.concat()1096			.try_into()1097			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)1098	}1099}11001101/// Trait for operate with properties.1102pub trait TrySetProperty: Sized {1103	type Value;11041105	/// Try to set property with scope.1106	fn try_scoped_set(1107		&mut self,1108		scope: PropertyScope,1109		key: PropertyKey,1110		value: Self::Value,1111	) -> Result<(), PropertiesError>;11121113	/// Try to set property with scope from iterator.1114	fn try_scoped_set_from_iter<I, KV>(1115		&mut self,1116		scope: PropertyScope,1117		iter: I,1118	) -> Result<(), PropertiesError>1119	where1120		I: Iterator<Item = KV>,1121		KV: Into<(PropertyKey, Self::Value)>,1122	{1123		for kv in iter {1124			let (key, value) = kv.into();1125			self.try_scoped_set(scope, key, value)?;1126		}11271128		Ok(())1129	}11301131	/// Try to set property.1132	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {1133		self.try_scoped_set(PropertyScope::None, key, value)1134	}11351136	/// Try to set property from iterator.1137	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>1138	where1139		I: Iterator<Item = KV>,1140		KV: Into<(PropertyKey, Self::Value)>,1141	{1142		self.try_scoped_set_from_iter(PropertyScope::None, iter)1143	}1144}11451146/// Wrapped map for storing properties.1147#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]1148#[derivative(Default(bound = ""))]1149pub struct PropertiesMap<Value>(1150	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,1151);11521153impl<Value> PropertiesMap<Value> {1154	/// Create new property map.1155	pub fn new() -> Self {1156		Self(BoundedBTreeMap::new())1157	}11581159	/// Remove property from map.1160	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {1161		Self::check_property_key(key)?;11621163		Ok(self.0.remove(key))1164	}11651166	/// Get property with appropriate key from map.1167	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1168		self.0.get(key)1169	}11701171	/// Check if map contains key.1172	pub fn contains_key(&self, key: &PropertyKey) -> bool {1173		self.0.contains_key(key)1174	}11751176	/// Check if map contains key with key validation.1177	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {1178		if key.is_empty() {1179			return Err(PropertiesError::EmptyPropertyKey);1180		}11811182		for byte in key.as_slice().iter() {1183			let byte = *byte;11841185			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {1186				return Err(PropertiesError::InvalidCharacterInPropertyKey);1187			}1188		}11891190		Ok(())1191	}1192}11931194impl<Value> IntoIterator for PropertiesMap<Value> {1195	type Item = (PropertyKey, Value);1196	type IntoIter = <1197		BoundedBTreeMap<1198			PropertyKey,1199			Value,1200			ConstU32<MAX_PROPERTIES_PER_ITEM>1201		> as IntoIterator1202	>::IntoIter;12031204	fn into_iter(self) -> Self::IntoIter {1205		self.0.into_iter()1206	}1207}12081209impl<Value> TrySetProperty for PropertiesMap<Value> {1210	type Value = Value;12111212	fn try_scoped_set(1213		&mut self,1214		scope: PropertyScope,1215		key: PropertyKey,1216		value: Self::Value,1217	) -> Result<(), PropertiesError> {1218		Self::check_property_key(&key)?;12191220		let key = scope.apply(key)?;1221		self.01222			.try_insert(key, value)1223			.map_err(|_| PropertiesError::PropertyLimitReached)?;12241225		Ok(())1226	}1227}12281229/// Alias for property permissions map.1230pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;12311232/// Wrapper for properties map with consumed space control.1233#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1234pub struct Properties {1235	map: PropertiesMap<PropertyValue>,1236	consumed_space: u32,1237	space_limit: u32,1238}12391240impl Properties {1241	/// Create new properies container.1242	pub fn new(space_limit: u32) -> Self {1243		Self {1244			map: PropertiesMap::new(),1245			consumed_space: 0,1246			space_limit,1247		}1248	}12491250	/// Remove propery with appropiate key.1251	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {1252		let value = self.map.remove(key)?;12531254		if let Some(ref value) = value {1255			let value_len = value.len() as u32;1256			self.consumed_space -= value_len;1257		}12581259		Ok(value)1260	}12611262	/// Get property with appropriate key.1263	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {1264		self.map.get(key)1265	}1266}12671268impl IntoIterator for Properties {1269	type Item = (PropertyKey, PropertyValue);1270	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;12711272	fn into_iter(self) -> Self::IntoIter {1273		self.map.into_iter()1274	}1275}12761277impl TrySetProperty for Properties {1278	type Value = PropertyValue;12791280	fn try_scoped_set(1281		&mut self,1282		scope: PropertyScope,1283		key: PropertyKey,1284		value: Self::Value,1285	) -> Result<(), PropertiesError> {1286		let value_len = value.len();12871288		if self.consumed_space as usize + value_len > self.space_limit as usize1289			&& !cfg!(feature = "runtime-benchmarks")1290		{1291			return Err(PropertiesError::NoSpaceForProperty);1292		}12931294		self.map.try_scoped_set(scope, key, value)?;12951296		self.consumed_space += value_len as u32;12971298		Ok(())1299	}1300}13011302/// Utility struct for using in `StorageMap`.1303pub struct CollectionProperties;13041305impl Get<Properties> for CollectionProperties {1306	fn get() -> Properties {1307		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)1308	}1309}13101311/// Utility struct for using in `StorageMap`.1312pub struct TokenProperties;13131314impl Get<Properties> for TokenProperties {1315	fn get() -> Properties {1316		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)1317	}1318}13191320// RMRK1321// todo document?1322parameter_types! {1323	#[derive(PartialEq, TypeInfo)]1324	pub const RmrkStringLimit: u32 = 128;1325	#[derive(PartialEq)]1326	pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1327	#[derive(PartialEq)]1328	pub const RmrkResourceSymbolLimit: u32 = 10;1329	#[derive(PartialEq)]1330	pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1331	#[derive(PartialEq)]1332	pub const RmrkKeyLimit: u32 = 32;1333	#[derive(PartialEq)]1334	pub const RmrkValueLimit: u32 = 256;1335	#[derive(PartialEq)]1336	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1337	#[derive(PartialEq)]1338	pub const MaxPropertiesPerTheme: u32 = 5;1339	#[derive(PartialEq)]1340	pub const RmrkPartsLimit: u32 = 25;1341	#[derive(PartialEq)]1342	pub const RmrkMaxPriorities: u32 = 25;1343	#[derive(PartialEq)]1344	pub const MaxResourcesOnMint: u32 = 100;1345}13461347impl From<RmrkCollectionId> for CollectionId {1348	fn from(id: RmrkCollectionId) -> Self {1349		Self(id)1350	}1351}13521353impl From<RmrkNftId> for TokenId {1354	fn from(id: RmrkNftId) -> Self {1355		Self(id)1356	}1357}13581359pub type RmrkCollectionInfo<AccountId> =1360	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1361pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1362pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1363pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1364pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1365pub type BoundedEquippableCollectionIds =1366	BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1367pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1368pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1369pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1370pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1371pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1372pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;13731374pub type RmrkBasicResource = BasicResource<RmrkString>;1375pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1376pub type RmrkSlotResource = SlotResource<RmrkString>;13771378pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1379pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1380pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1381pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1382pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1383pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1384pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed13851386pub type RmrkRpcString = Vec<u8>;1387pub type RmrkThemeName = RmrkRpcString;1388pub type RmrkPropertyKey = RmrkRpcString;