NetworkConfig

reth_network::config

Struct NetworkConfig 

Source 
pub struct NetworkConfig<C, N: NetworkPrimitives = EthNetworkPrimitives> {
Show 22 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_id: u64,
    pub fork_filter: ForkFilter,
    pub block_import: Box<dyn BlockImport<N::Block>>,
    pub network_mode: NetworkMode,
    pub executor: Box<dyn TaskSpawner>,
    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>,

}
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 [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::Block>>

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: 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 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.

§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.

Implementations§

Source§

impl<N: NetworkPrimitives> NetworkConfig<(), N>

Source

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

Convenience method for creating the corresponding builder type

Source

pub fn builder_with_rng_secret_key() -> NetworkConfigBuilder<N>

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

Source§

impl<C, N: NetworkPrimitives> NetworkConfig<C, N>

Source

pub fn new(client: C, secret_key: SecretKey) -> Self
where C: ChainSpecProvider<ChainSpec: Hardforks>,

Create a new instance with all mandatory fields set, rest is field with defaults.

Source

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

Apply a function to the config.

Source

pub fn set_discovery_v4(self, discovery_config: Discv4Config) -> Self

Sets the config to use for the discovery v4 protocol.

Source

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

Sets the address for the incoming RLPx connection listener.

Source

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

Returns the address for the incoming RLPx connection listener.

Source§

impl<C, N> NetworkConfig<C, N>
where C: BlockNumReader + 'static, N: NetworkPrimitives,

Source

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

Convenience method for calling NetworkManager::new.

Source§

impl<C, N> NetworkConfig<C, N>
where N: NetworkPrimitives, C: BlockReader<Block = N::Block, Receipt = N::Receipt, Header = N::BlockHeader> + HeaderProvider + Clone + Unpin + 'static,

Source

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§

Source§

impl<C: Debug, N: Debug + NetworkPrimitives> Debug for NetworkConfig<C, N>
where N::Block: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C, N> Freeze for NetworkConfig<C, N>
where C: Freeze,

§

impl<C, N = EthNetworkPrimitives> !RefUnwindSafe for NetworkConfig<C, N>

§

impl<C, N> Send for NetworkConfig<C, N>
where C: Send,

§

impl<C, N> Sync for NetworkConfig<C, N>
where C: Sync,

§

impl<C, N> Unpin for NetworkConfig<C, N>
where C: Unpin,

§

impl<C, N = EthNetworkPrimitives> !UnwindSafe for NetworkConfig<C, N>

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<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<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

§

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.
§

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

§

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.
§

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> 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
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 = Infallible

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

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

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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

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

§

impl<T> MaybeSend for T
where T: Send,

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.