Struct reth_network :: config :: NetworkConfigBuilder Copy item path

impl NetworkConfigBuilder

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 fn chain_spec(self, chain_spec: Arc<ChainSpec>) -> Self

Sets the chain spec.

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

Sets the NetworkMode.

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 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 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>) -> Self

Sets the block import type.

pub fn build_with_noop_provider(self) -> NetworkConfig<NoopBlockReader>

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

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

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 Debug for NetworkConfigBuilder

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !UnwindSafe for NetworkConfigBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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> 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: '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: '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: '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: '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> Same for T

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(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

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

Mutable access to the BorrowMut 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(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

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

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, 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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::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

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