vacp2p/rfc
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc.git synced 2025-02-09 21:46:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Feature/waku v2 historical sketch (#165)

Browse Source 
* Waku v2: Add content filter for waku topics

This addresses https://github.com/vacp2p/specs/issues/156 and
https://github.com/vacp2p/specs/issues/160

* Fix spellcheck and indent

* More protobuf fmt

* Waku v2: Shape up historical API

Addresses https://github.com/vacp2p/specs/issues/164

Also spellcheck and protobuf formating

* Spellcheck

* Update specs/waku/waku-v2.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
This commit is contained in:
Oskar Thorén 2020-07-28 16:19:20 +08:00 committed by GitHub
parent fa035fa86b
commit 7fa0419f7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
specs/waku/waku-v2.md
View File

@ -116,6 +116,8 @@ message RPC {
repeated SubOpts subscriptions = 1; repeated SubOpts subscriptions = 1;
repeated Message publish = 2; repeated Message publish = 2;
repeated ContentFilter contentFilter = 3; repeated ContentFilter contentFilter = 3;
repeated HistoryQuery historyQuery = 4;
repeated HistoryResponse historyResponse = 5;
message SubOpts { message SubOpts {
optional bool subscribe = 1; optional bool subscribe = 1;
@ -136,6 +138,15 @@ message Message {
optional bytes key = 6; optional bytes key = 6;
optional string contentTopic = 7; optional string contentTopic = 7;
} }
message HistoryQuery {
// TODO Include time range, topic/contentTopic, limit, cursor, (request-id), etc
}
message HistoryResponse {
// TODO Include Messages, cursor, etc
}
``` ```
WakuSub does not currently use the `ControlMessage` defined in GossipSub. WakuSub does not currently use the `ControlMessage` defined in GossipSub.
@ -148,6 +159,8 @@ However, later versions will add likely add this capability.
These are messages sent to directly connected peers. They SHOULD NOT be These are messages sent to directly connected peers. They SHOULD NOT be
gossiped. See section below on how the fields work. gossiped. See section below on how the fields work.
TODO Give brief summary of each type here
### Message ### Message
The `from` field MAY indicate which peer is publishing the message. The `from` field MAY indicate which peer is publishing the message.
@ -193,9 +206,31 @@ currently planned but underspecified.
### Historical message support ### Historical message support
TODO(Dean): Fill out this section with historical message API. Content filter is a way to do [message-based
filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering).
Currently the only content filter being applied is on `contentTopic`. This
corresponds to topics in Waku v1.
- Add issue for this in specs repository A node that only sets this field but doesn't subscribe to any topic SHOULD only
get notified when the content subtopic matches. A content subtopic matches when
a message `contentTopic` is the same. This means such a node acts as a light node.
A node that receives this RPC SHOULD apply this content filter before relaying.
Since such a node is doing extra work for a light node, it MAY also account for
usage and be selective in how much service it provides. This mechanism is
currently planned but underspecified.
### HistoryQuery
RPC call to query historical messages.
TODO To be specified in more detail
### HistoryResponse
RPC call to respond to a HistoryQuery call.
TODO To be specified in more detail
## Changelog ## Changelog

4
wordlist.txt
View File

@ -53,6 +53,10 @@ github
GossipSub GossipSub
growable growable
hasherror hasherror
historyQuery
HistoryQuery
historyResponse
HistoryResponse
html html
http http
https https