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

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#![cfg_attr(not(feature = "std"), no_std)]1819use core::{20	convert::{TryFrom, TryInto},21	fmt,22};23use frame_support::{24	storage::{bounded_btree_map::BoundedBTreeMap, bounded_btree_set::BoundedBTreeSet},25	traits::Get,26	parameter_types,27};2829#[cfg(feature = "serde")]30use serde::{Serialize, Deserialize};3132use sp_core::U256;33use sp_runtime::{ArithmeticError, sp_std::prelude::Vec, Permill};34use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};35use frame_support::{BoundedVec, traits::ConstU32};36use derivative::Derivative;37use scale_info::TypeInfo;3839// RMRK40use rmrk_traits::{41	CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme, ThemeProperty,42	ResourceTypes, BasicResource, ComposableResource, SlotResource, EquippableList,43};44pub use rmrk_traits::{45	primitives::{46		CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,47		SlotId as RmrkSlotId, PartId as RmrkPartId, ResourceId as RmrkResourceId,48	},49	NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,50	FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart,51};5253mod bounded;54pub mod budget;55pub mod mapping;56mod migration;5758pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;59pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;60pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;6162pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {63	100_00064} else {65	1066};67pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {68	100_00069} else {70	1071};72pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {73	204874} else {75	1076};77pub const COLLECTION_ADMINS_LIMIT: u32 = 5;78pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;79pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {80	1_000_00081} else {82	1083};8485// Timeouts for item types in passed blocks86pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;87pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;88pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;8990pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;9192// Schema limits93pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;94pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;95pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;9697pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;9899pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;100pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;101pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;102103pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;104pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;105pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;106107pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;108109pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;110pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;111112/// How much items can be created per single113/// create_many call114pub const MAX_ITEMS_PER_BATCH: u32 = 200;115116pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;117118#[derive(119	Encode,120	Decode,121	PartialEq,122	Eq,123	PartialOrd,124	Ord,125	Clone,126	Copy,127	Debug,128	Default,129	TypeInfo,130	MaxEncodedLen,131)]132#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]133pub struct CollectionId(pub u32);134impl EncodeLike<u32> for CollectionId {}135impl EncodeLike<CollectionId> for u32 {}136137#[derive(138	Encode,139	Decode,140	PartialEq,141	Eq,142	PartialOrd,143	Ord,144	Clone,145	Copy,146	Debug,147	Default,148	TypeInfo,149	MaxEncodedLen,150)]151#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]152pub struct TokenId(pub u32);153impl EncodeLike<u32> for TokenId {}154impl EncodeLike<TokenId> for u32 {}155156impl TokenId {157	pub fn try_next(self) -> Result<TokenId, ArithmeticError> {158		self.0159			.checked_add(1)160			.ok_or(ArithmeticError::Overflow)161			.map(Self)162	}163}164165impl From<TokenId> for U256 {166	fn from(t: TokenId) -> Self {167		t.0.into()168	}169}170171impl TryFrom<U256> for TokenId {172	type Error = &'static str;173174	fn try_from(value: U256) -> Result<Self, Self::Error> {175		Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))176	}177}178179#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]180#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]181pub struct TokenData<CrossAccountId> {182	pub properties: Vec<Property>,183	pub owner: Option<CrossAccountId>,184	pub pieces: u128,185}186187pub struct OverflowError;188impl From<OverflowError> for &'static str {189	fn from(_: OverflowError) -> Self {190		"overflow occured"191	}192}193194pub type DecimalPoints = u8;195196#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]197#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]198pub enum CollectionMode {199	NFT,200	Fungible(DecimalPoints),201	ReFungible,202}203204impl CollectionMode {205	pub fn id(&self) -> u8 {206		match self {207			CollectionMode::NFT => 1,208			CollectionMode::Fungible(_) => 2,209			CollectionMode::ReFungible => 3,210		}211	}212}213214pub trait SponsoringResolve<AccountId, Call> {215	fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;216}217218#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]219#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]220pub enum AccessMode {221	Normal,222	AllowList,223}224impl Default for AccessMode {225	fn default() -> Self {226		Self::Normal227	}228}229230#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]231#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]232pub enum SchemaVersion {233	ImageURL,234	Unique,235}236impl Default for SchemaVersion {237	fn default() -> Self {238		Self::ImageURL239	}240}241242#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]243#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]244pub struct Ownership<AccountId> {245	pub owner: AccountId,246	pub fraction: u128,247}248249#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]250#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]251pub enum SponsorshipState<AccountId> {252	/// The fees are applied to the transaction sender253	Disabled,254	/// Pending confirmation from a sponsor-to-be255	Unconfirmed(AccountId),256	/// Transactions are sponsored by specified account257	Confirmed(AccountId),258}259260impl<AccountId> SponsorshipState<AccountId> {261	/// Get the acting sponsor account, if present262	pub fn sponsor(&self) -> Option<&AccountId> {263		match self {264			Self::Confirmed(sponsor) => Some(sponsor),265			_ => None,266		}267	}268269	/// Get the sponsor account currently pending confirmation, if present270	pub fn pending_sponsor(&self) -> Option<&AccountId> {271		match self {272			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),273			_ => None,274		}275	}276277	/// Is sponsorship set and acting278	pub fn confirmed(&self) -> bool {279		matches!(self, Self::Confirmed(_))280	}281}282283impl<T> Default for SponsorshipState<T> {284	fn default() -> Self {285		Self::Disabled286	}287}288289/// Collection parameters, used in storage (see [`RpcCollection`] for the RPC version).290#[struct_versioning::versioned(version = 2, upper)]291#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]292pub struct Collection<AccountId> {293	pub owner: AccountId,294	pub mode: CollectionMode,295	#[version(..2)]296	pub access: AccessMode,297	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,298	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,299	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,300301	#[version(..2)]302	pub mint_mode: bool,303304	#[version(..2)]305	pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,306307	#[version(..2)]308	pub schema_version: SchemaVersion,309	pub sponsorship: SponsorshipState<AccountId>,310311	pub limits: CollectionLimits,312313	#[version(2.., upper(Default::default()))]314	pub permissions: CollectionPermissions,315316	/// Marks that this collection is not "unique", and managed from external.317	#[version(2.., upper(false))]318	pub external_collection: bool,319320	#[version(..2)]321	pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,322323	#[version(..2)]324	pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,325326	#[version(..2)]327	pub meta_update_permission: MetaUpdatePermission,328}329330/// Collection parameters, used in RPC calls (see [`Collection`] for the storage version).331#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]332#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]333pub struct RpcCollection<AccountId> {334	pub owner: AccountId,335	pub mode: CollectionMode,336	pub name: Vec<u16>,337	pub description: Vec<u16>,338	pub token_prefix: Vec<u8>,339	pub sponsorship: SponsorshipState<AccountId>,340	pub limits: CollectionLimits,341	pub permissions: CollectionPermissions,342	pub token_property_permissions: Vec<PropertyKeyPermission>,343	pub properties: Vec<Property>,344	pub read_only: bool,345}346347#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]348#[derivative(Debug, Default(bound = ""))]349pub struct CreateCollectionData<AccountId> {350	#[derivative(Default(value = "CollectionMode::NFT"))]351	pub mode: CollectionMode,352	pub access: Option<AccessMode>,353	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,354	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,355	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,356	pub pending_sponsor: Option<AccountId>,357	pub limits: Option<CollectionLimits>,358	pub permissions: Option<CollectionPermissions>,359	pub token_property_permissions: CollectionPropertiesPermissionsVec,360	pub properties: CollectionPropertiesVec,361}362363pub type CollectionPropertiesPermissionsVec =364	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;365366pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;367368/// Limits and restrictions of a collection.369/// All fields are wrapped in `Option`s, where None means chain default.370///371/// todo:doc links to chain defaults372// IMPORTANT: When adding/removing fields from this struct - don't forget to also373// update clamp_limits() in pallet-common.374#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]375#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]376pub struct CollectionLimits {377	/// Maximum number of owned tokens per account. Chain default: [`ACCOUNT_TOKEN_OWNERSHIP_LIMIT`]378	pub account_token_ownership_limit: Option<u32>,379	/// Maximum size of data in bytes of a sponsored transaction. Chain default: [`CUSTOM_DATA_LIMIT`]380	pub sponsored_data_size: Option<u32>,381382	/// FIXME should we delete this or repurpose it?383	/// None - setVariableMetadata is not sponsored384	/// Some(v) - setVariableMetadata is sponsored385	///           if there is v block between txs386	///387	/// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]388	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,389	/// Maximum amount of tokens inside the collection. Chain default: [`COLLECTION_TOKEN_LIMIT`]390	pub token_limit: Option<u32>,391392	/// Timeout for sponsoring a token transfer in passed blocks. Chain default:393	/// either [`NFT_SPONSOR_TRANSFER_TIMEOUT`], [`FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`], or [`REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`],394	/// depending on the collection type.395	pub sponsor_transfer_timeout: Option<u32>,396	/// Timeout for sponsoring an approval in passed blocks. Chain default: [`SPONSOR_APPROVE_TIMEOUT`]397	pub sponsor_approve_timeout: Option<u32>,398	/// Can a token be transferred by the owner. Chain default: `false`399	pub owner_can_transfer: Option<bool>,400	/// Can a token be burned by the owner. Chain default: `true`401	pub owner_can_destroy: Option<bool>,402	/// Can a token be transferred at all. Chain default: `true`403	pub transfers_enabled: Option<bool>,404}405406impl CollectionLimits {407	pub fn account_token_ownership_limit(&self) -> u32 {408		self.account_token_ownership_limit409			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)410			.min(MAX_TOKEN_OWNERSHIP)411	}412	pub fn sponsored_data_size(&self) -> u32 {413		self.sponsored_data_size414			.unwrap_or(CUSTOM_DATA_LIMIT)415			.min(CUSTOM_DATA_LIMIT)416	}417	pub fn token_limit(&self) -> u32 {418		self.token_limit419			.unwrap_or(COLLECTION_TOKEN_LIMIT)420			.min(COLLECTION_TOKEN_LIMIT)421	}422	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {423		self.sponsor_transfer_timeout424			.unwrap_or(default)425			.min(MAX_SPONSOR_TIMEOUT)426	}427	pub fn sponsor_approve_timeout(&self) -> u32 {428		self.sponsor_approve_timeout429			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)430			.min(MAX_SPONSOR_TIMEOUT)431	}432	pub fn owner_can_transfer(&self) -> bool {433		self.owner_can_transfer.unwrap_or(false)434	}435	pub fn owner_can_transfer_instaled(&self) -> bool {436		self.owner_can_transfer.is_some()437	}438	pub fn owner_can_destroy(&self) -> bool {439		self.owner_can_destroy.unwrap_or(true)440	}441	pub fn transfers_enabled(&self) -> bool {442		self.transfers_enabled.unwrap_or(true)443	}444	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {445		match self446			.sponsored_data_rate_limit447			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)448		{449			SponsoringRateLimit::SponsoringDisabled => None,450			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),451		}452	}453}454455/// Permissions on certain operations within a collection.456/// All fields are wrapped in `Option`s, where None means chain default.457// IMPORTANT: When adding/removing fields from this struct - don't forget to also458// update clamp_limits() in pallet-common.459#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]460#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]461pub struct CollectionPermissions {462	pub access: Option<AccessMode>,463	pub mint_mode: Option<bool>,464	pub nesting: Option<NestingPermissions>,465}466467impl CollectionPermissions {468	pub fn access(&self) -> AccessMode {469		self.access.unwrap_or(AccessMode::Normal)470	}471	pub fn mint_mode(&self) -> bool {472		self.mint_mode.unwrap_or(false)473	}474	pub fn nesting(&self) -> &NestingPermissions {475		static DEFAULT: NestingPermissions = NestingPermissions {476			token_owner: false,477			collection_admin: false,478			restricted: None,479			#[cfg(feature = "runtime-benchmarks")]480			permissive: false,481		};482		self.nesting.as_ref().unwrap_or(&DEFAULT)483	}484}485486type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;487488#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]489#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]490#[derivative(Debug)]491pub struct OwnerRestrictedSet(492	#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]493	#[derivative(Debug(format_with = "bounded::set_debug"))]494	pub OwnerRestrictedSetInner,495);496impl OwnerRestrictedSet {497	pub fn new() -> Self {498		Self(Default::default())499	}500}501impl core::ops::Deref for OwnerRestrictedSet {502	type Target = OwnerRestrictedSetInner;503	fn deref(&self) -> &Self::Target {504		&self.0505	}506}507impl core::ops::DerefMut for OwnerRestrictedSet {508	fn deref_mut(&mut self) -> &mut Self::Target {509		&mut self.0510	}511}512513/// Part of collection permissions, if set, defines who is able to nest tokens into other tokens.514#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]515#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]516#[derivative(Debug)]517pub struct NestingPermissions {518	/// Owner of token can nest tokens under it519	pub token_owner: bool,520	/// Admin of token collection can nest tokens under token521	pub collection_admin: bool,522	/// If set - only tokens from specified collections can be nested523	pub restricted: Option<OwnerRestrictedSet>,524525	#[cfg(feature = "runtime-benchmarks")]526	/// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`527	pub permissive: bool,528}529530/// Enum denominating how often can sponsoring occur if it is enabled.531#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]532#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]533pub enum SponsoringRateLimit {534	/// Sponsoring is disabled, and the collection sponsor will not pay for transactions535	SponsoringDisabled,536	/// Once per how many blocks can sponsorship of a transaction type occur537	Blocks(u32),538}539540/// Data used to describe an NFT at creation.541#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]542#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]543#[derivative(Debug)]544pub struct CreateNftData {545	/// Key-value pairs used to describe the token as metadata546	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]547	#[derivative(Debug(format_with = "bounded::vec_debug"))]548	pub properties: CollectionPropertiesVec,549}550551/// Data used to describe a Fungible token at creation.552#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]553#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]554pub struct CreateFungibleData {555	/// Number of fungible coins minted556	pub value: u128,557}558559/// Data used to describe a Refungible token at creation.560#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]561#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]562#[derivative(Debug)]563pub struct CreateReFungibleData {564	/// Immutable metadata of the token565	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]566	#[derivative(Debug(format_with = "bounded::vec_debug"))]567	pub const_data: BoundedVec<u8, CustomDataLimit>,568569	/// Number of pieces the RFT is split into570	pub pieces: u128,571572	/// Key-value pairs used to describe the token as metadata573	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]574	#[derivative(Debug(format_with = "bounded::vec_debug"))]575	pub properties: CollectionPropertiesVec,576}577578#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]579#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]580pub enum MetaUpdatePermission {581	ItemOwner,582	Admin,583	None,584}585586/// Enum holding data used for creation of all three item types.587#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]588#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]589pub enum CreateItemData {590	NFT(CreateNftData),591	Fungible(CreateFungibleData),592	ReFungible(CreateReFungibleData),593}594595/// Explicit NFT creation data with meta parameters.596#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]597#[derivative(Debug)]598pub struct CreateNftExData<CrossAccountId> {599	#[derivative(Debug(format_with = "bounded::vec_debug"))]600	pub properties: CollectionPropertiesVec,601	pub owner: CrossAccountId,602}603604/// Explicit RFT creation data with meta parameters.605#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]606#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]607pub struct CreateRefungibleExData<CrossAccountId> {608	#[derivative(Debug(format_with = "bounded::vec_debug"))]609	pub const_data: BoundedVec<u8, CustomDataLimit>,610	#[derivative(Debug(format_with = "bounded::map_debug"))]611	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,612	#[derivative(Debug(format_with = "bounded::vec_debug"))]613	pub properties: CollectionPropertiesVec,614}615616/// Explicit item creation data with meta parameters, namely the owner.617#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]618#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]619pub enum CreateItemExData<CrossAccountId> {620	NFT(621		#[derivative(Debug(format_with = "bounded::vec_debug"))]622		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,623	),624	Fungible(625		#[derivative(Debug(format_with = "bounded::map_debug"))]626		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,627	),628	/// Many tokens, each may have only one owner629	RefungibleMultipleItems(630		#[derivative(Debug(format_with = "bounded::vec_debug"))]631		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,632	),633	/// Single token, which may have many owners634	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),635}636637impl CreateItemData {638	pub fn data_size(&self) -> usize {639		match self {640			CreateItemData::ReFungible(data) => data.const_data.len(),641			_ => 0,642		}643	}644}645646impl From<CreateNftData> for CreateItemData {647	fn from(item: CreateNftData) -> Self {648		CreateItemData::NFT(item)649	}650}651652impl From<CreateReFungibleData> for CreateItemData {653	fn from(item: CreateReFungibleData) -> Self {654		CreateItemData::ReFungible(item)655	}656}657658impl From<CreateFungibleData> for CreateItemData {659	fn from(item: CreateFungibleData) -> Self {660		CreateItemData::Fungible(item)661	}662}663664/// Token's address, dictated by its collection and token IDs.665#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]666#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]667// todo possibly rename to be used generally as an address pair668pub struct TokenChild {669	pub token: TokenId,670	pub collection: CollectionId,671}672673#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]674#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]675pub struct CollectionStats {676	pub created: u32,677	pub destroyed: u32,678	pub alive: u32,679}680681#[derive(Encode, Decode, Clone, Debug)]682#[cfg_attr(feature = "std", derive(PartialEq))]683pub struct PhantomType<T>(core::marker::PhantomData<T>);684685impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {686	type Identity = PhantomType<T>;687688	fn type_info() -> scale_info::Type {689		use scale_info::{690			Type, Path,691			build::{FieldsBuilder, UnnamedFields},692			type_params,693		};694		Type::builder()695			.path(Path::new("up_data_structs", "PhantomType"))696			.type_params(type_params!(T))697			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))698	}699}700impl<T> MaxEncodedLen for PhantomType<T> {701	fn max_encoded_len() -> usize {702		0703	}704}705706pub type BoundedBytes<S> = BoundedVec<u8, S>;707708pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;709710pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;711pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;712713#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]714#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]715pub struct PropertyPermission {716	pub mutable: bool,717	pub collection_admin: bool,718	pub token_owner: bool,719}720721impl PropertyPermission {722	pub fn none() -> Self {723		Self {724			mutable: true,725			collection_admin: false,726			token_owner: false,727		}728	}729}730731#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]732#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]733pub struct Property {734	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]735	pub key: PropertyKey,736737	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]738	pub value: PropertyValue,739}740741impl Into<(PropertyKey, PropertyValue)> for Property {742	fn into(self) -> (PropertyKey, PropertyValue) {743		(self.key, self.value)744	}745}746747#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]748#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]749pub struct PropertyKeyPermission {750	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]751	pub key: PropertyKey,752753	pub permission: PropertyPermission,754}755756impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {757	fn into(self) -> (PropertyKey, PropertyPermission) {758		(self.key, self.permission)759	}760}761762#[derive(Debug)]763pub enum PropertiesError {764	NoSpaceForProperty,765	PropertyLimitReached,766	InvalidCharacterInPropertyKey,767	PropertyKeyIsTooLong,768	EmptyPropertyKey,769}770771#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]772pub enum PropertyScope {773	None,774	Rmrk,775}776777impl PropertyScope {778	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {779		let scope_str: &[u8] = match self {780			Self::None => return Ok(key),781			Self::Rmrk => b"rmrk",782		};783784		[scope_str, b":", key.as_slice()]785			.concat()786			.try_into()787			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)788	}789}790791pub trait TrySetProperty: Sized {792	type Value;793794	fn try_scoped_set(795		&mut self,796		scope: PropertyScope,797		key: PropertyKey,798		value: Self::Value,799	) -> Result<(), PropertiesError>;800801	fn try_scoped_set_from_iter<I, KV>(802		&mut self,803		scope: PropertyScope,804		iter: I,805	) -> Result<(), PropertiesError>806	where807		I: Iterator<Item = KV>,808		KV: Into<(PropertyKey, Self::Value)>,809	{810		for kv in iter {811			let (key, value) = kv.into();812			self.try_scoped_set(scope, key, value)?;813		}814815		Ok(())816	}817818	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {819		self.try_scoped_set(PropertyScope::None, key, value)820	}821822	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>823	where824		I: Iterator<Item = KV>,825		KV: Into<(PropertyKey, Self::Value)>,826	{827		self.try_scoped_set_from_iter(PropertyScope::None, iter)828	}829}830831#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]832#[derivative(Default(bound = ""))]833pub struct PropertiesMap<Value>(834	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,835);836837impl<Value> PropertiesMap<Value> {838	pub fn new() -> Self {839		Self(BoundedBTreeMap::new())840	}841842	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {843		Self::check_property_key(key)?;844845		Ok(self.0.remove(key))846	}847848	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {849		self.0.get(key)850	}851852	pub fn contains_key(&self, key: &PropertyKey) -> bool {853		self.0.contains_key(key)854	}855856	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {857		if key.is_empty() {858			return Err(PropertiesError::EmptyPropertyKey);859		}860861		for byte in key.as_slice().iter() {862			let byte = *byte;863864			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {865				return Err(PropertiesError::InvalidCharacterInPropertyKey);866			}867		}868869		Ok(())870	}871}872873impl<Value> IntoIterator for PropertiesMap<Value> {874	type Item = (PropertyKey, Value);875	type IntoIter = <876		BoundedBTreeMap<877			PropertyKey,878			Value,879			ConstU32<MAX_PROPERTIES_PER_ITEM>880		> as IntoIterator881	>::IntoIter;882883	fn into_iter(self) -> Self::IntoIter {884		self.0.into_iter()885	}886}887888impl<Value> TrySetProperty for PropertiesMap<Value> {889	type Value = Value;890891	fn try_scoped_set(892		&mut self,893		scope: PropertyScope,894		key: PropertyKey,895		value: Self::Value,896	) -> Result<(), PropertiesError> {897		Self::check_property_key(&key)?;898899		let key = scope.apply(key)?;900		self.0901			.try_insert(key, value)902			.map_err(|_| PropertiesError::PropertyLimitReached)?;903904		Ok(())905	}906}907908pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;909910#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]911pub struct Properties {912	map: PropertiesMap<PropertyValue>,913	consumed_space: u32,914	space_limit: u32,915}916917impl Properties {918	pub fn new(space_limit: u32) -> Self {919		Self {920			map: PropertiesMap::new(),921			consumed_space: 0,922			space_limit,923		}924	}925926	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {927		let value = self.map.remove(key)?;928929		if let Some(ref value) = value {930			let value_len = value.len() as u32;931			self.consumed_space -= value_len;932		}933934		Ok(value)935	}936937	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {938		self.map.get(key)939	}940}941942impl IntoIterator for Properties {943	type Item = (PropertyKey, PropertyValue);944	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;945946	fn into_iter(self) -> Self::IntoIter {947		self.map.into_iter()948	}949}950951impl TrySetProperty for Properties {952	type Value = PropertyValue;953954	fn try_scoped_set(955		&mut self,956		scope: PropertyScope,957		key: PropertyKey,958		value: Self::Value,959	) -> Result<(), PropertiesError> {960		let value_len = value.len();961962		if self.consumed_space as usize + value_len > self.space_limit as usize963			&& !cfg!(feature = "runtime-benchmarks")964		{965			return Err(PropertiesError::NoSpaceForProperty);966		}967968		self.map.try_scoped_set(scope, key, value)?;969970		self.consumed_space += value_len as u32;971972		Ok(())973	}974}975976pub struct CollectionProperties;977978impl Get<Properties> for CollectionProperties {979	fn get() -> Properties {980		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)981	}982}983984pub struct TokenProperties;985986impl Get<Properties> for TokenProperties {987	fn get() -> Properties {988		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)989	}990}991992// RMRK993// todo document?994parameter_types! {995	#[derive(PartialEq, TypeInfo)]996	pub const RmrkStringLimit: u32 = 128;997	#[derive(PartialEq)]998	pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;999	#[derive(PartialEq)]1000	pub const RmrkResourceSymbolLimit: u32 = 10;1001	#[derive(PartialEq)]1002	pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1003	#[derive(PartialEq)]1004	pub const RmrkKeyLimit: u32 = 32;1005	#[derive(PartialEq)]1006	pub const RmrkValueLimit: u32 = 256;1007	#[derive(PartialEq)]1008	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1009	#[derive(PartialEq)]1010	pub const MaxPropertiesPerTheme: u32 = 5;1011	#[derive(PartialEq)]1012	pub const RmrkPartsLimit: u32 = 25;1013	#[derive(PartialEq)]1014	pub const RmrkMaxPriorities: u32 = 25;1015	#[derive(PartialEq)]1016	pub const MaxResourcesOnMint: u32 = 100;1017}10181019impl From<RmrkCollectionId> for CollectionId {1020	fn from(id: RmrkCollectionId) -> Self {1021		Self(id)1022	}1023}10241025impl From<RmrkNftId> for TokenId {1026	fn from(id: RmrkNftId) -> Self {1027		Self(id)1028	}1029}10301031pub type RmrkCollectionInfo<AccountId> =1032	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1033pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1034pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1035pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1036pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1037pub type BoundedEquippableCollectionIds =1038	BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1039pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1040pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1041pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1042pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1043pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1044pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;10451046pub type RmrkBasicResource = BasicResource<RmrkString>;1047pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1048pub type RmrkSlotResource = SlotResource<RmrkString>;10491050pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1051pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1052pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1053pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1054pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1055pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1056pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed10571058pub type RmrkRpcString = Vec<u8>;1059pub type RmrkThemeName = RmrkRpcString;1060pub type RmrkPropertyKey = RmrkRpcString;