Struct NetworkConfigBuilder

pub struct NetworkConfigBuilder<N: NetworkPrimitives = EthNetworkPrimitives> { /* private fields */ }

Builder for NetworkConfig.

Implementations

impl<N: NetworkPrimitives> NetworkConfigBuilder<N>

pub fn with_rng_secret_key() -> Self

Create a new builder instance with a random secret key.

pub fn new(secret_key: SecretKey) -> Self

Create a new builder instance with the given secret key.

pub fn apply<F>(self, f: F) -> Self

where F: FnOnce(Self) -> Self,

Apply a function to the builder.

pub fn get_peer_id(&self) -> PeerId

Returns the configured [PeerId]

pub const fn secret_key(&self) -> &SecretKey

Returns the configured SecretKey, from which the node’s identity is derived.

pub const fn network_mode(self, network_mode: NetworkMode) -> Self

Sets the NetworkMode.

pub const fn with_pow(self) -> Self

Configures the network to use proof-of-work.

This effectively allows block propagation in the eth sub-protocol, which has been soft-deprecated with ethereum PoS after the merge. Even if block propagation is technically allowed, according to the eth protocol, it is not expected to be used in PoS networks and peers are supposed to terminate the connection if they receive a NewBlock message.

pub const fn set_head(self, head: Head) -> Self

Sets the highest synced block.

This is used to construct the appropriate [ForkFilter] and [Status] message.

If not set, this defaults to the genesis specified by the current chain specification.

pub fn hello_message(self, hello_message: HelloMessageWithProtocols) -> Self

Sets the HelloMessage to send when connecting to peers.

let peer_id = builder.get_peer_id();
builder.hello_message(HelloMessage::builder(peer_id).build());

pub fn peer_config(self, config: PeersConfig) -> Self

Set a custom peer config for how peers are handled

pub fn with_task_executor(self, executor: Box<dyn TaskSpawner>) -> Self

Sets the executor to use for spawning tasks.

If None, then [tokio::spawn] is used for spawning tasks.

pub const fn sessions_config(self, config: SessionsConfig) -> Self

Sets a custom config for how sessions are handled.

pub const fn transactions_manager_config( self, config: TransactionsManagerConfig, ) -> Self

Configures the transactions manager with the given config.

pub const fn set_addrs(self, addr: SocketAddr) -> Self

Sets the discovery and listener address

This is a convenience function for both NetworkConfigBuilder::listener_addr and NetworkConfigBuilder::discovery_addr.

By default, both are on the same port: DEFAULT_DISCOVERY_PORT

pub const fn listener_addr(self, listener_addr: SocketAddr) -> Self

Sets the socket address the network will listen on.

By default, this is [DEFAULT_DISCOVERY_ADDRESS]

pub fn listener_port(self, port: u16) -> Self

Sets the port of the address the network will listen on.

By default, this is DEFAULT_DISCOVERY_PORT

pub const fn discovery_addr(self, discovery_addr: SocketAddr) -> Self

Sets the socket address the discovery network will listen on

pub fn discovery_port(self, port: u16) -> Self

Sets the port of the address the discovery network will listen on.

By default, this is DEFAULT_DISCOVERY_PORT

pub fn with_unused_discovery_port(self) -> Self

Sets the discovery port to an unused port. This is useful for testing.

pub fn with_unused_listener_port(self) -> Self

Sets the listener port to an unused port. This is useful for testing.

pub fn external_ip_resolver(self, resolver: NatResolver) -> Self

Sets the external ip resolver to use for discovery v4.

If no [Discv4ConfigBuilder] is set via Self::discovery, this will create a new one.

This is a convenience function for setting the external ip resolver on the default [Discv4Config] config.

pub fn discovery(self, builder: Discv4ConfigBuilder) -> Self

Sets the discv4 config to use.

pub fn discovery_v5(self, builder: ConfigBuilder) -> Self

Sets the discv5 config to use.

pub fn dns_discovery(self, config: DnsDiscoveryConfig) -> Self

Sets the dns discovery config to use.

pub fn mainnet_boot_nodes(self) -> Self

Convenience function for setting Self::boot_nodes to the mainnet boot nodes.

pub fn sepolia_boot_nodes(self) -> Self

Convenience function for setting Self::boot_nodes to the sepolia boot nodes.

pub fn boot_nodes<T: Into<TrustedPeer>>( self, nodes: impl IntoIterator<Item = T>, ) -> Self

Sets the boot nodes to use to bootstrap the configured discovery services (discv4 + discv5).

pub fn boot_nodes_iter(&self) -> impl Iterator<Item = &TrustedPeer> + '_

Returns an iterator over all configured boot nodes.

pub fn disable_dns_discovery(self) -> Self

Disable the DNS discovery.

pub const fn disable_nat(self) -> Self

pub fn disable_discovery(self) -> Self

Disables all discovery.

pub fn disable_discovery_if(self, disable: bool) -> Self

Disables all discovery if the given condition is true.

pub fn disable_discv4_discovery(self) -> Self

Disable the Discv4 discovery.

pub fn disable_dns_discovery_if(self, disable: bool) -> Self

Disable the DNS discovery if the given condition is true.

pub fn disable_discv4_discovery_if(self, disable: bool) -> Self

Disable the Discv4 discovery if the given condition is true.

pub fn add_rlpx_sub_protocol(self, protocol: impl IntoRlpxSubProtocol) -> Self

Adds a new additional protocol to the RLPx sub-protocol list.

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

Sets whether tx gossip is disabled.

pub fn block_import(self, block_import: Box<dyn BlockImport<N::Block>>) -> Self

Sets the block import type.

pub fn build_with_noop_provider<ChainSpec>( self, chain_spec: Arc<ChainSpec>, ) -> NetworkConfig<NoopProvider<ChainSpec>, N>

where ChainSpec: EthChainSpec + Hardforks + 'static,

Convenience function for creating a NetworkConfig with a noop provider that does nothing.

pub const fn add_nat(self, nat: Option<NatResolver>) -> Self

Sets the NAT resolver for external IP.

pub fn build<C>(self, client: C) -> NetworkConfig<C, N>

where C: ChainSpecProvider<ChainSpec: Hardforks>,

Consumes the type and creates the actual NetworkConfig for the given client type that can interact with the chain.

The given client is to be used for interacting with the chain, for example fetching the corresponding block for a given block hash we receive from a peer in the status message when establishing a connection.

Trait Implementations

impl<N: Debug + NetworkPrimitives> Debug for NetworkConfigBuilder<N>

where N::Block: Debug,

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: 2264 bytes