de-mls 3.0.0

Decentralized MLS — end-to-end encrypted group messaging with consensus-based membership management over gossipsub-like networks
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

//! Reusable core for building DE-MLS chat applications.
//!
//! Wraps MLS cryptography, consensus voting, and message routing. Transport,
//! UI, and state management live in the app layer.
//!
//! Integrators implement `SessionEvent` / `ConversationLifecycle` (transport
//! + UI delivery) and feed inbound packets to [`crate::core::process_inbound`],
//! then dispatch the returned [`crate::core::ProcessResult`].
//! [`crate::defaults::DefaultConsensusPlugin`] bundles in-memory backends for tests
//! and simple deployments.
//!
//! Submodules: `conversation` (per-conversation state, handle, state machine,
//! config), `consensus` (pure consensus result application),
//! `consensus_plugin` ([`crate::core::ConsensusPlugin`] +
//! [`crate::defaults::DefaultConsensusPlugin`]), `conversation_plugins`
//! ([`crate::core::ConversationPluginsFactory`] — the per-conversation
//! plug-in factory bundle), `events` (`SessionEvent` /
//! `ConversationLifecycle`), `freeze` (round selection + apply),
//! `inbound` (app-subtopic packet routing), `peer_scoring`
//! (scoring plug-in contract), `process_result`
//! ([`crate::core::ProcessResult`]), `proposal_framing` (welcome-subtopic
//! + consensus-library framing helpers), `proposal_kind`
//! ([`crate::core::ProposalKind`] classifier), `steward_list`
//! (steward-list plug-in).

mod consensus;
mod consensus_plugin;
mod conversation;
mod conversation_plugins;
mod error;
mod events;
mod freeze;
mod inbound;
mod peer_scoring;
mod process_result;
mod proposal_framing;
mod proposal_kind;
mod steward_list;

// ── Core conversation operations ──
pub use freeze::{
    CommitHash, FreezeFinalizeResult, FreezeOutcome, compute_commit_hash, finalize_freeze_round,
};
pub use inbound::process_inbound;
pub use proposal_framing::build_key_package_message;

// ── Per-conversation types: state, handle, state machine, config ──
pub use conversation::{
    BufferedCommitCandidate, Conversation, ConversationConfig, ConversationHandle,
    ConversationState, ConversationStateMachine, DEFAULT_COMMIT_INACTIVITY_DURATION,
    DEFAULT_CONSENSUS_TIMEOUT, DEFAULT_ELECTION_VOTING_DELAY, DEFAULT_LIVENESS_CRITERIA_YES,
    DEFAULT_PENDING_UPDATE_MAX_EPOCHS, DEFAULT_PROPOSAL_EXPIRATION,
    DEFAULT_RECOVERY_INACTIVITY_DURATION, DEFAULT_VOTING_DELAY, FreezeBufferOutcome, OperatingMode,
    PendingUpdate, ProposalId, member_set, self_leave_proposal_id, target_identity_of,
};

// ── Consensus result application (pure, synchronous) ──
pub use consensus::{ConsensusApplyResult, apply_consensus_result};
pub use peer_scoring::{
    DEFAULT_PEER_SCORE, DEFAULT_THRESHOLD_PEER_SCORE, PeerScoreStorage, PeerScoringEvent,
    PeerScoringPlugin, PeerScoringService, ScoreEvent, ScoreOp, ScoreSnapshot, ScoringConfig,
    ScoringMemberDiff, default_score_deltas, emergency_score_ops, scoring_member_diff,
};

// ── Error type ──
pub use error::CoreError;

// ── Session-event types ──
pub use events::{ConversationLifecycle, SessionEvent};

// ── Proposal classification ──
pub use proposal_kind::ProposalKind;

// ── Steward list ──
pub use steward_list::{
    DEFAULT_MAX_RETRIES, DeterministicStewardList, ElectionDecision, StewardList,
    StewardListConfig, StewardListEvent, StewardListPlugin,
};

// ── Consensus plug-in trait ──
pub use consensus_plugin::{ConsensusPlugin, PluginConsensus};

// ── Per-conversation plug-in bundle ──
pub use conversation_plugins::ConversationPluginsFactory;

// ── Process results ──
pub use process_result::{NoopReason, ProcessResult};