chore: Circuit relay #3112

Ivansete-status · 2024-10-14T07:59:06Z

Description

Allow a node to act as a circuit-relay client/server. Also, start the Hole Punch server.
This is useful for nodes that are behind a NAT or firewall and hence are not reachable.

Special kudos to @richard-ramos , @lchenut and @diegomrsantos. This PR is yours and also inspired by this PR: #1766

Changes

Undo installation of libpcre because we forced ubuntu 22.04 (unrelated change.)
Make Waku a ref object so that it's always passed as by ref.
Move autonat service code into a separate module, autonate_service and check self-reachability every 30 sec instead of every 2 min.
New external parameter, relay-client, which allows setting the node as a circuit-relay client. (we will need to document that.)
Update ENR when a circuit-relay-client reserves a slot in a circuit-relay-server.
Update announced IP address to avoid announcing 0.0.0.0 or 127.0.0.1.
Spawn nim-libp2p DiscoveryManager with rendezvous to advertise rendezvous namespaces based on the subscribed pubsub topics.
nat: add exception protection when calling getExternalIP.

How to test

Three nodes need to run. Two configured as relay-client and a third one configured as a relay server (default.)

Start service node with the following in a VPS so that it is reachable:

ports-shift = 10
cluster-id = 2
log-level = "DEBUG"
nodekey = "1264d111d729a6eb6d2e6113e163f017b5ef03a6f94c9b5b7bb1bb36fa5cb07a9"

relay = false

Start node A with the following configuration and behind a NAT. This will connect to the service node.

ports-shift = 1
cluster-id = 2
staticnode = [ "/ip4/162.19.247.156/tcp/60010/p2p/16Uiu2HAmCzWcYBCw3xKW8De16X9wtcbQrqD8x7CRRv4xpsFJ4oN8" ]

log-level = "DEBUG"
nodekey = "364d111d729a6eb6d2e6113e163f017b5ef03a6f94c9b5b7bb1bb36fa5cb07a9"

relay-client = true

Wait for two minutes until the node A determines that it is not reachable. When that happens, the node A reserves a circuit-relay slot in the relay service node.

Start node B that will establish a relay connection with node A, through the relay sever:

ports-shift = 3
cluster-id = 2
staticnode = [ "/ip4/162.19.247.156/tcp/60010/p2p/16Uiu2HAmCzWcYBCw3xKW8De16X9wtcbQrqD8x7CRRv4xpsFJ4oN8/p2p-circuit/p2p/16Uiu2HAm2eqzqp6xn32fzgGi8K4BuF88W4Xy6yxsmDcW8h1gj6ie" ]
log-level = "DEBUG"
nodekey = "764d111d729a6eb6d2e6113e163f017b5ef03a6f94c9b5b7bb1bb36fa5cb07a9"

relay-client = true

Stop the service node. In that case, node A and node B will still be connected even though they are not reachable due to the NAT condition.

Issue

closes #2514

github-actions · 2024-10-14T08:04:06Z

You can find the image built from this PR at

quay.io/wakuorg/nwaku-pr:3112

Built from f4b8a6f

gabrielmer

Wooow, amazing PR! 😍 😍

Thanks so much!

tests/wakunode_rest/test_rest_admin.nim

tests/test_waku_switch.nim

waku/discovery/waku_discv5.nim

waku/factory/waku.nim

Co-authored-by: gabrielmer <[email protected]>

NagyZoltanPeter

I think its a great work! Left some little suggestions though.
Thank you!

NagyZoltanPeter · 2024-10-25T11:01:07Z

tests/test_peer_manager.nim

@@ -270,12 +270,12 @@ procSuite "Peer Manager":
      storage = WakuPeerStorage.new(database)[]
      node1 = newTestWakuNode(
        generateSecp256k1Key(),
-        ValidIpAddress.init("127.0.0.1"),
+        ValidIpAddress.init($getPrimaryIPAddr()),


I think getPrimaryIPAddr can be used here directly... no need to convert to string and than from string.

NagyZoltanPeter · 2024-10-25T11:02:56Z

tests/test_wakunode.nim

@@ -169,7 +169,7 @@ suite "WakuNode":
      nodeKey = generateSecp256k1Key()
      bindIp = parseIpAddress("0.0.0.0")
      bindPort = Port(61006)
-      extIp = some(parseIpAddress("127.0.0.1"))
+      extIp = some(parseIpAddress($getPrimaryIPAddr()))


Same here, with getPrimaryIPAddr, no need to conver vica-versa, that shall give a valid IP IMHO.

Thanks so much! I've applied your suggestions and much more cleaner now:)

NagyZoltanPeter · 2024-10-25T12:45:06Z

waku/factory/waku.nim

+  var relay = Relay.new()
+  if confCopy.isRelayClient:
+    relay = RelayClient.new()
+
+  let nodeRes = setupNode(confCopy, rng, relay)


Suggested change

var relay = Relay.new()

if confCopy.isRelayClient:

relay = RelayClient.new()

let nodeRes = setupNode(confCopy, rng, relay)

let relay =

if confCopy.isRelayClient: RelayClient.new()

else: Relay.new()

let nodeRes = setupNode(confCopy, rng, relay)

Maybe more straightforward and eliminates a possible useless initialization.

Thanks for the comment! I'd like to apply it but I came across a weird compilation issue (related to RelayClient, LPProtocol, templates, etc.) and due to that I need to initialize the circuitRelay component in a separate proc.

I assigned reviewers a bit prematurely in that one ¬¬ Sorry for upcoming spam!

richard-ramos

Code lgtm but I couldnt find how do you indicate to nwaku which nodes to use for circuit relay server

Ivansete-status · 2024-10-25T23:34:55Z

Code lgtm but I couldnt find how do you indicate to nwaku which nodes to use for circuit relay server

Thanks for checking! In the tests I've used the staticnode argument.
Do you think we need a more explicit CLI argument?

github-actions bot assigned Ivansete-status Oct 14, 2024

Ivansete-status force-pushed the circuit-relay branch 4 times, most recently from a00afcb to d869cd3 Compare October 19, 2024 18:19

Ivansete-status added 8 commits October 23, 2024 00:22

circuit relay first commit

46721c1

undo apt install libpcre

034b9dc

nat.nim: protect against possible exceptions when calling getExternalIP

7fe1057

progress in circuit-relay addition

2fc9637

Minor change to adapt the isRelayClient param description

f415a98

circuit relay progress

7c30a04

waku_node: should start waku relay protocol

dfe23b4

waku factory change to mount circuit hop proto by default

b0b48bd

Ivansete-status force-pushed the circuit-relay branch from f7a72cc to b0b48bd Compare October 22, 2024 22:22

Ivansete-status added 5 commits October 23, 2024 10:34

fix compilation issue in tests

8d2fcd3

fix compilation issue

3e2a1d5

update tests to use getPrimaryIPAddr

7112afc

test_app compilation fix

748b083

builer: rm unnecessary line

da6bdc1

Ivansete-status mentioned this pull request Oct 23, 2024

feat: Enable Hole Punching service #1766

Closed

Ivansete-status marked this pull request as ready for review October 23, 2024 17:41

Ivansete-status requested review from NagyZoltanPeter, richard-ramos, darshankabariya, jm-clius and gabrielmer October 23, 2024 17:41

gabrielmer approved these changes Oct 24, 2024

View reviewed changes

tests/wakunode_rest/test_rest_admin.nim Outdated Show resolved Hide resolved

tests/test_waku_switch.nim Show resolved Hide resolved

waku/discovery/waku_discv5.nim Outdated Show resolved Hide resolved

waku/factory/waku.nim Outdated Show resolved Hide resolved

Ivansete-status and others added 2 commits October 24, 2024 18:01

Update tests/wakunode_rest/test_rest_admin.nim

7e8511c

Co-authored-by: gabrielmer <[email protected]>

Update waku/discovery/waku_discv5.nim

16bdcb0

Co-authored-by: gabrielmer <[email protected]>

Ivansete-status added 4 commits October 25, 2024 15:26

avoid default relay in setupNode proc

28f317b

remove leftover unneeded code

50905f0

fix nph format issue

49771f6

missing import in test_node_factory

7af2425

NagyZoltanPeter approved these changes Oct 25, 2024

View reviewed changes

richard-ramos approved these changes Oct 25, 2024

View reviewed changes

Ivansete-status added 4 commits October 26, 2024 01:36

waku_node: better import of autonat_service

3f784cc

waku: avoid compilation issue

d69b626

waku.nim: protect against possible crash if discv5 is not enabled

16cf26b

apply Zoltan suggestion to simplify tests

eae4e8b

Ivansete-status merged commit cfde7ee into master Oct 28, 2024
10 of 11 checks passed

Ivansete-status deleted the circuit-relay branch October 28, 2024 08:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Circuit relay #3112

chore: Circuit relay #3112

Ivansete-status commented Oct 14, 2024 •

edited

Loading

github-actions bot commented Oct 14, 2024 •

edited

Loading

gabrielmer left a comment

NagyZoltanPeter left a comment

NagyZoltanPeter Oct 25, 2024

NagyZoltanPeter Oct 25, 2024

Ivansete-status Oct 26, 2024

NagyZoltanPeter Oct 25, 2024

Ivansete-status Oct 25, 2024

richard-ramos left a comment

Ivansete-status commented Oct 25, 2024

chore: Circuit relay #3112

chore: Circuit relay #3112

Conversation

Ivansete-status commented Oct 14, 2024 • edited Loading

Description

Changes

How to test

Issue

github-actions bot commented Oct 14, 2024 • edited Loading

gabrielmer left a comment

Choose a reason for hiding this comment

NagyZoltanPeter left a comment

Choose a reason for hiding this comment

NagyZoltanPeter Oct 25, 2024

Choose a reason for hiding this comment

NagyZoltanPeter Oct 25, 2024

Choose a reason for hiding this comment

Ivansete-status Oct 26, 2024

Choose a reason for hiding this comment

NagyZoltanPeter Oct 25, 2024

Choose a reason for hiding this comment

Ivansete-status Oct 25, 2024

Choose a reason for hiding this comment

richard-ramos left a comment

Choose a reason for hiding this comment

Ivansete-status commented Oct 25, 2024

Ivansete-status commented Oct 14, 2024 •

edited

Loading

github-actions bot commented Oct 14, 2024 •

edited

Loading