cwtch.im
/
secure-development-handbook
3
0
Fork 1
Code Issues 1 Pull Requests Releases Wiki Activity

Update 'src/overlays.md'

This commit is contained in:
kngako 2021-06-25 15:29:25 -07:00
parent 4e4b04c48d
commit 749cf21c51
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/overlays.md
View File

@ -1,5 +1,5 @@
# Message Overlays
<!-- Oh, great. Can this be earlier in the handbook? Like section 2. early? -->
[Adapted from: Discreet Log #8: Notes on the Cwtch Chat API](https://openprivacy.ca/discreet-log/08-chatapi/)
We envision Cwtch as a platform for providing an authenticated transport layer to higher-level applications.
@ -17,9 +17,7 @@ And because serialised JSON objects are just dictionaries, we can easily add mor
## Chat overlays, lists, and bulletins
The original Cwtch alpha demoed "overlays": different ways of interpreting the same data channel,
depending on the structure of the atomic data itself. W
e included simple checklists and BBS/classified ads as overlays that could be viewed
depending on the structure of the atomic data itself. We included simple checklists and BBS/classified ads as overlays that could be viewed
and shared with any Cwtch contact, be it a single peer or a group. The wire format looked like this:
```
@ -64,6 +62,11 @@ Where O stands for `Overlay` with the current supported overlays documented belo
The most simple over is a chat message which simply contains raw, unprocessed chat message information.
```
{o:1,d:"got milk?"}
```
<!-- I was told there would unique identifiers and signatures? -->
## Invitations (Overlays 100 and 101)
Instead of receiving the invite as an incoming contact request at the profile level, new inline invites are shared with a particular contact/group, where they can be viewed and/or accepted later, even if they were initially rejected (potentially by accident).
@ -76,3 +79,5 @@ The wire format for these are equally simple:
```
This represents a departure from our original "overlays" thinking to a more action-oriented representation. The chat "overlay" can communicate that someone *did* something, even if it's paraphrased down to "added an item to a list," and the lists and bulletins and other beautifully chaotic data can have their state precomputed and stored separately.
<!-- What are lists or bulletin boards? -->