chore(core): move peers utils module to waku_core

waku-org · Apr 24, 2023 · e041e04 · e041e04
1 parent 67e96ba
commit e041e04
Show file tree

Hide file tree

Showing 33 changed files with 295 additions and 317 deletions.
diff --git a/apps/chat2/chat2.nim b/apps/chat2/chat2.nim
@@ -33,7 +33,6 @@ import
   ../../waku/v2/node/waku_metrics,
   ../../waku/v2/node/peer_manager,
   ../../waku/v2/utils/compat,
-  ../../waku/v2/utils/peers,
   ../../waku/common/utils/nat,
   ./config_chat2
 

diff --git a/apps/chat2bridge/chat2bridge.nim b/apps/chat2bridge/chat2bridge.nim
@@ -16,7 +16,6 @@ import
   libp2p/errors,
   ../../../waku/v2/waku_core,
   ../../../waku/v2/waku_node,
-  ../../../waku/v2/utils/peers,
   ../../../waku/v2/node/peer_manager,
   ../../waku/v2/waku_filter,
   ../../waku/v2/waku_store,

diff --git a/apps/wakunode2/wakunode2.nim b/apps/wakunode2/wakunode2.nim
@@ -46,7 +46,6 @@ import
   ../../waku/v2/waku_discv5,
   ../../waku/v2/waku_peer_exchange,
   ../../waku/v2/waku_relay/validators,
-  ../../waku/v2/utils/peers,
   ./wakunode2_setup_rest,
   ./wakunode2_setup_rpc,
   ./config

diff --git a/tests/all_tests_v2.nim b/tests/all_tests_v2.nim
@@ -4,7 +4,8 @@
 import
   ./v2/waku_core/test_namespaced_topics,
   ./v2/waku_core/test_time,
-  ./v2/waku_core/test_message_digest
+  ./v2/waku_core/test_message_digest,
+  ./v2/waku_core/test_peers
 
 
 # Waku archive test suite
@@ -50,7 +51,6 @@ import
   ./v2/test_wakunode_filter,
   ./v2/test_waku_peer_exchange,
   ./v2/test_peer_store_extended,
-  ./v2/test_utils_peers,
   ./v2/test_message_cache,
   ./v2/test_peer_manager,
   ./v2/test_peer_storage,

diff --git a/tests/v2/test_peer_exchange.nim b/tests/v2/test_peer_exchange.nim
@@ -10,8 +10,8 @@ import
   libp2p/crypto/crypto,
   libp2p/protocols/pubsub/gossipsub
 import
+  ../../waku/v2/waku_core,
   ../../waku/v2/waku_node,
-  ../../waku/v2/utils/peers,
   ./testlib/wakucore,
   ./testlib/wakunode
 

diff --git a/tests/v2/test_waku_keepalive.nim b/tests/v2/test_waku_keepalive.nim
@@ -12,8 +12,8 @@ import
   libp2p/stream/connection,
   libp2p/crypto/crypto
 import
+  ../../waku/v2/waku_core,
   ../../waku/v2/waku_node,
-  ../../waku/v2/utils/peers,
   ./testlib/wakucore,
   ./testlib/wakunode
 

diff --git a/tests/v2/test_wakunode.nim b/tests/v2/test_wakunode.nim
@@ -17,12 +17,11 @@ import
   libp2p/nameresolving/mockresolver,
   eth/p2p/discoveryv5/enr
 import
+  ../../waku/v2/waku_core,
   ../../waku/v2/waku_node,
   ../../waku/v2/node/peer_manager,
-  ../../waku/v2/waku_core,
   ../../waku/v2/waku_relay,
   ../../waku/v2/waku_peer_exchange,
-  ../../waku/v2/utils/peers,
   ./testlib/wakucore,
   ./testlib/wakunode
 

diff --git a/tests/v2/test_wakunode_filter.nim b/tests/v2/test_wakunode_filter.nim
@@ -7,10 +7,9 @@ import
   chronos,
   libp2p/crypto/crypto
 import
+  ../../waku/v2/waku_core,
   ../../waku/v2/node/peer_manager,
   ../../waku/v2/waku_node,
-  ../../waku/v2/waku_core,
-  ../../waku/v2/utils/peers,
   ./testlib/common,
   ./testlib/wakucore,
   ./testlib/wakunode

diff --git a/tests/v2/test_wakunode_lightpush.nim b/tests/v2/test_wakunode_lightpush.nim
@@ -11,7 +11,6 @@ import
   ../../waku/v2/waku_core,
   ../../waku/v2/waku_lightpush,
   ../../waku/v2/node/peer_manager,
-  ../../waku/v2/utils/peers,
   ../../waku/v2/waku_node,
   ./testlib/common,
   ./testlib/wakucore,

diff --git a/tests/v2/test_utils_peers.nim → tests/v2/waku_core/test_peers.nim b/tests/v2/test_utils_peers.nim → tests/v2/waku_core/test_peers.nim
@@ -7,14 +7,14 @@ import
   libp2p/peerid,
   libp2p/errors
 import
-  ../../waku/v2/utils/peers
+  ../../waku/v2/waku_core
+
+suite "Waku Core - Peers":
 
-suite "Utils - Peers":
-
   test "Peer info parses correctly":
-    ## Given 
+    ## Given
     let address = "/ip4/127.0.0.1/tcp/65002/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
-      
+
     ## When
     let remotePeerInfoRes = parsePeerInfo(address)
     require remotePeerInfoRes.isOk()
@@ -26,7 +26,7 @@ suite "Utils - Peers":
       $(remotePeerInfo.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
       $(remotePeerInfo.addrs[0][0].tryGet()) == "/ip4/127.0.0.1"
       $(remotePeerInfo.addrs[0][1].tryGet()) == "/tcp/65002"
-    
+
   test "DNS multiaddrs parsing - dns peer":
     ## Given
     let address = "/dns/localhost/tcp/65012/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
@@ -46,7 +46,7 @@ suite "Utils - Peers":
   test "DNS multiaddrs parsing - dnsaddr peer":
     ## Given
     let address = "/dnsaddr/localhost/tcp/65022/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
-    
+
     ## When
     let dnsAddrPeerRes = parsePeerInfo(address)
     require dnsAddrPeerRes.isOk()
@@ -74,7 +74,7 @@ suite "Utils - Peers":
       $(dns4Peer.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
       $(dns4Peer.addrs[0][0].tryGet()) == "/dns4/localhost"
       $(dns4Peer.addrs[0][1].tryGet()) == "/tcp/65032"
-  
+
   test "DNS multiaddrs parsing - dns6 peer":
     ## Given
     let address = "/dns6/localhost/tcp/65042/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
@@ -110,31 +110,31 @@ suite "Utils - Peers":
   test "Multiaddr parsing should fail with trailing whitespace":
     ## Given
     let address = "/ip4/127.0.0.1/tcp/65072/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc "
-    
+
     ## Then
     check:
       parsePeerInfo(address).isErr()
 
   test "Multiaddress parsing should fail with invalid IP address":
     ## Given
     let address = "/ip4/127.0.0.0.1/tcp/65082/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
-    
+
     ## Then
     check:
       parsePeerInfo(address).isErr()
 
   test "Multiaddress parsing should fail with no peer ID":
     ## Given
     let address = "/ip4/127.0.0.1/tcp/65092"
-    
+
     # Then
     check:
       parsePeerInfo(address).isErr()
 
   test "Multiaddress parsing should fail with unsupported transport":
     ## Given
     let address = "/ip4/127.0.0.1/udp/65102/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
-    
+
     ## Then
     check:
       parsePeerInfo(address).isErr()

diff --git a/tests/v2/waku_relay/test_wakunode_relay.nim b/tests/v2/waku_relay/test_wakunode_relay.nim
@@ -20,7 +20,6 @@ import
 import
   ../../waku/v2/waku_core,
   ../../waku/v2/node/peer_manager,
-  ../../waku/v2/utils/peers,
   ../../waku/v2/waku_node,
   ../../waku/v2/waku_relay,
   ../../waku/v2/waku_relay/validators,

diff --git a/tests/v2/waku_rln_relay/test_wakunode_rln_relay.nim b/tests/v2/waku_rln_relay/test_wakunode_rln_relay.nim
@@ -14,11 +14,10 @@ import
   libp2p/protocols/pubsub/pubsub,
   eth/keys
 import
-  ../../../waku/v2/waku_node,
   ../../../waku/v2/waku_core,
+  ../../../waku/v2/waku_node,
   ../../../waku/v2/waku_rln_relay,
   ../../../waku/v2/waku_keystore,
-  ../../../waku/v2/utils/peers,
   ../testlib/wakucore,
   ../testlib/wakunode
 

diff --git a/tests/v2/waku_store/test_wakunode_store.nim b/tests/v2/waku_store/test_wakunode_store.nim
@@ -14,13 +14,12 @@ import
   libp2p/protocols/pubsub/gossipsub
 import
   ../../../waku/common/sqlite,
-  ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/waku_core,
+  ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/waku_archive,
   ../../../waku/v2/waku_archive/driver/sqlite_driver,
   ../../../waku/v2/waku_store,
   ../../../waku/v2/waku_filter,
-  ../../../waku/v2/utils/peers,
   ../../../waku/v2/waku_node,
   ../testlib/common,
   ../testlib/wakucore,

diff --git a/tests/v2/wakunode_jsonrpc/test_jsonrpc_admin.nim b/tests/v2/wakunode_jsonrpc/test_jsonrpc_admin.nim
@@ -10,6 +10,7 @@ import
   libp2p/crypto/crypto,
   json_rpc/[rpcserver, rpcclient]
 import
+  ../../../waku/v2/waku_core,
   ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/waku_node,
   ../../../waku/v2/node/jsonrpc/admin/handlers as admin_api,
@@ -19,7 +20,6 @@ import
   ../../../waku/v2/waku_archive/driver/queue_driver,
   ../../../waku/v2/waku_store,
   ../../../waku/v2/waku_filter,
-  ../../../waku/v2/utils/peers,
   ../testlib/wakucore,
   ../testlib/wakunode
 

diff --git a/tests/v2/wakunode_jsonrpc/test_jsonrpc_filter.nim b/tests/v2/wakunode_jsonrpc/test_jsonrpc_filter.nim
@@ -8,16 +8,15 @@ import
   libp2p/crypto/crypto,
   json_rpc/[rpcserver, rpcclient]
 import
+  ../../../waku/v2/waku_core,
   ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/waku_node,
   ../../../waku/v2/node/message_cache,
   ../../../waku/v2/node/jsonrpc/filter/handlers as filter_api,
   ../../../waku/v2/node/jsonrpc/filter/client as filter_api_client,
-  ../../../waku/v2/waku_core,
   ../../../waku/v2/waku_filter,
   ../../../waku/v2/waku_filter/rpc,
   ../../../waku/v2/waku_filter/client,
-  ../../../waku/v2/utils/peers,
   ../testlib/wakucore,
   ../testlib/wakunode
 

diff --git a/tests/v2/wakunode_jsonrpc/test_jsonrpc_relay.nim b/tests/v2/wakunode_jsonrpc/test_jsonrpc_relay.nim
@@ -9,6 +9,7 @@ import
   json_rpc/[rpcserver, rpcclient]
 import
   ../../../waku/common/base64,
+  ../../../waku/v2/waku_core,
   ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/node/message_cache,
   ../../../waku/v2/waku_node,
@@ -17,7 +18,6 @@ import
   ../../../waku/v2/waku_core,
   ../../../waku/v2/waku_relay,
   ../../../waku/v2/utils/compat,
-  ../../../waku/v2/utils/peers,
   ../testlib/common,
   ../testlib/wakucore,
   ../testlib/wakunode

diff --git a/tests/v2/wakunode_jsonrpc/test_jsonrpc_store.nim b/tests/v2/wakunode_jsonrpc/test_jsonrpc_store.nim
@@ -8,16 +8,15 @@ import
   libp2p/crypto/crypto,
   json_rpc/[rpcserver, rpcclient]
 import
-  ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/waku_core,
+  ../../../waku/v2/node/peer_manager,
   ../../../waku/v2/waku_node,
   ../../../waku/v2/node/jsonrpc/store/handlers as store_api,
   ../../../waku/v2/node/jsonrpc/store/client as store_api_client,
   ../../../waku/v2/waku_archive,
   ../../../waku/v2/waku_archive/driver/queue_driver,
   ../../../waku/v2/waku_store,
   ../../../waku/v2/waku_store/rpc,
-  ../../../waku/v2/utils/peers,
   ../../v2/testlib/common,
   ../../v2/testlib/wakucore,
   ../../v2/testlib/wakunode

diff --git a/tests/v2/wakunode_rest/test_rest_store.nim b/tests/v2/wakunode_rest/test_rest_store.nim
@@ -21,7 +21,6 @@ import
   ../../../waku/v2/waku_archive,
   ../../../waku/v2/waku_archive/driver/queue_driver,
   ../../../waku/v2/waku_store as waku_store,
-  ../../../waku/v2/utils/peers,
   ../../v2/testlib/common,
   ../../v2/testlib/wakucore,
   ../../v2/testlib/wakunode

diff --git a/tests/wakubridge/test_wakubridge.nim b/tests/wakubridge/test_wakubridge.nim
@@ -20,7 +20,6 @@ import
   ../../waku/v2/waku_core,
   ../../waku/v2/waku_node,
   ../../waku/v2/utils/compat,
-  ../../waku/v2/utils/peers,
   ../test_helpers
 
 import

diff --git a/tools/networkmonitor/networkmonitor.nim b/tools/networkmonitor/networkmonitor.nim
@@ -20,13 +20,12 @@ import
   metrics/chronos_httpserver,
   presto/[route, server, client]
 import
+  ../../waku/v2/waku_core,
   ../../waku/v2/node/peer_manager,
   ../../waku/v2/waku_node,
-  ../../waku/v2/waku_core,
   ../../waku/v2/waku_enr,
   ../../waku/v2/waku_discv5,
   ../../waku/v2/waku_dnsdisc,
-  ../../waku/v2/utils/peers,
   ./networkmonitor_metrics,
   ./networkmonitor_config,
   ./networkmonitor_utils

diff --git a/tools/wakucanary/wakucanary.nim b/tools/wakucanary/wakucanary.nim
@@ -11,8 +11,8 @@ import
   libp2p/multicodec
 import
   ../../waku/v2/node/peer_manager,
-  ../../waku/v2/waku_node,
-  ../../waku/v2/utils/peers
+  ../../waku/v2/waku_core,
+  ../../waku/v2/waku_node
 
 # protocols and their tag
 const ProtocolsTable = {

diff --git a/waku/v2/node/peer_manager/peer_manager.nim b/waku/v2/node/peer_manager/peer_manager.nim
@@ -13,8 +13,8 @@ import
   libp2p/muxers/muxer
 import
   ../../../common/nimchronos,
+  ../../waku_core,
   ../../waku_relay,
-  ../../utils/peers,
   ./peer_store/peer_storage,
   ./waku_peer_store
 

diff --git a/waku/v2/node/peer_manager/peer_store/peer_storage.nim b/waku/v2/node/peer_manager/peer_store/peer_storage.nim
@@ -7,8 +7,8 @@ else:
 import
   stew/results
 import
-  ../waku_peer_store,
-  ../../../utils/peers
+  ../../../waku_core,
+  ../waku_peer_store
 
 ## This module defines a peer storage interface. Implementations of
 ## PeerStorage are used to store and retrieve peers

diff --git a/waku/v2/node/peer_manager/peer_store/waku_peer_storage.nim b/waku/v2/node/peer_manager/peer_store/waku_peer_storage.nim
@@ -11,8 +11,8 @@ import
   libp2p/protobuf/minprotobuf
 import
   ../../../../common/sqlite,
+  ../../../waku_core,
   ../waku_peer_store,
-  ../../../utils/peers,
   ./peer_storage
 
 export sqlite

diff --git a/waku/v2/node/peer_manager/waku_peer_store.nim b/waku/v2/node/peer_manager/waku_peer_store.nim
@@ -4,14 +4,14 @@ else:
   {.push raises: [].}
 
 import
-  std/[tables, sequtils, sets, options, times, math, strutils],
+  std/[tables, sequtils, sets, options, times, strutils],
   chronos,
   eth/p2p/discoveryv5/enr,
   libp2p/builders,
   libp2p/peerstore
 
 import
-  ../../utils/peers,
+  ../../waku_core,
   ../../../common/utils/sequence
 
 export peerstore, builders

diff --git a/waku/v2/node/waku_node.nim b/waku/v2/node/waku_node.nim
@@ -38,7 +38,6 @@ import
   ../waku_dnsdisc,
   ../waku_discv5,
   ../waku_peer_exchange,
-  ../utils/peers,
   ./config,
   ./peer_manager,
   ./waku_switch

diff --git a/waku/v2/utils/DEPRECATION_NOTICE.md b/waku/v2/utils/DEPRECATION_NOTICE.md
@@ -0,0 +1,6 @@
+# :warning: DEPRECATION NOTICE :warning:
+
+The `utils` module has been marked as deprecated.
+This package submodules are planned to be moved to different modules.
+
+**No new sub-modules must be added to this folder.**
diff --git a/waku/v2/utils/README.md b/waku/v2/utils/README.md