From c0878e21baecc3eb2210893bc211d82dd22c51fd Mon Sep 17 00:00:00 2001 From: Leo dev Date: Sat, 4 Oct 2025 11:02:57 +0200 Subject: [PATCH] Readme --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index aa3c9e6..c1c35dc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # voxa-node + The server for the DM and notification system of Voxa + +### What is a Voxa Node? + +A voxa node is a server that handles DMs sent to you and push message notifications, a client will keep a constant connection with their chosen node and when a sender wants to send a DM or a message notification they can make a HTTP request to the same port, it's important to note that a node server only handles the receiving side, unless both parties are in the same node. + +A analogy to a node is a email server but real time. + +### What will a Voxa Node store? + +A voxa node stores messages that are sent to you, additionally push notifications and after 3 days of inactivity notifications will be removed. + +### Why Voxa Nodes over traditional PM/DM structure + +Traditional structures often are a privacy threat even with End-To-End encryption, additionally they are very resource intensive which in my situation is necessary to reduce as much as possible. +Another big issue with the traditional single server structure is that it may apply censorship, our biggest enemy. + +```mermaid +sequenceDiagram + participant Bob + participant AuthServer as Alice's Node (3rd Party Server) + participant Alice + participant Cloud as Voxa Cloud + + Bob->>Bob: Hash message (SHA-256) + Bob->>Bob: Sign hash with Private Key + Bob->>AuthServer: Send {message, signature} + + AuthServer->>Alice: Relay {message, signature} + + Alice->>Cloud: Request Bob's Public Key + Cloud-->>Alice: Return Bob's Public Key + + Alice->>Alice: Verify signature using Public Key
and recompute SHA-256(message) + + Alice-->>Alice: Accept message if signature is valid +```