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

//! I/O contract between the protocol layer and an integrator.
//!
//! Two channels:
//!
//! - [`SessionEvent`] — fire-and-forget notifications about a single
//!   conversation. Each [`crate::app::SessionRunner`] owns a broadcast sender;
//!   integrators subscribe per session.
//! - [`ConversationLifecycle`] — User-level create/remove notifications.
//!   Integrators use this to discover new sessions and subscribe to them.
//!
//! Synchronous outbound transport is supplied by
//! [`crate::ds::DeliveryService`], passed to `User` at construction and
//! cloned into each session.

use hashgraph_like_consensus::types::ConsensusEvent;

use crate::{
    core::ConversationState,
    protos::de_mls::messages::v1::{AppMessage, ConversationUpdateRequest},
};

/// Per-conversation notification. Sessions append these to their pending
/// buffer; integrators drain via
/// [`crate::app::SessionRunner::drain_events`] once per polling cycle. All
/// variants are fire-and-forget — no failure path back to the session.
#[derive(Debug, Clone)]
pub enum SessionEvent {
    /// Decrypted application message (chat, vote request, proposal
    /// notification, ban request, …).
    AppMessage(AppMessage),

    /// Welcome processed and MLS state initialised. Epoch timers + state
    /// transitions are already wired — surface to UI only.
    Joined,

    /// The user is out of this conversation (self-leave commit merged, or
    /// someone else removed us). The session entry is about to be removed
    /// from `User`'s registry.
    Leaving,

    /// A background operation (e.g., vote submission) failed. UI may surface;
    /// state has already been reconciled.
    Error { operation: String, message: String },

    /// The local user just submitted `request` as a new proposal with the
    /// creator's vote bundled. UI should record for history; no "please vote"
    /// affordance.
    OwnProposalSubmitted {
        proposal_id: u32,
        request: ConversationUpdateRequest,
    },

    /// A freeze round merged a commit; `batch` is the set of approved
    /// proposals that landed in this commit (in insertion order).
    CommitApplied(Vec<ConversationUpdateRequest>),

    /// Conversation transitioned into `state`.
    PhaseChange(ConversationState),

    /// A consensus session reached an outcome. Fired after the runner has
    /// applied the result to local state.
    ProposalDecided(ConsensusEvent),
}

/// User-level conversation lifecycle event. Appended to [`crate::app::User`]'s
/// pending buffer; integrators drain via
/// [`crate::app::User::drain_lifecycle_events`] once per polling cycle and
/// use `Created` as the trigger to begin draining per-session
/// [`SessionEvent`]s.
#[derive(Debug, Clone)]
pub enum ConversationLifecycle {
    /// A new conversation entry has been registered. The session is in the
    /// registry; the integrator can look it up and `subscribe()` to its
    /// per-session events.
    Created(String),

    /// A conversation entry has been removed from the registry.
    Removed(String),
}