feat: update autonat.md #411
Open
Conversation
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
Signed-off-by: Willian Paixao <willian@ufpa.br>
There was a problem hiding this comment.
Pull request overview
This PR updates the AutoNAT documentation to reflect the addition of AutoNAT v2 capabilities in go-libp2p. The update transforms previously planned features (referenced as a proposal) into actual documentation for the implemented AutoNAT v2 protocol, which enables per-address reachability detection rather than just node-level detection.
Key changes:
- Restructures autonat.md to clearly distinguish between AutoNAT v1 (node-level reachability) and v2 (per-address reachability)
- Adds practical Go code examples demonstrating how to query confirmed addresses and subscribe to reachability change events
- Updates hole-punching.md to reference AutoNAT v2's ability to determine reachability for individual addresses
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| content/concepts/nat/hole-punching.md | Adds a sentence noting that AutoNAT v2 enables per-address reachability detection (e.g., IPv4 vs IPv6) |
| content/concepts/nat/autonat.md | Completely restructures the document to distinguish v1 and v2, removes the proposal note, adds v2 feature documentation with code examples, and includes version availability information |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Author
|
Hey @2color @achingbrain can I get a review please? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.