commonware-consensus 2026.7.0

Order opaque messages in a Byzantine environment.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! Shared consensus-relay plumbing for the standard variant wrappers.

use crate::{
    marshal::{application::gates::Gates, core::Mailbox, standard::Standard},
    simplex::Plan,
    Block,
};
use commonware_actor::Feedback;
use commonware_cryptography::certificate::Scheme;
use commonware_p2p::Recipients;
use tracing::debug;

/// Relays a consensus broadcast [`Plan`] through marshal for the standard
/// variants ([`super::Deferred`] and [`super::Inline`]).
///
/// A propose plan sends the staged proposal to all peers, delivering the
/// durable-sync handle through the staged ack. A forward plan re-sends a
/// stored block to the requested recipients. A propose plan whose staged
/// proposal was already consumed falls back to a best-effort forward of the
/// persisted block.
pub(super) fn broadcast<S, B>(
    gates: &Gates<B::Digest, B>,
    marshal: &Mailbox<S, Standard<B>>,
    commitment: B::Digest,
    plan: Plan<S::PublicKey>,
) -> Feedback
where
    S: Scheme,
    B: Block,
{
    match plan {
        Plan::Propose { round } => {
            let Some((block, ack)) = gates.take_staged(round, commitment) else {
                debug!(%round, %commitment, "no staged proposal to relay, attempting forwarding");
                return marshal.forward(round, commitment, Recipients::All);
            };
            marshal.proposed(round, block, Recipients::All, ack)
        }
        Plan::Forward { round, recipients } => marshal.forward(round, commitment, recipients),
    }
}