Struct Pallet

pub struct Pallet<T>(PhantomData<T>);

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

Tuple Fields

0: PhantomData<T>

Implementations

impl<T: Config> Pallet<T>

Exposes callable functions to interact with the pallet.

pub fn register_member( origin: OriginFor<T>, network: NetworkId, member: AccountId, peer_id: PeerId, ) -> DispatchResult

register_member: Registers a member with specified network ID, public key, peer ID, and bond (staking amount).

Flow

1. Receives origin (caller’s account), network (NetworkId), peer_id (PeerId).
2. Ensures the origin is AdminOrigin (authenticated).
3. Validates the public_key against the origin account.
4. Checks if the member is already registered and unregisters them if necessary.
5. Inserts member data into respective storage maps (MemberNetwork::<T>, MemberPeerId::<T>, Heartbeat::<T>).
6. Marks the member as online (MemberOnline::<T>).
7. Emits Event::RegisteredMember.
8. Calls Self::member_online to notify the network election system.
9. Returns Ok(()) if successful.

pub fn unregister_member( origin: OriginFor<T>, member: AccountId, ) -> DispatchResult

• unregister_member: Unregisters a member from the network.

Flow

1. Receives origin (caller’s account).
2. Ensures the origin is signed (authenticated) and retrieves the member account.
3. Retrieves the current network of the member ([MemberNetwork::<T>::take(&member)]).
4. Calls Self::unregister_member_from_network to perform the actual unregistration tasks:
5. Removes data from storage (MemberPeerId::<T>, Heartbeat::<T>, MemberOnline::<T>).
6. Emits Event::UnRegisteredMember.
7. Calls Self::member_offline to mark the member as offline and calculate weight adjustments.
8. Returns Ok(()) if successful.

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

send_heartbeat: Updates the last heartbeat time for a member.

Flow

1. Receives origin (caller’s account).
2. Ensures the origin is signed (authenticated) and retrieves the member account.
3. Checks if the member is registered ([MemberNetwork::<T>::get(&member)]).
4. Updates the Heartbeat::<T> storage for the member.
5. Emits Event::HeartbeatReceived.
6. Calls Self::is_member_online to check if the member is already online.
   1. If not online, calls Self::member_online to mark them as online.
7. Returns Ok(()) if successful.

impl<T: Config> Pallet<T>

pub(crate) fn timeout_heartbeats() -> Weight

Handles periodic heartbeat checks and manages member online/offline statuses.

fn member_online(member: &AccountId, network: NetworkId)

Marks a member as online.

Flow

1. Receives member (account of the member) and network (NetworkId).
2. Inserts member into MemberOnline::<T> storage.
3. Emits Event::MemberOnline.
4. Calls Elections::member_online to notify the election system of the member’s online status.

fn members_offline(members: Vec<AccountId>, network: NetworkId)

Marks members as offline.

Flow

1. Receives members (accounts of the members) and network (NetworkId).
2. Removes members from MemberOnline::<T> storage.
3. Emits [Event::MembersOffline].

pub fn heartbeat_timeout() -> BlockNumberFor<T>

Retrieves the heartbeat timeout value.

This function fetches the timeout duration for heartbeats from the associated configuration. The heartbeat timeout is used to determine the maximum allowed duration between heartbeats before considering the node as inactive.

impl<T: Config> Pallet<T>

pub(crate) fn deposit_event(event: Event<T>)

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,

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 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> 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.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

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

Implements hooks for pallet initialization and block processing.

fn on_initialize(n: BlockNumberFor<T>) -> 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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

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

fn member_peer_id(account: &AccountId) -> Option<PeerId>

Retrieves the peer ID of a specific member.

fn is_member_online(account: &AccountId) -> bool

Checks if a specific member is online.

fn is_member_registered(account: &AccountId) -> bool

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>