@waku/core 0.0.1

package/dist/lib/utils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Convert input to a byte array.
+ *
+ * Handles both `0x` prefixed and non-prefixed strings.
+ */
+export declare function hexToBytes(hex: string | Uint8Array): Uint8Array;
+/**
+ * Convert byte array to hex string (no `0x` prefix).
+ */
+export declare const bytesToHex: (bytes: Uint8Array) => string;
+/**
+ * Decode byte array to utf-8 string.
+ */
+export declare const bytesToUtf8: (b: Uint8Array) => string;
+/**
+ * Encode utf-8 string to byte array.
+ */
+export declare const utf8ToBytes: (s: string) => Uint8Array;
+/**
+ * Concatenate using Uint8Arrays as `Buffer` has a different behavior with `DataView`
+ */
+export declare function concat(byteArrays: Uint8Array[], totalLength?: number): Uint8Array;

package/dist/lib/utils.js

@@ -0,0 +1,40 @@
+import { fromString } from "uint8arrays/from-string";
+import { toString } from "uint8arrays/to-string";
+/**
+ * Convert input to a byte array.
+ *
+ * Handles both `0x` prefixed and non-prefixed strings.
+ */
+export function hexToBytes(hex) {
+    if (typeof hex === "string") {
+        const _hex = hex.replace(/^0x/i, "");
+        return fromString(_hex.toLowerCase(), "base16");
+    }
+    return hex;
+}
+/**
+ * Convert byte array to hex string (no `0x` prefix).
+ */
+export const bytesToHex = (bytes) => toString(bytes, "base16");
+/**
+ * Decode byte array to utf-8 string.
+ */
+export const bytesToUtf8 = (b) => toString(b, "utf8");
+/**
+ * Encode utf-8 string to byte array.
+ */
+export const utf8ToBytes = (s) => fromString(s, "utf8");
+/**
+ * Concatenate using Uint8Arrays as `Buffer` has a different behavior with `DataView`
+ */
+export function concat(byteArrays, totalLength) {
+    const len = totalLength ?? byteArrays.reduce((acc, curr) => acc + curr.length, 0);
+    const res = new Uint8Array(len);
+    let offset = 0;
+    for (const bytes of byteArrays) {
+        res.set(bytes, offset);
+        offset += bytes.length;
+    }
+    return res;
+}
+//# sourceMappingURL=utils.js.map

package/dist/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,GAAwB;IACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrC,OAAO,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC;KACjD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAiB,EAAU,EAAE,CACtD,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAa,EAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAS,EAAc,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,UAAU,MAAM,CACpB,UAAwB,EACxB,WAAoB;IAEpB,MAAM,GAAG,GACP,WAAW,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACxE,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAEhC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC9B,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;KACxB;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/lib/wait_for_remote_peer.d.ts

@@ -0,0 +1,22 @@
+import type { Waku } from "@waku/interfaces";
+import { Protocols } from "@waku/interfaces";
+/**
+ * Wait for a remote peer to be ready given the passed protocols.
+ * Must be used after attempting to connect to nodes, using
+ * {@link index.waku.WakuNode.dial} or a bootstrap method with
+ * {@link lib/create_waku.createLightNode}.
+ *
+ * If the passed protocols is a GossipSub protocol, then it resolves only once
+ * a peer is in a mesh, to help ensure that other peers will send and receive
+ * message to us.
+ *
+ * @param waku The Waku Node
+ * @param protocols The protocols that need to be enabled by remote peers.
+ * @param timeoutMs A timeout value in milliseconds..
+ *
+ * @returns A promise that **resolves** if all desired protocols are fulfilled by
+ * remote nodes, **rejects** if the timeoutMs is reached.
+ * @throws If passing a protocol that is not mounted
+ * @default Wait for remote peers with protocols enabled locally and no time out is applied.
+ */
+export declare function waitForRemotePeer(waku: Waku, protocols?: Protocols[], timeoutMs?: number): Promise<void>;

package/dist/lib/wait_for_remote_peer.js

@@ -0,0 +1,113 @@
+import { Protocols } from "@waku/interfaces";
+import debug from "debug";
+import { pEvent } from "p-event";
+import { FilterCodec } from "./waku_filter/index.js";
+import { LightPushCodec } from "./waku_light_push/index.js";
+import { StoreCodec } from "./waku_store/index.js";
+const log = debug("waku:wait-for-remote-peer");
+/**
+ * Wait for a remote peer to be ready given the passed protocols.
+ * Must be used after attempting to connect to nodes, using
+ * {@link index.waku.WakuNode.dial} or a bootstrap method with
+ * {@link lib/create_waku.createLightNode}.
+ *
+ * If the passed protocols is a GossipSub protocol, then it resolves only once
+ * a peer is in a mesh, to help ensure that other peers will send and receive
+ * message to us.
+ *
+ * @param waku The Waku Node
+ * @param protocols The protocols that need to be enabled by remote peers.
+ * @param timeoutMs A timeout value in milliseconds..
+ *
+ * @returns A promise that **resolves** if all desired protocols are fulfilled by
+ * remote nodes, **rejects** if the timeoutMs is reached.
+ * @throws If passing a protocol that is not mounted
+ * @default Wait for remote peers with protocols enabled locally and no time out is applied.
+ */
+export async function waitForRemotePeer(waku, protocols, timeoutMs) {
+    protocols = protocols ?? getEnabledProtocols(waku);
+    if (!waku.isStarted())
+        return Promise.reject("Waku node is not started");
+    const promises = [];
+    if (protocols.includes(Protocols.Relay)) {
+        if (!waku.relay)
+            throw new Error("Cannot wait for Relay peer: protocol not mounted");
+        promises.push(waitForGossipSubPeerInMesh(waku.relay));
+    }
+    if (protocols.includes(Protocols.Store)) {
+        if (!waku.store)
+            throw new Error("Cannot wait for Store peer: protocol not mounted");
+        promises.push(waitForConnectedPeer(waku.store, [StoreCodec]));
+    }
+    if (protocols.includes(Protocols.LightPush)) {
+        if (!waku.lightPush)
+            throw new Error("Cannot wait for LightPush peer: protocol not mounted");
+        promises.push(waitForConnectedPeer(waku.lightPush, [LightPushCodec]));
+    }
+    if (protocols.includes(Protocols.Filter)) {
+        if (!waku.filter)
+            throw new Error("Cannot wait for Filter peer: protocol not mounted");
+        promises.push(waitForConnectedPeer(waku.filter, [FilterCodec]));
+    }
+    if (timeoutMs) {
+        await rejectOnTimeout(Promise.all(promises), timeoutMs, "Timed out waiting for a remote peer.");
+    }
+    else {
+        await Promise.all(promises);
+    }
+}
+/**
+ * Wait for a peer with the given protocol to be connected.
+ */
+async function waitForConnectedPeer(waku, codecs) {
+    const peers = await waku.peers();
+    if (peers.length) {
+        log(`${codecs} peer found: `, peers[0].id.toString());
+        return;
+    }
+    await new Promise((resolve) => {
+        const cb = (evt) => {
+            for (const codec of codecs) {
+                if (evt.detail.protocols.includes(codec)) {
+                    log("Resolving for", codec, evt.detail.protocols);
+                    waku.libp2p.peerStore.removeEventListener("change:protocols", cb);
+                    resolve();
+                    break;
+                }
+            }
+        };
+        waku.libp2p.peerStore.addEventListener("change:protocols", cb);
+    });
+}
+/**
+ * Wait for a peer with the given protocol to be connected and in the gossipsub
+ * mesh.
+ */
+async function waitForGossipSubPeerInMesh(waku) {
+    let peers = waku.getMeshPeers();
+    while (peers.length == 0) {
+        await pEvent(waku, "gossipsub:heartbeat");
+        peers = waku.getMeshPeers();
+    }
+}
+const awaitTimeout = (ms, rejectReason) => new Promise((_resolve, reject) => setTimeout(() => reject(rejectReason), ms));
+async function rejectOnTimeout(promise, timeoutMs, rejectReason) {
+    await Promise.race([promise, awaitTimeout(timeoutMs, rejectReason)]);
+}
+function getEnabledProtocols(waku) {
+    const protocols = [];
+    if (waku.relay) {
+        protocols.push(Protocols.Relay);
+    }
+    if (waku.filter) {
+        protocols.push(Protocols.Filter);
+    }
+    if (waku.store) {
+        protocols.push(Protocols.Store);
+    }
+    if (waku.lightPush) {
+        protocols.push(Protocols.LightPush);
+    }
+    return protocols;
+}
+//# sourceMappingURL=wait_for_remote_peer.js.map

package/dist/lib/wait_for_remote_peer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait_for_remote_peer.js","sourceRoot":"","sources":["../../src/lib/wait_for_remote_peer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,GAAG,GAAG,KAAK,CAAC,2BAA2B,CAAC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAU,EACV,SAAuB,EACvB,SAAkB;IAElB,SAAS,GAAG,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEnD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;QAAE,OAAO,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;IAEzE,MAAM,QAAQ,GAAG,EAAE,CAAC;IAEpB,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,QAAQ,CAAC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;KACvD;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;KAC/D;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;QAC3C,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;KACvE;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QACxC,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KACjE;IAED,IAAI,SAAS,EAAE;QACb,MAAM,eAAe,CACnB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EACrB,SAAS,EACT,sCAAsC,CACvC,CAAC;KACH;SAAM;QACL,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KAC7B;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,oBAAoB,CACjC,IAA0B,EAC1B,MAAgB;IAEhB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IAEjC,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,GAAG,CAAC,GAAG,MAAM,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtD,OAAO;KACR;IAED,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAClC,MAAM,EAAE,GAAG,CAAC,GAAyC,EAAQ,EAAE;YAC7D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;gBAC1B,IAAI,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBACxC,GAAG,CAAC,eAAe,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;oBAClE,OAAO,EAAE,CAAC;oBACV,MAAM;iBACP;aACF;QACH,CAAC,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,0BAA0B,CAAC,IAAW;IACnD,IAAI,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IAEhC,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE;QACxB,MAAM,MAAM,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;QAC1C,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;KAC7B;AACH,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAiB,EAAE,CACvE,IAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAEhF,KAAK,UAAU,eAAe,CAC5B,OAAmB,EACnB,SAAiB,EACjB,YAAoB;IAEpB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAU;IACrC,MAAM,SAAS,GAAG,EAAE,CAAC;IAErB,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;KACjC;IAED,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KAClC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;KACjC;IAED,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;KACrC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/lib/waku.d.ts

@@ -0,0 +1,61 @@
+import type { Stream } from "@libp2p/interface-connection";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+import type { Waku } from "@waku/interfaces";
+import { Protocols } from "@waku/interfaces";
+import type { Libp2p } from "libp2p";
+import { WakuFilter } from "./waku_filter";
+import { WakuLightPush } from "./waku_light_push";
+import { WakuRelay } from "./waku_relay";
+import { WakuStore } from "./waku_store";
+export declare const DefaultPingKeepAliveValueSecs = 0;
+export declare const DefaultRelayKeepAliveValueSecs: number;
+export interface WakuOptions {
+    /**
+     * Set keep alive frequency in seconds: Waku will send a `/ipfs/ping/1.0.0`
+     * request to each peer after the set number of seconds. Set to 0 to disable.
+     *
+     * @default {@link DefaultPingKeepAliveValueSecs}
+     */
+    pingKeepAlive?: number;
+    /**
+     * Set keep alive frequency in seconds: Waku will send a ping message over
+     * relay to each peer after the set number of seconds. Set to 0 to disable.
+     *
+     * @default {@link DefaultRelayKeepAliveValueSecs}
+     */
+    relayKeepAlive?: number;
+}
+export declare class WakuNode implements Waku {
+    libp2p: Libp2p;
+    relay?: WakuRelay;
+    store?: WakuStore;
+    filter?: WakuFilter;
+    lightPush?: WakuLightPush;
+    private pingKeepAliveTimers;
+    private relayKeepAliveTimers;
+    constructor(options: WakuOptions, libp2p: Libp2p, store?: WakuStore, lightPush?: WakuLightPush, filter?: WakuFilter);
+    /**
+     * Dials to the provided peer.
+     *
+     * @param peer The peer to dial
+     * @param protocols Waku protocols we expect from the peer; Default to Relay
+     */
+    dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
+    /**
+     * Add peer to address book, it will be auto-dialed in the background.
+     */
+    addPeerToAddressBook(peerId: PeerId | string, multiaddrs: Multiaddr[] | string[]): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    isStarted(): boolean;
+    /**
+     * Return the local multiaddr with peer id on which libp2p is listening.
+     *
+     * @throws if libp2p is not listening on localhost.
+     */
+    getLocalMultiaddrWithID(): string;
+    private startKeepAlive;
+    private stopKeepAlive;
+    private stopAllKeepAlives;
+}

package/dist/lib/waku.js

@@ -0,0 +1,174 @@
+import { peerIdFromString } from "@libp2p/peer-id";
+import { multiaddr } from "@multiformats/multiaddr";
+import { Protocols } from "@waku/interfaces";
+import debug from "debug";
+import { FilterCodec } from "./waku_filter/index.js";
+import { LightPushCodec } from "./waku_light_push/index.js";
+import { EncoderV0 } from "./waku_message/version_0.js";
+import { RelayCodecs, RelayPingContentTopic } from "./waku_relay/constants.js";
+import * as relayConstants from "./waku_relay/constants.js";
+import { StoreCodec } from "./waku_store/index.js";
+export const DefaultPingKeepAliveValueSecs = 0;
+export const DefaultRelayKeepAliveValueSecs = 5 * 60;
+const log = debug("waku:waku");
+export class WakuNode {
+    constructor(options, libp2p, store, lightPush, filter) {
+        this.libp2p = libp2p;
+        this.store = store;
+        this.filter = filter;
+        this.lightPush = lightPush;
+        if (isWakuRelay(libp2p.pubsub)) {
+            this.relay = libp2p.pubsub;
+        }
+        log("Waku node created", this.libp2p.peerId.toString(), `relay: ${!!this.relay}, store: ${!!this.store}, light push: ${!!this
+            .lightPush}, filter: ${!!this.filter}`);
+        this.pingKeepAliveTimers = {};
+        this.relayKeepAliveTimers = {};
+        const pingKeepAlive = options.pingKeepAlive || DefaultPingKeepAliveValueSecs;
+        const relayKeepAlive = this.relay
+            ? options.relayKeepAlive || DefaultRelayKeepAliveValueSecs
+            : 0;
+        libp2p.connectionManager.addEventListener("peer:connect", (evt) => {
+            this.startKeepAlive(evt.detail.remotePeer, pingKeepAlive, relayKeepAlive);
+        });
+        /**
+         * NOTE: Event is not being emitted on closing nor losing a connection.
+         * @see https://github.com/libp2p/js-libp2p/issues/939
+         * @see https://github.com/status-im/js-waku/issues/252
+         *
+         * >This event will be triggered anytime we are disconnected from another peer,
+         * >regardless of the circumstances of that disconnection.
+         * >If we happen to have multiple connections to a peer,
+         * >this event will **only** be triggered when the last connection is closed.
+         * @see https://github.com/libp2p/js-libp2p/blob/bad9e8c0ff58d60a78314077720c82ae331cc55b/doc/API.md?plain=1#L2100
+         */
+        libp2p.connectionManager.addEventListener("peer:disconnect", (evt) => {
+            this.stopKeepAlive(evt.detail.remotePeer);
+        });
+    }
+    /**
+     * Dials to the provided peer.
+     *
+     * @param peer The peer to dial
+     * @param protocols Waku protocols we expect from the peer; Default to Relay
+     */
+    async dial(peer, protocols) {
+        const _protocols = protocols ?? [Protocols.Relay];
+        const codecs = [];
+        if (_protocols.includes(Protocols.Relay)) {
+            RelayCodecs.forEach((codec) => codecs.push(codec));
+        }
+        if (_protocols.includes(Protocols.Store)) {
+            codecs.push(StoreCodec);
+        }
+        if (_protocols.includes(Protocols.LightPush)) {
+            codecs.push(LightPushCodec);
+        }
+        if (_protocols.includes(Protocols.Filter)) {
+            codecs.push(FilterCodec);
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore: new Multiaddr is not backward compatible
+        return this.libp2p.dialProtocol(peer, codecs);
+    }
+    /**
+     * Add peer to address book, it will be auto-dialed in the background.
+     */
+    async addPeerToAddressBook(peerId, multiaddrs) {
+        let peer;
+        if (typeof peerId === "string") {
+            peer = peerIdFromString(peerId);
+        }
+        else {
+            peer = peerId;
+        }
+        const addresses = multiaddrs.map((addr) => {
+            if (typeof addr === "string") {
+                return multiaddr(addr);
+            }
+            else {
+                return addr;
+            }
+        });
+        await this.libp2p.peerStore.addressBook.set(peer, addresses);
+    }
+    async start() {
+        await this.libp2p.start();
+    }
+    async stop() {
+        this.stopAllKeepAlives();
+        await this.libp2p.stop();
+    }
+    isStarted() {
+        return this.libp2p.isStarted();
+    }
+    /**
+     * Return the local multiaddr with peer id on which libp2p is listening.
+     *
+     * @throws if libp2p is not listening on localhost.
+     */
+    getLocalMultiaddrWithID() {
+        const localMultiaddr = this.libp2p
+            .getMultiaddrs()
+            .find((addr) => addr.toString().match(/127\.0\.0\.1/));
+        if (!localMultiaddr || localMultiaddr.toString() === "") {
+            throw "Not listening on localhost";
+        }
+        return localMultiaddr + "/p2p/" + this.libp2p.peerId.toString();
+    }
+    startKeepAlive(peerId, pingPeriodSecs, relayPeriodSecs) {
+        // Just in case a timer already exist for this peer
+        this.stopKeepAlive(peerId);
+        const peerIdStr = peerId.toString();
+        if (pingPeriodSecs !== 0) {
+            this.pingKeepAliveTimers[peerIdStr] = setInterval(() => {
+                this.libp2p.ping(peerId).catch((e) => {
+                    log(`Ping failed (${peerIdStr})`, e);
+                });
+            }, pingPeriodSecs * 1000);
+        }
+        const relay = this.relay;
+        if (relay && relayPeriodSecs !== 0) {
+            const encoder = new EncoderV0(RelayPingContentTopic);
+            this.relayKeepAliveTimers[peerIdStr] = setInterval(() => {
+                log("Sending Waku Relay ping message");
+                relay
+                    .send(encoder, { payload: new Uint8Array() })
+                    .catch((e) => log("Failed to send relay ping", e));
+            }, relayPeriodSecs * 1000);
+        }
+    }
+    stopKeepAlive(peerId) {
+        const peerIdStr = peerId.toString();
+        if (this.pingKeepAliveTimers[peerIdStr]) {
+            clearInterval(this.pingKeepAliveTimers[peerIdStr]);
+            delete this.pingKeepAliveTimers[peerIdStr];
+        }
+        if (this.relayKeepAliveTimers[peerIdStr]) {
+            clearInterval(this.relayKeepAliveTimers[peerIdStr]);
+            delete this.relayKeepAliveTimers[peerIdStr];
+        }
+    }
+    stopAllKeepAlives() {
+        for (const timer of [
+            ...Object.values(this.pingKeepAliveTimers),
+            ...Object.values(this.relayKeepAliveTimers),
+        ]) {
+            clearInterval(timer);
+        }
+        this.pingKeepAliveTimers = {};
+        this.relayKeepAliveTimers = {};
+    }
+}
+function isWakuRelay(pubsub) {
+    if (pubsub) {
+        try {
+            return pubsub.multicodecs.includes(relayConstants.RelayCodecs[relayConstants.RelayCodecs.length - 1]);
+            // Exception is expected if `libp2p` was not instantiated with pubsub
+            // eslint-disable-next-line no-empty
+        }
+        catch (e) { }
+    }
+    return false;
+}
+//# sourceMappingURL=waku.js.map

package/dist/lib/waku.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waku.js","sourceRoot":"","sources":["../../src/lib/waku.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,WAAW,EAAc,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,cAAc,EAAiB,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,KAAK,cAAc,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAa,MAAM,cAAc,CAAC;AAErD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAG,EAAE,CAAC;AAErD,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAmB/B,MAAM,OAAO,QAAQ;IAcnB,YACE,OAAoB,EACpB,MAAc,EACd,KAAiB,EACjB,SAAyB,EACzB,MAAmB;QAEnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;SAC5B;QAED,GAAG,CACD,mBAAmB,EACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAC7B,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,iBAAiB,CAAC,CAAC,IAAI;aAClE,SAAS,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CACzC,CAAC;QAEF,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAE/B,MAAM,aAAa,GACjB,OAAO,CAAC,aAAa,IAAI,6BAA6B,CAAC;QACzD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK;YAC/B,CAAC,CAAC,OAAO,CAAC,cAAc,IAAI,8BAA8B;YAC1D,CAAC,CAAC,CAAC,CAAC;QAEN,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE;YAChE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH;;;;;;;;;;WAUG;QACH,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,EAAE;YACnE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,IAAwB,EACxB,SAAuB;QAEvB,MAAM,UAAU,GAAG,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAElD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YACxC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;SACpD;QACD,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACzB;QACD,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAC5C,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SAC7B;QACD,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC1B;QAED,6DAA6D;QAC7D,uDAAuD;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CACxB,MAAuB,EACvB,UAAkC;QAElC,IAAI,IAAI,CAAC;QACT,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;SACjC;aAAM;YACL,IAAI,GAAG,MAAM,CAAC;SACf;QACD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAwB,EAAE,EAAE;YAC5D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;aACxB;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,uBAAuB;QACrB,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM;aAC/B,aAAa,EAAE;aACf,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YACvD,MAAM,4BAA4B,CAAC;SACpC;QACD,OAAO,cAAc,GAAG,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IAClE,CAAC;IAEO,cAAc,CACpB,MAAc,EACd,cAAsB,EACtB,eAAuB;QAEvB,mDAAmD;QACnD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE3B,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAEpC,IAAI,cAAc,KAAK,CAAC,EAAE;YACxB,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE;gBACrD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnC,GAAG,CAAC,gBAAgB,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;YACL,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC,CAAC;SAC3B;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,KAAK,IAAI,eAAe,KAAK,CAAC,EAAE;YAClC,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAC;YACrD,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE;gBACtD,GAAG,CAAC,iCAAiC,CAAC,CAAC;gBACvC,KAAK;qBACF,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,UAAU,EAAE,EAAE,CAAC;qBAC5C,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC,CAAC;YACvD,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC,CAAC;SAC5B;IACH,CAAC;IAEO,aAAa,CAAC,MAAc;QAClC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAEpC,IAAI,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE;YACvC,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;SAC5C;QAED,IAAI,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE;YACxC,aAAa,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;SAC7C;IACH,CAAC;IAEO,iBAAiB;QACvB,KAAK,MAAM,KAAK,IAAI;YAClB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAC1C,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC;SAC5C,EAAE;YACD,aAAa,CAAC,KAAK,CAAC,CAAC;SACtB;QAED,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;IACjC,CAAC;CACF;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,IAAI,MAAM,EAAE;QACV,IAAI;YACF,OAAO,MAAM,CAAC,WAAW,CAAC,QAAQ,CAChC,cAAc,CAAC,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAClE,CAAC;YACF,qEAAqE;YACrE,oCAAoC;SACrC;QAAC,OAAO,CAAC,EAAE,GAAE;KACf;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/lib/waku_filter/filter_rpc.d.ts

@@ -0,0 +1,25 @@
+import * as proto from "../../proto/filter";
+export declare type ContentFilter = {
+    contentTopic: string;
+};
+/**
+ * FilterRPC represents a message conforming to the Waku Filter protocol
+ */
+export declare class FilterRPC {
+    proto: proto.FilterRPC;
+    constructor(proto: proto.FilterRPC);
+    static createRequest(topic: string, contentFilters: ContentFilter[], requestId?: string, subscribe?: boolean): FilterRPC;
+    /**
+     *
+     * @param bytes Uint8Array of bytes from a FilterRPC message
+     * @returns FilterRPC
+     */
+    static decode(bytes: Uint8Array): FilterRPC;
+    /**
+     * Encode the current FilterRPC request to bytes
+     * @returns Uint8Array
+     */
+    encode(): Uint8Array;
+    get push(): proto.MessagePush | undefined;
+    get requestId(): string | undefined;
+}

package/dist/lib/waku_filter/filter_rpc.js

@@ -0,0 +1,44 @@
+import { v4 as uuid } from "uuid";
+import * as proto from "../../proto/filter.js";
+/**
+ * FilterRPC represents a message conforming to the Waku Filter protocol
+ */
+export class FilterRPC {
+    constructor(proto) {
+        this.proto = proto;
+    }
+    static createRequest(topic, contentFilters, requestId, subscribe = true) {
+        return new FilterRPC({
+            requestId: requestId || uuid(),
+            request: {
+                subscribe,
+                topic,
+                contentFilters,
+            },
+            push: undefined,
+        });
+    }
+    /**
+     *
+     * @param bytes Uint8Array of bytes from a FilterRPC message
+     * @returns FilterRPC
+     */
+    static decode(bytes) {
+        const res = proto.FilterRPC.decode(bytes);
+        return new FilterRPC(res);
+    }
+    /**
+     * Encode the current FilterRPC request to bytes
+     * @returns Uint8Array
+     */
+    encode() {
+        return proto.FilterRPC.encode(this.proto);
+    }
+    get push() {
+        return this.proto.push;
+    }
+    get requestId() {
+        return this.proto.requestId;
+    }
+}
+//# sourceMappingURL=filter_rpc.js.map

package/dist/lib/waku_filter/filter_rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter_rpc.js","sourceRoot":"","sources":["../../../src/lib/waku_filter/filter_rpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAC;AAM5C;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB,YAA0B,KAAsB;QAAtB,UAAK,GAAL,KAAK,CAAiB;IAAG,CAAC;IAEpD,MAAM,CAAC,aAAa,CAClB,KAAa,EACb,cAA+B,EAC/B,SAAkB,EAClB,SAAS,GAAG,IAAI;QAEhB,OAAO,IAAI,SAAS,CAAC;YACnB,SAAS,EAAE,SAAS,IAAI,IAAI,EAAE;YAC9B,OAAO,EAAE;gBACP,SAAS;gBACT,KAAK;gBACL,cAAc;aACf;YACD,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,KAAiB;QAC7B,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1C,OAAO,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAC9B,CAAC;CACF"}

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

@@ -0,0 +1,50 @@
+import type { Peer } from "@libp2p/interface-peer-store";
+import type { Callback, Decoder, Filter, Message, ProtocolOptions } from "@waku/interfaces";
+import type { Libp2p } from "libp2p";
+import { ContentFilter } from "./filter_rpc";
+export { ContentFilter };
+export declare const FilterCodec = "/vac/waku/filter/2.0.0-beta1";
+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 declare type UnsubscribeFunction = () => Promise<void>;
+/**
+ * Implements client side of the [Waku v2 Filter protocol](https://rfc.vac.dev/spec/12/).
+ *
+ * Note this currently only works in NodeJS when the Waku node is listening on a port, see:
+ * - https://github.com/status-im/go-waku/issues/245
+ * - https://github.com/status-im/nwaku/issues/948
+ */
+export declare class WakuFilter implements Filter {
+    libp2p: Libp2p;
+    pubSubTopic: string;
+    private subscriptions;
+    private decoders;
+    constructor(libp2p: Libp2p, options?: CreateOptions);
+    /**
+     * @param decoders Array of Decoders to use to decode messages, it also specifies the content topics.
+     * @param callback A function that will be called on each message returned by the filter.
+     * @param opts The FilterSubscriptionOpts used to narrow which messages are returned, and which peer to connect to.
+     * @returns Unsubscribe function that can be used to end the subscription.
+     */
+    subscribe<T extends Message>(decoders: Decoder<T>[], callback: Callback<T>, opts?: ProtocolOptions): Promise<UnsubscribeFunction>;
+    private onRequest;
+    private pushMessages;
+    private addCallback;
+    private deleteCallback;
+    private addDecoders;
+    private deleteDecoders;
+    private unsubscribe;
+    private newStream;
+    private getPeer;
+    peers(): Promise<Peer[]>;
+    randomPeer(): Promise<Peer | undefined>;
+}