git.delta.rocks / unique-network / refs/commits / 02be24d6ef8a

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#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]369#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]370pub struct CollectionLimits {371	#[serde(alias = "accountTokenOwnershipLimit")]372	pub account_token_ownership_limit: Option<u32>,373	#[serde(alias = "sponsoredDataSize")]374	pub sponsored_data_size: Option<u32>,375376	/// FIXME should we delete this or repurpose it?377	/// None - setVariableMetadata is not sponsored378	/// Some(v) - setVariableMetadata is sponsored379	///           if there is v block between txs380	#[serde(alias = "sponsoredDataRateLimit")]381	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,382	#[serde(alias = "tokenLimit")]383	pub token_limit: Option<u32>,384385	// Timeouts for item types in passed blocks386	#[serde(alias = "sponsorTransferTimeout")]387	pub sponsor_transfer_timeout: Option<u32>,388	#[serde(alias = "sponsorApproveTimeout")]389	pub sponsor_approve_timeout: Option<u32>,390	#[serde(alias = "ownerCanTransfer")]391	pub owner_can_transfer: Option<bool>,392	#[serde(alias = "ownerCanDestroy")]393	pub owner_can_destroy: Option<bool>,394	#[serde(alias = "transfersEnabled")]395	pub transfers_enabled: Option<bool>,396}397398impl CollectionLimits {399	pub fn account_token_ownership_limit(&self) -> u32 {400		self.account_token_ownership_limit401			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)402			.min(MAX_TOKEN_OWNERSHIP)403	}404	pub fn sponsored_data_size(&self) -> u32 {405		self.sponsored_data_size406			.unwrap_or(CUSTOM_DATA_LIMIT)407			.min(CUSTOM_DATA_LIMIT)408	}409	pub fn token_limit(&self) -> u32 {410		self.token_limit411			.unwrap_or(COLLECTION_TOKEN_LIMIT)412			.min(COLLECTION_TOKEN_LIMIT)413	}414	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {415		self.sponsor_transfer_timeout416			.unwrap_or(default)417			.min(MAX_SPONSOR_TIMEOUT)418	}419	pub fn sponsor_approve_timeout(&self) -> u32 {420		self.sponsor_approve_timeout421			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)422			.min(MAX_SPONSOR_TIMEOUT)423	}424	pub fn owner_can_transfer(&self) -> bool {425		self.owner_can_transfer.unwrap_or(true)426	}427	pub fn owner_can_destroy(&self) -> bool {428		self.owner_can_destroy.unwrap_or(true)429	}430	pub fn transfers_enabled(&self) -> bool {431		self.transfers_enabled.unwrap_or(true)432	}433	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {434		match self435			.sponsored_data_rate_limit436			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)437		{438			SponsoringRateLimit::SponsoringDisabled => None,439			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),440		}441	}442}443444#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]445#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]446pub struct CollectionPermissions {447	pub access: Option<AccessMode>,448	pub mint_mode: Option<bool>,449	pub nesting: Option<NestingRule>,450}451452impl CollectionPermissions {453	pub fn access(&self) -> AccessMode {454		self.access.unwrap_or(AccessMode::Normal)455	}456	pub fn mint_mode(&self) -> bool {457		self.mint_mode.unwrap_or(false)458	}459	pub fn nesting(&self) -> &NestingRule {460		static DEFAULT: NestingRule = NestingRule::Disabled;461		self.nesting.as_ref().unwrap_or(&DEFAULT)462	}463}464465#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]466#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]467#[derivative(Debug)]468pub enum NestingRule {469	/// No one can nest tokens470	Disabled,471	/// Owner can nest any tokens472	Owner,473	/// Owner can nest tokens from specified collections474	OwnerRestricted(475		#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]476		#[derivative(Debug(format_with = "bounded::set_debug"))]477		BoundedBTreeSet<CollectionId, ConstU32<16>>,478	),479}480481#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]482#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]483pub enum SponsoringRateLimit {484	SponsoringDisabled,485	Blocks(u32),486}487488#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]489#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]490#[derivative(Debug)]491pub struct CreateNftData {492	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]493	#[derivative(Debug(format_with = "bounded::vec_debug"))]494	pub const_data: BoundedVec<u8, CustomDataLimit>,495496	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]497	#[derivative(Debug(format_with = "bounded::vec_debug"))]498	pub properties: CollectionPropertiesVec,499}500501#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]502#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]503pub struct CreateFungibleData {504	pub value: u128,505}506507#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]508#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]509#[derivative(Debug)]510pub struct CreateReFungibleData {511	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]512	#[derivative(Debug(format_with = "bounded::vec_debug"))]513	pub const_data: BoundedVec<u8, CustomDataLimit>,514	pub pieces: u128,515}516517#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]518#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]519pub enum MetaUpdatePermission {520	ItemOwner,521	Admin,522	None,523}524525#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]526#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]527pub enum CreateItemData {528	NFT(CreateNftData),529	Fungible(CreateFungibleData),530	ReFungible(CreateReFungibleData),531}532533#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]534#[derivative(Debug)]535pub struct CreateNftExData<CrossAccountId> {536	#[derivative(Debug(format_with = "bounded::vec_debug"))]537	pub properties: CollectionPropertiesVec,538	pub owner: CrossAccountId,539}540541#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]542#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]543pub struct CreateRefungibleExData<CrossAccountId> {544	#[derivative(Debug(format_with = "bounded::vec_debug"))]545	pub const_data: BoundedVec<u8, CustomDataLimit>,546	#[derivative(Debug(format_with = "bounded::map_debug"))]547	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,548}549550#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]551#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]552pub enum CreateItemExData<CrossAccountId> {553	NFT(554		#[derivative(Debug(format_with = "bounded::vec_debug"))]555		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,556	),557	Fungible(558		#[derivative(Debug(format_with = "bounded::map_debug"))]559		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,560	),561	/// Many tokens, each may have only one owner562	RefungibleMultipleItems(563		#[derivative(Debug(format_with = "bounded::vec_debug"))]564		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,565	),566	/// Single token, which may have many owners567	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),568}569570impl CreateItemData {571	pub fn data_size(&self) -> usize {572		match self {573			CreateItemData::NFT(data) => data.const_data.len(),574			CreateItemData::ReFungible(data) => data.const_data.len(),575			_ => 0,576		}577	}578}579580impl From<CreateNftData> for CreateItemData {581	fn from(item: CreateNftData) -> Self {582		CreateItemData::NFT(item)583	}584}585586impl From<CreateReFungibleData> for CreateItemData {587	fn from(item: CreateReFungibleData) -> Self {588		CreateItemData::ReFungible(item)589	}590}591592impl From<CreateFungibleData> for CreateItemData {593	fn from(item: CreateFungibleData) -> Self {594		CreateItemData::Fungible(item)595	}596}597598#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]599#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]600pub struct CollectionStats {601	pub created: u32,602	pub destroyed: u32,603	pub alive: u32,604}605606#[derive(Encode, Decode, Clone, Debug)]607#[cfg_attr(feature = "std", derive(PartialEq))]608pub struct PhantomType<T>(core::marker::PhantomData<T>);609610impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {611	type Identity = PhantomType<T>;612613	fn type_info() -> scale_info::Type {614		use scale_info::{615			Type, Path,616			build::{FieldsBuilder, UnnamedFields},617			type_params,618		};619		Type::builder()620			.path(Path::new("up_data_structs", "PhantomType"))621			.type_params(type_params!(T))622			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))623	}624}625impl<T> MaxEncodedLen for PhantomType<T> {626	fn max_encoded_len() -> usize {627		0628	}629}630631pub type PropertyKey = BoundedVec<u8, ConstU32<MAX_PROPERTY_KEY_LENGTH>>;632pub type PropertyValue = BoundedVec<u8, ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;633634#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]635#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]636pub struct PropertyPermission {637	pub mutable: bool,638	pub collection_admin: bool,639	pub token_owner: bool,640}641642impl PropertyPermission {643	pub fn none() -> Self {644		Self {645			mutable: true,646			collection_admin: false,647			token_owner: false,648		}649	}650}651652#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]653#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]654pub struct Property {655	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]656	pub key: PropertyKey,657658	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]659	pub value: PropertyValue,660}661662impl Into<(PropertyKey, PropertyValue)> for Property {663	fn into(self) -> (PropertyKey, PropertyValue) {664		(self.key, self.value)665	}666}667668#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]669#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]670pub struct PropertyKeyPermission {671	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]672	pub key: PropertyKey,673674	pub permission: PropertyPermission,675}676677impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {678	fn into(self) -> (PropertyKey, PropertyPermission) {679		(self.key, self.permission)680	}681}682683#[derive(Debug)]684pub enum PropertiesError {685	NoSpaceForProperty,686	PropertyLimitReached,687	InvalidCharacterInPropertyKey,688	PropertyKeyIsTooLong,689	EmptyPropertyKey,690}691692#[derive(Clone, Copy)]693pub enum PropertyScope {694	None,695	Rmrk,696}697698impl PropertyScope {699	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {700		let scope_str: &[u8] = match self {701			Self::None => return Ok(key),702			Self::Rmrk => b"rmrk",703		};704705		[scope_str, b":", key.as_slice()]706			.concat()707			.try_into()708			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)709	}710}711712pub trait TrySetProperty: Sized {713	type Value;714715	fn try_scoped_set(716		&mut self,717		scope: PropertyScope,718		key: PropertyKey,719		value: Self::Value,720	) -> Result<(), PropertiesError>;721722	fn try_scoped_set_from_iter<I, KV>(723		&mut self,724		scope: PropertyScope,725		iter: I,726	) -> Result<(), PropertiesError>727	where728		I: Iterator<Item = KV>,729		KV: Into<(PropertyKey, Self::Value)>,730	{731		for kv in iter {732			let (key, value) = kv.into();733			self.try_scoped_set(scope, key, value)?;734		}735736		Ok(())737	}738739	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {740		self.try_scoped_set(PropertyScope::None, key, value)741	}742743	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>744	where745		I: Iterator<Item = KV>,746		KV: Into<(PropertyKey, Self::Value)>,747	{748		self.try_scoped_set_from_iter(PropertyScope::None, iter)749	}750}751752#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]753#[derivative(Default(bound = ""))]754pub struct PropertiesMap<Value>(755	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,756);757758impl<Value> PropertiesMap<Value> {759	pub fn new() -> Self {760		Self(BoundedBTreeMap::new())761	}762763	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {764		Self::check_property_key(key)?;765766		Ok(self.0.remove(key))767	}768769	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {770		self.0.get(key)771	}772773	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {774		if key.is_empty() {775			return Err(PropertiesError::EmptyPropertyKey);776		}777778		for byte in key.as_slice().iter() {779			let byte = *byte;780781			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' {782				return Err(PropertiesError::InvalidCharacterInPropertyKey);783			}784		}785786		Ok(())787	}788}789790impl<Value> IntoIterator for PropertiesMap<Value> {791	type Item = (PropertyKey, Value);792	type IntoIter = <793		BoundedBTreeMap<794			PropertyKey,795			Value,796			ConstU32<MAX_PROPERTIES_PER_ITEM>797		> as IntoIterator798	>::IntoIter;799800	fn into_iter(self) -> Self::IntoIter {801        self.0.into_iter()802    }803}804805impl<Value> TrySetProperty for PropertiesMap<Value> {806	type Value = Value;807808	fn try_scoped_set(809		&mut self,810		scope: PropertyScope,811		key: PropertyKey,812		value: Self::Value,813	) -> Result<(), PropertiesError> {814		Self::check_property_key(&key)?;815816		let key = scope.apply(key)?;817		self.0818			.try_insert(key, value)819			.map_err(|_| PropertiesError::PropertyLimitReached)?;820821		Ok(())822	}823}824825pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;826827#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]828pub struct Properties {829	map: PropertiesMap<PropertyValue>,830	consumed_space: u32,831	space_limit: u32,832}833834impl Properties {835	pub fn new(space_limit: u32) -> Self {836		Self {837			map: PropertiesMap::new(),838			consumed_space: 0,839			space_limit,840		}841	}842843	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {844		let value = self.map.remove(key)?;845846		if let Some(ref value) = value {847			let value_len = value.len() as u32;848			self.consumed_space -= value_len;849		}850851		Ok(value)852	}853854	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {855		self.map.get(key)856	}857}858859impl IntoIterator for Properties {860	type Item = (PropertyKey, PropertyValue);861	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;862863	fn into_iter(self) -> Self::IntoIter {864        self.map.into_iter()865    }866}867868impl TrySetProperty for Properties {869	type Value = PropertyValue;870871	fn try_scoped_set(872		&mut self,873		scope: PropertyScope,874		key: PropertyKey,875		value: Self::Value,876	) -> Result<(), PropertiesError> {877		let value_len = value.len();878879		if self.consumed_space as usize + value_len > self.space_limit as usize880			&& !cfg!(feature = "runtime-benchmarks")881		{882			return Err(PropertiesError::NoSpaceForProperty);883		}884885		self.map.try_scoped_set(scope, key, value)?;886887		self.consumed_space += value_len as u32;888889		Ok(())890	}891}892893pub struct CollectionProperties;894895impl Get<Properties> for CollectionProperties {896	fn get() -> Properties {897		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)898	}899}900901pub struct TokenProperties;902903impl Get<Properties> for TokenProperties {904	fn get() -> Properties {905		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)906	}907}908909// RMRK910// todo document?911parameter_types! {912	#[derive(PartialEq, TypeInfo)]913	pub const RmrkStringLimit: u32 = 128;914	#[derive(PartialEq)]915	pub const RmrkCollectionSymbolLimit: u32 = 100;916	#[derive(PartialEq)]917	pub const RmrkResourceSymbolLimit: u32 = 10;918	#[derive(PartialEq)]919	pub const RmrkKeyLimit: u32 = 32;920	#[derive(PartialEq)]921	pub const RmrkValueLimit: u32 = 256;922	#[derive(PartialEq)]923	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;924	#[derive(PartialEq)]925	pub const RmrkPartsLimit: u32 = 3;926}927928impl From<RmrkCollectionId> for CollectionId {929	fn from(id: RmrkCollectionId) -> Self {930		Self(id)931	}932}933934impl From<RmrkNftId> for TokenId {935	fn from(id: RmrkNftId) -> Self {936		Self(id)937	}938}939940pub type RmrkCollectionInfo<AccountId> =941	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;942pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;943pub type RmrkResourceInfo = ResourceInfo<944	RmrkBoundedResource,945	RmrkString,946	RmrkBoundedParts,947>;948pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;949pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;950pub type RmrkPartType =951	PartType<RmrkString, BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>>;952pub type RmrkThemeProperty = ThemeProperty<RmrkString>;953pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;954955pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;956pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;957pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;958959type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;960type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>;961962pub type RmrkRpcString = Vec<u8>;963pub type RmrkThemeName = RmrkRpcString;964pub type RmrkPropertyKey = RmrkRpcString;965966pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;