Struct Config

pub struct Config<C: Scheme, D: Array, A: Application<Context = Context<C::PublicKey>, Digest = D>, Z: Collector<Digest = D>, S: ThresholdCoordinator<Index = Epoch>> {

    pub crypto: C,
    pub coordinator: S,
    pub application: A,
    pub collector: Z,
    pub mailbox_size: usize,
    pub verify_concurrent: usize,
    pub namespace: Vec<u8>,
    pub refresh_epoch_timeout: Duration,
    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,
}

Configuration for the Engine.

Fields

crypto: C

The cryptographic scheme used if the engine is a sequencer.

coordinator: S

Manages the set of sequencers and signers. Also manages the cryptographic partial share if the engine is a signer.

application: A

Verifies chunks.

collector: Z

Notified when a chunk receives a threshold of acks.

mailbox_size: usize

The maximum size of the mailbox backlog.

verify_concurrent: usize

The maximum number of concurrent pending requests to the application.

namespace: Vec<u8>

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

refresh_epoch_timeout: Duration

How often the epoch is refreshed.

rebroadcast_timeout: Duration

How often the chunk is rebroadcast to all signers 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.