@waku/core 0.0.1

package/dist/lib/waku_relay/constants.js

@@ -0,0 +1,67 @@
+export const second = 1000;
+export const minute = 60 * second;
+/**
+ * RelayCodec is the libp2p identifier for the waku relay protocol
+ */
+export const RelayCodecs = [
+    "/vac/waku/relay/2.0.0-beta2",
+    "/vac/waku/relay/2.0.0",
+];
+export const RelayPingContentTopic = "/relay-ping/1/ping/null";
+/**
+ * RelayGossipFactor affects how many peers we will emit gossip to at each heartbeat.
+ * We will send gossip to RelayGossipFactor * (total number of non-mesh peers), or
+ * RelayDlazy, whichever is greater.
+ */
+export const RelayGossipFactor = 0.25;
+/**
+ * GossipsubHeartbeatInitialDelay is the short delay before the heartbeat timer begins
+ * after the router is initialized.
+ */
+export const RelayHeartbeatInitialDelay = 100;
+/**
+ * RelayHeartbeatInterval controls the time between heartbeats.
+ */
+export const RelayHeartbeatInterval = second;
+/**
+ * RelayPrunePeers controls the number of peers to include in prune Peer eXchange.
+ * When we prune a peer that's eligible for PX (has a good score, etc), we will try to
+ * send them signed peer records for up to RelayPrunePeers other peers that we
+ * know of.
+ */
+export const RelayPrunePeers = 16;
+/**
+ * RelayPruneBackoff controls the backoff time for pruned peers. This is how long
+ * a peer must wait before attempting to graft into our mesh again after being pruned.
+ * When pruning a peer, we send them our value of RelayPruneBackoff so they know
+ * the minimum time to wait. Peers running older versions may not send a backoff time,
+ * so if we receive a prune message without one, we will wait at least RelayPruneBackoff
+ * before attempting to re-graft.
+ */
+export const RelayPruneBackoff = minute;
+/**
+ * RelayFanoutTTL controls how long we keep track of the fanout state. If it's been
+ * RelayFanoutTTL since we've published to a topic that we're not subscribed to,
+ * we'll delete the fanout map for that topic.
+ */
+export const RelayFanoutTTL = minute;
+/**
+ * RelayOpportunisticGraftTicks is the number of heartbeat ticks for attempting to improve the mesh
+ * with opportunistic grafting. Every RelayOpportunisticGraftTicks we will attempt to select some
+ * high-scoring mesh peers to replace lower-scoring ones, if the median score of our mesh peers falls
+ * below a threshold
+ */
+export const RelayOpportunisticGraftTicks = 60;
+/**
+ * RelayOpportunisticGraftPeers is the number of peers to opportunistically graft.
+ */
+export const RelayOpportunisticGraftPeers = 2;
+/**
+ * RelayMaxIHaveLength is the maximum number of messages to include in an IHAVE message.
+ * Also controls the maximum number of IHAVE ids we will accept and request with IWANT from a
+ * peer within a heartbeat, to protect from IHAVE floods. You should adjust this value from the
+ * default if your system is pushing more than 5000 messages in GossipsubHistoryGossip heartbeats;
+ * with the defaults this is 1666 messages/s.
+ */
+export const RelayMaxIHaveLength = 5000;
+//# sourceMappingURL=constants.js.map

package/dist/lib/waku_relay/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/lib/waku_relay/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,CAAC;AAC3B,MAAM,CAAC,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,6BAA6B;IAC7B,uBAAuB;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAEtC;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAElC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAExC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AAErC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC"}

package/dist/lib/waku_relay/index.d.ts

@@ -0,0 +1,65 @@
+import { GossipSub, GossipsubOpts } from "@chainsafe/libp2p-gossipsub";
+import { PeerIdStr, TopicStr } from "@chainsafe/libp2p-gossipsub/dist/src/types";
+import type { Callback, Decoder, Encoder, Message, Relay, SendResult } from "@waku/interfaces";
+export declare type Observer<T extends Message> = {
+    decoder: Decoder<T>;
+    callback: Callback<T>;
+};
+export declare type CreateOptions = {
+    /**
+     * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}.
+     *
+     * One and only one pubsub topic is used by Waku. This is used by:
+     * - WakuRelay to receive, route and send messages,
+     * - WakuLightPush to send messages,
+     * - WakuStore to retrieve messages.
+     *
+     * The usage of the default pubsub topic is recommended.
+     * See [Waku v2 Topic Usage Recommendations](https://rfc.vac.dev/spec/23/) for details.
+     *
+     * @default {@link DefaultPubSubTopic}
+     */
+    pubSubTopic?: string;
+} & GossipsubOpts;
+/**
+ * Implements the [Waku v2 Relay protocol](https://rfc.vac.dev/spec/11/).
+ * Must be passed as a `pubsub` module to a `Libp2p` instance.
+ *
+ * @implements {require('libp2p-interfaces/src/pubsub')}
+ */
+export declare class WakuRelay extends GossipSub implements Relay {
+    pubSubTopic: string;
+    defaultDecoder: Decoder<Message>;
+    static multicodec: string;
+    /**
+     * observers called when receiving new message.
+     * Observers under key `""` are always called.
+     */
+    observers: Map<string, Set<Observer<any>>>;
+    constructor(options?: Partial<CreateOptions>);
+    /**
+     * Mounts the gossipsub protocol onto the libp2p node
+     * and subscribes to the default topic.
+     *
+     * @override
+     * @returns {void}
+     */
+    start(): Promise<void>;
+    /**
+     * Send Waku message.
+     */
+    send(encoder: Encoder, message: Partial<Message>): Promise<SendResult>;
+    /**
+     * Add an observer and associated Decoder to process incoming messages on a given content topic.
+     *
+     * @returns Function to delete the observer
+     */
+    addObserver<T extends Message>(decoder: Decoder<T>, callback: Callback<T>): () => void;
+    /**
+     * Subscribe to a pubsub topic and start emitting Waku messages to observers.
+     *
+     * @override
+     */
+    subscribe(pubSubTopic: string): void;
+    getMeshPeers(topic?: TopicStr): PeerIdStr[];
+}

package/dist/lib/waku_relay/index.js

@@ -0,0 +1,111 @@
+import { GossipSub, } from "@chainsafe/libp2p-gossipsub";
+import { SignaturePolicy } from "@chainsafe/libp2p-gossipsub/types";
+import debug from "debug";
+import { DefaultPubSubTopic } from "../constants.js";
+import { pushOrInitMapSet } from "../push_or_init_map.js";
+import { TopicOnlyDecoder } from "../waku_message/topic_only_message.js";
+import * as constants from "./constants.js";
+const log = debug("waku:relay");
+/**
+ * Implements the [Waku v2 Relay protocol](https://rfc.vac.dev/spec/11/).
+ * Must be passed as a `pubsub` module to a `Libp2p` instance.
+ *
+ * @implements {require('libp2p-interfaces/src/pubsub')}
+ */
+export class WakuRelay extends GossipSub {
+    constructor(options) {
+        options = Object.assign(options ?? {}, {
+            // Ensure that no signature is included nor expected in the messages.
+            globalSignaturePolicy: SignaturePolicy.StrictNoSign,
+            fallbackToFloodsub: false,
+        });
+        super(options);
+        this.multicodecs = constants.RelayCodecs;
+        this.observers = new Map();
+        this.pubSubTopic = options?.pubSubTopic ?? DefaultPubSubTopic;
+        // TODO: User might want to decide what decoder should be used (e.g. for RLN)
+        this.defaultDecoder = new TopicOnlyDecoder();
+    }
+    /**
+     * Mounts the gossipsub protocol onto the libp2p node
+     * and subscribes to the default topic.
+     *
+     * @override
+     * @returns {void}
+     */
+    async start() {
+        await super.start();
+        this.subscribe(this.pubSubTopic);
+    }
+    /**
+     * Send Waku message.
+     */
+    async send(encoder, message) {
+        const msg = await encoder.toWire(message);
+        if (!msg) {
+            log("Failed to encode message, aborting publish");
+            return { recipients: [] };
+        }
+        return this.publish(this.pubSubTopic, msg);
+    }
+    /**
+     * Add an observer and associated Decoder to process incoming messages on a given content topic.
+     *
+     * @returns Function to delete the observer
+     */
+    addObserver(decoder, callback) {
+        const observer = {
+            decoder,
+            callback,
+        };
+        pushOrInitMapSet(this.observers, decoder.contentTopic, observer);
+        return () => {
+            const observers = this.observers.get(decoder.contentTopic);
+            if (observers) {
+                observers.delete(observer);
+            }
+        };
+    }
+    /**
+     * Subscribe to a pubsub topic and start emitting Waku messages to observers.
+     *
+     * @override
+     */
+    subscribe(pubSubTopic) {
+        this.addEventListener("gossipsub:message", async (event) => {
+            if (event.detail.msg.topic !== pubSubTopic)
+                return;
+            log(`Message received on ${pubSubTopic}`);
+            const topicOnlyMsg = await this.defaultDecoder.fromWireToProtoObj(event.detail.msg.data);
+            if (!topicOnlyMsg || !topicOnlyMsg.contentTopic) {
+                log("Message does not have a content topic, skipping");
+                return;
+            }
+            const observers = this.observers.get(topicOnlyMsg.contentTopic);
+            if (!observers) {
+                return;
+            }
+            await Promise.all(Array.from(observers).map(async ({ decoder, callback }) => {
+                const protoMsg = await decoder.fromWireToProtoObj(event.detail.msg.data);
+                if (!protoMsg) {
+                    log("Internal error: message previously decoded failed on 2nd pass.");
+                    return;
+                }
+                const msg = await decoder.fromProtoObj(protoMsg);
+                if (msg) {
+                    callback(msg);
+                }
+                else {
+                    log("Failed to decode messages on", topicOnlyMsg.contentTopic);
+                }
+            }));
+        });
+        super.subscribe(pubSubTopic);
+    }
+    getMeshPeers(topic) {
+        return super.getMeshPeers(topic ?? this.pubSubTopic);
+    }
+}
+WakuRelay.multicodec = constants.RelayCodecs[0];
+WakuRelay.multicodec = constants.RelayCodecs[constants.RelayCodecs.length - 1];
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/waku_relay/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,GAGV,MAAM,6BAA6B,CAAC;AAKrC,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AASpE,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AAEzC,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAwBhC;;;;;GAKG;AACH,MAAM,OAAO,SAAU,SAAQ,SAAS;IAWtC,YAAY,OAAgC;QAC1C,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE;YACrC,qEAAqE;YACrE,qBAAqB,EAAE,eAAe,CAAC,YAAY;YACnD,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;QACH,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAEzC,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QAE3B,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,kBAAkB,CAAC;QAE9D,6EAA6E;QAC7E,IAAI,CAAC,cAAc,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACf,OAAgB,EAChB,OAAyB;QAEzB,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,CAAC,4CAA4C,CAAC,CAAC;YAClD,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC3B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,OAAmB,EACnB,QAAqB;QAErB,MAAM,QAAQ,GAAG;YACf,OAAO;YACP,QAAQ;SACT,CAAC;QACF,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAEjE,OAAO,GAAG,EAAE;YACV,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC3D,IAAI,SAAS,EAAE;gBACb,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC5B;QACH,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,WAAmB;QAC3B,IAAI,CAAC,gBAAgB,CACnB,mBAAmB,EACnB,KAAK,EAAE,KAAoC,EAAE,EAAE;YAC7C,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,KAAK,WAAW;gBAAE,OAAO;YACnD,GAAG,CAAC,uBAAuB,WAAW,EAAE,CAAC,CAAC;YAE1C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAC/D,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CACtB,CAAC;YACF,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE;gBAC/C,GAAG,CAAC,iDAAiD,CAAC,CAAC;gBACvD,OAAO;aACR;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO;aACR;YACD,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;gBACxD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,kBAAkB,CAC/C,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CACtB,CAAC;gBACF,IAAI,CAAC,QAAQ,EAAE;oBACb,GAAG,CACD,gEAAgE,CACjE,CAAC;oBACF,OAAO;iBACR;gBACD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBACjD,IAAI,GAAG,EAAE;oBACP,QAAQ,CAAC,GAAG,CAAC,CAAC;iBACf;qBAAM;oBACL,GAAG,CAAC,8BAA8B,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;iBAChE;YACH,CAAC,CAAC,CACH,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,YAAY,CAAC,KAAgB;QAC3B,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;;AA9Ha,oBAAU,GAAW,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAiI9D,SAAS,CAAC,UAAU,GAAG,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC"}

package/dist/lib/waku_store/history_rpc.d.ts

@@ -0,0 +1,27 @@
+import type { Uint8ArrayList } from "uint8arraylist";
+import * as proto from "../../proto/store";
+export declare enum PageDirection {
+    BACKWARD = "backward",
+    FORWARD = "forward"
+}
+export interface Params {
+    contentTopics: string[];
+    pubSubTopic: string;
+    pageDirection: PageDirection;
+    pageSize: number;
+    startTime?: Date;
+    endTime?: Date;
+    cursor?: proto.Index;
+}
+export declare class HistoryRPC {
+    readonly proto: proto.HistoryRPC;
+    private constructor();
+    get query(): proto.HistoryQuery | undefined;
+    get response(): proto.HistoryResponse | undefined;
+    /**
+     * Create History Query.
+     */
+    static createQuery(params: Params): HistoryRPC;
+    decode(bytes: Uint8ArrayList): HistoryRPC;
+    encode(): Uint8Array;
+}

package/dist/lib/waku_store/history_rpc.js

@@ -0,0 +1,71 @@
+import { v4 as uuid } from "uuid";
+import * as proto from "../../proto/store.js";
+const OneMillion = BigInt(1000000);
+export var PageDirection;
+(function (PageDirection) {
+    PageDirection["BACKWARD"] = "backward";
+    PageDirection["FORWARD"] = "forward";
+})(PageDirection || (PageDirection = {}));
+export class HistoryRPC {
+    constructor(proto) {
+        this.proto = proto;
+    }
+    get query() {
+        return this.proto.query;
+    }
+    get response() {
+        return this.proto.response;
+    }
+    /**
+     * Create History Query.
+     */
+    static createQuery(params) {
+        const contentFilters = params.contentTopics.map((contentTopic) => {
+            return { contentTopic };
+        });
+        const direction = directionToProto(params.pageDirection);
+        const pagingInfo = {
+            pageSize: BigInt(params.pageSize),
+            cursor: params.cursor,
+            direction,
+        };
+        let startTime, endTime;
+        if (params.startTime) {
+            // milliseconds 10^-3 to nanoseconds 10^-9
+            startTime = BigInt(params.startTime.valueOf()) * OneMillion;
+        }
+        if (params.endTime) {
+            // milliseconds 10^-3 to nanoseconds 10^-9
+            endTime = BigInt(params.endTime.valueOf()) * OneMillion;
+        }
+        return new HistoryRPC({
+            requestId: uuid(),
+            query: {
+                pubSubTopic: params.pubSubTopic,
+                contentFilters,
+                pagingInfo,
+                startTime,
+                endTime,
+            },
+            response: undefined,
+        });
+    }
+    decode(bytes) {
+        const res = proto.HistoryRPC.decode(bytes);
+        return new HistoryRPC(res);
+    }
+    encode() {
+        return proto.HistoryRPC.encode(this.proto);
+    }
+}
+function directionToProto(pageDirection) {
+    switch (pageDirection) {
+        case PageDirection.BACKWARD:
+            return proto.PagingInfo.Direction.DIRECTION_BACKWARD_UNSPECIFIED;
+        case PageDirection.FORWARD:
+            return proto.PagingInfo.Direction.DIRECTION_FORWARD;
+        default:
+            return proto.PagingInfo.Direction.DIRECTION_BACKWARD_UNSPECIFIED;
+    }
+}
+//# sourceMappingURL=history_rpc.js.map

package/dist/lib/waku_store/history_rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"history_rpc.js","sourceRoot":"","sources":["../../../src/lib/waku_store/history_rpc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAS,CAAC,CAAC;AAErC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;AACrB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAYD,MAAM,OAAO,UAAU;IACrB,YAAoC,KAAuB;QAAvB,UAAK,GAAL,KAAK,CAAkB;IAAG,CAAC;IAE/D,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,MAAc;QAC/B,MAAM,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;YAC/D,OAAO,EAAE,YAAY,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEzD,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;YACjC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,SAAS;SACU,CAAC;QAEtB,IAAI,SAAS,EAAE,OAAO,CAAC;QACvB,IAAI,MAAM,CAAC,SAAS,EAAE;YACpB,0CAA0C;YAC1C,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC;SAC7D;QAED,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,0CAA0C;YAC1C,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC;SACzD;QACD,OAAO,IAAI,UAAU,CAAC;YACpB,SAAS,EAAE,IAAI,EAAE;YACjB,KAAK,EAAE;gBACL,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,cAAc;gBACd,UAAU;gBACV,SAAS;gBACT,OAAO;aACR;YACD,QAAQ,EAAE,SAAS;SACpB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAqB;QAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM;QACJ,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,SAAS,gBAAgB,CACvB,aAA4B;IAE5B,QAAQ,aAAa,EAAE;QACrB,KAAK,aAAa,CAAC,QAAQ;YACzB,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC;QACnE,KAAK,aAAa,CAAC,OAAO;YACxB,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC;QACtD;YACE,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC;KACpE;AACH,CAAC"}

package/dist/lib/waku_store/index.d.ts

@@ -0,0 +1,126 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import { Peer } from "@libp2p/interface-peer-store";
+import { Decoder, Message } from "@waku/interfaces";
+import { Libp2p } from "libp2p";
+import { PageDirection } from "./history_rpc";
+export declare const StoreCodec = "/vac/waku/store/2.0.0-beta4";
+export declare const DefaultPageSize = 10;
+export { PageDirection };
+export interface CreateOptions {
+    /**
+     * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}.
+     *
+     * The usage of the default pubsub topic is recommended.
+     * See [Waku v2 Topic Usage Recommendations](https://rfc.vac.dev/spec/23/) for details.
+     *
+     * @default {@link DefaultPubSubTopic}
+     */
+    pubSubTopic?: string;
+}
+export interface TimeFilter {
+    startTime: Date;
+    endTime: Date;
+}
+export interface QueryOptions {
+    /**
+     * The peer to query. If undefined, a pseudo-random peer is selected from the connected Waku Store peers.
+     */
+    peerId?: PeerId;
+    /**
+     * The pubsub topic to pass to the query.
+     * See [Waku v2 Topic Usage Recommendations](https://rfc.vac.dev/spec/23/).
+     */
+    pubSubTopic?: string;
+    /**
+     * 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;
+}
+/**
+ * Implements the [Waku v2 Store protocol](https://rfc.vac.dev/spec/13/).
+ *
+ * The Waku Store protocol can be used to retrieved historical messages.
+ */
+export declare class WakuStore {
+    libp2p: Libp2p;
+    pubSubTopic: string;
+    constructor(libp2p: Libp2p, options?: CreateOptions);
+    /**
+     * Do a query to a Waku Store to retrieve historical/missed messages.
+     *
+     * The callback function takes a `WakuMessage` in input,
+     * messages are processed in order:
+     * - oldest to latest if `options.pageDirection` == { @link PageDirection.FORWARD }
+     * - latest to oldest if `options.pageDirection` == { @link PageDirection.BACKWARD }
+     *
+     * The ordering may affect performance.
+     * The ordering depends on the behavior of the remote store node.
+     * If strong ordering is needed, you may need to handle this at application level
+     * and set your own timestamps too (the WakuMessage timestamps are not certified).
+     *
+     * @throws If not able to reach a Waku Store peer to query,
+     * or if an error is encountered when processing the reply,
+     * or if two decoders with the same content topic are passed.
+     */
+    queryOrderedCallback<T extends Message>(decoders: Decoder<T>[], callback: (message: T) => Promise<void | boolean> | boolean | void, options?: QueryOptions): Promise<void>;
+    /**
+     * Do a query to a Waku Store to retrieve historical/missed messages.
+     *
+     * The callback function takes a `Promise<WakuMessage>` in input,
+     * useful if messages needs to be decrypted and performance matters.
+     *
+     * The order of the messages passed to the callback is as follows:
+     * - within a page, messages are expected to be ordered from oldest to most recent
+     * - pages direction depends on { @link QueryOptions.pageDirection }
+     *
+     * Do note that the resolution of the `Promise<WakuMessage | undefined` may
+     * break the order as it may rely on the browser decryption API, which in turn,
+     * may have a different speed depending on the type of decryption.
+     *
+     * @throws If not able to reach a Waku Store peer to query,
+     * or if an error is encountered when processing the reply,
+     * or if two decoders with the same content topic are passed.
+     */
+    queryCallbackOnPromise<T extends Message>(decoders: Decoder<T>[], callback: (message: Promise<T | undefined>) => Promise<void | boolean> | boolean | void, options?: QueryOptions): Promise<void>;
+    /**
+     * Do a query to a Waku Store to retrieve historical/missed messages.
+     *
+     * This is a generator, useful if you want most control on how messages
+     * are processed.
+     *
+     * The order of the messages returned by the remote Waku node SHOULD BE
+     * as follows:
+     * - within a page, messages SHOULD be ordered from oldest to most recent
+     * - pages direction depends on { @link QueryOptions.pageDirection }
+     *
+     * However, there is no way to guarantee the behavior of the remote node.
+     *
+     * @throws If not able to reach a Waku Store peer to query,
+     * or if an error is encountered when processing the reply,
+     * or if two decoders with the same content topic are passed.
+     */
+    queryGenerator<T extends Message>(decoders: Decoder<T>[], options?: QueryOptions): AsyncGenerator<Promise<T | undefined>[]>;
+    /**
+     * Returns known peers from the address book (`libp2p.peerStore`) that support
+     * store protocol. Waku may or  may not be currently connected to these peers.
+     */
+    peers(): Promise<Peer[]>;
+}
+export declare function isDefined<T>(msg: T | undefined): msg is T;