mirror of
https://github.com/logos-messaging/nim-chat-poc.git
synced 2026-01-09 01:23:07 +00:00
Update readme
This commit is contained in:
parent
4596676d6b
commit
ea14260c90
30
README.md
30
README.md
@ -3,7 +3,28 @@
|
||||
This is a technical proof of consuming the [chat_proto](https://github.com/waku-org/chat_proto/tree/base_types?tab=readme-ov-file) in nim.
|
||||
|
||||
|
||||
## Message Flow
|
||||
This POC introduces the following Conversation Types:
|
||||
- Inbox : Asymmetric channel for receiving invites
|
||||
- PrivateV1: 1:1 private messaing with Forward Secrecy and Post compromise security
|
||||
|
||||
Messages are delivered over Waku
|
||||
|
||||
See [nim_chat_poc](./src/nim_chat_poc.nim) for a client side usage example.
|
||||
|
||||
|
||||
## Quick Start
|
||||
|
||||
```
|
||||
# Build Dependencies and link libraries
|
||||
nimble initialize
|
||||
|
||||
# Run the default binary
|
||||
nimble run
|
||||
```
|
||||
|
||||
## Details
|
||||
|
||||
### Message Flow
|
||||
|
||||
To establish a secure conversation, Saro and Raya need to:
|
||||
1. Exchange key material
|
||||
@ -44,16 +65,9 @@ sequenceDiagram
|
||||
C -->> S: Recv M2
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
|
||||
|
||||
```
|
||||
# Run the default binary
|
||||
nimble run
|
||||
```
|
||||
|
||||
|
||||
## Limitations
|
||||
|
||||
1. `.proto` files are included in this repo due to complications in importing nested packages using `?subdir=`. Once resolved there will be a single definition of protocol types.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user