diff --git a/specs/waku/v2/waku-store.md b/specs/waku/v2/waku-store.md index 14449eef..f09d2f6f 100644 --- a/specs/waku/v2/waku-store.md +++ b/specs/waku/v2/waku-store.md @@ -1,7 +1,7 @@ --- title: Waku -version: 2.0.0-alpha6 -status: Raw +version: 2.0.0-beta1 +status: Draft authors: Oskar Thorén , Dean Eigenmann --- @@ -10,13 +10,14 @@ authors: Oskar Thorén , Dean Eigenmann - [Abstract](#abstract) - [Wire Specification](#wire-specification) * [Protobuf](#protobuf) +- [Changelog](#changelog) - [Copyright](#copyright) # Abstract `WakuStore` is a protocol to enable querying of messages received through relay protocol and stored by other nodes. -**Protocol identifier***: `/vac/waku/store/2.0.0-alpha6` +**Protocol identifier***: `/vac/waku/store/2.0.0-beta1` # Wire Specification @@ -43,26 +44,27 @@ message HistoryRPC { ##### HistoryRPC A node MUST send all History messages (`HistoryQuery`, `HistoryResponse`) wrapped inside a -`HistoryRPC`. This allows the node handler to determine how to handle a message as the Waku -Filter protocol is not a request response based protocol but instead a push based system. +`HistoryRPC`. -The `request_id` MUST be a uniquely generated string. +The `request_id` MUST be a uniquely generated string, the `HistoryResponse` and `HistoryQuery` `request_id` MUST match. The `HistoryResponse` message SHOULD contain any messages found +whose `topic` can be found in the `HistoryQuery` `topics` array. Any message whose `topic` does not match MUST NOT be included. ##### HistoryQuery RPC call to query historical messages. -The `uuid` field MUST indicate current request UUID, it is used to identify the corresponding response. - The `topics` field MUST indicate the list of topics to query. ##### HistoryResponse RPC call to respond to a HistoryQuery call. -The `uuid` field MUST indicate which query is being responded to. +The `messages` field MUST contain the messages found, these are [`WakuMessage`] types as defined in the corresponding [specification](./waku-message.md). -The `messages` field MUST contain the messages found. +# Changelog + +2.0.0-beta1 +Initial draft version. Released 2020-10-05 # Copyright diff --git a/specs/waku/v2/waku-v2.md b/specs/waku/v2/waku-v2.md index 20e611d1..16e1cf38 100644 --- a/specs/waku/v2/waku-v2.md +++ b/specs/waku/v2/waku-v2.md @@ -95,9 +95,9 @@ This consists of two main protocols. They are used in order to get Waku to run in resource restricted environments, such as low bandwidth or being mostly offline. -### Historical message support (experimental, alpha) +### Historical message support -**Protocol identifier***: `/vac/waku/store/2.0.0-alpha5` +**Protocol identifier***: `/vac/waku/store/2.0.0-beta1` See [WakuStore](waku-store.md) spec for more details.