git.delta.rocks / unique-network / refs/commits / 81762e018aaf

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	ResourceTypes, BasicResource, ComposableResource, SlotResource,45};46pub use rmrk::{47	primitives::{48		CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,49		PartId as RmrkPartId, ResourceId as RmrkResourceId,50	},51	NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,52	FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart, EquippableList as RmrkEquippableList,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.., upper(false))]320	pub read_only: bool,321322	#[version(..2)]323	pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,324325	#[version(..2)]326	pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,327328	#[version(..2)]329	pub meta_update_permission: MetaUpdatePermission,330}331332/// Used in RPC calls333#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]334#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]335pub struct RpcCollection<AccountId> {336	pub owner: AccountId,337	pub mode: CollectionMode,338	pub name: Vec<u16>,339	pub description: Vec<u16>,340	pub token_prefix: Vec<u8>,341	pub sponsorship: SponsorshipState<AccountId>,342	pub limits: CollectionLimits,343	pub permissions: CollectionPermissions,344	pub token_property_permissions: Vec<PropertyKeyPermission>,345	pub properties: Vec<Property>,346	pub read_only: bool,347}348349#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]350#[derivative(Debug, Default(bound = ""))]351pub struct CreateCollectionData<AccountId> {352	#[derivative(Default(value = "CollectionMode::NFT"))]353	pub mode: CollectionMode,354	pub access: Option<AccessMode>,355	pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,356	pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,357	pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,358	pub pending_sponsor: Option<AccountId>,359	pub limits: Option<CollectionLimits>,360	pub permissions: Option<CollectionPermissions>,361	pub token_property_permissions: CollectionPropertiesPermissionsVec,362	pub properties: CollectionPropertiesVec,363}364365pub type CollectionPropertiesPermissionsVec =366	BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;367368pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;369370/// All fields are wrapped in `Option`s, where None means chain default371// When adding/removing fields from this struct - don't forget to also update clamp_limits372#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]373#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]374pub struct CollectionLimits {375	pub account_token_ownership_limit: Option<u32>,376	pub sponsored_data_size: Option<u32>,377378	/// FIXME should we delete this or repurpose it?379	/// None - setVariableMetadata is not sponsored380	/// Some(v) - setVariableMetadata is sponsored381	///           if there is v block between txs382	pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,383	pub token_limit: Option<u32>,384385	// Timeouts for item types in passed blocks386	pub sponsor_transfer_timeout: Option<u32>,387	pub sponsor_approve_timeout: Option<u32>,388	pub owner_can_transfer: Option<bool>,389	pub owner_can_destroy: Option<bool>,390	pub transfers_enabled: Option<bool>,391}392393impl CollectionLimits {394	pub fn account_token_ownership_limit(&self) -> u32 {395		self.account_token_ownership_limit396			.unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)397			.min(MAX_TOKEN_OWNERSHIP)398	}399	pub fn sponsored_data_size(&self) -> u32 {400		self.sponsored_data_size401			.unwrap_or(CUSTOM_DATA_LIMIT)402			.min(CUSTOM_DATA_LIMIT)403	}404	pub fn token_limit(&self) -> u32 {405		self.token_limit406			.unwrap_or(COLLECTION_TOKEN_LIMIT)407			.min(COLLECTION_TOKEN_LIMIT)408	}409	pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {410		self.sponsor_transfer_timeout411			.unwrap_or(default)412			.min(MAX_SPONSOR_TIMEOUT)413	}414	pub fn sponsor_approve_timeout(&self) -> u32 {415		self.sponsor_approve_timeout416			.unwrap_or(SPONSOR_APPROVE_TIMEOUT)417			.min(MAX_SPONSOR_TIMEOUT)418	}419	pub fn owner_can_transfer(&self) -> bool {420		self.owner_can_transfer.unwrap_or(true)421	}422	pub fn owner_can_destroy(&self) -> bool {423		self.owner_can_destroy.unwrap_or(true)424	}425	pub fn transfers_enabled(&self) -> bool {426		self.transfers_enabled.unwrap_or(true)427	}428	pub fn sponsored_data_rate_limit(&self) -> Option<u32> {429		match self430			.sponsored_data_rate_limit431			.unwrap_or(SponsoringRateLimit::SponsoringDisabled)432		{433			SponsoringRateLimit::SponsoringDisabled => None,434			SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),435		}436	}437}438439// When adding/removing fields from this struct - don't forget to also update clamp_limits440#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]441#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]442pub struct CollectionPermissions {443	pub access: Option<AccessMode>,444	pub mint_mode: Option<bool>,445	pub nesting: Option<NestingRule>,446}447448impl CollectionPermissions {449	pub fn access(&self) -> AccessMode {450		self.access.unwrap_or(AccessMode::Normal)451	}452	pub fn mint_mode(&self) -> bool {453		self.mint_mode.unwrap_or(false)454	}455	pub fn nesting(&self) -> &NestingRule {456		static DEFAULT: NestingRule = NestingRule::Disabled;457		self.nesting.as_ref().unwrap_or(&DEFAULT)458	}459}460461pub type OwnerRestrictedSet = BoundedBTreeSet<CollectionId, ConstU32<16>>;462463#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]464#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]465#[derivative(Debug)]466pub enum NestingRule {467	/// No one can nest tokens468	Disabled,469	/// Owner can nest any tokens470	Owner,471	/// Owner can nest tokens from specified collections472	OwnerRestricted(473		#[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]474		#[derivative(Debug(format_with = "bounded::set_debug"))]475		OwnerRestrictedSet,476	),477	/// Used for tests478	Permissive,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 properties: CollectionPropertiesVec,495}496497#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]498#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]499pub struct CreateFungibleData {500	pub value: u128,501}502503#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]504#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]505#[derivative(Debug)]506pub struct CreateReFungibleData {507	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]508	#[derivative(Debug(format_with = "bounded::vec_debug"))]509	pub const_data: BoundedVec<u8, CustomDataLimit>,510	pub pieces: u128,511}512513#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]514#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]515pub enum MetaUpdatePermission {516	ItemOwner,517	Admin,518	None,519}520521#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]522#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]523pub enum CreateItemData {524	NFT(CreateNftData),525	Fungible(CreateFungibleData),526	ReFungible(CreateReFungibleData),527}528529#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]530#[derivative(Debug)]531pub struct CreateNftExData<CrossAccountId> {532	#[derivative(Debug(format_with = "bounded::vec_debug"))]533	pub properties: CollectionPropertiesVec,534	pub owner: CrossAccountId,535}536537#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]538#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]539pub struct CreateRefungibleExData<CrossAccountId> {540	#[derivative(Debug(format_with = "bounded::vec_debug"))]541	pub const_data: BoundedVec<u8, CustomDataLimit>,542	#[derivative(Debug(format_with = "bounded::map_debug"))]543	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,544}545546#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]547#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]548pub enum CreateItemExData<CrossAccountId> {549	NFT(550		#[derivative(Debug(format_with = "bounded::vec_debug"))]551		BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,552	),553	Fungible(554		#[derivative(Debug(format_with = "bounded::map_debug"))]555		BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,556	),557	/// Many tokens, each may have only one owner558	RefungibleMultipleItems(559		#[derivative(Debug(format_with = "bounded::vec_debug"))]560		BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,561	),562	/// Single token, which may have many owners563	RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),564}565566impl CreateItemData {567	pub fn data_size(&self) -> usize {568		match self {569			CreateItemData::ReFungible(data) => data.const_data.len(),570			_ => 0,571		}572	}573}574575impl From<CreateNftData> for CreateItemData {576	fn from(item: CreateNftData) -> Self {577		CreateItemData::NFT(item)578	}579}580581impl From<CreateReFungibleData> for CreateItemData {582	fn from(item: CreateReFungibleData) -> Self {583		CreateItemData::ReFungible(item)584	}585}586587impl From<CreateFungibleData> for CreateItemData {588	fn from(item: CreateFungibleData) -> Self {589		CreateItemData::Fungible(item)590	}591}592593#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]594#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]595// todo possibly rename to be used generally as an address pair596pub struct TokenChild {597	pub token: TokenId,598	pub collection: CollectionId,599}600601#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]602#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]603pub struct CollectionStats {604	pub created: u32,605	pub destroyed: u32,606	pub alive: u32,607}608609#[derive(Encode, Decode, Clone, Debug)]610#[cfg_attr(feature = "std", derive(PartialEq))]611pub struct PhantomType<T>(core::marker::PhantomData<T>);612613impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {614	type Identity = PhantomType<T>;615616	fn type_info() -> scale_info::Type {617		use scale_info::{618			Type, Path,619			build::{FieldsBuilder, UnnamedFields},620			type_params,621		};622		Type::builder()623			.path(Path::new("up_data_structs", "PhantomType"))624			.type_params(type_params!(T))625			.composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))626	}627}628impl<T> MaxEncodedLen for PhantomType<T> {629	fn max_encoded_len() -> usize {630		0631	}632}633634pub type PropertyKey = BoundedVec<u8, ConstU32<MAX_PROPERTY_KEY_LENGTH>>;635pub type PropertyValue = BoundedVec<u8, ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;636637#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]638#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]639pub struct PropertyPermission {640	pub mutable: bool,641	pub collection_admin: bool,642	pub token_owner: bool,643}644645impl PropertyPermission {646	pub fn none() -> Self {647		Self {648			mutable: true,649			collection_admin: false,650			token_owner: false,651		}652	}653}654655#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]656#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]657pub struct Property {658	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]659	pub key: PropertyKey,660661	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]662	pub value: PropertyValue,663}664665impl Into<(PropertyKey, PropertyValue)> for Property {666	fn into(self) -> (PropertyKey, PropertyValue) {667		(self.key, self.value)668	}669}670671#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]672#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]673pub struct PropertyKeyPermission {674	#[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]675	pub key: PropertyKey,676677	pub permission: PropertyPermission,678}679680impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {681	fn into(self) -> (PropertyKey, PropertyPermission) {682		(self.key, self.permission)683	}684}685686#[derive(Debug)]687pub enum PropertiesError {688	NoSpaceForProperty,689	PropertyLimitReached,690	InvalidCharacterInPropertyKey,691	PropertyKeyIsTooLong,692	EmptyPropertyKey,693}694695#[derive(Clone, Copy)]696pub enum PropertyScope {697	None,698	Rmrk,699}700701impl PropertyScope {702	pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {703		let scope_str: &[u8] = match self {704			Self::None => return Ok(key),705			Self::Rmrk => b"rmrk",706		};707708		[scope_str, b":", key.as_slice()]709			.concat()710			.try_into()711			.map_err(|_| PropertiesError::PropertyKeyIsTooLong)712	}713}714715pub trait TrySetProperty: Sized {716	type Value;717718	fn try_scoped_set(719		&mut self,720		scope: PropertyScope,721		key: PropertyKey,722		value: Self::Value,723	) -> Result<(), PropertiesError>;724725	fn try_scoped_set_from_iter<I, KV>(726		&mut self,727		scope: PropertyScope,728		iter: I,729	) -> Result<(), PropertiesError>730	where731		I: Iterator<Item = KV>,732		KV: Into<(PropertyKey, Self::Value)>,733	{734		for kv in iter {735			let (key, value) = kv.into();736			self.try_scoped_set(scope, key, value)?;737		}738739		Ok(())740	}741742	fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {743		self.try_scoped_set(PropertyScope::None, key, value)744	}745746	fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>747	where748		I: Iterator<Item = KV>,749		KV: Into<(PropertyKey, Self::Value)>,750	{751		self.try_scoped_set_from_iter(PropertyScope::None, iter)752	}753}754755#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]756#[derivative(Default(bound = ""))]757pub struct PropertiesMap<Value>(758	BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,759);760761impl<Value> PropertiesMap<Value> {762	pub fn new() -> Self {763		Self(BoundedBTreeMap::new())764	}765766	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {767		Self::check_property_key(key)?;768769		Ok(self.0.remove(key))770	}771772	pub fn get(&self, key: &PropertyKey) -> Option<&Value> {773		self.0.get(key)774	}775776	pub fn contains_key(&self, key: &PropertyKey) -> bool {777		self.0.contains_key(key)778	}779780	fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {781		if key.is_empty() {782			return Err(PropertiesError::EmptyPropertyKey);783		}784785		for byte in key.as_slice().iter() {786			let byte = *byte;787788			if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' {789				return Err(PropertiesError::InvalidCharacterInPropertyKey);790			}791		}792793		Ok(())794	}795}796797impl<Value> IntoIterator for PropertiesMap<Value> {798	type Item = (PropertyKey, Value);799	type IntoIter = <800		BoundedBTreeMap<801			PropertyKey,802			Value,803			ConstU32<MAX_PROPERTIES_PER_ITEM>804		> as IntoIterator805	>::IntoIter;806807	fn into_iter(self) -> Self::IntoIter {808		self.0.into_iter()809	}810}811812impl<Value> TrySetProperty for PropertiesMap<Value> {813	type Value = Value;814815	fn try_scoped_set(816		&mut self,817		scope: PropertyScope,818		key: PropertyKey,819		value: Self::Value,820	) -> Result<(), PropertiesError> {821		Self::check_property_key(&key)?;822823		let key = scope.apply(key)?;824		self.0825			.try_insert(key, value)826			.map_err(|_| PropertiesError::PropertyLimitReached)?;827828		Ok(())829	}830}831832pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;833834#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]835pub struct Properties {836	map: PropertiesMap<PropertyValue>,837	consumed_space: u32,838	space_limit: u32,839}840841impl Properties {842	pub fn new(space_limit: u32) -> Self {843		Self {844			map: PropertiesMap::new(),845			consumed_space: 0,846			space_limit,847		}848	}849850	pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {851		let value = self.map.remove(key)?;852853		if let Some(ref value) = value {854			let value_len = value.len() as u32;855			self.consumed_space -= value_len;856		}857858		Ok(value)859	}860861	pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {862		self.map.get(key)863	}864}865866impl IntoIterator for Properties {867	type Item = (PropertyKey, PropertyValue);868	type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;869870	fn into_iter(self) -> Self::IntoIter {871		self.map.into_iter()872	}873}874875impl TrySetProperty for Properties {876	type Value = PropertyValue;877878	fn try_scoped_set(879		&mut self,880		scope: PropertyScope,881		key: PropertyKey,882		value: Self::Value,883	) -> Result<(), PropertiesError> {884		let value_len = value.len();885886		if self.consumed_space as usize + value_len > self.space_limit as usize887			&& !cfg!(feature = "runtime-benchmarks")888		{889			return Err(PropertiesError::NoSpaceForProperty);890		}891892		self.map.try_scoped_set(scope, key, value)?;893894		self.consumed_space += value_len as u32;895896		Ok(())897	}898}899900pub struct CollectionProperties;901902impl Get<Properties> for CollectionProperties {903	fn get() -> Properties {904		Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)905	}906}907908pub struct TokenProperties;909910impl Get<Properties> for TokenProperties {911	fn get() -> Properties {912		Properties::new(MAX_TOKEN_PROPERTIES_SIZE)913	}914}915916// RMRK917// todo document?918parameter_types! {919	#[derive(PartialEq, TypeInfo)]920	pub const RmrkStringLimit: u32 = 128;921	#[derive(PartialEq)]922	pub const RmrkCollectionSymbolLimit: u32 = 100;923	#[derive(PartialEq)]924	pub const RmrkResourceSymbolLimit: u32 = 10;925	#[derive(PartialEq)]926	pub const RmrkKeyLimit: u32 = 32;927	#[derive(PartialEq)]928	pub const RmrkValueLimit: u32 = 256;929	#[derive(PartialEq)]930	pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;931	#[derive(PartialEq)]932	pub const RmrkPartsLimit: u32 = 3;933}934935impl From<RmrkCollectionId> for CollectionId {936	fn from(id: RmrkCollectionId) -> Self {937		Self(id)938	}939}940941impl From<RmrkNftId> for TokenId {942	fn from(id: RmrkNftId) -> Self {943		Self(id)944	}945}946947pub type RmrkCollectionInfo<AccountId> =948	CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;949pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;950pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;951pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;952pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;953pub type RmrkPartType =954	PartType<RmrkString, BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>>;955pub type RmrkThemeProperty = ThemeProperty<RmrkString>;956pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;957pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;958959pub type RmrkBasicResource = BasicResource<RmrkString>;960pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;961pub type RmrkSlotResource = SlotResource<RmrkString>;962963pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;964pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;965pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;966pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;967pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;968pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed969970pub type RmrkRpcString = Vec<u8>;971pub type RmrkThemeName = RmrkRpcString;972pub type RmrkPropertyKey = RmrkRpcString;