Crate commonware_consensus 

Order opaque messages in a Byzantine environment.

Status

Stability varies by primitive. See README for details.

Modules

aggregation

Recover quorum certificates over an externally synchronized sequencer of items.

marshal

Ordered delivery of finalized blocks.

simplex

Simple and fast BFT agreement inspired by Simplex Consensus.

types

Consensus types shared across the crate.

Structs

Reporters

A struct used to report activity to multiple Reporters (which may or may not be present).

Enums

Handoff

An application’s response to a handoff proposal request.

Traits

Application

Application is a minimal interface for standard implementations that operate over a stream of epoched blocks.

Automaton

Automaton is the interface responsible for driving the consensus forward by proposing new payloads and verifying payloads proposed by other participants.

Block

Block is the interface for a block in the blockchain.

BoundedBlock

A block that bounds its encoded size under a codec configuration.

CertifiableAutomaton

CertifiableAutomaton extends Automaton with the ability to certify payloads before finalization.

CertifiableBlock

CertifiableBlock extends Block with consensus context information.

Epochable

Epochable is a trait that provides access to the epoch number. Any consensus message or object that is associated with a specific epoch should implement this.

Heightable

Heightable is a trait that provides access to the height. Any consensus message or object that is associated with a specific height should implement this.

Monitor

Monitor is the interface an external actor can use to observe the progress of a consensus implementation.

Relay

Relay is the interface responsible for broadcasting payloads to the network.

Reporter

Reporter is the interface responsible for reporting activity to some external actor.

Roundable

Roundable is a trait that provides access to the Round number. Any consensus message or object that implements Epochable and Viewable automatically implements this trait.

Viewable

Viewable is a trait that provides access to the view (round) number. Any consensus message or object that is associated with a specific view should implement this.

Type Aliases

IndexSubscription

Alias for the subscription type returned by Monitor::subscribe.