Type Alias Babe

pub type Babe = Pallet<Runtime>;

Aliased Type

struct Babe(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

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>, ) -> Result<ValidTransaction, TransactionValidityError>

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

impl<T> Pallet<T>

where T: Config,

pub fn report_equivocation( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<EquivocationProof<<<T as Config>::Block as HeaderProvider>::HeaderT, Public>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

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: <T as Config>::RuntimeOrigin, equivocation_proof: Box<EquivocationProof<<<T as Config>::Block as HeaderProvider>::HeaderT, Public>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

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: <T as Config>::RuntimeOrigin, config: NextConfigDescriptor, ) -> Result<(), DispatchError>

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

where T: Config,

pub fn epoch_index() -> u64

Public function to access epoch_index storage.

pub fn authorities() -> WeakBoundedVec<(Public, u64), <T as Config>::MaxAuthorities>

Public function to access authorities storage.

pub fn genesis_slot() -> Slot

Public function to access genesis_slot storage.

pub fn current_slot() -> Slot

Public function to access current_slot storage.

pub fn randomness() -> [u8; 32]

Public function to access randomness storage.

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

Public function to access initialized storage.

pub fn author_vrf_randomness() -> Option<[u8; 32]>

Public function to access author_vrf_randomness storage.

pub fn lateness() -> <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

Public function to access lateness storage.

pub fn epoch_config() -> Option<BabeEpochConfiguration>

Public function to access epoch_config storage.

pub fn skipped_epochs() -> BoundedVec<(u64, u32), ConstU32<100>>

Public function to access skipped_epochs storage.

pub fn slot_duration() -> <T as Config>::Moment

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

pub fn should_epoch_change( now: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> 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 as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Option<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>

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<(Public, u64), <T as Config>::MaxAuthorities>, next_authorities: WeakBoundedVec<(Public, u64), <T as Config>::MaxAuthorities>, session_index: Option<u32>, )

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.

This doesn’t do anything if authorities is empty.

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 as Config>::Block as HeaderProvider>::HeaderT, Public>, key_owner_proof: <T as Config>::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> BeforeAllRuntimeMigrations for Pallet<T>

where T: Config,

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

where T: Config,

type Public = Public

The RuntimeAppPublic this type is bound to.

impl<T> Callable<T> for Pallet<T>

where T: Config,

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

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

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<(), Error>

Formats the value using the given formatter.

impl<T> DispatchViewFunction for Pallet<T>

where T: Config,

fn dispatch_view_function<O>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

where O: Output,

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

where T: Config,

fn average_session_length() -> <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

Return the average length of a session.

fn estimate_current_session_progress( _now: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> (Option<Permill>, Weight)

Return an estimate of the current session progress.

fn estimate_next_session_rotation( now: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> (Option<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>, Weight)

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

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

where T: Config,

fn find_author<'a, I>(digests: I) -> Option<u32>

where I: 'a + IntoIterator<Item = ([u8; 4], &'a [u8])>,

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

impl<T> GetStorageVersion for Pallet<T>

where T: Config,

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> <Pallet<T> as GetStorageVersion>::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> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_initialize( now: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

Initialization

fn on_finalize( _now: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

Block finalization

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

where T: Config,

fn integrity_test()

See Hooks::integrity_test.

impl<T> IsMember<Public> for Pallet<T>

where T: Config,

fn is_member(authority_id: &Public) -> bool

Is the given MemberId a valid member?

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

where T: Config,

fn lateness( &self, ) -> <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

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

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

where T: Config,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

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

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

where T: Config,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

See Hooks::on_finalize.

impl<T> OnGenesis for Pallet<T>

where T: Config,

fn on_genesis()

Something that should happen at genesis.

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

where T: Config,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight, ) -> Weight

See Hooks::on_idle.

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

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

See Hooks::on_initialize.

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

where T: Config,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter, )

Code to execute every now and then at the beginning of the block after inherent application.

impl<T> OnRuntimeUpgrade for Pallet<T>

where T: Config,

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

See Hooks::pre_upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), DispatchError>

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

where T: Config,

fn on_timestamp_set(moment: <T as Config>::Moment)

Called when the timestamp is set.

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

where T: Config + Config,

type Key = Public

The key type expected.

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

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

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: 'a + Iterator<Item = (&'a <T as Config>::AccountId, Public)>,

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

where T: Config,

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

where T: Config,

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: &Pallet<T>) -> 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> ShouldEndSession<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn should_end_session( now: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> bool

Return true if the session should be ended.

impl<T> StorageInfoTrait for Pallet<T>

where T: Config,

fn storage_info() -> Vec<StorageInfo>

impl<T> TryDecodeEntireStorage for Pallet<T>

where T: Config,

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> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn try_state( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, _s: Select, ) -> Result<(), DispatchError>

Execute the state checks.

impl<T> ValidateUnsigned for Pallet<T>

where T: Config,

type Call = Call<T>

The call to validate

fn validate_unsigned( source: TransactionSource, call: &<Pallet<T> as ValidateUnsigned>::Call, ) -> Result<ValidTransaction, TransactionValidityError>

Return the validity of the call

fn pre_dispatch( call: &<Pallet<T> as ValidateUnsigned>::Call, ) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

impl<T> ViewFunctionIdPrefix for Pallet<T>

where T: Config,

fn prefix() -> [u8; 16]

impl<T> WhitelistedStorageKeys for Pallet<T>

where T: Config,

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>