Struct pallet_im_online::pallet::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 heartbeat( origin: OriginFor<T>, heartbeat: Heartbeat<BlockNumberFor<T>>, _signature: <T::AuthorityId as RuntimeAppPublic>::Signature ) -> DispatchResult

Complexity:

• O(K) where K is length of Keys (heartbeat.validators_len)
  • O(K): decoding of length K

impl<T: Config> Pallet<T>

pub fn heartbeat_after() -> BlockNumberFor<T>

An auto-generated getter for HeartbeatAfter.

impl<T: Config> Pallet<T>

pub fn keys() -> WeakBoundedVec<T::AuthorityId, T::MaxKeys>

An auto-generated getter for Keys.

impl<T: Config> Pallet<T>

pub fn received_heartbeats<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<bool>

where KArg1: EncodeLike<SessionIndex>, KArg2: EncodeLike<AuthIndex>,

An auto-generated getter for ReceivedHeartbeats.

impl<T: Config> Pallet<T>

pub fn authored_blocks<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> u32

where KArg1: EncodeLike<SessionIndex>, KArg2: EncodeLike<ValidatorId<T>>,

An auto-generated getter for AuthoredBlocks.

impl<T: Config> Pallet<T>

pub fn is_online(authority_index: AuthIndex) -> bool

Returns true if a heartbeat has been received for the authority at authority_index in the authorities series or if the authority has authored at least one block, during the current session. Otherwise false.

pub fn received_heartbeat_in_current_session(authority_index: AuthIndex) -> bool

Returns true if a heartbeat has been received for the authority at authority_index in the authorities series, during the current session. Otherwise false.

Trait Implementations

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

type Public = <T as Config>::AuthorityId

The RuntimeAppPublic this type is bound to.

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 + Config> EventHandler<<<T as Config>::ValidatorSet as ValidatorSet<<T as Config>::AccountId>>::ValidatorId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

Keep track of number of authored blocks per authority, uncles are counted as well since they’re a valid proof of being online.

fn note_author(author: ValidatorId<T>)

Note that the given account ID is the author of the current block.

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

type CurrentStorageVersion = StorageVersion

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 offchain_worker(now: BlockNumberFor<T>)

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

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_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

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

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

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

type Key = <T as Config>::AuthorityId

The key type expected.

fn on_genesis_session<'a, I>(validators: I)

where I: Iterator<Item = (&'a T::AccountId, T::AuthorityId)> + 'a,

The given validator set will be used for the genesis session. It is guaranteed that the given validator set will also be used for the second session, therefore the first call to on_new_session should provide the same validator set.

fn on_new_session<'a, I>(_changed: bool, validators: I, _queued_validators: I)

where I: Iterator<Item = (&'a T::AccountId, T::AuthorityId)> + 'a,

Session set has changed; act appropriately. Note that this can be called before initialization of your module.

fn on_before_session_ending()

A notification for end of the session.

fn on_disabled(_i: u32)

A validator got disabled. Act accordingly until a new session begins.

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

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

type Call = Call<T>

The call to validate

fn validate_unsigned( _source: TransactionSource, call: &Self::Call ) -> TransactionValidity

Return the validity of the call

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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>