Struct NetworkArgs

pub struct NetworkArgs {

    pub discovery: DiscoveryArgs,
    pub trusted_peers: Vec<TrustedPeer>,
    pub trusted_only: bool,
    pub bootnodes: Option<Vec<TrustedPeer>>,
    pub dns_retries: usize,
    pub peers_file: Option<PathBuf>,
    pub identity: String,
    pub p2p_secret_key: Option<PathBuf>,
    pub no_persist_peers: bool,
    pub nat: NatResolver,
    pub addr: IpAddr,
    pub port: u16,
    pub max_outbound_peers: Option<usize>,
    pub max_inbound_peers: Option<usize>,
    pub max_concurrent_tx_requests: u32,
    pub max_concurrent_tx_requests_per_peer: u8,
    pub max_seen_tx_history: u32,
    pub max_pending_pool_imports: usize,
    pub soft_limit_byte_size_pooled_transactions_response: usize,
    pub soft_limit_byte_size_pooled_transactions_response_on_pack_request: usize,
    pub max_capacity_cache_txns_pending_fetch: u32,
    pub net_if: Option<String>,
}

Parameters for configuring the network more granularity via CLI

Fields

discovery: DiscoveryArgs

Arguments to setup discovery service.

trusted_peers: Vec<TrustedPeer>

Comma separated enode URLs of trusted peers for P2P connections.

–trusted-peers enode://abcd@192.168.0.1:30303

trusted_only: bool

Connect to or accept from trusted peers only

bootnodes: Option<Vec<TrustedPeer>>

Comma separated enode URLs for P2P discovery bootstrap.

Will fall back to a network-specific default if not specified.

dns_retries: usize

Amount of DNS resolution requests retries to perform when peering.

peers_file: Option<PathBuf>

The path to the known peers file. Connected peers are dumped to this file on nodes shutdown, and read on startup. Cannot be used with --no-persist-peers.

identity: String

Custom node identity

p2p_secret_key: Option<PathBuf>

Secret key to use for this node.

This will also deterministically set the peer ID. If not specified, it will be set in the data dir for the chain being used.

no_persist_peers: bool

Do not persist peers.

nat: NatResolver

NAT resolution method (any|none|upnp|publicip|extip:<IP>)

addr: IpAddr

Network listening address

port: u16

Network listening port

max_outbound_peers: Option<usize>

Maximum number of outbound requests. default: 100

max_inbound_peers: Option<usize>

Maximum number of inbound requests. default: 30

max_concurrent_tx_requests: u32

Max concurrent GetPooledTransactions requests.

max_concurrent_tx_requests_per_peer: u8

Max concurrent GetPooledTransactions requests per peer.

max_seen_tx_history: u32

Max number of seen transactions to remember per peer.

Default is 320 transaction hashes.

max_pending_pool_imports: usize

Max number of transactions to import concurrently.

soft_limit_byte_size_pooled_transactions_response: usize

Experimental, for usage in research. Sets the max accumulated byte size of transactions to pack in one response. Spec’d at 2MiB.

soft_limit_byte_size_pooled_transactions_response_on_pack_request: usize

Experimental, for usage in research. Sets the max accumulated byte size of transactions to request in one request.

Since RLPx protocol version 68, the byte size of a transaction is shared as metadata in a transaction announcement (see RLPx specs). This allows a node to request a specific size response.

By default, nodes request only 128 KiB worth of transactions, but should a peer request more, up to 2 MiB, a node will answer with more than 128 KiB.

Default is 128 KiB.

max_capacity_cache_txns_pending_fetch: u32

Max capacity of cache of hashes for transactions pending fetch.

net_if: Option<String>

Name of network interface used to communicate with peers.

If flag is set, but no value is passed, the default interface for docker eth0 is tried.

Implementations

impl NetworkArgs

pub fn resolved_addr(&self) -> IpAddr

Returns the resolved IP address.

pub fn resolved_bootnodes(&self) -> Option<Vec<NodeRecord>>

Returns the resolved bootnodes if any are provided.

pub fn network_config( &self, config: &Config, chain_spec: impl EthChainSpec, secret_key: SecretKey, default_peers_file: PathBuf, ) -> NetworkConfigBuilder

Build a NetworkConfigBuilder from a [Config] and a EthChainSpec, in addition to the values in this option struct.

The default_peers_file will be used as the default location to store the persistent peers file if no_persist_peers is false, and there is no provided peers_file.

Configured Bootnodes are prioritized, if unset, the chain spec bootnodes are used Priority order for bootnodes configuration:

1. –bootnodes flag
2. Network preset flags (e.g. –holesky)
3. default to mainnet nodes

pub fn persistent_peers_file(&self, peers_file: PathBuf) -> Option<PathBuf>

If no_persist_peers is false then this returns the path to the persistent peers file path.

pub const fn with_unused_p2p_port(self) -> NetworkArgs

Sets the p2p port to zero, to allow the OS to assign a random unused port when the network components bind to a socket.

pub const fn with_unused_ports(self) -> NetworkArgs

Sets the p2p and discovery ports to zero, allowing the OD to assign a random unused port when network components bind to sockets.

pub fn adjust_instance_ports(&mut self, instance: u16)

Change networking port numbers based on the instance number. Ports are updated to previous_value + instance - 1

Panics

Warning: if instance is zero in debug mode, this will panic.

pub async fn resolve_trusted_peers(&self) -> Result<Vec<NodeRecord>, Error>

Resolve all trusted peers at once

Trait Implementations

impl Args for NetworkArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for NetworkArgs

fn clone(&self) -> NetworkArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NetworkArgs

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

Formats the value using the given formatter.

impl Default for NetworkArgs

fn default() -> NetworkArgs

Returns the “default value” for a type.

impl FromArgMatches for NetworkArgs

fn from_arg_matches( __clap_arg_matches: &ArgMatches, ) -> Result<NetworkArgs, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<NetworkArgs, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl PartialEq for NetworkArgs

fn eq(&self, other: &NetworkArgs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NetworkArgs

impl StructuralPartialEq for NetworkArgs

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