chore: Circuit relay

[Ivansete-status]

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 directly reachable.

Changes

• Avoid starting the waku relay protocol twice.
• Move autonat service code into a separate module, autonate_service.
• New external parameter, relay-client, which allows setting the node as a circuit-relay client.
• Spawn nim-libp2p DiscoveryManager with rendezvous.
• nat: add exception protection when calling getExternalIP.
• Undo installation of libpcre because we forced ubuntu 22.04 (unrelated change.)

Pending to advertise circuit-relay address in ENR

How to test

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

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

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

relay = false
rest-admin = true
rest = true
filter = true
lightpush = true
discv5-discovery = true
discv5-udp-port = 9000
discv5-enr-auto-update = false
metrics-server = true

rln-relay-eth-client-address="https://sepolia.infura.io/v3/456aa120320f4aec879150fba9e9b7b1"
rln-relay-tree-path="rln_tree"

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

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

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

relay-client = true

rest-admin = true
rest = true
filter = true
lightpush = true
metrics-server = true

rln-relay-eth-client-address="https://sepolia.infura.io/v3/456aa120320f4aec879150fba9e9b7b1"
rln-relay-tree-path="rln_tree"

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.

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

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

relay-client = true

rest-admin = true
rest = true
filter = true
lightpush = true
metrics-server = true

rln-relay-eth-client-address="https://sepolia.infura.io/v3/456aa120320f4aec879150fba9e9b7b1"
rln-relay-tree-path="rln_tree_2"

4. 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]

You can find the image built from this PR at

quay.io/wakuorg/nwaku-pr:3112

Built from 2472c3e