Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

identify: clarify that listenAddrs should be external addresses #597

Closed
wants to merge 1 commit into from
Closed

identify: clarify that listenAddrs should be external addresses #597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion identify/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,9 @@ in [peer-ids](../peer-ids).

### listenAddrs

These are the addresses on which the peer is listening as multi-addresses.
The addresses on which the peer is deemed to be reachable by other peers.
These are also sometimes referred to as _external_ addresses.
For backwards-compatibility reasons, implementations MAY also include addresses of local interfaces.
Comment on lines +112 to +114
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am completely open to rewording this to ensure it is backwards-compatible, suggestions more than welcome!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no value in including local addresses.

Suggested change
For backwards-compatibility reasons, implementations MAY also include addresses of local interfaces.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume what you meant to say is that peers need to be able to handle local interface addresses that are sent here. But that's true anyway, you always need to be able to handle nonsense that a peer sends you.


### observedAddr

Expand Down