1234567891011121314151617#![cfg_attr(not(feature = "std"), no_std)]1819use core::{20 convert::{TryFrom, TryInto},21 fmt,22};23use frame_support::storage::bounded_btree_map::BoundedBTreeMap;24use sp_std::collections::btree_map::BTreeMap;2526#[cfg(feature = "serde")]27pub use serde::{Serialize, Deserialize};2829use sp_core::U256;30use sp_runtime::{ArithmeticError, sp_std::prelude::Vec};31use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};32pub use frame_support::{33 BoundedVec, construct_runtime, decl_event, decl_module, decl_storage, decl_error,34 dispatch::DispatchResult,35 ensure, fail, parameter_types,36 traits::{37 Currency, ExistenceRequirement, Get, Imbalance, KeyOwnerProofSystem, OnUnbalanced,38 Randomness, IsSubType, WithdrawReasons,39 },40 weights::{41 constants::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight, WEIGHT_PER_SECOND},42 DispatchInfo, GetDispatchInfo, IdentityFee, Pays, PostDispatchInfo, Weight,43 WeightToFeePolynomial, DispatchClass,44 },45 StorageValue, transactional,46 pallet_prelude::ConstU32,47};48use derivative::Derivative;49use scale_info::TypeInfo;5051mod migration;5253pub const MAX_DECIMAL_POINTS: DecimalPoints = 30;54pub const MAX_REFUNGIBLE_PIECES: u128 = 1_000_000_000_000_000_000_000;55pub const MAX_SPONSOR_TIMEOUT: u32 = 10_368_000;5657pub const MAX_TOKEN_OWNERSHIP: u32 = if cfg!(not(feature = "limit-testing")) {58 100_00059} else {60 1061};62pub const COLLECTION_NUMBER_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {63 100_00064} else {65 1066};67pub const CUSTOM_DATA_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {68 204869} else {70 1071};72pub const COLLECTION_ADMINS_LIMIT: u32 = 5;73pub const COLLECTION_TOKEN_LIMIT: u32 = u32::MAX;74pub const ACCOUNT_TOKEN_OWNERSHIP_LIMIT: u32 = if cfg!(not(feature = "limit-testing")) {75 1_000_00076} else {77 1078};798081pub const NFT_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;82pub const FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;83pub const REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT: u32 = 5;8485pub const SPONSOR_APPROVE_TIMEOUT: u32 = 5;868788pub const OFFCHAIN_SCHEMA_LIMIT: u32 = 8192;89pub const VARIABLE_ON_CHAIN_SCHEMA_LIMIT: u32 = 8192;90pub const CONST_ON_CHAIN_SCHEMA_LIMIT: u32 = 32768;9192pub const MAX_COLLECTION_NAME_LENGTH: u32 = 64;93pub const MAX_COLLECTION_DESCRIPTION_LENGTH: u32 = 256;94pub const MAX_TOKEN_PREFIX_LENGTH: u32 = 16;95969798pub const MAX_ITEMS_PER_BATCH: u32 = 200;99100pub type CustomDataLimit = ConstU32<CUSTOM_DATA_LIMIT>;101102#[derive(103 Encode,104 Decode,105 PartialEq,106 Eq,107 PartialOrd,108 Ord,109 Clone,110 Copy,111 Debug,112 Default,113 TypeInfo,114 MaxEncodedLen,115)]116#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]117pub struct CollectionId(pub u32);118impl EncodeLike<u32> for CollectionId {}119impl EncodeLike<CollectionId> for u32 {}120121#[derive(122 Encode,123 Decode,124 PartialEq,125 Eq,126 PartialOrd,127 Ord,128 Clone,129 Copy,130 Debug,131 Default,132 TypeInfo,133 MaxEncodedLen,134)]135#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]136pub struct TokenId(pub u32);137impl EncodeLike<u32> for TokenId {}138impl EncodeLike<TokenId> for u32 {}139140impl TokenId {141 pub fn try_next(self) -> Result<TokenId, ArithmeticError> {142 self.0143 .checked_add(1)144 .ok_or(ArithmeticError::Overflow)145 .map(Self)146 }147}148149impl From<TokenId> for U256 {150 fn from(t: TokenId) -> Self {151 t.0.into()152 }153}154155impl TryFrom<U256> for TokenId {156 type Error = &'static str;157158 fn try_from(value: U256) -> Result<Self, Self::Error> {159 Ok(TokenId(value.try_into().map_err(|_| "too large token id")?))160 }161}162163pub struct OverflowError;164impl From<OverflowError> for &'static str {165 fn from(_: OverflowError) -> Self {166 "overflow occured"167 }168}169170pub type DecimalPoints = u8;171172#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]173#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]174pub enum CollectionMode {175 NFT,176 177 Fungible(DecimalPoints),178 ReFungible,179}180181impl CollectionMode {182 pub fn id(&self) -> u8 {183 match self {184 CollectionMode::NFT => 1,185 CollectionMode::Fungible(_) => 2,186 CollectionMode::ReFungible => 3,187 }188 }189}190191pub trait SponsoringResolve<AccountId, Call> {192 fn resolve(who: &AccountId, call: &Call) -> Option<AccountId>;193}194195#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]196#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]197pub enum AccessMode {198 Normal,199 AllowList,200}201impl Default for AccessMode {202 fn default() -> Self {203 Self::Normal204 }205}206207#[derive(Encode, Decode, Eq, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]208#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]209pub enum SchemaVersion {210 ImageURL,211 Unique,212}213impl Default for SchemaVersion {214 fn default() -> Self {215 Self::ImageURL216 }217}218219#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]220#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]221pub struct Ownership<AccountId> {222 pub owner: AccountId,223 pub fraction: u128,224}225226#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]227#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]228pub enum SponsorshipState<AccountId> {229 230 Disabled,231 Unconfirmed(AccountId),232 233 Confirmed(AccountId),234}235236impl<AccountId> SponsorshipState<AccountId> {237 pub fn sponsor(&self) -> Option<&AccountId> {238 match self {239 Self::Confirmed(sponsor) => Some(sponsor),240 _ => None,241 }242 }243244 pub fn pending_sponsor(&self) -> Option<&AccountId> {245 match self {246 Self::Unconfirmed(sponsor) | Self::Confirmed(sponsor) => Some(sponsor),247 _ => None,248 }249 }250251 pub fn confirmed(&self) -> bool {252 matches!(self, Self::Confirmed(_))253 }254}255256impl<T> Default for SponsorshipState<T> {257 fn default() -> Self {258 Self::Disabled259 }260}261262#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, MaxEncodedLen)]263#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]264pub struct Collection<AccountId> {265 pub owner: AccountId,266 pub mode: CollectionMode,267 pub access: AccessMode,268 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]269 pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,270 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]271 pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,272 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]273 pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,274 pub mint_mode: bool,275 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]276 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,277 pub schema_version: SchemaVersion,278 pub sponsorship: SponsorshipState<AccountId>,279 pub limits: CollectionLimits, 280 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]281 pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,282 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]283 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,284 pub meta_update_permission: MetaUpdatePermission,285}286287#[derive(Encode, Decode, Clone, PartialEq, TypeInfo, Debug, Derivative, MaxEncodedLen)]288#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]289#[derivative(Default(bound = ""))]290pub struct CreateCollectionData<AccountId> {291 #[derivative(Default(value = "CollectionMode::NFT"))]292 pub mode: CollectionMode,293 pub access: Option<AccessMode>,294 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]295 pub name: BoundedVec<u16, ConstU32<MAX_COLLECTION_NAME_LENGTH>>,296 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]297 pub description: BoundedVec<u16, ConstU32<MAX_COLLECTION_DESCRIPTION_LENGTH>>,298 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]299 pub token_prefix: BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH>>,300 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]301 pub offchain_schema: BoundedVec<u8, ConstU32<OFFCHAIN_SCHEMA_LIMIT>>,302 pub schema_version: Option<SchemaVersion>,303 pub pending_sponsor: Option<AccountId>,304 pub limits: Option<CollectionLimits>,305 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]306 pub variable_on_chain_schema: BoundedVec<u8, ConstU32<VARIABLE_ON_CHAIN_SCHEMA_LIMIT>>,307 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]308 pub const_on_chain_schema: BoundedVec<u8, ConstU32<CONST_ON_CHAIN_SCHEMA_LIMIT>>,309 pub meta_update_permission: Option<MetaUpdatePermission>,310}311312#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo)]313#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]314pub struct NftItemType<AccountId> {315 pub owner: AccountId,316 pub const_data: Vec<u8>,317 pub variable_data: Vec<u8>,318}319320#[derive(Encode, Decode, Default, Debug, Clone, PartialEq, TypeInfo)]321#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]322pub struct FungibleItemType {323 pub value: u128,324}325326#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo)]327#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]328pub struct ReFungibleItemType<AccountId> {329 pub owner: Vec<Ownership<AccountId>>,330 pub const_data: Vec<u8>,331 pub variable_data: Vec<u8>,332}333334335#[derive(Encode, Decode, Debug, Default, Clone, PartialEq, TypeInfo, MaxEncodedLen)]336#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]337pub struct CollectionLimits {338 pub account_token_ownership_limit: Option<u32>,339 pub sponsored_data_size: Option<u32>,340 341 342 343 pub sponsored_data_rate_limit: Option<SponsoringRateLimit>,344 pub token_limit: Option<u32>,345346 347 pub sponsor_transfer_timeout: Option<u32>,348 pub sponsor_approve_timeout: Option<u32>,349 pub owner_can_transfer: Option<bool>,350 pub owner_can_destroy: Option<bool>,351 pub transfers_enabled: Option<bool>,352}353354impl CollectionLimits {355 pub fn account_token_ownership_limit(&self) -> u32 {356 self.account_token_ownership_limit357 .unwrap_or(ACCOUNT_TOKEN_OWNERSHIP_LIMIT)358 .min(MAX_TOKEN_OWNERSHIP)359 }360 pub fn sponsored_data_size(&self) -> u32 {361 self.sponsored_data_size362 .unwrap_or(CUSTOM_DATA_LIMIT)363 .min(CUSTOM_DATA_LIMIT)364 }365 pub fn token_limit(&self) -> u32 {366 self.token_limit367 .unwrap_or(COLLECTION_TOKEN_LIMIT)368 .min(COLLECTION_TOKEN_LIMIT)369 }370 pub fn sponsor_transfer_timeout(&self, default: u32) -> u32 {371 self.sponsor_transfer_timeout372 .unwrap_or(default)373 .min(MAX_SPONSOR_TIMEOUT)374 }375 pub fn sponsor_approve_timeout(&self) -> u32 {376 self.sponsor_approve_timeout377 .unwrap_or(SPONSOR_APPROVE_TIMEOUT)378 .min(MAX_SPONSOR_TIMEOUT)379 }380 pub fn owner_can_transfer(&self) -> bool {381 self.owner_can_transfer.unwrap_or(false)382 }383 pub fn owner_can_destroy(&self) -> bool {384 self.owner_can_destroy.unwrap_or(true)385 }386 pub fn transfers_enabled(&self) -> bool {387 self.transfers_enabled.unwrap_or(true)388 }389 pub fn sponsored_data_rate_limit(&self) -> Option<u32> {390 match self391 .sponsored_data_rate_limit392 .unwrap_or(SponsoringRateLimit::SponsoringDisabled)393 {394 SponsoringRateLimit::SponsoringDisabled => None,395 SponsoringRateLimit::Blocks(v) => Some(v.min(MAX_SPONSOR_TIMEOUT)),396 }397 }398}399400#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]401#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]402pub enum SponsoringRateLimit {403 SponsoringDisabled,404 Blocks(u32),405}406407408#[cfg(feature = "serde1")]409mod bounded_serde {410 use core::convert::TryFrom;411 use frame_support::{BoundedVec, traits::Get};412 use serde::{413 ser::{self, Serialize},414 de::{self, Deserialize, Error},415 };416 use sp_std::vec::Vec;417418 pub fn serialize<D, V, S>(value: &BoundedVec<V, S>, serializer: D) -> Result<D::Ok, D::Error>419 where420 D: ser::Serializer,421 V: Serialize,422 {423 (value as &Vec<_>).serialize(serializer)424 }425426 pub fn deserialize<'de, D, V, S>(deserializer: D) -> Result<BoundedVec<V, S>, D::Error>427 where428 D: de::Deserializer<'de>,429 V: de::Deserialize<'de>,430 S: Get<u32>,431 {432 433 let vec = <Vec<V>>::deserialize(deserializer)?;434 let len = vec.len();435 TryFrom::try_from(vec).map_err(|_| D::Error::invalid_length(len, &"lesser size"))436 }437}438439fn bounded_debug<V, S>(v: &BoundedVec<V, S>, f: &mut fmt::Formatter) -> Result<(), fmt::Error>440where441 V: fmt::Debug,442{443 use core::fmt::Debug;444 (&v as &Vec<V>).fmt(f)445}446447#[cfg(feature = "serde1")]448#[allow(dead_code)]449mod bounded_map_serde {450 use core::convert::TryFrom;451 use sp_std::collections::btree_map::BTreeMap;452 use frame_support::{traits::Get, storage::bounded_btree_map::BoundedBTreeMap};453 use serde::{454 ser::{self, Serialize},455 de::{self, Deserialize, Error},456 };457 pub fn serialize<D, K, V, S>(458 value: &BoundedBTreeMap<K, V, S>,459 serializer: D,460 ) -> Result<D::Ok, D::Error>461 where462 D: ser::Serializer,463 K: Serialize + Ord,464 V: Serialize,465 {466 (value as &BTreeMap<_, _>).serialize(serializer)467 }468469 pub fn deserialize<'de, D, K, V, S>(470 deserializer: D,471 ) -> Result<BoundedBTreeMap<K, V, S>, D::Error>472 where473 D: de::Deserializer<'de>,474 K: de::Deserialize<'de> + Ord,475 V: de::Deserialize<'de>,476 S: Get<u32>,477 {478 let map = <BTreeMap<K, V>>::deserialize(deserializer)?;479 let len = map.len();480 TryFrom::try_from(map).map_err(|_| D::Error::invalid_length(len, &"lesser size"))481 }482}483484fn bounded_map_debug<K, V, S>(485 v: &BoundedBTreeMap<K, V, S>,486 f: &mut fmt::Formatter,487) -> Result<(), fmt::Error>488where489 K: fmt::Debug + Ord,490 V: fmt::Debug,491{492 use core::fmt::Debug;493 (&v as &BTreeMap<K, V>).fmt(f)494}495496#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]497#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]498#[derivative(Debug)]499pub struct CreateNftData {500 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]501 #[derivative(Debug(format_with = "bounded_debug"))]502 pub const_data: BoundedVec<u8, CustomDataLimit>,503 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]504 #[derivative(Debug(format_with = "bounded_debug"))]505 pub variable_data: BoundedVec<u8, CustomDataLimit>,506}507508#[derive(Encode, Decode, MaxEncodedLen, Default, Debug, Clone, PartialEq, TypeInfo)]509#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]510pub struct CreateFungibleData {511 pub value: u128,512}513514#[derive(Encode, Decode, MaxEncodedLen, Default, PartialEq, Clone, Derivative, TypeInfo)]515#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]516#[derivative(Debug)]517pub struct CreateReFungibleData {518 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]519 #[derivative(Debug(format_with = "bounded_debug"))]520 pub const_data: BoundedVec<u8, CustomDataLimit>,521 #[cfg_attr(feature = "serde1", serde(with = "bounded_serde"))]522 #[derivative(Debug(format_with = "bounded_debug"))]523 pub variable_data: BoundedVec<u8, CustomDataLimit>,524 pub pieces: u128,525}526527#[derive(Encode, Decode, Debug, Clone, PartialEq, TypeInfo, MaxEncodedLen)]528#[cfg_attr(feature = "std", derive(Serialize, Deserialize))]529pub enum MetaUpdatePermission {530 ItemOwner,531 Admin,532 None,533}534535impl Default for MetaUpdatePermission {536 fn default() -> Self {537 Self::ItemOwner538 }539}540541#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]542#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]543pub enum CreateItemData {544 NFT(CreateNftData),545 Fungible(CreateFungibleData),546 ReFungible(CreateReFungibleData),547}548549#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]550#[derivative(Debug)]551pub struct CreateNftExData<CrossAccountId> {552 #[derivative(Debug(format_with = "bounded_debug"))]553 pub const_data: BoundedVec<u8, CustomDataLimit>,554 #[derivative(Debug(format_with = "bounded_debug"))]555 pub variable_data: BoundedVec<u8, CustomDataLimit>,556 pub owner: CrossAccountId,557}558559#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]560#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]561pub struct CreateRefungibleExData<CrossAccountId> {562 #[derivative(Debug(format_with = "bounded_debug"))]563 pub const_data: BoundedVec<u8, CustomDataLimit>,564 #[derivative(Debug(format_with = "bounded_debug"))]565 pub variable_data: BoundedVec<u8, CustomDataLimit>,566 #[derivative(Debug(format_with = "bounded_map_debug"))]567 pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,568}569570#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, TypeInfo, Derivative)]571#[derivative(Debug(bound = "CrossAccountId: fmt::Debug + Ord"))]572pub enum CreateItemExData<CrossAccountId> {573 NFT(574 #[derivative(Debug(format_with = "bounded_debug"))]575 BoundedVec<CreateNftExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,576 ),577 Fungible(578 #[derivative(Debug(format_with = "bounded_map_debug"))]579 BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,580 ),581 582 RefungibleMultipleItems(583 #[derivative(Debug(format_with = "bounded_debug"))]584 BoundedVec<CreateRefungibleExData<CrossAccountId>, ConstU32<MAX_ITEMS_PER_BATCH>>,585 ),586 587 RefungibleMultipleOwners(CreateRefungibleExData<CrossAccountId>),588}589590impl CreateItemData {591 pub fn data_size(&self) -> usize {592 match self {593 CreateItemData::NFT(data) => data.variable_data.len() + data.const_data.len(),594 CreateItemData::ReFungible(data) => data.variable_data.len() + data.const_data.len(),595 _ => 0,596 }597 }598}599600impl From<CreateNftData> for CreateItemData {601 fn from(item: CreateNftData) -> Self {602 CreateItemData::NFT(item)603 }604}605606impl From<CreateReFungibleData> for CreateItemData {607 fn from(item: CreateReFungibleData) -> Self {608 CreateItemData::ReFungible(item)609 }610}611612impl From<CreateFungibleData> for CreateItemData {613 fn from(item: CreateFungibleData) -> Self {614 CreateItemData::Fungible(item)615 }616}617618#[derive(Encode, Decode, MaxEncodedLen, PartialEq, Clone, Debug, TypeInfo)]619#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]620pub struct CollectionStats {621 pub created: u32,622 pub destroyed: u32,623 pub alive: u32,624}