Struct DiscoveryConfig

pub struct DiscoveryConfig {

    pub interval_period_ms: Option<u64>,
    pub target_concurrent_connections: Option<usize>,
    pub peers_to_query: Option<usize>,
    pub peer_query_timeout_sec: Option<u64>,
    pub get_known_peers_rate_limit: Option<NonZeroU32>,
    pub access_type: Option<AccessType>,
    pub allowlisted_peers: Vec<AllowlistedPeer>,
    pub max_concurrent_address_verifications: Option<usize>,
    pub address_verification_timeout_sec: Option<u64>,
    pub address_verification_total_timeout_sec: Option<u64>,
    pub address_verification_failure_cooldown_sec: Option<u64>,
    pub cooldown_cleanup_interval_sec: Option<u64>,
    pub allow_private_addresses: Option<bool>,
}

Fields

interval_period_ms: Option<u64>

Query peers for their latest checkpoint every interval period.

If unspecified, this will default to 5,000 milliseconds.

target_concurrent_connections: Option<usize>

Target number of concurrent connections to establish.

If unspecified, this will default to 4.

peers_to_query: Option<usize>

Number of peers to query each interval.

Sets the number of peers, to be randomly selected, that are queried for their known peers each interval.

If unspecified, this will default to 1.

peer_query_timeout_sec: Option<u64>

Timeout for individual peer query requests in discovery protocol.

If unspecified, this will default to 1 second.

get_known_peers_rate_limit: Option<NonZeroU32>

Per-peer rate-limit (in requests/sec) for the GetKnownPeers RPC.

If unspecified, this will default to no limit.

access_type: Option<AccessType>

See docstring for AccessType.

allowlisted_peers: Vec<AllowlistedPeer>

Like seed_peers in P2pConfig, allowlisted peers will always be allowed to establish connection with this node regardless of the concurrency limit. Unlike seed_peers, a node does not reach out to allowlisted_peers preferentially. It is also used to determine if a peer is accessible when its AccessType is Private. For example, a node will ignore a peer with Private AccessType if the peer is not in its allowlisted_peers. Namely, the node will not try to establish connections to this peer, nor advertise this peer’s info to other peers in the network.

max_concurrent_address_verifications: Option<usize>

Maximum number of concurrent address verification attempts. This prevents overwhelming the network when verifying many peers at once.

If unspecified, this will default to 10.

address_verification_timeout_sec: Option<u64>

Timeout for individual address verification attempts.

If unspecified, this will default to 3 seconds.

address_verification_total_timeout_sec: Option<u64>

Total timeout for all address verification attempts to prevent DoS attacks.

If unspecified, this will default to 8 seconds.

address_verification_failure_cooldown_sec: Option<u64>

Cooldown period in seconds for peers whose address verification failed. During this period, new peer info from the same peer will be ignored. Set to 0 to disable the cooldown feature entirely.

If unspecified, this will default to 600 seconds (10 minutes).

cooldown_cleanup_interval_sec: Option<u64>

Interval for cleaning up old entries from the verification failure cooldown list.

If unspecified, this will default to 300 seconds (5 minutes).

allow_private_addresses: Option<bool>

Whether to allow private IP and local DNS addresses (e.g., 192.168.0.1, localhost, .local) when verifying peer addresses.

Implementations

impl DiscoveryConfig

pub fn interval_period(&self) -> Duration

pub fn target_concurrent_connections(&self) -> usize

pub fn peers_to_query(&self) -> usize

pub fn peer_query_timeout(&self) -> Duration

pub fn access_type(&self) -> AccessType

pub fn max_concurrent_address_verifications(&self) -> usize

pub fn address_verification_timeout(&self) -> Duration

pub fn address_verification_total_timeout(&self) -> Duration

pub fn address_verification_failure_cooldown(&self) -> Duration

pub fn cooldown_cleanup_interval(&self) -> Duration

pub fn is_address_verification_cooldown_enabled(&self) -> bool

Returns true if address verification cooldown is enabled (cooldown > 0)

pub fn allow_private_addresses(&self) -> bool

Whether to allow private IP and local DNS addresses (e.g., 192.168.0.1, localhost, .local) when verifying peer addresses.

Trait Implementations

impl Clone for DiscoveryConfig

fn clone(&self) -> DiscoveryConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiscoveryConfig

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

Formats the value using the given formatter.

impl Default for DiscoveryConfig

fn default() -> DiscoveryConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DiscoveryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DiscoveryConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.