Struct sc_consensus::block_import::BlockImportParams
source · #[non_exhaustive]pub struct BlockImportParams<Block: BlockT> {Show 14 fields
pub origin: BlockOrigin,
pub header: Block::Header,
pub justifications: Option<Justifications>,
pub post_digests: Vec<DigestItem>,
pub body: Option<Vec<Block::Extrinsic>>,
pub indexed_body: Option<Vec<Vec<u8>>>,
pub state_action: StateAction<Block>,
pub finalized: bool,
pub intermediates: HashMap<Cow<'static, [u8]>, Box<dyn Any + Send>>,
pub auxiliary: Vec<(Vec<u8>, Option<Vec<u8>>)>,
pub fork_choice: Option<ForkChoiceStrategy>,
pub import_existing: bool,
pub create_gap: bool,
pub post_hash: Option<Block::Hash>,
}
Expand description
Data required to import a Block.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.origin: BlockOrigin
Origin of the Block
header: Block::Header
The header, without consensus post-digests applied. This should be in the same state as it comes out of the runtime.
Consensus engines which alter the header (by adding post-runtime digests)
should strip those off in the initial verification process and pass them
via the post_digests
field. During block authorship, they should
not be pushed to the header directly.
The reason for this distinction is so the header can be directly re-executed in a runtime that checks digest equivalence – the post-runtime digests are pushed back on after.
justifications: Option<Justifications>
Justification(s) provided for this block from the outside.
post_digests: Vec<DigestItem>
Digest items that have been added after the runtime for external work, like a consensus signature.
body: Option<Vec<Block::Extrinsic>>
The body of the block.
indexed_body: Option<Vec<Vec<u8>>>
Indexed transaction body of the block.
state_action: StateAction<Block>
Specify how the new state is computed.
finalized: bool
Is this block finalized already?
true
implies instant finality.
intermediates: HashMap<Cow<'static, [u8]>, Box<dyn Any + Send>>
Intermediate values that are interpreted by block importers. Each block importer, upon handling a value, removes it from the intermediate list. The final block importer rejects block import if there are still intermediate values that remain unhandled.
auxiliary: Vec<(Vec<u8>, Option<Vec<u8>>)>
Auxiliary consensus data produced by the block.
Contains a list of key-value pairs. If values are None
, the keys will be deleted. These
changes will be applied to AuxStore
database all as one batch, which is more efficient
than updating AuxStore
directly.
fork_choice: Option<ForkChoiceStrategy>
Fork choice strategy of this import. This should only be set by a
synchronous import, otherwise it may race against other imports.
None
indicates that the current verifier or importer cannot yet
determine the fork choice value, and it expects subsequent importer
to modify it. If None
is passed all the way down to bottom block
importer, the import fails with an IncompletePipeline
error.
import_existing: bool
Re-validate existing block.
create_gap: bool
Whether to create “block gap” in case this block doesn’t have parent.
post_hash: Option<Block::Hash>
Cached full header hash (with post-digests applied).
Implementations§
source§impl<Block: BlockT> BlockImportParams<Block>
impl<Block: BlockT> BlockImportParams<Block>
sourcepub fn new(origin: BlockOrigin, header: Block::Header) -> Self
pub fn new(origin: BlockOrigin, header: Block::Header) -> Self
Create a new block import params.
sourcepub fn post_header(&self) -> Block::Header
pub fn post_header(&self) -> Block::Header
Get the post header.
sourcepub fn insert_intermediate<T: 'static + Send>(
&mut self,
key: &'static [u8],
value: T,
)
pub fn insert_intermediate<T: 'static + Send>( &mut self, key: &'static [u8], value: T, )
Insert intermediate by given key.
sourcepub fn remove_intermediate<T: 'static>(
&mut self,
key: &[u8],
) -> Result<T, Error>
pub fn remove_intermediate<T: 'static>( &mut self, key: &[u8], ) -> Result<T, Error>
Remove and return intermediate by given key.
sourcepub fn get_intermediate<T: 'static>(&self, key: &[u8]) -> Result<&T, Error>
pub fn get_intermediate<T: 'static>(&self, key: &[u8]) -> Result<&T, Error>
Get a reference to a given intermediate.
sourcepub fn get_intermediate_mut<T: 'static>(
&mut self,
key: &[u8],
) -> Result<&mut T, Error>
pub fn get_intermediate_mut<T: 'static>( &mut self, key: &[u8], ) -> Result<&mut T, Error>
Get a mutable reference to a given intermediate.
sourcepub fn with_state(&self) -> bool
pub fn with_state(&self) -> bool
Check if this block contains state import action
Auto Trait Implementations§
impl<Block> Freeze for BlockImportParams<Block>
impl<Block> !RefUnwindSafe for BlockImportParams<Block>
impl<Block> Send for BlockImportParams<Block>
impl<Block> !Sync for BlockImportParams<Block>
impl<Block> Unpin for BlockImportParams<Block>
impl<Block> !UnwindSafe for BlockImportParams<Block>
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
§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,
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,
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,
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,
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,
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,
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,
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,
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,
§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> 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>
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>
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, 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,
§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,
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,
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
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
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
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>,
T
. Read more§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
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
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
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
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
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
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
.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
.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
.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
.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
.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
.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
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§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
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
T
.