Struct cumulus_client_collator::service::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 [Collation]s 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>, spawner: Arc<dyn SpawnNamed + Send + Sync>, 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>, ApiError>

Fetch the collation info from the runtime.

Returns Ok(Some(_)) on success, Err(_) on error or Ok(None) if the runtime api isn’t implemented by the runtime.

pub fn build_collation( &self, parent_header: &Block::Header, block_hash: Block::Hash, candidate: ParachainCandidate<Block> ) -> 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 it fetches underlying runtime API data.

This also returns the unencoded parachain block data, in case that is desired.

pub fn announce_with_barrier( &self, block_hash: Block::Hash ) -> Sender<CollationSecondedSignal>

Inform the networking systems that the block should be announced after an appropriate signal has been received. This returns the sending half of the signal.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy 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: Block::Hash, candidate: ParachainCandidate<Block> ) -> 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_with_barrier( &self, block_hash: Block::Hash ) -> Sender<CollationSecondedSignal>

Inform networking systems that the block should be announced after a signal has been received to indicate the block has been seconded by a relay-chain validator.

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

Directly announce a block on the network.