Struct pallet_babe::pallet::Pallet

pub struct Pallet<T>(_);

The BABE Pallet

Implementations

impl<T: Config> Pallet<T>

Methods for the ValidateUnsigned implementation: It 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.

pub fn validate_unsigned(
    source: TransactionSource,
    call: &Call<T>
) -> TransactionValidity

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

impl<T: Config> Pallet<T>

pub fn report_equivocation(
    origin: OriginFor<T>,
    equivocation_proof: Box<EquivocationProof<T::Header>>,
    key_owner_proof: T::KeyOwnerProof
) -> DispatchResultWithPostInfo

Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported.

pub fn report_equivocation_unsigned(
    origin: OriginFor<T>,
    equivocation_proof: Box<EquivocationProof<T::Header>>,
    key_owner_proof: T::KeyOwnerProof
) -> DispatchResultWithPostInfo

Report authority equivocation/misbehavior. This method will verify the equivocation proof and validate the given key ownership proof against the extracted offender. If both are valid, the offence will be reported. This extrinsic must be called unsigned and it is expected that only block authors will call it (validated in ValidateUnsigned), as such if the block author is defined it will be defined as the equivocation reporter.

pub fn plan_config_change(
    origin: OriginFor<T>,
    config: NextConfigDescriptor
) -> DispatchResult

Plan an epoch config change. The epoch config change is recorded and will be enacted on the next call to enact_epoch_change. The config will be activated one epoch after. Multiple calls to this method will replace any existing planned config change that had not been enacted yet.

impl<T: Config> Pallet<T>

pub fn epoch_index() -> u64

Current epoch index.

impl<T: Config> Pallet<T>

pub fn authorities(
) -> WeakBoundedVec<(AuthorityId, BabeAuthorityWeight), T::MaxAuthorities>

Current epoch authorities.

impl<T: Config> Pallet<T>

pub fn genesis_slot() -> Slot

The slot at which the first epoch actually started. This is 0 until the first block of the chain.

impl<T: Config> Pallet<T>

pub fn current_slot() -> Slot

Current slot number.

impl<T: Config> Pallet<T>

pub fn randomness() -> Randomness

The epoch randomness for the current epoch.

Security

This MUST NOT be used for gambling, as it can be influenced by a malicious validator in the short term. It MAY be used in many cryptographic protocols, however, so long as one remembers that this (like everything else on-chain) it is public. For example, it can be used where a number is needed that cannot have been chosen by an adversary, for purposes such as public-coin zero-knowledge proofs.

impl<T: Config> Pallet<T>

pub fn initialized() -> Option<Option<PreDigest>>

Temporary value (cleared at block finalization) which is Some if per-block initialization has already been called for current block.

impl<T: Config> Pallet<T>

pub fn author_vrf_randomness() -> Option<Randomness>

This field should always be populated during block processing unless secondary plain slots are enabled (which don’t contain a VRF output).

It is set in on_finalize, before it will contain the value from the last block.

impl<T: Config> Pallet<T>

pub fn lateness() -> T::BlockNumber

How late the current block is compared to its parent.

This entry is populated as part of block execution and is cleaned up on block finalization. Querying this storage entry outside of block execution context should always yield zero.

impl<T: Config> Pallet<T>

pub fn epoch_config() -> Option<BabeEpochConfiguration>

The configuration for the current epoch. Should never be None as it is initialized in genesis.

impl<T: Config> Pallet<T>

pub fn slot_duration() -> T::Moment

Determine the BABE slot duration based on the Timestamp module configuration.

pub fn should_epoch_change(now: T::BlockNumber) -> bool

Determine whether an epoch change should take place at this block. Assumes that initialization has already taken place.

pub fn next_expected_epoch_change(now: T::BlockNumber) -> Option<T::BlockNumber>

Return the best guess block number, at which the next epoch change is predicted to happen.

Returns None if the prediction is in the past; This implies an error internally in the Babe and should not happen under normal circumstances.

In other word, this is only accurate if no slots are missed. Given missed slots, the slot number will grow while the block number will not. Hence, the result can be interpreted as an upper bound.

pub fn enact_epoch_change(
    authorities: WeakBoundedVec<(AuthorityId, BabeAuthorityWeight), T::MaxAuthorities>,
    next_authorities: WeakBoundedVec<(AuthorityId, BabeAuthorityWeight), T::MaxAuthorities>
)

DANGEROUS: Enact an epoch change. Should be done on every block where should_epoch_change has returned true, and the caller is the only caller of this function.

Typically, this is not handled directly by the user, but by higher-level validator-set manager logic like pallet-session.

pub fn current_epoch_start() -> Slot

Finds the start slot of the current epoch. only guaranteed to give correct results after initialize of the first block in the chain (as its result is based off of GenesisSlot).

pub fn current_epoch() -> Epoch

Produces information about the current epoch.

pub fn next_epoch() -> Epoch

Produces information about the next epoch (which was already previously announced).

pub fn submit_unsigned_equivocation_report(
    equivocation_proof: EquivocationProof<T::Header>,
    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> 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 = Public

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> EstimateNextSessionRotation<<T as Config>::BlockNumber> for Pallet<T>

fn average_session_length() -> T::BlockNumber

Return the average length of a session.

fn estimate_current_session_progress(
    _now: T::BlockNumber
) -> (Option<Permill>, Weight)

Return an estimate of the current session progress.

fn estimate_next_session_rotation(
    now: T::BlockNumber
) -> (Option<T::BlockNumber>, Weight)

Return the block number at which the next session rotation is estimated to happen.

impl<T: Config> FindAuthor<u32> for Pallet<T>

fn find_author<'a, I>(digests: I) -> Option<u32>where
    I: 'a + IntoIterator<Item = (ConsensusEngineId, &'a [u8])>,

Find the author of a block based on the pre-runtime digests.

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

Initialization

fn on_finalize(_now: BlockNumberFor<T>)

Block finalization

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_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 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> IsMember<Public> for Pallet<T>

fn is_member(authority_id: &AuthorityId) -> bool

Is the given MemberId a valid member?

impl<T: Config> Lateness<<T as Config>::BlockNumber> for Pallet<T>

fn lateness(&self) -> T::BlockNumber

Returns a generic measure of how late the current block is compared to its parent.

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> OnTimestampSet<<T as Config>::Moment> for Pallet<T>

fn on_timestamp_set(moment: T::Moment)

Called when the timestamp is set.

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

type Key = Public

The key type expected.

fn on_genesis_session<'a, I>(validators: I)where
    I: Iterator<Item = (&'a T::AccountId, 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, AuthorityId)> + 'a,

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

fn on_disabled(i: u32)

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

fn on_before_session_ending()

A notification for end of the session.

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> ShouldEndSession<<T as Config>::BlockNumber> for Pallet<T>

fn should_end_session(now: T::BlockNumber) -> bool

Return true if the session should be ended.

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>