123456789101112131415161718192021#![cfg_attr(not(feature = "std"), no_std)]2223use core::{24 convert::{TryFrom, TryInto},25 fmt,26};27use frame_support::storage::{bounded_btree_map::BoundedBTreeMap, bounded_btree_set::BoundedBTreeSet};2829#[cfg(feature = "serde")]30use serde::{Serialize, Deserialize};3132use sp_core::U256;33use sp_runtime::{ArithmeticError, sp_std::prelude::Vec};34use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};35use bondrewd::Bitfields;36use frame_support::{BoundedVec, traits::ConstU32};37use derivative::Derivative;38use scale_info::TypeInfo;3940mod bondrewd_codec;41mod bounded;42pub mod budget;43pub mod mapping;44mod migration;454647pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;484950pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;51pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;525354pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {55 100_00056} else {57 1058};596061pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {62 100_00063} else {64 1065};666768pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {69 204870} else {71 1072};737475pub const COLLECTION_ADMINS_LIMIT: u32 = 5;767778pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;798081pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {82 1_000_00083} else {84 1085};868788pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;8990pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;9192pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;939495pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;969798pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;99pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;100pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;101102103pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;104105106pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;107108109pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;110111112pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;113114115pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;116117118pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;119120121pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;122123124pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;125126127pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;128129130pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;131132133134pub const MAX_ITEMS_PER_BATCH: u32 = 200;135136137pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;138139140#[derive(141 Encode,142 Decode,143 PartialEq,144 Eq,145 PartialOrd,146 Ord,147 Clone,148 Copy,149 Debug,150 Default,151 TypeInfo,152 MaxEncodedLen,153)]154#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]155pub struct CollectionId(pub u32);156impl EncodeLike<u32> for CollectionId {}157impl EncodeLike<CollectionId> for u32 {}158159impl From<u32> for CollectionId {160 fn from(value: u32) -> Self {161 Self(value)162 }163}164165166#[derive(167 Encode,168 Decode,169 PartialEq,170 Eq,171 PartialOrd,172 Ord,173 Clone,174 Copy,175 Debug,176 Default,177 TypeInfo,178 MaxEncodedLen,179)]180#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]181pub struct TokenId(pub u32);182impl EncodeLike<u32> for TokenId {}183impl EncodeLike<TokenId> for u32 {}184185impl TokenId {186 187 188 189 pub fn try_next(self) -> Result<TokenId, ArithmeticError> {190 self.0191 .checked_add(1)192 .ok_or(ArithmeticError::Overflow)193 .map(Self)194 }195}196197impl From<TokenId> for U256 {198 fn from(t: TokenId) -> Self {199 t.0.into()200 }201}202203impl TryFrom<U256> for TokenId {204 type Error = &'static str;205206 fn try_from(value: U256) -> Result<Self, Self::Error> {207 Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))208 }209}210211212#[struct_versioning::versioned(version = 2, upper)]213#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]214#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]215pub struct TokenData<CrossAccountId> {216 217 pub properties: Vec<Property>,218219 220 pub owner: Option<CrossAccountId>,221222 223 #[version(2.., upper(0))]224 pub pieces: u128,225}226227228pub struct OverflowError;229impl From<OverflowError> for &'static str {230 fn from(_: OverflowError) -> Self {231 "overflow occured"232 }233}234235236pub type DecimalPoints = u8;237238239240241242243#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]244#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]245pub enum CollectionMode {246 247 NFT,248 249 Fungible(DecimalPoints),250 251 ReFungible,252}253254impl CollectionMode {255 256 pub fn id(&self) -> u8 {257 match self {258 CollectionMode::NFT => 1,259 CollectionMode::Fungible(_) => 2,260 CollectionMode::ReFungible => 3,261 }262 }263}264265266pub trait SponsoringResolve<AccountId, Call> {267 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;268}269270271#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]272#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]273pub enum AccessMode {274 275 Normal,276 277 AllowList,278}279impl Default for AccessMode {280 fn default() -> Self {281 Self::Normal282 }283}284285286#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]287#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]288pub enum SchemaVersion {289 ImageURL,290 Unique,291}292impl Default for SchemaVersion {293 fn default() -> Self {294 Self::ImageURL295 }296}297298299#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]300#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]301pub struct Ownership<AccountId> {302 pub owner: AccountId,303 pub fraction: u128,304}305306307#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]308#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]309pub enum SponsorshipState<AccountId> {310 311 Disabled,312 313 314 Unconfirmed(AccountId),315 316 Confirmed(AccountId),317}318319impl<AccountId> SponsorshipState<AccountId> {320 321 pub fn sponsor(&self) -> Option<&AccountId> {322 match self {323 Self::Confirmed(sponsor) => Some(sponsor),324 _ => None,325 }326 }327328 329 pub fn pending_sponsor(&self) -> Option<&AccountId> {330 match self {331 Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),332 _ => None,333 }334 }335336 337 pub fn confirmed(&self) -> bool {338 matches!(self, Self::Confirmed(_))339 }340}341342impl<T> Default for SponsorshipState<T> {343 fn default() -> Self {344 Self::Disabled345 }346}347348pub type CollectionName = BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>;349pub type CollectionDescription = BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>;350pub type CollectionTokenPrefix = BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>;351352#[derive(Bitfields, Clone, Copy, PartialEq, Eq, Debug, Default)]353#[bondrewd(enforce_bytes = 1)]354pub struct CollectionFlags {355 356 #[bondrewd(bits = "0..1")]357 pub foreign: bool,358 359 #[bondrewd(bits = "1..2")]360 pub erc721metadata: bool,361 362 #[bondrewd(bits = "7..8")]363 pub external: bool,364365 #[bondrewd(reserve, bits = "2..7")]366 pub reserved: u8,367}368bondrewd_codec!(CollectionFlags);369370371372373374375376#[struct_versioning::versioned(version = 2, upper)]377#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]378pub struct Collection<AccountId> {379 380 pub owner: AccountId,381382 383 pub mode: CollectionMode,384385 386 #[version(..2)]387 pub access: AccessMode,388389 390 pub name: CollectionName,391392 393 pub description: CollectionDescription,394395 396 pub token_prefix: CollectionTokenPrefix,397398 #[version(..2)]399 pub mint_mode: bool,400401 #[version(..2)]402 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,403404 #[version(..2)]405 pub schema_version: SchemaVersion,406407 408 pub sponsorship: SponsorshipState<AccountId>,409410 411 pub limits: CollectionLimits,412413 414 #[version(2.., upper(Default::default()))]415 pub permissions: CollectionPermissions,416417 #[version(2.., upper(Default::default()))]418 pub flags: CollectionFlags,419420 #[version(..2)]421 pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,422423 #[version(..2)]424 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,425426 #[version(..2)]427 pub meta_update_permission: MetaUpdatePermission,428}429430#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]431#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]432pub struct RpcCollectionFlags {433 434 pub foreign: bool,435 436 pub erc721metadata: bool,437}438439440#[struct_versioning::versioned(version = 2, upper)]441#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]442#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]443pub struct RpcCollection<AccountId> {444 445 pub owner: AccountId,446447 448 pub mode: CollectionMode,449450 451 pub name: Vec<u16>,452453 454 pub description: Vec<u16>,455456 457 pub token_prefix: Vec<u8>,458459 460 pub sponsorship: SponsorshipState<AccountId>,461462 463 pub limits: CollectionLimits,464465 466 pub permissions: CollectionPermissions,467468 469 pub token_property_permissions: Vec<PropertyKeyPermission>,470471 472 pub properties: Vec<Property>,473474 475 pub read_only: bool,476477 478 #[version(2.., upper(RpcCollectionFlags {foreign: false, erc721metadata: false}))]479 pub flags: RpcCollectionFlags,480}481482483484485#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]486#[derivative(Debug, Default(bound = ""))]487pub struct CreateCollectionData<AccountId> {488 489 #[derivative(Default(value = "CollectionMode::NFT"))]490 pub mode: CollectionMode,491492 493 pub access: Option<AccessMode>,494495 496 pub name: CollectionName,497498 499 pub description: CollectionDescription,500501 502 pub token_prefix: CollectionTokenPrefix,503504 505 pub pending_sponsor: Option<AccountId>,506507 508 pub limits: Option<CollectionLimits>,509510 511 pub permissions: Option<CollectionPermissions>,512513 514 pub token_property_permissions: CollectionPropertiesPermissionsVec,515516 517 pub properties: CollectionPropertiesVec,518}519520521522pub type CollectionPropertiesPermissionsVec =523 BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;524525526pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;527528529530531532533534#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]535#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]536537538539pub struct CollectionLimits {540 541 542 543 pub account_token_ownership_limit: Option<u32>,544545 546 547 548 pub sponsored_data_size: Option<u32>,549550 551 552 553 554 555 556 557 558 559 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,560 561562 563 564 565 566 pub token_limit: Option<u32>,567568 569 570 571 572 573 574 575 pub sponsor_transfer_timeout: Option<u32>,576577 578 579 580 581 pub sponsor_approve_timeout: Option<u32>,582583 584 585 586 pub owner_can_transfer: Option<bool>,587588 589 590 591 pub owner_can_destroy: Option<bool>,592593 594 595 596 pub transfers_enabled: Option<bool>,597}598599impl CollectionLimits {600 pub fn with_default_limits(collection_type: CollectionMode) -> Self {601 CollectionLimits {602 account_token_ownership_limit: Some(ACCOUNT_TOKEN_OWNERSHIP_LIMIT),603 sponsored_data_size: Some(CUSTOM_DATA_LIMIT),604 sponsored_data_rate_limit: Some(SponsoringRateLimit::SponsoringDisabled),605 token_limit: Some(COLLECTION_TOKEN_LIMIT),606 sponsor_transfer_timeout: match collection_type {607 CollectionMode::NFT => Some(NFT_SPONSOR_TRANSFER_TIMEOUT),608 CollectionMode::ReFungible => Some(REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT),609 CollectionMode::Fungible(_) => Some(FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT),610 },611 sponsor_approve_timeout: Some(SPONSOR_APPROVE_TIMEOUT),612 owner_can_transfer: Some(false),613 owner_can_destroy: Some(true),614 transfers_enabled: Some(true),615 }616 }617618 619 pub fn account_token_ownership_limit(&self) -> u32 {620 self.account_token_ownership_limit621 .unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)622 .min(MAX_TOKEN_OWNERSHIP)623 }624625 626 pub fn sponsored_data_size(&self) -> u32 {627 self.sponsored_data_size628 .unwrap_or(CUSTOM_DATA_LIMIT)629 .min(CUSTOM_DATA_LIMIT)630 }631632 633 pub fn token_limit(&self) -> u32 {634 self.token_limit635 .unwrap_or(COLLECTION_TOKEN_LIMIT)636 .min(COLLECTION_TOKEN_LIMIT)637 }638639 640 641 pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {642 self.sponsor_transfer_timeout643 .unwrap_or(default)644 .min(MAX_SPONSOR_TIMEOUT)645 }646647 648 pub fn sponsor_approve_timeout(&self) -> u32 {649 self.sponsor_approve_timeout650 .unwrap_or(SPONSOR_APPROVE_TIMEOUT)651 .min(MAX_SPONSOR_TIMEOUT)652 }653654 655 pub fn owner_can_transfer(&self) -> bool {656 self.owner_can_transfer.unwrap_or(false)657 }658659 660 pub fn owner_can_transfer_instaled(&self) -> bool {661 self.owner_can_transfer.is_some()662 }663664 665 pub fn owner_can_destroy(&self) -> bool {666 self.owner_can_destroy.unwrap_or(true)667 }668669 670 pub fn transfers_enabled(&self) -> bool {671 self.transfers_enabled.unwrap_or(true)672 }673674 675 pub fn sponsored_data_rate_limit(&self) -> Option<u32> {676 match self677 .sponsored_data_rate_limit678 .unwrap_or(SponsoringRateLimit::SponsoringDisabled)679 {680 SponsoringRateLimit::SponsoringDisabled => None,681 SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),682 }683 }684}685686687688689690691#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]692#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]693694695pub struct CollectionPermissions {696 697 698 699 pub access: Option<AccessMode>,700701 702 703 704 pub mint_mode: Option<bool>,705706 707 708 709 710 711 712 pub nesting: Option<NestingPermissions>,713}714715impl CollectionPermissions {716 717 pub fn access(&self) -> AccessMode {718 self.access.unwrap_or(AccessMode::Normal)719 }720721 722 pub fn mint_mode(&self) -> bool {723 self.mint_mode.unwrap_or(false)724 }725726 727 pub fn nesting(&self) -> &NestingPermissions {728 static DEFAULT: NestingPermissions = NestingPermissions {729 token_owner: false,730 collection_admin: false,731 restricted: None,732 #[cfg(feature = "runtime-benchmarks")]733 permissive: false,734 };735 self.nesting.as_ref().unwrap_or(&DEFAULT)736 }737}738739740type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;741742743#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]744#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]745#[derivative(Debug)]746pub struct OwnerRestrictedSet(747 #[cfg_attr(feature = "serde1", serde(with = "bounded::set_serde"))]748 #[derivative(Debug(format_with = "bounded::set_debug"))]749 pub OwnerRestrictedSetInner,750);751752impl OwnerRestrictedSet {753 754 pub fn new() -> Self {755 Self(Default::default())756 }757}758impl core::ops::Deref for OwnerRestrictedSet {759 type Target = OwnerRestrictedSetInner;760 fn deref(&self) -> &Self::Target {761 &self.0762 }763}764impl core::ops::DerefMut for OwnerRestrictedSet {765 fn deref_mut(&mut self) -> &mut Self::Target {766 &mut self.0767 }768}769770771#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]772#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]773#[derivative(Debug)]774pub struct NestingPermissions {775 776 pub token_owner: bool,777 778 pub collection_admin: bool,779 780 pub restricted: Option<OwnerRestrictedSet>,781782 #[cfg(feature = "runtime-benchmarks")]783 784 pub permissive: bool,785}786787788789790#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]791#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]792pub enum SponsoringRateLimit {793 794 SponsoringDisabled,795 796 Blocks(u32),797}798799800#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]801#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]802#[derivative(Debug)]803pub struct CreateNftData {804 805 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]806 #[derivative(Debug(format_with = "bounded::vec_debug"))]807 808 pub properties: CollectionPropertiesVec,809}810811812#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]813#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]814pub struct CreateFungibleData {815 816 pub value: u128,817}818819820#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]821#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]822#[derivative(Debug)]823pub struct CreateReFungibleData {824 825 pub pieces: u128,826827 828 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]829 #[derivative(Debug(format_with = "bounded::vec_debug"))]830 pub properties: CollectionPropertiesVec,831}832833834#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]835#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]836pub enum MetaUpdatePermission {837 ItemOwner,838 Admin,839 None,840}841842843844#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]845#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]846pub enum CreateItemData {847 848 NFT(CreateNftData),849 850 Fungible(CreateFungibleData),851 852 ReFungible(CreateReFungibleData),853}854855856#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]857#[derivative(Debug)]858pub struct CreateNftExData<CrossAccountId> {859 860 #[derivative(Debug(format_with = "bounded::vec_debug"))]861 pub properties: CollectionPropertiesVec,862863 864 pub owner: CrossAccountId,865}866867868#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]869#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]870pub struct CreateRefungibleExMultipleOwners<CrossAccountId> {871 #[derivative(Debug(format_with = "bounded::map_debug"))]872 pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,873 #[derivative(Debug(format_with = "bounded::vec_debug"))]874 pub properties: CollectionPropertiesVec,875}876877878#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]879#[derivative(Debug(bound = "CrossAccountId: fmt::Debug"))]880pub struct CreateRefungibleExSingleOwner<CrossAccountId> {881 pub user: CrossAccountId,882 pub pieces: u128,883 #[derivative(Debug(format_with = "bounded::vec_debug"))]884 pub properties: CollectionPropertiesVec,885}886887888#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]889#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]890pub enum CreateItemExData<CrossAccountId> {891 892 NFT(893 #[derivative(Debug(format_with = "bounded::vec_debug"))]894 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,895 ),896897 898 Fungible(899 #[derivative(Debug(format_with = "bounded::map_debug"))]900 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,901 ),902903 904 905 RefungibleMultipleItems(906 #[derivative(Debug(format_with = "bounded::vec_debug"))]907 BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,908 ),909910 911 912 RefungibleMultipleOwners(CreateRefungibleExMultipleOwners<CrossAccountId>),913}914915impl From<CreateNftData> for CreateItemData {916 fn from(item: CreateNftData) -> Self {917 CreateItemData::NFT(item)918 }919}920921impl From<CreateReFungibleData> for CreateItemData {922 fn from(item: CreateReFungibleData) -> Self {923 CreateItemData::ReFungible(item)924 }925}926927impl From<CreateFungibleData> for CreateItemData {928 fn from(item: CreateFungibleData) -> Self {929 CreateItemData::Fungible(item)930 }931}932933934#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]935#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]936937pub struct TokenChild {938 939 pub token: TokenId,940941 942 pub collection: CollectionId,943}944945946#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]947#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]948pub struct CollectionStats {949 950 pub created: u32,951952 953 pub destroyed: u32,954955 956 pub alive: u32,957}958959960#[derive(Encode, Decode, Clone, Debug)]961#[cfg_attr(feature = "std", derive(PartialEq))]962pub struct PhantomType<T>(core::marker::PhantomData<T>);963964impl<T: TypeInfo + 'static> TypeInfo for PhantomType<T> {965 type Identity = PhantomType<T>;966967 fn type_info() -> scale_info::Type {968 use scale_info::{969 Type, Path,970 build::{FieldsBuilder, UnnamedFields},971 form::MetaForm,972 type_params,973 };974 Type::builder()975 .path(Path::new("up_data_structs", "PhantomType"))976 .type_params(type_params!(T))977 .composite(978 <FieldsBuilder<MetaForm, UnnamedFields>>::default().field(|b| b.ty::<[T; 0]>()),979 )980 }981}982impl<T> MaxEncodedLen for PhantomType<T> {983 fn max_encoded_len() -> usize {984 0985 }986}987988989pub type BoundedBytes<S> = BoundedVec<u8, S>;990991992pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;993994995pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;996997998pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;99910001001#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone, Default)]1002#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1003pub struct PropertyPermission {1004 1005 1006 1007 pub mutable: bool,10081009 1010 pub collection_admin: bool,10111012 1013 pub token_owner: bool,1014}10151016impl PropertyPermission {1017 1018 pub fn none() -> Self {1019 Self {1020 mutable: true,1021 collection_admin: false,1022 token_owner: false,1023 }1024 }1025}102610271028#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1029#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1030pub struct Property {1031 1032 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1033 pub key: PropertyKey,10341035 1036 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1037 pub value: PropertyValue,1038}10391040impl Into<(PropertyKey, PropertyValue)> for Property {1041 fn into(self) -> (PropertyKey, PropertyValue) {1042 (self.key, self.value)1043 }1044}104510461047#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1048#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1049pub struct PropertyKeyPermission {1050 1051 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1052 pub key: PropertyKey,10531054 1055 pub permission: PropertyPermission,1056}10571058impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1059 fn into(self) -> (PropertyKey, PropertyPermission) {1060 (self.key, self.permission)1061 }1062}106310641065#[derive(Debug)]1066pub enum PropertiesError {1067 1068 1069 1070 1071 NoSpaceForProperty,10721073 1074 1075 1076 PropertyLimitReached,10771078 1079 InvalidCharacterInPropertyKey,10801081 1082 1083 1084 PropertyKeyIsTooLong,10851086 1087 EmptyPropertyKey,1088}108910901091#[derive(Debug)]1092pub enum TokenOwnerError {1093 NotFound,1094 MultipleOwners,1095}10961097109810991100#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1101pub enum PropertyScope {1102 None,1103 Rmrk,1104}11051106impl PropertyScope {1107 pub fn prefix(&self) -> &'static [u8] {1108 match self {1109 Self::None => b"",1110 Self::Rmrk => b"rmrk:",1111 }1112 }1113 1114 pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {1115 let prefix = self.prefix();1116 if prefix == b"" {1117 return Ok(key);1118 }1119 [prefix, key.as_slice()]1120 .concat()1121 .try_into()1122 .map_err(|_| PropertiesError::PropertyKeyIsTooLong)1123 }1124}112511261127pub trait TrySetProperty: Sized {1128 type Value;11291130 1131 fn try_scoped_set(1132 &mut self,1133 scope: PropertyScope,1134 key: PropertyKey,1135 value: Self::Value,1136 ) -> Result<Option<Self::Value>, PropertiesError>;11371138 1139 fn try_scoped_set_from_iter<I, KV>(1140 &mut self,1141 scope: PropertyScope,1142 iter: I,1143 ) -> Result<(), PropertiesError>1144 where1145 I: Iterator<Item = KV>,1146 KV: Into<(PropertyKey, Self::Value)>,1147 {1148 for kv in iter {1149 let (key, value) = kv.into();1150 self.try_scoped_set(scope, key, value)?;1151 }11521153 Ok(())1154 }11551156 1157 fn try_set(1158 &mut self,1159 key: PropertyKey,1160 value: Self::Value,1161 ) -> Result<Option<Self::Value>, PropertiesError> {1162 self.try_scoped_set(PropertyScope::None, key, value)1163 }11641165 1166 fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>1167 where1168 I: Iterator<Item = KV>,1169 KV: Into<(PropertyKey, Self::Value)>,1170 {1171 self.try_scoped_set_from_iter(PropertyScope::None, iter)1172 }1173}117411751176#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]1177#[derivative(Default(bound = ""))]1178pub struct PropertiesMap<Value>(1179 BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,1180);11811182impl<Value> PropertiesMap<Value> {1183 1184 pub fn new() -> Self {1185 Self(BoundedBTreeMap::new())1186 }11871188 1189 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {1190 Self::check_property_key(key)?;11911192 Ok(self.0.remove(key))1193 }11941195 1196 pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1197 self.0.get(key)1198 }11991200 1201 pub fn contains_key(&self, key: &PropertyKey) -> bool {1202 self.0.contains_key(key)1203 }12041205 1206 fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {1207 if key.is_empty() {1208 return Err(PropertiesError::EmptyPropertyKey);1209 }12101211 for byte in key.as_slice().iter() {1212 let byte = *byte;12131214 if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {1215 return Err(PropertiesError::InvalidCharacterInPropertyKey);1216 }1217 }12181219 Ok(())1220 }12211222 pub fn values(&self) -> impl Iterator<Item = &Value> {1223 self.0.values()1224 }12251226 pub fn iter(&self) -> impl Iterator<Item = (&PropertyKey, &Value)> {1227 self.0.iter()1228 }1229}12301231impl<Value> IntoIterator for PropertiesMap<Value> {1232 type Item = (PropertyKey, Value);1233 type IntoIter = <1234 BoundedBTreeMap<1235 PropertyKey,1236 Value,1237 ConstU32<MAX_PROPERTIES_PER_ITEM>1238 > as IntoIterator1239 >::IntoIter;12401241 fn into_iter(self) -> Self::IntoIter {1242 self.0.into_iter()1243 }1244}12451246impl<Value> TrySetProperty for PropertiesMap<Value> {1247 type Value = Value;12481249 fn try_scoped_set(1250 &mut self,1251 scope: PropertyScope,1252 key: PropertyKey,1253 value: Self::Value,1254 ) -> Result<Option<Self::Value>, PropertiesError> {1255 Self::check_property_key(&key)?;12561257 let key = scope.apply(key)?;1258 self.01259 .try_insert(key, value)1260 .map_err(|_| PropertiesError::PropertyLimitReached)1261 }1262}126312641265pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;12661267fn slice_size(data: &[u8]) -> u32 {1268 scoped_slice_size(PropertyScope::None, data)1269}1270fn scoped_slice_size(scope: PropertyScope, data: &[u8]) -> u32 {1271 use codec::Compact;1272 let prefix = scope.prefix();1273 <Compact<u32>>::encoded_size(&Compact(data.len() as u32 + prefix.len() as u32)) as u321274 + data.len() as u321275 + prefix.len() as u321276}127712781279#[derive(Encode, Decode, TypeInfo, Clone, PartialEq)]1280pub struct Properties<const S: u32> {1281 map: PropertiesMap<PropertyValue>,1282 consumed_space: u32,1283 1284 _reserved: u32,1285}12861287impl<const S: u32> MaxEncodedLen for Properties<S> {1288 fn max_encoded_len() -> usize {1289 1290 u32::max_encoded_len() * 3 + S as usize1291 }1292}12931294impl<const S: u32> Default for Properties<S> {1295 fn default() -> Self {1296 Self::new()1297 }1298}12991300impl<const S: u32> Properties<S> {1301 1302 pub fn new() -> Self {1303 Self {1304 map: PropertiesMap::new(),1305 consumed_space: 0,1306 _reserved: 0,1307 }1308 }13091310 1311 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {1312 let value = self.map.remove(key)?;13131314 if let Some(ref value) = value {1315 let kv_len = slice_size(key) + slice_size(value);1316 self.consumed_space = self.consumed_space.saturating_sub(kv_len);1317 }13181319 Ok(value)1320 }13211322 1323 pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {1324 self.map.get(key)1325 }13261327 1328 1329 pub fn recompute_consumed_space(&mut self) {1330 self.consumed_space = self1331 .map1332 .iter()1333 .map(|(key, value)| slice_size(key) + slice_size(value))1334 .sum();1335 }1336}13371338impl<const S: u32> IntoIterator for Properties<S> {1339 type Item = (PropertyKey, PropertyValue);1340 type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;13411342 fn into_iter(self) -> Self::IntoIter {1343 self.map.into_iter()1344 }1345}13461347impl<const S: u32> TrySetProperty for Properties<S> {1348 type Value = PropertyValue;13491350 fn try_scoped_set(1351 &mut self,1352 scope: PropertyScope,1353 key: PropertyKey,1354 value: Self::Value,1355 ) -> Result<Option<Self::Value>, PropertiesError> {1356 let key_size = scoped_slice_size(scope, &key);1357 let value_size = slice_size(&value) as u32;13581359 if self.consumed_space + value_size + key_size > S && !cfg!(feature = "runtime-benchmarks")1360 {1361 return Err(PropertiesError::NoSpaceForProperty);1362 }13631364 let old_value = self.map.try_scoped_set(scope, key, value)?;13651366 if let Some(old_value) = old_value.as_ref() {1367 let old_value_size = slice_size(&old_value);1368 self.consumed_space = self.consumed_space.saturating_sub(old_value_size) + value_size;1369 } else {1370 self.consumed_space += key_size + value_size;1371 }13721373 Ok(old_value)1374 }1375}13761377pub type CollectionProperties = Properties<MAX_COLLECTION_PROPERTIES_SIZE>;1378pub type TokenProperties = Properties<MAX_TOKEN_PROPERTIES_SIZE>;