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

//! Property traits for simulation testing.

use super::tracker::ProgressTracker;
use commonware_cryptography::PublicKey;
use std::{future::Future, pin::Pin};

/// A property checked after each finalization.
///
/// Receives the inspectable states of all active (non-crashed) validators.
pub trait FinalizationProperty<S>: Send + Sync {
    /// Human-readable name for error reporting.
    fn name(&self) -> &str;

    /// Check the property. Returns `Err` with a description if violated.
    fn check<'a>(
        &'a self,
        states: &'a [&'a S],
    ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'a>>;
}

/// A property checked once at simulation end with access to both the
/// progress tracker and all validator states (inside the runtime,
/// before it shuts down).
pub trait Property<P: PublicKey, S>: Send + Sync {
    /// Human-readable name for error reporting.
    fn name(&self) -> &str;

    /// Check the property. Returns `Err` with a description if violated.
    fn check<'a>(
        &'a self,
        tracker: &'a ProgressTracker<P>,
        states: &'a [&'a S],
    ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'a>>;
}