@waku/discovery 0.0.2-434be7b.0

package/dist/dns/enrtree.d.ts

@@ -0,0 +1,33 @@
+export type ENRRootValues = {
+    eRoot: string;
+    lRoot: string;
+    seq: number;
+    signature: string;
+};
+export type ENRTreeValues = {
+    publicKey: string;
+    domain: string;
+};
+export declare class ENRTree {
+    static readonly RECORD_PREFIX = "enr:";
+    static readonly TREE_PREFIX = "enrtree:";
+    static readonly BRANCH_PREFIX = "enrtree-branch:";
+    static readonly ROOT_PREFIX = "enrtree-root:";
+    /**
+     * Extracts the branch subdomain referenced by a DNS tree root string after verifying
+     * the root record signature with its base32 compressed public key.
+     */
+    static parseAndVerifyRoot(root: string, publicKey: string): string;
+    static parseRootValues(txt: string): ENRRootValues;
+    /**
+     * Returns the public key and top level domain of an ENR tree entry.
+     * The domain is the starting point for traversing a set of linked DNS TXT records
+     * and the public key is used to verify the root entry record
+     */
+    static parseTree(tree: string): ENRTreeValues;
+    /**
+     * Returns subdomains listed in an ENR branch entry. These in turn lead to
+     * either further branch entries or ENR records.
+     */
+    static parseBranch(branch: string): string[];
+}

package/dist/dns/enrtree.js

@@ -0,0 +1,76 @@
+import { ENR } from "@waku/enr";
+import { keccak256, verifySignature } from "@waku/enr";
+import { utf8ToBytes } from "@waku/utils/bytes";
+import base32 from "hi-base32";
+import { fromString } from "uint8arrays/from-string";
+export class ENRTree {
+    static RECORD_PREFIX = ENR.RECORD_PREFIX;
+    static TREE_PREFIX = "enrtree:";
+    static BRANCH_PREFIX = "enrtree-branch:";
+    static ROOT_PREFIX = "enrtree-root:";
+    /**
+     * Extracts the branch subdomain referenced by a DNS tree root string after verifying
+     * the root record signature with its base32 compressed public key.
+     */
+    static parseAndVerifyRoot(root, publicKey) {
+        if (!root.startsWith(this.ROOT_PREFIX))
+            throw new Error(`ENRTree root entry must start with '${this.ROOT_PREFIX}'`);
+        const rootValues = ENRTree.parseRootValues(root);
+        const decodedPublicKey = base32.decode.asBytes(publicKey);
+        // The signature is a 65-byte secp256k1 over the keccak256 hash
+        // of the record content, excluding the `sig=` part, encoded as URL-safe base64 string
+        // (Trailing recovery bit must be trimmed to pass `ecdsaVerify` method)
+        const signedComponent = root.split(" sig")[0];
+        const signedComponentBuffer = utf8ToBytes(signedComponent);
+        const signatureBuffer = fromString(rootValues.signature, "base64url").slice(0, 64);
+        const isVerified = verifySignature(signatureBuffer, keccak256(signedComponentBuffer), new Uint8Array(decodedPublicKey));
+        if (!isVerified)
+            throw new Error("Unable to verify ENRTree root signature");
+        return rootValues.eRoot;
+    }
+    static parseRootValues(txt) {
+        const matches = txt.match(/^enrtree-root:v1 e=([^ ]+) l=([^ ]+) seq=(\d+) sig=([^ ]+)$/);
+        if (!Array.isArray(matches))
+            throw new Error("Could not parse ENRTree root entry");
+        matches.shift(); // The first entry is the full match
+        const [eRoot, lRoot, seq, signature] = matches;
+        if (!eRoot)
+            throw new Error("Could not parse 'e' value from ENRTree root entry");
+        if (!lRoot)
+            throw new Error("Could not parse 'l' value from ENRTree root entry");
+        if (!seq)
+            throw new Error("Could not parse 'seq' value from ENRTree root entry");
+        if (!signature)
+            throw new Error("Could not parse 'sig' value from ENRTree root entry");
+        return { eRoot, lRoot, seq: Number(seq), signature };
+    }
+    /**
+     * Returns the public key and top level domain of an ENR tree entry.
+     * The domain is the starting point for traversing a set of linked DNS TXT records
+     * and the public key is used to verify the root entry record
+     */
+    static parseTree(tree) {
+        if (!tree.startsWith(this.TREE_PREFIX))
+            throw new Error(`ENRTree tree entry must start with '${this.TREE_PREFIX}'`);
+        const matches = tree.match(/^enrtree:\/\/([^@]+)@(.+)$/);
+        if (!Array.isArray(matches))
+            throw new Error("Could not parse ENRTree tree entry");
+        matches.shift(); // The first entry is the full match
+        const [publicKey, domain] = matches;
+        if (!publicKey)
+            throw new Error("Could not parse public key from ENRTree tree entry");
+        if (!domain)
+            throw new Error("Could not parse domain from ENRTree tree entry");
+        return { publicKey, domain };
+    }
+    /**
+     * Returns subdomains listed in an ENR branch entry. These in turn lead to
+     * either further branch entries or ENR records.
+     */
+    static parseBranch(branch) {
+        if (!branch.startsWith(this.BRANCH_PREFIX))
+            throw new Error(`ENRTree branch entry must start with '${this.BRANCH_PREFIX}'`);
+        return branch.split(this.BRANCH_PREFIX)[1].split(",");
+    }
+}
+//# sourceMappingURL=enrtree.js.map

package/dist/dns/enrtree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrtree.js","sourceRoot":"","sources":["../../src/dns/enrtree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAcrD,MAAM,OAAO,OAAO;IACX,MAAM,CAAU,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAClD,MAAM,CAAU,WAAW,GAAG,UAAU,CAAC;IACzC,MAAM,CAAU,aAAa,GAAG,iBAAiB,CAAC;IAClD,MAAM,CAAU,WAAW,GAAG,eAAe,CAAC;IAErD;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAY,EAAE,SAAiB;QACvD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAI,CAAC,WAAW,GAAG,CAC3D,CAAC;QAEJ,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE1D,+DAA+D;QAC/D,sFAAsF;QACtF,uEAAuE;QACvE,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,qBAAqB,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;QAC3D,MAAM,eAAe,GAAG,UAAU,CAAC,UAAU,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,KAAK,CACzE,CAAC,EACD,EAAE,CACH,CAAC;QAEF,MAAM,UAAU,GAAG,eAAe,CAChC,eAAe,EACf,SAAS,CAAC,qBAAqB,CAAC,EAChC,IAAI,UAAU,CAAC,gBAAgB,CAAC,CACjC,CAAC;QAEF,IAAI,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAE5E,OAAO,UAAU,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,GAAW;QAChC,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CACvB,6DAA6D,CAC9D,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAExD,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,oCAAoC;QACrD,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC;QAE/C,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QAEvE,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,IAAI,CAAC,SAAS;YACZ,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QAEzE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,IAAY;QAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAI,CAAC,WAAW,GAAG,CAC3D,CAAC;QAEJ,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAEzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAExD,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,oCAAoC;QACrD,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;QAEpC,IAAI,CAAC,SAAS;YACZ,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAc;QAC/B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,aAAa,GAAG,CAC/D,CAAC;QAEJ,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC"}

package/dist/dns/fetch_nodes.d.ts

@@ -0,0 +1,13 @@
+import type { IEnr, NodeCapabilityCount } from "@waku/interfaces";
+/**
+ * Fetch nodes using passed [[getNode]] until all wanted capabilities are
+ * fulfilled or the number of [[getNode]] call exceeds the sum of
+ * [[wantedNodeCapabilityCount]] plus [[errorTolerance]].
+ */
+export declare function fetchNodesUntilCapabilitiesFulfilled(wantedNodeCapabilityCount: Partial<NodeCapabilityCount>, errorTolerance: number, getNode: () => Promise<IEnr | null>): Promise<IEnr[]>;
+/**
+ * Fetch nodes using passed [[getNode]] until all wanted capabilities are
+ * fulfilled or the number of [[getNode]] call exceeds the sum of
+ * [[wantedNodeCapabilityCount]] plus [[errorTolerance]].
+ */
+export declare function yieldNodesUntilCapabilitiesFulfilled(wantedNodeCapabilityCount: Partial<NodeCapabilityCount>, errorTolerance: number, getNode: () => Promise<IEnr | null>): AsyncGenerator<IEnr>;

package/dist/dns/fetch_nodes.js

@@ -0,0 +1,133 @@
+import { Logger } from "@waku/utils";
+const log = new Logger("discovery:fetch_nodes");
+/**
+ * Fetch nodes using passed [[getNode]] until all wanted capabilities are
+ * fulfilled or the number of [[getNode]] call exceeds the sum of
+ * [[wantedNodeCapabilityCount]] plus [[errorTolerance]].
+ */
+export async function fetchNodesUntilCapabilitiesFulfilled(wantedNodeCapabilityCount, errorTolerance, getNode) {
+    const wanted = {
+        relay: wantedNodeCapabilityCount.relay ?? 0,
+        store: wantedNodeCapabilityCount.store ?? 0,
+        filter: wantedNodeCapabilityCount.filter ?? 0,
+        lightPush: wantedNodeCapabilityCount.lightPush ?? 0
+    };
+    const maxSearches = wanted.relay + wanted.store + wanted.filter + wanted.lightPush;
+    const actual = {
+        relay: 0,
+        store: 0,
+        filter: 0,
+        lightPush: 0
+    };
+    let totalSearches = 0;
+    const peers = [];
+    while (!isSatisfied(wanted, actual) &&
+        totalSearches < maxSearches + errorTolerance) {
+        const peer = await getNode();
+        if (peer && isNewPeer(peer, peers)) {
+            // ENRs without a waku2 key are ignored.
+            if (peer.waku2) {
+                if (helpsSatisfyCapabilities(peer.waku2, wanted, actual)) {
+                    addCapabilities(peer.waku2, actual);
+                    peers.push(peer);
+                }
+            }
+            log.info(`got new peer candidate from DNS address=${peer.nodeId}@${peer.ip}`);
+        }
+        totalSearches++;
+    }
+    return peers;
+}
+/**
+ * Fetch nodes using passed [[getNode]] until all wanted capabilities are
+ * fulfilled or the number of [[getNode]] call exceeds the sum of
+ * [[wantedNodeCapabilityCount]] plus [[errorTolerance]].
+ */
+export async function* yieldNodesUntilCapabilitiesFulfilled(wantedNodeCapabilityCount, errorTolerance, getNode) {
+    const wanted = {
+        relay: wantedNodeCapabilityCount.relay ?? 0,
+        store: wantedNodeCapabilityCount.store ?? 0,
+        filter: wantedNodeCapabilityCount.filter ?? 0,
+        lightPush: wantedNodeCapabilityCount.lightPush ?? 0
+    };
+    const maxSearches = wanted.relay + wanted.store + wanted.filter + wanted.lightPush;
+    const actual = {
+        relay: 0,
+        store: 0,
+        filter: 0,
+        lightPush: 0
+    };
+    let totalSearches = 0;
+    const peerNodeIds = new Set();
+    while (!isSatisfied(wanted, actual) &&
+        totalSearches < maxSearches + errorTolerance) {
+        const peer = await getNode();
+        if (peer && peer.nodeId && !peerNodeIds.has(peer.nodeId)) {
+            peerNodeIds.add(peer.nodeId);
+            // ENRs without a waku2 key are ignored.
+            if (peer.waku2) {
+                if (helpsSatisfyCapabilities(peer.waku2, wanted, actual)) {
+                    addCapabilities(peer.waku2, actual);
+                    yield peer;
+                }
+            }
+            log.info(`got new peer candidate from DNS address=${peer.nodeId}@${peer.ip}`);
+        }
+        totalSearches++;
+    }
+}
+function isSatisfied(wanted, actual) {
+    return (actual.relay >= wanted.relay &&
+        actual.store >= wanted.store &&
+        actual.filter >= wanted.filter &&
+        actual.lightPush >= wanted.lightPush);
+}
+function isNewPeer(peer, peers) {
+    if (!peer.nodeId)
+        return false;
+    for (const existingPeer of peers) {
+        if (peer.nodeId === existingPeer.nodeId) {
+            return false;
+        }
+    }
+    return true;
+}
+function addCapabilities(node, total) {
+    if (node.relay)
+        total.relay += 1;
+    if (node.store)
+        total.store += 1;
+    if (node.filter)
+        total.filter += 1;
+    if (node.lightPush)
+        total.lightPush += 1;
+}
+/**
+ * Checks if the proposed ENR [[node]] helps satisfy the [[wanted]] capabilities,
+ * considering the [[actual]] capabilities of nodes retrieved so far..
+ *
+ * @throws If the function is called when the wanted capabilities are already fulfilled.
+ */
+function helpsSatisfyCapabilities(node, wanted, actual) {
+    if (isSatisfied(wanted, actual)) {
+        throw "Internal Error: Waku2 wanted capabilities are already fulfilled";
+    }
+    const missing = missingCapabilities(wanted, actual);
+    return ((missing.relay && node.relay) ||
+        (missing.store && node.store) ||
+        (missing.filter && node.filter) ||
+        (missing.lightPush && node.lightPush));
+}
+/**
+ * Return a [[Waku2]] Object for which capabilities are set to true if they are
+ * [[wanted]] yet missing from [[actual]].
+ */
+function missingCapabilities(wanted, actual) {
+    return {
+        relay: actual.relay < wanted.relay,
+        store: actual.store < wanted.store,
+        filter: actual.filter < wanted.filter,
+        lightPush: actual.lightPush < wanted.lightPush
+    };
+}
+//# sourceMappingURL=fetch_nodes.js.map

package/dist/dns/fetch_nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch_nodes.js","sourceRoot":"","sources":["../../src/dns/fetch_nodes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CACxD,yBAAuD,EACvD,cAAsB,EACtB,OAAmC;IAEnC,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,yBAAyB,CAAC,KAAK,IAAI,CAAC;QAC3C,KAAK,EAAE,yBAAyB,CAAC,KAAK,IAAI,CAAC;QAC3C,MAAM,EAAE,yBAAyB,CAAC,MAAM,IAAI,CAAC;QAC7C,SAAS,EAAE,yBAAyB,CAAC,SAAS,IAAI,CAAC;KACpD,CAAC;IAEF,MAAM,WAAW,GACf,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;IAEjE,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,SAAS,EAAE,CAAC;KACb,CAAC;IAEF,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,MAAM,KAAK,GAAW,EAAE,CAAC;IAEzB,OACE,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC;QAC5B,aAAa,GAAG,WAAW,GAAG,cAAc,EAC5C,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC7B,IAAI,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;YACnC,wCAAwC;YACxC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;oBACzD,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;oBACpC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,GAAG,CAAC,IAAI,CACN,2CAA2C,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CACpE,CAAC;QACJ,CAAC;QAED,aAAa,EAAE,CAAC;IAClB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,oCAAoC,CACzD,yBAAuD,EACvD,cAAsB,EACtB,OAAmC;IAEnC,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,yBAAyB,CAAC,KAAK,IAAI,CAAC;QAC3C,KAAK,EAAE,yBAAyB,CAAC,KAAK,IAAI,CAAC;QAC3C,MAAM,EAAE,yBAAyB,CAAC,MAAM,IAAI,CAAC;QAC7C,SAAS,EAAE,yBAAyB,CAAC,SAAS,IAAI,CAAC;KACpD,CAAC;IAEF,MAAM,WAAW,GACf,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;IAEjE,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,SAAS,EAAE,CAAC;KACb,CAAC;IAEF,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;IAE9B,OACE,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC;QAC5B,aAAa,GAAG,WAAW,GAAG,cAAc,EAC5C,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC7B,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACzD,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,wCAAwC;YACxC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;oBACzD,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;oBACpC,MAAM,IAAI,CAAC;gBACb,CAAC;YACH,CAAC;YACD,GAAG,CAAC,IAAI,CACN,2CAA2C,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CACpE,CAAC;QACJ,CAAC;QACD,aAAa,EAAE,CAAC;IAClB,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAClB,MAA2B,EAC3B,MAA2B;IAE3B,OAAO,CACL,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK;QAC5B,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK;QAC5B,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM;QAC9B,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CACrC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,IAAU,EAAE,KAAa;IAC1C,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAE/B,KAAK,MAAM,YAAY,IAAI,KAAK,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,IAAW,EAAE,KAA0B;IAC9D,IAAI,IAAI,CAAC,KAAK;QAAE,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IACjC,IAAI,IAAI,CAAC,KAAK;QAAE,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IACjC,IAAI,IAAI,CAAC,MAAM;QAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IACnC,IAAI,IAAI,CAAC,SAAS;QAAE,KAAK,CAAC,SAAS,IAAI,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,SAAS,wBAAwB,CAC/B,IAAW,EACX,MAA2B,EAC3B,MAA2B;IAE3B,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAChC,MAAM,iEAAiE,CAAC;IAC1E,CAAC;IAED,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEpD,OAAO,CACL,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;QAC7B,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;QAC7B,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,CACtC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,MAA2B,EAC3B,MAA2B;IAE3B,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK;QAClC,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM;QACrC,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS;KAC/C,CAAC;AACJ,CAAC"}

package/dist/dns/index.d.ts

@@ -0,0 +1,3 @@
+export { PeerDiscoveryDns, wakuDnsDiscovery } from "./dns_discovery.js";
+export { enrTree } from "./constants.js";
+export { DnsNodeDiscovery } from "./dns.js";

package/dist/dns/index.js

@@ -0,0 +1,4 @@
+export { PeerDiscoveryDns, wakuDnsDiscovery } from "./dns_discovery.js";
+export { enrTree } from "./constants.js";
+export { DnsNodeDiscovery } from "./dns.js";
+//# sourceMappingURL=index.js.map

package/dist/dns/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dns/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { PeerDiscoveryDns, wakuDnsDiscovery } from "./dns/dns_discovery.js";
+export { enrTree } from "./dns/constants.js";
+export { DnsNodeDiscovery } from "./dns/dns.js";
+export { wakuPeerExchange, PeerExchangeCodec, WakuPeerExchange } from "./peer-exchange/waku_peer_exchange.js";
+export { wakuPeerExchangeDiscovery, PeerExchangeDiscovery } from "./peer-exchange/waku_peer_exchange_discovery.js";
+export { LocalPeerCacheDiscovery, wakuLocalPeerCacheDiscovery } from "./local-peer-cache/index.js";

package/dist/index.js

@@ -0,0 +1,10 @@
+// DNS Discovery
+export { PeerDiscoveryDns, wakuDnsDiscovery } from "./dns/dns_discovery.js";
+export { enrTree } from "./dns/constants.js";
+export { DnsNodeDiscovery } from "./dns/dns.js";
+// Peer Exchange Discovery
+export { wakuPeerExchange, PeerExchangeCodec, WakuPeerExchange } from "./peer-exchange/waku_peer_exchange.js";
+export { wakuPeerExchangeDiscovery, PeerExchangeDiscovery } from "./peer-exchange/waku_peer_exchange_discovery.js";
+// Local Peer Cache Discovery
+export { LocalPeerCacheDiscovery, wakuLocalPeerCacheDiscovery } from "./local-peer-cache/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,0BAA0B;AAC1B,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACtB,MAAM,iDAAiD,CAAC;AAEzD,6BAA6B;AAC7B,OAAO,EACL,uBAAuB,EACvB,2BAA2B,EAC5B,MAAM,6BAA6B,CAAC"}

package/dist/local-peer-cache/index.d.ts

@@ -0,0 +1,24 @@
+import { TypedEventEmitter } from "@libp2p/interface";
+import { CustomEvent, IdentifyResult, PeerDiscovery, PeerDiscoveryEvents, Startable } from "@libp2p/interface";
+import { type Libp2pComponents, Tags } from "@waku/interfaces";
+type LocalPeerCacheDiscoveryOptions = {
+    tagName?: string;
+    tagValue?: number;
+    tagTTL?: number;
+};
+export declare const DEFAULT_LOCAL_TAG_NAME = Tags.LOCAL;
+export declare class LocalPeerCacheDiscovery extends TypedEventEmitter<PeerDiscoveryEvents> implements PeerDiscovery, Startable {
+    private readonly components;
+    private readonly options?;
+    private isStarted;
+    private peers;
+    constructor(components: Libp2pComponents, options?: LocalPeerCacheDiscoveryOptions | undefined);
+    get [Symbol.toStringTag](): string;
+    start(): Promise<void>;
+    stop(): void | Promise<void>;
+    handleNewPeers: (event: CustomEvent<IdentifyResult>) => void;
+    private getPeersFromLocalStorage;
+    private savePeersToLocalStorage;
+}
+export declare function wakuLocalPeerCacheDiscovery(): (components: Libp2pComponents, options?: LocalPeerCacheDiscoveryOptions) => LocalPeerCacheDiscovery;
+export {};

package/dist/local-peer-cache/index.js

@@ -0,0 +1,106 @@
+import { TypedEventEmitter } from "@libp2p/interface";
+import { CustomEvent } from "@libp2p/interface";
+import { createFromJSON } from "@libp2p/peer-id-factory";
+import { multiaddr } from "@multiformats/multiaddr";
+import { Tags } from "@waku/interfaces";
+import { getWsMultiaddrFromMultiaddrs, Logger } from "@waku/utils";
+const log = new Logger("peer-exchange-discovery");
+export const DEFAULT_LOCAL_TAG_NAME = Tags.LOCAL;
+const DEFAULT_LOCAL_TAG_VALUE = 50;
+const DEFAULT_LOCAL_TAG_TTL = 100000000;
+export class LocalPeerCacheDiscovery extends TypedEventEmitter {
+    components;
+    options;
+    isStarted;
+    peers = [];
+    constructor(components, options) {
+        super();
+        this.components = components;
+        this.options = options;
+        this.isStarted = false;
+        this.peers = this.getPeersFromLocalStorage();
+    }
+    get [Symbol.toStringTag]() {
+        return "@waku/local-peer-cache-discovery";
+    }
+    async start() {
+        if (this.isStarted)
+            return;
+        log.info("Starting Local Storage Discovery");
+        this.components.events.addEventListener("peer:identify", this.handleNewPeers);
+        for (const { id: idStr, address } of this.peers) {
+            const peerId = await createFromJSON({ id: idStr });
+            if (await this.components.peerStore.has(peerId))
+                continue;
+            await this.components.peerStore.save(peerId, {
+                multiaddrs: [multiaddr(address)],
+                tags: {
+                    [this.options?.tagName ?? DEFAULT_LOCAL_TAG_NAME]: {
+                        value: this.options?.tagValue ?? DEFAULT_LOCAL_TAG_VALUE,
+                        ttl: this.options?.tagTTL ?? DEFAULT_LOCAL_TAG_TTL
+                    }
+                }
+            });
+            this.dispatchEvent(new CustomEvent("peer", {
+                detail: {
+                    id: peerId,
+                    multiaddrs: [multiaddr(address)]
+                }
+            }));
+        }
+        log.info(`Discovered ${this.peers.length} peers`);
+        this.isStarted = true;
+    }
+    stop() {
+        if (!this.isStarted)
+            return;
+        log.info("Stopping Local Storage Discovery");
+        this.components.events.removeEventListener("peer:identify", this.handleNewPeers);
+        this.isStarted = false;
+        this.savePeersToLocalStorage();
+    }
+    handleNewPeers = (event) => {
+        const { peerId, listenAddrs } = event.detail;
+        const websocketMultiaddr = getWsMultiaddrFromMultiaddrs(listenAddrs);
+        const localStoragePeers = this.getPeersFromLocalStorage();
+        const existingPeerIndex = localStoragePeers.findIndex((_peer) => _peer.id === peerId.toString());
+        if (existingPeerIndex >= 0) {
+            localStoragePeers[existingPeerIndex].address =
+                websocketMultiaddr.toString();
+        }
+        else {
+            localStoragePeers.push({
+                id: peerId.toString(),
+                address: websocketMultiaddr.toString()
+            });
+        }
+        this.peers = localStoragePeers;
+        this.savePeersToLocalStorage();
+    };
+    getPeersFromLocalStorage() {
+        try {
+            const storedPeersData = localStorage.getItem("waku:peers");
+            if (!storedPeersData)
+                return [];
+            const peers = JSON.parse(storedPeersData);
+            return peers.filter(isValidStoredPeer);
+        }
+        catch (error) {
+            log.error("Error parsing peers from local storage:", error);
+            return [];
+        }
+    }
+    savePeersToLocalStorage() {
+        localStorage.setItem("waku:peers", JSON.stringify(this.peers));
+    }
+}
+function isValidStoredPeer(peer) {
+    return (peer &&
+        typeof peer === "object" &&
+        typeof peer.id === "string" &&
+        typeof peer.address === "string");
+}
+export function wakuLocalPeerCacheDiscovery() {
+    return (components, options) => new LocalPeerCacheDiscovery(components, options);
+}
+//# sourceMappingURL=index.js.map

package/dist/local-peer-cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/local-peer-cache/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EACL,WAAW,EAMZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAGL,IAAI,EACL,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,4BAA4B,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAEnE,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAQlD,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC,KAAK,CAAC;AACjD,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,qBAAqB,GAAG,SAAW,CAAC;AAE1C,MAAM,OAAO,uBACX,SAAQ,iBAAsC;IAO3B;IACA;IALX,SAAS,CAAU;IACnB,KAAK,GAA2B,EAAE,CAAC;IAE3C,YACmB,UAA4B,EAC5B,OAAwC;QAEzD,KAAK,EAAE,CAAC;QAHS,eAAU,GAAV,UAAU,CAAkB;QAC5B,YAAO,GAAP,OAAO,CAAiC;QAGzD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,kCAAkC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAE3B,GAAG,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,gBAAgB,CACrC,eAAe,EACf,IAAI,CAAC,cAAc,CACpB,CAAC;QAEF,KAAK,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YACnD,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,SAAS;YAE1D,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC3C,UAAU,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAChC,IAAI,EAAE;oBACJ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,IAAI,sBAAsB,CAAC,EAAE;wBACjD,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,IAAI,uBAAuB;wBACxD,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,qBAAqB;qBACnD;iBACF;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CAAW,MAAM,EAAE;gBAChC,MAAM,EAAE;oBACN,EAAE,EAAE,MAAM;oBACV,UAAU,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBACjC;aACF,CAAC,CACH,CAAC;QACJ,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,CAAC;QAElD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,GAAG,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,mBAAmB,CACxC,eAAe,EACf,IAAI,CAAC,cAAc,CACpB,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QAEvB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAED,cAAc,GAAG,CAAC,KAAkC,EAAQ,EAAE;QAC5D,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;QAE7C,MAAM,kBAAkB,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAC;QAErE,MAAM,iBAAiB,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAE1D,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,SAAS,CACnD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,MAAM,CAAC,QAAQ,EAAE,CAC1C,CAAC;QAEF,IAAI,iBAAiB,IAAI,CAAC,EAAE,CAAC;YAC3B,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,OAAO;gBAC1C,kBAAkB,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,iBAAiB,CAAC,IAAI,CAAC;gBACrB,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE;gBACrB,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;aACvC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,iBAAiB,CAAC;QAC/B,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC,CAAC;IAEM,wBAAwB;QAC9B,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC3D,IAAI,CAAC,eAAe;gBAAE,OAAO,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC1C,OAAO,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,KAAK,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;YAC5D,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAEO,uBAAuB;QAC7B,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;CACF;AAED,SAAS,iBAAiB,CAAC,IAAS;IAClC,OAAO,CACL,IAAI;QACJ,OAAO,IAAI,KAAK,QAAQ;QACxB,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ;QAC3B,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,CACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B;IAIzC,OAAO,CACL,UAA4B,EAC5B,OAAwC,EACxC,EAAE,CAAC,IAAI,uBAAuB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACxD,CAAC"}

package/dist/peer-exchange/index.d.ts

@@ -0,0 +1,2 @@
+export { wakuPeerExchange, PeerExchangeCodec, WakuPeerExchange } from "./waku_peer_exchange.js";
+export { wakuPeerExchangeDiscovery, PeerExchangeDiscovery, Options, DEFAULT_PEER_EXCHANGE_TAG_NAME } from "./waku_peer_exchange_discovery.js";

package/dist/peer-exchange/index.js

@@ -0,0 +1,3 @@
+export { wakuPeerExchange, PeerExchangeCodec, WakuPeerExchange } from "./waku_peer_exchange.js";
+export { wakuPeerExchangeDiscovery, PeerExchangeDiscovery, DEFAULT_PEER_EXCHANGE_TAG_NAME } from "./waku_peer_exchange_discovery.js";
+//# sourceMappingURL=index.js.map

package/dist/peer-exchange/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/peer-exchange/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EAErB,8BAA8B,EAC/B,MAAM,mCAAmC,CAAC"}

package/dist/peer-exchange/rpc.d.ts

@@ -0,0 +1,22 @@
+import { proto_peer_exchange as proto } from "@waku/proto";
+import type { Uint8ArrayList } from "uint8arraylist";
+/**
+ * PeerExchangeRPC represents a message conforming to the Waku Peer Exchange protocol
+ */
+export declare class PeerExchangeRPC {
+    proto: proto.PeerExchangeRPC;
+    constructor(proto: proto.PeerExchangeRPC);
+    static createRequest(params: proto.PeerExchangeQuery): PeerExchangeRPC;
+    /**
+     * Encode the current PeerExchangeRPC request to bytes
+     * @returns Uint8Array
+     */
+    encode(): Uint8Array;
+    /**
+     * Decode the current PeerExchangeRPC request to bytes
+     * @returns Uint8Array
+     */
+    static decode(bytes: Uint8ArrayList): PeerExchangeRPC;
+    get query(): proto.PeerExchangeQuery | undefined;
+    get response(): proto.PeerExchangeResponse | undefined;
+}

package/dist/peer-exchange/rpc.js

@@ -0,0 +1,41 @@
+import { proto_peer_exchange as proto } from "@waku/proto";
+/**
+ * PeerExchangeRPC represents a message conforming to the Waku Peer Exchange protocol
+ */
+export class PeerExchangeRPC {
+    proto;
+    constructor(proto) {
+        this.proto = proto;
+    }
+    static createRequest(params) {
+        const { numPeers } = params;
+        return new PeerExchangeRPC({
+            query: {
+                numPeers: numPeers
+            },
+            response: undefined
+        });
+    }
+    /**
+     * Encode the current PeerExchangeRPC request to bytes
+     * @returns Uint8Array
+     */
+    encode() {
+        return proto.PeerExchangeRPC.encode(this.proto);
+    }
+    /**
+     * Decode the current PeerExchangeRPC request to bytes
+     * @returns Uint8Array
+     */
+    static decode(bytes) {
+        const res = proto.PeerExchangeRPC.decode(bytes);
+        return new PeerExchangeRPC(res);
+    }
+    get query() {
+        return this.proto.query;
+    }
+    get response() {
+        return this.proto.response;
+    }
+}
+//# sourceMappingURL=rpc.js.map

package/dist/peer-exchange/rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.js","sourceRoot":"","sources":["../../src/peer-exchange/rpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,IAAI,KAAK,EAAE,MAAM,aAAa,CAAC;AAG3D;;GAEG;AACH,MAAM,OAAO,eAAe;IACA;IAA1B,YAA0B,KAA4B;QAA5B,UAAK,GAAL,KAAK,CAAuB;IAAG,CAAC;IAE1D,MAAM,CAAC,aAAa,CAAC,MAA+B;QAClD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,eAAe,CAAC;YACzB,KAAK,EAAE;gBACL,QAAQ,EAAE,QAAQ;aACnB;YACD,QAAQ,EAAE,SAAS;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,KAAqB;QACjC,MAAM,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChD,OAAO,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,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;CACF"}

package/dist/peer-exchange/waku_peer_exchange.d.ts

@@ -0,0 +1,21 @@
+import { BaseProtocol } from "@waku/core/lib/base_protocol";
+import { IPeerExchange, Libp2pComponents, PeerExchangeQueryParams, PeerExchangeResult, PubsubTopic } from "@waku/interfaces";
+export declare const PeerExchangeCodec = "/vac/waku/peer-exchange/2.0.0-alpha1";
+/**
+ * Implementation of the Peer Exchange protocol (https://rfc.vac.dev/spec/34/)
+ */
+export declare class WakuPeerExchange extends BaseProtocol implements IPeerExchange {
+    /**
+     * @param components - libp2p components
+     */
+    constructor(components: Libp2pComponents, pubsubTopics: PubsubTopic[]);
+    /**
+     * Make a peer exchange query to a peer
+     */
+    query(params: PeerExchangeQueryParams): Promise<PeerExchangeResult>;
+}
+/**
+ *
+ * @returns A function that creates a new peer exchange protocol
+ */
+export declare function wakuPeerExchange(pubsubTopics: PubsubTopic[]): (components: Libp2pComponents) => WakuPeerExchange;

package/dist/peer-exchange/waku_peer_exchange.js

@@ -0,0 +1,80 @@
+import { BaseProtocol } from "@waku/core/lib/base_protocol";
+import { EnrDecoder } from "@waku/enr";
+import { ProtocolError } from "@waku/interfaces";
+import { isDefined } from "@waku/utils";
+import { Logger } from "@waku/utils";
+import all from "it-all";
+import * as lp from "it-length-prefixed";
+import { pipe } from "it-pipe";
+import { Uint8ArrayList } from "uint8arraylist";
+import { PeerExchangeRPC } from "./rpc.js";
+export const PeerExchangeCodec = "/vac/waku/peer-exchange/2.0.0-alpha1";
+const log = new Logger("peer-exchange");
+/**
+ * Implementation of the Peer Exchange protocol (https://rfc.vac.dev/spec/34/)
+ */
+export class WakuPeerExchange extends BaseProtocol {
+    /**
+     * @param components - libp2p components
+     */
+    constructor(components, pubsubTopics) {
+        super(PeerExchangeCodec, components, log, pubsubTopics);
+    }
+    /**
+     * Make a peer exchange query to a peer
+     */
+    async query(params) {
+        const { numPeers } = params;
+        const rpcQuery = PeerExchangeRPC.createRequest({
+            numPeers: BigInt(numPeers)
+        });
+        const peer = await this.peerStore.get(params.peerId);
+        if (!peer) {
+            return {
+                peerInfos: null,
+                error: ProtocolError.NO_PEER_AVAILABLE
+            };
+        }
+        const stream = await this.getStream(peer);
+        const res = await pipe([rpcQuery.encode()], lp.encode, stream, lp.decode, async (source) => await all(source));
+        try {
+            const bytes = new Uint8ArrayList();
+            res.forEach((chunk) => {
+                bytes.append(chunk);
+            });
+            const { response } = PeerExchangeRPC.decode(bytes);
+            if (!response) {
+                log.error("PeerExchangeRPC message did not contains a `response` field");
+                return {
+                    peerInfos: null,
+                    error: ProtocolError.EMPTY_PAYLOAD
+                };
+            }
+            const peerInfos = await Promise.all(response.peerInfos
+                .map((peerInfo) => peerInfo.enr)
+                .filter(isDefined)
+                .map(async (enr) => {
+                return { ENR: await EnrDecoder.fromRLP(enr) };
+            }));
+            return {
+                peerInfos,
+                error: null
+            };
+        }
+        catch (err) {
+            log.error("Failed to decode push reply", err);
+            return {
+                peerInfos: null,
+                error: ProtocolError.DECODE_FAILED
+            };
+        }
+    }
+}
+/**
+ *
+ * @returns A function that creates a new peer exchange protocol
+ */
+export function wakuPeerExchange(pubsubTopics) {
+    return (components) => new WakuPeerExchange(components, pubsubTopics);
+}
+//# sourceMappingURL=waku_peer_exchange.js.map

package/dist/peer-exchange/waku_peer_exchange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waku_peer_exchange.js","sourceRoot":"","sources":["../../src/peer-exchange/waku_peer_exchange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAKL,aAAa,EAEd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,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,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,MAAM,CAAC,MAAM,iBAAiB,GAAG,sCAAsC,CAAC;AAExE,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD;;OAEG;IACH,YAAY,UAA4B,EAAE,YAA2B;QACnE,KAAK,CAAC,iBAAiB,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAA+B;QACzC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,MAAM,QAAQ,GAAG,eAAe,CAAC,aAAa,CAAC;YAC7C,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;SAC3B,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,KAAK,EAAE,aAAa,CAAC,iBAAiB;aACvC,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE1C,MAAM,GAAG,GAAG,MAAM,IAAI,CACpB,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EACnB,EAAE,CAAC,MAAM,EACT,MAAM,EACN,EAAE,CAAC,MAAM,EACT,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,CACpC,CAAC;QAEF,IAAI,CAAC;YACH,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,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,GAAG,CAAC,KAAK,CACP,6DAA6D,CAC9D,CAAC;gBACF,OAAO;oBACL,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,aAAa,CAAC,aAAa;iBACnC,CAAC;YACJ,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,QAAQ,CAAC,SAAS;iBACf,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC;iBAC/B,MAAM,CAAC,SAAS,CAAC;iBACjB,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACjB,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,CAAC,CAAC,CACL,CAAC;YAEF,OAAO;gBACL,SAAS;gBACT,KAAK,EAAE,IAAI;aACZ,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;YAC9C,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,KAAK,EAAE,aAAa,CAAC,aAAa;aACnC,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,YAA2B;IAE3B,OAAO,CAAC,UAA4B,EAAE,EAAE,CACtC,IAAI,gBAAgB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;AACnD,CAAC"}