commonware-bridge 2026.9.0

Send succinct consensus certificates between two networks.
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

//! This crate contains all logic typically implemented by an application developer.
//! This includes things like how to produce/verify blocks and how to identify which
//! participants are active at a given view.

use crate::Scheme;
use commonware_cryptography::Hasher;
use std::num::NonZeroUsize;

mod actor;
pub use actor::Application;
use commonware_runtime::{Sink, Stream};
use commonware_stream::encrypted::{Receiver, Sender};
mod ingress;

/// Genesis message to use during initialization.
const GENESIS: &[u8] = b"commonware is neat";

/// Returns the initial payload for the single consensus epoch.
pub fn genesis<H: Hasher>() -> H::Digest {
    // Use the digest of the genesis message as the initial payload.
    H::hash(&[GENESIS])
}

/// Configuration for the application.
pub struct Config<Si: Sink, St: Stream> {
    pub indexer: (Sender<Si>, Receiver<St>),

    /// Signing scheme for this network.
    pub this_network: Scheme,

    /// Certificate verifier for the other network.
    pub other_network: Scheme,

    /// Number of messages from consensus to hold in our backlog
    /// before blocking.
    pub mailbox_size: NonZeroUsize,
}