Struct substrate_test_runtime_client::TestClientBuilder

pub struct TestClientBuilder<Block, Executor, Backend, G> where
    Block: Block,
    G: GenesisInit,  { /* fields omitted */ }

A builder for creating a test client instance.

Implementations

impl<Block, Executor, G> TestClientBuilder<Block, Executor, Backend<Block>, G> where
    Block: Block,
    G: GenesisInit, 

pub fn with_default_backend(
) -> TestClientBuilder<Block, Executor, Backend<Block>, G>

Create new TestClientBuilder with default backend.

pub fn with_pruning_window(
    keep_blocks: u32
) -> TestClientBuilder<Block, Executor, Backend<Block>, G>

Create new TestClientBuilder with default backend and pruning window size

pub fn with_tx_storage(
    keep_blocks: u32
) -> TestClientBuilder<Block, Executor, Backend<Block>, G>

Create new TestClientBuilder with default backend and storage chain mode

impl<Block, Executor, Backend, G> TestClientBuilder<Block, Executor, Backend, G> where
    Block: Block,
    G: GenesisInit, 

pub fn with_backend(
    backend: Arc<Backend>
) -> TestClientBuilder<Block, Executor, Backend, G>

Create a new instance of the test client builder.

pub fn set_keystore(
    self,
    keystore: Arc<dyn SyncCryptoStore + 'static>
) -> TestClientBuilder<Block, Executor, Backend, G>

Set the keystore that should be used by the externalities.

pub fn genesis_init_mut(&mut self) -> &mut G

Alter the genesis storage parameters.

pub fn backend(&self) -> Arc<Backend>

Give access to the underlying backend of these clients

pub fn add_child_storage(
    self,
    child_info: &ChildInfo,
    key: impl AsRef<[u8]>,
    value: impl AsRef<[u8]>
) -> TestClientBuilder<Block, Executor, Backend, G>

Extend child storage

pub fn set_execution_strategy(
    self,
    execution_strategy: ExecutionStrategy
) -> TestClientBuilder<Block, Executor, Backend, G>

Set the execution strategy that should be used by all contexts.

pub fn set_block_rules(
    self,
    fork_blocks: Option<Vec<(<<Block as Block>::Header as Header>::Number, <Block as Block>::Hash), Global>>,
    bad_blocks: Option<HashSet<<Block as Block>::Hash, RandomState>>
) -> TestClientBuilder<Block, Executor, Backend, G>

Sets custom block rules.

pub fn enable_offchain_indexing_api(
    self
) -> TestClientBuilder<Block, Executor, Backend, G>

Enable the offchain indexing api.

pub fn set_no_genesis(self) -> TestClientBuilder<Block, Executor, Backend, G>

Disable writing genesis.

pub fn build_with_executor<RuntimeApi>(
    self,
    executor: Executor
) -> (Client<Backend, Executor, Block, RuntimeApi>, LongestChain<Backend, Block>) where
    Backend: Backend<Block>,
    Executor: CallExecutor<Block> + 'static,
    <Backend as Backend<Block>>::OffchainStorage: 'static, 

Build the test client with the given native executor.

impl<Block, E, Backend, G> TestClientBuilder<Block, LocalCallExecutor<Block, Backend, NativeExecutor<E>>, Backend, G> where
    Block: Block,
    G: GenesisInit, 

pub fn build_with_native_executor<RuntimeApi, I>(
    self,
    executor: I
) -> (Client<Backend, LocalCallExecutor<Block, Backend, NativeExecutor<E>>, Block, RuntimeApi>, LongestChain<Backend, Block>) where
    Backend: Backend<Block> + 'static,
    E: NativeExecutionDispatch + 'static,
    I: Into<Option<NativeExecutor<E>>>, 

Build the test client with the given native executor.

Trait Implementations

impl<Block, Executor, G> Default for TestClientBuilder<Block, Executor, Backend<Block>, G> where
    Block: Block,
    G: GenesisInit, 

pub fn default() -> TestClientBuilder<Block, Executor, Backend<Block>, G>

Returns the “default value” for a type.