From adcf05953e41e1c8784631a4303f047a6df96f54 Mon Sep 17 00:00:00 2001 From: status-im-auto Date: Mon, 28 Aug 2023 05:36:29 +0000 Subject: [PATCH] Update documentation --- spec/16/index.html | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/spec/16/index.html b/spec/16/index.html index 0fcb96bf..56fb47bb 100644 --- a/spec/16/index.html +++ b/spec/16/index.html @@ -488,7 +488,7 @@ the retrieved version string MAY contain the git commit hash alone or in combina Relay API # -

Refer to the Waku Relay specification for more information on the relaying of messages.

+

Refer to the Waku Relay specification for more information on the relaying of messages.

post_waku_v2_relay_v1_message # @@ -635,7 +635,7 @@ the retrieved version string MAY contain the git commit hash alone or in combina Relay Private API #

-

The Private API provides functionality to encrypt/decrypt WakuMessage payloads using either symmetric or asymmetric cryptography. This allows backwards compatibility with Waku v1 nodes. +

The Private API provides functionality to encrypt/decrypt WakuMessage payloads using either symmetric or asymmetric cryptography. This allows backwards compatibility with Waku v1 nodes. It is the API client’s responsibility to keep track of the keys used for encrypted communication. Since keys must be cached by the client and provided to the node to encrypt/decrypt payloads, a Private API SHOULD NOT be exposed on non-local or untrusted nodes.

Types @@ -703,7 +703,7 @@ It is the API client’s responsibility to keep track of the keys used for e #

post_waku_v2_private_v1_symmetric_message @@ -879,7 +879,7 @@ It is the API client’s responsibility to keep track of the keys used for e #

Store API @@ -943,9 +943,9 @@ It is the API client’s responsibility to keep track of the keys used for e cursor -Index +Index optional -Message Index from which to perform pagination. If not included and forward is set to true, paging will be performed from the beginning of the list. If not included and forward is set to false, paging will be performed from the end of the list. +Message Index from which to perform pagination. If not included and forward is set to true, paging will be performed from the beginning of the list. If not included and forward is set to false, paging will be performed from the end of the list. forward @@ -974,13 +974,13 @@ It is the API client’s responsibility to keep track of the keys used for e digest String mandatory -A hash for the message at this Index +A hash for the message at this Index receivedTime Number mandatory -UNIX timestamp in nanoseconds at which the message at this Index was received +UNIX timestamp in nanoseconds at which the message at this Index was received @@ -1011,7 +1011,7 @@ It is the API client’s responsibility to keep track of the keys used for e get_waku_v2_store_v1_messages #

-

The get_waku_v2_store_v1_messages method retrieves historical messages on specific content topics. This method MAY be called with PagingOptions, to retrieve historical messages on a per-page basis. If the request included PagingOptions, the node MUST return messages on a per-page basis and include PagingOptions in the response. These PagingOptions MUST contain a cursor pointing to the Index from which a new page can be requested.

+

The get_waku_v2_store_v1_messages method retrieves historical messages on specific content topics. This method MAY be called with PagingOptions, to retrieve historical messages on a per-page basis. If the request included PagingOptions, the node MUST return messages on a per-page basis and include PagingOptions in the response. These PagingOptions MUST contain a cursor pointing to the Index from which a new page can be requested.

Parameters # @@ -1042,13 +1042,13 @@ It is the API client’s responsibility to keep track of the keys used for e startTime Number optional -The inclusive lower bound on the timestamp of queried WakuMessages. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. +The inclusive lower bound on the timestamp of queried WakuMessages. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. endTime Number optional -The inclusive upper bound on the timestamp of queried WakuMessages. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. +The inclusive upper bound on the timestamp of queried WakuMessages. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. pagingOptions @@ -1069,7 +1069,7 @@ It is the API client’s responsibility to keep track of the keys used for e Filter API #

-

Refer to the Waku Filter specification for more information on content filtering.

+

Refer to the Waku Filter specification for more information on content filtering.

Types # @@ -1102,7 +1102,7 @@ It is the API client’s responsibility to keep track of the keys used for e post_waku_v2_filter_v1_subscription #

-

The post_waku_v2_filter_v1_subscription method creates a subscription in a light node for messages that matches a content filter and, optionally, a PubSub topic.

+

The post_waku_v2_filter_v1_subscription method creates a subscription in a light node for messages that matches a content filter and, optionally, a PubSub topic.

Parameters # @@ -1142,7 +1142,7 @@ It is the API client’s responsibility to keep track of the keys used for e delete_waku_v2_filter_v1_subscription #

-

The delete_waku_v2_filter_v1_subscription method removes subscriptions in a light node matching a content filter and, optionally, a PubSub topic.

+

The delete_waku_v2_filter_v1_subscription method removes subscriptions in a light node matching a content filter and, optionally, a PubSub topic.

Parameters # @@ -1272,7 +1272,7 @@ It is the API client’s responsibility to keep track of the keys used for e #

post_waku_v2_admin_v1_peers @@ -1486,7 +1486,7 @@ It is the API client’s responsibility to keep track of the keys used for e
  • JSON-RPC specification
  • LibP2P Addressing
  • LibP2P PubSub specification - topic descriptor
    • -
  • Waku v2 specification
    • +
  • Waku v2 specification
  • IETF RFC 4648 - The Base16, Base32, and Base64 Data Encodings