Struct CollatorService 

pub struct CollatorService<Block: BlockT, BS, RA> { /* private fields */ }

The CollatorService provides common utilities for parachain consensus and authoring.

This includes logic for checking the block status of arbitrary parachain headers gathered from the relay chain state, creating full Collations to be shared with validators, and distributing new parachain blocks along the network.

Implementations

impl<Block, BS, RA> CollatorService<Block, BS, RA>

where Block: BlockT, BS: BlockBackend<Block>, RA: ProvideRuntimeApi<Block>, RA::Api: CollectCollationInfo<Block>,

pub fn new( block_status: Arc<BS>, announce_block: Arc<dyn Fn(Block::Hash, Option<Vec<u8>>) + Send + Sync>, runtime_api: Arc<RA>, ) -> Self

Create a new instance.

pub fn check_block_status( &self, hash: Block::Hash, header: &Block::Header, ) -> bool

Checks the status of the given block hash in the Parachain.

Returns true if the block could be found and is good to be build on.

pub fn fetch_collation_info( &self, block_hash: Block::Hash, header: &Block::Header, ) -> Result<Option<(CollationInfo, u32)>, ApiError>

Fetch the collation info from the runtime.

Returns Ok(Some((CollationInfo, ApiVersion))) on success, Err(_) on error or Ok(None) if the runtime api isn’t implemented by the runtime. ApiVersion being the version of the CollectCollationInfo runtime api.

Trait Implementations

impl<Block: BlockT, BS, RA> Clone for CollatorService<Block, BS, RA>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Block, BS, RA> ServiceInterface<Block> for CollatorService<Block, BS, RA>

where Block: BlockT, BS: BlockBackend<Block>, RA: ProvideRuntimeApi<Block>, RA::Api: CollectCollationInfo<Block>,

fn check_block_status(&self, hash: Block::Hash, header: &Block::Header) -> bool

Checks the status of the given block hash in the Parachain.

fn build_collation( &self, parent_header: &Block::Header, _: Block::Hash, candidate: ParachainCandidate<Block>, scheduling_proof: Option<SchedulingProof>, ) -> Option<(Collation, ParachainBlockData<Block>)>

Build a full Collation from a given [ParachainCandidate]. This requires that the underlying block has been fully imported into the underlying client, as implementations will fetch underlying runtime API data.

fn announce_block(&self, block_hash: Block::Hash, data: Option<Vec<u8>>)

Directly announce a block on the network.

fn build_multi_block_collation( &self, parent_header: &<Block as BlockT>::Header, blocks: Vec<Block>, proof: StorageProof, scheduling_proof: Option<SchedulingProof>, ) -> Option<(Collation, ParachainBlockData<Block>)>

Build a multi-block collation.