Struct PromiscuousStrategyConfig

pub struct PromiscuousStrategyConfig {
    pub network_quality_threshold: f64,
    pub min_network_size_samples: u32,
    pub new_channel_stake: Balance,
    pub minimum_node_balance: Balance,
    pub max_channels: Option<usize>,
    pub enforce_max_channels: bool,
    pub minimum_peer_version: VersionReq,
}

Configuration of PromiscuousStrategy.

Fields

network_quality_threshold: f64

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

min_network_size_samples: u32

Minimum number of network quality samples before the strategy can start making decisions.

new_channel_stake: Balance

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

Defaults to 10 HOPR

minimum_node_balance: Balance

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

Defaults to 10 HOPR

max_channels: Option<usize>

Maximum number of opened channels the strategy should maintain.

Defaults to square-root of the sampled network size.

enforce_max_channels: bool

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

minimum_peer_version: VersionReq

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

Default is “>=2.0.0”

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_threshold: 0.5, min_network_size_samples: 10, new_channel_stake: Balance::new_from_str("10000000000000000000", BalanceType::HOPR), minimum_node_balance: Balance::new_from_str("10000000000000000000", BalanceType::HOPR), max_channels: Default::default(), enforce_max_channels: true, minimum_peer_version: ">=2.0.0".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<'v_a> ValidateArgs<'v_a> for PromiscuousStrategyConfig

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl StructuralPartialEq for PromiscuousStrategyConfig