Struct pallet_fruniques::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn u32_to_instance_id(input: u32) -> T::ItemIdwhere <T as Config>::ItemId: From<u32>,

pub fn u32_to_class_id(input: u32) -> T::CollectionIdwhere <T as Config>::CollectionId: From<u32>,

pub fn bytes_to_u32(input: Vec<u8>) -> u32

pub fn percent_to_permill(input: u32) -> Permill

pub fn permill_to_percent(input: Permill) -> u32

pub fn bytes_to_string(input: Vec<u8>) -> String

pub fn account_id_to_lookup_source( account_id: &T::AccountId ) -> <T::Lookup as StaticLookup>::Source

pub fn dummy_description() -> CollectionDescription<T>

pub fn dummy_attributes() -> Vec<(AttributeKey<T>, AttributeValue<T>)>

pub fn get_nft_attribute( class_id: &T::CollectionId, instance_id: &T::ItemId, key: &[u8] ) -> AttributeValue<T>

Helper function for printing purposes

pub fn admin_of( class_id: &T::CollectionId, instance_id: &T::ItemId ) -> Option<T::AccountId>

pub fn is_frozen( collection_id: &T::CollectionId, instance_id: &T::ItemId ) -> bool

pub fn collection_exists(class_id: &T::CollectionId) -> bool

pub fn instance_exists( class_id: &T::CollectionId, instance_id: &T::ItemId ) -> bool

pub fn do_initial_setup() -> DispatchResult

pub fn set_attribute( origin: OriginFor<T>, class_id: &T::CollectionId, instance_id: T::ItemId, key: AttributeKey<T>, value: AttributeValue<T> ) -> DispatchResult

pub fn do_mint( collection: T::CollectionId, owner: T::AccountId, metadata: CollectionDescription<T>, attributes: Option<Attributes<T>> ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn do_freeze( class_id: &T::CollectionId, instance_id: T::ItemId ) -> DispatchResult

pub fn do_thaw( class_id: &T::CollectionId, instance_id: T::ItemId ) -> DispatchResult

pub fn burn( origin: OriginFor<T>, class_id: &T::CollectionId, instance_id: T::ItemId ) -> DispatchResult

pub fn do_create_collection( origin: OriginFor<T>, metadata: CollectionDescription<T>, admin: T::AccountId ) -> Result<T::CollectionId, DispatchError>where <T as Config>::CollectionId: From<u32>,

Helper function to create a new collection Creates a collection and updates its metadata if needed.

pub fn do_spawn( collection: T::CollectionId, owner: T::AccountId, metadata: CollectionDescription<T>, attributes: Option<Attributes<T>>, parent_info: Option<ParentInfo<T>> ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn do_nft_division( collection: T::CollectionId, item: T::ItemId, metadata: CollectionDescription<T>, parent_info: &ParentInfo<T>, user: T::AccountId ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn do_redeem(collection: T::CollectionId, item: T::ItemId) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn get_nft_metadata( collection: T::CollectionId, item: T::ItemId ) -> CollectionDescription<T>

pub fn pallet_id() -> IdOrVec

Helper functions to interact with the RBAC module

pub fn pallet_account() -> T::AccountId

pub fn insert_auth_in_frunique_collection( user: T::AccountId, class_id: T::CollectionId, role: FruniqueRole ) -> DispatchResult

pub fn remove_auth_from_frunique_collection( user: T::AccountId, class_id: T::CollectionId, role: FruniqueRole ) -> DispatchResult

pub fn is_authorized( user: T::AccountId, collection_id: T::CollectionId, permission: Permission ) -> DispatchResult

impl<T> Pallet<T>where T: Config<CollectionId = CollectionId, ItemId = ItemId> + Config,

pub fn initial_setup( origin: OriginFor<T>, freezer: T::AccountId ) -> DispatchResult

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

Creation of a collection

This function creates a collection and an asset class. The collection is a unique identifier for a set of fruniques.

Parameters

• origin: The origin of the transaction.
• metadata: The title of the collection.

pub fn set_attributes( origin: OriginFor<T>, class_id: T::CollectionId, instance_id: T::ItemId, attributes: Attributes<T> ) -> DispatchResult

Set multiple attributes to a frunique.

• origin must be signed by the owner of the frunique.
• class_id must be a valid class of the asset class.
• instance_id must be a valid instance of the asset class.
• attributes must be a list of pairs of key and value.

pub fn spawn( origin: OriginFor<T>, class_id: CollectionId, metadata: CollectionDescription<T>, attributes: Option<Attributes<T>>, parent_info_call: Option<ParentInfoCall<T>> ) -> DispatchResult

NFT creation

Parameters:

• origin must be signed by the owner of the frunique.
• class_id must be a valid class of the asset class.
• metadata Title of the nft.
• attributes An array of attributes (key, value) to be added to the NFT.
• parent_info Optional value needed for the NFT division.

pub fn verify( origin: OriginFor<T>, class_id: CollectionId, instance_id: ItemId ) -> DispatchResult

Verification of the NFT

Parameters:

• origin must be signed by the owner of the frunique.
• class_id must be a valid class of the asset class.
• instance_id must be a valid instance of the asset class.

pub fn invite( origin: OriginFor<T>, class_id: CollectionId, invitee: T::AccountId ) -> DispatchResult

Invite a user to become a collaborator in a collection.

Parameters:

• origin must be signed by the owner of the frunique.
• class_id must be a valid class of the asset class.
• invitee must be a valid user.

Considerations:

This functions enables the owner of a collection to invite a user to become a collaborator. The user will be able to create NFTs in the collection. The user will be able to add attributes to the NFTs in the collection.

pub fn force_set_counter( origin: OriginFor<T>, class_id: T::CollectionId, instance_id: Option<T::ItemId> ) -> DispatchResult

Force set counter

Parameters:

origin must be signed by the Root origin.

• class_id must be a valid class of the asset class.
• instance_id must be a valid instance of the asset class.

Considerations:

This function is only used for testing purposes. Or in case someone calls uniques pallet directly. This function it’s not expected to be used in production as it can lead to unexpected results.

pub fn force_destroy_collection( origin: OriginFor<T>, class_id: T::CollectionId, witness: DestroyWitness, maybe_check_owner: Option<T::AccountId> ) -> DispatchResult

Force destroy collection

Parameters:

• origin must be signed by the Root origin.
• class_id must be a valid class of the asset class.
• witness the witness data to destroy the collection. This is used to prevent accidental destruction of the collection. The witness data is retrieved from the class storage.
• maybe_check_owner Optional value to check if the owner of the collection is the same as the signer.

Considerations:

This function is only used for testing purposes. Or in case someone calls uniques pallet directly. This function it’s not expected to be used in production as it can lead to unexpected results.

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

Kill all the stored data.

This function is used to kill ALL the stored data. Use with caution!

Parameters:

• origin: The user who performs the action.

Considerations:

• This function is only available to the admin with sudo access.

pub fn spam_spawning( origin: OriginFor<T>, number_of_classes: u32, number_of_instances: u32 ) -> DispatchResult

impl<T: Config> Pallet<T>

pub fn freezer() -> Option<T::AccountId>

Keeps track of the number of collections in existence.

impl<T: Config> Pallet<T>

pub fn next_collection() -> CollectionId

Keeps track of the number of collections in existence.

impl<T: Config> Pallet<T>

pub fn next_frunique<KArg>(k: KArg) -> ItemIdwhere KArg: EncodeLike<T::CollectionId>,

Keeps track of the number of fruniques in existence for a collection.

impl<T: Config> Pallet<T>

pub fn frunique_info<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<FruniqueData<T>>where KArg1: EncodeLike<T::CollectionId>, KArg2: EncodeLike<T::ItemId>,

impl<T: Config> Pallet<T>

pub fn frunique_roots<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<bool>where KArg1: EncodeLike<T::CollectionId>, KArg2: EncodeLike<T::ItemId>,

impl<T: Config> Pallet<T>

pub fn frunique_verified<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<bool>where KArg1: EncodeLike<T::CollectionId>, KArg2: EncodeLike<T::ItemId>,

impl<T: Config> Pallet<T>

pub fn frunique_redeemed<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<bool>where KArg1: EncodeLike<T::CollectionId>, KArg2: EncodeLike<T::ItemId>,

Trait Implementations

impl<T> Callable<T> for Pallet<T>where T: Config<CollectionId = CollectionId, ItemId = ItemId> + Config,

type RuntimeCall = 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> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

fn integrity_test()

Run integrity test.

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.

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

fn storage_info() -> Vec<StorageInfo>

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>