Struct NetworkConfig 

pub struct NetworkConfig<C, N = BasicNetworkPrimitives<EthPrimitives, EthereumTxEnvelope<TxEip4844WithSidecar>>>
where
    N: NetworkPrimitives,
{

    pub client: C,
    pub secret_key: SecretKey,
    pub boot_nodes: HashSet<TrustedPeer>,
    pub dns_discovery_config: Option<DnsDiscoveryConfig>,
    pub discovery_v4_addr: SocketAddr,
    pub discovery_v4_config: Option<Discv4Config>,
    pub discovery_v5_config: Option<Config>,
    pub listener_addr: SocketAddr,
    pub peers_config: PeersConfig,
    pub sessions_config: SessionsConfig,
    pub chain_id: u64,
    pub fork_filter: ForkFilter,
    pub block_import: Box<dyn BlockImport<<N as NetworkPrimitives>::NewBlockPayload>>,
    pub network_mode: NetworkMode,
    pub executor: Runtime,
    pub status: UnifiedStatus,
    pub hello_message: HelloMessageWithProtocols,
    pub extra_protocols: RlpxSubProtocols,
    pub tx_gossip_disabled: bool,
    pub transactions_manager_config: TransactionsManagerConfig,
    pub nat: Option<NatResolver>,
    pub handshake: Arc<dyn EthRlpxHandshake>,
    pub eth_max_message_size: usize,
    pub p2p_max_payload_size: usize,
    pub required_block_hashes: Vec<NumHash>,
}

Available on crate feature network only.

All network related initialization settings.

Fields

client: C

The client type that can interact with the chain.

This type is used to fetch the block number after we established a session and received the UnifiedStatus block hash.

secret_key: SecretKey

The node’s secret key, from which the node’s identity is derived.

boot_nodes: HashSet<TrustedPeer>

All boot nodes to start network discovery with.

dns_discovery_config: Option<DnsDiscoveryConfig>

How to set up discovery over DNS.

discovery_v4_addr: SocketAddr

Address to use for discovery v4.

discovery_v4_config: Option<Discv4Config>

How to set up discovery.

discovery_v5_config: Option<Config>

How to set up discovery version 5.

listener_addr: SocketAddr

Address to listen for incoming connections

peers_config: PeersConfig

How to instantiate peer manager.

sessions_config: SessionsConfig

How to configure the SessionManager.

chain_id: u64

The chain id

fork_filter: ForkFilter

The ForkFilter to use at launch for authenticating sessions.

See also https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2124.md#stale-software-examples

For sync from block 0, this should be the default chain ForkFilter beginning at the first hardfork, Frontier for mainnet.

block_import: Box<dyn BlockImport<<N as NetworkPrimitives>::NewBlockPayload>>

The block importer type.

network_mode: NetworkMode

The default mode of the network.

executor: Runtime

The executor to use for spawning tasks.

status: UnifiedStatus

The Status message to send to peers at the beginning.

hello_message: HelloMessageWithProtocols

Sets the hello message for the p2p handshake in RLPx

extra_protocols: RlpxSubProtocols

Additional RLPx sub-protocols to announce and handle alongside eth.

Does not cover snap/2, which is supported natively (see NetworkConfigBuilder::with_snap).

tx_gossip_disabled: bool

Whether to disable transaction gossip

transactions_manager_config: TransactionsManagerConfig

How to instantiate transactions manager.

nat: Option<NatResolver>

The NAT resolver for external IP

handshake: Arc<dyn EthRlpxHandshake>

The Ethereum P2P handshake, see also: https://github.com/ethereum/devp2p/blob/master/rlpx.md#initial-handshake. This can be overridden to support custom handshake logic via the NetworkConfigBuilder.

eth_max_message_size: usize

Maximum allowed ETH message size for post-handshake ETH/Snap streams.

p2p_max_payload_size: usize

Maximum uncompressed size of a message payload on the p2p stream, which carries every subprotocol.

required_block_hashes: Vec<NumHash>

List of block number-hash pairs to check for required blocks. If non-empty, peers that don’t have these blocks will be filtered out.

Implementations

impl<N> NetworkConfig<(), N>

where N: NetworkPrimitives,

pub fn builder( secret_key: SecretKey, executor: Runtime, ) -> NetworkConfigBuilder<N>

Convenience method for creating the corresponding builder type.

pub fn builder_with_rng_secret_key(executor: Runtime) -> NetworkConfigBuilder<N>

Convenience method for creating the corresponding builder type with a random secret key.

impl<C, N> NetworkConfig<C, N>

where N: NetworkPrimitives,

pub fn apply<F>(self, f: F) -> NetworkConfig<C, N>

where F: FnOnce(NetworkConfig<C, N>) -> NetworkConfig<C, N>,

Apply a function to the config.

pub fn set_discovery_v4( self, discovery_config: Discv4Config, ) -> NetworkConfig<C, N>

Sets the config to use for the discovery v4 protocol.

pub const fn set_listener_addr( self, listener_addr: SocketAddr, ) -> NetworkConfig<C, N>

Sets the address for the incoming RLPx connection listener.

pub const fn listener_addr(&self) -> &SocketAddr

Returns the address for the incoming RLPx connection listener.

impl<C, N> NetworkConfig<C, N>

where C: BlockNumReader + 'static, N: NetworkPrimitives,

pub async fn manager(self) -> Result<NetworkManager<N>, NetworkError>

Convenience method for calling NetworkManager::new.

impl<C, N> NetworkConfig<C, N>

where C: BalProvider + StateProviderFactory + StateRangeProviderFactory + BlockReader<Block = <N as NetworkPrimitives>::Block, Receipt = <N as NetworkPrimitives>::Receipt, Header = <N as NetworkPrimitives>::BlockHeader> + Clone + Unpin + 'static, N: NetworkPrimitives,

pub async fn start_network(self) -> Result<NetworkHandle<N>, NetworkError>

Starts the networking stack given a NetworkConfig and returns a handle to the network.

Trait Implementations

impl<C, N> Debug for NetworkConfig<C, N>

where C: Debug, N: Debug + NetworkPrimitives, <N as NetworkPrimitives>::NewBlockPayload: Debug,

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

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.