feat(relay): allow enabling and disabling of relay HOP advertisement#6154
Merged
mergify[bot] merged 32 commits intolibp2p:masterfrom Apr 21, 2026
Merged
feat(relay): allow enabling and disabling of relay HOP advertisement#6154mergify[bot] merged 32 commits intolibp2p:masterfrom
mergify[bot] merged 32 commits intolibp2p:masterfrom
Conversation
dariusc93
changed the title
elenaf9
reviewed
Sep 28, 2025
Member
elenaf9
left a comment
elenaf9
left a comment
There was a problem hiding this comment.
Thanks for the PR and sorry for the delay!
Although nothing is mentioned in libp2p spec (besides maintaining the reservation), should we disconnect peers who have an active reservation with the relay when the node is no longer reachable (ie if the node decides to disable advertisement of its protocol, or if there are no external addresses available if its determined automatically) or should we maintain the current reservations until they expire?
I wouldn't disconnect them if there is an active circuit for the peer, because in that case we are already connected to both, dialer and listener.
If not, I am unsure. We currently also don't tell clients if individual external addresses expire, so they might be advertising outdated info anyway. And it might also be that we are just temporarily unreachable in which case we probably don't want to immediately close all active reservations. So I am leaning towards not disconnecting. Or only disconnect if the status was manually set to disable.
Co-authored-by: Elena Frank <elena.frank@proton.me>
dariusc93
commented
Oct 6, 2025
elenaf9
reviewed
Oct 9, 2025
Member
elenaf9
left a comment
elenaf9
left a comment
There was a problem hiding this comment.
Few nits, rest LGTM.
Can we have a test for this? 🙏
…feat/relay-enable-disable
elenaf9
reviewed
Jan 17, 2026
Member
There was a problem hiding this comment.
I am sorry for the delay. Some more nits, mostly documentation. Rest LGTM. Thanks @dariusc93!
Co-authored-by: Elena Frank <elena.frank@proton.me>
jxs
approved these changes
Mar 11, 2026
Member
jxs
left a comment
jxs
left a comment
There was a problem hiding this comment.
Hi Darius, and thanks for this! LGTM, Left a small comment regarding comments which I think we could also expand to the new functions added as well
elenaf9
approved these changes
Apr 21, 2026
Co-authored-by: Elena Frank <elena.frank@proton.me>
Contributor
Merge Queue Status
This pull request spent 12 seconds in the queue, including 2 seconds running CI. Required conditions to merge
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR allows the relay to enable and disable its advertisement of the HOP protocol, with the option to automatically determine if the relay should advertise its protocol and function based on its reachability via external addresses (following suite with how libp2p-kad operates)
resolves #4260.
Notes & open questions
Status. Should we change it to any other name likeMode, etc?By default, the status is set to enabled to prevent it from "breaking" relays that do update to a version with this PR merged, but given that the relay need external addresses to operate (the clients with STOP would receive an error if the relay does not have an external address), should have it set to automatic instead, allowing it to be override later on?Additionally, as a note that this is WIP as this is not tested (yet) and mostly to throw the idea out there based on the issue above (#4260)
Change checklist