Struct sc_block_builder::BlockBuilder

pub struct BlockBuilder<'a, Block: BlockT, A: ProvideRuntimeApi<Block>, B> { /* private fields */ }

Utility for building new (valid) blocks from a stream of extrinsics.

Implementations

impl<'a, Block, A, B> BlockBuilder<'a, Block, A, B>where
    Block: BlockT,
    A: ProvideRuntimeApi<Block> + 'a,
    A::Api: BlockBuilderApi<Block> + ApiExt<Block, StateBackend = StateBackendFor<B, Block>>,
    B: Backend<Block>,

pub fn new(
    api: &'a A,
    parent_hash: Block::Hash,
    parent_number: NumberFor<Block>,
    record_proof: RecordProof,
    inherent_digests: Digest,
    backend: &'a B
) -> Result<Self, Error>

Create a new instance of builder based on the given parent_hash and parent_number.

While proof recording is enabled, all accessed trie nodes are saved. These recorded trie nodes can be used by a third party to prove the output of this block builder without having access to the full storage.

pub fn push(&mut self, xt: <Block as BlockT>::Extrinsic) -> Result<(), Error>

Push onto the block’s list of extrinsics.

This will ensure the extrinsic can be validly executed (by executing it).

pub fn build(
    self
) -> Result<BuiltBlock<Block, StateBackendFor<B, Block>>, Error>

Consume the builder to build a valid Block containing all pushed extrinsics.

Returns the build Block, the changes to the storage and an optional StorageProof supplied by self.api, combined as BuiltBlock. The storage proof will be Some(_) when proof recording was enabled.

pub fn create_inherents(
    &mut self,
    inherent_data: InherentData
) -> Result<Vec<Block::Extrinsic>, Error>

Create the inherents for the block.

Returns the inherents created by the runtime or an error if something failed.

pub fn estimate_block_size(&self, include_proof: bool) -> usize

Estimate the size of the block in the current state.

If include_proof is true, the estimated size of the storage proof will be added to the estimation.