From c6c8abf10810bf252c17f72757c086ed02bef7ab Mon Sep 17 00:00:00 2001 From: status-im-auto Date: Mon, 17 Apr 2023 08:25:48 +0000 Subject: [PATCH] Update documentation --- 404.html | 2 +- categories/index.html | 2 +- docs/index.html | 2 +- docs/index.xml | 3 +- ...4c02e5a1a18120b6e3b2726d0d14a2853e4a8bd.js | 1847 ---------------- ...c544f711a902c5a5553f18ab5f5292cd7669c96.js | 1887 ---------------- ...81d35eb298793da42d51213b13f121ed4d5bbc9.js | 1845 ---------------- ...1bd866018f21a24d2998835d9159c738d1d2b08.js | 1888 ----------------- ...233161ef674cc7654eb6625280306c4cfa084b5.js | 22 +- ...cb9140dd4baa470a3068ee9a431a698e9fbbef9.js | 1874 ---------------- ...31337dad3c49720ac8c3a8c62f49e96c5b524bd.js | 2 +- ...382375653b0b362e9d81b1cb407fd7c16d6f19b.js | 1 - ...ebec1c35bd2d7cd417b7cd4534d2d6139ae3c7d.js | 1 - ...59f9a8989f3bccf4ea5b7e6aacd1b7a3383556d.js | 1 - ...acbf51cd25d01df2dd3381e81b0fc5fb8c0bff9.js | 1 - ...139ef90b532acee6745ecea9930b517a3a918cb.js | 1 - index.html | 2 +- index.xml | 3 +- spec/1/index.html | 2 +- spec/10/index.html | 2 +- spec/11/index.html | 2 +- spec/12/index.html | 2 +- spec/13/index.html | 2 +- spec/14/index.html | 2 +- spec/15/index.html | 2 +- spec/16/index.html | 2 +- spec/17/index.html | 2 +- spec/18/index.html | 2 +- spec/19/index.html | 2 +- spec/2/index.html | 2 +- spec/20/index.html | 2 +- spec/21/index.html | 2 +- spec/22/index.html | 2 +- spec/23/index.html | 2 +- spec/24/index.html | 2 +- spec/25/index.html | 2 +- spec/26/index.html | 2 +- spec/27/index.html | 2 +- spec/28/index.html | 2 +- spec/29/index.html | 2 +- spec/3/index.html | 2 +- spec/30/index.html | 2 +- spec/31/index.html | 2 +- spec/32/index.html | 2 +- spec/33/index.html | 2 +- spec/34/index.html | 2 +- spec/35/index.html | 2 +- spec/36/index.html | 2 +- spec/37/index.html | 2 +- spec/38/index.html | 2 +- spec/4/index.html | 2 +- spec/43/index.html | 2 +- spec/44/index.html | 2 +- spec/45/index.html | 2 +- spec/46/index.html | 2 +- spec/47/index.html | 2 +- spec/48/index.html | 2 +- spec/5/index.html | 2 +- spec/51/index.html | 2 +- spec/52/index.html | 2 +- spec/53/index.html | 2 +- spec/54/index.html | 2 +- spec/55/index.html | 166 +- spec/56/index.html | 2 +- spec/57/index.html | 2 +- spec/58/index.html | 2 +- spec/6/index.html | 2 +- spec/7/index.html | 2 +- spec/8/index.html | 2 +- spec/9/index.html | 2 +- spec/xx/index.html | 2 +- .../index.html | 2 +- tags/index.html | 2 +- tags/logos/consensus/index.html | 2 +- tags/rln/index.html | 2 +- tags/waku-application/index.html | 5 +- tags/waku-application/index.xml | 3 +- tags/waku-core-protocol/index.html | 2 +- tags/waku-core/index.html | 2 +- tags/waku/anonymity/index.html | 2 +- tags/waku/application/index.html | 2 +- tags/waku/core-protocol/index.html | 2 +- 82 files changed, 252 insertions(+), 9428 deletions(-) delete mode 100644 en.search-data.min.1deffbf8c4f797754715353d44c02e5a1a18120b6e3b2726d0d14a2853e4a8bd.js delete mode 100644 en.search-data.min.838df3ca8467335a52d41d9c4c544f711a902c5a5553f18ab5f5292cd7669c96.js delete mode 100644 en.search-data.min.8a1e308e05ef03c79e8c2f78a81d35eb298793da42d51213b13f121ed4d5bbc9.js delete mode 100644 en.search-data.min.bc54823b6ce1c543f43b92db71bd866018f21a24d2998835d9159c738d1d2b08.js rename en.search-data.min.5393046f46cb16675feae7d4bd34aece3e73ff79055f638a6c27d70c501eda59.js => en.search-data.min.d7c85814c4d610853796bb88e233161ef674cc7654eb6625280306c4cfa084b5.js (98%) delete mode 100644 en.search-data.min.fab26b254cf0f59aa8e791a5dcb9140dd4baa470a3068ee9a431a698e9fbbef9.js rename en.search.min.569030df97a7a363e516338e1e5dd6d506564a23c5dfc6dc2d8153374fccde46.js => en.search.min.6c850667c4402a32dafd5e17531337dad3c49720ac8c3a8c62f49e96c5b524bd.js (84%) delete mode 100644 en.search.min.b7648449ad6d8bd8c1a14cd82382375653b0b362e9d81b1cb407fd7c16d6f19b.js delete mode 100644 en.search.min.ce9c36a332abd597f8248f84debec1c35bd2d7cd417b7cd4534d2d6139ae3c7d.js delete mode 100644 en.search.min.d0db2715d1b3a9e7db2666f1159f9a8989f3bccf4ea5b7e6aacd1b7a3383556d.js delete mode 100644 en.search.min.d155bdcce811a62aabff33a71acbf51cd25d01df2dd3381e81b0fc5fb8c0bff9.js delete mode 100644 en.search.min.e92c2c7376311bebd222cda24139ef90b532acee6745ecea9930b517a3a918cb.js diff --git a/404.html b/404.html index ff5f018d..4e1e7cd0 100644 --- a/404.html +++ b/404.html @@ -14,7 +14,7 @@ - + +

Note that the definitions for ChatMessage and EmojiReaction can be found in chat_message.proto and emoji_reaction.proto.

+
+ Chat Created + # +
+

When creating a group chat, this is the first event that MUST be sent. +Any event with a clock value lower than this MUST be discarded. +Upon receiving this event a client MUST validate the chat_id provided with the update and create a chat with identified by chat_id.

+

By default, the creator of the group chat is the only group admin.

+
+ Name Changed + # +
+

To change the name of the group chat, group admins MUST use a NAME_CHANGED event. +Upon receiving this event a client MUST validate the chat_id provided with the updates and MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored. +If the event is valid the chat name SHOULD be changed according to the provided message.

+
+ Members Added + # +
+

To add members to the chat, group admins MUST use a MEMBERS_ADDED event. +Upon receiving this event a participant MUST validate the chat_id provided with the updates and MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored. +If the event is valid, a participant MUST update the list of members of the chat who have not joined, adding the members received.

+
+ Member Joined + # +
+

To signal the intent to start receiving messages from a given chat, new participants MUST use a MEMBER_JOINED event. +Upon receiving this event a participant MUST validate the chat_id provided with the updates. +If the event is valid a participant MUST add the new participant to the list of participants stored locally. +Any message sent to the group chat MUST now include the new participant.

+
+ Member Removed + # +
+

There are two ways in which a member MAY be removed from a group chat:

+ +

Each participant MUST validate the chat_id provided with the updates and MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored. +If the event is valid, a participant MUST update the local list of members accordingly.

+
+ Admins Added + # +
+

To promote participants to group admin, group admins MUST use an ADMINS_ADDED event. +Upon receiving this event, a participant MUST validate the chat_id provided with the updates, MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored. +If the event is valid, a participant MUST update the list of admins of the chat accordingly.

+
+ Admin Removed + # +
+

Group admins MUST NOT be able to remove other group admins. +An admin MAY remove themselves by sending an ADMIN_REMOVED event, with the members field containing their own public key. +Each participant MUST validate the chat_id provided with the updates and MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored. +If the event is valid, a participant MUST update the list of admins of the chat accordingly.

+
+ Color Changed + # +
+

To change the text color of the group chat name, group admins MUST use a COLOR_CHANGED event.

+
+ Image Changed + # +
+

To change the display image of the group chat, group admins MUST use an IMAGE_CHANGED event.

Security Considerations # @@ -322,6 +472,7 @@ It is handled by the key-exchange protocol used. For example,

  • 53/WAKU2-X3DH
  • 35/WAKU2-NOISE
  • 10/WAKU2
    • +
  • 7/GROUP-CHAT
    • @@ -367,6 +518,11 @@ It is handled by the key-exchange protocol used. For example,

  • Session management
    • +
  • Negotiation of a 1:1 chat amongst multiple participants (group chat) + +
    • diff --git a/spec/56/index.html b/spec/56/index.html index e9f10546..5ee9c872 100644 --- a/spec/56/index.html +++ b/spec/56/index.html @@ -21,7 +21,7 @@ Smaller group chats, on the other hand, are out of scope for this document and c - +