git.delta.rocks / unique-network / refs/commits / 2999bc8acc0d

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,43};44pub use rmrk_traits::{45	primitives::{46		CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,47		PartId as RmrkPartId, ResourceId as RmrkResourceId,48	},49	NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,50	FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart, EquippableList as RmrkEquippableList,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_COLLECTION_PROPERTIES_SIZE: u32 = 40960;108pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;109110// RMRK constants111pub const RMRK_STRING_LIMIT: u32 = 128;112pub const RMRK_COLLECTION_SYMBOL_LIMIT: u32 = 100;113pub const RMRK_RESOURCE_SYMBOL_LIMIT: u32 = 10;114pub const RMRK_KEY_LIMIT: u32 = 32;115pub const RMRK_VALUE_LIMIT: u32 = 256;116117/// How much items can be created per single118/// create_many call119pub const MAX_ITEMS_PER_BATCH: u32 = 200;120121pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;122123#[derive(124	Encode,125	Decode,126	PartialEq,127	Eq,128	PartialOrd,129	Ord,130	Clone,131	Copy,132	Debug,133	Default,134	TypeInfo,135	MaxEncodedLen,136)]137#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]138pub struct CollectionId(pub u32);139impl EncodeLike<u32> for CollectionId {}140impl EncodeLike<CollectionId> for u32 {}141142#[derive(143	Encode,144	Decode,145	PartialEq,146	Eq,147	PartialOrd,148	Ord,149	Clone,150	Copy,151	Debug,152	Default,153	TypeInfo,154	MaxEncodedLen,155)]156#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]157pub struct TokenId(pub u32);158impl EncodeLike<u32> for TokenId {}159impl EncodeLike<TokenId> for u32 {}160161impl TokenId {162	pub fn try_next(self) -> Result<TokenId, ArithmeticError> {163		self.0164			.checked_add(1)165			.ok_or(ArithmeticError::Overflow)166			.map(Self)167	}168}169170impl From<TokenId> for U256 {171	fn from(t: TokenId) -> Self {172		t.0.into()173	}174}175176impl TryFrom<U256> for TokenId {177	type Error = &'static str;178179	fn try_from(value: U256) -> Result<Self, Self::Error> {180		Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))181	}182}183184#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]185#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]186pub struct TokenData<CrossAccountId> {187	pub properties: Vec<Property>,188	pub owner: Option<CrossAccountId>,189}190191pub struct OverflowError;192impl From<OverflowError> for &'static str {193	fn from(_: OverflowError) -> Self {194		"overflow occured"195	}196}197198pub type DecimalPoints = u8;199200#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]201#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]202pub enum CollectionMode {203	NFT,204	// decimal points205	Fungible(DecimalPoints),206	ReFungible,207}208209impl CollectionMode {210	pub fn id(&self) -> u8 {211		match self {212			CollectionMode::NFT => 1,213			CollectionMode::Fungible(_) => 2,214			CollectionMode::ReFungible => 3,215		}216	}217}218219pub trait SponsoringResolve<AccountId, Call> {220	fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;221}222223#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]224#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]225pub enum AccessMode {226	Normal,227	AllowList,228}229impl Default for AccessMode {230	fn default() -> Self {231		Self::Normal232	}233}234235#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]236#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]237pub enum SchemaVersion {238	ImageURL,239	Unique,240}241impl Default for SchemaVersion {242	fn default() -> Self {243		Self::ImageURL244	}245}246247#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]248#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]249pub struct Ownership<AccountId> {250	pub owner: AccountId,251	pub fraction: u128,252}253254#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]255#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]256pub enum SponsorshipState<AccountId> {257	/// The fees are applied to the transaction sender258	Disabled,259	Unconfirmed(AccountId),260	/// Transactions are sponsored by specified account261	Confirmed(AccountId),262}263264impl<AccountId> SponsorshipState<AccountId> {265	pub fn sponsor(&self) -> Option<&AccountId> {266		match self {267			Self::Confirmed(sponsor) => Some(sponsor),268			_ => None,269		}270	}271272	pub fn pending_sponsor(&self) -> Option<&AccountId> {273		match self {274			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),275			_ => None,276		}277	}278279	pub fn confirmed(&self) -> bool {280		matches!(self, Self::Confirmed(_))281	}282}283284impl<T> Default for SponsorshipState<T> {285	fn default() -> Self {286		Self::Disabled287	}288}289290/// Used in storage291#[struct_versioning::versioned(version = 2, upper)]292#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]293pub struct Collection<AccountId> {294	pub owner: AccountId,295	pub mode: CollectionMode,296	#[version(..2)]297	pub access: AccessMode,298	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,299	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,300	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,301302	#[version(..2)]303	pub mint_mode: bool,304305	#[version(..2)]306	pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,307308	#[version(..2)]309	pub schema_version: SchemaVersion,310	pub sponsorship: SponsorshipState<AccountId>,311312	pub limits: CollectionLimits,313314	#[version(2.., upper(Default::default()))]315	pub permissions: CollectionPermissions,316317	/// Marks that this collection is not "unique", and managed from external.318	#[version(2.., upper(false))]319	pub external_collection: bool,320321	#[version(..2)]322	pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,323324	#[version(..2)]325	pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,326327	#[version(..2)]328	pub meta_update_permission: MetaUpdatePermission,329}330331/// Used in RPC calls332#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]333#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]334pub struct RpcCollection<AccountId> {335	pub owner: AccountId,336	pub mode: CollectionMode,337	pub name: Vec<u16>,338	pub description: Vec<u16>,339	pub token_prefix: Vec<u8>,340	pub sponsorship: SponsorshipState<AccountId>,341	pub limits: CollectionLimits,342	pub permissions: CollectionPermissions,343	pub token_property_permissions: Vec<PropertyKeyPermission>,344	pub properties: Vec<Property>,345	pub read_only: bool,346}347348#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]349#[derivative(Debug, Default(bound = ""))]350pub struct CreateCollectionData<AccountId> {351	#[derivative(Default(value = "CollectionMode::NFT"))]352	pub mode: CollectionMode,353	pub access: Option<AccessMode>,354	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,355	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,356	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,357	pub pending_sponsor: Option<AccountId>,358	pub limits: Option<CollectionLimits>,359	pub permissions: Option<CollectionPermissions>,360	pub token_property_permissions: CollectionPropertiesPermissionsVec,361	pub properties: CollectionPropertiesVec,362}363364pub type CollectionPropertiesPermissionsVec =365	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;366367pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;368369/// All fields are wrapped in `Option`s, where None means chain default370// When adding/removing fields from this struct - don't forget to also update clamp_limits371#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]372#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]373pub struct CollectionLimits {374	pub account_token_ownership_limit: Option<u32>,375	pub sponsored_data_size: Option<u32>,376377	/// FIXME should we delete this or repurpose it?378	/// None - setVariableMetadata is not sponsored379	/// Some(v) - setVariableMetadata is sponsored380	///           if there is v block between txs381	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,382	pub token_limit: Option<u32>,383384	// Timeouts for item types in passed blocks385	pub sponsor_transfer_timeout: Option<u32>,386	pub sponsor_approve_timeout: Option<u32>,387	pub owner_can_transfer: Option<bool>,388	pub owner_can_destroy: Option<bool>,389	pub transfers_enabled: Option<bool>,390}391392impl CollectionLimits {393	pub fn account_token_ownership_limit(&self) -> u32 {394		self.account_token_ownership_limit395			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)396			.min(MAX_TOKEN_OWNERSHIP)397	}398	pub fn sponsored_data_size(&self) -> u32 {399		self.sponsored_data_size400			.unwrap_or(CUSTOM_DATA_LIMIT)401			.min(CUSTOM_DATA_LIMIT)402	}403	pub fn token_limit(&self) -> u32 {404		self.token_limit405			.unwrap_or(COLLECTION_TOKEN_LIMIT)406			.min(COLLECTION_TOKEN_LIMIT)407	}408	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {409		self.sponsor_transfer_timeout410			.unwrap_or(default)411			.min(MAX_SPONSOR_TIMEOUT)412	}413	pub fn sponsor_approve_timeout(&self) -> u32 {414		self.sponsor_approve_timeout415			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)416			.min(MAX_SPONSOR_TIMEOUT)417	}418	pub fn owner_can_transfer(&self) -> bool {419		self.owner_can_transfer.unwrap_or(true)420	}421	pub fn owner_can_destroy(&self) -> bool {422		self.owner_can_destroy.unwrap_or(true)423	}424	pub fn transfers_enabled(&self) -> bool {425		self.transfers_enabled.unwrap_or(true)426	}427	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {428		match self429			.sponsored_data_rate_limit430			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)431		{432			SponsoringRateLimit::SponsoringDisabled => None,433			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),434		}435	}436}437438// When adding/removing fields from this struct - don't forget to also update clamp_limits439#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]440#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]441pub struct CollectionPermissions {442	pub access: Option<AccessMode>,443	pub mint_mode: Option<bool>,444	pub nesting: Option<NestingRule>,445}446447impl CollectionPermissions {448	pub fn access(&self) -> AccessMode {449		self.access.unwrap_or(AccessMode::Normal)450	}451	pub fn mint_mode(&self) -> bool {452		self.mint_mode.unwrap_or(false)453	}454	pub fn nesting(&self) -> &NestingRule {455		static DEFAULT: NestingRule = NestingRule::Disabled;456		self.nesting.as_ref().unwrap_or(&DEFAULT)457	}458}459460pub type OwnerRestrictedSet = BoundedBTreeSet<CollectionId, ConstU32<16>>;461462#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]463#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]464#[derivative(Debug)]465pub enum NestingRule {466	/// No one can nest tokens467	Disabled,468	/// Owner can nest any tokens469	Owner,470	/// Owner can nest tokens from specified collections471	OwnerRestricted(472		#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]473		#[derivative(Debug(format_with = "bounded::set_debug"))]474		OwnerRestrictedSet,475	),476	/// Used for tests477	Permissive,478}479480#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]481#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]482pub enum SponsoringRateLimit {483	SponsoringDisabled,484	Blocks(u32),485}486487#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]488#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]489#[derivative(Debug)]490pub struct CreateNftData {491	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]492	#[derivative(Debug(format_with = "bounded::vec_debug"))]493	pub properties: CollectionPropertiesVec,494}495496#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]497#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]498pub struct CreateFungibleData {499	pub value: u128,500}501502#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]503#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]504#[derivative(Debug)]505pub struct CreateReFungibleData {506	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]507	#[derivative(Debug(format_with = "bounded::vec_debug"))]508	pub const_data: BoundedVec<u8, CustomDataLimit>,509	pub pieces: u128,510}511512#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]513#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]514pub enum MetaUpdatePermission {515	ItemOwner,516	Admin,517	None,518}519520#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]521#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]522pub enum CreateItemData {523	NFT(CreateNftData),524	Fungible(CreateFungibleData),525	ReFungible(CreateReFungibleData),526}527528#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]529#[derivative(Debug)]530pub struct CreateNftExData<CrossAccountId> {531	#[derivative(Debug(format_with = "bounded::vec_debug"))]532	pub properties: CollectionPropertiesVec,533	pub owner: CrossAccountId,534}535536#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]537#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]538pub struct CreateRefungibleExData<CrossAccountId> {539	#[derivative(Debug(format_with = "bounded::vec_debug"))]540	pub const_data: BoundedVec<u8, CustomDataLimit>,541	#[derivative(Debug(format_with = "bounded::map_debug"))]542	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,543}544545#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]546#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]547pub enum CreateItemExData<CrossAccountId> {548	NFT(549		#[derivative(Debug(format_with = "bounded::vec_debug"))]550		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,551	),552	Fungible(553		#[derivative(Debug(format_with = "bounded::map_debug"))]554		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,555	),556	/// Many tokens, each may have only one owner557	RefungibleMultipleItems(558		#[derivative(Debug(format_with = "bounded::vec_debug"))]559		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,560	),561	/// Single token, which may have many owners562	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),563}564565impl CreateItemData {566	pub fn data_size(&self) -> usize {567		match self {568			CreateItemData::ReFungible(data) => data.const_data.len(),569			_ => 0,570		}571	}572}573574impl From<CreateNftData> for CreateItemData {575	fn from(item: CreateNftData) -> Self {576		CreateItemData::NFT(item)577	}578}579580impl From<CreateReFungibleData> for CreateItemData {581	fn from(item: CreateReFungibleData) -> Self {582		CreateItemData::ReFungible(item)583	}584}585586impl From<CreateFungibleData> for CreateItemData {587	fn from(item: CreateFungibleData) -> Self {588		CreateItemData::Fungible(item)589	}590}591592#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]593#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]594// todo possibly rename to be used generally as an address pair595pub struct TokenChild {596	pub token: TokenId,597	pub collection: CollectionId,598}599600#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]601#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]602pub struct CollectionStats {603	pub created: u32,604	pub destroyed: u32,605	pub alive: u32,606}607608#[derive(Encode, Decode, Clone, Debug)]609#[cfg_attr(feature = "std", derive(PartialEq))]610pub struct PhantomType<T>(core::marker::PhantomData<T>);611612impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {613	type Identity = PhantomType<T>;614615	fn type_info() -> scale_info::Type {616		use scale_info::{617			Type, Path,618			build::{FieldsBuilder, UnnamedFields},619			type_params,620		};621		Type::builder()622			.path(Path::new("up_data_structs", "PhantomType"))623			.type_params(type_params!(T))624			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))625	}626}627impl<T> MaxEncodedLen for PhantomType<T> {628	fn max_encoded_len() -> usize {629		0630	}631}632633pub type PropertyKey = BoundedVec<u8, ConstU32<MAX_PROPERTY_KEY_LENGTH>>;634pub type PropertyValue = BoundedVec<u8, ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;635636#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]637#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]638pub struct PropertyPermission {639	pub mutable: bool,640	pub collection_admin: bool,641	pub token_owner: bool,642}643644impl PropertyPermission {645	pub fn none() -> Self {646		Self {647			mutable: true,648			collection_admin: false,649			token_owner: false,650		}651	}652}653654#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]655#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]656pub struct Property {657	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]658	pub key: PropertyKey,659660	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]661	pub value: PropertyValue,662}663664impl Into<(PropertyKey, PropertyValue)> for Property {665	fn into(self) -> (PropertyKey, PropertyValue) {666		(self.key, self.value)667	}668}669670#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]671#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]672pub struct PropertyKeyPermission {673	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]674	pub key: PropertyKey,675676	pub permission: PropertyPermission,677}678679impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {680	fn into(self) -> (PropertyKey, PropertyPermission) {681		(self.key, self.permission)682	}683}684685#[derive(Debug)]686pub enum PropertiesError {687	NoSpaceForProperty,688	PropertyLimitReached,689	InvalidCharacterInPropertyKey,690	PropertyKeyIsTooLong,691	EmptyPropertyKey,692}693694#[derive(Clone, Copy)]695pub enum PropertyScope {696	None,697	Rmrk,698}699700impl PropertyScope {701	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {702		let scope_str: &[u8] = match self {703			Self::None => return Ok(key),704			Self::Rmrk => b"rmrk",705		};706707		[scope_str, b":", key.as_slice()]708			.concat()709			.try_into()710			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)711	}712}713714pub trait TrySetProperty: Sized {715	type Value;716717	fn try_scoped_set(718		&mut self,719		scope: PropertyScope,720		key: PropertyKey,721		value: Self::Value,722	) -> Result<(), PropertiesError>;723724	fn try_scoped_set_from_iter<I, KV>(725		&mut self,726		scope: PropertyScope,727		iter: I,728	) -> Result<(), PropertiesError>729	where730		I: Iterator<Item = KV>,731		KV: Into<(PropertyKey, Self::Value)>,732	{733		for kv in iter {734			let (key, value) = kv.into();735			self.try_scoped_set(scope, key, value)?;736		}737738		Ok(())739	}740741	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {742		self.try_scoped_set(PropertyScope::None, key, value)743	}744745	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>746	where747		I: Iterator<Item = KV>,748		KV: Into<(PropertyKey, Self::Value)>,749	{750		self.try_scoped_set_from_iter(PropertyScope::None, iter)751	}752}753754#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]755#[derivative(Default(bound = ""))]756pub struct PropertiesMap<Value>(757	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,758);759760impl<Value> PropertiesMap<Value> {761	pub fn new() -> Self {762		Self(BoundedBTreeMap::new())763	}764765	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {766		Self::check_property_key(key)?;767768		Ok(self.0.remove(key))769	}770771	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {772		self.0.get(key)773	}774775	pub fn contains_key(&self, key: &PropertyKey) -> bool {776		self.0.contains_key(key)777	}778779	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {780		if key.is_empty() {781			return Err(PropertiesError::EmptyPropertyKey);782		}783784		for byte in key.as_slice().iter() {785			let byte = *byte;786787			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' {788				return Err(PropertiesError::InvalidCharacterInPropertyKey);789			}790		}791792		Ok(())793	}794}795796impl<Value> IntoIterator for PropertiesMap<Value> {797	type Item = (PropertyKey, Value);798	type IntoIter = <799		BoundedBTreeMap<800			PropertyKey,801			Value,802			ConstU32<MAX_PROPERTIES_PER_ITEM>803		> as IntoIterator804	>::IntoIter;805806	fn into_iter(self) -> Self::IntoIter {807		self.0.into_iter()808	}809}810811impl<Value> TrySetProperty for PropertiesMap<Value> {812	type Value = Value;813814	fn try_scoped_set(815		&mut self,816		scope: PropertyScope,817		key: PropertyKey,818		value: Self::Value,819	) -> Result<(), PropertiesError> {820		Self::check_property_key(&key)?;821822		let key = scope.apply(key)?;823		self.0824			.try_insert(key, value)825			.map_err(|_| PropertiesError::PropertyLimitReached)?;826827		Ok(())828	}829}830831pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;832833#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]834pub struct Properties {835	map: PropertiesMap<PropertyValue>,836	consumed_space: u32,837	space_limit: u32,838}839840impl Properties {841	pub fn new(space_limit: u32) -> Self {842		Self {843			map: PropertiesMap::new(),844			consumed_space: 0,845			space_limit,846		}847	}848849	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {850		let value = self.map.remove(key)?;851852		if let Some(ref value) = value {853			let value_len = value.len() as u32;854			self.consumed_space -= value_len;855		}856857		Ok(value)858	}859860	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {861		self.map.get(key)862	}863}864865impl IntoIterator for Properties {866	type Item = (PropertyKey, PropertyValue);867	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;868869	fn into_iter(self) -> Self::IntoIter {870		self.map.into_iter()871	}872}873874impl TrySetProperty for Properties {875	type Value = PropertyValue;876877	fn try_scoped_set(878		&mut self,879		scope: PropertyScope,880		key: PropertyKey,881		value: Self::Value,882	) -> Result<(), PropertiesError> {883		let value_len = value.len();884885		if self.consumed_space as usize + value_len > self.space_limit as usize886			&& !cfg!(feature = "runtime-benchmarks")887		{888			return Err(PropertiesError::NoSpaceForProperty);889		}890891		self.map.try_scoped_set(scope, key, value)?;892893		self.consumed_space += value_len as u32;894895		Ok(())896	}897}898899pub struct CollectionProperties;900901impl Get<Properties> for CollectionProperties {902	fn get() -> Properties {903		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)904	}905}906907pub struct TokenProperties;908909impl Get<Properties> for TokenProperties {910	fn get() -> Properties {911		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)912	}913}914915// RMRK916// todo document?917parameter_types! {918	#[derive(PartialEq, TypeInfo)]919	pub const RmrkStringLimit: u32 = 128;920	#[derive(PartialEq)]921	pub const RmrkCollectionSymbolLimit: u32 = 100;922	#[derive(PartialEq)]923	pub const RmrkResourceSymbolLimit: u32 = 10;924	#[derive(PartialEq)]925	pub const RmrkKeyLimit: u32 = 32;926	#[derive(PartialEq)]927	pub const RmrkValueLimit: u32 = 256;928	#[derive(PartialEq)]929	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;930	#[derive(PartialEq)]931	pub const RmrkPartsLimit: u32 = 3;932	#[derive(PartialEq)]933	pub const RmrkMaxPriorities: u32 = 3;934}935936impl From<RmrkCollectionId> for CollectionId {937	fn from(id: RmrkCollectionId) -> Self {938		Self(id)939	}940}941942impl From<RmrkNftId> for TokenId {943	fn from(id: RmrkNftId) -> Self {944		Self(id)945	}946}947948pub type RmrkCollectionInfo<AccountId> =949	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;950pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;951pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;952pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;953pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;954pub type RmrkPartType =955	PartType<RmrkString, BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>>;956pub type RmrkThemeProperty = ThemeProperty<RmrkString>;957pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;958pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;959960pub type RmrkBasicResource = BasicResource<RmrkString>;961pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;962pub type RmrkSlotResource = SlotResource<RmrkString>;963964pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;965pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;966pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;967pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;968pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;969pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed970971pub type RmrkRpcString = Vec<u8>;972pub type RmrkThemeName = RmrkRpcString;973pub type RmrkPropertyKey = RmrkRpcString;