Struct Config 

pub struct Config<S: Scheme, L: Elector<S>, B: Blocker<PublicKey = S::PublicKey>, D: Digest, A: CertifiableAutomaton<Context = Context<D, S::PublicKey>>, R: Relay, F: Reporter<Activity = Activity<S, D>>> {

    pub scheme: S,
    pub elector: L,
    pub blocker: B,
    pub automaton: A,
    pub relay: R,
    pub reporter: F,
    pub partition: String,
    pub mailbox_size: usize,
    pub epoch: Epoch,
    pub namespace: Vec<u8>,
    pub replay_buffer: NonZeroUsize,
    pub write_buffer: NonZeroUsize,
    pub buffer_pool: PoolRef,
    pub leader_timeout: Duration,
    pub notarization_timeout: Duration,
    pub nullify_retry: Duration,
    pub activity_timeout: ViewDelta,
    pub skip_timeout: ViewDelta,
    pub fetch_timeout: Duration,
    pub fetch_concurrent: usize,
}

Configuration for the consensus engine.

Fields

scheme: S

Signing scheme for the consensus engine.

Consensus messages can be signed with a cryptosystem that differs from the static participant identity keys exposed in participants. For example, we can authenticate peers on the network with commonware_cryptography::ed25519 keys while signing votes with shares distributed via commonware_cryptography::bls12381::dkg (which change each epoch). The scheme implementation is responsible for reusing the exact participant ordering carried by participants so that signer indices remain stable across both key spaces; if the order diverges, validators will reject votes as coming from the wrong validator.

elector: L

Leader election configuration.

Determines how leaders are selected for each view. Built-in options include RoundRobin for deterministic rotation and Random for unpredictable selection using BLS threshold signatures.

blocker: B

Blocker for the network.

Blocking is handled by commonware_p2p.

automaton: A

Automaton for the consensus engine.

relay: R

Relay for the consensus engine.

reporter: F

Reporter for the consensus engine.

All activity is exported for downstream applications that benefit from total observability, consider wrapping with crate::simplex::scheme::reporter::AttributableReporter to automatically filter and verify activities based on scheme attributability.

partition: String

Partition for the consensus engine.

mailbox_size: usize

Maximum number of messages to buffer on channels inside the consensus engine before blocking.

epoch: Epoch

Epoch for the consensus engine. Each running engine should have a unique epoch.

namespace: Vec<u8>

Prefix for all signed messages to prevent replay attacks.

replay_buffer: NonZeroUsize

Number of bytes to buffer when replaying during startup.

write_buffer: NonZeroUsize

The size of the write buffer to use for each blob in the journal.

buffer_pool: PoolRef

Buffer pool for the journal.

leader_timeout: Duration

Amount of time to wait for a leader to propose a payload in a view.

notarization_timeout: Duration

Amount of time to wait for a quorum of notarizations in a view before attempting to skip the view.

nullify_retry: Duration

Amount of time to wait before retrying a nullify broadcast if stuck in a view.

activity_timeout: ViewDelta

Number of views behind finalized tip to track and persist activity derived from validator messages.

skip_timeout: ViewDelta

Move to nullify immediately if the selected leader has been inactive for this many recent known views (we ignore views we don’t have data for).

This number should be less than or equal to activity_timeout (how many views we are tracking below the finalized tip).

fetch_timeout: Duration

Timeout to wait for a peer to respond to a request.

fetch_concurrent: usize

Number of concurrent requests to make at once.

Implementations

impl<S: Scheme, L: Elector<S>, B: Blocker<PublicKey = S::PublicKey>, D: Digest, A: CertifiableAutomaton<Context = Context<D, S::PublicKey>>, R: Relay, F: Reporter<Activity = Activity<S, D>>> Config<S, L, B, D, A, R, F>

pub fn assert(&self)

Assert enforces that all configuration values are valid.