Struct Config

pub struct Config<C: Signer, B: Blocker<PublicKey = C::PublicKey>, V: Variant, D: Digest, A: Automaton<Context = Context<D>>, R: Relay, F: Reporter<Activity = Activity<V, D>>, S: ThresholdSupervisor<Index = View, Identity = V::Public, Seed = V::Signature, PublicKey = C::PublicKey, Share = Share>> {

    pub crypto: C,
    pub blocker: B,
    pub automaton: A,
    pub relay: R,
    pub reporter: F,
    pub supervisor: S,
    pub partition: String,
    pub compression: Option<u8>,
    pub mailbox_size: usize,
    pub namespace: Vec<u8>,
    pub replay_buffer: usize,
    pub write_buffer: usize,
    pub leader_timeout: Duration,
    pub notarization_timeout: Duration,
    pub nullify_retry: Duration,
    pub activity_timeout: View,
    pub skip_timeout: View,
    pub fetch_timeout: Duration,
    pub max_fetch_count: usize,
    pub fetch_rate_per_peer: Quota,
    pub fetch_concurrent: usize,
}

Configuration for the consensus engine.

Fields

crypto: C

Cryptographic primitives.

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.

supervisor: S

Supervisor for the consensus engine.

partition: String

Partition for the consensus engine.

compression: Option<u8>

Compression level for the consensus engine.

mailbox_size: usize

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

namespace: Vec<u8>

Prefix for all signed messages to prevent replay attacks.

replay_buffer: usize

Number of bytes to buffer when replaying during startup.

write_buffer: usize

The size of the write buffer to use for each blob in 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: View

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

skip_timeout: View

Move to nullify immediately if the selected leader has been inactive for this many views.

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

fetch_timeout: Duration

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

max_fetch_count: usize

Maximum number of notarizations/nullifications to request/respond with at once.

fetch_rate_per_peer: Quota

Maximum rate of requests to send to a given peer.

Inbound rate limiting is handled by commonware_p2p.

fetch_concurrent: usize

Number of concurrent requests to make at once.

Implementations

impl<C: Signer, B: Blocker<PublicKey = C::PublicKey>, V: Variant, D: Digest, A: Automaton<Context = Context<D>>, R: Relay, F: Reporter<Activity = Activity<V, D>>, S: ThresholdSupervisor<Seed = V::Signature, Index = View, Share = Share, Identity = V::Public, PublicKey = C::PublicKey>> Config<C, B, V, D, A, R, F, S>

pub fn assert(&self)

Assert enforces that all configuration values are valid.