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.

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

Add small spec on addressing #178

Closed
yusefnapora opened this issue Jul 3, 2019 · 0 comments · Fixed by #191
Closed

Add small spec on addressing #178

yusefnapora opened this issue Jul 3, 2019 · 0 comments · Fixed by #191

Comments

@yusefnapora
Copy link
Contributor

Reading through the specs, I realized that most of them assume that you're familiar with multiaddr. The multiaddr README doesn't go into much detail on how it's used in libp2p, and I think the specs would benefit from an overview of how addresses work in libp2p.

Main points to cover:

  • libp2p uses multiaddr to encode transport addresses
    • briefly describe string and binary formats
  • multiaddrs are composable (describe encapsulation / decapsulation)
    • show examples of e.g. websockets over TCP/IP
  • examples of addresses for all currently supported transports
  • note about extending multiaddr to support new protocols (e.g. p2p-circuit)
    • should mention that it's rarely needed, but possible if you have the right use case
@mxinden mxinden linked a pull request Apr 16, 2021 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant