Module pallet 

The pallet module in each FRAME pallet hosts the most important items needed to construct this pallet.

The main components of this pallet are:

• Pallet, which implements all of the dispatchable extrinsics of the pallet, among other public functions.
  • The subset of the functions that are dispatchable can be identified either in the dispatchables module or in the Call enum.
• storage_types, which contains the list of all types that are representing a storage item. Otherwise, all storage items are listed among Type Definitions.
• Config, which contains the configuration trait of this pallet.
• Event and Error, which are listed among the Enums.

Modules

dispatchables

Auto-generated docs-only module listing all defined dispatchables for this pallet.

storage_types

Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.

Structs

CollectionInfo

Collection owner, ownership handoff, item allocation, and deposit accounting.

ItemDefinition

Immutable shared definition for every minted copy of an item.

LockInfo

Post-failure backoff lock for an NFT purse key.

MetadataEntry

One stored metadata entry and the deposit backing it.

Nft

A minted Scarcity instance.

Pallet

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

Enums

Call

Contains a variant per dispatchable extrinsic that this pallet has.

Error

The Error enum of this pallet.

Event

The Event enum of this pallet

HoldReason

Hold reason available to runtimes which back Config::Consideration with fungible holds.

Origin

A Scarcity NFT held by the custom dispatch origin.

Traits

Config

Configuration trait of this pallet.

Type Aliases

BalanceOf

CollectionId

CollectionInfoOf

CollectionMetadata

Collection-wide defaults inherited by every item in a collection.

Collections

Immutable item catalogues, grouped by their collection.

InstanceDeposits

Exact per-instance storage deposits, present only for deposit-paying mints.

InstanceId

Permanent global serial, assigned at mint.

InstanceMetadata

Per-instance entries which override item and collection metadata for the same key.

InstanceMetadataCount

Number of metadata overrides stored for each live instance.

Instances

Stable reverse index from instance identifier to its current owner key.

ItemDefs

Immutable item definitions, indexed within their collection.

ItemIndex

Index within a collection; (CollectionId, ItemIndex) names an item definition.

ItemMetadata

Per-item defaults which override collection defaults for the same key.

Locked

Post-failure backoff locks for NFT purse keys.

MetadataKeyOf

MetadataValueOf

ModuleDeprecated

Type alias to Pallet, to be used by construct_runtime.

NextCollectionId

The next collection identifier to allocate.

NextInstanceId

The next permanent instance identifier to allocate.

NftsByOwner

One NFT per owner key — the coinage model.