Struct Config

pub struct Config<P: Array, V: Variant, D: Digest, A: Automaton<Context = Index, Digest = D>, Z: Reporter<Activity = Activity<V, D>>, M: Monitor<Index = Epoch>, B: Blocker<PublicKey = P>, TSu: ThresholdSupervisor<Index = Epoch, PublicKey = P>> {

    pub monitor: M,
    pub validators: TSu,
    pub automaton: A,
    pub reporter: Z,
    pub blocker: B,
    pub namespace: Vec<u8>,
    pub priority_acks: bool,
    pub rebroadcast_timeout: NonZeroDuration,
    pub epoch_bounds: (u64, u64),
    pub window: NonZeroU64,
    pub journal_partition: String,
    pub journal_write_buffer: NonZeroUsize,
    pub journal_replay_buffer: NonZeroUsize,
    pub journal_heights_per_section: NonZeroU64,
    pub journal_compression: Option<u8>,
}

Configuration for the super::Engine.

Fields

monitor: M

Tracks the current state of consensus (to determine which participants should be involved in the current broadcast attempt).

validators: TSu

Manages the set of validators and the group identity. Also manages the cryptographic partial share if the engine is a validator.

automaton: A

Proposes and verifies Digests.

reporter: Z

Notified when a chunk receives a threshold of super::types::Acks.

blocker: B

Blocker for the network.

Blocking is handled by commonware_p2p.

namespace: Vec<u8>

The application namespace used to sign over different types of messages. Used to prevent replay attacks on other applications.

priority_acks: bool

Whether acks are sent as priority.

rebroadcast_timeout: NonZeroDuration

How often an ack is rebroadcast to all validators if no threshold is reached.

epoch_bounds: (u64, u64)

A tuple representing the epochs to keep in memory. The first element is the number of old epochs to keep. The second element is the number of future epochs to accept.

For example, if the current epoch is 10, and the bounds are (1, 2), then epochs 9, 10, 11, and 12 are kept (and accepted); all others are pruned or rejected.

window: NonZeroU64

The number of chunks to process concurrently.

journal_partition: String

Partition for the commonware_storage::journal::variable::Journal.

journal_write_buffer: NonZeroUsize

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

journal_replay_buffer: NonZeroUsize

Number of bytes to buffer when replaying a journal.

journal_heights_per_section: NonZeroU64

The number of entries to keep per journal section.

journal_compression: Option<u8>

Compression level for the journal.