Struct PromiscuousStrategyConfig

pub struct PromiscuousStrategyConfig {
    pub network_quality_open_threshold: f64,
    pub network_quality_close_threshold: f64,
    pub minimum_peer_pings: u32,
    pub initial_delay: Duration,
    pub new_channel_stake: Balance,
    pub minimum_safe_balance: Balance,
    pub max_channels: Option<usize>,
    pub enforce_max_channels: bool,
    pub minimum_peer_version: VersionReq,
}

Configuration of PromiscuousStrategy.

Fields

network_quality_open_threshold: f64

A quality threshold between 0 and 1 used to determine whether the strategy should open channel with the peer.

Default is 0.9

network_quality_close_threshold: f64

A quality threshold between 0 and 1 used to determine whether the strategy should close channel with the peer. If set to 0, no channels will be closed.

Default is 0.2

minimum_peer_pings: u32

Number of heartbeats sent to the peer before it is considered for selection.

Default is 50.

initial_delay: Duration

Initial delay from startup before the strategy starts taking decisions.

Default is 5 minutes.

new_channel_stake: Balance

A stake of tokens that should be allocated to a channel opened by the strategy.

Default is 10 wxHOPR

minimum_safe_balance: Balance

Minimum token balance of the node’s Safe. When reached, the strategy will not open any new channels.

Default is 1000 wxHOPR

max_channels: Option<usize>

The maximum number of opened channels the strategy should maintain.

Defaults to square-root of the sampled network size, the minimum is 10.

enforce_max_channels: bool

If set, the strategy will aggressively close channels (even with peers above the network_quality_close_threshold) if the number of opened outgoing channels (regardless if opened by the strategy or manually) exceeds the max_channels limit.

Default is true.

minimum_peer_version: VersionReq

Specifies a minimum version (in semver syntax) of the peer the strategy should open a channel to.

Default is “>=2.2.1”

Trait Implementations

impl Clone for PromiscuousStrategyConfig

fn clone(&self) -> PromiscuousStrategyConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PromiscuousStrategyConfig

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

Formats the value using the given formatter.

impl Default for PromiscuousStrategyConfig

fn default() -> Self

Return PromiscuousStrategyConfig { network_quality_open_threshold: default_network_quality_open_threshold(), network_quality_close_threshold: default_network_quality_close_threshold(), minimum_peer_pings: default_minimum_pings(), initial_delay: default_initial_delay(), new_channel_stake: default_new_channel_stake(), minimum_safe_balance: default_min_safe_balance(), max_channels: Default::default(), enforce_max_channels: true, minimum_peer_version: ">=2.2.1".parse().expect("should be valid default version") }

impl<'de> Deserialize<'de> for PromiscuousStrategyConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PromiscuousStrategyConfig

fn eq(&self, other: &PromiscuousStrategyConfig) -> 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 Serialize for PromiscuousStrategyConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for PromiscuousStrategyConfig

fn validate(&self) -> Result<(), ValidationErrors>

impl StructuralPartialEq for PromiscuousStrategyConfig