Struct pallet_nft::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn collection_owner(
    collection_id: T::NftCollectionId
) -> Option<T::AccountId>

pub fn owner(
    collection_id: T::NftCollectionId,
    item_id: T::NftItemId
) -> Option<T::AccountId>

pub fn do_create_collection(
    owner: T::AccountId,
    collection_id: T::NftCollectionId,
    created_by: Acc,
    metadata: BoundedVecOfUnq<T>
) -> DispatchResult

pub fn do_mint(
    owner: T::AccountId,
    collection_id: T::NftCollectionId,
    item_id: T::NftItemId,
    metadata: BoundedVecOfUnq<T>
) -> DispatchResult

pub fn set_metadata(
    owner: T::AccountId,
    collection_id: T::NftCollectionId,
    item_id: T::NftItemId,
    metadata: BoundedVecOfUnq<T>
) -> DispatchResult

pub fn do_transfer(
    collection_id: T::NftCollectionId,
    item_id: T::NftItemId,
    from: T::AccountId,
    to: T::AccountId
) -> DispatchResult

pub fn do_burn(
    owner: T::AccountId,
    collection_id: T::NftCollectionId,
    item_id: T::NftItemId
) -> DispatchResult

pub fn do_destroy_collection(
    owner: T::AccountId,
    collection_id: T::NftCollectionId
) -> DispatchResult

impl<T: Config> Pallet<T>

pub fn create_collection(
    origin: OriginFor<T>,
    collection_id: PossibleCollections,
    metadata: BoundedVecOfUnq<T>
) -> DispatchResult

Creates an NFT Collection of the given Collection and sets its metadata

Parameters:

• collection_id: Identifier of a Collection
• metadata: Arbitrary data about a Collection, e.g. IPFS hash or name

Emits CollectionCreated event

pub fn mint(
    origin: OriginFor<T>,
    collection_id: PossibleCollections,
    metadata: BoundedVecOfUnq<T>
) -> DispatchResult

Mints a NFT in the specified Collection and sets its metadata

Parameters:

• collection_id: The Collection of the asset to be minted.
• item_id: The Collection of the asset to be minted.
• metadata: Arbitrary data about an Item, e.g. IPFS hash or symbol

pub fn transfer(
    origin: OriginFor<T>,
    collection_id: PossibleCollections,
    item_id: T::NftItemId,
    dest: <T::Lookup as StaticLookup>::Source
) -> DispatchResult

Triggered by Root(origin), this transfers NFT from owner account to dest account

Parameters:

• collection_id: The Collection of the asset to be transferred.
• item_id: The Item of the asset to be transferred.
• dest: The account to receive ownership of the asset.

pub fn burn(
    origin: OriginFor<T>,
    collection_id: PossibleCollections,
    item_id: T::NftItemId
) -> DispatchResult

Triggered by a servicer (origin) this removes a token from existence

Parameters:

• collection_id: The Collection of the asset to be burned.
• item_id: The Item of the asset to be burned.

pub fn destroy_collection(
    origin: OriginFor<T>,
    collection_id: PossibleCollections
) -> DispatchResult

Removes a Collection from existence

Parameters:

• collection_id: The identifier of the asset Collection to be destroyed.

impl<T: Config> Pallet<T>

pub fn collections<KArg>(k: KArg) -> Option<CollectionInfo<BoundedVecOfUnq<T>>>where
    KArg: EncodeLike<T::NftCollectionId>,

Stores Collection info

impl<T: Config> Pallet<T>

pub fn items<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<ItemInfoOf<T>>where
    KArg1: EncodeLike<T::NftCollectionId>,
    KArg2: EncodeLike<T::NftItemId>,

Stores Item info

impl<T: Config> Pallet<T>

pub fn itemid() -> Vec<u32>

Update Item ID

Trait Implementations

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

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn create_collection(
    collection: &Self::CollectionId,
    who: &T::AccountId,
    _admin: &T::AccountId
) -> DispatchResult

Create a collection of nonfungible items to be owned by who and managed by admin.

impl<T: Config> CreateTypedCollection<<T as Config>::AccountId, <T as Config>::NftCollectionId> for Pallet<T>

fn create_typed_collection(
    owner: T::AccountId,
    collection_id: T::NftCollectionId
) -> DispatchResult

This function create an NFT collection of created_by type.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

type DestroyWitness = DestroyWitness

The witness data needed to destroy an item.

fn get_destroy_witness(
    collection: &Self::CollectionId
) -> Option<Self::DestroyWitness>

Provide the appropriate witness data needed to destroy an item.

fn destroy(
    collection: Self::CollectionId,
    _witness: Self::DestroyWitness,
    _maybe_check_owner: Option<T::AccountId>
) -> Result<Self::DestroyWitness, DispatchError>

Destroy an existing fungible item.

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

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

type ItemId = <T as Config>::NftItemId

Type for identifying an item.

type CollectionId = <T as Config>::NftCollectionId

Type for identifying a collection (an identifier for an independent collection of items).

fn owner(
    collection: &Self::CollectionId,
    item: &Self::ItemId
) -> Option<T::AccountId>

Returns the owner of item of collection, or None if the item doesn’t exist (or somehow has no owner).

fn collection_owner(collection: &Self::CollectionId) -> Option<T::AccountId>

Returns the owner of the collection, if there is one. For many NFTs this may not make any sense, so users of this API should not be surprised to find a collection results in None here.

fn attribute(
    _collection: &Self::CollectionId,
    _item: &Self::ItemId,
    _key: &[u8]
) -> Option<Vec<u8, Global>>

Returns the attribute value of item of collection corresponding to key.

fn typed_attribute<K, V>(
    collection: &Self::CollectionId,
    item: &Self::ItemId,
    key: &K
) -> Option<V>where
    K: Encode,
    V: Decode,

Returns the strongly-typed attribute value of item of collection corresponding to key.

fn collection_attribute(
    _collection: &Self::CollectionId,
    _key: &[u8]
) -> Option<Vec<u8, Global>>

Returns the attribute value of collection corresponding to key.

fn typed_collection_attribute<K, V>(
    collection: &Self::CollectionId,
    key: &K
) -> Option<V>where
    K: Encode,
    V: Decode,

Returns the strongly-typed attribute value of collection corresponding to key.

fn can_transfer(_collection: &Self::CollectionId, _item: &Self::ItemId) -> bool

Returns true if the item of collection may be transferred.

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

fn collections() -> Box<dyn Iterator<Item = Self::CollectionId>>

Returns an iterator of the collections in existence.

fn items(
    collection: &Self::CollectionId
) -> Box<dyn Iterator<Item = Self::ItemId>>

Returns an iterator of the items of a collection in existence.

fn owned(
    who: &T::AccountId
) -> Box<dyn Iterator<Item = (Self::CollectionId, Self::ItemId)>>

Returns an iterator of the items of all collections owned by who.

fn owned_in_collection(
    collection: &Self::CollectionId,
    who: &T::AccountId
) -> Box<dyn Iterator<Item = Self::ItemId>>

Returns an iterator of the items of collection owned by who.

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

fn integrity_test()

Run integrity test.

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

fn mint_into(
    collection: &Self::CollectionId,
    item: &Self::ItemId,
    who: &T::AccountId
) -> DispatchResult

Mint some item of collection to be owned by who.

fn burn(
    collection: &Self::CollectionId,
    item: &Self::ItemId,
    _maybe_check_owner: Option<&T::AccountId>
) -> DispatchResult

Burn some item of collection.

fn set_attribute(
    _collection: &Self::CollectionId,
    _item: &Self::ItemId,
    _key: &[u8],
    _value: &[u8]
) -> Result<(), DispatchError>

Set attribute value of item of collection’s key.

fn set_typed_attribute<K, V>(
    collection: &Self::CollectionId,
    item: &Self::ItemId,
    key: &K,
    value: &V
) -> Result<(), DispatchError>where
    K: Encode,
    V: Encode,

Attempt to set the strongly-typed attribute value of item of collection’s key.

fn set_collection_attribute(
    _collection: &Self::CollectionId,
    _key: &[u8],
    _value: &[u8]
) -> Result<(), DispatchError>

Set attribute value of collection’s key.

fn set_typed_collection_attribute<K, V>(
    collection: &Self::CollectionId,
    key: &K,
    value: &V
) -> Result<(), DispatchError>where
    K: Encode,
    V: Encode,

Attempt to set the strongly-typed attribute value of collection’s key.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Config> ReserveCollectionId<<T as Config>::NftCollectionId> for Pallet<T>

fn is_id_reserved(id: T::NftCollectionId) -> bool

This function returns true if collection id is from the reserved range, false otherwise.

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

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>