difftreelog
refactor move foreign flag to collection struct
in: master
9 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -697,6 +697,26 @@
]
[[package]]
+name = "bondrewd"
+version = "0.1.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6d1660fac8d3acced44dac64453fafedf5aab2de196b932c727e63e4ae42d1cc"
+dependencies = [
+ "bondrewd-derive",
+]
+
+[[package]]
+name = "bondrewd-derive"
+version = "0.3.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "723da0dee1eef38edc021b0793f892bdc024500c6a5b0727a2efe16f0e0a6977"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
name = "bounded-vec"
version = "0.6.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -5892,6 +5912,7 @@
name = "pallet-foreign-assets"
version = "0.1.0"
dependencies = [
+ "frame-benchmarking",
"frame-support",
"frame-system",
"hex",
@@ -6600,7 +6621,7 @@
[[package]]
name = "pallet-unique"
-version = "0.1.4"
+version = "0.2.0"
dependencies = [
"ethereum",
"evm-coder",
@@ -12634,6 +12655,7 @@
name = "up-data-structs"
version = "0.2.2"
dependencies = [
+ "bondrewd",
"derivative",
"frame-support",
"frame-system",
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -70,6 +70,7 @@
COLLECTION_NUMBER_LIMIT,
Collection,
RpcCollection,
+ CollectionFlags,
CollectionId,
CreateItemData,
MAX_TOKEN_PREFIX_LENGTH,
@@ -252,9 +253,9 @@
}
/// Checks that the collection was created with, and must be operated upon through **Unique API**.
- /// Now check only the `external_collection` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.
+ /// Now check only the `external` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.
pub fn check_is_internal(&self) -> DispatchResult {
- if self.external_collection {
+ if self.flags.external {
return Err(<Error<T>>::CollectionIsExternal)?;
}
@@ -262,9 +263,9 @@
}
/// Checks that the collection was created with, and must be operated upon through an **assimilated API**.
- /// Now check only the `external_collection` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.
+ /// Now check only the `external` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.
pub fn check_is_external(&self) -> DispatchResult {
- if !self.external_collection {
+ if !self.flags.external {
return Err(<Error<T>>::CollectionIsInternal)?;
}
@@ -345,7 +346,7 @@
use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};
use frame_system::pallet_prelude::*;
use frame_support::traits::Currency;
- use up_data_structs::{TokenId, mapping::TokenAddressMapping};
+ use up_data_structs::{TokenId, mapping::TokenAddressMapping, CollectionFlags};
use scale_info::TypeInfo;
use weights::WeightInfo;
@@ -792,7 +793,7 @@
sponsorship,
limits,
permissions,
- external_collection,
+ flags,
} = <CollectionById<T>>::get(collection)?;
let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)
@@ -822,7 +823,8 @@
permissions,
token_property_permissions,
properties,
- read_only: external_collection,
+ read_only: flags.external,
+ foreign: flags.foreign,
})
}
}
@@ -861,11 +863,11 @@
///
/// * `owner` - The owner of the collection.
/// * `data` - Description of the created collection.
- /// * `is_external` - Marks that collection managet by not "Unique network".
+ /// * `flags` - Extra flags to store.
pub fn init_collection(
owner: T::CrossAccountId,
data: CreateCollectionData<T::AccountId>,
- is_external: bool,
+ flags: CollectionFlags,
) -> Result<CollectionId, DispatchError> {
{
ensure!(
@@ -909,7 +911,7 @@
Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)
})
.unwrap_or_else(|| Ok(CollectionPermissions::default()))?,
- external_collection: is_external,
+ flags,
};
let mut collection_properties = up_data_structs::CollectionProperties::get();
pallets/fungible/src/lib.rsdiffbeforeafterboth--- a/pallets/fungible/src/lib.rs
+++ b/pallets/fungible/src/lib.rs
@@ -83,8 +83,8 @@
use frame_support::{ensure};
use pallet_evm::account::CrossAccountId;
use up_data_structs::{
- AccessMode, CollectionId, TokenId, CreateCollectionData, mapping::TokenAddressMapping,
- budget::Budget,
+ AccessMode, CollectionId, CollectionFlags, TokenId, CreateCollectionData,
+ mapping::TokenAddressMapping, budget::Budget,
};
use pallet_common::{
Error as CommonError, Event as CommonEvent, Pallet as PalletCommon,
@@ -167,11 +167,6 @@
Value = u128,
QueryKind = ValueQuery,
>;
-
- /// Foreign collection flag
- #[pallet::storage]
- pub type ForeignCollection<T: Config> =
- StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = bool, QueryKind = ValueQuery>;
}
/// Wrapper around untyped collection handle, asserting inner collection is of fungible type.
@@ -217,7 +212,7 @@
owner: T::CrossAccountId,
data: CreateCollectionData<T::AccountId>,
) -> Result<CollectionId, DispatchError> {
- <PalletCommon<T>>::init_collection(owner, data, false)
+ <PalletCommon<T>>::init_collection(owner, data, CollectionFlags::default())
}
/// Initializes the collection with ForeignCollection flag. Returns [CollectionId] on success, [DispatchError] otherwise.
@@ -225,8 +220,14 @@
owner: T::CrossAccountId,
data: CreateCollectionData<T::AccountId>,
) -> Result<CollectionId, DispatchError> {
- let id = <PalletCommon<T>>::init_collection(owner, data, false)?;
- <ForeignCollection<T>>::insert(id, true);
+ let id = <PalletCommon<T>>::init_collection(
+ owner,
+ data,
+ CollectionFlags {
+ foreign: true,
+ ..Default::default()
+ },
+ )?;
Ok(id)
}
@@ -245,7 +246,6 @@
PalletCommon::destroy_collection(collection.0, sender)?;
- <ForeignCollection<T>>::remove(id);
<TotalSupply<T>>::remove(id);
let _ = <Balance<T>>::clear_prefix((id,), u32::MAX, None);
let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);
@@ -274,10 +274,7 @@
.ok_or(<CommonError<T>>::TokenValueTooLow)?;
// Foreign collection check
- ensure!(
- !<ForeignCollection<T>>::get(collection.id),
- <CommonError<T>>::NoPermission
- );
+ ensure!(!collection.flags.foreign, <CommonError<T>>::NoPermission);
if collection.permissions.access() == AccessMode::AllowList {
collection.check_allowlist(owner)?;
@@ -502,10 +499,7 @@
nesting_budget: &dyn Budget,
) -> DispatchResult {
// Foreign collection check
- ensure!(
- !<ForeignCollection<T>>::get(collection.id),
- <CommonError<T>>::NoPermission
- );
+ ensure!(!collection.flags.foreign, <CommonError<T>>::NoPermission);
if !collection.is_owner_or_admin(sender) {
ensure!(
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -100,10 +100,10 @@
weights::{PostDispatchInfo, Pays},
};
use up_data_structs::{
- AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,
- mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission, PropertyKey,
- PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,
- AuxPropertyValue,
+ AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,
+ CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission,
+ PropertyKey, PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty,
+ TokenChild, AuxPropertyValue,
};
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_common::{
@@ -408,7 +408,14 @@
data: CreateCollectionData<T::AccountId>,
is_external: bool,
) -> Result<CollectionId, DispatchError> {
- <PalletCommon<T>>::init_collection(owner, data, is_external)
+ <PalletCommon<T>>::init_collection(
+ owner,
+ data,
+ CollectionFlags {
+ external: is_external,
+ ..Default::default()
+ },
+ )
}
/// Destroy NFT collection
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -112,10 +112,10 @@
use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};
use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};
use up_data_structs::{
- AccessMode, budget::Budget, CollectionId, CollectionMode, CollectionPropertiesVec,
- CreateCollectionData, CustomDataLimit, mapping::TokenAddressMapping, MAX_ITEMS_PER_BATCH,
- MAX_REFUNGIBLE_PIECES, Property, PropertyKey, PropertyKeyPermission, PropertyPermission,
- PropertyScope, PropertyValue, TokenId, TrySetProperty,
+ AccessMode, budget::Budget, CollectionId, CollectionMode, CollectionFlags,
+ CollectionPropertiesVec, CreateCollectionData, CustomDataLimit, mapping::TokenAddressMapping,
+ MAX_ITEMS_PER_BATCH, MAX_REFUNGIBLE_PIECES, Property, PropertyKey, PropertyKeyPermission,
+ PropertyPermission, PropertyScope, PropertyValue, TokenId, TrySetProperty,
};
use frame_support::BoundedBTreeMap;
use derivative::Derivative;
@@ -375,7 +375,7 @@
owner: T::CrossAccountId,
data: CreateCollectionData<T::AccountId>,
) -> Result<CollectionId, DispatchError> {
- <PalletCommon<T>>::init_collection(owner, data, false)
+ <PalletCommon<T>>::init_collection(owner, data, CollectionFlags::default())
}
/// Destroy RFT collection
primitives/data-structs/Cargo.tomldiffbeforeafterboth--- a/primitives/data-structs/Cargo.toml
+++ b/primitives/data-structs/Cargo.toml
@@ -27,6 +27,7 @@
struct-versioning = { path = "../../crates/struct-versioning" }
pallet-evm = { default-features = false, git = "https://github.com/uniquenetwork/frontier", branch = "unique-polkadot-v0.9.27-fee-limit" }
rmrk-traits = { default-features = false, path = "../rmrk-traits" }
+bondrewd = { version = "0.1.14", features = ["derive"], default-features = false }
[features]
default = ["std"]
primitives/data-structs/src/bondrewd_codec.rsdiffbeforeafterboth--- /dev/null
+++ b/primitives/data-structs/src/bondrewd_codec.rs
@@ -0,0 +1,31 @@
+//! Integration between bondrewd and parity scale codec
+//! Maybe we can move it to scale-codec itself in future?
+
+#[macro_export]
+macro_rules! bondrewd_codec {
+ ($T:ty) => {
+ impl Encode for $T {
+ fn encode_to<O: codec::Output + ?Sized>(&self, dest: &mut O) {
+ dest.write(&self.into_bytes())
+ }
+ }
+ impl codec::Decode for $T {
+ fn decode<I: codec::Input + ?Sized>(from: &mut I) -> Result<Self, codec::Error> {
+ let mut bytes = [0; Self::BYTE_SIZE];
+ from.read(&mut bytes)?;
+ Ok(Self::from_bytes(bytes))
+ }
+ }
+ impl MaxEncodedLen for $T {
+ fn max_encoded_len() -> usize {
+ Self::BYTE_SIZE
+ }
+ }
+ impl TypeInfo for $T {
+ type Identity = [u8; Self::BYTE_SIZE];
+ fn type_info() -> scale_info::Type {
+ <[u8; Self::BYTE_SIZE] as TypeInfo>::type_info()
+ }
+ }
+ };
+}
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//! # Primitives crate.18//!19//! This crate contains types, traits and constants.2021#![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;4243// RMRK44use 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;6162/// Maximum of decimal points.63pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;6465/// Maximum pieces for refungible token.66pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;67pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;6869/// Maximum tokens for user.70pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {71 100_00072} else {73 1074};7576/// Maximum for collections can be created.77pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {78 100_00079} else {80 1081};8283/// Maximum for various custom data of token.84pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {85 204886} else {87 1088};8990/// Maximum admins per collection.91pub const COLLECTION_ADMINS_LIMIT: u32 = 5;9293/// Maximum tokens per collection.94pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;9596/// Maximum tokens per account.97pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {98 1_000_00099} else {100 10101};102103/// Default timeout for transfer sponsoring NFT item.104pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;105/// Default timeout for transfer sponsoring fungible item.106pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;107/// Default timeout for transfer sponsoring refungible item.108pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;109110/// Default timeout for sponsored approving.111pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;112113// Schema limits114pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;115pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;116pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;117118// TODO: not used. Delete?119pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;120121/// Maximum length for collection name.122pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;123124/// Maximum length for collection description.125pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;126127/// Maximal token prefix length.128pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;129130/// Maximal lenght of property key.131pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;132133/// Maximal lenght of property value.134pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;135136/// Maximum properties that can be assigned to token.137pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;138139/// Maximal lenght of extended property value.140pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;141142/// Maximum size for all collection properties.143pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;144145/// Maximum size for all token properties.146pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;147148/// How much items can be created per single149/// create_many call.150pub const MAX_ITEMS_PER_BATCH: u32 = 200;151152/// Used for limit bounded types of token custom data.153pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;154155/// Collection id.156#[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 {}174175/// Token id.176#[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 /// Try to get next token id.197 ///198 /// If next id cause overflow, then [`ArithmeticError::Overflow`] returned.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}220221/// Token data.222#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]223#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]224pub struct TokenData<CrossAccountId> {225 /// Properties of token.226 pub properties: Vec<Property>,227228 /// Token owner.229 pub owner: Option<CrossAccountId>,230231 /// Token pieces.232 pub pieces: u128,233}234235// TODO: unused type236pub struct OverflowError;237impl From<OverflowError> for &'static str {238 fn from(_: OverflowError) -> Self {239 "overflow occured"240 }241}242243/// Alias for decimal points type.244pub type DecimalPoints = u8;245246/// Collection mode.247///248/// Collection can represent various types of tokens.249/// Each collection can contain only one type of tokens at a time.250/// This type helps to understand which tokens the collection contains.251#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]252#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]253pub enum CollectionMode {254 /// Non fungible tokens.255 NFT,256 /// Fungible tokens.257 Fungible(DecimalPoints),258 /// Refungible tokens.259 ReFungible,260}261262impl CollectionMode {263 /// Get collection mod as number.264 pub fn id(&self) -> u8 {265 match self {266 CollectionMode::NFT => 1,267 CollectionMode::Fungible(_) => 2,268 CollectionMode::ReFungible => 3,269 }270 }271}272273// TODO: unused trait274pub trait SponsoringResolve<AccountId, Call> {275 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;276}277278/// Access mode for some token operations.279#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]280#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]281pub enum AccessMode {282 /// Access grant for owner and admins. Used as default.283 Normal,284 /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.285 AllowList,286}287impl Default for AccessMode {288 fn default() -> Self {289 Self::Normal290 }291}292293// TODO: remove in future.294#[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}305306// TODO: unused type307#[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}313314/// The state of collection sponsorship.315#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]316#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]317pub enum SponsorshipState<AccountId> {318 /// The fees are applied to the transaction sender.319 Disabled,320 /// The sponsor is under consideration. Until the sponsor gives his consent,321 /// the fee will still be charged to sender.322 Unconfirmed(AccountId),323 /// Transactions are sponsored by specified account.324 Confirmed(AccountId),325}326327impl<AccountId> SponsorshipState<AccountId> {328 /// Get a sponsor of the collection who has confirmed his status.329 pub fn sponsor(&self) -> Option<&AccountId> {330 match self {331 Self::Confirmed(sponsor) => Some(sponsor),332 _ => None,333 }334 }335336 /// Get a sponsor of the collection who has pending or confirmed status.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 /// Whether the sponsorship is confirmed.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>>;359360/// Base structure for represent collection.361///362/// Used to provide basic functionality for all types of collections.363///364/// #### Note365/// Collection parameters, used in storage (see [`RpcCollection`] for the RPC version).366#[struct_versioning::versioned(version = 2, upper)]367#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]368pub struct Collection<AccountId> {369 /// Collection owner account.370 pub owner: AccountId,371372 /// Collection mode.373 pub mode: CollectionMode,374375 /// Access mode.376 #[version(..2)]377 pub access: AccessMode,378379 /// Collection name.380 pub name: CollectionName,381382 /// Collection description.383 pub description: CollectionDescription,384385 /// Token prefix.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 /// The state of sponsorship of the collection.398 pub sponsorship: SponsorshipState<AccountId>,399400 /// Collection limits.401 pub limits: CollectionLimits,402403 /// Collection permissions.404 #[version(2.., upper(Default::default()))]405 pub permissions: CollectionPermissions,406407 /// Marks that this collection is not "unique", and managed from external.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}420421/// Collection parameters, used in RPC calls (see [`Collection`] for the storage version).422#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]423#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]424pub struct RpcCollection<AccountId> {425 /// Collection owner account.426 pub owner: AccountId,427428 /// Collection mode.429 pub mode: CollectionMode,430431 /// Collection name.432 pub name: Vec<u16>,433434 /// Collection description.435 pub description: Vec<u16>,436437 /// Token prefix.438 pub token_prefix: Vec<u8>,439440 /// The state of sponsorship of the collection.441 pub sponsorship: SponsorshipState<AccountId>,442443 /// Collection limits.444 pub limits: CollectionLimits,445446 /// Collection permissions.447 pub permissions: CollectionPermissions,448449 /// Token property permissions.450 pub token_property_permissions: Vec<PropertyKeyPermission>,451452 /// Collection properties.453 pub properties: Vec<Property>,454455 /// Is collection read only.456 pub read_only: bool,457}458459/// Data used for create collection.460///461/// All fields are wrapped in [`Option`], where `None` means chain default.462#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]463#[derivative(Debug, Default(bound = ""))]464pub struct CreateCollectionData<AccountId> {465 /// Collection mode.466 #[derivative(Default(value = "CollectionMode::NFT"))]467 pub mode: CollectionMode,468469 /// Access mode.470 pub access: Option<AccessMode>,471472 /// Collection name.473 pub name: CollectionName,474475 /// Collection description.476 pub description: CollectionDescription,477478 /// Token prefix.479 pub token_prefix: CollectionTokenPrefix,480481 /// Pending collection sponsor.482 pub pending_sponsor: Option<AccountId>,483484 /// Collection limits.485 pub limits: Option<CollectionLimits>,486487 /// Collection permissions.488 pub permissions: Option<CollectionPermissions>,489490 /// Token property permissions.491 pub token_property_permissions: CollectionPropertiesPermissionsVec,492493 /// Collection properties.494 pub properties: CollectionPropertiesVec,495}496497/// Bounded vector of properties permissions. Max length is [`MAX_PROPERTIES_PER_ITEM`].498// TODO: maybe rename to PropertiesPermissionsVec499pub type CollectionPropertiesPermissionsVec =500 BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;501502/// Bounded vector of properties. Max length is [`MAX_PROPERTIES_PER_ITEM`].503pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;504505/// Limits and restrictions of a collection.506///507/// All fields are wrapped in [`Option`], where `None` means chain default.508///509/// Update with `pallet_common::Pallet::clamp_limits`.510// IMPORTANT: When adding/removing fields from this struct - don't forget to also511#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]512#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]513// When adding/removing fields from this struct - don't forget to also update with `pallet_common::Pallet::clamp_limits`.514// TODO: move `pallet_common::Pallet::clamp_limits` into `impl CollectionLimits`.515// TODO: may be remove [`Option`] and **pub** from fields and create struct with default values.516pub struct CollectionLimits {517 /// How many tokens can a user have on one account.518 /// * Default - [`ACCOUNT_TOKEN_OWNERSHIP_LIMIT`].519 /// * Limit - [`MAX_TOKEN_OWNERSHIP`].520 pub account_token_ownership_limit: Option<u32>,521522 /// How many bytes of data are available for sponsorship.523 /// * Default - [`CUSTOM_DATA_LIMIT`].524 /// * Limit - [`CUSTOM_DATA_LIMIT`].525 pub sponsored_data_size: Option<u32>,526527 // FIXME should we delete this or repurpose it?528 /// Times in how many blocks we sponsor data.529 ///530 /// If is `Some(v)` then **setVariableMetadata** is sponsored if there is `v` block between transactions.531 ///532 /// * Default - [`SponsoringDisabled`](SponsoringRateLimit::SponsoringDisabled).533 /// * Limit - [`MAX_SPONSOR_TIMEOUT`].534 ///535 /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]536 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,537 /// Maximum amount of tokens inside the collection. Chain default: [`COLLECTION_TOKEN_LIMIT`]538539 /// How many tokens can be mined into this collection.540 ///541 /// * Default - [`COLLECTION_TOKEN_LIMIT`].542 /// * Limit - [`COLLECTION_TOKEN_LIMIT`].543 pub token_limit: Option<u32>,544545 /// Timeouts for transfer sponsoring.546 ///547 /// * Default548 /// - **Fungible** - [`FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]549 /// - **NFT** - [`NFT_SPONSOR_TRANSFER_TIMEOUT`]550 /// - **Refungible** - [`REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]551 /// * Limit - [`MAX_SPONSOR_TIMEOUT`].552 pub sponsor_transfer_timeout: Option<u32>,553554 /// Timeout for sponsoring an approval in passed blocks.555 ///556 /// * Default - [`SPONSOR_APPROVE_TIMEOUT`].557 /// * Limit - [`MAX_SPONSOR_TIMEOUT`].558 pub sponsor_approve_timeout: Option<u32>,559560 /// Whether the collection owner of the collection can send tokens (which belong to other users).561 ///562 /// * Default - **false**.563 pub owner_can_transfer: Option<bool>,564565 /// Can the collection owner burn other people's tokens.566 ///567 /// * Default - **true**.568 pub owner_can_destroy: Option<bool>,569570 /// Is it possible to send tokens from this collection between users.571 ///572 /// * Default - **true**.573 pub transfers_enabled: Option<bool>,574}575576impl CollectionLimits {577 /// Get effective value for [`account_token_ownership_limit`](self.account_token_ownership_limit).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 /// Get effective value for [`sponsored_data_size`](self.sponsored_data_size).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 /// Get effective value for [`token_limit`](self.token_limit).592 pub fn token_limit(&self) -> u32 {593 self.token_limit594 .unwrap_or(COLLECTION_TOKEN_LIMIT)595 .min(COLLECTION_TOKEN_LIMIT)596 }597598 // TODO: may be replace u32 to mode?599 /// Get effective value for [`sponsor_transfer_timeout`](self.sponsor_transfer_timeout).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 /// Get effective value for [`sponsor_approve_timeout`](self.sponsor_approve_timeout).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 /// Get effective value for [`owner_can_transfer`](self.owner_can_transfer).614 pub fn owner_can_transfer(&self) -> bool {615 self.owner_can_transfer.unwrap_or(false)616 }617618 /// Get effective value for [`owner_can_transfer_instaled`](self.owner_can_transfer_instaled).619 pub fn owner_can_transfer_instaled(&self) -> bool {620 self.owner_can_transfer.is_some()621 }622623 /// Get effective value for [`owner_can_destroy`](self.owner_can_destroy).624 pub fn owner_can_destroy(&self) -> bool {625 self.owner_can_destroy.unwrap_or(true)626 }627628 /// Get effective value for [`transfers_enabled`](self.transfers_enabled).629 pub fn transfers_enabled(&self) -> bool {630 self.transfers_enabled.unwrap_or(true)631 }632633 /// Get effective value for [`sponsored_data_rate_limit`](self.sponsored_data_rate_limit).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}644645/// Permissions on certain operations within a collection.646///647/// Some fields are wrapped in [`Option`], where `None` means chain default.648///649/// Update with `pallet_common::Pallet::clamp_permissions`.650#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]651#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]652// When adding/removing fields from this struct - don't forget to also update `pallet_common::Pallet::clamp_permissions`.653// TODO: move `pallet_common::Pallet::clamp_permissions` into `impl CollectionPermissions`.654pub struct CollectionPermissions {655 /// Access mode.656 ///657 /// * Default - [`AccessMode::Normal`].658 pub access: Option<AccessMode>,659660 /// Minting allowance.661 ///662 /// * Default - **false**.663 pub mint_mode: Option<bool>,664665 /// Permissions for nesting.666 ///667 /// * Default668 /// - `token_owner` - **false**669 /// - `collection_admin` - **false**670 /// - `restricted` - **None**671 pub nesting: Option<NestingPermissions>,672}673674impl CollectionPermissions {675 /// Get effective value for [`access`](self.access).676 pub fn access(&self) -> AccessMode {677 self.access.unwrap_or(AccessMode::Normal)678 }679680 /// Get effective value for [`mint_mode`](self.mint_mode).681 pub fn mint_mode(&self) -> bool {682 self.mint_mode.unwrap_or(false)683 }684685 /// Get effective value for [`nesting`](self.nesting).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}697698/// Inner set for collections allowed to nest.699type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;700701/// Wraper for collections set allowing nest.702#[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 /// Create new set.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}728729/// Part of collection permissions, if set, defines who is able to nest tokens into other tokens.730#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]731#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]732#[derivative(Debug)]733pub struct NestingPermissions {734 /// Owner of token can nest tokens under it.735 pub token_owner: bool,736 /// Admin of token collection can nest tokens under token.737 pub collection_admin: bool,738 /// If set - only tokens from specified collections can be nested.739 pub restricted: Option<OwnerRestrictedSet>,740741 #[cfg(feature = "runtime-benchmarks")]742 /// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`.743 pub permissive: bool,744}745746/// Enum denominating how often can sponsoring occur if it is enabled.747///748/// Used for [`collection limits`](CollectionLimits).749#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]750#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]751pub enum SponsoringRateLimit {752 /// Sponsoring is disabled, and the collection sponsor will not pay for transactions753 SponsoringDisabled,754 /// Once per how many blocks can sponsorship of a transaction type occur755 Blocks(u32),756}757758/// Data used to describe an NFT at creation.759#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]760#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]761#[derivative(Debug)]762pub struct CreateNftData {763 /// Key-value pairs used to describe the token as metadata764 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]765 #[derivative(Debug(format_with = "bounded::vec_debug"))]766 /// Properties that wil be assignet to created item.767 pub properties: CollectionPropertiesVec,768}769770/// Data used to describe a Fungible token at creation.771#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]772#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]773pub struct CreateFungibleData {774 /// Number of fungible coins minted775 pub value: u128,776}777778/// Data used to describe a Refungible token at creation.779#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]780#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]781#[derivative(Debug)]782pub struct CreateReFungibleData {783 /// Number of pieces the RFT is split into784 pub pieces: u128,785786 /// Key-value pairs used to describe the token as metadata787 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]788 #[derivative(Debug(format_with = "bounded::vec_debug"))]789 pub properties: CollectionPropertiesVec,790}791792// TODO: remove this.793#[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}800801/// Enum holding data used for creation of all three item types.802/// Unified data for create item.803#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]804#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]805pub enum CreateItemData {806 /// Data for create NFT.807 NFT(CreateNftData),808 /// Data for create Fungible item.809 Fungible(CreateFungibleData),810 /// Data for create ReFungible item.811 ReFungible(CreateReFungibleData),812}813814/// Extended data for create NFT.815#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]816#[derivative(Debug)]817pub struct CreateNftExData<CrossAccountId> {818 /// Properties that wil be assignet to created item.819 #[derivative(Debug(format_with = "bounded::vec_debug"))]820 pub properties: CollectionPropertiesVec,821822 /// Owner of creating item.823 pub owner: CrossAccountId,824}825826/// Extended data for create ReFungible item.827#[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}835836/// Extended data for create ReFungible item.837#[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}845846/// Unified extended data for creating item.847#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]848#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]849pub enum CreateItemExData<CrossAccountId> {850 /// Extended data for create NFT.851 NFT(852 #[derivative(Debug(format_with = "bounded::vec_debug"))]853 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,854 ),855856 /// Extended data for create Fungible item.857 Fungible(858 #[derivative(Debug(format_with = "bounded::map_debug"))]859 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,860 ),861862 /// Extended data for create ReFungible item in case of863 /// many tokens, each may have only one owner864 RefungibleMultipleItems(865 #[derivative(Debug(format_with = "bounded::vec_debug"))]866 BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,867 ),868869 /// Extended data for create ReFungible item in case of870 /// single token, which may have many owners871 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}891892/// Token's address, dictated by its collection and token IDs.893#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]894#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]895// todo possibly rename to be used generally as an address pair896pub struct TokenChild {897 /// Token id.898 pub token: TokenId,899900 /// Collection id.901 pub collection: CollectionId,902}903904/// Collection statistics.905#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]906#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]907pub struct CollectionStats {908 /// Number of created items.909 pub created: u32,910911 /// Number of burned items.912 pub destroyed: u32,913914 /// Number of current items.915 pub alive: u32,916}917918/// This type works like [`PhantomData`] but supports generating _scale-info_ descriptions to generate node metadata.919#[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}943944/// Bounded vector of bytes.945pub type BoundedBytes<S> = BoundedVec<u8, S>;946947/// Extra properties for external collections.948pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;949950/// Property key.951pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;952953/// Property value.954pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;955956/// Property permission.957#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]958#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]959pub struct PropertyPermission {960 /// Permission to change the property and property permission.961 ///962 /// If it **false** then you can not change corresponding property even if [`collection_admin`] and [`token_owner`] are **true**.963 pub mutable: bool,964965 /// Change permission for the collection administrator.966 pub collection_admin: bool,967968 /// Permission to change the property for the owner of the token.969 pub token_owner: bool,970}971972impl PropertyPermission {973 /// Creates mutable property permission but changes restricted for collection admin and token owner.974 pub fn none() -> Self {975 Self {976 mutable: true,977 collection_admin: false,978 token_owner: false,979 }980 }981}982983/// Property is simpl key-value record.984#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]985#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]986pub struct Property {987 /// Property key.988 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]989 pub key: PropertyKey,990991 /// Property value.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}10011002/// Record for proprty key permission.1003#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1004#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1005pub struct PropertyKeyPermission {1006 /// Key.1007 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1008 pub key: PropertyKey,10091010 /// Permission.1011 pub permission: PropertyPermission,1012}10131014impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1015 fn into(self) -> (PropertyKey, PropertyPermission) {1016 (self.key, self.permission)1017 }1018}10191020/// Errors for properties actions.1021#[derive(Debug)]1022pub enum PropertiesError {1023 /// The space allocated for properties has run out.1024 ///1025 /// * Limit for colection - [`MAX_COLLECTION_PROPERTIES_SIZE`].1026 /// * Limit for token - [`MAX_TOKEN_PROPERTIES_SIZE`].1027 NoSpaceForProperty,10281029 /// The property limit has been reached.1030 ///1031 /// * Limit - [`MAX_PROPERTIES_PER_ITEM`].1032 PropertyLimitReached,10331034 /// Property key contains not allowed character.1035 InvalidCharacterInPropertyKey,10361037 /// Property key length is too long.1038 ///1039 /// * Limit - [`MAX_PROPERTY_KEY_LENGTH`].1040 PropertyKeyIsTooLong,10411042 /// Property key is empty.1043 EmptyPropertyKey,1044}10451046/// Marker for scope of property.1047///1048/// Scoped property can't be changed by user. Used for external collections.1049#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1050pub enum PropertyScope {1051 None,1052 Rmrk,1053}10541055impl PropertyScope {1056 /// Apply scope to property key.1057 pub fn apply(self, key: PropertyKey) -> Result<PropertyKey, PropertiesError> {1058 let scope_str: &[u8] = match self {1059 Self::None => return Ok(key),1060 Self::Rmrk => b"rmrk",1061 };10621063 [scope_str, b":", key.as_slice()]1064 .concat()1065 .try_into()1066 .map_err(|_| PropertiesError::PropertyKeyIsTooLong)1067 }1068}10691070/// Trait for operate with properties.1071pub trait TrySetProperty: Sized {1072 type Value;10731074 /// Try to set property with scope.1075 fn try_scoped_set(1076 &mut self,1077 scope: PropertyScope,1078 key: PropertyKey,1079 value: Self::Value,1080 ) -> Result<(), PropertiesError>;10811082 /// Try to set property with scope from iterator.1083 fn try_scoped_set_from_iter<I, KV>(1084 &mut self,1085 scope: PropertyScope,1086 iter: I,1087 ) -> Result<(), PropertiesError>1088 where1089 I: Iterator<Item = KV>,1090 KV: Into<(PropertyKey, Self::Value)>,1091 {1092 for kv in iter {1093 let (key, value) = kv.into();1094 self.try_scoped_set(scope, key, value)?;1095 }10961097 Ok(())1098 }10991100 /// Try to set property.1101 fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {1102 self.try_scoped_set(PropertyScope::None, key, value)1103 }11041105 /// Try to set property from iterator.1106 fn try_set_from_iter<I, KV>(&mut self, iter: I) -> Result<(), PropertiesError>1107 where1108 I: Iterator<Item = KV>,1109 KV: Into<(PropertyKey, Self::Value)>,1110 {1111 self.try_scoped_set_from_iter(PropertyScope::None, iter)1112 }1113}11141115/// Wrapped map for storing properties.1116#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]1117#[derivative(Default(bound = ""))]1118pub struct PropertiesMap<Value>(1119 BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,1120);11211122impl<Value> PropertiesMap<Value> {1123 /// Create new property map.1124 pub fn new() -> Self {1125 Self(BoundedBTreeMap::new())1126 }11271128 /// Remove property from map.1129 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<Value>, PropertiesError> {1130 Self::check_property_key(key)?;11311132 Ok(self.0.remove(key))1133 }11341135 /// Get property with appropriate key from map.1136 pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1137 self.0.get(key)1138 }11391140 /// Check if map contains key.1141 pub fn contains_key(&self, key: &PropertyKey) -> bool {1142 self.0.contains_key(key)1143 }11441145 /// Check if map contains key with key validation.1146 fn check_property_key(key: &PropertyKey) -> Result<(), PropertiesError> {1147 if key.is_empty() {1148 return Err(PropertiesError::EmptyPropertyKey);1149 }11501151 for byte in key.as_slice().iter() {1152 let byte = *byte;11531154 if !byte.is_ascii_alphanumeric() && byte != b'_' && byte != b'-' && byte != b'.' {1155 return Err(PropertiesError::InvalidCharacterInPropertyKey);1156 }1157 }11581159 Ok(())1160 }1161}11621163impl<Value> IntoIterator for PropertiesMap<Value> {1164 type Item = (PropertyKey, Value);1165 type IntoIter = <1166 BoundedBTreeMap<1167 PropertyKey,1168 Value,1169 ConstU32<MAX_PROPERTIES_PER_ITEM>1170 > as IntoIterator1171 >::IntoIter;11721173 fn into_iter(self) -> Self::IntoIter {1174 self.0.into_iter()1175 }1176}11771178impl<Value> TrySetProperty for PropertiesMap<Value> {1179 type Value = Value;11801181 fn try_scoped_set(1182 &mut self,1183 scope: PropertyScope,1184 key: PropertyKey,1185 value: Self::Value,1186 ) -> Result<(), PropertiesError> {1187 Self::check_property_key(&key)?;11881189 let key = scope.apply(key)?;1190 self.01191 .try_insert(key, value)1192 .map_err(|_| PropertiesError::PropertyLimitReached)?;11931194 Ok(())1195 }1196}11971198/// Alias for property permissions map.1199pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;12001201/// Wrapper for properties map with consumed space control.1202#[derive(Encode, Decode, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1203pub struct Properties {1204 map: PropertiesMap<PropertyValue>,1205 consumed_space: u32,1206 space_limit: u32,1207}12081209impl Properties {1210 /// Create new properies container.1211 pub fn new(space_limit: u32) -> Self {1212 Self {1213 map: PropertiesMap::new(),1214 consumed_space: 0,1215 space_limit,1216 }1217 }12181219 /// Remove propery with appropiate key.1220 pub fn remove(&mut self, key: &PropertyKey) -> Result<Option<PropertyValue>, PropertiesError> {1221 let value = self.map.remove(key)?;12221223 if let Some(ref value) = value {1224 let value_len = value.len() as u32;1225 self.consumed_space -= value_len;1226 }12271228 Ok(value)1229 }12301231 /// Get property with appropriate key.1232 pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {1233 self.map.get(key)1234 }1235}12361237impl IntoIterator for Properties {1238 type Item = (PropertyKey, PropertyValue);1239 type IntoIter = <PropertiesMap<PropertyValue> as IntoIterator>::IntoIter;12401241 fn into_iter(self) -> Self::IntoIter {1242 self.map.into_iter()1243 }1244}12451246impl TrySetProperty for Properties {1247 type Value = PropertyValue;12481249 fn try_scoped_set(1250 &mut self,1251 scope: PropertyScope,1252 key: PropertyKey,1253 value: Self::Value,1254 ) -> Result<(), PropertiesError> {1255 let value_len = value.len();12561257 if self.consumed_space as usize + value_len > self.space_limit as usize1258 && !cfg!(feature = "runtime-benchmarks")1259 {1260 return Err(PropertiesError::NoSpaceForProperty);1261 }12621263 self.map.try_scoped_set(scope, key, value)?;12641265 self.consumed_space += value_len as u32;12661267 Ok(())1268 }1269}12701271/// Utility struct for using in `StorageMap`.1272pub struct CollectionProperties;12731274impl Get<Properties> for CollectionProperties {1275 fn get() -> Properties {1276 Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)1277 }1278}12791280/// Utility struct for using in `StorageMap`.1281pub struct TokenProperties;12821283impl Get<Properties> for TokenProperties {1284 fn get() -> Properties {1285 Properties::new(MAX_TOKEN_PROPERTIES_SIZE)1286 }1287}12881289// RMRK1290// todo document?1291parameter_types! {1292 #[derive(PartialEq, TypeInfo)]1293 pub const RmrkStringLimit: u32 = 128;1294 #[derive(PartialEq)]1295 pub const RmrkCollectionSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1296 #[derive(PartialEq)]1297 pub const RmrkResourceSymbolLimit: u32 = 10;1298 #[derive(PartialEq)]1299 pub const RmrkBaseSymbolLimit: u32 = MAX_TOKEN_PREFIX_LENGTH;1300 #[derive(PartialEq)]1301 pub const RmrkKeyLimit: u32 = 32;1302 #[derive(PartialEq)]1303 pub const RmrkValueLimit: u32 = 256;1304 #[derive(PartialEq)]1305 pub const RmrkMaxCollectionsEquippablePerPart: u32 = 100;1306 #[derive(PartialEq)]1307 pub const MaxPropertiesPerTheme: u32 = 5;1308 #[derive(PartialEq)]1309 pub const RmrkPartsLimit: u32 = 25;1310 #[derive(PartialEq)]1311 pub const RmrkMaxPriorities: u32 = 25;1312 #[derive(PartialEq)]1313 pub const MaxResourcesOnMint: u32 = 100;1314}13151316impl From<RmrkCollectionId> for CollectionId {1317 fn from(id: RmrkCollectionId) -> Self {1318 Self(id)1319 }1320}13211322impl From<RmrkNftId> for TokenId {1323 fn from(id: RmrkNftId) -> Self {1324 Self(id)1325 }1326}13271328pub type RmrkCollectionInfo<AccountId> =1329 CollectionInfo<RmrkString, RmrkCollectionSymbol, AccountId>;1330pub type RmrkInstanceInfo<AccountId> = NftInfo<AccountId, Permill, RmrkString>;1331pub type RmrkResourceInfo = ResourceInfo<RmrkString, RmrkBoundedParts>;1332pub type RmrkPropertyInfo = PropertyInfo<RmrkKeyString, RmrkValueString>;1333pub type RmrkBaseInfo<AccountId> = BaseInfo<AccountId, RmrkString>;1334pub type BoundedEquippableCollectionIds =1335 BoundedVec<RmrkCollectionId, RmrkMaxCollectionsEquippablePerPart>;1336pub type RmrkPartType = PartType<RmrkString, BoundedEquippableCollectionIds>;1337pub type RmrkEquippableList = EquippableList<BoundedEquippableCollectionIds>;1338pub type RmrkThemeProperty = ThemeProperty<RmrkString>;1339pub type RmrkTheme = Theme<RmrkString, Vec<RmrkThemeProperty>>;1340pub type RmrkBoundedTheme = Theme<RmrkString, BoundedVec<RmrkThemeProperty, MaxPropertiesPerTheme>>;1341pub type RmrkResourceTypes = ResourceTypes<RmrkString, RmrkBoundedParts>;13421343pub type RmrkBasicResource = BasicResource<RmrkString>;1344pub type RmrkComposableResource = ComposableResource<RmrkString, RmrkBoundedParts>;1345pub type RmrkSlotResource = SlotResource<RmrkString>;13461347pub type RmrkString = BoundedVec<u8, RmrkStringLimit>;1348pub type RmrkCollectionSymbol = BoundedVec<u8, RmrkCollectionSymbolLimit>;1349pub type RmrkBaseSymbol = BoundedVec<u8, RmrkBaseSymbolLimit>;1350pub type RmrkKeyString = BoundedVec<u8, RmrkKeyLimit>;1351pub type RmrkValueString = BoundedVec<u8, RmrkValueLimit>;1352pub type RmrkBoundedResource = BoundedVec<u8, RmrkResourceSymbolLimit>;1353pub type RmrkBoundedParts = BoundedVec<RmrkPartId, RmrkPartsLimit>; // todo make sure it is needed13541355pub type RmrkRpcString = Vec<u8>;1356pub type RmrkThemeName = RmrkRpcString;1357pub type RmrkPropertyKey = RmrkRpcString;1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Primitives crate.18//!19//! This crate contains types, traits and constants.2021#![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;4344// RMRK45use 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;6364/// Maximum of decimal points.65pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;6667/// Maximum pieces for refungible token.68pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;69pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;7071/// Maximum tokens for user.72pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {73 100_00074} else {75 1076};7778/// Maximum for collections can be created.79pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {80 100_00081} else {82 1083};8485/// Maximum for various custom data of token.86pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {87 204888} else {89 1090};9192/// Maximum admins per collection.93pub const COLLECTION_ADMINS_LIMIT: u32 = 5;9495/// Maximum tokens per collection.96pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;9798/// Maximum tokens per account.99pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {100 1_000_000101} else {102 10103};104105/// Default timeout for transfer sponsoring NFT item.106pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;107/// Default timeout for transfer sponsoring fungible item.108pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;109/// Default timeout for transfer sponsoring refungible item.110pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;111112/// Default timeout for sponsored approving.113pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;114115// Schema limits116pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;117pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;118pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;119120// TODO: not used. Delete?121pub const COLLECTION_FIELD_LIMIT: u32 = CONST_ON_CHAIN_SCHEMA_LIMIT;122123/// Maximum length for collection name.124pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;125126/// Maximum length for collection description.127pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;128129/// Maximal token prefix length.130pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;131132/// Maximal lenght of property key.133pub const MAX_PROPERTY_KEY_LENGTH: u32 = 256;134135/// Maximal lenght of property value.136pub const MAX_PROPERTY_VALUE_LENGTH: u32 = 32768;137138/// Maximum properties that can be assigned to token.139pub const MAX_PROPERTIES_PER_ITEM: u32 = 64;140141/// Maximal lenght of extended property value.142pub const MAX_AUX_PROPERTY_VALUE_LENGTH: u32 = 2048;143144/// Maximum size for all collection properties.145pub const MAX_COLLECTION_PROPERTIES_SIZE: u32 = 40960;146147/// Maximum size for all token properties.148pub const MAX_TOKEN_PROPERTIES_SIZE: u32 = 32768;149150/// How much items can be created per single151/// create_many call.152pub const MAX_ITEMS_PER_BATCH: u32 = 200;153154/// Used for limit bounded types of token custom data.155pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;156157/// Collection id.158#[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 {}176177/// Token id.178#[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 /// Try to get next token id.199 ///200 /// If next id cause overflow, then [`ArithmeticError::Overflow`] returned.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}222223/// Token data.224#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]225#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]226pub struct TokenData<CrossAccountId> {227 /// Properties of token.228 pub properties: Vec<Property>,229230 /// Token owner.231 pub owner: Option<CrossAccountId>,232233 /// Token pieces.234 pub pieces: u128,235}236237// TODO: unused type238pub struct OverflowError;239impl From<OverflowError> for &'static str {240 fn from(_: OverflowError) -> Self {241 "overflow occured"242 }243}244245/// Alias for decimal points type.246pub type DecimalPoints = u8;247248/// Collection mode.249///250/// Collection can represent various types of tokens.251/// Each collection can contain only one type of tokens at a time.252/// This type helps to understand which tokens the collection contains.253#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]254#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]255pub enum CollectionMode {256 /// Non fungible tokens.257 NFT,258 /// Fungible tokens.259 Fungible(DecimalPoints),260 /// Refungible tokens.261 ReFungible,262}263264impl CollectionMode {265 /// Get collection mod as number.266 pub fn id(&self) -> u8 {267 match self {268 CollectionMode::NFT => 1,269 CollectionMode::Fungible(_) => 2,270 CollectionMode::ReFungible => 3,271 }272 }273}274275// TODO: unused trait276pub trait SponsoringResolve<AccountId, Call> {277 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;278}279280/// Access mode for some token operations.281#[derive(Encode, Decode, Eq, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]282#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]283pub enum AccessMode {284 /// Access grant for owner and admins. Used as default.285 Normal,286 /// Like a [`Normal`](AccessMode::Normal) but also users in allow list.287 AllowList,288}289impl Default for AccessMode {290 fn default() -> Self {291 Self::Normal292 }293}294295// TODO: remove in future.296#[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}307308// TODO: unused type309#[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}315316/// The state of collection sponsorship.317#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]318#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]319pub enum SponsorshipState<AccountId> {320 /// The fees are applied to the transaction sender.321 Disabled,322 /// The sponsor is under consideration. Until the sponsor gives his consent,323 /// the fee will still be charged to sender.324 Unconfirmed(AccountId),325 /// Transactions are sponsored by specified account.326 Confirmed(AccountId),327}328329impl<AccountId> SponsorshipState<AccountId> {330 /// Get a sponsor of the collection who has confirmed his status.331 pub fn sponsor(&self) -> Option<&AccountId> {332 match self {333 Self::Confirmed(sponsor) => Some(sponsor),334 _ => None,335 }336 }337338 /// Get a sponsor of the collection who has pending or confirmed status.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 /// Whether the sponsorship is confirmed.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 /// Tokens in foreign collections can be transferred, but not burnt366 #[bondrewd(bits = "0..1")]367 pub foreign: bool,368 /// External collections can't be managed using `unique` api369 #[bondrewd(bits = "7..8")]370 pub external: bool,371372 #[bondrewd(reserve, bits = "1..7")]373 pub reserved: u8,374}375bondrewd_codec!(CollectionFlags);376377/// Base structure for represent collection.378///379/// Used to provide basic functionality for all types of collections.380///381/// #### Note382/// Collection parameters, used in storage (see [`RpcCollection`] for the RPC version).383#[struct_versioning::versioned(version = 2, upper)]384#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]385pub struct Collection<AccountId> {386 /// Collection owner account.387 pub owner: AccountId,388389 /// Collection mode.390 pub mode: CollectionMode,391392 /// Access mode.393 #[version(..2)]394 pub access: AccessMode,395396 /// Collection name.397 pub name: CollectionName,398399 /// Collection description.400 pub description: CollectionDescription,401402 /// Token prefix.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 /// The state of sponsorship of the collection.415 pub sponsorship: SponsorshipState<AccountId>,416417 /// Collection limits.418 pub limits: CollectionLimits,419420 /// Collection permissions.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}436437/// Collection parameters, used in RPC calls (see [`Collection`] for the storage version).438#[derive(Encode, Decode, Clone, PartialEq, TypeInfo)]439#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]440pub struct RpcCollection<AccountId> {441 /// Collection owner account.442 pub owner: AccountId,443444 /// Collection mode.445 pub mode: CollectionMode,446447 /// Collection name.448 pub name: Vec<u16>,449450 /// Collection description.451 pub description: Vec<u16>,452453 /// Token prefix.454 pub token_prefix: Vec<u8>,455456 /// The state of sponsorship of the collection.457 pub sponsorship: SponsorshipState<AccountId>,458459 /// Collection limits.460 pub limits: CollectionLimits,461462 /// Collection permissions.463 pub permissions: CollectionPermissions,464465 /// Token property permissions.466 pub token_property_permissions: Vec<PropertyKeyPermission>,467468 /// Collection properties.469 pub properties: Vec<Property>,470471 /// Is collection read only.472 pub read_only: bool,473474 /// Is collection is foreign.475 pub foreign: bool,476}477478/// Data used for create collection.479///480/// All fields are wrapped in [`Option`], where `None` means chain default.481#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Derivative, MaxEncodedLen)]482#[derivative(Debug, Default(bound = ""))]483pub struct CreateCollectionData<AccountId> {484 /// Collection mode.485 #[derivative(Default(value = "CollectionMode::NFT"))]486 pub mode: CollectionMode,487488 /// Access mode.489 pub access: Option<AccessMode>,490491 /// Collection name.492 pub name: CollectionName,493494 /// Collection description.495 pub description: CollectionDescription,496497 /// Token prefix.498 pub token_prefix: CollectionTokenPrefix,499500 /// Pending collection sponsor.501 pub pending_sponsor: Option<AccountId>,502503 /// Collection limits.504 pub limits: Option<CollectionLimits>,505506 /// Collection permissions.507 pub permissions: Option<CollectionPermissions>,508509 /// Token property permissions.510 pub token_property_permissions: CollectionPropertiesPermissionsVec,511512 /// Collection properties.513 pub properties: CollectionPropertiesVec,514}515516/// Bounded vector of properties permissions. Max length is [`MAX_PROPERTIES_PER_ITEM`].517// TODO: maybe rename to PropertiesPermissionsVec518pub type CollectionPropertiesPermissionsVec =519 BoundedVec<PropertyKeyPermission, ConstU32<MAX_PROPERTIES_PER_ITEM>>;520521/// Bounded vector of properties. Max length is [`MAX_PROPERTIES_PER_ITEM`].522pub type CollectionPropertiesVec = BoundedVec<Property, ConstU32<MAX_PROPERTIES_PER_ITEM>>;523524/// Limits and restrictions of a collection.525///526/// All fields are wrapped in [`Option`], where `None` means chain default.527///528/// Update with `pallet_common::Pallet::clamp_limits`.529// IMPORTANT: When adding/removing fields from this struct - don't forget to also530#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]531#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]532// When adding/removing fields from this struct - don't forget to also update with `pallet_common::Pallet::clamp_limits`.533// TODO: move `pallet_common::Pallet::clamp_limits` into `impl CollectionLimits`.534// TODO: may be remove [`Option`] and **pub** from fields and create struct with default values.535pub struct CollectionLimits {536 /// How many tokens can a user have on one account.537 /// * Default - [`ACCOUNT_TOKEN_OWNERSHIP_LIMIT`].538 /// * Limit - [`MAX_TOKEN_OWNERSHIP`].539 pub account_token_ownership_limit: Option<u32>,540541 /// How many bytes of data are available for sponsorship.542 /// * Default - [`CUSTOM_DATA_LIMIT`].543 /// * Limit - [`CUSTOM_DATA_LIMIT`].544 pub sponsored_data_size: Option<u32>,545546 // FIXME should we delete this or repurpose it?547 /// Times in how many blocks we sponsor data.548 ///549 /// If is `Some(v)` then **setVariableMetadata** is sponsored if there is `v` block between transactions.550 ///551 /// * Default - [`SponsoringDisabled`](SponsoringRateLimit::SponsoringDisabled).552 /// * Limit - [`MAX_SPONSOR_TIMEOUT`].553 ///554 /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]555 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,556 /// Maximum amount of tokens inside the collection. Chain default: [`COLLECTION_TOKEN_LIMIT`]557558 /// How many tokens can be mined into this collection.559 ///560 /// * Default - [`COLLECTION_TOKEN_LIMIT`].561 /// * Limit - [`COLLECTION_TOKEN_LIMIT`].562 pub token_limit: Option<u32>,563564 /// Timeouts for transfer sponsoring.565 ///566 /// * Default567 /// - **Fungible** - [`FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]568 /// - **NFT** - [`NFT_SPONSOR_TRANSFER_TIMEOUT`]569 /// - **Refungible** - [`REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT`]570 /// * Limit - [`MAX_SPONSOR_TIMEOUT`].571 pub sponsor_transfer_timeout: Option<u32>,572573 /// Timeout for sponsoring an approval in passed blocks.574 ///575 /// * Default - [`SPONSOR_APPROVE_TIMEOUT`].576 /// * Limit - [`MAX_SPONSOR_TIMEOUT`].577 pub sponsor_approve_timeout: Option<u32>,578579 /// Whether the collection owner of the collection can send tokens (which belong to other users).580 ///581 /// * Default - **false**.582 pub owner_can_transfer: Option<bool>,583584 /// Can the collection owner burn other people's tokens.585 ///586 /// * Default - **true**.587 pub owner_can_destroy: Option<bool>,588589 /// Is it possible to send tokens from this collection between users.590 ///591 /// * Default - **true**.592 pub transfers_enabled: Option<bool>,593}594595impl CollectionLimits {596 /// Get effective value for [`account_token_ownership_limit`](self.account_token_ownership_limit).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 /// Get effective value for [`sponsored_data_size`](self.sponsored_data_size).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 /// Get effective value for [`token_limit`](self.token_limit).611 pub fn token_limit(&self) -> u32 {612 self.token_limit613 .unwrap_or(COLLECTION_TOKEN_LIMIT)614 .min(COLLECTION_TOKEN_LIMIT)615 }616617 // TODO: may be replace u32 to mode?618 /// Get effective value for [`sponsor_transfer_timeout`](self.sponsor_transfer_timeout).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 /// Get effective value for [`sponsor_approve_timeout`](self.sponsor_approve_timeout).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 /// Get effective value for [`owner_can_transfer`](self.owner_can_transfer).633 pub fn owner_can_transfer(&self) -> bool {634 self.owner_can_transfer.unwrap_or(false)635 }636637 /// Get effective value for [`owner_can_transfer_instaled`](self.owner_can_transfer_instaled).638 pub fn owner_can_transfer_instaled(&self) -> bool {639 self.owner_can_transfer.is_some()640 }641642 /// Get effective value for [`owner_can_destroy`](self.owner_can_destroy).643 pub fn owner_can_destroy(&self) -> bool {644 self.owner_can_destroy.unwrap_or(true)645 }646647 /// Get effective value for [`transfers_enabled`](self.transfers_enabled).648 pub fn transfers_enabled(&self) -> bool {649 self.transfers_enabled.unwrap_or(true)650 }651652 /// Get effective value for [`sponsored_data_rate_limit`](self.sponsored_data_rate_limit).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}663664/// Permissions on certain operations within a collection.665///666/// Some fields are wrapped in [`Option`], where `None` means chain default.667///668/// Update with `pallet_common::Pallet::clamp_permissions`.669#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]670#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]671// When adding/removing fields from this struct - don't forget to also update `pallet_common::Pallet::clamp_permissions`.672// TODO: move `pallet_common::Pallet::clamp_permissions` into `impl CollectionPermissions`.673pub struct CollectionPermissions {674 /// Access mode.675 ///676 /// * Default - [`AccessMode::Normal`].677 pub access: Option<AccessMode>,678679 /// Minting allowance.680 ///681 /// * Default - **false**.682 pub mint_mode: Option<bool>,683684 /// Permissions for nesting.685 ///686 /// * Default687 /// - `token_owner` - **false**688 /// - `collection_admin` - **false**689 /// - `restricted` - **None**690 pub nesting: Option<NestingPermissions>,691}692693impl CollectionPermissions {694 /// Get effective value for [`access`](self.access).695 pub fn access(&self) -> AccessMode {696 self.access.unwrap_or(AccessMode::Normal)697 }698699 /// Get effective value for [`mint_mode`](self.mint_mode).700 pub fn mint_mode(&self) -> bool {701 self.mint_mode.unwrap_or(false)702 }703704 /// Get effective value for [`nesting`](self.nesting).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}716717/// Inner set for collections allowed to nest.718type OwnerRestrictedSetInner = BoundedBTreeSet<CollectionId, ConstU32<16>>;719720/// Wraper for collections set allowing nest.721#[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 /// Create new set.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}747748/// Part of collection permissions, if set, defines who is able to nest tokens into other tokens.749#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen, Derivative)]750#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]751#[derivative(Debug)]752pub struct NestingPermissions {753 /// Owner of token can nest tokens under it.754 pub token_owner: bool,755 /// Admin of token collection can nest tokens under token.756 pub collection_admin: bool,757 /// If set - only tokens from specified collections can be nested.758 pub restricted: Option<OwnerRestrictedSet>,759760 #[cfg(feature = "runtime-benchmarks")]761 /// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`.762 pub permissive: bool,763}764765/// Enum denominating how often can sponsoring occur if it is enabled.766///767/// Used for [`collection limits`](CollectionLimits).768#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]769#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]770pub enum SponsoringRateLimit {771 /// Sponsoring is disabled, and the collection sponsor will not pay for transactions772 SponsoringDisabled,773 /// Once per how many blocks can sponsorship of a transaction type occur774 Blocks(u32),775}776777/// Data used to describe an NFT at creation.778#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]779#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]780#[derivative(Debug)]781pub struct CreateNftData {782 /// Key-value pairs used to describe the token as metadata783 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]784 #[derivative(Debug(format_with = "bounded::vec_debug"))]785 /// Properties that wil be assignet to created item.786 pub properties: CollectionPropertiesVec,787}788789/// Data used to describe a Fungible token at creation.790#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]791#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]792pub struct CreateFungibleData {793 /// Number of fungible coins minted794 pub value: u128,795}796797/// Data used to describe a Refungible token at creation.798#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]799#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]800#[derivative(Debug)]801pub struct CreateReFungibleData {802 /// Number of pieces the RFT is split into803 pub pieces: u128,804805 /// Key-value pairs used to describe the token as metadata806 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]807 #[derivative(Debug(format_with = "bounded::vec_debug"))]808 pub properties: CollectionPropertiesVec,809}810811// TODO: remove this.812#[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}819820/// Enum holding data used for creation of all three item types.821/// Unified data for create item.822#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]823#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]824pub enum CreateItemData {825 /// Data for create NFT.826 NFT(CreateNftData),827 /// Data for create Fungible item.828 Fungible(CreateFungibleData),829 /// Data for create ReFungible item.830 ReFungible(CreateReFungibleData),831}832833/// Extended data for create NFT.834#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]835#[derivative(Debug)]836pub struct CreateNftExData<CrossAccountId> {837 /// Properties that wil be assignet to created item.838 #[derivative(Debug(format_with = "bounded::vec_debug"))]839 pub properties: CollectionPropertiesVec,840841 /// Owner of creating item.842 pub owner: CrossAccountId,843}844845/// Extended data for create ReFungible item.846#[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}854855/// Extended data for create ReFungible item.856#[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}864865/// Unified extended data for creating item.866#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]867#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]868pub enum CreateItemExData<CrossAccountId> {869 /// Extended data for create NFT.870 NFT(871 #[derivative(Debug(format_with = "bounded::vec_debug"))]872 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,873 ),874875 /// Extended data for create Fungible item.876 Fungible(877 #[derivative(Debug(format_with = "bounded::map_debug"))]878 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,879 ),880881 /// Extended data for create ReFungible item in case of882 /// many tokens, each may have only one owner883 RefungibleMultipleItems(884 #[derivative(Debug(format_with = "bounded::vec_debug"))]885 BoundedVec<CreateRefungibleExSingleOwner<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,886 ),887888 /// Extended data for create ReFungible item in case of889 /// single token, which may have many owners890 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}910911/// Token's address, dictated by its collection and token IDs.912#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]913#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]914// todo possibly rename to be used generally as an address pair915pub struct TokenChild {916 /// Token id.917 pub token: TokenId,918919 /// Collection id.920 pub collection: CollectionId,921}922923/// Collection statistics.924#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]925#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]926pub struct CollectionStats {927 /// Number of created items.928 pub created: u32,929930 /// Number of burned items.931 pub destroyed: u32,932933 /// Number of current items.934 pub alive: u32,935}936937/// This type works like [`PhantomData`] but supports generating _scale-info_ descriptions to generate node metadata.938#[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}962963/// Bounded vector of bytes.964pub type BoundedBytes<S> = BoundedVec<u8, S>;965966/// Extra properties for external collections.967pub type AuxPropertyValue = BoundedBytes<ConstU32<MAX_AUX_PROPERTY_VALUE_LENGTH>>;968969/// Property key.970pub type PropertyKey = BoundedBytes<ConstU32<MAX_PROPERTY_KEY_LENGTH>>;971972/// Property value.973pub type PropertyValue = BoundedBytes<ConstU32<MAX_PROPERTY_VALUE_LENGTH>>;974975/// Property permission.976#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]977#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]978pub struct PropertyPermission {979 /// Permission to change the property and property permission.980 ///981 /// If it **false** then you can not change corresponding property even if [`collection_admin`] and [`token_owner`] are **true**.982 pub mutable: bool,983984 /// Change permission for the collection administrator.985 pub collection_admin: bool,986987 /// Permission to change the property for the owner of the token.988 pub token_owner: bool,989}990991impl PropertyPermission {992 /// Creates mutable property permission but changes restricted for collection admin and token owner.993 pub fn none() -> Self {994 Self {995 mutable: true,996 collection_admin: false,997 token_owner: false,998 }999 }1000}10011002/// Property is simpl key-value record.1003#[derive(Encode, Decode, Debug, TypeInfo, Clone, PartialEq, MaxEncodedLen)]1004#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1005pub struct Property {1006 /// Property key.1007 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1008 pub key: PropertyKey,10091010 /// Property value.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}10201021/// Record for proprty key permission.1022#[derive(Encode, Decode, TypeInfo, Debug, MaxEncodedLen, PartialEq, Clone)]1023#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]1024pub struct PropertyKeyPermission {1025 /// Key.1026 #[cfg_attr(feature = "serde1", serde(with = "bounded::vec_serde"))]1027 pub key: PropertyKey,10281029 /// Permission.1030 pub permission: PropertyPermission,1031}10321033impl Into<(PropertyKey, PropertyPermission)> for PropertyKeyPermission {1034 fn into(self) -> (PropertyKey, PropertyPermission) {1035 (self.key, self.permission)1036 }1037}10381039/// Errors for properties actions.1040#[derive(Debug)]1041pub enum PropertiesError {1042 /// The space allocated for properties has run out.1043 ///1044 /// * Limit for colection - [`MAX_COLLECTION_PROPERTIES_SIZE`].1045 /// * Limit for token - [`MAX_TOKEN_PROPERTIES_SIZE`].1046 NoSpaceForProperty,10471048 /// The property limit has been reached.1049 ///1050 /// * Limit - [`MAX_PROPERTIES_PER_ITEM`].1051 PropertyLimitReached,10521053 /// Property key contains not allowed character.1054 InvalidCharacterInPropertyKey,10551056 /// Property key length is too long.1057 ///1058 /// * Limit - [`MAX_PROPERTY_KEY_LENGTH`].1059 PropertyKeyIsTooLong,10601061 /// Property key is empty.1062 EmptyPropertyKey,1063}10641065/// Marker for scope of property.1066///1067/// Scoped property can't be changed by user. Used for external collections.1068#[derive(Encode, Decode, MaxEncodedLen, TypeInfo, PartialEq, Clone, Copy)]1069pub enum PropertyScope {1070 None,1071 Rmrk,1072}10731074impl PropertyScope {1075 /// Apply scope to property key.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}10881089/// Trait for operate with properties.1090pub trait TrySetProperty: Sized {1091 type Value;10921093 /// Try to set property with scope.1094 fn try_scoped_set(1095 &mut self,1096 scope: PropertyScope,1097 key: PropertyKey,1098 value: Self::Value,1099 ) -> Result<(), PropertiesError>;11001101 /// Try to set property with scope from iterator.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 /// Try to set property.1120 fn try_set(&mut self, key: PropertyKey, value: Self::Value) -> Result<(), PropertiesError> {1121 self.try_scoped_set(PropertyScope::None, key, value)1122 }11231124 /// Try to set property from iterator.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}11331134/// Wrapped map for storing properties.1135#[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 /// Create new property map.1143 pub fn new() -> Self {1144 Self(BoundedBTreeMap::new())1145 }11461147 /// Remove property from map.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 /// Get property with appropriate key from map.1155 pub fn get(&self, key: &PropertyKey) -> Option<&Value> {1156 self.0.get(key)1157 }11581159 /// Check if map contains key.1160 pub fn contains_key(&self, key: &PropertyKey) -> bool {1161 self.0.contains_key(key)1162 }11631164 /// Check if map contains key with key validation.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}12161217/// Alias for property permissions map.1218pub type PropertiesPermissionMap = PropertiesMap<PropertyPermission>;12191220/// Wrapper for properties map with consumed space control.1221#[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 /// Create new properies container.1230 pub fn new(space_limit: u32) -> Self {1231 Self {1232 map: PropertiesMap::new(),1233 consumed_space: 0,1234 space_limit,1235 }1236 }12371238 /// Remove propery with appropiate key.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 /// Get property with appropriate key.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}12891290/// Utility struct for using in `StorageMap`.1291pub struct CollectionProperties;12921293impl Get<Properties> for CollectionProperties {1294 fn get() -> Properties {1295 Properties::new(MAX_COLLECTION_PROPERTIES_SIZE)1296 }1297}12981299/// Utility struct for using in `StorageMap`.1300pub struct TokenProperties;13011302impl Get<Properties> for TokenProperties {1303 fn get() -> Properties {1304 Properties::new(MAX_TOKEN_PROPERTIES_SIZE)1305 }1306}13071308// RMRK1309// todo document?1310parameter_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>; // todo make sure it is needed13731374pub type RmrkRpcString = Vec<u8>;1375pub type RmrkThemeName = RmrkRpcString;1376pub type RmrkPropertyKey = RmrkRpcString;primitives/data-structs/src/migration.rsdiffbeforeafterboth--- a/primitives/data-structs/src/migration.rs
+++ b/primitives/data-structs/src/migration.rs
@@ -38,3 +38,26 @@
test_to_option(SponsoringRateLimit::SponsoringDisabled);
test_to_option(SponsoringRateLimit::Blocks(10));
}
+
+#[test]
+fn collection_flags_have_same_encoding_as_bool() {
+ use crate::CollectionFlags;
+ use codec::Encode;
+
+ assert_eq!(
+ true.encode(),
+ CollectionFlags {
+ external: true,
+ ..Default::default()
+ }
+ .encode()
+ );
+ assert_eq!(
+ false.encode(),
+ CollectionFlags {
+ external: false,
+ ..Default::default()
+ }
+ .encode()
+ );
+}