commonware-storage 2026.4.0

Persist and retrieve data from an abstract store.
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

//! Re-exports of the generic verification module, specialized for the MMR [Family].

use crate::merkle::{
    hasher::Hasher,
    mmr::{Error, Family, Location, Proof},
    storage::Storage,
};
use commonware_cryptography::Digest;
use core::ops::Range;

/// MMR-specialized [ProofStore](crate::merkle::verification::ProofStore).
pub type ProofStore<D> = crate::merkle::verification::ProofStore<Family, D>;

/// Return a range proof for the nodes corresponding to the given location range.
///
/// This is a thin wrapper around the generic
/// [range_proof](crate::merkle::verification::range_proof), specialized for the MMR family.
pub async fn range_proof<
    D: Digest,
    H: Hasher<Family, Digest = D>,
    S: Storage<Family, Digest = D>,
>(
    hasher: &H,
    mmr: &S,
    range: Range<Location>,
) -> Result<Proof<D>, Error> {
    crate::merkle::verification::range_proof(hasher, mmr, range).await
}

/// Analogous to [range_proof] but for a previous database state.
///
/// This is a thin wrapper around the generic
/// [historical_range_proof](crate::merkle::verification::historical_range_proof), specialized for
/// the MMR family.
pub async fn historical_range_proof<
    D: Digest,
    H: Hasher<Family, Digest = D>,
    S: Storage<Family, Digest = D>,
>(
    hasher: &H,
    mmr: &S,
    leaves: Location,
    range: Range<Location>,
) -> Result<Proof<D>, Error> {
    crate::merkle::verification::historical_range_proof(hasher, mmr, leaves, range).await
}

/// Return an inclusion proof for the elements at the specified locations.
///
/// This is a thin wrapper around the generic
/// [multi_proof](crate::merkle::verification::multi_proof), specialized for the MMR family.
pub async fn multi_proof<D: Digest, S: Storage<Family, Digest = D>>(
    mmr: &S,
    locations: &[Location],
) -> Result<Proof<D>, Error> {
    crate::merkle::verification::multi_proof(mmr, locations).await
}