Struct pallet_im_online::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn heartbeat(
    origin: OriginFor<T>,
    heartbeat: Heartbeat<T::BlockNumber>,
    _signature: <T::AuthorityId as RuntimeAppPublic>::Signature
) -> DispatchResult

• Complexity: O(K + E) where K is length of Keys (heartbeat.validators_len) and E is length of heartbeat.network_state.external_address
  • O(K): decoding of length K
  • O(E): decoding/encoding of length E
• DbReads: pallet_session Validators, pallet_session CurrentIndex, Keys, ReceivedHeartbeats
• DbWrites: ReceivedHeartbeats

impl<T: Config> Pallet<T>

pub fn heartbeat_after() -> T::BlockNumber

The block number after which it’s ok to send heartbeats in the current session.

At the beginning of each session we set this to a value that should fall roughly in the middle of the session duration. The idea is to first wait for the validators to produce a block in the current session, so that the heartbeat later on will not be necessary.

This value will only be used as a fallback if we fail to get a proper session progress estimate from NextSessionRotation, as those estimates should be more accurate then the value we calculate for HeartbeatAfter.

impl<T: Config> Pallet<T>

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

The current set of keys that may issue a heartbeat.

impl<T: Config> Pallet<T>

pub fn received_heartbeats<KArg1, KArg2>(
    k1: KArg1,
    k2: KArg2
) -> Option<WrapperOpaque<BoundedOpaqueNetworkState<T::MaxPeerDataEncodingSize, T::MaxPeerDataEncodingSize, T::MaxPeerInHeartbeats>>>where
    KArg1: EncodeLike<SessionIndex>,
    KArg2: EncodeLike<AuthIndex>,

For each session index, we keep a mapping of SessionIndex and AuthIndex to WrapperOpaque<BoundedOpaqueNetworkState>.

impl<T: Config> Pallet<T>

pub fn authored_blocks<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> u32where
    KArg1: EncodeLike<SessionIndex>,
    KArg2: EncodeLike<ValidatorId<T>>,

For each session index, we keep a mapping of ValidatorId<T> to the number of blocks authored by the given authority.

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

fn note_uncle(author: ValidatorId<T>, _age: T::BlockNumber)

Note that the given account ID authored the given uncle, and how many blocks older than the current block it is (age >= 0, so siblings are allowed)

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

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

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