Skip to main content

cll/
lib.rs

1//! `cll` -- Rust implementation of the Checkpointed Local Log (CLL)
2//! mechanism: a Merkle Mountain Range (MMR) over an append-only log, signed
3//! COSE checkpoints, per-record range proofs, and a witness-registration
4//! client.
5//!
6//! This crate is the Rust sibling of the `checkpointed-local-log` Python
7//! package (`cll` on PyPI) -- same repository, same conformance vectors
8//! (`mmr-conformance-vectors/`, `commitment-conformance-vectors/`). Rust
9//! and Python are two implementations of one spec; the vectors are the
10//! contract, not either implementation.
11//!
12//! Scope is deliberately narrow, matching this repo's Go/TypeScript ports:
13//! the checkpoint + MMR + storage substrate only -- append-only log
14//! indexing, the MMR with inclusion/consistency/range proofs, signed COSE
15//! checkpoints, and witness delivery. This crate carries no payload
16//! semantics of any kind and no ledger admission/revocation layer (that
17//! stays Python-only, by decision -- see the repo README); it defines
18//! nothing about how the entries it indexes are produced, interpreted, or
19//! governed.
20//!
21//! [`log`] holds the storage interfaces every CLL implementation shares (the
22//! entry log, checkpoint state and witness state of the repository's
23//! `docs/backend-contract.md`), their in-memory, JSONL, SQLite (feature
24//! `sqlite`) and MySQL (feature `mysql`) backends, and the conformance runner
25//! for any backend.
26//!
27//! [`runner`] and [`witness_delivery`] are the host-run loops over those
28//! interfaces, ports of the Go runners: [`runner::CheckpointRunner`] indexes
29//! entries and signs checkpoints on a cadence, and
30//! [`witness_delivery::DeliveryRunner`] delivers each checkpoint to its
31//! witnesses (over [`witness_delivery::HttpWitnessClient`] or any
32//! [`witness_delivery::Submitter`]) with bounded retry. The shared
33//! `runner-conformance-vectors/` pin their behavior.
34
35pub mod checkpoint;
36pub mod log;
37pub mod mmr;
38pub mod node_store;
39pub mod range_proof;
40pub mod runner;
41pub mod store;
42pub mod witness;
43pub mod witness_delivery;