Struct pallet_grandpa::Module

pub struct Module<T: Trait>(_);

Implementations

impl<T: Trait + 'static> Module<T>

pub fn state() -> StoredState<T::BlockNumber>

State of the current authority set.

pub fn pending_change() -> Option<StoredPendingChange<T::BlockNumber>>

Pending change: (signaled at, scheduled change).

pub fn next_forced() -> Option<T::BlockNumber>

next block number where we can force a change.

pub fn stalled() -> Option<(T::BlockNumber, T::BlockNumber)>

true if we are currently stalled.

pub fn current_set_id() -> SetId

The number of changes (both in terms of keys and underlying economic responsibilities) in the “set” of Grandpa validators from genesis.

pub fn session_for_set<K: EncodeLike<SetId>>(key: K) -> Option<SessionIndex>

A mapping from grandpa set ID to the index of the most recent session for which its members were responsible.

TWOX-NOTE: SetId is not under user control.

impl<T: Trait> Module<T>

pub fn grandpa_authorities() -> AuthorityList

Get the current set of authorities, along with their respective weights.

pub fn schedule_pause(in_blocks: T::BlockNumber) -> DispatchResult

Schedule GRANDPA to pause starting in the given number of blocks. Cannot be done when already paused.

pub fn schedule_resume(in_blocks: T::BlockNumber) -> DispatchResult

Schedule a resume of GRANDPA after pausing.

pub fn schedule_change(
    next_authorities: AuthorityList,
    in_blocks: T::BlockNumber,
    forced: Option<T::BlockNumber>
) -> DispatchResult

Schedule a change in the authorities.

The change will be applied at the end of execution of the block in_blocks after the current block. This value may be 0, in which case the change is applied at the end of the current block.

If the forced parameter is defined, this indicates that the current set has been synchronously determined to be offline and that after in_blocks the given change should be applied. The given block number indicates the median last finalized block number and it should be used as the canon block when starting the new grandpa voter.

No change should be signaled while any change is pending. Returns an error if a change is already pending.

pub fn submit_unsigned_equivocation_report(
    equivocation_proof: EquivocationProof<T::Hash, T::BlockNumber>,
    key_owner_proof: T::KeyOwnerProof
) -> Option<()>

Submits an extrinsic to report an equivocation. This method will create an unsigned extrinsic with a call to report_equivocation_unsigned and will push the transaction to the pool. Only useful in an offchain context.

Trait Implementations

impl<T: Trait> BoundToRuntimeAppPublic for Module<T>

type Public = AuthorityId

The RuntimeAppPublic this type is bound to.

impl<T: Trait> Callable<T> for Module<T>

type Call = Call<T>

impl<T: Clone + Trait> Clone for Module<T>

fn clone(&self) -> Module<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + Trait> Copy for Module<T>

impl<T: Trait> Debug for Module<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: Eq + Trait> Eq for Module<T>

impl<T: Trait> IntegrityTest for Module<T>

pub fn integrity_test()

Run integrity test.

impl<T: Trait> ModuleErrorMetadata for Module<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Trait + Trait> OffchainWorker<<T as Trait>::BlockNumber> for Module<T>

pub fn offchain_worker(_n: BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Trait> OnFinalizationStalled<<T as Trait>::BlockNumber> for Module<T>

fn on_stalled(further_wait: T::BlockNumber, median: T::BlockNumber)

The parameter here is how many more blocks to wait before applying changes triggered by finality stalling.

impl<T: Trait + Trait> OnFinalize<<T as Trait>::BlockNumber> for Module<T>

fn on_finalize(block_number: T::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Trait + Trait> OnInitialize<<T as Trait>::BlockNumber> for Module<T>

pub fn on_initialize(_n: BlockNumber) -> u64

The block is being initialized. Implement to have something happen.

impl<T: Trait> OnRuntimeUpgrade for Module<T>

pub fn on_runtime_upgrade() -> u64

Perform a module upgrade.

impl<T: Trait> OneSessionHandler<<T as Trait>::AccountId> for Module<T> where
    T: Trait, 

type Key = AuthorityId

The key type expected.

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

fn on_new_session<'a, I: 'a>(
    changed: bool,
    validators: I,
    _queued_validators: I
) where
    I: Iterator<Item = (&'a T::AccountId, AuthorityId)>, 

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

fn on_disabled(i: usize)

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

pub fn on_before_session_ending()

A notification for end of the session.

impl<T: PartialEq + Trait> PartialEq<Module<T>> for Module<T>

fn eq(&self, other: &Module<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Module<T>) -> bool

This method tests for !=.

impl<T: Trait> StructuralEq for Module<T>

impl<T: Trait> StructuralPartialEq for Module<T>

impl<T: Trait> ValidateUnsigned for Module<T>

A ValidateUnsigned implementation that restricts calls to report_equivocation_unsigned to local calls (i.e. extrinsics generated on this node) or that already in a block. This guarantees that only block authors can include unsigned equivocation reports.

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.