Struct SsaGeneratorConfig 

pub struct SsaGeneratorConfig {
    pub polynomials_per_ssa: u16,
    pub threshold: u8,
    pub surplus_shares: u8,
}

Configuration for the SsaShareGenerator.

Fields

polynomials_per_ssa: u16

The number of polynomials to generate per SSA commitment.

Default is DEFAULT_POLYS_PER_SSA, must be between 1 and MAX_POLYS_PER_SSA.

threshold: u8

Minimum number of shares required to reconstruct each SSA polynomial.

Default is DEFAULT_POLY_THRESHOLD, must be at least MIN_POLY_THRESHOLD. The upper bound MAX_POLY_THRESHOLD is the width of the field.

surplus_shares: u8

Additional number of shares to generate beyond the threshold for redundancy.

Covers lost shares only: the Exit reconstructs from the first threshold distinct shares that reach it, so any of the surplus can stand in for one that never arrives. It does not cover corrupt shares — nothing checks a share on arrival any more, so a bad one is only noticed once it has already poisoned the interpolation. See SsaPartCommitment.

Emitting them is unconditional: a polynomial leaves the queue at threshold + surplus shares, whether or not any were lost, so the Exit serves this many packets per polynomial in every case. That is why the surplus is part of the per-SSA quota rather than free service — the Entry is buying insurance, and insurance is paid for whether or not it is claimed.

Default is DEFAULT_SURPLUS_SHARES — but prefer default_surplus_for wherever the threshold is known, because this is a ratio of it and the constant can only be the ratio evaluated at the default threshold.

Bounded by threshold rather than by the byte the wire gives it: see surplus_must_not_exceed_threshold. It shares the lower half of the negotiated PixParams word with threshold, so a byte is all that fits there — but what is representable and what is sane to configure are different questions, and this field used to be documented as needing no validator on the strength of the first.

Trait Implementations

impl Clone for SsaGeneratorConfig

fn clone(&self) -> SsaGeneratorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SsaGeneratorConfig

impl Debug for SsaGeneratorConfig

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

Formats the value using the given formatter.

impl Default for SsaGeneratorConfig

fn default() -> Self

Return SsaGeneratorConfig { polynomials_per_ssa: DEFAULT_POLYS_PER_SSA, threshold: DEFAULT_POLY_THRESHOLD, surplus_shares: DEFAULT_SURPLUS_SHARES }

impl<'de> Deserialize<'de> for SsaGeneratorConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SsaGeneratorConfig

impl PartialEq for SsaGeneratorConfig

fn eq(&self, other: &SsaGeneratorConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SsaGeneratorConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SsaGeneratorConfig

impl Validate for SsaGeneratorConfig

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

impl<'v_a> ValidateArgs<'v_a> for SsaGeneratorConfig

type Args = ()

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