Struct DandelionConfig

pub struct DandelionConfig {
    pub time_between_hop: Duration,
    pub epoch_duration: Duration,
    pub fluff_probability: f64,
    pub graph: Graph,
}

The config used to initialize dandelion.

One notable missing item from the config is Tbase AKA the timeout parameter to prevent black hole attacks. This is removed from the config for simplicity, Tbase is calculated using the formula provided in the D++ paper:

(-k*(k-1)*hop)/(2*log(1-ep))

Where k is calculated from the fluff probability, hop is time_between_hop and ep is fixed at 0.1.

Fields

time_between_hop: Duration

The time it takes for a stem transaction to pass through a node, including network latency.

It’s better to be safe and put a slightly higher value than lower.

epoch_duration: Duration

The duration of an epoch.

fluff_probability: f64

q in the dandelion paper, this is the probability that a node will be in the fluff state for a certain epoch.

The dandelion paper recommends to make this value small, but the smaller this value, the higher the broadcast latency.

It is recommended for this value to be <= 0.2, this value MUST be in range 0.0..=1.0.

graph: Graph

The graph type.

Implementations

impl DandelionConfig

pub const fn number_of_stems(&self) -> usize

Returns the number of outbound peers to use to stem transactions.

This value depends on the Graph chosen.

pub fn average_embargo_timeout(&self) -> Duration

Returns the average embargo timeout, Tbase in the dandelion++ paper.

This is the average embargo timeout only including this node with k nodes also putting an embargo timeout using the exponential distribution, the average until one of them fluffs is Tbase / k.

pub fn expected_stem_length(&self) -> f64

Returns the expected length of a stem.

Trait Implementations

impl Clone for DandelionConfig

fn clone(&self) -> DandelionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DandelionConfig

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

Formats the value using the given formatter.

impl Copy for DandelionConfig

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