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 bondrewd::Bitfields;40use frame_support::{BoundedVec, traits::ConstU32};41use derivative::Derivative;42use scale_info::TypeInfo;434445use rmrk_traits::{46 CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme, ThemeProperty,47 ResourceTypes, BasicResource, ComposableResource, SlotResource, EquippableList,48};49pub use rmrk_traits::{50 primitives::{51 CollectionId as RmrkCollectionId, NftId as RmrkNftId, BaseId as RmrkBaseId,52 SlotId as RmrkSlotId, PartId as RmrkPartId, ResourceId as RmrkResourceId,53 },54 NftChild as RmrkNftChild, AccountIdOrCollectionNftTuple as RmrkAccountIdOrCollectionNftTuple,55 FixedPart as RmrkFixedPart, SlotPart as RmrkSlotPart,56};5758mod bondrewd_codec;59mod bounded;60pub mod budget;61pub mod mapping;62mod migration;636465pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;666768pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;69pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;707172pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {73 100_00074} else {75 1076};777879pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {80 100_00081} else {82 1083};848586pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {87 204888} else {89 1090};919293pub const COLLECTION_ADMINS_LIMIT: u32 = 5;949596pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;979899pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {100 1_000_000101} else {102 10103};104105106pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;107108pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;109110pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;111112113pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;114115116pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;117pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;118pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;119120121pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;122123124pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;125126127pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;128129130pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;131132133pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;134135136pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;137138139pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;140141142pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;143144145pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;146147148pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;149150151152pub const MAX_ITEMS_PER_BATCH: u32 = 200;153154155pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;156157158#[derive(159 Encode,160 Decode,161 PartialEq,162 Eq,163 PartialOrd,164 Ord,165 Clone,166 Copy,167 Debug,168 Default,169 TypeInfo,170 MaxEncodedLen,171)]172#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]173pub struct CollectionId(pub u32);174impl EncodeLike<u32> for CollectionId {}175impl EncodeLike<CollectionId> for u32 {}176177178#[derive(179 Encode,180 Decode,181 PartialEq,182 Eq,183 PartialOrd,184 Ord,185 Clone,186 Copy,187 Debug,188 Default,189 TypeInfo,190 MaxEncodedLen,191)]192#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]193pub struct TokenId(pub u32);194impl EncodeLike<u32> for TokenId {}195impl EncodeLike<TokenId> for u32 {}196197impl TokenId {198 199 200 201 pub fn try_next(self) -> Result<TokenId, ArithmeticError> {202 self.0203 .checked_add(1)204 .ok_or(ArithmeticError::Overflow)205 .map(Self)206 }207}208209impl From<TokenId> for U256 {210 fn from(t: TokenId) -> Self {211 t.0.into()212 }213}214215impl TryFrom<U256> for TokenId {216 type Error = &'static str;217218 fn try_from(value: U256) -> Result<Self, Self::Error> {219 Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))220 }221}222223224#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]225#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]226pub struct TokenData<CrossAccountId> {227 228 pub properties: Vec<Property>,229230 231 pub owner: Option<CrossAccountId>,232233 234 pub pieces: u128,235}236237238pub struct OverflowError;239impl From<OverflowError> for &'static str {240 fn from(_: OverflowError) -> Self {241 "overflow occured"242 }243}244245246pub type DecimalPoints = u8;247248249250251252253#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]254#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]255pub enum CollectionMode {256 257 NFT,258 259 Fungible(DecimalPoints),260 261 ReFungible,262}263264impl CollectionMode {265 266 pub fn id(&self) -> u8 {267 match self {268 CollectionMode::NFT => 1,269 CollectionMode::Fungible(_) => 2,270 CollectionMode::ReFungible => 3,271 }272 }273}274275276pub trait SponsoringResolve<AccountId, Call> {277 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;278}279280281#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]282#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]283pub enum AccessMode {284 285 Normal,286 287 AllowList,288}289impl Default for AccessMode {290 fn default() -> Self {291 Self::Normal292 }293}294295296#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]297#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]298pub enum SchemaVersion {299 ImageURL,300 Unique,301}302impl Default for SchemaVersion {303 fn default() -> Self {304 Self::ImageURL305 }306}307308309#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]310#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]311pub struct Ownership<AccountId> {312 pub owner: AccountId,313 pub fraction: u128,314}315316317#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]318#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]319pub enum SponsorshipState<AccountId> {320 321 Disabled,322 323 324 Unconfirmed(AccountId),325 326 Confirmed(AccountId),327}328329impl<AccountId> SponsorshipState<AccountId> {330 331 pub fn sponsor(&self) -> Option<&AccountId> {332 match self {333 Self::Confirmed(sponsor) => Some(sponsor),334 _ => None,335 }336 }337338 339 pub fn pending_sponsor(&self) -> Option<&AccountId> {340 match self {341 Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),342 _ => None,343 }344 }345346 347 pub fn confirmed(&self) -> bool {348 matches!(self, Self::Confirmed(_))349 }350}351352impl<T> Default for SponsorshipState<T> {353 fn default() -> Self {354 Self::Disabled355 }356}357358pub type CollectionName = BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>;359pub type CollectionDescription = BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>;360pub type CollectionTokenPrefix = BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>;361362#[derive(Bitfields, Clone, Copy, PartialEq, Eq, Debug, Default)]363#[bondrewd(enforce_bytes = 1)]364pub struct CollectionFlags {365 366 #[bondrewd(bits = "0..1")]367 pub foreign: bool,368 369 #[bondrewd(bits = "7..8")]370 pub external: bool,371372 #[bondrewd(reserve, bits = "1..7")]373 pub reserved: u8,374}375bondrewd_codec!(CollectionFlags);376377378379380381382383#[struct_versioning::versioned(version = 2, upper)]384#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]385pub struct Collection<AccountId> {386 387 pub owner: AccountId,388389 390 pub mode: CollectionMode,391392 393 #[version(..2)]394 pub access: AccessMode,395396 397 pub name: CollectionName,398399 400 pub description: CollectionDescription,401402 403 pub token_prefix: CollectionTokenPrefix,404405 #[version(..2)]406 pub mint_mode: bool,407408 #[version(..2)]409 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,410411 #[version(..2)]412 pub schema_version: SchemaVersion,413414 415 pub sponsorship: SponsorshipState<AccountId>,416417 418 pub limits: CollectionLimits,419420 421 #[version(2.., upper(Default::default()))]422 pub permissions: CollectionPermissions,423424 #[version(2.., upper(Default::default()))]425 pub flags: CollectionFlags,426427 #[version(..2)]428 pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,429430 #[version(..2)]431 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,432433 #[version(..2)]434 pub meta_update_permission: MetaUpdatePermission,435}436437438#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]439#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]440pub struct RpcCollection<AccountId> {441 442 pub owner: AccountId,443444 445 pub mode: CollectionMode,446447 448 pub name: Vec<u16>,449450 451 pub description: Vec<u16>,452453 454 pub token_prefix: Vec<u8>,455456 457 pub sponsorship: SponsorshipState<AccountId>,458459 460 pub limits: CollectionLimits,461462 463 pub permissions: CollectionPermissions,464465 466 pub token_property_permissions: Vec<PropertyKeyPermission>,467468 469 pub properties: Vec<Property>,470471 472 pub read_only: bool,473474 475 pub foreign: bool,476}477478479480481#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]482#[derivative(Debug, Default(bound = ""))]483pub struct CreateCollectionData<AccountId> {484 485 #[derivative(Default(value = "CollectionMode::NFT"))]486 pub mode: CollectionMode,487488 489 pub access: Option<AccessMode>,490491 492 pub name: CollectionName,493494 495 pub description: CollectionDescription,496497 498 pub token_prefix: CollectionTokenPrefix,499500 501 pub pending_sponsor: Option<AccountId>,502503 504 pub limits: Option<CollectionLimits>,505506 507 pub permissions: Option<CollectionPermissions>,508509 510 pub token_property_permissions: CollectionPropertiesPermissionsVec,511512 513 pub properties: CollectionPropertiesVec,514}515516517518pub type CollectionPropertiesPermissionsVec =519 BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;520521522pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;523524525526527528529530#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]531#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]532533534535pub struct CollectionLimits {536 537 538 539 pub account_token_ownership_limit: Option<u32>,540541 542 543 544 pub sponsored_data_size: Option<u32>,545546 547 548 549 550 551 552 553 554 555 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,556 557558 559 560 561 562 pub token_limit: Option<u32>,563564 565 566 567 568 569 570 571 pub sponsor_transfer_timeout: Option<u32>,572573 574 575 576 577 pub sponsor_approve_timeout: Option<u32>,578579 580 581 582 pub owner_can_transfer: Option<bool>,583584 585 586 587 pub owner_can_destroy: Option<bool>,588589 590 591 592 pub transfers_enabled: Option<bool>,593}594595impl CollectionLimits {596 597 pub fn account_token_ownership_limit(&self) -> u32 {598 self.account_token_ownership_limit599 .unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)600 .min(MAX_TOKEN_OWNERSHIP)601 }602603 604 pub fn sponsored_data_size(&self) -> u32 {605 self.sponsored_data_size606 .unwrap_or(CUSTOM_DATA_LIMIT)607 .min(CUSTOM_DATA_LIMIT)608 }609610 611 pub fn token_limit(&self) -> u32 {612 self.token_limit613 .unwrap_or(COLLECTION_TOKEN_LIMIT)614 .min(COLLECTION_TOKEN_LIMIT)615 }616617 618 619 pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {620 self.sponsor_transfer_timeout621 .unwrap_or(default)622 .min(MAX_SPONSOR_TIMEOUT)623 }624625 626 pub fn sponsor_approve_timeout(&self) -> u32 {627 self.sponsor_approve_timeout628 .unwrap_or(SPONSOR_APPROVE_TIMEOUT)629 .min(MAX_SPONSOR_TIMEOUT)630 }631632 633 pub fn owner_can_transfer(&self) -> bool {634 self.owner_can_transfer.unwrap_or(false)635 }636637 638 pub fn owner_can_transfer_instaled(&self) -> bool {639 self.owner_can_transfer.is_some()640 }641642 643 pub fn owner_can_destroy(&self) -> bool {644 self.owner_can_destroy.unwrap_or(true)645 }646647 648 pub fn transfers_enabled(&self) -> bool {649 self.transfers_enabled.unwrap_or(true)650 }651652 653 pub fn sponsored_data_rate_limit(&self) -> Option<u32> {654 match self655 .sponsored_data_rate_limit656 .unwrap_or(SponsoringRateLimit::SponsoringDisabled)657 {658 SponsoringRateLimit::SponsoringDisabled => None,659 SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),660 }661 }662}663664665666667668669#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]670#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]671672673pub struct CollectionPermissions {674 675 676 677 pub access: Option<AccessMode>,678679 680 681 682 pub mint_mode: Option<bool>,683684 685 686 687 688 689 690 pub nesting: Option<NestingPermissions>,691}692693impl CollectionPermissions {694 695 pub fn access(&self) -> AccessMode {696 self.access.unwrap_or(AccessMode::Normal)697 }698699 700 pub fn mint_mode(&self) -> bool {701 self.mint_mode.unwrap_or(false)702 }703704 705 pub fn nesting(&self) -> &NestingPermissions {706 static DEFAULT: NestingPermissions = NestingPermissions {707 token_owner: false,708 collection_admin: false,709 restricted: None,710 #[cfg(feature = "runtime-benchmarks")]711 permissive: false,712 };713 self.nesting.as_ref().unwrap_or(&DEFAULT)714 }715}716717718type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;719720721#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]722#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]723#[derivative(Debug)]724pub struct OwnerRestrictedSet(725 #[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]726 #[derivative(Debug(format_with = "bounded::set_debug"))]727 pub OwnerRestrictedSetInner,728);729730impl OwnerRestrictedSet {731 732 pub fn new() -> Self {733 Self(Default::default())734 }735}736impl core::ops::Deref for OwnerRestrictedSet {737 type Target = OwnerRestrictedSetInner;738 fn deref(&self) -> &Self::Target {739 &self.0740 }741}742impl core::ops::DerefMut for OwnerRestrictedSet {743 fn deref_mut(&mut self) -> &mut Self::Target {744 &mut self.0745 }746}747748749#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]750#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]751#[derivative(Debug)]752pub struct NestingPermissions {753 754 pub token_owner: bool,755 756 pub collection_admin: bool,757 758 pub restricted: Option<OwnerRestrictedSet>,759760 #[cfg(feature = "runtime-benchmarks")]761 762 pub permissive: bool,763}764765766767768#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]769#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]770pub enum SponsoringRateLimit {771 772 SponsoringDisabled,773 774 Blocks(u32),775}776777778#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]779#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]780#[derivative(Debug)]781pub struct CreateNftData {782 783 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]784 #[derivative(Debug(format_with = "bounded::vec_debug"))]785 786 pub properties: CollectionPropertiesVec,787}788789790#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]791#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]792pub struct CreateFungibleData {793 794 pub value: u128,795}796797798#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]799#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]800#[derivative(Debug)]801pub struct CreateReFungibleData {802 803 pub pieces: u128,804805 806 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]807 #[derivative(Debug(format_with = "bounded::vec_debug"))]808 pub properties: CollectionPropertiesVec,809}810811812#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]813#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]814pub enum MetaUpdatePermission {815 ItemOwner,816 Admin,817 None,818}819820821822#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]823#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]824pub enum CreateItemData {825 826 NFT(CreateNftData),827 828 Fungible(CreateFungibleData),829 830 ReFungible(CreateReFungibleData),831}832833834#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]835#[derivative(Debug)]836pub struct CreateNftExData<CrossAccountId> {837 838 #[derivative(Debug(format_with = "bounded::vec_debug"))]839 pub properties: CollectionPropertiesVec,840841 842 pub owner: CrossAccountId,843}844845846#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]847#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]848pub struct CreateRefungibleExMultipleOwners<CrossAccountId> {849 #[derivative(Debug(format_with = "bounded::map_debug"))]850 pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,851 #[derivative(Debug(format_with = "bounded::vec_debug"))]852 pub properties: CollectionPropertiesVec,853}854855856#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]857#[derivative(Debug(bound = "CrossAccountId: fmt::Debug"))]858pub struct CreateRefungibleExSingleOwner<CrossAccountId> {859 pub user: CrossAccountId,860 pub pieces: u128,861 #[derivative(Debug(format_with = "bounded::vec_debug"))]862 pub properties: CollectionPropertiesVec,863}864865866#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]867#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]868pub enum CreateItemExData<CrossAccountId> {869 870 NFT(871 #[derivative(Debug(format_with = "bounded::vec_debug"))]872 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,873 ),874875 876 Fungible(877 #[derivative(Debug(format_with = "bounded::map_debug"))]878 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,879 ),880881 882 883 RefungibleMultipleItems(884 #[derivative(Debug(format_with = "bounded::vec_debug"))]885 BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,886 ),887888 889 890 RefungibleMultipleOwners(CreateRefungibleExMultipleOwners<CrossAccountId>),891}892893impl From<CreateNftData> for CreateItemData {894 fn from(item: CreateNftData) -> Self {895 CreateItemData::NFT(item)896 }897}898899impl From<CreateReFungibleData> for CreateItemData {900 fn from(item: CreateReFungibleData) -> Self {901 CreateItemData::ReFungible(item)902 }903}904905impl From<CreateFungibleData> for CreateItemData {906 fn from(item: CreateFungibleData) -> Self {907 CreateItemData::Fungible(item)908 }909}910911912#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]913#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]914915pub struct TokenChild {916 917 pub token: TokenId,918919 920 pub collection: CollectionId,921}922923924#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]925#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]926pub struct CollectionStats {927 928 pub created: u32,929930 931 pub destroyed: u32,932933 934 pub alive: u32,935}936937938#[derive(Encode, Decode, Clone, Debug)]939#[cfg_attr(feature = "std", derive(PartialEq))]940pub struct PhantomType<T>(core::marker::PhantomData<T>);941942impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {943 type Identity = PhantomType<T>;944945 fn type_info() -> scale_info::Type {946 use scale_info::{947 Type, Path,948 build::{FieldsBuilder, UnnamedFields},949 type_params,950 };951 Type::builder()952 .path(Path::new("up_data_structs", "PhantomType"))953 .type_params(type_params!(T))954 .composite(<FieldsBuilder<UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()))955 }956}957impl<T> MaxEncodedLen for PhantomType<T> {958 fn max_encoded_len() -> usize {959 0960 }961}962963964pub type BoundedBytes<S> = BoundedVec<u8, S>;965966967pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;968969970pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;971972973pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;974975976#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]977#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]978pub struct PropertyPermission {979 980 981 982 pub mutable: bool,983984 985 pub collection_admin: bool,986987 988 pub token_owner: bool,989}990991impl PropertyPermission {992 993 pub fn none() -> Self {994 Self {995 mutable: true,996 collection_admin: false,997 token_owner: false,998 }999 }1000}100110021003#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1004#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1005pub struct Property {1006 1007 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1008 pub key: PropertyKey,10091010 1011 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1012 pub value: PropertyValue,1013}10141015impl Into<(PropertyKey, PropertyValue)> for Property {1016 fn into(self) -> (PropertyKey, PropertyValue) {1017 (self.key, self.value)1018 }1019}102010211022#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1023#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1024pub struct PropertyKeyPermission {1025 1026 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1027 pub key: PropertyKey,10281029 1030 pub permission: PropertyPermission,1031}10321033impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1034 fn into(self) -> (PropertyKey, PropertyPermission) {1035 (self.key, self.permission)1036 }1037}103810391040#[derive(Debug)]1041pub enum PropertiesError {1042 1043 1044 1045 1046 NoSpaceForProperty,10471048 1049 1050 1051 PropertyLimitReached,10521053 1054 InvalidCharacterInPropertyKey,10551056 1057 1058 1059 PropertyKeyIsTooLong,10601061 1062 EmptyPropertyKey,1063}10641065106610671068#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1069pub enum PropertyScope {1070 None,1071 Rmrk,1072}10731074impl PropertyScope {1075 1076 pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {1077 let scope_str: &[u8] = match self {1078 Self::None => return Ok(key),1079 Self::Rmrk => b"rmrk",1080 };10811082 [scope_str, b":", key.as_slice()]1083 .concat()1084 .try_into()1085 .map_err(|_| PropertiesError::PropertyKeyIsTooLong)1086 }1087}108810891090pub trait TrySetProperty: Sized {1091 type Value;10921093 1094 fn try_scoped_set(1095 &mut self,1096 scope: PropertyScope,1097 key: PropertyKey,1098 value: Self::Value,1099 ) -> Result<(), PropertiesError>;11001101 1102 fn try_scoped_set_from_iter<I, KV>(1103 &mut self,1104 scope: PropertyScope,1105 iter: I,1106 ) -> Result<(), PropertiesError>1107 where1108 I: Iterator<Item = KV>,1109 KV: Into<(PropertyKey, Self::Value)>,1110 {1111 for kv in iter {1112 let (key, value) = kv.into();1113 self.try_scoped_set(scope, key, value)?;1114 }11151116 Ok(())1117 }11181119 1120 fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {1121 self.try_scoped_set(PropertyScope::None, key, value)1122 }11231124 1125 fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>1126 where1127 I: Iterator<Item = KV>,1128 KV: Into<(PropertyKey, Self::Value)>,1129 {1130 self.try_scoped_set_from_iter(PropertyScope::None, iter)1131 }1132}113311341135#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]1136#[derivative(Default(bound = ""))]1137pub struct PropertiesMap<Value>(1138 BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,1139);11401141impl<Value> PropertiesMap<Value> {1142 1143 pub fn new() -> Self {1144 Self(BoundedBTreeMap::new())1145 }11461147 1148 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {1149 Self::check_property_key(key)?;11501151 Ok(self.0.remove(key))1152 }11531154 1155 pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1156 self.0.get(key)1157 }11581159 1160 pub fn contains_key(&self, key: &PropertyKey) -> bool {1161 self.0.contains_key(key)1162 }11631164 1165 fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {1166 if key.is_empty() {1167 return Err(PropertiesError::EmptyPropertyKey);1168 }11691170 for byte in key.as_slice().iter() {1171 let byte = *byte;11721173 if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {1174 return Err(PropertiesError::InvalidCharacterInPropertyKey);1175 }1176 }11771178 Ok(())1179 }1180}11811182impl<Value> IntoIterator for PropertiesMap<Value> {1183 type Item = (PropertyKey, Value);1184 type IntoIter = <1185 BoundedBTreeMap<1186 PropertyKey,1187 Value,1188 ConstU32<MAX_PROPERTIES_PER_ITEM>1189 > as IntoIterator1190 >::IntoIter;11911192 fn into_iter(self) -> Self::IntoIter {1193 self.0.into_iter()1194 }1195}11961197impl<Value> TrySetProperty for PropertiesMap<Value> {1198 type Value = Value;11991200 fn try_scoped_set(1201 &mut self,1202 scope: PropertyScope,1203 key: PropertyKey,1204 value: Self::Value,1205 ) -> Result<(), PropertiesError> {1206 Self::check_property_key(&key)?;12071208 let key = scope.apply(key)?;1209 self.01210 .try_insert(key, value)1211 .map_err(|_| PropertiesError::PropertyLimitReached)?;12121213 Ok(())1214 }1215}121612171218pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;121912201221#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1222pub struct Properties {1223 map: PropertiesMap<PropertyValue>,1224 consumed_space: u32,1225 space_limit: u32,1226}12271228impl Properties {1229 1230 pub fn new(space_limit: u32) -> Self {1231 Self {1232 map: PropertiesMap::new(),1233 consumed_space: 0,1234 space_limit,1235 }1236 }12371238 1239 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {1240 let value = self.map.remove(key)?;12411242 if let Some(ref value) = value {1243 let value_len = value.len() as u32;1244 self.consumed_space -= value_len;1245 }12461247 Ok(value)1248 }12491250 1251 pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {1252 self.map.get(key)1253 }1254}12551256impl IntoIterator for Properties {1257 type Item = (PropertyKey, PropertyValue);1258 type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;12591260 fn into_iter(self) -> Self::IntoIter {1261 self.map.into_iter()1262 }1263}12641265impl TrySetProperty for Properties {1266 type Value = PropertyValue;12671268 fn try_scoped_set(1269 &mut self,1270 scope: PropertyScope,1271 key: PropertyKey,1272 value: Self::Value,1273 ) -> Result<(), PropertiesError> {1274 let value_len = value.len();12751276 if self.consumed_space as usize + value_len > self.space_limit as usize1277 && !cfg!(feature = "runtime-benchmarks")1278 {1279 return Err(PropertiesError::NoSpaceForProperty);1280 }12811282 self.map.try_scoped_set(scope, key, value)?;12831284 self.consumed_space += value_len as u32;12851286 Ok(())1287 }1288}128912901291pub struct CollectionProperties;12921293impl Get<Properties> for CollectionProperties {1294 fn get() -> Properties {1295 Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)1296 }1297}129812991300pub struct TokenProperties;13011302impl Get<Properties> for TokenProperties {1303 fn get() -> Properties {1304 Properties::new(MAX_TOKEN_PROPERTIES_SIZE)1305 }1306}1307130813091310parameter_types! {1311 #[derive(PartialEq, TypeInfo)]1312 pub const RmrkStringLimit: u32 = 128;1313 #[derive(PartialEq)]1314 pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1315 #[derive(PartialEq)]1316 pub const RmrkResourceSymbolLimit: u32 = 10;1317 #[derive(PartialEq)]1318 pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1319 #[derive(PartialEq)]1320 pub const RmrkKeyLimit: u32 = 32;1321 #[derive(PartialEq)]1322 pub const RmrkValueLimit: u32 = 256;1323 #[derive(PartialEq)]1324 pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1325 #[derive(PartialEq)]1326 pub const MaxPropertiesPerTheme: u32 = 5;1327 #[derive(PartialEq)]1328 pub const RmrkPartsLimit: u32 = 25;1329 #[derive(PartialEq)]1330 pub const RmrkMaxPriorities: u32 = 25;1331 #[derive(PartialEq)]1332 pub const MaxResourcesOnMint: u32 = 100;1333}13341335impl From<RmrkCollectionId> for CollectionId {1336 fn from(id: RmrkCollectionId) -> Self {1337 Self(id)1338 }1339}13401341impl From<RmrkNftId> for TokenId {1342 fn from(id: RmrkNftId) -> Self {1343 Self(id)1344 }1345}13461347pub type RmrkCollectionInfo<AccountId> =1348 CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1349pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1350pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1351pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1352pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1353pub type BoundedEquippableCollectionIds =1354 BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1355pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1356pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1357pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1358pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1359pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1360pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;13611362pub type RmrkBasicResource = BasicResource<RmrkString>;1363pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1364pub type RmrkSlotResource = SlotResource<RmrkString>;13651366pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1367pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1368pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1369pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1370pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1371pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1372pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; 13731374pub type RmrkRpcString = Vec<u8>;1375pub type RmrkThemeName = RmrkRpcString;1376pub type RmrkPropertyKey = RmrkRpcString;