refactor/messages (#177)

* Update waku-v2.md

* Update wordlist.txt

* Update waku-v2.md

* Update waku-v2.md

* Update waku-v2.md
This commit is contained in:
Dean Eigenmann 2020-09-09 11:57:28 +02:00 committed by GitHub
parent a391edf448
commit 2684cba31c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 21 deletions

View File

@ -1,6 +1,6 @@
--- ---
title: Waku title: Waku
version: 2.0.0-alpha3 version: 2.0.0-alpha4
status: Raw status: Raw
authors: Oskar Thorén <oskar@status.im> authors: Oskar Thorén <oskar@status.im>
--- ---
@ -76,8 +76,8 @@ interaction domains: (a) gossip domain (b) discovery domain (c) req/resp domain.
The current [protocol identifiers](https://docs.libp2p.io/concepts/protocols/) are: The current [protocol identifiers](https://docs.libp2p.io/concepts/protocols/) are:
1. `/vac/waku/relay/2.0.0-alpha2` 1. `/vac/waku/relay/2.0.0-alpha2`
2. `/vac/waku/store/2.0.0-alpha2` 2. `/vac/waku/store/2.0.0-alpha4`
3. `/vac/waku/filter/2.0.0-alpha2` 3. `/vac/waku/filter/2.0.0-alpha4`
TODO: Protocol identifiers are subject to change, e.g. for request-reply TODO: Protocol identifiers are subject to change, e.g. for request-reply
@ -177,21 +177,16 @@ offline.
### Historical message support ### Historical message support
**Protocol identifier***: `/vac/waku/store/2.0.0-alpha2` **Protocol identifier***: `/vac/waku/store/2.0.0-alpha4`
TODO To be elaborated on TODO To be elaborated on
#### Protobuf #### Protobuf
```protobuf ```protobuf
message RPC {
repeated HistoryQuery historyQuery = 1;
repeated HistoryResponse historyResponse = 2;
}
message HistoryQuery { message HistoryQuery {
string uuid = 1; string uuid = 1;
repeated string topic = 2; repeated string topics = 2;
} }
message HistoryResponse { message HistoryResponse {
@ -206,7 +201,7 @@ RPC call to query historical messages.
The `uuid` field MUST indicate current request UUID, it is used to identify the corresponding response. The `uuid` field MUST indicate current request UUID, it is used to identify the corresponding response.
The `topic` field MUST indicate the list of topics to query. The `topics` field MUST indicate the list of topics to query.
##### HistoryResponse ##### HistoryResponse
@ -219,7 +214,7 @@ The `messages` field MUST contain the messages found.
### Content filtering ### Content filtering
**Protocol identifier***: `/vac/waku/filter/2.0.0-alpha3` **Protocol identifier***: `/vac/waku/filter/2.0.0-alpha4`
Content filtering is a way to do [message-based Content filtering is a way to do [message-based
filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering). filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering).
@ -257,24 +252,18 @@ NOTE I would imagine this is implied from the contentFilter, especially as two n
```protobuf ```protobuf
message RPC {
repeated FilterRequest filterRequest = 1;
// space for optional FilterResponse
repeated MessagePush messagePush = 3;
}
message FilterRequest { message FilterRequest {
// space for optional request id // space for optional request id
repeated ContentFilter contentFilter = 2; repeated ContentFilter contentFilters = 2;
optional string topic = 3; optional string topic = 3;
message ContentFilter { message ContentFilter {
optional string contentTopic = 1; optional string contentTopics = 1;
} }
} }
message MessagePush { message MessagePush {
repeated Message message = 1; repeated Message messages = 1;
} }
``` ```

View File

@ -24,7 +24,9 @@ Changelog
COSS COSS
ContentFilter ContentFilter
contentFilter contentFilter
contentFilters
contentTopic contentTopic
contentTopics
CPU CPU
DAG DAG
DAGs DAGs