refactor: start moving discovery modules to waku/discovery (#2587)

waku-org · Apr 17, 2024 · 828583a · 828583a
1 parent aa9c302
commit 828583a
Show file tree

Hide file tree

Showing 24 changed files with 73 additions and 41 deletions.
diff --git a/apps/chat2/chat2.nim b/apps/chat2/chat2.nim
@@ -39,7 +39,7 @@ import
   ../../waku/waku_lightpush/rpc,
   ../../waku/waku_enr,
   ../../waku/waku_store,
-  ../../waku/waku_dnsdisc,
+  ../../waku/discovery/waku_dnsdisc,
   ../../waku/waku_node,
   ../../waku/node/waku_metrics,
   ../../waku/node/peer_manager,
@@ -523,7 +523,9 @@ proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
       if msg.contentTopic == chat.contentTopic:
         chat.printReceivedMessage(msg)
 
-    node.subscribe((kind: PubsubSub, topic: DefaultPubsubTopic), some(WakuRelayHandler(handler)))
+    node.subscribe(
+      (kind: PubsubSub, topic: DefaultPubsubTopic), some(WakuRelayHandler(handler))
+    )
 
     if conf.rlnRelay:
       info "WakuRLNRelay is enabled"

diff --git a/apps/networkmonitor/networkmonitor.nim b/apps/networkmonitor/networkmonitor.nim
@@ -25,8 +25,8 @@ import
   ../../waku/node/peer_manager,
   ../../waku/waku_node,
   ../../waku/waku_enr,
-  ../../waku/waku_discv5,
-  ../../waku/waku_dnsdisc,
+  ../../waku/discovery/waku_discv5,
+  ../../waku/discovery/waku_dnsdisc,
   ../../waku/waku_relay,
   ../../waku/waku_rln_relay,
   ../../waku/factory/builder,
@@ -131,12 +131,12 @@ proc setConnectedPeersMetrics(
   var analyzeFuts: seq[Future[Result[string, string]]]
 
   var (inConns, outConns) = node.peer_manager.connectedPeers(WakuRelayCodec)
-  info "connected peers", inConns=inConns.len, outConns=outConns.len
+  info "connected peers", inConns = inConns.len, outConns = outConns.len
 
   shuffle(outConns)
 
-  if outConns.len >= toInt(MaxConnectedPeers/2):
-    for p in outConns[0 ..< toInt(outConns.len/2)]:
+  if outConns.len >= toInt(MaxConnectedPeers / 2):
+    for p in outConns[0 ..< toInt(outConns.len / 2)]:
       trace "Pruning Peer", Peer = $p
       asyncSpawn(node.switch.disconnect(p))
 

diff --git a/apps/wakunode2/app.nim b/apps/wakunode2/app.nim
@@ -40,9 +40,9 @@ import
   ../../waku/waku_api/rest/health/handlers as rest_health_api,
   ../../waku/waku_api/rest/admin/handlers as rest_admin_api,
   ../../waku/waku_archive,
-  ../../waku/waku_dnsdisc,
+  ../../waku/discovery/waku_dnsdisc,
+  ../../waku/discovery/waku_discv5,
   ../../waku/waku_enr/sharding,
-  ../../waku/waku_discv5,
   ../../waku/waku_peer_exchange,
   ../../waku/waku_rln_relay,
   ../../waku/waku_store,
@@ -366,9 +366,7 @@ proc startRestServer(
       "/relay endpoints are not available. Please check your configuration: --relay"
 
   ## Filter REST API
-  if conf.filternode  != "" and
-     app.node.wakuFilterClient != nil:
-
+  if conf.filternode != "" and app.node.wakuFilterClient != nil:
     let filterCache = MessageCache.init()
 
     let filterDiscoHandler =

diff --git a/examples/publisher.nim b/examples/publisher.nim
@@ -15,7 +15,7 @@ import
   ../../../waku/waku_core,
   ../../../waku/waku_node,
   ../../../waku/waku_enr,
-  ../../../waku/waku_discv5,
+  ../../../waku/discovery/waku_discv5,
   ../../../waku/factory/builder
 
 proc now*(): Timestamp =

diff --git a/examples/subscriber.nim b/examples/subscriber.nim
@@ -15,7 +15,7 @@ import
   ../../../waku/waku_core,
   ../../../waku/waku_node,
   ../../../waku/waku_enr,
-  ../../../waku/waku_discv5,
+  ../../../waku/discovery/waku_discv5,
   ../../../waku/factory/builder,
   ../../../waku/waku_relay
 

diff --git a/tests/node/test_wakunode_peer_exchange.nim b/tests/node/test_wakunode_peer_exchange.nim
@@ -15,7 +15,7 @@ import
 import
   ../../../waku/[
     waku_node,
-    waku_discv5,
+    discovery/waku_discv5,
     waku_peer_exchange,
     node/peer_manager,
     waku_relay/protocol,

diff --git a/tests/test_waku_dnsdisc.nim b/tests/test_waku_dnsdisc.nim
@@ -13,7 +13,7 @@ import
 import
   ../../waku/node/peer_manager,
   ../../waku/waku_node,
-  ../../waku/waku_dnsdisc,
+  ../../waku/discovery/waku_dnsdisc,
   ./testlib/common,
   ./testlib/wakucore,
   ./testlib/wakunode

diff --git a/tests/test_waku_metadata.nim b/tests/test_waku_metadata.nim
@@ -17,7 +17,7 @@ import
   ../../waku/waku_node,
   ../../waku/waku_core/topics,
   ../../waku/node/peer_manager,
-  ../../waku/waku_discv5,
+  ../../waku/discovery/waku_discv5,
   ../../waku/waku_metadata,
   ./testlib/wakucore,
   ./testlib/wakunode

diff --git a/tests/testlib/wakunode.nim b/tests/testlib/wakunode.nim
@@ -12,7 +12,7 @@ import
   ../../../waku/waku_node,
   ../../../waku/node/peer_manager,
   ../../../waku/waku_enr,
-  ../../../waku/waku_discv5,
+  ../../../waku/discovery/waku_discv5,
   ../../../waku/factory/external_config,
   ../../../waku/factory/internal_config,
   ../../../waku/factory/builder,

diff --git a/tests/waku_discv5/test_waku_discv5.nim b/tests/waku_discv5/test_waku_discv5.nim
@@ -11,7 +11,7 @@ import
   eth/keys as eth_keys
 
 import
-  ../../../waku/[waku_core/topics, waku_enr, waku_discv5, common/enr],
+  ../../../waku/[waku_core/topics, waku_enr, discovery/waku_discv5, common/enr],
   ../testlib/[wakucore, testasync, assertions, futures],
   ../waku_enr/utils,
   ./utils

diff --git a/tests/waku_discv5/utils.nim b/tests/waku_discv5/utils.nim
@@ -6,7 +6,8 @@ import
   eth/keys as eth_keys
 
 import
-  ../../../waku/[waku_core/topics, waku_enr, waku_discv5], ../testlib/[common, wakucore]
+  ../../../waku/[waku_core/topics, waku_enr, discovery/waku_discv5],
+  ../testlib/[common, wakucore]
 
 proc newTestDiscv5*(
     privKey: libp2p_keys.PrivateKey,

diff --git a/tests/waku_enr/test_sharding.nim b/tests/waku_enr/test_sharding.nim
@@ -9,7 +9,7 @@ import
   eth/keys as eth_keys
 
 import
-  ../../../waku/[waku_enr, waku_discv5, waku_core],
+  ../../../waku/[waku_enr, discovery/waku_discv5, waku_core],
   ../testlib/wakucore,
   ../waku_discv5/utils,
   ./utils

diff --git a/tests/waku_enr/utils.nim b/tests/waku_enr/utils.nim
@@ -7,7 +7,7 @@ import
   eth/keys as eth_keys
 
 import
-  ../../../waku/[waku_core/topics, waku_enr, waku_discv5, waku_enr/sharding],
+  ../../../waku/[waku_core/topics, waku_enr, discovery/waku_discv5, waku_enr/sharding],
   ../testlib/[common, wakucore]
 
 proc newTestEnrRecord*(

diff --git a/tests/waku_peer_exchange/test_protocol.nim b/tests/waku_peer_exchange/test_protocol.nim
@@ -13,7 +13,7 @@ import
   ../../../waku/[
     waku_node,
     node/peer_manager,
-    waku_discv5,
+    discovery/waku_discv5,
     waku_peer_exchange,
     waku_peer_exchange/rpc,
     waku_peer_exchange/rpc_codec,

diff --git a/tests/waku_peer_exchange/test_rpc_codec.nim b/tests/waku_peer_exchange/test_rpc_codec.nim
@@ -12,13 +12,12 @@ import
   eth/p2p/discoveryv5/enr
 
 import
-  ../../../waku/
-    [
-      node/peer_manager,
-      waku_discv5,
-      waku_peer_exchange/rpc,
-      waku_peer_exchange/rpc_codec,
-    ],
+  ../../../waku/[
+    node/peer_manager,
+    discovery/waku_discv5,
+    waku_peer_exchange/rpc,
+    waku_peer_exchange/rpc_codec,
+  ],
   ../testlib/[wakucore]
 
 suite "Peer Exchange RPC":

diff --git a/tests/waku_peer_exchange/utils.nim b/tests/waku_peer_exchange/utils.nim
@@ -13,7 +13,7 @@ import
 import
   ../../../waku/[
     waku_node,
-    waku_discv5,
+    discovery/waku_discv5,
     waku_peer_exchange,
     waku_peer_exchange/rpc,
     waku_peer_exchange/protocol,

diff --git a/waku/discovery/discovery_manager.nim b/waku/discovery/discovery_manager.nim
@@ -0,0 +1,33 @@
+when (NimMajor, NimMinor) < (1, 4):
+  {.push raises: [Defect].}
+else:
+  {.push raises: [].}
+
+import waku_discv5, ../../waku_core
+
+## This module contains the logic needed to discover other peers and
+## also to make the "self" node discoverable by other peers.
+
+type DiscoveryManager* = object
+  wakuDiscv5*: Option[WakuDiscoveryV5]
+  dynamicBootstrapNodes*: seq[RemotePeerInfo]
+
+#[
+    TODO: in future PRs we will have:
+
+    App* = object
+        version: string
+        conf: WakuNodeConf
+        rng: ref HmacDrbgContext
+        key: crypto.PrivateKey
+
+        ## in future PRs, the following two items will be encapsulated by 'DiscoveryManager'
+        wakuDiscv5: Option[WakuDiscoveryV5]         <-- this will get removed
+        dynamicBootstrapNodes: seq[RemotePeerInfo]  <-- this will get removed
+
+        node: WakuNode  <-- this will contain a discManager instance
+
+        restServer: Option[WakuRestServerRef]
+        metricsServer: Option[MetricsHttpServerRef]
+
+    ]#
diff --git a/waku/waku_discv5.nim → waku/discovery/waku_discv5.nim b/waku/waku_discv5.nim → waku/discovery/waku_discv5.nim
@@ -14,7 +14,7 @@ import
   eth/keys as eth_keys,
   eth/p2p/discoveryv5/node,
   eth/p2p/discoveryv5/protocol
-import ./node/peer_manager/peer_manager, ./waku_core, ./waku_enr
+import ../node/peer_manager/peer_manager, ../waku_core, ../waku_enr
 
 export protocol, waku_enr
 

diff --git a/waku/waku_dnsdisc.nim → waku/discovery/waku_dnsdisc.nim b/waku/waku_dnsdisc.nim → waku/discovery/waku_dnsdisc.nim
@@ -21,7 +21,7 @@ import
   libp2p/multiaddress,
   libp2p/peerid,
   dnsdisc/client
-import ./waku_core
+import ../waku_core
 
 export client
 

diff --git a/waku/factory/builder.nim b/waku/factory/builder.nim
@@ -12,7 +12,7 @@ import
   libp2p/builders,
   libp2p/nameresolving/nameresolver,
   libp2p/transports/wstransport
-import ../waku_enr, ../waku_discv5, ../waku_node, ../node/peer_manager
+import ../waku_enr, ../discovery/waku_discv5, ../waku_node, ../node/peer_manager
 
 type
   WakuNodeBuilder* = object # General

diff --git a/waku/factory/node_factory.nim b/waku/factory/node_factory.nim
@@ -16,7 +16,7 @@ import
   ../waku_node,
   ../waku_core,
   ../waku_rln_relay,
-  ../waku_dnsdisc,
+  ../discovery/waku_dnsdisc,
   ../waku_archive,
   ../waku_store,
   ../waku_filter_v2,

diff --git a/waku/node/waku_node.nim b/waku/node/waku_node.nim
@@ -41,11 +41,11 @@ import
   ../waku_lightpush/common,
   ../waku_lightpush/protocol,
   ../waku_enr,
-  ../waku_dnsdisc,
   ../waku_peer_exchange,
   ../waku_rln_relay,
   ./config,
   ./peer_manager,
+  ../discovery/waku_dnsdisc,
   ../common/ratelimit
 
 declarePublicCounter waku_node_messages, "number of messages received", ["type"]
@@ -446,8 +446,7 @@ proc filterHandleMessage*(
     node: WakuNode, pubsubTopic: PubsubTopic, message: WakuMessage
 ) {.async.} =
   if node.wakuFilter.isNil():
-    error "cannot handle filter message",
-      error = "waku filter is required"
+    error "cannot handle filter message", error = "waku filter is required"
     return
 
   await node.wakuFilter.handleMessage(pubsubTopic, message)
@@ -546,7 +545,7 @@ proc filterSubscribe*(
 proc filterUnsubscribe*(
     node: WakuNode,
     pubsubTopic: Option[PubsubTopic],
-    contentTopics: ContentTopic|seq[ContentTopic],
+    contentTopics: ContentTopic | seq[ContentTopic],
     peer: RemotePeerInfo | string,
 ): Future[FilterSubscribeResult] {.async, gcsafe, raises: [Defect, ValueError].} =
   ## Unsubscribe from a content filter V2".

diff --git a/waku/waku_api/handlers.nim b/waku/waku_api/handlers.nim
@@ -4,7 +4,7 @@ else:
   {.push raises: [].}
 
 import chronos, chronicles, std/[options, sequtils], stew/results
-import ../waku_discv5, ../waku_relay, ../waku_core, ./message_cache
+import ../discovery/waku_discv5, ../waku_relay, ../waku_core, ./message_cache
 
 ### Discovery
 

diff --git a/waku/waku_peer_exchange/protocol.nim b/waku/waku_peer_exchange/protocol.nim
@@ -11,7 +11,7 @@ import
   ../common/nimchronos,
   ../node/peer_manager,
   ../waku_core,
-  ../waku_discv5,
+  ../discovery/waku_discv5,
   ./rpc,
   ./rpc_codec