difftreelog
fix create collection properties length
in: master
1 file changed
primitives/data-structs/src/lib.rsdiffbeforeafterboth1// 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};5354mod bounded;55pub mod budget;56pub mod mapping;57mod migration;5859pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;60pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;61pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;6263pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {64 100_00065} else {66 1067};68pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {69 100_00070} else {71 1072};73pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {74 204875} else {76 1077};78pub const COLLECTION_ADMINS_LIMIT: u32 = 5;79pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;80pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {81 1_000_00082} else {83 1084};8586// Timeouts for item types in passed blocks87pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;88pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;89pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;9091pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;9293// Schema limits94pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;95pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;96pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;9798pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;99100pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;101pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;102pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;103104pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;105pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;106pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;107108// pub const MAX_PROPERTY_KEYS_OVERALL_LENGTH: u32 = MAX_PROPERTY_KEY_LENGTH * MAX_PROPERTIES_PER_ITEM;109pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;110pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;111112pub const MAX_COLLECTION_PROPERTIES_ENCODE_LEN: u32 =113 MAX_PROPERTIES_PER_ITEM * MAX_PROPERTY_KEY_LENGTH + MAX_COLLECTION_PROPERTIES_SIZE;114115// RMRK constants116pub const RMRK_STRING_LIMIT: u32 = 128;117pub const RMRK_COLLECTION_SYMBOL_LIMIT: u32 = 100;118pub const RMRK_RESOURCE_SYMBOL_LIMIT: u32 = 10;119pub const RMRK_KEY_LIMIT: u32 = 32;120pub const RMRK_VALUE_LIMIT: u32 = 256;121122pub struct MaxPropertiesPermissionsEncodeLen;123124impl Get<u32> for MaxPropertiesPermissionsEncodeLen {125 fn get() -> u32 {126 MAX_PROPERTIES_PER_ITEM * MAX_PROPERTY_KEY_LENGTH127 + <PropertyPermission as MaxEncodedLen>::max_encoded_len() as u32128 }129}130131/// How much items can be created per single132/// create_many call133pub const MAX_ITEMS_PER_BATCH: u32 = 200;134135pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;136137#[derive(138 Encode,139 Decode,140 PartialEq,141 Eq,142 PartialOrd,143 Ord,144 Clone,145 Copy,146 Debug,147 Default,148 TypeInfo,149 MaxEncodedLen,150)]151#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]152pub struct CollectionId(pub u32);153impl EncodeLike<u32> for CollectionId {}154impl EncodeLike<CollectionId> for u32 {}155156#[derive(157 Encode,158 Decode,159 PartialEq,160 Eq,161 PartialOrd,162 Ord,163 Clone,164 Copy,165 Debug,166 Default,167 TypeInfo,168 MaxEncodedLen,169)]170#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]171pub struct TokenId(pub u32);172impl EncodeLike<u32> for TokenId {}173impl EncodeLike<TokenId> for u32 {}174175impl TokenId {176 pub fn try_next(self) -> Result<TokenId, ArithmeticError> {177 self.0178 .checked_add(1)179 .ok_or(ArithmeticError::Overflow)180 .map(Self)181 }182}183184impl From<TokenId> for U256 {185 fn from(t: TokenId) -> Self {186 t.0.into()187 }188}189190impl TryFrom<U256> for TokenId {191 type Error = &'static str;192193 fn try_from(value: U256) -> Result<Self, Self::Error> {194 Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))195 }196}197198#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]199#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]200pub struct TokenData<CrossAccountId> {201 pub const_data: Vec<u8>,202 pub properties: Vec<Property>,203 pub owner: Option<CrossAccountId>,204}205206pub struct OverflowError;207impl From<OverflowError> for &'static str {208 fn from(_: OverflowError) -> Self {209 "overflow occured"210 }211}212213pub type DecimalPoints = u8;214215#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]216#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]217pub enum CollectionMode {218 NFT,219 // decimal points220 Fungible(DecimalPoints),221 ReFungible,222}223224impl CollectionMode {225 pub fn id(&self) -> u8 {226 match self {227 CollectionMode::NFT => 1,228 CollectionMode::Fungible(_) => 2,229 CollectionMode::ReFungible => 3,230 }231 }232}233234pub trait SponsoringResolve<AccountId, Call> {235 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;236}237238#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]239#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]240pub enum AccessMode {241 Normal,242 AllowList,243}244impl Default for AccessMode {245 fn default() -> Self {246 Self::Normal247 }248}249250#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]251#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]252pub enum SchemaVersion {253 ImageURL,254 Unique,255}256impl Default for SchemaVersion {257 fn default() -> Self {258 Self::ImageURL259 }260}261262#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]263#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]264pub struct Ownership<AccountId> {265 pub owner: AccountId,266 pub fraction: u128,267}268269#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]270#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]271pub enum SponsorshipState<AccountId> {272 /// The fees are applied to the transaction sender273 Disabled,274 Unconfirmed(AccountId),275 /// Transactions are sponsored by specified account276 Confirmed(AccountId),277}278279impl<AccountId> SponsorshipState<AccountId> {280 pub fn sponsor(&self) -> Option<&AccountId> {281 match self {282 Self::Confirmed(sponsor) => Some(sponsor),283 _ => None,284 }285 }286287 pub fn pending_sponsor(&self) -> Option<&AccountId> {288 match self {289 Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),290 _ => None,291 }292 }293294 pub fn confirmed(&self) -> bool {295 matches!(self, Self::Confirmed(_))296 }297}298299impl<T> Default for SponsorshipState<T> {300 fn default() -> Self {301 Self::Disabled302 }303}304305/// Used in storage306#[struct_versioning::versioned(version = 2, upper)]307#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]308pub struct Collection<AccountId> {309 pub owner: AccountId,310 pub mode: CollectionMode,311 pub access: AccessMode,312 pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,313 pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,314 pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,315 pub mint_mode: bool,316317 #[version(..2)]318 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,319320 pub schema_version: SchemaVersion,321 pub sponsorship: SponsorshipState<AccountId>,322323 #[version(..2)]324 pub limits: CollectionLimitsVersion1, // Collection private restrictions325 #[version(2.., upper(limits.into()))]326 pub limits: CollectionLimitsVersion2,327328 #[version(..2)]329 pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,330331 #[version(..2)]332 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,333334 #[version(..2)]335 pub meta_update_permission: MetaUpdatePermission,336}337338/// Used in RPC calls339#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]340#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]341pub struct RpcCollection<AccountId> {342 pub owner: AccountId,343 pub mode: CollectionMode,344 pub access: AccessMode,345 pub name: Vec<u16>,346 pub description: Vec<u16>,347 pub token_prefix: Vec<u8>,348 pub mint_mode: bool,349 pub offchain_schema: Vec<u8>,350 pub schema_version: SchemaVersion,351 pub sponsorship: SponsorshipState<AccountId>,352 pub limits: CollectionLimits,353 pub const_on_chain_schema: Vec<u8>,354 pub token_property_permissions: Vec<PropertyKeyPermission>,355 pub properties: Vec<Property>,356}357358#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]359#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]360pub enum CollectionField {361 ConstOnChainSchema,362 OffchainSchema,363}364365#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]366#[derivative(Debug, Default(bound = ""))]367pub struct CreateCollectionData<AccountId> {368 #[derivative(Default(value = "CollectionMode::NFT"))]369 pub mode: CollectionMode,370 pub access: Option<AccessMode>,371 pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,372 pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,373 pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,374 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,375 pub schema_version: Option<SchemaVersion>,376 pub pending_sponsor: Option<AccountId>,377 pub limits: Option<CollectionLimits>,378 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,379 pub token_property_permissions: CollectionPropertiesPermissionsVec,380 pub properties: CollectionPropertiesVec,381}382383pub type CollectionPropertiesPermissionsVec =384 BoundedVec<PropertyKeyPermission, MaxPropertiesPermissionsEncodeLen>;385386pub type CollectionPropertiesVec =387 BoundedVec<Property, ConstU32<MAX_COLLECTION_PROPERTIES_ENCODE_LEN>>;388389/// All fields are wrapped in `Option`s, where None means chain default390#[struct_versioning::versioned(version = 2, upper)]391#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]392#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]393pub struct CollectionLimits {394 pub account_token_ownership_limit: Option<u32>,395 pub sponsored_data_size: Option<u32>,396397 /// FIXME should we delete this or repurpose it?398 /// None - setVariableMetadata is not sponsored399 /// Some(v) - setVariableMetadata is sponsored400 /// if there is v block between txs401 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,402 pub token_limit: Option<u32>,403404 // Timeouts for item types in passed blocks405 pub sponsor_transfer_timeout: Option<u32>,406 pub sponsor_approve_timeout: Option<u32>,407 pub owner_can_transfer: Option<bool>,408 pub owner_can_destroy: Option<bool>,409 pub transfers_enabled: Option<bool>,410411 #[version(2.., upper(None))]412 pub nesting_rule: Option<NestingRule>,413}414415impl CollectionLimits {416 pub fn account_token_ownership_limit(&self) -> u32 {417 self.account_token_ownership_limit418 .unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)419 .min(MAX_TOKEN_OWNERSHIP)420 }421 pub fn sponsored_data_size(&self) -> u32 {422 self.sponsored_data_size423 .unwrap_or(CUSTOM_DATA_LIMIT)424 .min(CUSTOM_DATA_LIMIT)425 }426 pub fn token_limit(&self) -> u32 {427 self.token_limit428 .unwrap_or(COLLECTION_TOKEN_LIMIT)429 .min(COLLECTION_TOKEN_LIMIT)430 }431 pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {432 self.sponsor_transfer_timeout433 .unwrap_or(default)434 .min(MAX_SPONSOR_TIMEOUT)435 }436 pub fn sponsor_approve_timeout(&self) -> u32 {437 self.sponsor_approve_timeout438 .unwrap_or(SPONSOR_APPROVE_TIMEOUT)439 .min(MAX_SPONSOR_TIMEOUT)440 }441 pub fn owner_can_transfer(&self) -> bool {442 self.owner_can_transfer.unwrap_or(true)443 }444 pub fn owner_can_destroy(&self) -> bool {445 self.owner_can_destroy.unwrap_or(true)446 }447 pub fn transfers_enabled(&self) -> bool {448 self.transfers_enabled.unwrap_or(true)449 }450 pub fn sponsored_data_rate_limit(&self) -> Option<u32> {451 match self452 .sponsored_data_rate_limit453 .unwrap_or(SponsoringRateLimit::SponsoringDisabled)454 {455 SponsoringRateLimit::SponsoringDisabled => None,456 SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),457 }458 }459 pub fn nesting_rule(&self) -> &NestingRule {460 static DEFAULT: NestingRule = NestingRule::Disabled;461 self.nesting_rule.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)]518pub enum MetaUpdatePermission {519 ItemOwner,520 Admin,521 None,522}523524#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]525#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]526pub enum CreateItemData {527 NFT(CreateNftData),528 Fungible(CreateFungibleData),529 ReFungible(CreateReFungibleData),530}531532#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]533#[derivative(Debug)]534pub struct CreateNftExData<CrossAccountId> {535 #[derivative(Debug(format_with = "bounded::vec_debug"))]536 pub const_data: BoundedVec<u8, CustomDataLimit>,537 #[derivative(Debug(format_with = "bounded::vec_debug"))]538 pub properties: CollectionPropertiesVec,539 pub owner: CrossAccountId,540}541542#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]543#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]544pub struct CreateRefungibleExData<CrossAccountId> {545 #[derivative(Debug(format_with = "bounded::vec_debug"))]546 pub const_data: BoundedVec<u8, CustomDataLimit>,547 #[derivative(Debug(format_with = "bounded::map_debug"))]548 pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,549}550551#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]552#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]553pub enum CreateItemExData<CrossAccountId> {554 NFT(555 #[derivative(Debug(format_with = "bounded::vec_debug"))]556 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,557 ),558 Fungible(559 #[derivative(Debug(format_with = "bounded::map_debug"))]560 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,561 ),562 /// Many tokens, each may have only one owner563 RefungibleMultipleItems(564 #[derivative(Debug(format_with = "bounded::vec_debug"))]565 BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,566 ),567 /// Single token, which may have many owners568 RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),569}570571impl CreateItemData {572 pub fn data_size(&self) -> usize {573 match self {574 CreateItemData::NFT(data) => data.const_data.len(),575 CreateItemData::ReFungible(data) => data.const_data.len(),576 _ => 0,577 }578 }579}580581impl From<CreateNftData> for CreateItemData {582 fn from(item: CreateNftData) -> Self {583 CreateItemData::NFT(item)584 }585}586587impl From<CreateReFungibleData> for CreateItemData {588 fn from(item: CreateReFungibleData) -> Self {589 CreateItemData::ReFungible(item)590 }591}592593impl From<CreateFungibleData> for CreateItemData {594 fn from(item: CreateFungibleData) -> Self {595 CreateItemData::Fungible(item)596 }597}598599#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]600#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]601pub struct CollectionStats {602 pub created: u32,603 pub destroyed: u32,604 pub alive: u32,605}606607#[derive(Encode, Decode, Clone, Debug)]608#[cfg_attr(feature = "std", derive(PartialEq))]609pub struct PhantomType<T>(core::marker::PhantomData<T>);610611impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {612 type Identity = PhantomType<T>;613614 fn type_info() -> scale_info::Type {615 use scale_info::{616 Type, Path,617 build::{FieldsBuilder, UnnamedFields},618 type_params,619 };620 Type::builder()621 .path(Path::new("up_data_structs", "PhantomType"))622 .type_params(type_params!(T))623 .composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))624 }625}626impl<T> MaxEncodedLen for PhantomType<T> {627 fn max_encoded_len() -> usize {628 0629 }630}631632pub type PropertyKey = BoundedVec<u8, ConstU32<MAX_PROPERTY_KEY_LENGTH>>;633pub type PropertyValue = BoundedVec<u8, ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;634635#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]636#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]637pub struct PropertyPermission {638 pub mutable: bool,639 pub collection_admin: bool,640 pub token_owner: bool,641}642643impl PropertyPermission {644 pub fn none() -> Self {645 Self {646 mutable: true,647 collection_admin: false,648 token_owner: false,649 }650 }651}652653#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]654#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]655pub struct Property {656 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]657 pub key: PropertyKey,658659 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]660 pub value: PropertyValue,661}662663impl Into<(PropertyKey, PropertyValue)> for Property {664 fn into(self) -> (PropertyKey, PropertyValue) {665 (self.key, self.value)666 }667}668669#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]670#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]671pub struct PropertyKeyPermission {672 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]673 pub key: PropertyKey,674675 pub permission: PropertyPermission,676}677678impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {679 fn into(self) -> (PropertyKey, PropertyPermission) {680 (self.key, self.permission)681 }682}683684#[derive(Debug)]685pub enum PropertiesError {686 NoSpaceForProperty,687 PropertyLimitReached,688 InvalidCharacterInPropertyKey,689 PropertyKeyIsTooLong,690 EmptyPropertyKey,691}692693#[derive(Clone, Copy)]694pub enum PropertyScope {695 None,696 Rmrk,697}698699impl PropertyScope {700 pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {701 let scope_str: &[u8] = match self {702 Self::None => return Ok(key),703 Self::Rmrk => b"rmrk",704 };705706 [scope_str, b":", key.as_slice()]707 .concat()708 .try_into()709 .map_err(|_| PropertiesError::PropertyKeyIsTooLong)710 }711}712713pub trait TrySetProperty: Sized {714 type Value;715716 fn try_scoped_set(717 &mut self,718 scope: PropertyScope,719 key: PropertyKey,720 value: Self::Value,721 ) -> Result<(), PropertiesError>;722723 fn try_scoped_set_from_iter<I, KV>(724 &mut self,725 scope: PropertyScope,726 iter: I,727 ) -> Result<(), PropertiesError>728 where729 I: Iterator<Item = KV>,730 KV: Into<(PropertyKey, Self::Value)>,731 {732 for kv in iter {733 let (key, value) = kv.into();734 self.try_scoped_set(scope, key, value)?;735 }736737 Ok(())738 }739740 fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {741 self.try_scoped_set(PropertyScope::None, key, value)742 }743744 fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>745 where746 I: Iterator<Item = KV>,747 KV: Into<(PropertyKey, Self::Value)>,748 {749 self.try_scoped_set_from_iter(PropertyScope::None, iter)750 }751}752753#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]754#[derivative(Default(bound = ""))]755pub struct PropertiesMap<Value>(756 BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,757);758759impl<Value> PropertiesMap<Value> {760 pub fn new() -> Self {761 Self(BoundedBTreeMap::new())762 }763764 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {765 Self::check_property_key(key)?;766767 Ok(self.0.remove(key))768 }769770 pub fn get(&self, key: &PropertyKey) -> Option<&Value> {771 self.0.get(key)772 }773774 fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {775 if key.is_empty() {776 return Err(PropertiesError::EmptyPropertyKey);777 }778779 for byte in key.as_slice().iter() {780 let byte = *byte;781782 if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' {783 return Err(PropertiesError::InvalidCharacterInPropertyKey);784 }785 }786787 Ok(())788 }789}790791impl<Value> IntoIterator for PropertiesMap<Value> {792 type Item = (PropertyKey, Value);793 type IntoIter = <794 BoundedBTreeMap<795 PropertyKey,796 Value,797 ConstU32<MAX_PROPERTIES_PER_ITEM>798 > as IntoIterator799 >::IntoIter;800801 fn into_iter(self) -> Self::IntoIter {802 self.0.into_iter()803 }804}805806impl<Value> TrySetProperty for PropertiesMap<Value> {807 type Value = Value;808809 fn try_scoped_set(810 &mut self,811 scope: PropertyScope,812 key: PropertyKey,813 value: Self::Value,814 ) -> Result<(), PropertiesError> {815 Self::check_property_key(&key)?;816817 let key = scope.apply(key)?;818 self.0819 .try_insert(key, value)820 .map_err(|_| PropertiesError::PropertyLimitReached)?;821822 Ok(())823 }824}825826pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;827828#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]829pub struct Properties {830 map: PropertiesMap<PropertyValue>,831 consumed_space: u32,832 space_limit: u32,833}834835impl Properties {836 pub fn new(space_limit: u32) -> Self {837 Self {838 map: PropertiesMap::new(),839 consumed_space: 0,840 space_limit,841 }842 }843844 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {845 let value = self.map.remove(key)?;846847 if let Some(ref value) = value {848 let value_len = value.len() as u32;849 self.consumed_space -= value_len;850 }851852 Ok(value)853 }854855 pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {856 self.map.get(key)857 }858}859860impl IntoIterator for Properties {861 type Item = (PropertyKey, PropertyValue);862 type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;863864 fn into_iter(self) -> Self::IntoIter {865 self.map.into_iter()866 }867}868869impl TrySetProperty for Properties {870 type Value = PropertyValue;871872 fn try_scoped_set(873 &mut self,874 scope: PropertyScope,875 key: PropertyKey,876 value: Self::Value,877 ) -> Result<(), PropertiesError> {878 let value_len = value.len();879880 if self.consumed_space as usize + value_len > self.space_limit as usize881 && !cfg!(feature = "runtime-benchmarks")882 {883 return Err(PropertiesError::NoSpaceForProperty);884 }885886 self.map.try_scoped_set(scope, key, value)?;887888 self.consumed_space += value_len as u32;889890 Ok(())891 }892}893894pub struct CollectionProperties;895896impl Get<Properties> for CollectionProperties {897 fn get() -> Properties {898 Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)899 }900}901902pub struct TokenProperties;903904impl Get<Properties> for TokenProperties {905 fn get() -> Properties {906 Properties::new(MAX_TOKEN_PROPERTIES_SIZE)907 }908}909910// RMRK911// todo document?912parameter_types! {913 #[derive(PartialEq, TypeInfo)]914 pub const RmrkStringLimit: u32 = 128;915 #[derive(PartialEq)]916 pub const RmrkCollectionSymbolLimit: u32 = 100;917 #[derive(PartialEq)]918 pub const RmrkResourceSymbolLimit: u32 = 10;919 #[derive(PartialEq)]920 pub const RmrkKeyLimit: u32 = 32;921 #[derive(PartialEq)]922 pub const RmrkValueLimit: u32 = 256;923 #[derive(PartialEq)]924 pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;925 #[derive(PartialEq)]926 pub const RmrkPartsLimit: u32 = 3;927}928929impl From<RmrkCollectionId> for CollectionId {930 fn from(id: RmrkCollectionId) -> Self {931 Self(id)932 }933}934935impl From<RmrkNftId> for TokenId {936 fn from(id: RmrkNftId) -> Self {937 Self(id)938 }939}940941pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;942pub type RmrkCollectionInfo<AccountId> =943 CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;944pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;945pub type RmrkResourceInfo = ResourceInfo<946 BoundedVec<u8, RmrkResourceSymbolLimit>,947 RmrkString,948 BoundedVec<RmrkPartId, RmrkPartsLimit>,949>;950pub type RmrkPropertyInfo =951 PropertyInfo<BoundedVec<u8, RmrkKeyLimit>, BoundedVec<u8, RmrkValueLimit>>;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>>;957958pub type RmrkRpcString = Vec<u8>;959pub type RmrkThemeName = RmrkRpcString;960pub type RmrkPropertyKey = RmrkRpcString;961962pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;