Struct cumulus_client_parachain_inherent::MockValidationDataInherentDataProvider

pub struct MockValidationDataInherentDataProvider<R = ()> {
    pub current_para_block: u32,
    pub para_id: ParaId,
    pub current_para_block_head: Option<HeadData>,
    pub relay_offset: u32,
    pub relay_blocks_per_para_block: u32,
    pub para_blocks_per_relay_epoch: u32,
    pub relay_randomness_config: R,
    pub xcm_config: MockXcmConfig,
    pub raw_downward_messages: Vec<Vec<u8>>,
    pub raw_horizontal_messages: Vec<(ParaId, Vec<u8>)>,
    pub additional_key_values: Option<Vec<(Vec<u8>, Vec<u8>)>>,
    pub upgrade_go_ahead: Option<UpgradeGoAhead>,
}

Inherent data provider that supplies mocked validation data.

This is useful when running a node that is not actually backed by any relay chain. For example when running a local node, or running integration tests.

We mock a relay chain block number as follows: relay_block_number = offset + relay_blocks_per_para_block * current_para_block To simulate a parachain that starts in relay block 1000 and gets a block in every other relay block, use 1000 and 2

Optionally, mock XCM messages can be injected into the runtime. When mocking XCM, in addition to the messages themselves, you must provide some information about your parachain’s configuration in order to mock the MQC heads properly. See MockXcmConfig for more information

Fields

current_para_block: u32

The current block number of the local block chain (the parachain).

para_id: ParaId

The parachain ID of the parachain for that the inherent data is created.

current_para_block_head: Option<HeadData>

The current block head data of the local block chain (the parachain).

relay_offset: u32

The relay block in which this parachain appeared to start. This will be the relay block number in para block #P1.

relay_blocks_per_para_block: u32

The number of relay blocks that elapses between each parablock. Probably set this to 1 or 2 to simulate optimistic or realistic relay chain behavior.

para_blocks_per_relay_epoch: u32

Number of parachain blocks per relay chain epoch Mock epoch is computed by dividing current_para_block by this value.

relay_randomness_config: R

Function to mock BABE one epoch ago randomness.

xcm_config: MockXcmConfig

XCM messages and associated configuration information.

raw_downward_messages: Vec<Vec<u8>>

Inbound downward XCM messages to be injected into the block.

raw_horizontal_messages: Vec<(ParaId, Vec<u8>)>

Inbound Horizontal messages sorted by channel.

additional_key_values: Option<Vec<(Vec<u8>, Vec<u8>)>>

Additional key-value pairs that should be injected.

upgrade_go_ahead: Option<UpgradeGoAhead>

Whether upgrade go ahead should be set.

Trait Implementations

impl<R: Default> Default for MockValidationDataInherentDataProvider<R>

fn default() -> MockValidationDataInherentDataProvider<R>

Returns the “default value” for a type.

impl<R: Send + Sync + GenerateRandomness<u64>> InherentDataProvider for MockValidationDataInherentDataProvider<R>

fn provide_inherent_data<'life0, 'life1, 'async_trait>( &'life0 self, inherent_data: &'life1 mut InherentData, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Provide inherent data that should be included in a block.

fn try_handle_error<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _: &'life1 InherentIdentifier, _: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Option<Result<(), Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Convert the given encoded error to a string.

fn create_inherent_data<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<InherentData, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Convenience function for creating InherentData.