Struct Pallet

pub struct Pallet<T, I = ()>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn create( origin: OriginFor<T>, collection: T::CollectionId, admin: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Issue a new collection of non-fungible items from a public origin.

This new collection has no items initially and its owner is the origin.

The origin must conform to the configured CreateOrigin and have sufficient funds free.

ItemDeposit funds of sender are reserved.

Parameters:

• collection: The identifier of the new collection. This must not be currently in use.
• admin: The admin of this collection. The admin is the initial address of each member of the collection’s admin team.

Emits Created event when successful.

Weight: O(1)

pub fn force_create( origin: OriginFor<T>, collection: T::CollectionId, owner: <<T as Config>::Lookup as StaticLookup>::Source, free_holding: bool, ) -> DispatchResult

Issue a new collection of non-fungible items from a privileged origin.

This new collection has no items initially.

The origin must conform to ForceOrigin.

Unlike create, no funds are reserved.

• collection: The identifier of the new item. This must not be currently in use.
• owner: The owner of this collection of items. The owner has full superuser permissions over this item, but may later change and configure the permissions using transfer_ownership and set_team.

Emits ForceCreated event when successful.

Weight: O(1)

pub fn destroy( origin: OriginFor<T>, collection: T::CollectionId, witness: DestroyWitness, ) -> DispatchResultWithPostInfo

Destroy a collection of fungible items.

The origin must conform to ForceOrigin or must be Signed and the sender must be the owner of the collection.

• collection: The identifier of the collection to be destroyed.
• witness: Information on the items minted in the collection. This must be correct.

Emits Destroyed event when successful.

Weight: O(n + m) where:

• n = witness.items
• m = witness.item_metadatas
• a = witness.attributes

pub fn mint( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, owner: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Mint an item of a particular collection.

The origin must be Signed and the sender must be the Issuer of the collection.

• collection: The collection of the item to be minted.
• item: The item value of the item to be minted.
• beneficiary: The initial owner of the minted item.

Emits Issued event when successful.

Weight: O(1)

pub fn burn( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, check_owner: Option<<<T as Config>::Lookup as StaticLookup>::Source>, ) -> DispatchResult

Destroy a single item.

Origin must be Signed and the signing account must be either:

• the Admin of the collection;

• the Owner of the item;

• collection: The collection of the item to be burned.

• item: The item of the item to be burned.

• check_owner: If Some then the operation will fail with WrongOwner unless the item is owned by this value.

Emits Burned with the actual amount burned.

Weight: O(1) Modes: check_owner.is_some().

pub fn transfer( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, dest: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Move an item from the sender account to another.

This resets the approved account of the item.

Origin must be Signed and the signing account must be either:

• the Admin of the collection;
• the Owner of the item;
• the approved delegate for the item (in this case, the approval is reset).

Arguments:

• collection: The collection of the item to be transferred.
• item: The item of the item to be transferred.
• dest: The account to receive ownership of the item.

Emits Transferred.

Weight: O(1)

pub fn redeposit( origin: OriginFor<T>, collection: T::CollectionId, items: Vec<T::ItemId>, ) -> DispatchResult

Reevaluate the deposits on some items.

Origin must be Signed and the sender should be the Owner of the collection.

• collection: The collection to be frozen.
• items: The items of the collection whose deposits will be reevaluated.

NOTE: This exists as a best-effort function. Any items which are unknown or in the case that the owner account does not have reservable funds to pay for a deposit increase are ignored. Generally the owner isn’t going to call this on items whose existing deposit is less than the refreshed deposit as it would only cost them, so it’s of little consequence.

It will still return an error in the case that the collection is unknown of the signer is not permitted to call it.

Weight: O(items.len())

pub fn freeze( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, ) -> DispatchResult

Disallow further unprivileged transfer of an item.

Origin must be Signed and the sender should be the Freezer of the collection.

• collection: The collection of the item to be frozen.
• item: The item of the item to be frozen.

Emits Frozen.

Weight: O(1)

pub fn thaw( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, ) -> DispatchResult

Re-allow unprivileged transfer of an item.

Origin must be Signed and the sender should be the Freezer of the collection.

• collection: The collection of the item to be thawed.
• item: The item of the item to be thawed.

Emits Thawed.

Weight: O(1)

pub fn freeze_collection( origin: OriginFor<T>, collection: T::CollectionId, ) -> DispatchResult

Disallow further unprivileged transfers for a whole collection.

Origin must be Signed and the sender should be the Freezer of the collection.

• collection: The collection to be frozen.

Emits CollectionFrozen.

Weight: O(1)

pub fn thaw_collection( origin: OriginFor<T>, collection: T::CollectionId, ) -> DispatchResult

Re-allow unprivileged transfers for a whole collection.

Origin must be Signed and the sender should be the Admin of the collection.

• collection: The collection to be thawed.

Emits CollectionThawed.

Weight: O(1)

pub fn transfer_ownership( origin: OriginFor<T>, collection: T::CollectionId, owner: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Change the Owner of a collection.

Origin must be Signed and the sender should be the Owner of the collection.

• collection: The collection whose owner should be changed.
• owner: The new Owner of this collection. They must have called set_accept_ownership with collection in order for this operation to succeed.

Emits OwnerChanged.

Weight: O(1)

pub fn set_team( origin: OriginFor<T>, collection: T::CollectionId, issuer: <<T as Config>::Lookup as StaticLookup>::Source, admin: <<T as Config>::Lookup as StaticLookup>::Source, freezer: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Change the Issuer, Admin and Freezer of a collection.

Origin must be Signed and the sender should be the Owner of the collection.

• collection: The collection whose team should be changed.
• issuer: The new Issuer of this collection.
• admin: The new Admin of this collection.
• freezer: The new Freezer of this collection.

Emits TeamChanged.

Weight: O(1)

pub fn approve_transfer( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, delegate: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Approve an item to be transferred by a delegated third-party account.

The origin must conform to ForceOrigin or must be Signed and the sender must be either the owner of the item or the admin of the collection.

• collection: The collection of the item to be approved for delegated transfer.
• item: The item of the item to be approved for delegated transfer.
• delegate: The account to delegate permission to transfer the item.

Important NOTE: The approved account gets reset after each transfer.

Emits ApprovedTransfer on success.

Weight: O(1)

pub fn cancel_approval( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, maybe_check_delegate: Option<<<T as Config>::Lookup as StaticLookup>::Source>, ) -> DispatchResult

Cancel the prior approval for the transfer of an item by a delegate.

Origin must be either:

• the Force origin;
• Signed with the signer being the Admin of the collection;
• Signed with the signer being the Owner of the item;

Arguments:

• collection: The collection of the item of whose approval will be cancelled.
• item: The item of the item of whose approval will be cancelled.
• maybe_check_delegate: If Some will ensure that the given account is the one to which permission of transfer is delegated.

Emits ApprovalCancelled on success.

Weight: O(1)

pub fn force_item_status( origin: OriginFor<T>, collection: T::CollectionId, owner: <<T as Config>::Lookup as StaticLookup>::Source, issuer: <<T as Config>::Lookup as StaticLookup>::Source, admin: <<T as Config>::Lookup as StaticLookup>::Source, freezer: <<T as Config>::Lookup as StaticLookup>::Source, free_holding: bool, is_frozen: bool, ) -> DispatchResult

Alter the attributes of a given item.

Origin must be ForceOrigin.

• collection: The identifier of the item.
• owner: The new Owner of this item.
• issuer: The new Issuer of this item.
• admin: The new Admin of this item.
• freezer: The new Freezer of this item.
• free_holding: Whether a deposit is taken for holding an item of this collection.
• is_frozen: Whether this collection is frozen except for permissioned/admin instructions.

Emits ItemStatusChanged with the identity of the item.

Weight: O(1)

pub fn set_attribute( origin: OriginFor<T>, collection: T::CollectionId, maybe_item: Option<T::ItemId>, key: BoundedVec<u8, T::KeyLimit>, value: BoundedVec<u8, T::ValueLimit>, ) -> DispatchResult

Set an attribute for a collection or item.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the collection.

If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * (key.len + value.len) taking into account any already reserved funds.

• collection: The identifier of the collection whose item’s metadata to set.
• maybe_item: The identifier of the item whose metadata to set.
• key: The key of the attribute.
• value: The value to which to set the attribute.

Emits AttributeSet.

Weight: O(1)

pub fn clear_attribute( origin: OriginFor<T>, collection: T::CollectionId, maybe_item: Option<T::ItemId>, key: BoundedVec<u8, T::KeyLimit>, ) -> DispatchResult

Clear an attribute for a collection or item.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the collection.

Any deposit is freed for the collection’s owner.

• collection: The identifier of the collection whose item’s metadata to clear.
• maybe_item: The identifier of the item whose metadata to clear.
• key: The key of the attribute.

Emits AttributeCleared.

Weight: O(1)

pub fn set_metadata( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, data: BoundedVec<u8, T::StringLimit>, is_frozen: bool, ) -> DispatchResult

Set the metadata for an item.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the collection.

If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * data.len taking into account any already reserved funds.

• collection: The identifier of the collection whose item’s metadata to set.
• item: The identifier of the item whose metadata to set.
• data: The general information of this item. Limited in length by StringLimit.
• is_frozen: Whether the metadata should be frozen against further changes.

Emits MetadataSet.

Weight: O(1)

pub fn clear_metadata( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, ) -> DispatchResult

Clear the metadata for an item.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the item.

Any deposit is freed for the collection’s owner.

• collection: The identifier of the collection whose item’s metadata to clear.
• item: The identifier of the item whose metadata to clear.

Emits MetadataCleared.

Weight: O(1)

pub fn set_collection_metadata( origin: OriginFor<T>, collection: T::CollectionId, data: BoundedVec<u8, T::StringLimit>, is_frozen: bool, ) -> DispatchResult

Set the metadata for a collection.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the collection.

If the origin is Signed, then funds of signer are reserved according to the formula: MetadataDepositBase + DepositPerByte * data.len taking into account any already reserved funds.

• collection: The identifier of the item whose metadata to update.
• data: The general information of this item. Limited in length by StringLimit.
• is_frozen: Whether the metadata should be frozen against further changes.

Emits CollectionMetadataSet.

Weight: O(1)

pub fn clear_collection_metadata( origin: OriginFor<T>, collection: T::CollectionId, ) -> DispatchResult

Clear the metadata for a collection.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the collection.

Any deposit is freed for the collection’s owner.

• collection: The identifier of the collection whose metadata to clear.

Emits CollectionMetadataCleared.

Weight: O(1)

pub fn set_accept_ownership( origin: OriginFor<T>, maybe_collection: Option<T::CollectionId>, ) -> DispatchResult

Set (or reset) the acceptance of ownership for a particular account.

Origin must be Signed and if maybe_collection is Some, then the signer must have a provider reference.

• maybe_collection: The identifier of the collection whose ownership the signer is willing to accept, or if None, an indication that the signer is willing to accept no ownership transferal.

Emits OwnershipAcceptanceChanged.

pub fn set_collection_max_supply( origin: OriginFor<T>, collection: T::CollectionId, max_supply: u32, ) -> DispatchResult

Set the maximum amount of items a collection could have.

Origin must be either ForceOrigin or Signed and the sender should be the Owner of the collection.

Note: This function can only succeed once per collection.

• collection: The identifier of the collection to change.
• max_supply: The maximum amount of items a collection could have.

Emits CollectionMaxSupplySet event when successful.

pub fn set_price( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, price: Option<BalanceOf<T, I>>, whitelisted_buyer: Option<<<T as Config>::Lookup as StaticLookup>::Source>, ) -> DispatchResult

Set (or reset) the price for an item.

Origin must be Signed and must be the owner of the asset item.

• collection: The collection of the item.
• item: The item to set the price for.
• price: The price for the item. Pass None, to reset the price.
• buyer: Restricts the buy operation to a specific account.

Emits ItemPriceSet on success if the price is not None. Emits ItemPriceRemoved on success if the price is None.

pub fn buy_item( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, bid_price: BalanceOf<T, I>, ) -> DispatchResult

Allows to buy an item if it’s up for sale.

Origin must be Signed and must not be the owner of the item.

• collection: The collection of the item.
• item: The item the sender wants to buy.
• bid_price: The price the sender is willing to pay.

Emits ItemBought on success.

pub fn create_with_extra_deposit_limit( origin: OriginFor<T>, collection: T::CollectionId, admin: <<T as Config>::Lookup as StaticLookup>::Source, limit: BalanceOf<T, I>, ) -> DispatchResult

Issue a new collection of non-fungible items from a public origin.

This new collection has no items initially and its owner is the origin.

The origin must conform to the configured CreateOrigin and have sufficient funds free.

ItemDeposit funds of sender are reserved.

Parameters:

• collection: The identifier of the new collection. This must not be currently in use.
• admin: The admin of this collection. The admin is the initial address of each member of the collection’s admin team.
• extra_deposit_limit: The cap on the total amount of funds that an admin/issuer can reserve from the collection owner (origin of this call) while minting NFTs with extra deposit.

Emits Created event when successful.

Weight: O(1)

pub fn mint_with_extra_deposit( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, owner: <<T as Config>::Lookup as StaticLookup>::Source, deposit: BalanceOf<T, I>, ) -> DispatchResult

Mint an item of a particular collection with extra deposit.

The origin must be Signed and the sender must be the Issuer of the collection.

• collection: The collection of the item to be minted.
• item: The item value of the item to be minted.
• beneficiary: The initial owner of the minted item.

Emits Issued event when successful.

Weight: O(1)

pub fn update_extra_deposit_limit( origin: OriginFor<T>, collection: T::CollectionId, limit: BalanceOf<T, I>, ) -> DispatchResult

Update extra deposit limit for a collection when it’s not against what is already reserved.

Only the collection owner can update this limit to a value higher than the total extra deposit for the collection currently.

Parameters:

• collection: The identifier of the collection owned by the origin.
• limit: The new cap on the total amount of funds that an admin/issuer can reserve from the collection owner (origin of this call) while minting NFTs with extra deposit.

Emits ExtraDepositLimitUpdated event when successful.

Weight: O(1)

Trait Implementations

impl<T: Config<I>, I: 'static> BeforeAllRuntimeMigrations for Pallet<T, I>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, I> Debug for Pallet<T, I>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config<I>, I: 'static> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T, I> PartialEq for Pallet<T, I>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T, I> Eq for Pallet<T, I>