Struct substrate_relay_helper::finality_base::engine::Grandpa
source · pub struct Grandpa<C>(/* private fields */);
Expand description
GRANDPA finality engine.
Trait Implementations§
source§impl<C: ChainWithGrandpa> Engine<C> for Grandpa<C>
impl<C: ChainWithGrandpa> Engine<C> for Grandpa<C>
source§fn prepare_initialization_data<'async_trait>(
source_client: impl 'async_trait + Client<C>,
) -> Pin<Box<dyn Future<Output = Result<Self::InitializationData, Error<HashOf<C>, BlockNumberOf<C>>>> + Send + 'async_trait>>where
Self: 'async_trait,
fn prepare_initialization_data<'async_trait>(
source_client: impl 'async_trait + Client<C>,
) -> Pin<Box<dyn Future<Output = Result<Self::InitializationData, Error<HashOf<C>, BlockNumberOf<C>>>> + Send + 'async_trait>>where
Self: 'async_trait,
Prepare initialization data for the GRANDPA verifier pallet.
§type ConsensusLogReader = GrandpaConsensusLogReader<<<C as Chain>::Header as Header>::Number>
type ConsensusLogReader = GrandpaConsensusLogReader<<<C as Chain>::Header as Header>::Number>
A reader that can extract the consensus log from the header digest and interpret it.
§type FinalityProof = GrandpaJustification<<C as Chain>::Header>
type FinalityProof = GrandpaJustification<<C as Chain>::Header>
Type of finality proofs, used by consensus engine.
§type FinalityVerificationContext = JustificationVerificationContext
type FinalityVerificationContext = JustificationVerificationContext
The context needed for verifying finality proofs.
§type EquivocationProof = EquivocationProof<<C as Chain>::Hash, <C as Chain>::BlockNumber>
type EquivocationProof = EquivocationProof<<C as Chain>::Hash, <C as Chain>::BlockNumber>
The type of the equivocation proof used by the consensus engine.
§type EquivocationsFinder = GrandpaEquivocationsFinder<C>
type EquivocationsFinder = GrandpaEquivocationsFinder<C>
The equivocations finder.
§type KeyOwnerProof = <C as ChainWithGrandpa>::KeyOwnerProof
type KeyOwnerProof = <C as ChainWithGrandpa>::KeyOwnerProof
The type of the key owner proof used by the consensus engine.
§type InitializationData = InitializationData<<C as Chain>::Header>
type InitializationData = InitializationData<<C as Chain>::Header>
Type of bridge pallet initialization data.
§type OperatingMode = BasicOperatingMode
type OperatingMode = BasicOperatingMode
Type of bridge pallet operating mode.
source§fn is_initialized_key() -> StorageKey
fn is_initialized_key() -> StorageKey
Returns storage at the bridged (target) chain that corresponds to some value that is
missing from the storage until bridge pallet is initialized. Read more
source§fn pallet_operating_mode_key() -> StorageKey
fn pallet_operating_mode_key() -> StorageKey
Returns storage key at the bridged (target) chain that corresponds to the variable
that holds the operating mode of the pallet.
source§fn source_finality_proofs<'life0, 'async_trait>(
client: &'life0 (impl 'async_trait + Client<C>),
) -> Pin<Box<dyn Future<Output = Result<Subscription<Bytes>, SubstrateError>> + Send + 'async_trait>>where
'life0: 'async_trait,
fn source_finality_proofs<'life0, 'async_trait>(
client: &'life0 (impl 'async_trait + Client<C>),
) -> Pin<Box<dyn Future<Output = Result<Subscription<Bytes>, SubstrateError>> + Send + 'async_trait>>where
'life0: 'async_trait,
A method to subscribe to encoded finality proofs, given source client.
source§fn verify_and_optimize_proof<'life0, 'life1, 'life2, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
header: &'life1 C::Header,
proof: &'life2 mut Self::FinalityProof,
) -> Pin<Box<dyn Future<Output = Result<Self::FinalityVerificationContext, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn verify_and_optimize_proof<'life0, 'life1, 'life2, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
header: &'life1 C::Header,
proof: &'life2 mut Self::FinalityProof,
) -> Pin<Box<dyn Future<Output = Result<Self::FinalityVerificationContext, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Verify and optimize finality proof before sending it to the target node. Read more
source§fn check_max_expected_call_limits(
header: &C::Header,
proof: &Self::FinalityProof,
) -> SubmitFinalityProofCallExtras
fn check_max_expected_call_limits( header: &C::Header, proof: &Self::FinalityProof, ) -> SubmitFinalityProofCallExtras
Checks whether the given
header
and its finality proof
fit the maximal expected
call limits (size and weight).source§fn finality_verification_context<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
at: HashOf<TargetChain>,
) -> Pin<Box<dyn Future<Output = Result<Self::FinalityVerificationContext, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
fn finality_verification_context<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
at: HashOf<TargetChain>,
) -> Pin<Box<dyn Future<Output = Result<Self::FinalityVerificationContext, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
Get the context needed for validating a finality proof.
source§fn synced_headers_finality_info<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
at: TargetChain::Hash,
) -> Pin<Box<dyn Future<Output = Result<Vec<HeaderGrandpaInfo<HeaderOf<C>>>, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
'life0: 'async_trait,
fn synced_headers_finality_info<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
at: TargetChain::Hash,
) -> Pin<Box<dyn Future<Output = Result<Vec<HeaderGrandpaInfo<HeaderOf<C>>>, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
'life0: 'async_trait,
Returns the finality info associated to the source headers synced with the target
at the provided block.
source§fn generate_source_key_ownership_proof<'life0, 'life1, 'async_trait>(
source_client: &'life0 (impl 'async_trait + Client<C>),
at: C::Hash,
equivocation: &'life1 Self::EquivocationProof,
) -> Pin<Box<dyn Future<Output = Result<Self::KeyOwnerProof, SubstrateError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn generate_source_key_ownership_proof<'life0, 'life1, 'async_trait>(
source_client: &'life0 (impl 'async_trait + Client<C>),
at: C::Hash,
equivocation: &'life1 Self::EquivocationProof,
) -> Pin<Box<dyn Future<Output = Result<Self::KeyOwnerProof, SubstrateError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Generate key ownership proof for the provided equivocation.
source§fn is_initialized<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
) -> Pin<Box<dyn Future<Output = Result<bool, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
fn is_initialized<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
) -> Pin<Box<dyn Future<Output = Result<bool, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
Returns
Ok(true)
if finality pallet at the bridged chain has already been initialized.source§fn is_halted<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
) -> Pin<Box<dyn Future<Output = Result<bool, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
fn is_halted<'life0, 'async_trait, TargetChain>(
target_client: &'life0 (impl 'async_trait + Client<TargetChain>),
) -> Pin<Box<dyn Future<Output = Result<bool, SubstrateError>> + Send + 'async_trait>>where
TargetChain: 'async_trait + Chain,
Self: 'async_trait,
'life0: 'async_trait,
Returns
Ok(true)
if finality pallet at the bridged chain is halted.Auto Trait Implementations§
impl<C> Freeze for Grandpa<C>
impl<C> RefUnwindSafe for Grandpa<C>where
C: RefUnwindSafe,
impl<C> Send for Grandpa<C>where
C: Send,
impl<C> Sync for Grandpa<C>where
C: Sync,
impl<C> Unpin for Grandpa<C>where
C: Unpin,
impl<C> UnwindSafe for Grandpa<C>where
C: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
§fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
§fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<Src, Dest> IntoTuple<Dest> for Srcwhere
Dest: FromTuple<Src>,
impl<Src, Dest> IntoTuple<Dest> for Srcwhere
Dest: FromTuple<Src>,
fn into_tuple(self) -> Dest
§impl<T> IsType<T> for T
impl<T> IsType<T> for T
§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of
T
. Read more§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
type Error = <U as TryFromKey<T>>::Error
fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>
§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of
T
.