From 32342faade360636fdb98267cc02718241ff49d1 Mon Sep 17 00:00:00 2001 From: status-im-auto Date: Wed, 4 Oct 2023 10:19:44 +0000 Subject: [PATCH] Update documentation --- 404.html | 2 +- categories/index.html | 2 +- docs/index.html | 2 +- ...7cb37f06ef80e49b4513d7667cbe976941bee89.js | 5 +- ...dc77c41772af9a0cc8f61944eb9dd61879c1936.js | 2 +- index.html | 2 +- spec/1/index.html | 2 +- spec/10/index.html | 2 +- spec/11/index.html | 2 +- spec/12/index.html | 333 ++++++++++++------ 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 | 2 +- spec/56/index.html | 2 +- spec/57/index.html | 2 +- spec/58/index.html | 2 +- spec/6/index.html | 2 +- spec/61/index.html | 2 +- spec/63/index.html | 2 +- spec/64/index.html | 20 +- spec/66/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 | 2 +- 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 +- 73 files changed, 306 insertions(+), 192 deletions(-) rename en.search-data.min.5258b7d2f249dc128cabb637df78aa763e19b382701beff8b20487a931f82608.js => en.search-data.min.607eb262fae69d52ea0d81b577cb37f06ef80e49b4513d7667cbe976941bee89.js (99%) rename en.search.min.25e86c123ea496f3f432cb3ff3ae6cd881c6ce8e3db5f383b09ed8668477e2fa.js => en.search.min.2f23f3fa7bbb71fcf9c621b07dc77c41772af9a0cc8f61944eb9dd61879c1936.js (89%) diff --git a/404.html b/404.html index 0ce125034..f39ec168a 100644 --- a/404.html +++ b/404.html @@ -14,7 +14,7 @@ - + +

Anonymous filter subscription: This feature guarantees that nodes can anonymously subscribe for a message filter (i.e., without revealing their exact content filter). As such, no adversary in the WakuFilter protocol would be able to link nodes to their subscribed content filers. The current version of the WakuFilter protocol does not provide anonymity as the subscribing node has a direct connection to the full node and explicitly submits its content filter to be notified about the matching messages. However, one can consider preserving anonymity through one of the following ways:

+ +

+ Changelog + # +

+

+ Next + #

-

In return to any FilterSubscribeRequest, -a filter service node SHOULD respond with a FilterSubscribeResponse with a requestId matching that of the request. -This response MUST contain a status_code indicating if the request was successful or not. -Successful status codes are in the 2xx range. -Client nodes SHOULD consider all other status codes as error codes and assume that the requested operation had failed. -In addition, the filter service node MAY choose to provide a more detailed status description in the status_desc field.

-

- Filter matching - # + +

+ 2.0.0-beta2 + #

-

In the description of each request type below, -the term “filter criteria” refers to the combination of pubsub_topic and a set of content_topics. -The request MAY include filter criteria, conditional to the selected filter_subscribe_type. -If the request contains filter criteria, -it MUST contain a pubsub_topic -and the content_topics set MUST NOT be empty. -A WakuMessage matches filter criteria when its content_topic is in the content_topics set -and it was published on a matching pubsub_topic.

-

- Filter Subscribe Types - # +

Initial draft version. Released 2020-10-28

+ +

+ 2.0.0-beta1 + #

-

The following filter subscribe types are defined:

-

- SUBSCRIBER_PING - # -

-

A filter client that sends a FilterSubscribeRequest with filter_subscribe_type set to SUBSCRIBER_PING -requests that the service node SHOULD indicate if it has any active subscriptions for this client. -The filter client SHOULD exclude any filter criteria from the request. -The filter service node SHOULD respond with a success code if it has any active subscriptions for this client -or an error code if not. -The filter service node SHOULD ignore any filter criteria in the request.

-

- SUBSCRIBE - # -

-

A filter client that sends a FilterSubscribeRequest with filter_subscribe_type set to SUBSCRIBE -requests that the service node SHOULD push messages matching this filter to the client. -The filter client MUST include the desired filter criteria in the request. -A client MAY use this request type to modify an existing subscription +

Initial draft version. Released 2020-10-05

+

+ Copyright + # +

+

Copyright and related rights waived via +CC0.

+

+ References + # +

+
    +
  1. +

    Message Filtering (Wikipedia)

    +
    2. +
  2. +

    Libp2p PubSub spec - topic validation

    +
    3. +
+ + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +t MAY use this request type to modify an existing subscription by providing additional filter criteria in a new request. A client MAY use this request type to refresh an existing subscription by providing the same filter criteria in a new request. diff --git a/spec/13/index.html b/spec/13/index.html index e4509af9a..4090a2ea1 100644 --- a/spec/13/index.html +++ b/spec/13/index.html @@ -21,7 +21,7 @@ - +