From 1b1cf7d6ef7b3486411c736ca61b095639de768c Mon Sep 17 00:00:00 2001 From: Alexander Borzunov Date: Wed, 11 Jan 2023 17:06:27 +0400 Subject: [PATCH 1/4] Fix docstrings about relays --- hivemind/p2p/p2p_daemon.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/hivemind/p2p/p2p_daemon.py b/hivemind/p2p/p2p_daemon.py index 5a02071ab..a99bd7c6b 100644 --- a/hivemind/p2p/p2p_daemon.py +++ b/hivemind/p2p/p2p_daemon.py @@ -130,10 +130,10 @@ async def create( :param use_ipfs: Bootstrap to IPFS (incompatible with initial_peers) :param use_relay: Enable circuit relay functionality in libp2p (see https://docs.libp2p.io/concepts/nat/circuit-relay/). - If enabled (default), others can use you as a relay. - If you want use relays yourself (to reach peers behind NATs/firewalls), - please also pass `use_auto_relay=True`. - :param use_auto_relay: Look for libp2p relays to reach peers behind NATs/firewalls + If enabled (default), you can reach peers behind NATs/firewalls through libp2p relays. + If you are behind NAT/firewall yourself, + please pass `use_auto_relay=True` to become reachable. + :param use_auto_relay: Look for libp2p relays to become reachable if this peer is behind NAT/firewall :param quic: Deprecated, has no effect since libp2p 0.17.0 :param use_relay_hop: Deprecated, has no effect since libp2p 0.17.0 :param use_relay_discovery: Deprecated, has no effect since libp2p 0.17.0 From ea09128a9c9148d40279553a2f7849178ed028a5 Mon Sep 17 00:00:00 2001 From: Alexander Borzunov Date: Wed, 11 Jan 2023 17:08:01 +0400 Subject: [PATCH 2/4] Update hivemind/p2p/p2p_daemon.py --- hivemind/p2p/p2p_daemon.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hivemind/p2p/p2p_daemon.py b/hivemind/p2p/p2p_daemon.py index a99bd7c6b..1fb7b0c2d 100644 --- a/hivemind/p2p/p2p_daemon.py +++ b/hivemind/p2p/p2p_daemon.py @@ -133,7 +133,7 @@ async def create( If enabled (default), you can reach peers behind NATs/firewalls through libp2p relays. If you are behind NAT/firewall yourself, please pass `use_auto_relay=True` to become reachable. - :param use_auto_relay: Look for libp2p relays to become reachable if this peer is behind NAT/firewall + :param use_auto_relay: Look for libp2p relays to become reachable if we are behind NAT/firewall :param quic: Deprecated, has no effect since libp2p 0.17.0 :param use_relay_hop: Deprecated, has no effect since libp2p 0.17.0 :param use_relay_discovery: Deprecated, has no effect since libp2p 0.17.0 From 109bfa10a0b9eb015284156901b67b90a8e58b15 Mon Sep 17 00:00:00 2001 From: Alexander Borzunov Date: Wed, 11 Jan 2023 17:09:30 +0400 Subject: [PATCH 3/4] Update run_dht.py --- hivemind/hivemind_cli/run_dht.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/hivemind/hivemind_cli/run_dht.py b/hivemind/hivemind_cli/run_dht.py index dabf437d4..5bf018510 100644 --- a/hivemind/hivemind_cli/run_dht.py +++ b/hivemind/hivemind_cli/run_dht.py @@ -62,7 +62,9 @@ def main(): help="Disable circuit relay functionality in libp2p (see https://docs.libp2p.io/concepts/nat/circuit-relay/)", ) parser.add_argument( - "--use_auto_relay", action="store_true", help="Look for libp2p relays to reach peers behind NATs/firewalls" + "--use_auto_relay", + action="store_true", + help="Look for libp2p relays to become reachable if we are behind NAT/firewall", ) parser.add_argument( "--refresh_period", type=int, default=30, help="Period (in seconds) for fetching the keys from DHT" From 5e49850d98e0cd7c77d1d7092cba9174183cbe06 Mon Sep 17 00:00:00 2001 From: Alexander Borzunov Date: Wed, 11 Jan 2023 17:09:48 +0400 Subject: [PATCH 4/4] Update run_server.py --- hivemind/hivemind_cli/run_server.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/hivemind/hivemind_cli/run_server.py b/hivemind/hivemind_cli/run_server.py index e42422caa..afbc528a8 100644 --- a/hivemind/hivemind_cli/run_server.py +++ b/hivemind/hivemind_cli/run_server.py @@ -42,7 +42,9 @@ def main(): help="Disable circuit relay functionality in libp2p (see https://docs.libp2p.io/concepts/nat/circuit-relay/)", ) parser.add_argument( - "--use_auto_relay", action="store_true", help="Look for libp2p relays to reach peers behind NATs/firewalls" + "--use_auto_relay", + action="store_true", + help="Look for libp2p relays to become reachable if we are behind NAT/firewall", ) parser.add_argument('--num_handlers', type=int, default=None, required=False,