Merge pull request #1572 from zancas/update_sync_docs

document sync definitions
zingolabs · Dec 11, 2024 · c0de3b8 · c0de3b8
2 parents 4dfdb7f + b9df5d9
commit c0de3b8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/zingo-sync/src/lib.rs b/zingo-sync/src/lib.rs
@@ -1,6 +1,12 @@
 #![warn(missing_docs)]
 //! Zingo sync engine prototype
 //!
+//! Definitions, Subordinate to the [Zcash Protocol Specification](<https://zips.z.cash/protocol/protocol-dark.pdf#blockchain>):
+//!  - Sync: Observation of a consensus state
+//!  - Consensus State:  Eventually consistent global agreement
+//!  - Key-Enabled (keyed): Sync where the observer owns keys that reveal hidden information
+//!  - Explore (not yet supported): sync of public data
+//!
 //! Entrypoint: [`crate::sync::sync`]
 //!
 //! Terminology: