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
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

//! Compact immutable database types and helpers for compact sync demonstration.

use crate::{Hasher, Key, Value};
use commonware_parallel::Sequential;
use commonware_runtime::{BufferPooler, Clock, Metrics, Storage};
use commonware_storage::{
    merkle::{
        compact::Config as MerkleConfig,
        mmr::{self},
    },
    qmdb::{
        self,
        immutable::fixed::{self, CompactConfig},
        sync::compact,
    },
};
use tracing::error;

/// Database type alias.
pub type Database<E> = fixed::CompactDb<mmr::Family, E, Key, Value, Hasher, Sequential>;

/// Operation type alias.
pub type Operation = fixed::Operation<mmr::Family, Key, Value>;

/// Create a database configuration for the compact immutable variant.
pub fn create_config(_context: &impl BufferPooler) -> CompactConfig<Sequential> {
    CompactConfig {
        merkle: MerkleConfig {
            partition: "compact-immutable".into(),
            strategy: Sequential,
        },
        commit_codec_config: (),
    }
}

impl<E> super::ExampleDatabase for Database<E>
where
    E: Storage + Clock + Metrics,
{
    type Family = mmr::Family;
    type Operation = Operation;

    fn create_test_operations(count: usize, seed: u64, starting_loc: u64) -> Vec<Self::Operation> {
        super::immutable::create_test_operations(count, seed, starting_loc)
    }

    async fn add_operations(
        &mut self,
        operations: Vec<Self::Operation>,
    ) -> Result<(), qmdb::Error<mmr::Family>> {
        let Some(last) = operations.last() else {
            error!("operations must end with a commit");
            return Ok(());
        };
        if !matches!(last, Operation::Commit(..)) {
            error!("operations must end with a commit");
            return Ok(());
        }

        let mut batch = self.new_batch();
        for operation in operations {
            match operation {
                Operation::Set(key, value) => {
                    batch = batch.set(key, value);
                }
                Operation::Commit(metadata, floor) => {
                    let merkleized = batch.merkleize(self, metadata, floor);
                    self.apply_batch(merkleized)?;
                    self.commit().await?;
                    batch = self.new_batch();
                }
            }
        }
        Ok(())
    }

    fn current_floor(&self) -> u64 {
        *Self::inactivity_floor_loc(self)
    }

    fn root(&self) -> Key {
        Self::root(self)
    }

    fn name() -> &'static str {
        "compact immutable"
    }
}

impl<E> super::CompactSyncable for Database<E>
where
    E: Storage + Clock + Metrics,
{
    async fn current_target(&self) -> compact::Target<Self::Family, Key> {
        Self::current_target(self)
    }
}