Struct AggregatingStrategyConfig

pub struct AggregatingStrategyConfig {
    pub aggregation_threshold: Option<u32>,
    pub unrealized_balance_ratio: Option<f64>,
    pub aggregate_on_channel_close: bool,
}

Configuration object for the AggregatingStrategy

Fields

aggregation_threshold: Option<u32>

Number of acknowledged winning tickets in a channel that triggers the ticket aggregation in that channel when exceeded.

This condition is independent of unrealized_balance_ratio.

Default is 250.

unrealized_balance_ratio: Option<f64>

Percentage of unrealized balance in unaggregated tickets in a channel that triggers the ticket aggregation when exceeded.

The unrealized balance in this case is the proportion of the channel balance allocated in unredeemed unaggregated tickets. This condition is independent of aggregation_threshold.

Default is 0.9

aggregate_on_channel_close: bool

If set, the strategy will automatically aggregate tickets in channel that has transitioned to the PendingToClose state.

This happens regardless if aggregation_threshold or unrealized_balance_ratio thresholds are met on that channel. If the aggregation on-close fails, the tickets are automatically sent for redeeming instead.

Default is true.

Trait Implementations

impl Clone for AggregatingStrategyConfig

fn clone(&self) -> AggregatingStrategyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AggregatingStrategyConfig

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

Formats the value using the given formatter.

impl Default for AggregatingStrategyConfig

fn default() -> Self

Return AggregatingStrategyConfig { aggregation_threshold: default_aggregation_threshold(), unrealized_balance_ratio: default_unrealized_balance_ratio(), aggregate_on_channel_close: just_true() }

impl<'de> Deserialize<'de> for AggregatingStrategyConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AggregatingStrategyConfig> for AggregationPrerequisites

fn from(value: AggregatingStrategyConfig) -> Self

Converts to this type from the input type.

impl PartialEq for AggregatingStrategyConfig

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

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 AggregatingStrategyConfig

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

impl<'v_a> ValidateArgs<'v_a> for AggregatingStrategyConfig

type Args = ()

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

impl Copy for AggregatingStrategyConfig

impl StructuralPartialEq for AggregatingStrategyConfig