Server Structure

README.md

@@ -1,22 +1,84 @@
-# Protocol
+## Keywords
 
-## DM structure
+- Voxa Client: The user-side app which communicates with all below.
+- Voxa Cloud: The authentication and user management handler.
+- Voxa Server: The self-host-able community/friends communication service.
+- Voxa Node: The self-host-able Private Message communication service, also used for sending notifications.
+
+## Node Structure
 
 The Direct-Message structure works like Email, but real-time and the node uses a temporary auth, a node is what stores messages that are sent by a user.
 
+This diagram shows that in order to send a message to a user, you must connect to their chosen node, which can be accessed via the Voxa Cloud and connected to directly.
+
+A node message can be a DM (Direct Message between two parties), or a SM (Server Message from a community).
+
 ```mermaid
 sequenceDiagram
     participant AliceClient as Alice's Client
-    participant AliceNode as Alice's Home Node (Node7)
     participant Voxa as Voxa Cloud
-    participant BobNode as Bob's Home Node (Node2)
+    participant BobNode as Bob's Selected Node (Node2)
     participant BobClient as Bob's Client
 
     AliceClient->>Voxa: Lookup Bob's node
     Voxa-->>AliceClient: Respond with Bob → Node2
-    AliceClient->>BobNode: Send DM to bob
+    AliceClient->>BobNode: Authenticate and Send DM to bob
     BobNode-->>AliceClient: Acknowledge message stored
     BobNode->>BobClient: Notify new message
     BobClient-->>BobNode: Acknowledge received
     BobNode-->>AliceClient: Acknowledge received
 ```
+
+## Server Structure
+
+Let's say Alice sends a message in `general`, this is how the server handles it
+
+```mermaid
+flowchart TD
+    A[...]
+    A --> B{Is Bob connected<br>to this server?}
+    B -- Yes --> C[Deliver directly<br>to Bob's client]
+    C --> D[Ack received]
+    B -- No --> E[Lookup Bob's selected node<br>via Voxa Cloud]
+    E --> F[Forward message<br>to Bob's node]
+    F --> G[Bob's node notifies<br>Bob's client]
+    G --> H[Ack flows back]
+```
+
+## Authentication handshake
+
+This sequence happens when you connect to a server or node.
+
+```mermaid
+sequenceDiagram
+    participant Alice as Alice's Client
+    participant Voxa as Voxa Cloud
+    participant Server as Node / Server
+
+    Alice->>Voxa: Register token for the (Node / Server)
+    Voxa-->>Alice: TOKEN
+    Alice->>Server: Authenticate with TOKEN
+    Server->>Voxa: Authenticate with TOKEN
+    Voxa-->>Server: The user is Alice
+    Server-->>Alice: You are Alice
+```
+
+### Edge cases:
+
+<details>
+<summary>The server doesn't send the user id (or the proper user ID) to the client</summary>
+
+1. The server is compromised / has evil intents
+2. The token is compromised / client has evil intents
+
+</details>
+
+<details>
+<summary>The client or server fail to handle the protocol or handshake</summary>
+
+1. The server is likely outdated and lacks maintenance
+2. The client is likely outdated and lacks maintenance
+
+</details>
+
+All of these edge cases don't have the fact written, but each edge case can be induced by a bug or 3rd party not necessarily implicating evil intents.