commonware-sync 2026.5.0

Synchronize state between a server and client.
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

//! Synchronize state between a server and client.
//!
//! This example shows how to synchronize a client database to a remote server's database
//! using either full operation replay or compact state transfer. Full sync uses
//! [commonware_storage::qmdb::any], [commonware_storage::qmdb::current],
//! [commonware_storage::qmdb::immutable], or [commonware_storage::qmdb::keyless]. Compact sync
//! demonstrates the compact-storage variants of
//! [commonware_storage::qmdb::immutable] and [commonware_storage::qmdb::keyless].
//! The CLI selects the logical database family with `--family`; in compact mode, only the server
//! chooses backing storage with `--storage`.
//!
//! It includes network protocols, database configuration, and utilities for creating test data.

#![doc(
    html_logo_url = "https://commonware.xyz/imgs/rustdoc_logo.svg",
    html_favicon_url = "https://commonware.xyz/favicon.ico"
)]

pub mod error;
pub use error::Error;
pub mod databases;
pub mod net;
pub use databases::{any, current, immutable, immutable_compact, keyless, keyless_compact};

/// Returns the version of the crate.
pub const fn crate_version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

/// Hasher type used in the database.
pub type Hasher = commonware_cryptography::sha256::Sha256;

/// Digest type used in the database.
pub type Digest = commonware_cryptography::sha256::Digest;

/// Key type used in the database.
pub type Key = commonware_cryptography::sha256::Digest;

/// Value type used in the database.
pub type Value = commonware_cryptography::sha256::Digest;

/// Translator type for the database.
pub type Translator = commonware_storage::translator::EightCap;