feat: DNS discovery as default bootstrap discovery (#1114)

* use DNS discovery as default bootstrap discovery

* fix: failing CI

* fix: typo

* introduce tagging, components & explicit tests

    libp2p wasn't by default tagging peers with dns-discovery as
"bootstrap"
    -- we are manually now tagging peers with "dns-discovery", and then
    running tests according to that

* fix: package installs

* fix: typedoc CI

* change tag name from dns-discovery to bootstrap

* update tag name in test

* fix CI

* address review

* add: prod enrtree and use as default

Author: danisharora099

package-lock.json

@@ -51,7 +51,6 @@
   },
   "dependencies": {
     "@chainsafe/libp2p-noise": "^10.1.0",
-    "@libp2p/bootstrap": "^5.0.0",
     "@libp2p/interface-address-manager": "^2.0.1",
     "@libp2p/interface-connection": "^3.0.3",
     "@libp2p/interface-connection-manager": "^1.3.1",
@@ -68,6 +67,7 @@
     "@libp2p/mplex": "^7.0.0",
     "@libp2p/websockets": "^5.0.0",
     "@waku/core": "*",
+    "@waku/dns-discovery": "*",
     "@waku/peer-exchange": "*",
     "interface-datastore": "^7.0.1"
   },

packages/create/package.json

@@ -1,5 +1,4 @@
 import { noise } from "@chainsafe/libp2p-noise";
-import { bootstrap } from "@libp2p/bootstrap";
 import type { PeerDiscovery } from "@libp2p/interface-peer-discovery";
 import { mplex } from "@libp2p/mplex";
 import { webSockets } from "@libp2p/websockets";
@@ -14,14 +13,20 @@ import {
   wakuStore,
 } from "@waku/core";
 import { DefaultUserAgent } from "@waku/core";
-import { getPredefinedBootstrapNodes } from "@waku/core/lib/predefined_bootstrap_nodes";
+import { enrTree, wakuDnsDiscovery } from "@waku/dns-discovery";
 import type { FullNode, IRelay, LightNode, RelayNode } from "@waku/interfaces";
 import { wakuPeerExchange } from "@waku/peer-exchange";
 import type { Libp2p } from "libp2p";
 import { createLibp2p, Libp2pOptions } from "libp2p";
 
 import type { Libp2pComponents } from "./libp2p_components.js";
 
+const DEFAULT_NODE_REQUIREMENTS = {
+  lightPush: 1,
+  filter: 1,
+  store: 1,
+};
+
 export { Libp2pComponents };
 
 export interface CreateOptions {
@@ -165,7 +170,7 @@ export async function createFullNode(
 export function defaultPeerDiscovery(): (
   components: Libp2pComponents
 ) => PeerDiscovery {
-  return bootstrap({ list: getPredefinedBootstrapNodes() });
+  return wakuDnsDiscovery(enrTree["PROD"], DEFAULT_NODE_REQUIREMENTS);
 }
 
 export async function defaultLibp2p(

packages/create/src/index.ts

@@ -3,6 +3,8 @@ import { expect } from "chai";
 import { DnsClient, DnsNodeDiscovery } from "./dns.js";
 import testData from "./testdata.json" assert { type: "json" };
 
+import { enrTree } from "./index.js";
+
 const mockData = testData.dns;
 
 const host = "nodes.example.org";
@@ -260,9 +262,6 @@ describe("DNS Node Discovery w/ capabilities", () => {
 });
 
 describe("DNS Node Discovery [live data]", function () {
-  const publicKey = "AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM";
-  const fqdn = "test.waku.nodes.status.im";
-  const enrTree = `enrtree://${publicKey}@${fqdn}`;
   const maxQuantity = 3;
 
   before(function () {
@@ -275,7 +274,30 @@ describe("DNS Node Discovery [live data]", function () {
     this.timeout(10000);
     // Google's dns server address. Needs to be set explicitly to run in CI
     const dnsNodeDiscovery = DnsNodeDiscovery.dnsOverHttp();
-    const peers = await dnsNodeDiscovery.getPeers([enrTree], {
+    const peers = await dnsNodeDiscovery.getPeers([enrTree.TEST], {
+      relay: maxQuantity,
+      store: maxQuantity,
+      filter: maxQuantity,
+      lightPush: maxQuantity,
+    });
+
+    expect(peers.length).to.eq(maxQuantity);
+
+    const multiaddrs = peers.map((peer) => peer.multiaddrs).flat();
+
+    const seen: string[] = [];
+    for (const ma of multiaddrs) {
+      expect(ma).to.not.be.undefined;
+      expect(seen).to.not.include(ma!.toString());
+      seen.push(ma!.toString());
+    }
+  });
+
+  it(`should retrieve ${maxQuantity} multiaddrs for prod.waku.nodes.status.im`, async function () {
+    this.timeout(10000);
+    // Google's dns server address. Needs to be set explicitly to run in CI
+    const dnsNodeDiscovery = DnsNodeDiscovery.dnsOverHttp();
+    const peers = await dnsNodeDiscovery.getPeers([enrTree.PROD], {
       relay: maxQuantity,
       store: maxQuantity,
       filter: maxQuantity,