@waku/core 0.0.31-08fc2d1.0 → 0.0.31-88a29c3.0

package/dist/lib/store/index.js

@@ -1,4 +1,3 @@
-import { proto_store as proto } from "@waku/proto";
 import { Logger } from "@waku/utils";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
@@ -6,29 +5,24 @@ import { pipe } from "it-pipe";
 import { Uint8ArrayList } from "uint8arraylist";
 import { BaseProtocol } from "../base_protocol.js";
 import { toProtoMessage } from "../to_proto_message.js";
-import { HistoryRpc, PageDirection } from "./history_rpc.js";
-var HistoryError = proto.HistoryResponse.HistoryError;
+import { DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE, StoreQueryRequest, StoreQueryResponse } from "./rpc.js";
 const log = new Logger("store");
-export const StoreCodec = "/vac/waku/store/2.0.0-beta4";
-export { PageDirection };
-/**
- * Implements the [Waku v2 Store protocol](https://rfc.vac.dev/spec/13/).
- *
- * The Waku Store protocol can be used to retrieved historical messages.
- */
+export const StoreCodec = "/vac/waku/store-query/3.0.0";
 export class StoreCore extends BaseProtocol {
     constructor(libp2p, options) {
-        super(StoreCodec, libp2p.components, log, options.pubsubTopics, options);
+        super(StoreCodec, libp2p.components, log, options?.pubsubTopics || [], options);
     }
     async *queryPerPage(queryOpts, decoders, peer) {
         if (queryOpts.contentTopics.toString() !==
             Array.from(decoders.keys()).toString()) {
             throw new Error("Internal error, the decoders should match the query's content topics");
         }
-        let currentCursor = queryOpts.cursor;
+        let currentCursor = queryOpts.paginationCursor;
         while (true) {
-            queryOpts.cursor = currentCursor;
-            const historyRpcQuery = HistoryRpc.createQuery(queryOpts);
+            const storeQueryRequest = StoreQueryRequest.create({
+                ...queryOpts,
+                paginationCursor: currentCursor
+            });
             let stream;
             try {
                 stream = await this.getStream(peer);
@@ -37,50 +31,48 @@ export class StoreCore extends BaseProtocol {
                 log.error("Failed to get stream", e);
                 break;
             }
-            const res = await pipe([historyRpcQuery.encode()], lp.encode, stream, lp.decode, async (source) => await all(source));
+            const res = await pipe([storeQueryRequest.encode()], lp.encode, stream, lp.decode, async (source) => await all(source));
             const bytes = new Uint8ArrayList();
             res.forEach((chunk) => {
                 bytes.append(chunk);
             });
-            const reply = historyRpcQuery.decode(bytes);
-            if (!reply.response) {
-                log.warn("Stopping pagination due to store `response` field missing");
-                break;
-            }
-            const response = reply.response;
-            if (response.error && response.error !== HistoryError.NONE) {
-                throw "History response contains an Error: " + response.error;
+            const storeQueryResponse = StoreQueryResponse.decode(bytes);
+            if (!storeQueryResponse.statusCode ||
+                storeQueryResponse.statusCode >= 300) {
+                const errorMessage = `Store query failed with status code: ${storeQueryResponse.statusCode}, description: ${storeQueryResponse.statusDesc}`;
+                log.error(errorMessage);
+                throw new Error(errorMessage);
             }
-            if (!response.messages || !response.messages.length) {
-                log.warn("Stopping pagination due to store `response.messages` field missing or empty");
+            if (!storeQueryResponse.messages || !storeQueryResponse.messages.length) {
+                log.warn("Stopping pagination due to empty messages in response");
                 break;
             }
-            log.error(`${response.messages.length} messages retrieved from store`);
-            yield response.messages.map((protoMsg) => {
-                const contentTopic = protoMsg.contentTopic;
-                if (typeof contentTopic !== "undefined") {
+            log.info(`${storeQueryResponse.messages.length} messages retrieved from store`);
+            const decodedMessages = storeQueryResponse.messages.map((protoMsg) => {
+                if (!protoMsg.message) {
+                    return Promise.resolve(undefined);
+                }
+                const contentTopic = protoMsg.message.contentTopic;
+                if (contentTopic) {
                     const decoder = decoders.get(contentTopic);
                     if (decoder) {
-                        return decoder.fromProtoObj(queryOpts.pubsubTopic, toProtoMessage(protoMsg));
+                        return decoder.fromProtoObj(protoMsg.pubsubTopic || "", toProtoMessage(protoMsg.message));
                     }
                 }
                 return Promise.resolve(undefined);
             });
-            const nextCursor = response.pagingInfo?.cursor;
-            if (typeof nextCursor === "undefined") {
-                // If the server does not return cursor then there is an issue,
-                // Need to abort, or we end up in an infinite loop
-                log.warn("Stopping pagination due to `response.pagingInfo.cursor` missing from store response");
-                break;
+            yield decodedMessages;
+            if (queryOpts.paginationForward) {
+                currentCursor =
+                    storeQueryResponse.messages[storeQueryResponse.messages.length - 1]
+                        .messageHash;
+            }
+            else {
+                currentCursor = storeQueryResponse.messages[0].messageHash;
             }
-            currentCursor = nextCursor;
-            const responsePageSize = response.pagingInfo?.pageSize;
-            const queryPageSize = historyRpcQuery.query?.pagingInfo?.pageSize;
-            if (
-            // Response page size smaller than query, meaning this is the last page
-            responsePageSize &&
-                queryPageSize &&
-                responsePageSize < queryPageSize) {
+            if (storeQueryResponse.messages.length > MAX_PAGE_SIZE &&
+                storeQueryResponse.messages.length <
+                    (queryOpts.paginationLimit || DEFAULT_PAGE_SIZE)) {
                 break;
             }
         }

package/dist/lib/store/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/store/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,IAAI,KAAK,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,GAAG,MAAM,QAAQ,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAU,MAAM,kBAAkB,CAAC;AAErE,IAAO,YAAY,GAAG,KAAK,CAAC,eAAe,CAAC,YAAY,CAAC;AAEzD,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;AAEhC,MAAM,CAAC,MAAM,UAAU,GAAG,6BAA6B,CAAC;AAExD,OAAO,EAAE,aAAa,EAAU,CAAC;AAqCjC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,YAAmB,MAAc,EAAE,OAA+B;QAChE,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,OAAQ,CAAC,YAAa,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,CAAC,YAAY,CACxB,SAAiB,EACjB,QAAkC,EAClC,IAAU;QAEV,IACE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;YAClC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,EACtC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;QACJ,CAAC;QAED,IAAI,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC;QACrC,OAAO,IAAI,EAAE,CAAC;YACZ,SAAS,CAAC,MAAM,GAAG,aAAa,CAAC;YAEjC,MAAM,eAAe,GAAG,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YAE1D,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;gBACrC,MAAM;YACR,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,IAAI,CACpB,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAC1B,EAAE,CAAC,MAAM,EACT,MAAM,EACN,EAAE,CAAC,MAAM,EACT,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,CACpC,CAAC;YAEF,MAAM,KAAK,GAAG,IAAI,cAAc,EAAE,CAAC;YACnC,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACpB,GAAG,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;gBACtE,MAAM;YACR,CAAC;YAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAiC,CAAC;YAEzD,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;gBAC3D,MAAM,sCAAsC,GAAG,QAAQ,CAAC,KAAK,CAAC;YAChE,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACpD,GAAG,CAAC,IAAI,CACN,6EAA6E,CAC9E,CAAC;gBACF,MAAM;YACR,CAAC;YAED,GAAG,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,gCAAgC,CAAC,CAAC;YAEvE,MAAM,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACvC,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;gBAC3C,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;oBACxC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;oBAC3C,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,OAAO,CAAC,YAAY,CACzB,SAAS,CAAC,WAAW,EACrB,cAAc,CAAC,QAAQ,CAAC,CACzB,CAAC;oBACJ,CAAC;gBACH,CAAC;gBACD,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;YAC/C,IAAI,OAAO,UAAU,KAAK,WAAW,EAAE,CAAC;gBACtC,+DAA+D;gBAC/D,kDAAkD;gBAClD,GAAG,CAAC,IAAI,CACN,qFAAqF,CACtF,CAAC;gBACF,MAAM;YACR,CAAC;YAED,aAAa,GAAG,UAAU,CAAC;YAE3B,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;YACvD,MAAM,aAAa,GAAG,eAAe,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC;YAClE;YACE,uEAAuE;YACvE,gBAAgB;gBAChB,aAAa;gBACb,gBAAgB,GAAG,aAAa,EAChC,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/store/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,GAAG,MAAM,QAAQ,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,UAAU,CAAC;AAElB,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;AAEhC,MAAM,CAAC,MAAM,UAAU,GAAG,6BAA6B,CAAC;AAExD,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,YAAmB,MAAc,EAAE,OAA+B;QAChE,KAAK,CACH,UAAU,EACV,MAAM,CAAC,UAAU,EACjB,GAAG,EACH,OAAO,EAAE,YAAY,IAAI,EAAE,EAC3B,OAAO,CACR,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,CAAC,YAAY,CACxB,SAA6B,EAC7B,QAAkC,EAClC,IAAU;QAEV,IACE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;YAClC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,EACtC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;QACJ,CAAC;QAED,IAAI,aAAa,GAAG,SAAS,CAAC,gBAAgB,CAAC;QAC/C,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBACjD,GAAG,SAAS;gBACZ,gBAAgB,EAAE,aAAa;aAChC,CAAC,CAAC;YAEH,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;gBACrC,MAAM;YACR,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,IAAI,CACpB,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAC5B,EAAE,CAAC,MAAM,EACT,MAAM,EACN,EAAE,CAAC,MAAM,EACT,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,CACpC,CAAC;YAEF,MAAM,KAAK,GAAG,IAAI,cAAc,EAAE,CAAC;YACnC,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5D,IACE,CAAC,kBAAkB,CAAC,UAAU;gBAC9B,kBAAkB,CAAC,UAAU,IAAI,GAAG,EACpC,CAAC;gBACD,MAAM,YAAY,GAAG,wCAAwC,kBAAkB,CAAC,UAAU,kBAAkB,kBAAkB,CAAC,UAAU,EAAE,CAAC;gBAC5I,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAChC,CAAC;YAED,IAAI,CAAC,kBAAkB,CAAC,QAAQ,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACxE,GAAG,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;gBAClE,MAAM;YACR,CAAC;YAED,GAAG,CAAC,IAAI,CACN,GAAG,kBAAkB,CAAC,QAAQ,CAAC,MAAM,gCAAgC,CACtE,CAAC;YAEF,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACnE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACtB,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACpC,CAAC;gBACD,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC;gBACnD,IAAI,YAAY,EAAE,CAAC;oBACjB,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;oBAC3C,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,OAAO,CAAC,YAAY,CACzB,QAAQ,CAAC,WAAW,IAAI,EAAE,EAC1B,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CACjC,CAAC;oBACJ,CAAC;gBACH,CAAC;gBACD,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,MAAM,eAAe,CAAC;YAEtB,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAC;gBAChC,aAAa;oBACX,kBAAkB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;yBAChE,WAAW,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;YAC7D,CAAC;YAED,IACE,kBAAkB,CAAC,QAAQ,CAAC,MAAM,GAAG,aAAa;gBAClD,kBAAkB,CAAC,QAAQ,CAAC,MAAM;oBAChC,CAAC,SAAS,CAAC,eAAe,IAAI,iBAAiB,CAAC,EAClD,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/lib/store/rpc.d.ts

@@ -0,0 +1,22 @@
+import { QueryRequestParams } from "@waku/interfaces";
+import { proto_store as proto } from "@waku/proto";
+import type { Uint8ArrayList } from "uint8arraylist";
+export declare const DEFAULT_PAGE_SIZE = 20;
+export declare const MAX_PAGE_SIZE = 100;
+export declare class StoreQueryRequest {
+    proto: proto.StoreQueryRequest;
+    constructor(proto: proto.StoreQueryRequest);
+    static create(params: QueryRequestParams): StoreQueryRequest;
+    static decode(bytes: Uint8ArrayList): StoreQueryRequest;
+    encode(): Uint8Array;
+}
+export declare class StoreQueryResponse {
+    proto: proto.StoreQueryResponse;
+    constructor(proto: proto.StoreQueryResponse);
+    static decode(bytes: Uint8ArrayList): StoreQueryResponse;
+    encode(): Uint8Array;
+    get statusCode(): number | undefined;
+    get statusDesc(): string | undefined;
+    get messages(): proto.WakuMessageKeyValue[];
+    get paginationCursor(): Uint8Array | undefined;
+}

package/dist/lib/store/rpc.js

@@ -0,0 +1,74 @@
+import { proto_store as proto } from "@waku/proto";
+import { v4 as uuid } from "uuid";
+// https://github.com/waku-org/nwaku/blob/7205f95cff9f49ca0bb762e8fd0bf56a6a7f3b3b/waku/waku_store/common.nim#L12
+export const DEFAULT_PAGE_SIZE = 20;
+export const MAX_PAGE_SIZE = 100;
+const ONE_MILLION = 1_000000;
+export class StoreQueryRequest {
+    proto;
+    constructor(proto) {
+        this.proto = proto;
+    }
+    static create(params) {
+        const request = new StoreQueryRequest({
+            ...params,
+            requestId: uuid(),
+            timeStart: params.timeStart
+                ? BigInt(params.timeStart.getTime() * ONE_MILLION)
+                : undefined,
+            timeEnd: params.timeEnd
+                ? BigInt(params.timeEnd.getTime() * ONE_MILLION)
+                : undefined,
+            messageHashes: params.messageHashes || [],
+            paginationLimit: params.paginationLimit
+                ? BigInt(params.paginationLimit)
+                : undefined
+        });
+        // Validate request parameters based on RFC
+        if ((params.pubsubTopic && !params.contentTopics) ||
+            (!params.pubsubTopic && params.contentTopics)) {
+            throw new Error("Both pubsubTopic and contentTopics must be set or unset");
+        }
+        if (params.messageHashes &&
+            (params.pubsubTopic ||
+                params.contentTopics ||
+                params.timeStart ||
+                params.timeEnd)) {
+            throw new Error("Message hash lookup queries cannot include content filter criteria");
+        }
+        return request;
+    }
+    static decode(bytes) {
+        const res = proto.StoreQueryRequest.decode(bytes);
+        return new StoreQueryRequest(res);
+    }
+    encode() {
+        return proto.StoreQueryRequest.encode(this.proto);
+    }
+}
+export class StoreQueryResponse {
+    proto;
+    constructor(proto) {
+        this.proto = proto;
+    }
+    static decode(bytes) {
+        const res = proto.StoreQueryResponse.decode(bytes);
+        return new StoreQueryResponse(res);
+    }
+    encode() {
+        return proto.StoreQueryResponse.encode(this.proto);
+    }
+    get statusCode() {
+        return this.proto.statusCode;
+    }
+    get statusDesc() {
+        return this.proto.statusDesc;
+    }
+    get messages() {
+        return this.proto.messages;
+    }
+    get paginationCursor() {
+        return this.proto.paginationCursor;
+    }
+}
+//# sourceMappingURL=rpc.js.map

package/dist/lib/store/rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.js","sourceRoot":"","sources":["../../../src/lib/store/rpc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,IAAI,KAAK,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,iHAAiH;AACjH,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AACpC,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,CAAC;AACjC,MAAM,WAAW,GAAG,QAAQ,CAAC;AAE7B,MAAM,OAAO,iBAAiB;IACF;IAA1B,YAA0B,KAA8B;QAA9B,UAAK,GAAL,KAAK,CAAyB;IAAG,CAAC;IAErD,MAAM,CAAC,MAAM,CAAC,MAA0B;QAC7C,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC;YACpC,GAAG,MAAM;YACT,SAAS,EAAE,IAAI,EAAE;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS;gBACzB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC;gBAClD,CAAC,CAAC,SAAS;YACb,OAAO,EAAE,MAAM,CAAC,OAAO;gBACrB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC;gBAChD,CAAC,CAAC,SAAS;YACb,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,EAAE;YACzC,eAAe,EAAE,MAAM,CAAC,eAAe;gBACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC;gBAChC,CAAC,CAAC,SAAS;SACd,CAAC,CAAC;QAEH,2CAA2C;QAC3C,IACE,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;YAC7C,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,EAC7C,CAAC;YACD,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QAED,IACE,MAAM,CAAC,aAAa;YACpB,CAAC,MAAM,CAAC,WAAW;gBACjB,MAAM,CAAC,aAAa;gBACpB,MAAM,CAAC,SAAS;gBAChB,MAAM,CAAC,OAAO,CAAC,EACjB,CAAC;YACD,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;QACJ,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,MAAM,GAAG,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAClD,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAEM,MAAM;QACX,OAAO,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;CACF;AAED,MAAM,OAAO,kBAAkB;IACH;IAA1B,YAA0B,KAA+B;QAA/B,UAAK,GAAL,KAAK,CAA0B;IAAG,CAAC;IAEtD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,MAAM,GAAG,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnD,OAAO,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM;QACX,OAAO,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IAC/B,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IAC/B,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACrC,CAAC;CACF"}

package/package.json

@@ -1 +1 @@
-{"name":"@waku/core","version":"0.0.31-08fc2d1.0","description":"TypeScript implementation of the Waku v2 protocol","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./lib/message/version_0":{"types":"./dist/lib/message/version_0.d.ts","import":"./dist/lib/message/version_0.js"},"./lib/base_protocol":{"types":"./dist/lib/base_protocol.d.ts","import":"./dist/lib/base_protocol.js"}},"typesVersions":{"*":{"lib/*":["dist/lib/*"],"constants/*":["dist/constants/*"]}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/core#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralised","communication","web3","ethereum","dapps"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"NODE_ENV=test karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=18"},"dependencies":{"@libp2p/ping":"^1.0.12","@waku/enr":"0.0.25-08fc2d1.0","@waku/interfaces":"0.0.26-08fc2d1.0","@waku/proto":"0.0.8-08fc2d1.0","@waku/utils":"0.0.19-08fc2d1.0","debug":"^4.3.4","it-all":"^3.0.4","it-length-prefixed":"^9.0.4","it-pipe":"^3.0.1","p-event":"^6.0.1","uint8arraylist":"^2.4.3","uuid":"^9.0.0"},"devDependencies":{"@multiformats/multiaddr":"^12.0.0","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/debug":"^4.1.12","@types/mocha":"^10.0.6","@types/uuid":"^9.0.8","@waku/build-utils":"*","chai":"^4.3.10","cspell":"^8.6.1","fast-check":"^3.19.0","ignore-loader":"^0.1.2","isomorphic-fetch":"^3.0.0","mocha":"^10.3.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^4.12.0"},"peerDependencies":{"@multiformats/multiaddr":"^12.0.0","libp2p":"^1.1.2","@waku/enr":"0.0.25-08fc2d1.0","@waku/interfaces":"0.0.26-08fc2d1.0","@waku/proto":"0.0.8-08fc2d1.0","@waku/utils":"0.0.19-08fc2d1.0"},"peerDependenciesMeta":{"@multiformats/multiaddr":{"optional":true},"@waku/interfaces":{"optional":true}},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}
+{"name":"@waku/core","version":"0.0.31-88a29c3.0","description":"TypeScript implementation of the Waku v2 protocol","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./lib/message/version_0":{"types":"./dist/lib/message/version_0.d.ts","import":"./dist/lib/message/version_0.js"},"./lib/base_protocol":{"types":"./dist/lib/base_protocol.d.ts","import":"./dist/lib/base_protocol.js"}},"typesVersions":{"*":{"lib/*":["dist/lib/*"],"constants/*":["dist/constants/*"]}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/core#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralised","communication","web3","ethereum","dapps"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"NODE_ENV=test karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=18"},"dependencies":{"@libp2p/ping":"^1.0.12","@waku/enr":"0.0.25-88a29c3.0","@waku/interfaces":"0.0.26-88a29c3.0","@waku/proto":"0.0.8-88a29c3.0","@waku/utils":"0.0.19-88a29c3.0","debug":"^4.3.4","it-all":"^3.0.4","it-length-prefixed":"^9.0.4","it-pipe":"^3.0.1","p-event":"^6.0.1","uint8arraylist":"^2.4.3","uuid":"^9.0.0"},"devDependencies":{"@multiformats/multiaddr":"^12.0.0","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/debug":"^4.1.12","@types/mocha":"^10.0.6","@types/uuid":"^9.0.8","@waku/build-utils":"*","chai":"^4.3.10","cspell":"^8.6.1","fast-check":"^3.19.0","ignore-loader":"^0.1.2","isomorphic-fetch":"^3.0.0","mocha":"^10.3.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^4.12.0"},"peerDependencies":{"@multiformats/multiaddr":"^12.0.0","libp2p":"^1.1.2","@waku/enr":"0.0.25-88a29c3.0","@waku/interfaces":"0.0.26-88a29c3.0","@waku/proto":"0.0.8-88a29c3.0","@waku/utils":"0.0.19-88a29c3.0"},"peerDependenciesMeta":{"@multiformats/multiaddr":{"optional":true},"@waku/interfaces":{"optional":true}},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}

package/src/index.ts

@@ -15,12 +15,12 @@ export { LightPushCodec, LightPushCore } from "./lib/light_push/index.js";
 export * as waku_store from "./lib/store/index.js";
 export { StoreCore } from "./lib/store/index.js";
 
-export { PageDirection } from "./lib/store/index.js";
-
 export { waitForRemotePeer } from "./lib/wait_for_remote_peer.js";
 
 export { ConnectionManager } from "./lib/connection_manager.js";
 
+export { getHealthManager } from "./lib/health_manager.js";
+
 export { KeepAliveManager } from "./lib/keep_alive_manager.js";
 export { StreamManager } from "./lib/stream_manager/index.js";
 

package/src/lib/health_manager.ts

@@ -0,0 +1,90 @@
+import {
+  HealthStatus,
+  type IHealthManager,
+  NodeHealth,
+  type ProtocolHealth,
+  Protocols
+} from "@waku/interfaces";
+
+class HealthManager implements IHealthManager {
+  public static instance: HealthManager;
+  private readonly health: NodeHealth;
+
+  private constructor() {
+    this.health = {
+      overallStatus: HealthStatus.Unhealthy,
+      protocolStatuses: new Map()
+    };
+  }
+
+  public static getInstance(): HealthManager {
+    if (!HealthManager.instance) {
+      HealthManager.instance = new HealthManager();
+    }
+    return HealthManager.instance;
+  }
+
+  public getHealthStatus(): HealthStatus {
+    return this.health.overallStatus;
+  }
+
+  public getProtocolStatus(protocol: Protocols): ProtocolHealth | undefined {
+    return this.health.protocolStatuses.get(protocol);
+  }
+
+  public updateProtocolHealth(
+    multicodec: string,
+    connectedPeers: number
+  ): void {
+    const protocol = this.getNameFromMulticodec(multicodec);
+
+    let status: HealthStatus = HealthStatus.Unhealthy;
+    if (connectedPeers == 1) {
+      status = HealthStatus.MinimallyHealthy;
+    } else if (connectedPeers >= 2) {
+      status = HealthStatus.SufficientlyHealthy;
+    }
+
+    this.health.protocolStatuses.set(protocol, {
+      name: protocol,
+      status: status,
+      lastUpdate: new Date()
+    });
+
+    this.updateOverallHealth();
+  }
+
+  private getNameFromMulticodec(multicodec: string): Protocols {
+    let name: Protocols;
+    if (multicodec.includes("filter")) {
+      name = Protocols.Filter;
+    } else if (multicodec.includes("lightpush")) {
+      name = Protocols.LightPush;
+    } else if (multicodec.includes("store")) {
+      name = Protocols.Store;
+    } else {
+      throw new Error(`Unknown protocol: ${multicodec}`);
+    }
+    return name;
+  }
+
+  private updateOverallHealth(): void {
+    const relevantProtocols = [Protocols.LightPush, Protocols.Filter];
+    const statuses = relevantProtocols.map(
+      (p) => this.getProtocolStatus(p)?.status
+    );
+
+    if (statuses.some((status) => status === HealthStatus.Unhealthy)) {
+      this.health.overallStatus = HealthStatus.Unhealthy;
+    } else if (
+      statuses.some((status) => status === HealthStatus.MinimallyHealthy)
+    ) {
+      this.health.overallStatus = HealthStatus.MinimallyHealthy;
+    } else {
+      this.health.overallStatus = HealthStatus.SufficientlyHealthy;
+    }
+  }
+}
+
+export const getHealthManager = (): HealthManager =>
+  HealthManager.getInstance();

package/src/lib/store/index.ts

@@ -1,13 +1,12 @@
 import type { Peer } from "@libp2p/interface";
 import {
-  Cursor,
   IDecodedMessage,
   IDecoder,
   IStoreCore,
   Libp2p,
-  ProtocolCreateOptions
+  ProtocolCreateOptions,
+  QueryRequestParams
 } from "@waku/interfaces";
-import { proto_store as proto } from "@waku/proto";
 import { Logger } from "@waku/utils";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
@@ -17,63 +16,30 @@ import { Uint8ArrayList } from "uint8arraylist";
 import { BaseProtocol } from "../base_protocol.js";
 import { toProtoMessage } from "../to_proto_message.js";
 
-import { HistoryRpc, PageDirection, Params } from "./history_rpc.js";
-
-import HistoryError = proto.HistoryResponse.HistoryError;
+import {
+  DEFAULT_PAGE_SIZE,
+  MAX_PAGE_SIZE,
+  StoreQueryRequest,
+  StoreQueryResponse
+} from "./rpc.js";
 
 const log = new Logger("store");
 
-export const StoreCodec = "/vac/waku/store/2.0.0-beta4";
-
-export { PageDirection, Params };
-
-export interface TimeFilter {
-  startTime: Date;
-  endTime: Date;
-}
-
-export interface QueryOptions {
-  /**
-   * The direction in which pages are retrieved:
-   * - { @link PageDirection.BACKWARD }: Most recent page first.
-   * - { @link PageDirection.FORWARD }: Oldest page first.
-   *
-   * Note: This does not affect the ordering of messages with the page
-   * (the oldest message is always first).
-   *
-   * @default { @link PageDirection.BACKWARD }
-   */
-  pageDirection?: PageDirection;
-  /**
-   * The number of message per page.
-   *
-   * @default { @link DefaultPageSize }
-   */
-  pageSize?: number;
-  /**
-   * Retrieve messages with a timestamp within the provided values.
-   */
-  timeFilter?: TimeFilter;
-  /**
-   * Cursor as an index to start a query from.
-   * The cursor index will be exclusive (i.e. the message at the cursor index will not be included in the result).
-   * If undefined, the query will start from the beginning or end of the history, depending on the page direction.
-   */
-  cursor?: Cursor;
-}
+export const StoreCodec = "/vac/waku/store-query/3.0.0";
 
-/**
- * Implements the [Waku v2 Store protocol](https://rfc.vac.dev/spec/13/).
- *
- * The Waku Store protocol can be used to retrieved historical messages.
- */
 export class StoreCore extends BaseProtocol implements IStoreCore {
   public constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
-    super(StoreCodec, libp2p.components, log, options!.pubsubTopics!, options);
+    super(
+      StoreCodec,
+      libp2p.components,
+      log,
+      options?.pubsubTopics || [],
+      options
+    );
   }
 
   public async *queryPerPage<T extends IDecodedMessage>(
-    queryOpts: Params,
+    queryOpts: QueryRequestParams,
     decoders: Map<string, IDecoder<T>>,
     peer: Peer
   ): AsyncGenerator<Promise<T | undefined>[]> {
@@ -86,11 +52,12 @@ export class StoreCore extends BaseProtocol implements IStoreCore {
       );
     }
 
-    let currentCursor = queryOpts.cursor;
+    let currentCursor = queryOpts.paginationCursor;
     while (true) {
-      queryOpts.cursor = currentCursor;
-
-      const historyRpcQuery = HistoryRpc.createQuery(queryOpts);
+      const storeQueryRequest = StoreQueryRequest.create({
+        ...queryOpts,
+        paginationCursor: currentCursor
+      });
 
       let stream;
       try {
@@ -101,7 +68,7 @@ export class StoreCore extends BaseProtocol implements IStoreCore {
       }
 
       const res = await pipe(
-        [historyRpcQuery.encode()],
+        [storeQueryRequest.encode()],
         lp.encode,
         stream,
         lp.decode,
@@ -113,61 +80,57 @@ export class StoreCore extends BaseProtocol implements IStoreCore {
         bytes.append(chunk);
       });
 
-      const reply = historyRpcQuery.decode(bytes);
-
-      if (!reply.response) {
-        log.warn("Stopping pagination due to store `response` field missing");
-        break;
-      }
-
-      const response = reply.response as proto.HistoryResponse;
+      const storeQueryResponse = StoreQueryResponse.decode(bytes);
 
-      if (response.error && response.error !== HistoryError.NONE) {
-        throw "History response contains an Error: " + response.error;
+      if (
+        !storeQueryResponse.statusCode ||
+        storeQueryResponse.statusCode >= 300
+      ) {
+        const errorMessage = `Store query failed with status code: ${storeQueryResponse.statusCode}, description: ${storeQueryResponse.statusDesc}`;
+        log.error(errorMessage);
+        throw new Error(errorMessage);
       }
 
-      if (!response.messages || !response.messages.length) {
-        log.warn(
-          "Stopping pagination due to store `response.messages` field missing or empty"
-        );
+      if (!storeQueryResponse.messages || !storeQueryResponse.messages.length) {
+        log.warn("Stopping pagination due to empty messages in response");
         break;
       }
 
-      log.error(`${response.messages.length} messages retrieved from store`);
+      log.info(
+        `${storeQueryResponse.messages.length} messages retrieved from store`
+      );
 
-      yield response.messages.map((protoMsg) => {
-        const contentTopic = protoMsg.contentTopic;
-        if (typeof contentTopic !== "undefined") {
+      const decodedMessages = storeQueryResponse.messages.map((protoMsg) => {
+        if (!protoMsg.message) {
+          return Promise.resolve(undefined);
+        }
+        const contentTopic = protoMsg.message.contentTopic;
+        if (contentTopic) {
           const decoder = decoders.get(contentTopic);
           if (decoder) {
             return decoder.fromProtoObj(
-              queryOpts.pubsubTopic,
-              toProtoMessage(protoMsg)
+              protoMsg.pubsubTopic || "",
+              toProtoMessage(protoMsg.message)
             );
           }
         }
         return Promise.resolve(undefined);
       });
 
-      const nextCursor = response.pagingInfo?.cursor;
-      if (typeof nextCursor === "undefined") {
-        // If the server does not return cursor then there is an issue,
-        // Need to abort, or we end up in an infinite loop
-        log.warn(
-          "Stopping pagination due to `response.pagingInfo.cursor` missing from store response"
-        );
-        break;
-      }
+      yield decodedMessages;
 
-      currentCursor = nextCursor;
+      if (queryOpts.paginationForward) {
+        currentCursor =
+          storeQueryResponse.messages[storeQueryResponse.messages.length - 1]
+            .messageHash;
+      } else {
+        currentCursor = storeQueryResponse.messages[0].messageHash;
+      }
 
-      const responsePageSize = response.pagingInfo?.pageSize;
-      const queryPageSize = historyRpcQuery.query?.pagingInfo?.pageSize;
       if (
-        // Response page size smaller than query, meaning this is the last page
-        responsePageSize &&
-        queryPageSize &&
-        responsePageSize < queryPageSize
+        storeQueryResponse.messages.length > MAX_PAGE_SIZE &&
+        storeQueryResponse.messages.length <
+          (queryOpts.paginationLimit || DEFAULT_PAGE_SIZE)
       ) {
         break;
       }