Struct E2ETestSetupBuilder 

pub struct E2ETestSetupBuilder<N: NodeBuilderHelper> { /* private fields */ }

Builder for configuring and launching test node setups.

By default, the nodes:

• run on a shared Runtime::test runtime,
• build payloads with eth_payload_attributes for the hardforks active in the chain spec,
• have discovery disabled, use unused ports and serve all RPC modules except testing over HTTP,
• report an idle sync state from startup, so they gossip transactions before their first block,
• are connected to each other.

Once launched, each node receives a forkchoice update that makes genesis the head, safe and finalized block, unless dev mining is enabled.

Configuration and tree configuration modifiers are applied in the order they are added.

Use E2ETestSetupExt::test_setup_for to set up nodes on the test_chain_spec at a hardfork, or E2ETestSetupExt::test_setup for any other chain spec:

let (mut node, wallet) = EthereumNode::test_setup_for(EthereumHardfork::Cancun)
    .with_tree_config_modifier(|config| config.with_persistence_threshold(0))
    .build_single()
    .await?;

Implementations

impl<N: NodeBuilderHelper> E2ETestSetupBuilder<N>

pub fn new(num_nodes: usize, chain_spec: Arc<N::ChainSpec>) -> Self

Creates a new builder for num_nodes nodes of the given chain.

pub const fn with_num_nodes(self, num_nodes: usize) -> Self

Sets the number of nodes to launch.

pub fn with_runtime(self, runtime: Runtime) -> Self

Launches the nodes on the given runtime instead of a new Runtime::test.

This lets multiple setups, or other components of a test, share the same tokio handle and rayon pools. Note that the tasks of the nodes are only shut down once all handles to the runtime are dropped, not when the nodes are dropped.

pub fn with_attributes_generator<G>(self, generator: G) -> Self

where G: Fn(u64) -> PayloadAttrTy<N> + Send + Sync + 'static,

Sets the generator for the payload attributes of the payloads built by the test nodes.

The generator is called with the timestamp of the next payload. Defaults to eth_payload_attributes for the chain spec of the setup.

pub const fn with_connect_nodes(self, connect_nodes: bool) -> Self

Sets whether nodes should be interconnected (default: true).

pub fn with_tree_config_modifier<G>(self, modifier: G) -> Self

where G: Fn(TreeConfig) -> TreeConfig + Send + Sync + 'static,

Adds a modifier for the tree configuration.

The closure receives the current tree config and returns a modified version. The base config is the default config with a small cross block cache.

pub fn with_node_config_modifier<G>(self, modifier: G) -> Self

where G: Fn(NodeConfig<N::ChainSpec>) -> NodeConfig<N::ChainSpec> + Send + Sync + 'static,

Adds a modifier for the node configuration.

The closure receives the current node config and returns a modified version.

pub fn with_rpc_modifier<G>(self, modifier: G) -> Self

where G: Fn(RpcServerArgs) -> RpcServerArgs + Send + Sync + 'static,

Adds a modifier for the RPC server arguments.

The closure receives the current arguments, which serve all modules except testing over HTTP on an unused port.

pub fn with_pruning(self, pruning: PruningArgs) -> Self

Sets the pruning arguments for the test nodes.

pub const fn with_storage_v2(self, storage_v2: bool) -> Self

Sets whether nodes use the v2 storage layout (--storage.v2), which routes tx hashes, history indices, etc. to RocksDB and changesets/senders to static files.

Defaults to the node’s --storage.v2 default. Node config modifiers run afterwards and can still override it.

pub fn with_dev_mode(self, dev: bool) -> Self

Sets whether the nodes run in dev mode (--dev).

Unlike dev mining, this only sets the dev flag and does not start a local miner.

pub fn with_dev_mining(self, block_time: Option<Duration>) -> Self

where N: DebugNode<Adapter<N>>,

Launches the node in dev mode with a local miner that builds a block every block_time, or as soon as a transaction is pending if None.

Dev mining is limited to a single node, since every node would mine its own chain. The local miner drives forkchoice and payload building, so the node does not receive the initial forkchoice update to genesis, and the block producing helpers of NodeTestContext, e.g. NodeTestContext::advance_block and NodeTestContext::update_forkchoice, must not be used. Use Self::map_dev_payload_attributes to customize the payload attributes of the mined blocks.

pub fn map_dev_payload_attributes<G>(self, map: G) -> Self

where G: Fn(PayloadAttrTy<N>) -> PayloadAttrTy<N> + Send + Sync + 'static,

Maps the payload attributes of the blocks built by the local miner of dev mining nodes, e.g. to set the fee recipient.

Mappers are applied in the order they are added. Has no effect unless dev mining is enabled.

pub async fn build(self) -> Result<(Vec<NodeHelperType<N>>, Wallet)>

Builds and launches the test nodes.

pub async fn build_single(self) -> Result<(NodeHelperType<N>, Wallet)>

Builds and launches a single test node.

Returns an error if the builder was not configured with exactly one node.

Trait Implementations

impl<N: NodeBuilderHelper> Debug for E2ETestSetupBuilder<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 120 bytes