Struct reth_network::config::NetworkConfig
source · pub struct NetworkConfig<C> {Show 20 fields
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_spec: Arc<ChainSpec>,
pub fork_filter: ForkFilter,
pub block_import: Box<dyn BlockImport>,
pub network_mode: NetworkMode,
pub executor: Box<dyn TaskSpawner>,
pub status: Status,
pub hello_message: HelloMessageWithProtocols,
pub extra_protocols: RlpxSubProtocols,
pub tx_gossip_disabled: bool,
pub transactions_manager_config: TransactionsManagerConfig,
}
Expand description
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 [Status] 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_spec: Arc<ChainSpec>
The chain spec
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>
The block importer type.
network_mode: NetworkMode
The default mode of the network.
executor: Box<dyn TaskSpawner>
The executor to use for spawning tasks.
status: Status
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 protocols to announce and handle in RLPx
tx_gossip_disabled: bool
Whether to disable transaction gossip
transactions_manager_config: TransactionsManagerConfig
How to instantiate transactions manager.
Implementations§
source§impl NetworkConfig<()>
impl NetworkConfig<()>
sourcepub fn builder(secret_key: SecretKey) -> NetworkConfigBuilder
pub fn builder(secret_key: SecretKey) -> NetworkConfigBuilder
Convenience method for creating the corresponding builder type
sourcepub fn builder_with_rng_secret_key() -> NetworkConfigBuilder
pub fn builder_with_rng_secret_key() -> NetworkConfigBuilder
Convenience method for creating the corresponding builder type with a random secret key.
source§impl<C> NetworkConfig<C>
impl<C> NetworkConfig<C>
sourcepub fn new(client: C, secret_key: SecretKey) -> Self
pub fn new(client: C, secret_key: SecretKey) -> Self
Create a new instance with all mandatory fields set, rest is field with defaults.
sourcepub fn set_discovery_v4(self, discovery_config: Discv4Config) -> Self
pub fn set_discovery_v4(self, discovery_config: Discv4Config) -> Self
Sets the config to use for the discovery v4 protocol.
sourcepub const fn set_listener_addr(self, listener_addr: SocketAddr) -> Self
pub const fn set_listener_addr(self, listener_addr: SocketAddr) -> Self
Sets the address for the incoming RLPx
connection listener.
sourcepub const fn listener_addr(&self) -> &SocketAddr
pub const fn listener_addr(&self) -> &SocketAddr
Returns the address for the incoming RLPx
connection listener.
source§impl<C> NetworkConfig<C>where
C: BlockNumReader + 'static,
impl<C> NetworkConfig<C>where
C: BlockNumReader + 'static,
sourcepub async fn manager(self) -> Result<NetworkManager, NetworkError>
pub async fn manager(self) -> Result<NetworkManager, NetworkError>
Convenience method for calling NetworkManager::new
.
source§impl<C> NetworkConfig<C>
impl<C> NetworkConfig<C>
sourcepub async fn start_network(self) -> Result<NetworkHandle, NetworkError>
pub async fn start_network(self) -> Result<NetworkHandle, NetworkError>
Starts the networking stack given a NetworkConfig
and returns a handle to the network.
Trait Implementations§
Auto Trait Implementations§
impl<C> Freeze for NetworkConfig<C>where
C: Freeze,
impl<C> !RefUnwindSafe for NetworkConfig<C>
impl<C> Send for NetworkConfig<C>where
C: Send,
impl<C> Sync for NetworkConfig<C>where
C: Sync,
impl<C> Unpin for NetworkConfig<C>where
C: Unpin,
impl<C> !UnwindSafe for NetworkConfig<C>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<T> MaybeDebug for Twhere
T: Debug,
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.