Type Alias Beefy

pub type Beefy = Pallet<Runtime>;

Aliased Type

struct Beefy(/* 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_double_voting( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<DoubleVotingProof<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config>::BeefyId, <<T as Config>::BeefyId as RuntimeAppPublic>::Signature>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Report voter 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_double_voting_unsigned( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<DoubleVotingProof<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config>::BeefyId, <<T as Config>::BeefyId as RuntimeAppPublic>::Signature>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Report voter 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 set_new_genesis( origin: <T as Config>::RuntimeOrigin, delay_in_blocks: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Reset BEEFY consensus by setting a new BEEFY genesis at delay_in_blocks blocks in the future.

Note: delay_in_blocks has to be at least 1.

pub fn report_fork_voting( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<ForkVotingProof<<<T as Config>::Block as HeaderProvider>::HeaderT, <T as Config>::BeefyId, <<T as Config>::AncestryHelper as AncestryHelper<<<T as Config>::Block as HeaderProvider>::HeaderT>>::Proof>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Report fork voting equivocation. 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_fork_voting_unsigned( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<ForkVotingProof<<<T as Config>::Block as HeaderProvider>::HeaderT, <T as Config>::BeefyId, <<T as Config>::AncestryHelper as AncestryHelper<<<T as Config>::Block as HeaderProvider>::HeaderT>>::Proof>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Report fork voting equivocation. 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 report_future_block_voting( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<FutureBlockVotingProof<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config>::BeefyId>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Report future block voting equivocation. 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_future_block_voting_unsigned( origin: <T as Config>::RuntimeOrigin, equivocation_proof: Box<FutureBlockVotingProof<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config>::BeefyId>>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Report future block voting equivocation. 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.

impl<T> Pallet<T>

where T: Config,

pub fn do_try_state() -> Result<(), DispatchError>

Ensure the correctness of the state of this pallet.

This should be valid before or after each state transition of this pallet.

impl<T> Pallet<T>

where T: Config,

pub fn validator_set() -> Option<ValidatorSet<<T as Config>::BeefyId>>

Return the current active BEEFY validator set.

pub fn submit_unsigned_double_voting_report( equivocation_proof: DoubleVotingProof<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config>::BeefyId, <<T as Config>::BeefyId as RuntimeAppPublic>::Signature>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Option<()>

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

pub fn submit_unsigned_fork_voting_report( equivocation_proof: ForkVotingProof<<<T as Config>::Block as HeaderProvider>::HeaderT, <T as Config>::BeefyId, <<T as Config>::AncestryHelper as AncestryHelper<<<T as Config>::Block as HeaderProvider>::HeaderT>>::Proof>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Option<()>

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

pub fn submit_unsigned_future_block_voting_report( equivocation_proof: FutureBlockVotingProof<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config>::BeefyId>, key_owner_proof: <T as Config>::KeyOwnerProof, ) -> Option<()>

Submits an extrinsic to report a future block voting equivocation. This method will create an unsigned extrinsic with a call to report_future_block_voting_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> BoundToRuntimeAppPublic for Pallet<T>

where T: Config,

type Public = <T as Config>::BeefyId

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> 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 try_state( _n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

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_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 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<<T as Config>::BeefyId> for Pallet<T>

where T: Config,

fn is_member(authority_id: &<T as Config>::BeefyId) -> bool

Is the given MemberId a valid member?

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> OneSessionHandler<<T as Config>::AccountId> for Pallet<T>

where T: Config + Config,

type Key = <T as Config>::BeefyId

The key type expected.

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

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

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, <T as Config>::BeefyId)>,

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> 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 pre_dispatch( call: &<Pallet<T> as ValidateUnsigned>::Call, ) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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

Return the validity of the call

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>