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
//! WaveKV - An embeddable, eventually consistent, distributed key-value store
//!
//! WaveKV is a Rust library that provides a log-driven, eventually consistent,
//! in-memory distributed key-value store core. It focuses on simplicity over completeness.
//!
//! # Key Features
//!
//! - **Peer-to-peer architecture**: All nodes have equal roles with no leader or coordinator
//! - **No minimum cluster size**: Works with any number of nodes (even just one)
//! - **Last-write-wins conflict resolution**: Simple and deterministic conflict resolution
//! - **Eventually consistent**: Log-driven replication ensures convergence
//! - **Embeddable**: Designed to be embedded into your Rust programs
//! - **Transport-agnostic**: Core only - you provide the network layer
//! - **In-memory**: Best suited for small to medium datasets that fit in RAM
//!
//! # Quick Start
//!
//! ```rust
//! use wavekv::Node;
//!
//! // Create a node with ID 1, knowing about peer 2
//! let node = Node::new(1, vec![2]);
//!
//! // Put and get values
//! let mut state = node.write();
//! state.put("key".to_string(), b"value".to_vec()).unwrap();
//! let entry = state.get("key").unwrap();
//! assert_eq!(entry.value.as_ref().unwrap(), b"value");
//! ```
//!
//! # Architecture
//!
//! WaveKV uses a log-driven architecture where every mutation becomes a `StateOp`
//! appended to a write-ahead log (WAL). Nodes exchange incremental logs and snapshots
//! to achieve eventual consistency.
//!
//! The core types you'll work with:
//! - [`Node`] - Thread-safe wrapper around node state
//! - [`types::Entry`] - A key-value entry with metadata
//! - [`types::PeerState`] - Tracks synchronization state for each peer
//! - [`sync::SyncManager`] - Handles synchronization between nodes
//!
//! # Non-goals
//!
//! WaveKV intentionally does NOT provide:
//! - Strong consistency or linearizability
//! - ACID transactions
//! - Authentication or access control
//! - Production-grade durability guarantees
//! - Network transport layer
//! - Support for large datasets (limited by available RAM)
//!
//! For more details, see the [README](https://github.com/Phala-Network/wavekv).
pub use Node;