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 get_callback( owner: &T::AccountId, callback_name: Vec<u8>, ) -> Option<T::AccountId>

Retrieves the callback registered by a given owner for a specific callback name.

This function first checks for a specific callback registered by the owner and, if not found, falls back to the global callback registered by the owner.

Arguments

• owner - The account id of the owner of the registered callback.
• callback_name - The name of the callback to be fetched.

pub fn execute<R>( hook_point: HookPoint<T::AccountId>, ) -> Result<R, DispatchError>

where R: Decode,

Executes the logic associated with a given hook point.

This function is responsible for invoking the callback logic registered for a hook point.

Arguments

• hook_point - A struct containing details about the hook point to be executed.

pub fn install( contract_deployment: ContractDeployment<T::AccountId>, ) -> Result<T::AccountId, DispatchError>

Deploys an ink! contract into the runtime.

This function handles the instantiation of an ink! contract, making it available for interaction.

Arguments

• contract_deployment: An instance of the ContractDeployment struct containing all the necessary details for deployment.

pub fn create( callback: &str, owner: T::AccountId, origin: T::AccountId, ) -> HookPoint<T::AccountId>

Initializes and returns a new hook point.

This function creates a new hook point, which can be further customized and then executed.

Arguments

• callback - The fully qualified name of the callback to be associated with the hook point.
• owner - The account id of the owner of the hook point.
• origin - The account id initiating the creation of the hook point.

pub fn prepare_deployment( constructor: &str, creator: T::AccountId, code: Vec<u8>, salt: Vec<u8>, ) -> ContractDeployment<T::AccountId>

Prepares the details for a new contract deployment.

This function assists in creating a ContractDeployment instance by setting up the necessary data, such as the selector derived from the given constructor. The created instance can then be further customized with initial arguments using the add_init_arg method.

Arguments

• constructor - A string representing the constructor identifier.
• creator - The account ID of the entity deploying the contract.
• code - The compiled wasm code of the ink! contract.
• salt - A unique salt to ensure the resulting contract address is unique.

Returns

A new ContractDeployment instance.

impl<T: Config> Pallet<T>

pub fn register_global_callback( origin: OriginFor<T>, contract: T::AccountId, ) -> DispatchResult

Register a global ink! callback for an address.

This contract is used for each callback within the substrate system. It allows a user to set a default callback contract that will be triggered for any hook point unless a specific callback is set.

• contract: The contract address to use as the endpoint for all callbacks.

pub fn register_specific_callback( origin: OriginFor<T>, contract: T::AccountId, id: Vec<u8>, ) -> DispatchResult

Register a specific ink! callback for an address.

Allows a user to set a callback for a specific hook point. This will take precedence over the global callback for the given hook point.

• contract: Contract address to use as the endpoint for this specific callback.
• id: Identifier for this registration.

impl<T: Config> Pallet<T>

pub fn callbacks<KArg>(k: KArg) -> Option<T::AccountId>

where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for GlobalCallbacks.

impl<T: Config> Pallet<T>

pub fn specific_callbacks<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> Option<T::AccountId>

where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<BoundedVec<u8, T::MaxLengthId>>,

An auto-generated getter for SpecificCallbacks.

Trait Implementations

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

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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>::Block as HeaderProvider>::HeaderT as Header>::Number> 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).

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>::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>)

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, 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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> 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 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> 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>