@waku/core 0.0.9 → 0.0.11

package/dist/lib/waku.js

@@ -1,70 +1,34 @@
 import { Protocols } from "@waku/interfaces";
-import { PeerExchangeCodec } from "@waku/peer-exchange";
 import debug from "debug";
-import { FilterCodec } from "./filter/index.js";
-import { LightPushCodec } from "./light_push/index.js";
-import { createEncoder } from "./message/version_0.js";
+import { ConnectionManager } from "./connection_manager.js";
 import * as relayConstants from "./relay/constants.js";
-import { RelayCodecs, RelayPingContentTopic } from "./relay/constants.js";
-import { StoreCodec } from "./store/index.js";
 export const DefaultPingKeepAliveValueSecs = 0;
 export const DefaultRelayKeepAliveValueSecs = 5 * 60;
 export const DefaultUserAgent = "js-waku";
 const log = debug("waku:waku");
 export class WakuNode {
-    constructor(options, libp2p, store, lightPush, filter, peerExchange) {
+    constructor(options, libp2p, store, lightPush, filter) {
         this.libp2p = libp2p;
-        const { peerStore, connectionManager, registrar } = libp2p;
-        const components = { peerStore, connectionManager, registrar };
         if (store) {
-            this.store = store(components);
+            this.store = store(libp2p);
         }
         if (filter) {
-            this.filter = filter(components);
+            this.filter = filter(libp2p);
         }
         if (lightPush) {
-            this.lightPush = lightPush(components);
-        }
-        if (peerExchange) {
-            this.peerExchange = peerExchange(components);
+            this.lightPush = lightPush(libp2p);
         }
         if (isRelay(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}, peer exchange: ${!!this
-            .peerExchange} `);
-        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);
-        });
-        // Trivial handling of discovered peers, to be refined.
-        libp2p.addEventListener("peer:discovery", (evt) => {
-            const peerId = evt.detail.id;
-            log(`Found peer ${peerId.toString()}, dialing.`);
-            libp2p.dial(peerId).catch((err) => {
-                log(`Fail to dial ${peerId}`, err);
-            });
-        });
+        const peerId = this.libp2p.peerId.toString();
+        this.connectionManager = ConnectionManager.create(peerId, libp2p, { pingKeepAlive, relayKeepAlive }, this.relay);
+        log("Waku node created", peerId, `relay: ${!!this.relay}, store: ${!!this.store}, light push: ${!!this
+            .lightPush}, filter: ${!!this.filter}`);
     }
     /**
      * Dials to the provided peer.
@@ -79,23 +43,39 @@ export class WakuNode {
             this.store && _protocols.push(Protocols.Store);
             this.filter && _protocols.push(Protocols.Filter);
             this.lightPush && _protocols.push(Protocols.LightPush);
-            this.peerExchange && _protocols.push(Protocols.PeerExchange);
         }
         const codecs = [];
         if (_protocols.includes(Protocols.Relay)) {
-            RelayCodecs.forEach((codec) => codecs.push(codec));
+            if (this.relay) {
+                this.relay.multicodecs.forEach((codec) => codecs.push(codec));
+            }
+            else {
+                log("Relay codec not included in dial codec: protocol not mounted locally");
+            }
         }
         if (_protocols.includes(Protocols.Store)) {
-            codecs.push(StoreCodec);
+            if (this.store) {
+                codecs.push(this.store.multicodec);
+            }
+            else {
+                log("Store codec not included in dial codec: protocol not mounted locally");
+            }
         }
         if (_protocols.includes(Protocols.LightPush)) {
-            codecs.push(LightPushCodec);
+            if (this.lightPush) {
+                codecs.push(this.lightPush.multicodec);
+            }
+            else {
+                log("Light Push codec not included in dial codec: protocol not mounted locally");
+            }
         }
         if (_protocols.includes(Protocols.Filter)) {
-            codecs.push(FilterCodec);
-        }
-        if (_protocols.includes(Protocols.PeerExchange)) {
-            codecs.push(PeerExchangeCodec);
+            if (this.filter) {
+                codecs.push(this.filter.multicodec);
+            }
+            else {
+                log("Filter codec not included in dial codec: protocol not mounted locally");
+            }
         }
         log(`Dialing to ${peer.toString()} with protocols ${_protocols}`);
         return this.libp2p.dialProtocol(peer, codecs);
@@ -104,7 +84,7 @@ export class WakuNode {
         await this.libp2p.start();
     }
     async stop() {
-        this.stopAllKeepAlives();
+        this.connectionManager.stop();
         await this.libp2p.stop();
     }
     isStarted() {
@@ -124,49 +104,6 @@ export class WakuNode {
         }
         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 = createEncoder(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 isRelay(pubsub) {
     if (pubsub) {

package/dist/lib/waku.js.map

@@ -1 +1 @@
-{"version":3,"file":"waku.js","sourceRoot":"","sources":["../../src/lib/waku.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,WAAW,EAAoB,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAuB,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAmB,MAAM,kBAAkB,CAAC;AAE/D,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAG,EAAE,CAAC;AACrD,MAAM,CAAC,MAAM,gBAAgB,GAAG,SAAS,CAAC;AAE1C,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAwB/B,MAAM,OAAO,QAAQ;IAenB,YACE,OAAoB,EACpB,MAAc,EACd,KAA+C,EAC/C,SAA2D,EAC3D,MAAkD,EAClD,YAAoE;QAEpE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC3D,MAAM,UAAU,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,CAAC;QAE/D,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;SAChC;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;SAClC;QACD,IAAI,SAAS,EAAE;YACb,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;SACxC;QAED,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;SAC9C;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC1B,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,oBAAoB,CAAC,CAAC,IAAI;aAC7D,YAAY,GAAG,CACnB,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;QAEH,uDAAuD;QACvD,MAAM,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE;YAChD,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,GAAG,CAAC,cAAc,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;YACjD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChC,GAAG,CAAC,gBAAgB,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,IAAwB,EACxB,SAAuB;QAEvB,MAAM,UAAU,GAAG,SAAS,IAAI,EAAE,CAAC;QAEnC,IAAI,OAAO,SAAS,KAAK,WAAW,EAAE;YACpC,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACjD,IAAI,CAAC,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YACvD,IAAI,CAAC,YAAY,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SAC9D;QAED,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,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE;YAC/C,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;SAChC;QAED,GAAG,CAAC,cAAc,IAAI,CAAC,QAAQ,EAAE,mBAAmB,UAAU,EAAE,CAAC,CAAC;QAElE,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,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,aAAa,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,OAAO,CAAC,MAAc;IAC7B,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"}
+{"version":3,"file":"waku.js","sourceRoot":"","sources":["../../src/lib/waku.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAC;AAEvD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,GAAG,EAAE,CAAC;AACrD,MAAM,CAAC,MAAM,gBAAgB,GAAG,SAAS,CAAC;AAE1C,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAwB/B,MAAM,OAAO,QAAQ;IAQnB,YACE,OAAoB,EACpB,MAAc,EACd,KAAkC,EAClC,SAA0C,EAC1C,MAAoC;QAEpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;SAC5B;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;SAC9B;QACD,IAAI,SAAS,EAAE;YACb,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;SACpC;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC1B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;SAC5B;QAED,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,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,MAAM,CAC/C,MAAM,EACN,MAAM,EACN,EAAE,aAAa,EAAE,cAAc,EAAE,EACjC,IAAI,CAAC,KAAK,CACX,CAAC;QAEF,GAAG,CACD,mBAAmB,EACnB,MAAM,EACN,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;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,IAAwB,EACxB,SAAuB;QAEvB,MAAM,UAAU,GAAG,SAAS,IAAI,EAAE,CAAC;QAEnC,IAAI,OAAO,SAAS,KAAK,WAAW,EAAE;YACpC,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACjD,IAAI,CAAC,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACxD;QAED,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YACxC,IAAI,IAAI,CAAC,KAAK,EAAE;gBACd,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;aAC/D;iBAAM;gBACL,GAAG,CACD,sEAAsE,CACvE,CAAC;aACH;SACF;QACD,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YACxC,IAAI,IAAI,CAAC,KAAK,EAAE;gBACd,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;aACpC;iBAAM;gBACL,GAAG,CACD,sEAAsE,CACvE,CAAC;aACH;SACF;QACD,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAC5C,IAAI,IAAI,CAAC,SAAS,EAAE;gBAClB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;aACxC;iBAAM;gBACL,GAAG,CACD,2EAA2E,CAC5E,CAAC;aACH;SACF;QACD,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YACzC,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;aACrC;iBAAM;gBACL,GAAG,CACD,uEAAuE,CACxE,CAAC;aACH;SACF;QAED,GAAG,CAAC,cAAc,IAAI,CAAC,QAAQ,EAAE,mBAAmB,UAAU,EAAE,CAAC,CAAC;QAElE,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC9B,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;CACF;AAED,SAAS,OAAO,CAAC,MAAc;IAC7B,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/core",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "TypeScript implementation of the Waku v2 protocol",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -20,6 +20,10 @@
     "./lib/message/topic_only_message": {
       "types": "./dist/lib/message/topic_only_message.d.ts",
       "import": "./dist/lib/message/topic_only_message.js"
+    },
+    "./lib/base_protocol": {
+      "types": "./dist/lib/base_protocol.d.ts",
+      "import": "./dist/lib/base_protocol.js"
     }
   },
   "typesVersions": {
@@ -53,7 +57,7 @@
     "build:bundle": "rollup --config rollup.config.js",
     "fix": "run-s fix:*",
     "fix:prettier": "prettier . --write",
-    "fix:lint": "eslint src --ext .ts --ext .cjs --fix",
+    "fix:lint": "eslint src *.js --fix",
     "pretest": "run-s pretest:*",
     "pretest:1-init-git-submodules": "[ -f '../../nwaku/build/wakunode2' ] || git submodule update --init --recursive",
     "pretest:2-build-nwaku": "[ -f '../../nwaku/build/wakunode2' ] || run-s nwaku:build",
@@ -61,7 +65,7 @@
     "nwaku:force-build": "(cd ../../nwaku && rm -rf ./build/ ./vendor) && run-s nwaku:build",
     "check": "run-s check:*",
     "check:tsc": "tsc -p tsconfig.dev.json",
-    "check:lint": "eslint src --ext .ts",
+    "check:lint": "eslint src *.js",
     "check:prettier": "prettier . --list-different",
     "check:spelling": "cspell \"{README.md,src/**/*.ts}\"",
     "test": "run-s test:*",
@@ -76,80 +80,65 @@
     "node": ">=16"
   },
   "dependencies": {
-    "@chainsafe/libp2p-gossipsub": "^5.2.1",
-    "@libp2p/interface-connection": "^3.0.3",
-    "@libp2p/interface-peer-discovery": "^1.0.0",
-    "@libp2p/interface-peer-id": "^1.0.6",
-    "@libp2p/interface-peer-info": "^1.0.4",
-    "@libp2p/interface-peer-store": "^1.2.3",
-    "@libp2p/interface-pubsub": "^3.0.1",
-    "@libp2p/interface-registrar": "^2.0.4",
-    "@libp2p/interfaces": "^3.0.4",
-    "@libp2p/peer-id": "^1.1.10",
-    "@multiformats/multiaddr": "^11.0.6",
-    "@noble/hashes": "^1.1.3",
-    "@waku/byte-utils": "*",
-    "@waku/interfaces": "*",
-    "@waku/libp2p-utils": "*",
-    "@waku/peer-exchange": "*",
-    "@waku/proto": "*",
+    "@chainsafe/libp2p-gossipsub": "^6.1.0",
+    "@noble/hashes": "^1.2.0",
+    "@waku/interfaces": "0.0.8",
+    "@waku/proto": "0.0.3",
+    "@waku/utils": "0.0.2",
     "debug": "^4.3.4",
-    "it-all": "^1.0.6",
-    "it-length-prefixed": "^8.0.2",
-    "it-pipe": "^2.0.4",
-    "libp2p": "0.40.0",
-    "chai": "^4.3.4",
-    "fast-check": "^2.14.0",
+    "it-all": "^2.0.0",
+    "it-length-prefixed": "^8.0.4",
+    "it-pipe": "^2.0.5",
     "p-event": "^5.0.1",
-    "uint8arraylist": "^2.3.2",
-    "uint8arrays": "^4.0.2",
+    "uint8arraylist": "^2.4.3",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^22.0.0",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@types/app-root-path": "^1.2.4",
-    "@types/chai": "^4.2.15",
+    "@libp2p/interface-connection": "^3.0.8",
+    "@libp2p/interface-libp2p": "^1.1.1",
+    "@libp2p/interface-peer-id": "^2.0.1",
+    "@libp2p/interface-peer-store": "^1.2.8",
+    "@libp2p/interface-pubsub": "^3.0.6",
+    "@libp2p/interface-registrar": "^2.0.8",
+    "@multiformats/multiaddr": "^11.4.0",
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@types/chai": "^4.3.4",
     "@types/debug": "^4.1.7",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^18.11.17",
-    "@types/tail": "^2.0.0",
-    "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^5.8.1",
-    "@typescript-eslint/parser": "^5.8.1",
-    "app-root-path": "^3.0.0",
-    "cspell": "^6.17.0",
-    "eslint": "^8.6.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@types/mocha": "^10.0.1",
+    "@types/uuid": "^9.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.51.0",
+    "@waku/build-utils": "*",
+    "chai": "^4.3.7",
+    "cspell": "^6.28.0",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-functional": "^4.0.2",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-prettier": "^4.0.0",
-    "gh-pages": "^3.2.3",
+    "eslint-plugin-functional": "^5.0.4",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "fast-check": "^3.7.0",
     "ignore-loader": "^0.1.2",
     "isomorphic-fetch": "^3.0.0",
-    "jsdom": "^19.0.0",
-    "jsdom-global": "^3.0.2",
-    "karma": "^6.3.12",
-    "karma-chrome-launcher": "^3.1.0",
+    "karma": "^6.4.1",
+    "karma-chrome-launcher": "^3.1.1",
     "karma-mocha": "^2.0.1",
     "karma-webpack": "^5.0.0",
-    "mocha": "^9.1.3",
+    "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "p-timeout": "^6.0.0",
-    "portfinder": "^1.0.28",
-    "prettier": "^2.1.1",
+    "prettier": "^2.8.4",
     "process": "^0.11.10",
-    "puppeteer": "^13.0.1",
-    "rollup": "^2.75.0",
-    "tail": "^2.2.0",
-    "ts-loader": "^9.3.1",
+    "puppeteer": "^19.7.2",
+    "rollup": "^3.15.0",
+    "ts-loader": "^9.4.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.6.3"
+    "typescript": "^4.9.5"
   },
   "peerDependencies": {
-    "@multiformats/multiaddr": "^11.0.6"
+    "@multiformats/multiaddr": "^11.4.0",
+    "libp2p": "^0.42.2"
   },
   "peerDependenciesMeta": {
     "@multiformats/multiaddr": {

package/src/index.ts

@@ -1,9 +1,10 @@
 export { DefaultPubSubTopic } from "./lib/constants.js";
 export { DefaultUserAgent } from "./lib/waku.js";
 
-export {
-  createEncoder,
-  createDecoder,
+export { createEncoder, createDecoder } from "./lib/message/version_0.js";
+export type {
+  Encoder,
+  Decoder,
   DecodedMessage,
 } from "./lib/message/version_0.js";
 export * as message from "./lib/message/index.js";
@@ -29,3 +30,10 @@ export {
 } from "./lib/store/index.js";
 
 export { waitForRemotePeer } from "./lib/wait_for_remote_peer.js";
+
+export { ConnectionManager } from "./lib/connection_manager.js";
+
+export {
+  KeepAliveManager,
+  KeepAliveOptions,
+} from "./lib/keep_alive_manager.js";

package/src/lib/base_protocol.ts

@@ -0,0 +1,47 @@
+import type { Connection, Stream } from "@libp2p/interface-connection";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import { Peer, PeerStore } from "@libp2p/interface-peer-store";
+import {
+  getPeersForProtocol,
+  selectConnection,
+  selectPeerForProtocol,
+} from "@waku/utils/libp2p";
+
+/**
+ * A class with predefined helpers, to be used as a base to implement Waku
+ * Protocols.
+ */
+export class BaseProtocol {
+  constructor(
+    public multicodec: string,
+    public peerStore: PeerStore,
+    protected getConnections: (peerId?: PeerId) => Connection[]
+  ) {}
+
+  /**
+   * Returns known peers from the address book (`libp2p.peerStore`) that support
+   * the class protocol. Waku may or may not be currently connected to these
+   * peers.
+   */
+  async peers(): Promise<Peer[]> {
+    return getPeersForProtocol(this.peerStore, [this.multicodec]);
+  }
+
+  protected async getPeer(peerId?: PeerId): Promise<Peer> {
+    const { peer } = await selectPeerForProtocol(
+      this.peerStore,
+      [this.multicodec],
+      peerId
+    );
+    return peer;
+  }
+  protected async newStream(peer: Peer): Promise<Stream> {
+    const connections = this.getConnections(peer.id);
+    const connection = selectConnection(connections);
+    if (!connection) {
+      throw new Error("Failed to get a connection to the peer");
+    }
+
+    return connection.newStream(this.multicodec);
+  }
+}

package/src/lib/connection_manager.ts

@@ -0,0 +1,220 @@
+import type { Connection } from "@libp2p/interface-connection";
+import type { Libp2p } from "@libp2p/interface-libp2p";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { PeerInfo } from "@libp2p/interface-peer-info";
+import type { ConnectionManagerOptions, IRelay } from "@waku/interfaces";
+import { Tags } from "@waku/interfaces";
+import debug from "debug";
+
+import { KeepAliveManager, KeepAliveOptions } from "./keep_alive_manager.js";
+
+const log = debug("waku:connection-manager");
+
+export const DEFAULT_MAX_BOOTSTRAP_PEERS_ALLOWED = 1;
+export const DEFAULT_MAX_DIAL_ATTEMPTS_FOR_PEER = 3;
+
+export class ConnectionManager {
+  private static instances = new Map<string, ConnectionManager>();
+  private keepAliveManager: KeepAliveManager;
+  private options: ConnectionManagerOptions;
+  private libp2pComponents: Libp2p;
+  private dialAttemptsForPeer: Map<string, number> = new Map();
+
+  public static create(
+    peerId: string,
+    libp2p: Libp2p,
+    keepAliveOptions: KeepAliveOptions,
+    relay?: IRelay,
+    options?: ConnectionManagerOptions
+  ): ConnectionManager {
+    let instance = ConnectionManager.instances.get(peerId);
+    if (!instance) {
+      instance = new ConnectionManager(
+        libp2p,
+        keepAliveOptions,
+        relay,
+        options
+      );
+      ConnectionManager.instances.set(peerId, instance);
+    }
+
+    return instance;
+  }
+
+  private constructor(
+    libp2pComponents: Libp2p,
+    keepAliveOptions: KeepAliveOptions,
+    relay?: IRelay,
+    options?: Partial<ConnectionManagerOptions>
+  ) {
+    this.libp2pComponents = libp2pComponents;
+    this.options = {
+      maxDialAttemptsForPeer: DEFAULT_MAX_DIAL_ATTEMPTS_FOR_PEER,
+      maxBootstrapPeersAllowed: DEFAULT_MAX_BOOTSTRAP_PEERS_ALLOWED,
+      ...options,
+    };
+
+    this.keepAliveManager = new KeepAliveManager(keepAliveOptions, relay);
+
+    this.run()
+      .then(() => log(`Connection Manager is now running`))
+      .catch((error) => log(`Unexpected error while running service`, error));
+  }
+
+  private async run(): Promise<void> {
+    // start event listeners
+    this.startPeerDiscoveryListener();
+    this.startPeerConnectionListener();
+    this.startPeerDisconnectionListener();
+  }
+
+  stop(): void {
+    this.keepAliveManager.stopAll();
+    this.libp2pComponents.removeEventListener(
+      "peer:connect",
+      this.onEventHandlers["peer:connect"]
+    );
+    this.libp2pComponents.removeEventListener(
+      "peer:disconnect",
+      this.onEventHandlers["peer:disconnect"]
+    );
+    this.libp2pComponents.removeEventListener(
+      "peer:discovery",
+      this.onEventHandlers["peer:discovery"]
+    );
+  }
+
+  private async dialPeer(peerId: PeerId): Promise<void> {
+    let dialAttempt = 0;
+    while (dialAttempt <= this.options.maxDialAttemptsForPeer) {
+      try {
+        log(`Dialing peer ${peerId.toString()}`);
+        await this.libp2pComponents.dial(peerId);
+
+        const tags = await this.getTagNamesForPeer(peerId);
+        // add tag to connection describing discovery mechanism
+        // don't add duplicate tags
+        this.libp2pComponents
+          .getConnections(peerId)
+          .forEach(
+            (conn) => (conn.tags = Array.from(new Set([...conn.tags, ...tags])))
+          );
+
+        this.dialAttemptsForPeer.delete(peerId.toString());
+        return;
+      } catch (error) {
+        log(`
+          Error dialing peer ${peerId.toString()}`);
+        dialAttempt = this.dialAttemptsForPeer.get(peerId.toString()) ?? 1;
+        this.dialAttemptsForPeer.set(peerId.toString(), dialAttempt + 1);
+
+        if (dialAttempt <= this.options.maxDialAttemptsForPeer) {
+          log(`Reattempting dial (${dialAttempt})`);
+        }
+      }
+    }
+
+    try {
+      log(`Deleting undialable peer ${peerId.toString()} from peer store`);
+      return await this.libp2pComponents.peerStore.delete(peerId);
+    } catch (error) {
+      throw `Error deleting undialable peer ${peerId.toString()} from peer store - ${error}`;
+    }
+  }
+
+  private startPeerDiscoveryListener(): void {
+    this.libp2pComponents.peerStore.addEventListener(
+      "peer",
+      this.onEventHandlers["peer:discovery"]
+    );
+  }
+
+  private startPeerConnectionListener(): void {
+    this.libp2pComponents.addEventListener(
+      "peer:connect",
+      this.onEventHandlers["peer:connect"]
+    );
+  }
+
+  private startPeerDisconnectionListener(): void {
+    // TODO: ensure that these following issues are updated and confirmed
+    /**
+     * 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
+     */
+    this.libp2pComponents.addEventListener(
+      "peer:disconnect",
+      this.onEventHandlers["peer:disconnect"]
+    );
+  }
+
+  private onEventHandlers = {
+    "peer:discovery": async (evt: CustomEvent<PeerInfo>): Promise<void> => {
+      const { id: peerId } = evt.detail;
+      if (!(await this.shouldDialPeer(peerId))) return;
+
+      this.dialPeer(peerId).catch((err) =>
+        log(`Error dialing peer ${peerId.toString()} : ${err}`)
+      );
+    },
+    "peer:connect": (evt: CustomEvent<Connection>): void => {
+      {
+        this.keepAliveManager.start(
+          evt.detail.remotePeer,
+          this.libp2pComponents.ping.bind(this)
+        );
+      }
+    },
+    "peer:disconnect": () => {
+      return (evt: CustomEvent<Connection>): void => {
+        this.keepAliveManager.stop(evt.detail.remotePeer);
+      };
+    },
+  };
+
+  /**
+   * Checks if the peer is dialable based on the following conditions:
+   * 1. If the peer is a bootstrap peer, it is only dialable if the number of current bootstrap connections is less than the max allowed.
+   * 2. If the peer is not a bootstrap peer
+   */
+  private async shouldDialPeer(peerId: PeerId): Promise<boolean> {
+    const isConnected = this.libp2pComponents.getConnections(peerId).length > 0;
+
+    if (isConnected) return false;
+
+    const isBootstrap = (await this.getTagNamesForPeer(peerId)).some(
+      (tagName) => tagName === Tags.BOOTSTRAP
+    );
+
+    if (isBootstrap) {
+      const currentBootstrapConnections = this.libp2pComponents
+        .getConnections()
+        .filter((conn) => {
+          conn.tags.find((name) => name === Tags.BOOTSTRAP);
+        }).length;
+      if (currentBootstrapConnections < this.options.maxBootstrapPeersAllowed)
+        return true;
+    } else {
+      return true;
+    }
+
+    return false;
+  }
+
+  /**
+   * Fetches the tag names for a given peer
+   */
+  private async getTagNamesForPeer(peerId: PeerId): Promise<string[]> {
+    const tags = (await this.libp2pComponents.peerStore.getTags(peerId)).map(
+      (tag) => tag.name
+    );
+    return tags;
+  }
+}