chore!: update store.proto

Ref: https://github.com/vacp2p/waku

Author: fryorcraken

packages/core/src/lib/store/history_rpc.ts

@@ -20,7 +20,7 @@ export interface Params {
 }
 
 export class HistoryRPC {
-  private constructor(public readonly proto: proto.HistoryRPC) {}
+  private constructor(public readonly proto: proto.HistoryRpc) {}
 
   get query(): proto.HistoryQuery | undefined {
     return this.proto.query;
@@ -59,7 +59,7 @@ export class HistoryRPC {
     return new HistoryRPC({
       requestId: uuid(),
       query: {
-        pubSubTopic: params.pubSubTopic,
+        pubsubTopic: params.pubSubTopic,
         contentFilters,
         pagingInfo,
         startTime,
@@ -70,12 +70,12 @@ export class HistoryRPC {
   }
 
   decode(bytes: Uint8ArrayList): HistoryRPC {
-    const res = proto.HistoryRPC.decode(bytes);
+    const res = proto.HistoryRpc.decode(bytes);
     return new HistoryRPC(res);
   }
 
   encode(): Uint8Array {
-    return proto.HistoryRPC.encode(this.proto);
+    return proto.HistoryRpc.encode(this.proto);
   }
 }
 
@@ -84,10 +84,10 @@ function directionToProto(
 ): proto.PagingInfo.Direction {
   switch (pageDirection) {
     case PageDirection.BACKWARD:
-      return proto.PagingInfo.Direction.DIRECTION_BACKWARD_UNSPECIFIED;
+      return proto.PagingInfo.Direction.BACKWARD;
     case PageDirection.FORWARD:
-      return proto.PagingInfo.Direction.DIRECTION_FORWARD;
+      return proto.PagingInfo.Direction.FORWARD;
     default:
-      return proto.PagingInfo.Direction.DIRECTION_BACKWARD_UNSPECIFIED;
+      return proto.PagingInfo.Direction.BACKWARD;
   }
 }

packages/core/src/lib/store/index.ts

@@ -6,7 +6,6 @@ import {
   Cursor,
   IDecodedMessage,
   IDecoder,
-  Index,
   IStore,
   ProtocolCreateOptions,
 } from "@waku/interfaces";
@@ -294,10 +293,7 @@ async function* paginate<T extends IDecodedMessage>(
 
     const response = reply.response as proto.HistoryResponse;
 
-    if (
-      response.error &&
-      response.error !== HistoryError.ERROR_NONE_UNSPECIFIED
-    ) {
+    if (response.error && response.error !== HistoryError.NONE) {
       throw "History response contains an Error: " + response.error;
     }
 
@@ -353,7 +349,7 @@ export function isDefined<T>(msg: T | undefined): msg is T {
 export async function createCursor(
   message: IDecodedMessage,
   pubsubTopic: string = DefaultPubSubTopic
-): Promise<Index> {
+): Promise<Cursor> {
   if (
     !message ||
     !message.timestamp ||
@@ -373,7 +369,7 @@ export async function createCursor(
     digest,
     pubsubTopic,
     senderTime: messageTime,
-    receivedTime: messageTime,
+    receiverTime: messageTime,
   };
 }
 

packages/interfaces/src/store.ts

@@ -11,19 +11,13 @@ export interface TimeFilter {
   endTime: Date;
 }
 
-export interface Index {
-  digest?: Uint8Array;
-  receivedTime?: bigint;
-  senderTime?: bigint;
-  pubsubTopic?: string;
+export interface Cursor {
+  digest: Uint8Array;
+  receiverTime: bigint;
+  senderTime: bigint;
+  pubsubTopic: string;
 }
 
-export type Cursor = {
-  digest?: Uint8Array;
-  senderTime?: bigint;
-  pubsubTopic?: string;
-};
-
 export type StoreQueryOptions = {
   /**
    * The direction in which pages are retrieved:
@@ -45,7 +39,8 @@ export type StoreQueryOptions = {
    */
   timeFilter?: TimeFilter;
   /**
-   * Cursor as an index to start a query from.
+   * Cursor as an index to start a query from. Must be generated from a Waku
+   * Message.
    */
   cursor?: Cursor;
 } & ProtocolOptions;

packages/proto/src/lib/store.proto

@@ -1,48 +1,53 @@
+// 13/WAKU2-STORE rfc: https://rfc.vac.dev/spec/13/
+// Protocol identifier: /vac/waku/store/2.0.0-beta4
+
 syntax = "proto3";
 
 import "message.proto";
 
 message Index {
-  optional bytes digest = 1;
-  optional sint64 received_time = 2;
-  optional sint64 sender_time = 3;
-  optional string pubsub_topic = 4;
+  bytes digest = 1;
+  sint64 receiver_time = 2;
+  sint64 sender_time = 3;
+  string pubsub_topic = 4;
 }
 
 message PagingInfo {
   optional uint64 page_size = 1;
   optional Index cursor = 2;
   enum Direction {
-    DIRECTION_BACKWARD_UNSPECIFIED = 0;
-    DIRECTION_FORWARD = 1;
+    BACKWARD = 0;
+    FORWARD = 1;
   }
   optional Direction direction = 3;
 }
 
 message ContentFilter {
-  optional string content_topic = 1;
+  string content_topic = 1;
 }
 
 message HistoryQuery {
-  optional string pub_sub_topic = 2;
+  // The first field is reserved for future use
+  optional string pubsub_topic = 2;
   repeated ContentFilter content_filters = 3;
   optional PagingInfo paging_info = 4;
   optional sint64 start_time = 5;
   optional sint64 end_time = 6;
 }
 
 message HistoryResponse {
+  // The first field is reserved for future use
   repeated WakuMessage messages = 2;
   optional PagingInfo paging_info = 3;
   enum HistoryError {
-    ERROR_NONE_UNSPECIFIED = 0;
-    ERROR_INVALID_CURSOR = 1;
+    NONE = 0;
+    INVALID_CURSOR = 1;
   }
-  optional HistoryError error = 4;
+  HistoryError error = 4;
 }
 
-message HistoryRPC {
-  optional string request_id = 1;
+message HistoryRpc {
+  string request_id = 1;
   optional HistoryQuery query = 2;
   optional HistoryResponse response = 3;
 }