Skip to main content

NetworkConfigBuilder

reth::network::config

Struct NetworkConfigBuilder 

Source 
pub struct NetworkConfigBuilder<N = BasicNetworkPrimitives<EthPrimitives, EthereumTxEnvelope<TxEip4844WithSidecar>>>
where
    N: NetworkPrimitives,
{ /* private fields */ }
Expand description

Builder for NetworkConfig.

Implementations§

Source§

impl NetworkConfigBuilder

Source

pub fn eth(secret_key: SecretKey, executor: Runtime) -> NetworkConfigBuilder

Creates the NetworkConfigBuilder with EthNetworkPrimitives types.

Source§

impl<N> NetworkConfigBuilder<N>
where N: NetworkPrimitives,

Source

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

Create a new builder instance with a random secret key.

Source

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

Create a new builder instance with the given secret key.

Source

pub fn apply<F>(self, f: F) -> NetworkConfigBuilder<N>
where F: FnOnce(NetworkConfigBuilder<N>) -> NetworkConfigBuilder<N>,

Apply a function to the builder.

Source

pub fn get_peer_id(&self) -> FixedBytes<64>

Returns the configured PeerId

Source

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

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

Source

pub const fn network_mode( self, network_mode: NetworkMode, ) -> NetworkConfigBuilder<N>

Sets the NetworkMode.

Source

pub const fn with_pow(self) -> NetworkConfigBuilder<N>

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.

Source

pub const fn set_head(self, head: Head) -> NetworkConfigBuilder<N>

Sets the highest synced block.

This is used to construct the appropriate ForkFilter and UnifiedStatus message.

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

Source

pub fn hello_message( self, hello_message: HelloMessageWithProtocols, ) -> NetworkConfigBuilder<N>

Sets the HelloMessage to send when connecting to peers.

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

pub fn peer_config(self, config: PeersConfig) -> NetworkConfigBuilder<N>

Set a custom peer config for how peers are handled

Source

pub fn with_task_executor(self, executor: Runtime) -> NetworkConfigBuilder<N>

Sets the executor to use for spawning tasks.

Source

pub const fn sessions_config( self, config: SessionsConfig, ) -> NetworkConfigBuilder<N>

Sets a custom config for how sessions are handled.

Source

pub const fn transactions_manager_config( self, config: TransactionsManagerConfig, ) -> NetworkConfigBuilder<N>

Configures the transactions manager with the given config.

Source

pub const fn transaction_propagation_mode( self, mode: TransactionPropagationMode, ) -> NetworkConfigBuilder<N>

Configures the propagation mode for the transaction manager.

Source

pub const fn set_addrs(self, addr: SocketAddr) -> NetworkConfigBuilder<N>

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

Source

pub const fn listener_addr( self, listener_addr: SocketAddr, ) -> NetworkConfigBuilder<N>

Sets the socket address the network will listen on.

By default, this is DEFAULT_DISCOVERY_ADDRESS

Source

pub fn listener_port(self, port: u16) -> NetworkConfigBuilder<N>

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

By default, this is DEFAULT_DISCOVERY_PORT

Source

pub const fn discovery_addr( self, discovery_addr: SocketAddr, ) -> NetworkConfigBuilder<N>

Sets the socket address the discovery network will listen on

Source

pub fn discovery_port(self, port: u16) -> NetworkConfigBuilder<N>

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

By default, this is DEFAULT_DISCOVERY_PORT

Source

pub fn with_unused_ports(self) -> NetworkConfigBuilder<N>

Launches the network with an unused network and discovery port This is useful for testing.

Source

pub fn with_unused_discovery_port(self) -> NetworkConfigBuilder<N>

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

Source

pub fn with_unused_listener_port(self) -> NetworkConfigBuilder<N>

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

Source

pub fn external_ip_resolver( self, resolver: NatResolver, ) -> NetworkConfigBuilder<N>

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.

Source

pub fn discovery(self, builder: Discv4ConfigBuilder) -> NetworkConfigBuilder<N>

Sets the discv4 config to use.

Source

pub fn discovery_v5(self, builder: ConfigBuilder) -> NetworkConfigBuilder<N>

Sets the discv5 config to use.

Source

pub fn dns_discovery( self, config: DnsDiscoveryConfig, ) -> NetworkConfigBuilder<N>

Sets the dns discovery config to use.

Source

pub fn mainnet_boot_nodes(self) -> NetworkConfigBuilder<N>

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

Source

pub fn sepolia_boot_nodes(self) -> NetworkConfigBuilder<N>

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

Source

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

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

Source

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

Returns an iterator over all configured boot nodes.

Source

pub fn disable_dns_discovery(self) -> NetworkConfigBuilder<N>

Disable the DNS discovery.

Source

pub fn disable_nat(self) -> NetworkConfigBuilder<N>

Source

pub fn disable_discovery(self) -> NetworkConfigBuilder<N>

Disables all discovery.

Source

pub fn disable_discovery_if(self, disable: bool) -> NetworkConfigBuilder<N>

Disables all discovery if the given condition is true.

Source

pub fn disable_discv4_discovery(self) -> NetworkConfigBuilder<N>

Disable the Discv4 discovery.

Source

pub fn disable_discv5_discovery(self) -> NetworkConfigBuilder<N>

Disable the Discv5 discovery.

Source

pub fn disable_dns_discovery_if(self, disable: bool) -> NetworkConfigBuilder<N>

Disable the DNS discovery if the given condition is true.

Source

pub fn disable_discv4_discovery_if( self, disable: bool, ) -> NetworkConfigBuilder<N>

Disable the Discv4 discovery if the given condition is true.

Source

pub fn disable_discv5_discovery_if( self, disable: bool, ) -> NetworkConfigBuilder<N>

Disable the Discv5 discovery if the given condition is true.

Source

pub fn add_rlpx_sub_protocol( self, protocol: impl IntoRlpxSubProtocol, ) -> NetworkConfigBuilder<N>

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

Not for snap/2, which is supported natively (see Self::with_snap).

Source

pub const fn with_snap(self, snap_enabled: bool) -> NetworkConfigBuilder<N>

Toggles advertisement of the snap/2 satellite protocol (EIP-8189).

Default off: snap/2 is only negotiated with peers when explicitly enabled.

Source

pub const fn disable_tx_gossip( self, disable_tx_gossip: bool, ) -> NetworkConfigBuilder<N>

Sets whether tx gossip is disabled.

Source

pub fn required_block_hashes( self, hashes: Vec<NumHash>, ) -> NetworkConfigBuilder<N>

Sets the required block hashes for peer filtering.

Source

pub fn block_import( self, block_import: Box<dyn BlockImport<<N as NetworkPrimitives>::NewBlockPayload>>, ) -> NetworkConfigBuilder<N>

Sets the block import type.

Source

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.

Source

pub fn add_nat(self, nat: Option<NatResolver>) -> NetworkConfigBuilder<N>

Sets the NAT resolver for external IP.

Source

pub fn eth_rlpx_handshake( self, handshake: Arc<dyn EthRlpxHandshake>, ) -> NetworkConfigBuilder<N>

Overrides the default Eth RLPx handshake.

Source

pub const fn eth_max_message_size( self, max_message_size: usize, ) -> NetworkConfigBuilder<N>

Sets the maximum allowed ETH message size for post-handshake ETH/Snap streams.

This does not affect the initial status handshake, which continues to use MAX_MESSAGE_SIZE.

Every message also passes the p2p stream’s payload limit first, so a value above p2p_max_payload_size only takes effect once that is raised as well.

Source

pub const fn eth_max_message_size_opt( self, max_message_size: Option<usize>, ) -> NetworkConfigBuilder<N>

Sets the maximum allowed ETH message size for post-handshake ETH/Snap streams if present.

Source

pub const fn p2p_max_payload_size( self, max_payload_size: usize, ) -> NetworkConfigBuilder<N>

Sets the maximum uncompressed size of a message payload on the p2p stream, which defaults to MAX_PAYLOAD_SIZE (16 MiB, from EIP-706).

The limit applies to every subprotocol, in both directions, and to the p2p handshake. An RLPx frame carries less than 16 MiB of snappy-compressed data, so a larger value only admits messages that compress below that. Sending a frame that does not fit closes the session with an error.

Source

pub const fn network_id( self, network_id: Option<u64>, ) -> NetworkConfigBuilder<N>

Set the optional network id.

Source

pub fn build<C>(self, client: C) -> NetworkConfig<C, N>
where C: ChainSpecProvider, <C as 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§

Source§

impl<N> Debug for NetworkConfigBuilder<N>
where N: Debug + NetworkPrimitives, <N as NetworkPrimitives>::NewBlockPayload: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> NonStaticAny for T
where T: ?Sized,

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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