Struct Config

pub struct Config<C: Signer, V: Variant, D: Digest, A: Automaton<Context = Context<C::PublicKey>, Digest = D>, R: Relay<Digest = D>, Z: Reporter<Activity = Activity<C::PublicKey, V, D>>, M: Monitor<Index = Epoch>, Su: Supervisor<Index = Epoch, PublicKey = C::PublicKey>, TSu: ThresholdSupervisor<Index = Epoch, PublicKey = C::PublicKey>> {

    pub crypto: C,
    pub monitor: M,
    pub validators: TSu,
    pub sequencers: Su,
    pub automaton: A,
    pub relay: R,
    pub reporter: Z,
    pub namespace: Vec<u8>,
    pub priority_proposals: bool,
    pub priority_acks: bool,
    pub rebroadcast_timeout: Duration,
    pub epoch_bounds: (u64, u64),
    pub height_bound: u64,
    pub journal_name_prefix: String,
    pub journal_heights_per_section: u64,
    pub journal_replay_concurrency: usize,
    pub journal_replay_buffer: usize,
    pub journal_write_buffer: usize,
    pub journal_compression: Option<u8>,
}

Configuration for the Engine.

Fields

crypto: C

The cryptographic scheme used if the engine is a sequencer.

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 polynomial. Also manages the cryptographic partial share if the engine is a validator.

sequencers: Su

Manages the set of sequencers.

automaton: A

Proposes and verifies digests.

relay: R

Broadcasts the raw payload.

reporter: Z

Notified when a chunk receives a threshold of acks.

namespace: Vec<u8>

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

priority_proposals: bool

Whether proposals are sent as priority.

priority_acks: bool

Whether acks are sent as priority.

rebroadcast_timeout: Duration

How often a proposal 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.

height_bound: u64

The number of future heights to accept acks for. This is used to prevent spam of acks for arbitrary heights.

For example, if the current tip for a sequencer is at height 100, and the height_bound is 10, then acks for heights 100-110 are accepted.

journal_name_prefix: String

A prefix for the journal names. The rest of the name is the hex-encoded public keys of the relevant sequencer.

journal_heights_per_section: u64

The number of entries to keep per journal section.

journal_replay_concurrency: usize

Upon replaying a journal, the number of entries to replay concurrently.

journal_replay_buffer: usize

The number of bytes to buffer when replaying a journal.

journal_write_buffer: usize

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

journal_compression: Option<u8>

Compression level for the journal.