Struct Pallet 

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

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

Implementations

impl<T: Config> Pallet<T>

pub fn create_collection(origin: OriginFor<T>) -> DispatchResult

Create a collection owned by the signer.

pub fn define_item( origin: OriginFor<T>, collection: CollectionId, metadata: Vec<(MetadataKeyOf<T>, MetadataValueOf<T>)>, ) -> DispatchResult

Define one immutable item and its shared metadata defaults.

The supplied metadata is inherited by every instance minted from this definition. Instance-specific values belong on Self::mint or Self::set_instance_metadata.

pub fn mint( origin: OriginFor<T>, collection: CollectionId, item: ItemIndex, to: T::AccountId, metadata: Vec<(MetadataKeyOf<T>, MetadataValueOf<T>)>, ) -> DispatchResult

Mint an instance of an immutable item definition into an empty purse key.

The destination gives no consent; any empty key is a valid target. See the module documentation on purse-key occupancy.

metadata contains instance-specific overrides. Item metadata remains the shared default for every instance minted from the definition.

pub fn transfer( origin: OriginFor<T>, to: T::AccountId, ) -> DispatchResultWithPostInfo

Transfer an NFT held by the Origin::Nft purse-key origin.

pub fn burn(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Burn an NFT held by the Origin::Nft purse-key origin.

Item-definition supply counts minted-ever instances and is deliberately monotonic. Item metadata belongs to the definition and remains untouched. Instance metadata is removed and its exact deposits are released.

pub fn nominate_collection_owner( origin: OriginFor<T>, collection: CollectionId, pending_owner: Option<T::AccountId>, ) -> DispatchResult

Nominate an account to claim ownership of a collection.

Only the current owner may nominate or clear a prospective owner. Nomination does not change authority or move deposits.

pub fn set_collection_metadata( origin: OriginFor<T>, collection: CollectionId, key: MetadataKeyOf<T>, value: Option<MetadataValueOf<T>>, ) -> DispatchResult

Set or remove a collection-level metadata default.

Only the collection owner may mutate metadata. None releases an existing entry’s deposit; when the key is absent it is a successful no-op.

pub fn set_item_metadata( origin: OriginFor<T>, collection: CollectionId, item: ItemIndex, key: MetadataKeyOf<T>, value: Option<MetadataValueOf<T>>, ) -> DispatchResult

Set or remove a metadata default shared by every instance of an item.

This scope overrides the collection default without changing any instance-specific override. Only the collection owner may mutate metadata. None releases an existing entry’s deposit; when the key is absent it is a successful no-op.

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

Claim a collection after nomination by its current owner.

An equivalent aggregate consideration is first created for the claimant and then the previous owner’s ticket is dropped. The operation is atomic: failure to establish the claimant’s consideration leaves ownership and both tickets unchanged.

pub fn set_instance_metadata( origin: OriginFor<T>, instance: InstanceId, key: MetadataKeyOf<T>, value: Option<MetadataValueOf<T>>, ) -> DispatchResult

Set or remove an instance-specific metadata override.

Only the collection owner may mutate metadata. None releases an existing entry’s deposit; when the key is absent it is a successful no-op.

pub fn force_burn( origin: OriginFor<T>, instance: InstanceId, ) -> DispatchResultWithPostInfo

Force-burn one live instance as its collection owner.

The collection layer intentionally applies no holder-level ACL. When a runtime exposes this call to its contract environment, a contract-owned collection can enforce its own consent and game rules before calling it.

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

Delete an unused item definition owned by the signer.

Every live instance must be burned and every item metadata entry removed first. Deleted item indices are never reused.

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

Delete an empty collection owned by the signer.

Every item definition and collection metadata entry must be removed first. Deleted collection identifiers are never reused.

pub fn force_transfer( origin: OriginFor<T>, instance: InstanceId, to: T::AccountId, ) -> DispatchResult

Force-transfer one live instance as its collection owner.

The collection layer intentionally applies no holder-level ACL. When a runtime exposes this call to its contract environment, a contract-owned collection can enforce its own consent and game rules before calling it. The move increments the instance state nonce, invalidating prior holder authorizations.

impl<T: Config> Pallet<T>

pub fn do_create_collection( owner: T::AccountId, ) -> Result<CollectionId, DispatchError>

Allocate a collection identifier and record its initial owner.

pub fn do_define_item( owner: T::AccountId, collection: CollectionId, metadata: Vec<(MetadataKeyOf<T>, MetadataValueOf<T>)>, ) -> Result<ItemIndex, DispatchError>

Add an immutable item definition to an owned collection.

pub fn item_metadata_of( collection: CollectionId, item: ItemIndex, key: &MetadataKeyOf<T>, ) -> Option<MetadataValueOf<T>>

Effective value for key on (collection, item).

An item-level entry wins; otherwise the collection-level default is returned.

pub fn instance_metadata_of( instance: InstanceId, key: &MetadataKeyOf<T>, ) -> Option<MetadataValueOf<T>>

Effective value for key on a live minted instance.

An instance-level entry wins, followed by the item definition and then collection.

pub fn collection_metadata_of( collection: CollectionId, key: &MetadataKeyOf<T>, ) -> Option<MetadataValueOf<T>>

Only the collection-level value for key, without item-level resolution.

pub fn do_mint( owner: T::AccountId, collection: CollectionId, item: ItemIndex, to: T::AccountId, metadata: Vec<(MetadataKeyOf<T>, MetadataValueOf<T>)>, ) -> Result<InstanceId, DispatchError>

Mint an instance after enforcing collection ownership and the one-NFT-per-key rule.

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + Config, T::RuntimeCall: From<Call<T>> + Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo> + GetDispatchInfo,

Available on crate features runtime-benchmarks only.

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> DispatchViewFunction for Pallet<T>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

impl<T: Config> GetStorageVersion for Pallet<T>

type InCodeStorageVersion = NoStorageVersionSet

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.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

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 pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> MintWithoutDeposit<<T as Config>::AccountId> for Pallet<T>

type MetadataKey = BoundedVec<u8, <T as Config>::MaxKeyLen>

Bounded metadata key accepted by the implementation.

type MetadataValue = BoundedVec<u8, <T as Config>::MaxValueLen>

Bounded metadata value accepted by the implementation.

fn mint_without_deposit( collection: CollectionId, item: ItemIndex, to: T::AccountId, metadata: Vec<(Self::MetadataKey, Self::MetadataValue)>, ) -> Result<InstanceId, DispatchError>

Mint an instance and its initial metadata without storage deposits.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

impl<T: Config> PalletInfoAccess for Pallet<T>

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> PalletsInfoAccess for Pallet<T>

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> PartialEq for Pallet<T>

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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryDecodeEntireStorage for Pallet<T>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

impl<T: Config> ViewFunctionIdPrefix for Pallet<T>

fn prefix() -> [u8; 16]

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

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> Eq for Pallet<T>