commonware-glue 2026.5.0

Default constructions that span multiple primitives.
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use super::common::MockValidatorState;
use crate::simulate::{processed::ProcessedHeight, property::Property, tracker::ProgressTracker};
use commonware_consensus::marshal::core::Variant;
use commonware_cryptography::{ed25519, sha256, Digestible};
use std::{future::Future, pin::Pin};

/// Post-run property: all validators agree on the finalized block at `height`.
#[derive(Clone, Copy)]
pub(crate) struct BlockAgreementAtHeight {
    height: u64,
}

impl BlockAgreementAtHeight {
    pub fn new(height: u64) -> Self {
        Self { height }
    }
}

impl<V> Property<ed25519::PublicKey, MockValidatorState<V>> for BlockAgreementAtHeight
where
    V: Variant,
    V::ApplicationBlock: Digestible<Digest = sha256::Digest>,
    MockValidatorState<V>: Send + Sync,
{
    fn name(&self) -> &str {
        "block_agreement_at_height"
    }

    fn check<'a>(
        &'a self,
        _tracker: &'a ProgressTracker<ed25519::PublicKey>,
        states: &'a [&'a MockValidatorState<V>],
    ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'a>> {
        Box::pin(async move {
            let mut expected = None;
            for state in states {
                let Some(digest) = state.digest_at_height(self.height).await else {
                    return Err(format!(
                        "missing finalized digest at height {} on at least one validator",
                        self.height
                    ));
                };
                if let Some(previous) = expected {
                    if digest != previous {
                        return Err(format!(
                            "digest disagreement at finalized height {}",
                            self.height
                        ));
                    }
                } else {
                    expected = Some(digest);
                }
            }

            Ok(())
        })
    }
}

/// Post-run property: at least one node used state sync and then advanced further.
#[derive(Clone, Copy)]
pub(crate) struct LateJoinerStateSyncHandoff;

impl<V> Property<ed25519::PublicKey, MockValidatorState<V>> for LateJoinerStateSyncHandoff
where
    V: Variant,
    V::ApplicationBlock: Digestible<Digest = sha256::Digest>,
    MockValidatorState<V>: Send + Sync,
{
    fn name(&self) -> &str {
        "late_joiner_state_sync_handoff"
    }

    fn check<'a>(
        &'a self,
        _tracker: &'a ProgressTracker<ed25519::PublicKey>,
        states: &'a [&'a MockValidatorState<V>],
    ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'a>> {
        Box::pin(async move {
            for state in states {
                let Some(sync_height) = state.state_sync_height() else {
                    continue;
                };
                let processed_height = state.processed_height().await;
                if processed_height > sync_height {
                    return Ok(());
                }
            }

            Err(
                "no validator both used state sync and advanced beyond the synced height"
                    .to_string(),
            )
        })
    }
}

/// Post-run property: a validator started state sync, crashed before it
/// completed, restarted, re-entered state sync, then advanced beyond the
/// synced height.
#[derive(Clone, Copy)]
pub(crate) struct CrashDuringStateSyncRecovery;

impl<V> Property<ed25519::PublicKey, MockValidatorState<V>> for CrashDuringStateSyncRecovery
where
    V: Variant,
    V::ApplicationBlock: Digestible<Digest = sha256::Digest>,
    MockValidatorState<V>: Send + Sync,
{
    fn name(&self) -> &str {
        "crash_during_state_sync_recovery"
    }

    fn check<'a>(
        &'a self,
        _tracker: &'a ProgressTracker<ed25519::PublicKey>,
        states: &'a [&'a MockValidatorState<V>],
    ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'a>> {
        Box::pin(async move {
            let mut observed = Vec::new();
            for state in states {
                let processed_height = state.processed_height().await;
                observed.push(format!(
                    "entries={} sync_height={:?} processed_height={processed_height}",
                    state.state_sync_entries(),
                    state.state_sync_height(),
                ));

                let Some(sync_height) = state.state_sync_height() else {
                    continue;
                };
                if state.state_sync_entries() < 2 {
                    continue;
                }
                if processed_height > sync_height {
                    return Ok(());
                }
            }

            Err(
                format!(
                    "no validator re-entered state sync after a crash and then advanced beyond the synced height; observed [{}]",
                    observed.join(", "),
                ),
            )
        })
    }
}