git.delta.rocks / unique-network / refs/commits / 7cf62e7cc906

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, SlotResource as RmrkSlotResource,53};5455mod bounded;56pub mod budget;57pub mod mapping;58mod migration;5960pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;61pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;62pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;6364pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {65	100_00066} else {67	1068};69pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {70	100_00071} else {72	1073};74pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {75	204876} else {77	1078};79pub const COLLECTION_ADMINS_LIMIT: u32 = 5;80pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;81pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {82	1_000_00083} else {84	1085};8687// Timeouts for item types in passed blocks88pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;89pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;90pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;9192pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;9394// Schema limits95pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;96pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;97pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;9899pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;100101pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;102pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;103pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;104105pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;106pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;107pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;108109pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;110pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;111112// RMRK constants113pub const RMRK_STRING_LIMIT: u32 = 128;114pub const RMRK_COLLECTION_SYMBOL_LIMIT: u32 = 100;115pub const RMRK_RESOURCE_SYMBOL_LIMIT: u32 = 10;116pub const RMRK_KEY_LIMIT: u32 = 32;117pub const RMRK_VALUE_LIMIT: u32 = 256;118119/// How much items can be created per single120/// create_many call121pub const MAX_ITEMS_PER_BATCH: u32 = 200;122123pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;124125#[derive(126	Encode,127	Decode,128	PartialEq,129	Eq,130	PartialOrd,131	Ord,132	Clone,133	Copy,134	Debug,135	Default,136	TypeInfo,137	MaxEncodedLen,138)]139#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]140pub struct CollectionId(pub u32);141impl EncodeLike<u32> for CollectionId {}142impl EncodeLike<CollectionId> for u32 {}143144#[derive(145	Encode,146	Decode,147	PartialEq,148	Eq,149	PartialOrd,150	Ord,151	Clone,152	Copy,153	Debug,154	Default,155	TypeInfo,156	MaxEncodedLen,157)]158#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]159pub struct TokenId(pub u32);160impl EncodeLike<u32> for TokenId {}161impl EncodeLike<TokenId> for u32 {}162163impl TokenId {164	pub fn try_next(self) -> Result<TokenId, ArithmeticError> {165		self.0166			.checked_add(1)167			.ok_or(ArithmeticError::Overflow)168			.map(Self)169	}170}171172impl From<TokenId> for U256 {173	fn from(t: TokenId) -> Self {174		t.0.into()175	}176}177178impl TryFrom<U256> for TokenId {179	type Error = &'static str;180181	fn try_from(value: U256) -> Result<Self, Self::Error> {182		Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))183	}184}185186#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]187#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]188pub struct TokenData<CrossAccountId> {189	pub properties: Vec<Property>,190	pub owner: Option<CrossAccountId>,191}192193pub struct OverflowError;194impl From<OverflowError> for &'static str {195	fn from(_: OverflowError) -> Self {196		"overflow occured"197	}198}199200pub type DecimalPoints = u8;201202#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]203#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]204pub enum CollectionMode {205	NFT,206	// decimal points207	Fungible(DecimalPoints),208	ReFungible,209}210211impl CollectionMode {212	pub fn id(&self) -> u8 {213		match self {214			CollectionMode::NFT => 1,215			CollectionMode::Fungible(_) => 2,216			CollectionMode::ReFungible => 3,217		}218	}219}220221pub trait SponsoringResolve<AccountId, Call> {222	fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;223}224225#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]226#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]227pub enum AccessMode {228	Normal,229	AllowList,230}231impl Default for AccessMode {232	fn default() -> Self {233		Self::Normal234	}235}236237#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]238#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]239pub enum SchemaVersion {240	ImageURL,241	Unique,242}243impl Default for SchemaVersion {244	fn default() -> Self {245		Self::ImageURL246	}247}248249#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]250#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]251pub struct Ownership<AccountId> {252	pub owner: AccountId,253	pub fraction: u128,254}255256#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]257#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]258pub enum SponsorshipState<AccountId> {259	/// The fees are applied to the transaction sender260	Disabled,261	Unconfirmed(AccountId),262	/// Transactions are sponsored by specified account263	Confirmed(AccountId),264}265266impl<AccountId> SponsorshipState<AccountId> {267	pub fn sponsor(&self) -> Option<&AccountId> {268		match self {269			Self::Confirmed(sponsor) => Some(sponsor),270			_ => None,271		}272	}273274	pub fn pending_sponsor(&self) -> Option<&AccountId> {275		match self {276			Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),277			_ => None,278		}279	}280281	pub fn confirmed(&self) -> bool {282		matches!(self, Self::Confirmed(_))283	}284}285286impl<T> Default for SponsorshipState<T> {287	fn default() -> Self {288		Self::Disabled289	}290}291292/// Used in storage293#[struct_versioning::versioned(version = 2, upper)]294#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]295pub struct Collection<AccountId> {296	pub owner: AccountId,297	pub mode: CollectionMode,298	#[version(..2)]299	pub access: AccessMode,300	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,301	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,302	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,303304	#[version(..2)]305	pub mint_mode: bool,306307	#[version(..2)]308	pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,309310	#[version(..2)]311	pub schema_version: SchemaVersion,312	pub sponsorship: SponsorshipState<AccountId>,313314	pub limits: CollectionLimits,315316	#[version(2.., upper(Default::default()))]317	pub permissions: CollectionPermissions,318319	#[version(..2)]320	pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,321322	#[version(..2)]323	pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,324325	#[version(..2)]326	pub meta_update_permission: MetaUpdatePermission,327}328329/// Used in RPC calls330#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]331#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]332pub struct RpcCollection<AccountId> {333	pub owner: AccountId,334	pub mode: CollectionMode,335	pub name: Vec<u16>,336	pub description: Vec<u16>,337	pub token_prefix: Vec<u8>,338	pub sponsorship: SponsorshipState<AccountId>,339	pub limits: CollectionLimits,340	pub permissions: CollectionPermissions,341	pub token_property_permissions: Vec<PropertyKeyPermission>,342	pub properties: Vec<Property>,343}344345#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]346#[derivative(Debug, Default(bound = ""))]347pub struct CreateCollectionData<AccountId> {348	#[derivative(Default(value = "CollectionMode::NFT"))]349	pub mode: CollectionMode,350	pub access: Option<AccessMode>,351	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,352	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,353	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,354	pub pending_sponsor: Option<AccountId>,355	pub limits: Option<CollectionLimits>,356	pub permissions: Option<CollectionPermissions>,357	pub token_property_permissions: CollectionPropertiesPermissionsVec,358	pub properties: CollectionPropertiesVec,359}360361pub type CollectionPropertiesPermissionsVec =362	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;363364pub type CollectionPropertiesVec =365	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 const_data: BoundedVec<u8, CustomDataLimit>,488489	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]490	#[derivative(Debug(format_with = "bounded::vec_debug"))]491	pub properties: CollectionPropertiesVec,492}493494#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]495#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]496pub struct CreateFungibleData {497	pub value: u128,498}499500#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]501#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]502#[derivative(Debug)]503pub struct CreateReFungibleData {504	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]505	#[derivative(Debug(format_with = "bounded::vec_debug"))]506	pub const_data: BoundedVec<u8, CustomDataLimit>,507	pub pieces: u128,508}509510#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]511#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]512pub enum MetaUpdatePermission {513	ItemOwner,514	Admin,515	None,516}517518#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]519#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]520pub enum CreateItemData {521	NFT(CreateNftData),522	Fungible(CreateFungibleData),523	ReFungible(CreateReFungibleData),524}525526#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]527#[derivative(Debug)]528pub struct CreateNftExData<CrossAccountId> {529	#[derivative(Debug(format_with = "bounded::vec_debug"))]530	pub properties: CollectionPropertiesVec,531	pub owner: CrossAccountId,532}533534#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]535#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]536pub struct CreateRefungibleExData<CrossAccountId> {537	#[derivative(Debug(format_with = "bounded::vec_debug"))]538	pub const_data: BoundedVec<u8, CustomDataLimit>,539	#[derivative(Debug(format_with = "bounded::map_debug"))]540	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,541}542543#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]544#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]545pub enum CreateItemExData<CrossAccountId> {546	NFT(547		#[derivative(Debug(format_with = "bounded::vec_debug"))]548		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,549	),550	Fungible(551		#[derivative(Debug(format_with = "bounded::map_debug"))]552		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,553	),554	/// Many tokens, each may have only one owner555	RefungibleMultipleItems(556		#[derivative(Debug(format_with = "bounded::vec_debug"))]557		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,558	),559	/// Single token, which may have many owners560	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),561}562563impl CreateItemData {564	pub fn data_size(&self) -> usize {565		match self {566			CreateItemData::NFT(data) => data.const_data.len(),567			CreateItemData::ReFungible(data) => data.const_data.len(),568			_ => 0,569		}570	}571}572573impl From<CreateNftData> for CreateItemData {574	fn from(item: CreateNftData) -> Self {575		CreateItemData::NFT(item)576	}577}578579impl From<CreateReFungibleData> for CreateItemData {580	fn from(item: CreateReFungibleData) -> Self {581		CreateItemData::ReFungible(item)582	}583}584585impl From<CreateFungibleData> for CreateItemData {586	fn from(item: CreateFungibleData) -> Self {587		CreateItemData::Fungible(item)588	}589}590591#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]592#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]593pub struct CollectionStats {594	pub created: u32,595	pub destroyed: u32,596	pub alive: u32,597}598599#[derive(Encode, Decode, Clone, Debug)]600#[cfg_attr(feature = "std", derive(PartialEq))]601pub struct PhantomType<T>(core::marker::PhantomData<T>);602603impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {604	type Identity = PhantomType<T>;605606	fn type_info() -> scale_info::Type {607		use scale_info::{608			Type, Path,609			build::{FieldsBuilder, UnnamedFields},610			type_params,611		};612		Type::builder()613			.path(Path::new("up_data_structs", "PhantomType"))614			.type_params(type_params!(T))615			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))616	}617}618impl<T> MaxEncodedLen for PhantomType<T> {619	fn max_encoded_len() -> usize {620		0621	}622}623624pub type PropertyKey = BoundedVec<u8, ConstU32<MAX_PROPERTY_KEY_LENGTH>>;625pub type PropertyValue = BoundedVec<u8, ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;626627#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]628#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]629pub struct PropertyPermission {630	pub mutable: bool,631	pub collection_admin: bool,632	pub token_owner: bool,633}634635impl PropertyPermission {636	pub fn none() -> Self {637		Self {638			mutable: true,639			collection_admin: false,640			token_owner: false,641		}642	}643}644645#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]646#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]647pub struct Property {648	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]649	pub key: PropertyKey,650651	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]652	pub value: PropertyValue,653}654655impl Into<(PropertyKey, PropertyValue)> for Property {656	fn into(self) -> (PropertyKey, PropertyValue) {657		(self.key, self.value)658	}659}660661#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]662#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]663pub struct PropertyKeyPermission {664	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]665	pub key: PropertyKey,666667	pub permission: PropertyPermission,668}669670impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {671	fn into(self) -> (PropertyKey, PropertyPermission) {672		(self.key, self.permission)673	}674}675676#[derive(Debug)]677pub enum PropertiesError {678	NoSpaceForProperty,679	PropertyLimitReached,680	InvalidCharacterInPropertyKey,681	PropertyKeyIsTooLong,682	EmptyPropertyKey,683}684685#[derive(Clone, Copy)]686pub enum PropertyScope {687	None,688	Rmrk,689}690691impl PropertyScope {692	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {693		let scope_str: &[u8] = match self {694			Self::None => return Ok(key),695			Self::Rmrk => b"rmrk",696		};697698		[scope_str, b":", key.as_slice()]699			.concat()700			.try_into()701			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)702	}703}704705pub trait TrySetProperty: Sized {706	type Value;707708	fn try_scoped_set(709		&mut self,710		scope: PropertyScope,711		key: PropertyKey,712		value: Self::Value,713	) -> Result<(), PropertiesError>;714715	fn try_scoped_set_from_iter<I, KV>(716		&mut self,717		scope: PropertyScope,718		iter: I,719	) -> Result<(), PropertiesError>720	where721		I: Iterator<Item = KV>,722		KV: Into<(PropertyKey, Self::Value)>,723	{724		for kv in iter {725			let (key, value) = kv.into();726			self.try_scoped_set(scope, key, value)?;727		}728729		Ok(())730	}731732	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {733		self.try_scoped_set(PropertyScope::None, key, value)734	}735736	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>737	where738		I: Iterator<Item = KV>,739		KV: Into<(PropertyKey, Self::Value)>,740	{741		self.try_scoped_set_from_iter(PropertyScope::None, iter)742	}743}744745#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]746#[derivative(Default(bound = ""))]747pub struct PropertiesMap<Value>(748	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,749);750751impl<Value> PropertiesMap<Value> {752	pub fn new() -> Self {753		Self(BoundedBTreeMap::new())754	}755756	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {757		Self::check_property_key(key)?;758759		Ok(self.0.remove(key))760	}761762	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {763		self.0.get(key)764	}765766	pub fn contains_key(&self, key: &PropertyKey) -> bool {767		self.0.contains_key(key)768	}769770	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {771		if key.is_empty() {772			return Err(PropertiesError::EmptyPropertyKey);773		}774775		for byte in key.as_slice().iter() {776			let byte = *byte;777778			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' {779				return Err(PropertiesError::InvalidCharacterInPropertyKey);780			}781		}782783		Ok(())784	}785}786787impl<Value> IntoIterator for PropertiesMap<Value> {788	type Item = (PropertyKey, Value);789	type IntoIter = <790		BoundedBTreeMap<791			PropertyKey,792			Value,793			ConstU32<MAX_PROPERTIES_PER_ITEM>794		> as IntoIterator795	>::IntoIter;796797	fn into_iter(self) -> Self::IntoIter {798        self.0.into_iter()799    }800}801802impl<Value> TrySetProperty for PropertiesMap<Value> {803	type Value = Value;804805	fn try_scoped_set(806		&mut self,807		scope: PropertyScope,808		key: PropertyKey,809		value: Self::Value,810	) -> Result<(), PropertiesError> {811		Self::check_property_key(&key)?;812813		let key = scope.apply(key)?;814		self.0815			.try_insert(key, value)816			.map_err(|_| PropertiesError::PropertyLimitReached)?;817818		Ok(())819	}820}821822pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;823824#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]825pub struct Properties {826	map: PropertiesMap<PropertyValue>,827	consumed_space: u32,828	space_limit: u32,829}830831impl Properties {832	pub fn new(space_limit: u32) -> Self {833		Self {834			map: PropertiesMap::new(),835			consumed_space: 0,836			space_limit,837		}838	}839840	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {841		let value = self.map.remove(key)?;842843		if let Some(ref value) = value {844			let value_len = value.len() as u32;845			self.consumed_space -= value_len;846		}847848		Ok(value)849	}850851	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {852		self.map.get(key)853	}854}855856impl IntoIterator for Properties {857	type Item = (PropertyKey, PropertyValue);858	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;859860	fn into_iter(self) -> Self::IntoIter {861        self.map.into_iter()862    }863}864865impl TrySetProperty for Properties {866	type Value = PropertyValue;867868	fn try_scoped_set(869		&mut self,870		scope: PropertyScope,871		key: PropertyKey,872		value: Self::Value,873	) -> Result<(), PropertiesError> {874		let value_len = value.len();875876		if self.consumed_space as usize + value_len > self.space_limit as usize877			&& !cfg!(feature = "runtime-benchmarks")878		{879			return Err(PropertiesError::NoSpaceForProperty);880		}881882		self.map.try_scoped_set(scope, key, value)?;883884		self.consumed_space += value_len as u32;885886		Ok(())887	}888}889890pub struct CollectionProperties;891892impl Get<Properties> for CollectionProperties {893	fn get() -> Properties {894		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)895	}896}897898pub struct TokenProperties;899900impl Get<Properties> for TokenProperties {901	fn get() -> Properties {902		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)903	}904}905906// RMRK907// todo document?908parameter_types! {909	#[derive(PartialEq, TypeInfo)]910	pub const RmrkStringLimit: u32 = 128;911	#[derive(PartialEq)]912	pub const RmrkCollectionSymbolLimit: u32 = 100;913	#[derive(PartialEq)]914	pub const RmrkResourceSymbolLimit: u32 = 10;915	#[derive(PartialEq)]916	pub const RmrkKeyLimit: u32 = 32;917	#[derive(PartialEq)]918	pub const RmrkValueLimit: u32 = 256;919	#[derive(PartialEq)]920	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;921	#[derive(PartialEq)]922	pub const RmrkPartsLimit: u32 = 3;923}924925impl From<RmrkCollectionId> for CollectionId {926	fn from(id: RmrkCollectionId) -> Self {927		Self(id)928	}929}930931impl From<RmrkNftId> for TokenId {932	fn from(id: RmrkNftId) -> Self {933		Self(id)934	}935}936937pub type RmrkCollectionInfo<AccountId> =938	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;939pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;940pub type RmrkResourceInfo = ResourceInfo<941	RmrkBoundedResource,942	RmrkString,943	RmrkBoundedParts,944>;945pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;946pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;947pub type RmrkPartType =948	PartType<RmrkString, BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>>;949pub type RmrkThemeProperty = ThemeProperty<RmrkString>;950pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;951952pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;953pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;954pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;955956type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;957type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>;958959pub type RmrkRpcString = Vec<u8>;960pub type RmrkThemeName = RmrkRpcString;961pub type RmrkPropertyKey = RmrkRpcString;962963pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;