git.delta.rocks / unique-network / refs/commits / 42b27fc67845

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: [`MAX_SPONSOR_TIMEOUT`]393	pub sponsor_transfer_timeout: Option<u32>,394	/// Timeout for sponsoring an approval in passed blocks. Chain default: [`SPONSOR_APPROVE_TIMEOUT`]395	pub sponsor_approve_timeout: Option<u32>,396	/// Can a token be transferred by the owner. Chain default: `false`397	pub owner_can_transfer: Option<bool>,398	/// Can a token be burned by the owner. Chain default: `true`399	pub owner_can_destroy: Option<bool>,400	/// Can a token be transferred at all. Chain default: `true`401	pub transfers_enabled: Option<bool>,402}403404impl CollectionLimits {405	pub fn account_token_ownership_limit(&self) -> u32 {406		self.account_token_ownership_limit407			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)408			.min(MAX_TOKEN_OWNERSHIP)409	}410	pub fn sponsored_data_size(&self) -> u32 {411		self.sponsored_data_size412			.unwrap_or(CUSTOM_DATA_LIMIT)413			.min(CUSTOM_DATA_LIMIT)414	}415	pub fn token_limit(&self) -> u32 {416		self.token_limit417			.unwrap_or(COLLECTION_TOKEN_LIMIT)418			.min(COLLECTION_TOKEN_LIMIT)419	}420	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {421		self.sponsor_transfer_timeout422			.unwrap_or(default)423			.min(MAX_SPONSOR_TIMEOUT)424	}425	pub fn sponsor_approve_timeout(&self) -> u32 {426		self.sponsor_approve_timeout427			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)428			.min(MAX_SPONSOR_TIMEOUT)429	}430	pub fn owner_can_transfer(&self) -> bool {431		self.owner_can_transfer.unwrap_or(false)432	}433	pub fn owner_can_transfer_instaled(&self) -> bool {434		self.owner_can_transfer.is_some()435	}436	pub fn owner_can_destroy(&self) -> bool {437		self.owner_can_destroy.unwrap_or(true)438	}439	pub fn transfers_enabled(&self) -> bool {440		self.transfers_enabled.unwrap_or(true)441	}442	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {443		match self444			.sponsored_data_rate_limit445			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)446		{447			SponsoringRateLimit::SponsoringDisabled => None,448			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),449		}450	}451}452453/// Permissions on certain operations within a collection.454/// All fields are wrapped in `Option`s, where None means chain default.455// IMPORTANT: When adding/removing fields from this struct - don't forget to also456// update clamp_limits() in pallet-common.457#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]458#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]459pub struct CollectionPermissions {460	pub access: Option<AccessMode>,461	pub mint_mode: Option<bool>,462	pub nesting: Option<NestingPermissions>,463}464465impl CollectionPermissions {466	pub fn access(&self) -> AccessMode {467		self.access.unwrap_or(AccessMode::Normal)468	}469	pub fn mint_mode(&self) -> bool {470		self.mint_mode.unwrap_or(false)471	}472	pub fn nesting(&self) -> &NestingPermissions {473		static DEFAULT: NestingPermissions = NestingPermissions {474			token_owner: false,475			collection_admin: false,476			restricted: None,477			#[cfg(feature = "runtime-benchmarks")]478			permissive: false,479		};480		self.nesting.as_ref().unwrap_or(&DEFAULT)481	}482}483484type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;485486#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]487#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]488#[derivative(Debug)]489pub struct OwnerRestrictedSet(490	#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]491	#[derivative(Debug(format_with = "bounded::set_debug"))]492	pub OwnerRestrictedSetInner,493);494impl OwnerRestrictedSet {495	pub fn new() -> Self {496		Self(Default::default())497	}498}499impl core::ops::Deref for OwnerRestrictedSet {500	type Target = OwnerRestrictedSetInner;501	fn deref(&self) -> &Self::Target {502		&self.0503	}504}505impl core::ops::DerefMut for OwnerRestrictedSet {506	fn deref_mut(&mut self) -> &mut Self::Target {507		&mut self.0508	}509}510511/// Part of collection permissions, if set, defines who is able to nest tokens into other tokens.512#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]513#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]514#[derivative(Debug)]515pub struct NestingPermissions {516	/// Owner of token can nest tokens under it517	pub token_owner: bool,518	/// Admin of token collection can nest tokens under token519	pub collection_admin: bool,520	/// If set - only tokens from specified collections can be nested521	pub restricted: Option<OwnerRestrictedSet>,522523	#[cfg(feature = "runtime-benchmarks")]524	/// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`525	pub permissive: bool,526}527528/// Enum denominating how often can sponsoring occur if it is enabled.529#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]530#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]531pub enum SponsoringRateLimit {532	/// Sponsoring is disabled, and the collection sponsor will not pay for transactions533	SponsoringDisabled,534	/// Once per how many blocks can sponsorship of a transaction type occur535	Blocks(u32),536}537538/// Data used to describe an NFT at creation.539#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]540#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]541#[derivative(Debug)]542pub struct CreateNftData {543	/// Key-value pairs used to describe the token as metadata544	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]545	#[derivative(Debug(format_with = "bounded::vec_debug"))]546	pub properties: CollectionPropertiesVec,547}548549/// Data used to describe a Fungible token at creation.550#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]551#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]552pub struct CreateFungibleData {553	/// Number of fungible coins minted554	pub value: u128,555}556557/// Data used to describe a Refungible token at creation.558#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]559#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]560#[derivative(Debug)]561pub struct CreateReFungibleData {562	/// Immutable metadata of the token563	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]564	#[derivative(Debug(format_with = "bounded::vec_debug"))]565	pub const_data: BoundedVec<u8, CustomDataLimit>,566567	/// Number of pieces the RFT is split into568	pub pieces: u128,569570	/// Key-value pairs used to describe the token as metadata571	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]572	#[derivative(Debug(format_with = "bounded::vec_debug"))]573	pub properties: CollectionPropertiesVec,574}575576#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]577#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]578pub enum MetaUpdatePermission {579	ItemOwner,580	Admin,581	None,582}583584/// Enum holding data used for creation of all three item types.585#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]586#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]587pub enum CreateItemData {588	NFT(CreateNftData),589	Fungible(CreateFungibleData),590	ReFungible(CreateReFungibleData),591}592593/// Explicit NFT creation data with meta parameters.594#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]595#[derivative(Debug)]596pub struct CreateNftExData<CrossAccountId> {597	#[derivative(Debug(format_with = "bounded::vec_debug"))]598	pub properties: CollectionPropertiesVec,599	pub owner: CrossAccountId,600}601602/// Explicit RFT creation data with meta parameters.603#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]604#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]605pub struct CreateRefungibleExData<CrossAccountId> {606	#[derivative(Debug(format_with = "bounded::vec_debug"))]607	pub const_data: BoundedVec<u8, CustomDataLimit>,608	#[derivative(Debug(format_with = "bounded::map_debug"))]609	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,610	#[derivative(Debug(format_with = "bounded::vec_debug"))]611	pub properties: CollectionPropertiesVec,612}613614/// Explicit item creation data with meta parameters, namely the owner.615#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]616#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]617pub enum CreateItemExData<CrossAccountId> {618	NFT(619		#[derivative(Debug(format_with = "bounded::vec_debug"))]620		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,621	),622	Fungible(623		#[derivative(Debug(format_with = "bounded::map_debug"))]624		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,625	),626	/// Many tokens, each may have only one owner627	RefungibleMultipleItems(628		#[derivative(Debug(format_with = "bounded::vec_debug"))]629		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,630	),631	/// Single token, which may have many owners632	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),633}634635impl CreateItemData {636	pub fn data_size(&self) -> usize {637		match self {638			CreateItemData::ReFungible(data) => data.const_data.len(),639			_ => 0,640		}641	}642}643644impl From<CreateNftData> for CreateItemData {645	fn from(item: CreateNftData) -> Self {646		CreateItemData::NFT(item)647	}648}649650impl From<CreateReFungibleData> for CreateItemData {651	fn from(item: CreateReFungibleData) -> Self {652		CreateItemData::ReFungible(item)653	}654}655656impl From<CreateFungibleData> for CreateItemData {657	fn from(item: CreateFungibleData) -> Self {658		CreateItemData::Fungible(item)659	}660}661662/// Token's address, dictated by its collection and token IDs.663#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]664#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]665// todo possibly rename to be used generally as an address pair666pub struct TokenChild {667	pub token: TokenId,668	pub collection: CollectionId,669}670671#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]672#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]673pub struct CollectionStats {674	pub created: u32,675	pub destroyed: u32,676	pub alive: u32,677}678679#[derive(Encode, Decode, Clone, Debug)]680#[cfg_attr(feature = "std", derive(PartialEq))]681pub struct PhantomType<T>(core::marker::PhantomData<T>);682683impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {684	type Identity = PhantomType<T>;685686	fn type_info() -> scale_info::Type {687		use scale_info::{688			Type, Path,689			build::{FieldsBuilder, UnnamedFields},690			type_params,691		};692		Type::builder()693			.path(Path::new("up_data_structs", "PhantomType"))694			.type_params(type_params!(T))695			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))696	}697}698impl<T> MaxEncodedLen for PhantomType<T> {699	fn max_encoded_len() -> usize {700		0701	}702}703704pub type BoundedBytes<S> = BoundedVec<u8, S>;705706pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;707708pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;709pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;710711#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]712#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]713pub struct PropertyPermission {714	pub mutable: bool,715	pub collection_admin: bool,716	pub token_owner: bool,717}718719impl PropertyPermission {720	pub fn none() -> Self {721		Self {722			mutable: true,723			collection_admin: false,724			token_owner: false,725		}726	}727}728729#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]730#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]731pub struct Property {732	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]733	pub key: PropertyKey,734735	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]736	pub value: PropertyValue,737}738739impl Into<(PropertyKey, PropertyValue)> for Property {740	fn into(self) -> (PropertyKey, PropertyValue) {741		(self.key, self.value)742	}743}744745#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]746#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]747pub struct PropertyKeyPermission {748	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]749	pub key: PropertyKey,750751	pub permission: PropertyPermission,752}753754impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {755	fn into(self) -> (PropertyKey, PropertyPermission) {756		(self.key, self.permission)757	}758}759760#[derive(Debug)]761pub enum PropertiesError {762	NoSpaceForProperty,763	PropertyLimitReached,764	InvalidCharacterInPropertyKey,765	PropertyKeyIsTooLong,766	EmptyPropertyKey,767}768769#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]770pub enum PropertyScope {771	None,772	Rmrk,773}774775impl PropertyScope {776	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {777		let scope_str: &[u8] = match self {778			Self::None => return Ok(key),779			Self::Rmrk => b"rmrk",780		};781782		[scope_str, b":", key.as_slice()]783			.concat()784			.try_into()785			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)786	}787}788789pub trait TrySetProperty: Sized {790	type Value;791792	fn try_scoped_set(793		&mut self,794		scope: PropertyScope,795		key: PropertyKey,796		value: Self::Value,797	) -> Result<(), PropertiesError>;798799	fn try_scoped_set_from_iter<I, KV>(800		&mut self,801		scope: PropertyScope,802		iter: I,803	) -> Result<(), PropertiesError>804	where805		I: Iterator<Item = KV>,806		KV: Into<(PropertyKey, Self::Value)>,807	{808		for kv in iter {809			let (key, value) = kv.into();810			self.try_scoped_set(scope, key, value)?;811		}812813		Ok(())814	}815816	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {817		self.try_scoped_set(PropertyScope::None, key, value)818	}819820	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>821	where822		I: Iterator<Item = KV>,823		KV: Into<(PropertyKey, Self::Value)>,824	{825		self.try_scoped_set_from_iter(PropertyScope::None, iter)826	}827}828829#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]830#[derivative(Default(bound = ""))]831pub struct PropertiesMap<Value>(832	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,833);834835impl<Value> PropertiesMap<Value> {836	pub fn new() -> Self {837		Self(BoundedBTreeMap::new())838	}839840	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {841		Self::check_property_key(key)?;842843		Ok(self.0.remove(key))844	}845846	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {847		self.0.get(key)848	}849850	pub fn contains_key(&self, key: &PropertyKey) -> bool {851		self.0.contains_key(key)852	}853854	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {855		if key.is_empty() {856			return Err(PropertiesError::EmptyPropertyKey);857		}858859		for byte in key.as_slice().iter() {860			let byte = *byte;861862			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {863				return Err(PropertiesError::InvalidCharacterInPropertyKey);864			}865		}866867		Ok(())868	}869}870871impl<Value> IntoIterator for PropertiesMap<Value> {872	type Item = (PropertyKey, Value);873	type IntoIter = <874		BoundedBTreeMap<875			PropertyKey,876			Value,877			ConstU32<MAX_PROPERTIES_PER_ITEM>878		> as IntoIterator879	>::IntoIter;880881	fn into_iter(self) -> Self::IntoIter {882		self.0.into_iter()883	}884}885886impl<Value> TrySetProperty for PropertiesMap<Value> {887	type Value = Value;888889	fn try_scoped_set(890		&mut self,891		scope: PropertyScope,892		key: PropertyKey,893		value: Self::Value,894	) -> Result<(), PropertiesError> {895		Self::check_property_key(&key)?;896897		let key = scope.apply(key)?;898		self.0899			.try_insert(key, value)900			.map_err(|_| PropertiesError::PropertyLimitReached)?;901902		Ok(())903	}904}905906pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;907908#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]909pub struct Properties {910	map: PropertiesMap<PropertyValue>,911	consumed_space: u32,912	space_limit: u32,913}914915impl Properties {916	pub fn new(space_limit: u32) -> Self {917		Self {918			map: PropertiesMap::new(),919			consumed_space: 0,920			space_limit,921		}922	}923924	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {925		let value = self.map.remove(key)?;926927		if let Some(ref value) = value {928			let value_len = value.len() as u32;929			self.consumed_space -= value_len;930		}931932		Ok(value)933	}934935	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {936		self.map.get(key)937	}938}939940impl IntoIterator for Properties {941	type Item = (PropertyKey, PropertyValue);942	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;943944	fn into_iter(self) -> Self::IntoIter {945		self.map.into_iter()946	}947}948949impl TrySetProperty for Properties {950	type Value = PropertyValue;951952	fn try_scoped_set(953		&mut self,954		scope: PropertyScope,955		key: PropertyKey,956		value: Self::Value,957	) -> Result<(), PropertiesError> {958		let value_len = value.len();959960		if self.consumed_space as usize + value_len > self.space_limit as usize961			&& !cfg!(feature = "runtime-benchmarks")962		{963			return Err(PropertiesError::NoSpaceForProperty);964		}965966		self.map.try_scoped_set(scope, key, value)?;967968		self.consumed_space += value_len as u32;969970		Ok(())971	}972}973974pub struct CollectionProperties;975976impl Get<Properties> for CollectionProperties {977	fn get() -> Properties {978		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)979	}980}981982pub struct TokenProperties;983984impl Get<Properties> for TokenProperties {985	fn get() -> Properties {986		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)987	}988}989990// RMRK991// todo document?992parameter_types! {993	#[derive(PartialEq, TypeInfo)]994	pub const RmrkStringLimit: u32 = 128;995	#[derive(PartialEq)]996	pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;997	#[derive(PartialEq)]998	pub const RmrkResourceSymbolLimit: u32 = 10;999	#[derive(PartialEq)]1000	pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1001	#[derive(PartialEq)]1002	pub const RmrkKeyLimit: u32 = 32;1003	#[derive(PartialEq)]1004	pub const RmrkValueLimit: u32 = 256;1005	#[derive(PartialEq)]1006	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1007	#[derive(PartialEq)]1008	pub const MaxPropertiesPerTheme: u32 = 5;1009	#[derive(PartialEq)]1010	pub const RmrkPartsLimit: u32 = 25;1011	#[derive(PartialEq)]1012	pub const RmrkMaxPriorities: u32 = 25;1013	#[derive(PartialEq)]1014	pub const MaxResourcesOnMint: u32 = 100;1015}10161017impl From<RmrkCollectionId> for CollectionId {1018	fn from(id: RmrkCollectionId) -> Self {1019		Self(id)1020	}1021}10221023impl From<RmrkNftId> for TokenId {1024	fn from(id: RmrkNftId) -> Self {1025		Self(id)1026	}1027}10281029pub type RmrkCollectionInfo<AccountId> =1030	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1031pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1032pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1033pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1034pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1035pub type BoundedEquippableCollectionIds =1036	BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1037pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1038pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1039pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1040pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1041pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1042pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;10431044pub type RmrkBasicResource = BasicResource<RmrkString>;1045pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1046pub type RmrkSlotResource = SlotResource<RmrkString>;10471048pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1049pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1050pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1051pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1052pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1053pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1054pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed10551056pub type RmrkRpcString = Vec<u8>;1057pub type RmrkThemeName = RmrkRpcString;1058pub type RmrkPropertyKey = RmrkRpcString;