123456789101112131415161718192021#![cfg_attr(not(feature = "std"), no_std)]2223use core::{24 convert::{TryFrom, TryInto},25 fmt,26};27use frame_support::{28 storage::{bounded_btree_map::BoundedBTreeMap, bounded_btree_set::BoundedBTreeSet},29 traits::Get,30 parameter_types,31};3233#[cfg(feature = "serde")]34use serde::{Serialize, Deserialize};3536use sp_core::U256;37use sp_runtime::{ArithmeticError, sp_std::prelude::Vec, Permill};38use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};39use frame_support::{BoundedVec, traits::ConstU32};40use derivative::Derivative;41use scale_info::TypeInfo;424344use rmrk_traits::{45 CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme, ThemeProperty,46 ResourceTypes, BasicResource, ComposableResource, SlotResource, EquippableList,47};48pub use rmrk_traits::{49 primitives::{50 CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,51 SlotId as RmrkSlotId, PartId as RmrkPartId, ResourceId as RmrkResourceId,52 },53 NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,54 FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart,55};5657mod bounded;58pub mod budget;59pub mod mapping;60mod migration;616263pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;646566pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;67pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;686970pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {71 100_00072} else {73 1074};757677pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {78 100_00079} else {80 1081};828384pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {85 204886} else {87 1088};899091pub const COLLECTION_ADMINS_LIMIT: u32 = 5;929394pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;959697pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {98 1_000_00099} else {100 10101};102103104pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;105106pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;107108pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;109110111pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;112113114pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;115pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;116pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;117118119pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;120121122pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;123124125pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;126127128pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;129130131pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;132133134pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;135136137pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;138139140pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;141142143pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;144145146pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;147148149150pub const MAX_ITEMS_PER_BATCH: u32 = 200;151152153pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;154155156#[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 CollectionId(pub u32);172impl EncodeLike<u32> for CollectionId {}173impl EncodeLike<CollectionId> for u32 {}174175176#[derive(177 Encode,178 Decode,179 PartialEq,180 Eq,181 PartialOrd,182 Ord,183 Clone,184 Copy,185 Debug,186 Default,187 TypeInfo,188 MaxEncodedLen,189)]190#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]191pub struct TokenId(pub u32);192impl EncodeLike<u32> for TokenId {}193impl EncodeLike<TokenId> for u32 {}194195impl TokenId {196 197 198 199 pub fn try_next(self) -> Result<TokenId, ArithmeticError> {200 self.0201 .checked_add(1)202 .ok_or(ArithmeticError::Overflow)203 .map(Self)204 }205}206207impl From<TokenId> for U256 {208 fn from(t: TokenId) -> Self {209 t.0.into()210 }211}212213impl TryFrom<U256> for TokenId {214 type Error = &'static str;215216 fn try_from(value: U256) -> Result<Self, Self::Error> {217 Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))218 }219}220221222#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]223#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]224pub struct TokenData<CrossAccountId> {225 226 pub properties: Vec<Property>,227228 229 pub owner: Option<CrossAccountId>,230231 232 pub pieces: u128,233}234235236pub struct OverflowError;237impl From<OverflowError> for &'static str {238 fn from(_: OverflowError) -> Self {239 "overflow occured"240 }241}242243244pub type DecimalPoints = u8;245246247248249250251#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]252#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]253pub enum CollectionMode {254 255 NFT,256 257 Fungible(DecimalPoints),258 259 ReFungible,260}261262impl CollectionMode {263 264 pub fn id(&self) -> u8 {265 match self {266 CollectionMode::NFT => 1,267 CollectionMode::Fungible(_) => 2,268 CollectionMode::ReFungible => 3,269 }270 }271}272273274pub trait SponsoringResolve<AccountId, Call> {275 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;276}277278279#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]280#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]281pub enum AccessMode {282 283 Normal,284 285 AllowList,286}287impl Default for AccessMode {288 fn default() -> Self {289 Self::Normal290 }291}292293294#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]295#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]296pub enum SchemaVersion {297 ImageURL,298 Unique,299}300impl Default for SchemaVersion {301 fn default() -> Self {302 Self::ImageURL303 }304}305306307#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]308#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]309pub struct Ownership<AccountId> {310 pub owner: AccountId,311 pub fraction: u128,312}313314315#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]316#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]317pub enum SponsorshipState<AccountId> {318 319 Disabled,320 321 322 Unconfirmed(AccountId),323 324 Confirmed(AccountId),325}326327impl<AccountId> SponsorshipState<AccountId> {328 329 pub fn sponsor(&self) -> Option<&AccountId> {330 match self {331 Self::Confirmed(sponsor) => Some(sponsor),332 _ => None,333 }334 }335336 337 pub fn pending_sponsor(&self) -> Option<&AccountId> {338 match self {339 Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),340 _ => None,341 }342 }343344 345 pub fn confirmed(&self) -> bool {346 matches!(self, Self::Confirmed(_))347 }348}349350impl<T> Default for SponsorshipState<T> {351 fn default() -> Self {352 Self::Disabled353 }354}355356pub type CollectionName = BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>;357pub type CollectionDescription = BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>;358pub type CollectionTokenPrefix = BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>;359360361362363364365366#[struct_versioning::versioned(version = 2, upper)]367#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]368pub struct Collection<AccountId> {369 370 pub owner: AccountId,371372 373 pub mode: CollectionMode,374375 376 #[version(..2)]377 pub access: AccessMode,378379 380 pub name: CollectionName,381382 383 pub description: CollectionDescription,384385 386 pub token_prefix: CollectionTokenPrefix,387388 #[version(..2)]389 pub mint_mode: bool,390391 #[version(..2)]392 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,393394 #[version(..2)]395 pub schema_version: SchemaVersion,396397 398 pub sponsorship: SponsorshipState<AccountId>,399400 401 pub limits: CollectionLimits,402403 404 #[version(2.., upper(Default::default()))]405 pub permissions: CollectionPermissions,406407 408 #[version(2.., upper(false))]409 pub external_collection: bool,410411 #[version(..2)]412 pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,413414 #[version(..2)]415 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,416417 #[version(..2)]418 pub meta_update_permission: MetaUpdatePermission,419}420421422#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]423#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]424pub struct RpcCollection<AccountId> {425 426 pub owner: AccountId,427428 429 pub mode: CollectionMode,430431 432 pub name: Vec<u16>,433434 435 pub description: Vec<u16>,436437 438 pub token_prefix: Vec<u8>,439440 441 pub sponsorship: SponsorshipState<AccountId>,442443 444 pub limits: CollectionLimits,445446 447 pub permissions: CollectionPermissions,448449 450 pub token_property_permissions: Vec<PropertyKeyPermission>,451452 453 pub properties: Vec<Property>,454455 456 pub read_only: bool,457}458459460461462#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]463#[derivative(Debug, Default(bound = ""))]464pub struct CreateCollectionData<AccountId> {465 466 #[derivative(Default(value = "CollectionMode::NFT"))]467 pub mode: CollectionMode,468469 470 pub access: Option<AccessMode>,471472 473 pub name: CollectionName,474475 476 pub description: CollectionDescription,477478 479 pub token_prefix: CollectionTokenPrefix,480481 482 pub pending_sponsor: Option<AccountId>,483484 485 pub limits: Option<CollectionLimits>,486487 488 pub permissions: Option<CollectionPermissions>,489490 491 pub token_property_permissions: CollectionPropertiesPermissionsVec,492493 494 pub properties: CollectionPropertiesVec,495}496497498499pub type CollectionPropertiesPermissionsVec =500 BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;501502503pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;504505506507508509510511#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]512#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]513514515516pub struct CollectionLimits {517 518 519 520 pub account_token_ownership_limit: Option<u32>,521522 523 524 525 pub sponsored_data_size: Option<u32>,526527 528 529 530 531 532 533 534 535 536 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,537 538539 540 541 542 543 pub token_limit: Option<u32>,544545 546 547 548 549 550 551 552 pub sponsor_transfer_timeout: Option<u32>,553554 555 556 557 558 pub sponsor_approve_timeout: Option<u32>,559560 561 562 563 pub owner_can_transfer: Option<bool>,564565 566 567 568 pub owner_can_destroy: Option<bool>,569570 571 572 573 pub transfers_enabled: Option<bool>,574}575576impl CollectionLimits {577 578 pub fn account_token_ownership_limit(&self) -> u32 {579 self.account_token_ownership_limit580 .unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)581 .min(MAX_TOKEN_OWNERSHIP)582 }583584 585 pub fn sponsored_data_size(&self) -> u32 {586 self.sponsored_data_size587 .unwrap_or(CUSTOM_DATA_LIMIT)588 .min(CUSTOM_DATA_LIMIT)589 }590591 592 pub fn token_limit(&self) -> u32 {593 self.token_limit594 .unwrap_or(COLLECTION_TOKEN_LIMIT)595 .min(COLLECTION_TOKEN_LIMIT)596 }597598 599 600 pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {601 self.sponsor_transfer_timeout602 .unwrap_or(default)603 .min(MAX_SPONSOR_TIMEOUT)604 }605606 607 pub fn sponsor_approve_timeout(&self) -> u32 {608 self.sponsor_approve_timeout609 .unwrap_or(SPONSOR_APPROVE_TIMEOUT)610 .min(MAX_SPONSOR_TIMEOUT)611 }612613 614 pub fn owner_can_transfer(&self) -> bool {615 self.owner_can_transfer.unwrap_or(false)616 }617618 619 pub fn owner_can_transfer_instaled(&self) -> bool {620 self.owner_can_transfer.is_some()621 }622623 624 pub fn owner_can_destroy(&self) -> bool {625 self.owner_can_destroy.unwrap_or(true)626 }627628 629 pub fn transfers_enabled(&self) -> bool {630 self.transfers_enabled.unwrap_or(true)631 }632633 634 pub fn sponsored_data_rate_limit(&self) -> Option<u32> {635 match self636 .sponsored_data_rate_limit637 .unwrap_or(SponsoringRateLimit::SponsoringDisabled)638 {639 SponsoringRateLimit::SponsoringDisabled => None,640 SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),641 }642 }643}644645646647648649650#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]651#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]652653654pub struct CollectionPermissions {655 656 657 658 pub access: Option<AccessMode>,659660 661 662 663 pub mint_mode: Option<bool>,664665 666 667 668 669 670 671 pub nesting: Option<NestingPermissions>,672}673674impl CollectionPermissions {675 676 pub fn access(&self) -> AccessMode {677 self.access.unwrap_or(AccessMode::Normal)678 }679680 681 pub fn mint_mode(&self) -> bool {682 self.mint_mode.unwrap_or(false)683 }684685 686 pub fn nesting(&self) -> &NestingPermissions {687 static DEFAULT: NestingPermissions = NestingPermissions {688 token_owner: false,689 collection_admin: false,690 restricted: None,691 #[cfg(feature = "runtime-benchmarks")]692 permissive: false,693 };694 self.nesting.as_ref().unwrap_or(&DEFAULT)695 }696}697698699type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;700701702#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]703#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]704#[derivative(Debug)]705pub struct OwnerRestrictedSet(706 #[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]707 #[derivative(Debug(format_with = "bounded::set_debug"))]708 pub OwnerRestrictedSetInner,709);710711impl OwnerRestrictedSet {712 713 pub fn new() -> Self {714 Self(Default::default())715 }716}717impl core::ops::Deref for OwnerRestrictedSet {718 type Target = OwnerRestrictedSetInner;719 fn deref(&self) -> &Self::Target {720 &self.0721 }722}723impl core::ops::DerefMut for OwnerRestrictedSet {724 fn deref_mut(&mut self) -> &mut Self::Target {725 &mut self.0726 }727}728729730#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]731#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]732#[derivative(Debug)]733pub struct NestingPermissions {734 735 pub token_owner: bool,736 737 pub collection_admin: bool,738 739 pub restricted: Option<OwnerRestrictedSet>,740741 #[cfg(feature = "runtime-benchmarks")]742 743 pub permissive: bool,744}745746747748749#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]750#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]751pub enum SponsoringRateLimit {752 753 SponsoringDisabled,754 755 Blocks(u32),756}757758759#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]760#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]761#[derivative(Debug)]762pub struct CreateNftData {763 764 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]765 #[derivative(Debug(format_with = "bounded::vec_debug"))]766 767 pub properties: CollectionPropertiesVec,768}769770771#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]772#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]773pub struct CreateFungibleData {774 775 pub value: u128,776}777778779#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]780#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]781#[derivative(Debug)]782pub struct CreateReFungibleData {783 784 pub pieces: u128,785786 787 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]788 #[derivative(Debug(format_with = "bounded::vec_debug"))]789 pub properties: CollectionPropertiesVec,790}791792793#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]794#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]795pub enum MetaUpdatePermission {796 ItemOwner,797 Admin,798 None,799}800801802803#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]804#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]805pub enum CreateItemData {806 807 NFT(CreateNftData),808 809 Fungible(CreateFungibleData),810 811 ReFungible(CreateReFungibleData),812}813814815#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]816#[derivative(Debug)]817pub struct CreateNftExData<CrossAccountId> {818 819 #[derivative(Debug(format_with = "bounded::vec_debug"))]820 pub properties: CollectionPropertiesVec,821822 823 pub owner: CrossAccountId,824}825826827#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]828#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]829pub struct CreateRefungibleExMultipleOwners<CrossAccountId> {830 #[derivative(Debug(format_with = "bounded::map_debug"))]831 pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,832 #[derivative(Debug(format_with = "bounded::vec_debug"))]833 pub properties: CollectionPropertiesVec,834}835836837#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]838#[derivative(Debug(bound = "CrossAccountId: fmt::Debug"))]839pub struct CreateRefungibleExSingleOwner<CrossAccountId> {840 pub user: CrossAccountId,841 pub pieces: u128,842 #[derivative(Debug(format_with = "bounded::vec_debug"))]843 pub properties: CollectionPropertiesVec,844}845846847#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]848#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]849pub enum CreateItemExData<CrossAccountId> {850 851 NFT(852 #[derivative(Debug(format_with = "bounded::vec_debug"))]853 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,854 ),855856 857 Fungible(858 #[derivative(Debug(format_with = "bounded::map_debug"))]859 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,860 ),861862 863 864 RefungibleMultipleItems(865 #[derivative(Debug(format_with = "bounded::vec_debug"))]866 BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,867 ),868869 870 871 RefungibleMultipleOwners(CreateRefungibleExMultipleOwners<CrossAccountId>),872}873874impl From<CreateNftData> for CreateItemData {875 fn from(item: CreateNftData) -> Self {876 CreateItemData::NFT(item)877 }878}879880impl From<CreateReFungibleData> for CreateItemData {881 fn from(item: CreateReFungibleData) -> Self {882 CreateItemData::ReFungible(item)883 }884}885886impl From<CreateFungibleData> for CreateItemData {887 fn from(item: CreateFungibleData) -> Self {888 CreateItemData::Fungible(item)889 }890}891892893#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]894#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]895896pub struct TokenChild {897 898 pub token: TokenId,899900 901 pub collection: CollectionId,902}903904905#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]906#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]907pub struct CollectionStats {908 909 pub created: u32,910911 912 pub destroyed: u32,913914 915 pub alive: u32,916}917918919#[derive(Encode, Decode, Clone, Debug)]920#[cfg_attr(feature = "std", derive(PartialEq))]921pub struct PhantomType<T>(core::marker::PhantomData<T>);922923impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {924 type Identity = PhantomType<T>;925926 fn type_info() -> scale_info::Type {927 use scale_info::{928 Type, Path,929 build::{FieldsBuilder, UnnamedFields},930 type_params,931 };932 Type::builder()933 .path(Path::new("up_data_structs", "PhantomType"))934 .type_params(type_params!(T))935 .composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))936 }937}938impl<T> MaxEncodedLen for PhantomType<T> {939 fn max_encoded_len() -> usize {940 0941 }942}943944945pub type BoundedBytes<S> = BoundedVec<u8, S>;946947948pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;949950951pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;952953954pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;955956957#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]958#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]959pub struct PropertyPermission {960 961 962 963 pub mutable: bool,964965 966 pub collection_admin: bool,967968 969 pub token_owner: bool,970}971972impl PropertyPermission {973 974 pub fn none() -> Self {975 Self {976 mutable: true,977 collection_admin: false,978 token_owner: false,979 }980 }981}982983984#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]985#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]986pub struct Property {987 988 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]989 pub key: PropertyKey,990991 992 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]993 pub value: PropertyValue,994}995996impl Into<(PropertyKey, PropertyValue)> for Property {997 fn into(self) -> (PropertyKey, PropertyValue) {998 (self.key, self.value)999 }1000}100110021003#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1004#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1005pub struct PropertyKeyPermission {1006 1007 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1008 pub key: PropertyKey,10091010 1011 pub permission: PropertyPermission,1012}10131014impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1015 fn into(self) -> (PropertyKey, PropertyPermission) {1016 (self.key, self.permission)1017 }1018}101910201021#[derive(Debug)]1022pub enum PropertiesError {1023 1024 1025 1026 1027 NoSpaceForProperty,10281029 1030 1031 1032 PropertyLimitReached,10331034 1035 InvalidCharacterInPropertyKey,10361037 1038 1039 1040 PropertyKeyIsTooLong,10411042 1043 EmptyPropertyKey,1044}10451046104710481049#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1050pub enum PropertyScope {1051 None,1052 Rmrk,1053 Eth,1054}10551056impl PropertyScope {1057 1058 pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {1059 let scope_str: &[u8] = match self {1060 Self::None => return Ok(key),1061 Self::Rmrk => b"rmrk",1062 Self::Eth => b"eth",1063 };10641065 [scope_str, b":", key.as_slice()]1066 .concat()1067 .try_into()1068 .map_err(|_| PropertiesError::PropertyKeyIsTooLong)1069 }1070}107110721073pub trait TrySetProperty: Sized {1074 type Value;10751076 1077 fn try_scoped_set(1078 &mut self,1079 scope: PropertyScope,1080 key: PropertyKey,1081 value: Self::Value,1082 ) -> Result<(), PropertiesError>;10831084 1085 fn try_scoped_set_from_iter<I, KV>(1086 &mut self,1087 scope: PropertyScope,1088 iter: I,1089 ) -> Result<(), PropertiesError>1090 where1091 I: Iterator<Item = KV>,1092 KV: Into<(PropertyKey, Self::Value)>,1093 {1094 for kv in iter {1095 let (key, value) = kv.into();1096 self.try_scoped_set(scope, key, value)?;1097 }10981099 Ok(())1100 }11011102 1103 fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {1104 self.try_scoped_set(PropertyScope::None, key, value)1105 }11061107 1108 fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>1109 where1110 I: Iterator<Item = KV>,1111 KV: Into<(PropertyKey, Self::Value)>,1112 {1113 self.try_scoped_set_from_iter(PropertyScope::None, iter)1114 }1115}111611171118#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]1119#[derivative(Default(bound = ""))]1120pub struct PropertiesMap<Value>(1121 BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,1122);11231124impl<Value> PropertiesMap<Value> {1125 1126 pub fn new() -> Self {1127 Self(BoundedBTreeMap::new())1128 }11291130 1131 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {1132 Self::check_property_key(key)?;11331134 Ok(self.0.remove(key))1135 }11361137 1138 pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1139 self.0.get(key)1140 }11411142 1143 pub fn contains_key(&self, key: &PropertyKey) -> bool {1144 self.0.contains_key(key)1145 }11461147 1148 fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {1149 if key.is_empty() {1150 return Err(PropertiesError::EmptyPropertyKey);1151 }11521153 for byte in key.as_slice().iter() {1154 let byte = *byte;11551156 if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {1157 return Err(PropertiesError::InvalidCharacterInPropertyKey);1158 }1159 }11601161 Ok(())1162 }1163}11641165impl<Value> IntoIterator for PropertiesMap<Value> {1166 type Item = (PropertyKey, Value);1167 type IntoIter = <1168 BoundedBTreeMap<1169 PropertyKey,1170 Value,1171 ConstU32<MAX_PROPERTIES_PER_ITEM>1172 > as IntoIterator1173 >::IntoIter;11741175 fn into_iter(self) -> Self::IntoIter {1176 self.0.into_iter()1177 }1178}11791180impl<Value> TrySetProperty for PropertiesMap<Value> {1181 type Value = Value;11821183 fn try_scoped_set(1184 &mut self,1185 scope: PropertyScope,1186 key: PropertyKey,1187 value: Self::Value,1188 ) -> Result<(), PropertiesError> {1189 Self::check_property_key(&key)?;11901191 let key = scope.apply(key)?;1192 self.01193 .try_insert(key, value)1194 .map_err(|_| PropertiesError::PropertyLimitReached)?;11951196 Ok(())1197 }1198}119912001201pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;120212031204#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1205pub struct Properties {1206 map: PropertiesMap<PropertyValue>,1207 consumed_space: u32,1208 space_limit: u32,1209}12101211impl Properties {1212 1213 pub fn new(space_limit: u32) -> Self {1214 Self {1215 map: PropertiesMap::new(),1216 consumed_space: 0,1217 space_limit,1218 }1219 }12201221 1222 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {1223 let value = self.map.remove(key)?;12241225 if let Some(ref value) = value {1226 let value_len = value.len() as u32;1227 self.consumed_space -= value_len;1228 }12291230 Ok(value)1231 }12321233 1234 pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {1235 self.map.get(key)1236 }1237}12381239impl IntoIterator for Properties {1240 type Item = (PropertyKey, PropertyValue);1241 type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;12421243 fn into_iter(self) -> Self::IntoIter {1244 self.map.into_iter()1245 }1246}12471248impl TrySetProperty for Properties {1249 type Value = PropertyValue;12501251 fn try_scoped_set(1252 &mut self,1253 scope: PropertyScope,1254 key: PropertyKey,1255 value: Self::Value,1256 ) -> Result<(), PropertiesError> {1257 let value_len = value.len();12581259 if self.consumed_space as usize + value_len > self.space_limit as usize1260 && !cfg!(feature = "runtime-benchmarks")1261 {1262 return Err(PropertiesError::NoSpaceForProperty);1263 }12641265 self.map.try_scoped_set(scope, key, value)?;12661267 self.consumed_space += value_len as u32;12681269 Ok(())1270 }1271}127212731274pub struct CollectionProperties;12751276impl Get<Properties> for CollectionProperties {1277 fn get() -> Properties {1278 Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)1279 }1280}128112821283pub struct TokenProperties;12841285impl Get<Properties> for TokenProperties {1286 fn get() -> Properties {1287 Properties::new(MAX_TOKEN_PROPERTIES_SIZE)1288 }1289}1290129112921293parameter_types! {1294 #[derive(PartialEq, TypeInfo)]1295 pub const RmrkStringLimit: u32 = 128;1296 #[derive(PartialEq)]1297 pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1298 #[derive(PartialEq)]1299 pub const RmrkResourceSymbolLimit: u32 = 10;1300 #[derive(PartialEq)]1301 pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1302 #[derive(PartialEq)]1303 pub const RmrkKeyLimit: u32 = 32;1304 #[derive(PartialEq)]1305 pub const RmrkValueLimit: u32 = 256;1306 #[derive(PartialEq)]1307 pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1308 #[derive(PartialEq)]1309 pub const MaxPropertiesPerTheme: u32 = 5;1310 #[derive(PartialEq)]1311 pub const RmrkPartsLimit: u32 = 25;1312 #[derive(PartialEq)]1313 pub const RmrkMaxPriorities: u32 = 25;1314 #[derive(PartialEq)]1315 pub const MaxResourcesOnMint: u32 = 100;1316}13171318impl From<RmrkCollectionId> for CollectionId {1319 fn from(id: RmrkCollectionId) -> Self {1320 Self(id)1321 }1322}13231324impl From<RmrkNftId> for TokenId {1325 fn from(id: RmrkNftId) -> Self {1326 Self(id)1327 }1328}13291330pub type RmrkCollectionInfo<AccountId> =1331 CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1332pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1333pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1334pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1335pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1336pub type BoundedEquippableCollectionIds =1337 BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1338pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1339pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1340pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1341pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1342pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1343pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;13441345pub type RmrkBasicResource = BasicResource<RmrkString>;1346pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1347pub type RmrkSlotResource = SlotResource<RmrkString>;13481349pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1350pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1351pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1352pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1353pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1354pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1355pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; 13561357pub type RmrkRpcString = Vec<u8>;1358pub type RmrkThemeName = RmrkRpcString;1359pub type RmrkPropertyKey = RmrkRpcString;