`b1d3841dc4c5`

source

primitives/data-structs/src/lib.rs25.9 KiBsource history
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;3839pub mod rmrk;4041// RMRK42use rmrk::{43	CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme, ThemeProperty,44};45pub use rmrk::{46	primitives::{47		CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,48		PartId as RmrkPartId, ResourceId as RmrkResourceId,49	},50	NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,51	FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart, EquippableList as RmrkEquippableList,52	BasicResource as RmrkBasicResource, ComposableResource as RmrkComposableResource,53	SlotResource as RmrkSlotResource,54};5556mod bounded;57pub mod budget;58pub mod mapping;59mod migration;6061pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;62pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;63pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;6465pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {66	100_00067} else {68	1069};70pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {71	100_00072} else {73	1074};75pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {76	204877} else {78	1079};80pub const COLLECTION_ADMINS_LIMIT: u32 = 5;81pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;82pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {83	1_000_00084} else {85	1086};8788// Timeouts for item types in passed blocks89pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;90pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;91pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;9293pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;9495// Schema limits96pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;97pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;98pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;99100pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;101102pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;103pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;104pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;105106pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;107pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;108pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;109110pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;111pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;112113// RMRK constants114pub const RMRK_STRING_LIMIT: u32 = 128;115pub const RMRK_COLLECTION_SYMBOL_LIMIT: u32 = 100;116pub const RMRK_RESOURCE_SYMBOL_LIMIT: u32 = 10;117pub const RMRK_KEY_LIMIT: u32 = 32;118pub const RMRK_VALUE_LIMIT: u32 = 256;119120/// How much items can be created per single121/// create_many call122pub const MAX_ITEMS_PER_BATCH: u32 = 200;123124pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;125126#[derive(127	Encode,128	Decode,129	PartialEq,130	Eq,131	PartialOrd,132	Ord,133	Clone,134	Copy,135	Debug,136	Default,137	TypeInfo,138	MaxEncodedLen,139)]140#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]141pub struct CollectionId(pub u32);142impl EncodeLike<u32> for CollectionId {}143impl EncodeLike<CollectionId> for u32 {}144145#[derive(146	Encode,147	Decode,148	PartialEq,149	Eq,150	PartialOrd,151	Ord,152	Clone,153	Copy,154	Debug,155	Default,156	TypeInfo,157	MaxEncodedLen,158)]159#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]160pub struct TokenId(pub u32);161impl EncodeLike<u32> for TokenId {}162impl EncodeLike<TokenId> for u32 {}163164impl TokenId {165	pub fn try_next(self) -> Result<TokenId, ArithmeticError> {166		self.0167			.checked_add(1)168			.ok_or(ArithmeticError::Overflow)169			.map(Self)170	}171}172173impl From<TokenId> for U256 {174	fn from(t: TokenId) -> Self {175		t.0.into()176	}177}178179impl TryFrom<U256> for TokenId {180	type Error = &'static str;181182	fn try_from(value: U256) -> Result<Self, Self::Error> {183		Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))184	}185}186187#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]188#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]189pub struct TokenData<CrossAccountId> {190	pub properties: Vec<Property>,191	pub owner: Option<CrossAccountId>,192}193194pub struct OverflowError;195impl From<OverflowError> for &'static str {196	fn from(_: OverflowError) -> Self {197		"overflow occured"198	}199}200201pub type DecimalPoints = u8;202203#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]204#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]205pub enum CollectionMode {206	NFT,207	// decimal points208	Fungible(DecimalPoints),209	ReFungible,210}211212impl CollectionMode {213	pub fn id(&self) -> u8 {214		match self {215			CollectionMode::NFT => 1,216			CollectionMode::Fungible(_) => 2,217			CollectionMode::ReFungible => 3,218		}219	}220}221222pub trait SponsoringResolve<AccountId, Call> {223	fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;224}225226#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]227#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]228pub enum AccessMode {229	Normal,230	AllowList,231}232impl Default for AccessMode {233	fn default() -> Self {234		Self::Normal235	}236}237238#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]239#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]240pub enum SchemaVersion {241	ImageURL,242	Unique,243}244impl Default for SchemaVersion {245	fn default() -> Self {246		Self::ImageURL247	}248}249250#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]251#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]252pub struct Ownership<AccountId> {253	pub owner: AccountId,254	pub fraction: u128,255}256257#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]258#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]259pub enum SponsorshipState<AccountId> {260	/// The fees are applied to the transaction sender261	Disabled,262	Unconfirmed(AccountId),263	/// Transactions are sponsored by specified account264	Confirmed(AccountId),265}266267impl<AccountId> SponsorshipState<AccountId> {268	pub fn sponsor(&self) -> Option<&AccountId> {269		match self {270			Self::Confirmed(sponsor) => Some(sponsor),271			_ => None,272		}273	}274275	pub fn pending_sponsor(&self) -> Option<&AccountId> {276		match self {277			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),278			_ => None,279		}280	}281282	pub fn confirmed(&self) -> bool {283		matches!(self, Self::Confirmed(_))284	}285}286287impl<T> Default for SponsorshipState<T> {288	fn default() -> Self {289		Self::Disabled290	}291}292293/// Used in storage294#[struct_versioning::versioned(version = 2, upper)]295#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]296pub struct Collection<AccountId> {297	pub owner: AccountId,298	pub mode: CollectionMode,299	#[version(..2)]300	pub access: AccessMode,301	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,302	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,303	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,304305	#[version(..2)]306	pub mint_mode: bool,307308	#[version(..2)]309	pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,310311	#[version(..2)]312	pub schema_version: SchemaVersion,313	pub sponsorship: SponsorshipState<AccountId>,314315	pub limits: CollectionLimits,316317	#[version(2.., upper(Default::default()))]318	pub permissions: CollectionPermissions,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/// Used in RPC calls331#[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}345346#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]347#[derivative(Debug, Default(bound = ""))]348pub struct CreateCollectionData<AccountId> {349	#[derivative(Default(value = "CollectionMode::NFT"))]350	pub mode: CollectionMode,351	pub access: Option<AccessMode>,352	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,353	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,354	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,355	pub pending_sponsor: Option<AccountId>,356	pub limits: Option<CollectionLimits>,357	pub permissions: Option<CollectionPermissions>,358	pub token_property_permissions: CollectionPropertiesPermissionsVec,359	pub properties: CollectionPropertiesVec,360}361362pub type CollectionPropertiesPermissionsVec =363	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;364365pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;366367/// All fields are wrapped in `Option`s, where None means chain default368// When adding/removing fields from this struct - don't forget to also update clamp_limits369#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]370#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]371pub struct CollectionLimits {372	pub account_token_ownership_limit: Option<u32>,373	pub sponsored_data_size: Option<u32>,374375	/// FIXME should we delete this or repurpose it?376	/// None - setVariableMetadata is not sponsored377	/// Some(v) - setVariableMetadata is sponsored378	///           if there is v block between txs379	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,380	pub token_limit: Option<u32>,381382	// Timeouts for item types in passed blocks383	pub sponsor_transfer_timeout: Option<u32>,384	pub sponsor_approve_timeout: Option<u32>,385	pub owner_can_transfer: Option<bool>,386	pub owner_can_destroy: Option<bool>,387	pub transfers_enabled: Option<bool>,388}389390impl CollectionLimits {391	pub fn account_token_ownership_limit(&self) -> u32 {392		self.account_token_ownership_limit393			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)394			.min(MAX_TOKEN_OWNERSHIP)395	}396	pub fn sponsored_data_size(&self) -> u32 {397		self.sponsored_data_size398			.unwrap_or(CUSTOM_DATA_LIMIT)399			.min(CUSTOM_DATA_LIMIT)400	}401	pub fn token_limit(&self) -> u32 {402		self.token_limit403			.unwrap_or(COLLECTION_TOKEN_LIMIT)404			.min(COLLECTION_TOKEN_LIMIT)405	}406	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {407		self.sponsor_transfer_timeout408			.unwrap_or(default)409			.min(MAX_SPONSOR_TIMEOUT)410	}411	pub fn sponsor_approve_timeout(&self) -> u32 {412		self.sponsor_approve_timeout413			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)414			.min(MAX_SPONSOR_TIMEOUT)415	}416	pub fn owner_can_transfer(&self) -> bool {417		self.owner_can_transfer.unwrap_or(true)418	}419	pub fn owner_can_destroy(&self) -> bool {420		self.owner_can_destroy.unwrap_or(true)421	}422	pub fn transfers_enabled(&self) -> bool {423		self.transfers_enabled.unwrap_or(true)424	}425	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {426		match self427			.sponsored_data_rate_limit428			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)429		{430			SponsoringRateLimit::SponsoringDisabled => None,431			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),432		}433	}434}435436// When adding/removing fields from this struct - don't forget to also update clamp_limits437#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]438#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]439pub struct CollectionPermissions {440	pub access: Option<AccessMode>,441	pub mint_mode: Option<bool>,442	pub nesting: Option<NestingRule>,443}444445impl CollectionPermissions {446	pub fn access(&self) -> AccessMode {447		self.access.unwrap_or(AccessMode::Normal)448	}449	pub fn mint_mode(&self) -> bool {450		self.mint_mode.unwrap_or(false)451	}452	pub fn nesting(&self) -> &NestingRule {453		static DEFAULT: NestingRule = NestingRule::Disabled;454		self.nesting.as_ref().unwrap_or(&DEFAULT)455	}456}457458#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]459#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]460#[derivative(Debug)]461pub enum NestingRule {462	/// No one can nest tokens463	Disabled,464	/// Owner can nest any tokens465	Owner,466	/// Owner can nest tokens from specified collections467	OwnerRestricted(468		#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]469		#[derivative(Debug(format_with = "bounded::set_debug"))]470		BoundedBTreeSet<CollectionId, ConstU32<16>>,471	),472}473474#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]475#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]476pub enum SponsoringRateLimit {477	SponsoringDisabled,478	Blocks(u32),479}480481#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]482#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]483#[derivative(Debug)]484pub struct CreateNftData {485	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]486	#[derivative(Debug(format_with = "bounded::vec_debug"))]487	pub properties: CollectionPropertiesVec,488}489490#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]491#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]492pub struct CreateFungibleData {493	pub value: u128,494}495496#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]497#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]498#[derivative(Debug)]499pub struct CreateReFungibleData {500	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]501	#[derivative(Debug(format_with = "bounded::vec_debug"))]502	pub const_data: BoundedVec<u8, CustomDataLimit>,503	pub pieces: u128,504}505506#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]507#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]508pub enum MetaUpdatePermission {509	ItemOwner,510	Admin,511	None,512}513514#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]515#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]516pub enum CreateItemData {517	NFT(CreateNftData),518	Fungible(CreateFungibleData),519	ReFungible(CreateReFungibleData),520}521522#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]523#[derivative(Debug)]524pub struct CreateNftExData<CrossAccountId> {525	#[derivative(Debug(format_with = "bounded::vec_debug"))]526	pub properties: CollectionPropertiesVec,527	pub owner: CrossAccountId,528}529530#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]531#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]532pub struct CreateRefungibleExData<CrossAccountId> {533	#[derivative(Debug(format_with = "bounded::vec_debug"))]534	pub const_data: BoundedVec<u8, CustomDataLimit>,535	#[derivative(Debug(format_with = "bounded::map_debug"))]536	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,537}538539#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]540#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]541pub enum CreateItemExData<CrossAccountId> {542	NFT(543		#[derivative(Debug(format_with = "bounded::vec_debug"))]544		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,545	),546	Fungible(547		#[derivative(Debug(format_with = "bounded::map_debug"))]548		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,549	),550	/// Many tokens, each may have only one owner551	RefungibleMultipleItems(552		#[derivative(Debug(format_with = "bounded::vec_debug"))]553		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,554	),555	/// Single token, which may have many owners556	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),557}558559impl CreateItemData {560	pub fn data_size(&self) -> usize {561		match self {562			CreateItemData::ReFungible(data) => data.const_data.len(),563			_ => 0,564		}565	}566}567568impl From<CreateNftData> for CreateItemData {569	fn from(item: CreateNftData) -> Self {570		CreateItemData::NFT(item)571	}572}573574impl From<CreateReFungibleData> for CreateItemData {575	fn from(item: CreateReFungibleData) -> Self {576		CreateItemData::ReFungible(item)577	}578}579580impl From<CreateFungibleData> for CreateItemData {581	fn from(item: CreateFungibleData) -> Self {582		CreateItemData::Fungible(item)583	}584}585586#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]587#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]588pub struct CollectionStats {589	pub created: u32,590	pub destroyed: u32,591	pub alive: u32,592}593594#[derive(Encode, Decode, Clone, Debug)]595#[cfg_attr(feature = "std", derive(PartialEq))]596pub struct PhantomType<T>(core::marker::PhantomData<T>);597598impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {599	type Identity = PhantomType<T>;600601	fn type_info() -> scale_info::Type {602		use scale_info::{603			Type, Path,604			build::{FieldsBuilder, UnnamedFields},605			type_params,606		};607		Type::builder()608			.path(Path::new("up_data_structs", "PhantomType"))609			.type_params(type_params!(T))610			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))611	}612}613impl<T> MaxEncodedLen for PhantomType<T> {614	fn max_encoded_len() -> usize {615		0616	}617}618619pub type PropertyKey = BoundedVec<u8, ConstU32<MAX_PROPERTY_KEY_LENGTH>>;620pub type PropertyValue = BoundedVec<u8, ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;621622#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]623#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]624pub struct PropertyPermission {625	pub mutable: bool,626	pub collection_admin: bool,627	pub token_owner: bool,628}629630impl PropertyPermission {631	pub fn none() -> Self {632		Self {633			mutable: true,634			collection_admin: false,635			token_owner: false,636		}637	}638}639640#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]641#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]642pub struct Property {643	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]644	pub key: PropertyKey,645646	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]647	pub value: PropertyValue,648}649650impl Into<(PropertyKey, PropertyValue)> for Property {651	fn into(self) -> (PropertyKey, PropertyValue) {652		(self.key, self.value)653	}654}655656#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]657#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]658pub struct PropertyKeyPermission {659	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]660	pub key: PropertyKey,661662	pub permission: PropertyPermission,663}664665impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {666	fn into(self) -> (PropertyKey, PropertyPermission) {667		(self.key, self.permission)668	}669}670671#[derive(Debug)]672pub enum PropertiesError {673	NoSpaceForProperty,674	PropertyLimitReached,675	InvalidCharacterInPropertyKey,676	PropertyKeyIsTooLong,677	EmptyPropertyKey,678}679680#[derive(Clone, Copy)]681pub enum PropertyScope {682	None,683	Rmrk,684}685686impl PropertyScope {687	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {688		let scope_str: &[u8] = match self {689			Self::None => return Ok(key),690			Self::Rmrk => b"rmrk",691		};692693		[scope_str, b":", key.as_slice()]694			.concat()695			.try_into()696			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)697	}698}699700pub trait TrySetProperty: Sized {701	type Value;702703	fn try_scoped_set(704		&mut self,705		scope: PropertyScope,706		key: PropertyKey,707		value: Self::Value,708	) -> Result<(), PropertiesError>;709710	fn try_scoped_set_from_iter<I, KV>(711		&mut self,712		scope: PropertyScope,713		iter: I,714	) -> Result<(), PropertiesError>715	where716		I: Iterator<Item = KV>,717		KV: Into<(PropertyKey, Self::Value)>,718	{719		for kv in iter {720			let (key, value) = kv.into();721			self.try_scoped_set(scope, key, value)?;722		}723724		Ok(())725	}726727	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {728		self.try_scoped_set(PropertyScope::None, key, value)729	}730731	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>732	where733		I: Iterator<Item = KV>,734		KV: Into<(PropertyKey, Self::Value)>,735	{736		self.try_scoped_set_from_iter(PropertyScope::None, iter)737	}738}739740#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]741#[derivative(Default(bound = ""))]742pub struct PropertiesMap<Value>(743	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,744);745746impl<Value> PropertiesMap<Value> {747	pub fn new() -> Self {748		Self(BoundedBTreeMap::new())749	}750751	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {752		Self::check_property_key(key)?;753754		Ok(self.0.remove(key))755	}756757	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {758		self.0.get(key)759	}760761	pub fn contains_key(&self, key: &PropertyKey) -> bool {762		self.0.contains_key(key)763	}764765	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {766		if key.is_empty() {767			return Err(PropertiesError::EmptyPropertyKey);768		}769770		for byte in key.as_slice().iter() {771			let byte = *byte;772773			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' {774				return Err(PropertiesError::InvalidCharacterInPropertyKey);775			}776		}777778		Ok(())779	}780}781782impl<Value> IntoIterator for PropertiesMap<Value> {783	type Item = (PropertyKey, Value);784	type IntoIter = <785		BoundedBTreeMap<786			PropertyKey,787			Value,788			ConstU32<MAX_PROPERTIES_PER_ITEM>789		> as IntoIterator790	>::IntoIter;791792	fn into_iter(self) -> Self::IntoIter {793		self.0.into_iter()794	}795}796797impl<Value> TrySetProperty for PropertiesMap<Value> {798	type Value = Value;799800	fn try_scoped_set(801		&mut self,802		scope: PropertyScope,803		key: PropertyKey,804		value: Self::Value,805	) -> Result<(), PropertiesError> {806		Self::check_property_key(&key)?;807808		let key = scope.apply(key)?;809		self.0810			.try_insert(key, value)811			.map_err(|_| PropertiesError::PropertyLimitReached)?;812813		Ok(())814	}815}816817pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;818819#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]820pub struct Properties {821	map: PropertiesMap<PropertyValue>,822	consumed_space: u32,823	space_limit: u32,824}825826impl Properties {827	pub fn new(space_limit: u32) -> Self {828		Self {829			map: PropertiesMap::new(),830			consumed_space: 0,831			space_limit,832		}833	}834835	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {836		let value = self.map.remove(key)?;837838		if let Some(ref value) = value {839			let value_len = value.len() as u32;840			self.consumed_space -= value_len;841		}842843		Ok(value)844	}845846	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {847		self.map.get(key)848	}849}850851impl IntoIterator for Properties {852	type Item = (PropertyKey, PropertyValue);853	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;854855	fn into_iter(self) -> Self::IntoIter {856		self.map.into_iter()857	}858}859860impl TrySetProperty for Properties {861	type Value = PropertyValue;862863	fn try_scoped_set(864		&mut self,865		scope: PropertyScope,866		key: PropertyKey,867		value: Self::Value,868	) -> Result<(), PropertiesError> {869		let value_len = value.len();870871		if self.consumed_space as usize + value_len > self.space_limit as usize872			&& !cfg!(feature = "runtime-benchmarks")873		{874			return Err(PropertiesError::NoSpaceForProperty);875		}876877		self.map.try_scoped_set(scope, key, value)?;878879		self.consumed_space += value_len as u32;880881		Ok(())882	}883}884885pub struct CollectionProperties;886887impl Get<Properties> for CollectionProperties {888	fn get() -> Properties {889		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)890	}891}892893pub struct TokenProperties;894895impl Get<Properties> for TokenProperties {896	fn get() -> Properties {897		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)898	}899}900901// RMRK902// todo document?903parameter_types! {904	#[derive(PartialEq, TypeInfo)]905	pub const RmrkStringLimit: u32 = 128;906	#[derive(PartialEq)]907	pub const RmrkCollectionSymbolLimit: u32 = 100;908	#[derive(PartialEq)]909	pub const RmrkResourceSymbolLimit: u32 = 10;910	#[derive(PartialEq)]911	pub const RmrkKeyLimit: u32 = 32;912	#[derive(PartialEq)]913	pub const RmrkValueLimit: u32 = 256;914	#[derive(PartialEq)]915	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;916	#[derive(PartialEq)]917	pub const RmrkPartsLimit: u32 = 3;918}919920impl From<RmrkCollectionId> for CollectionId {921	fn from(id: RmrkCollectionId) -> Self {922		Self(id)923	}924}925926impl From<RmrkNftId> for TokenId {927	fn from(id: RmrkNftId) -> Self {928		Self(id)929	}930}931932pub type RmrkCollectionInfo<AccountId> =933	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;934pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;935pub type RmrkResourceInfo = ResourceInfo<RmrkBoundedResource, RmrkString, RmrkBoundedParts>;936pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;937pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;938pub type RmrkPartType =939	PartType<RmrkString, BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>>;940pub type RmrkThemeProperty = ThemeProperty<RmrkString>;941pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;942943pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;944pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;945pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;946947type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;948type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>;949950pub type RmrkRpcString = Vec<u8>;951pub type RmrkThemeName = RmrkRpcString;952pub type RmrkPropertyKey = RmrkRpcString;953954pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;