-
Notifications
You must be signed in to change notification settings - Fork 86
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
docs: add dnsaddr protocol spec #102
Conversation
...to the best of my knowledge. Added as separate doc in `protocols` dir so existing link in README becomes not 404 :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️ This looks correct as I understand it. I have one suggestion in regards to specifying the example dns query just for clarity. It's in the description, but I think showing it would be helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
afaik looks good, only nit: would make Example into a separate section
Co-Authored-By: Marcin Rataj <lidel@lidel.org>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concise, clear, and (to my knowledge) correct. Thank you! ❤️
fun note: we had to add the 2 levels of indirection because we couldn't fit 8 records (ip4 & ip6 per boostrap node) into a single udp packet for the dns response https://github.com/protocol/bifrost-infra/issues/338 |
@olizilla mind adding a PR against |
@@ -0,0 +1,38 @@ | |||
# `dnsaddr` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably explain suffix matching: Given the address /dnsaddr/bootstrap.libp2p.io/SOMETHING
, this address will only resolve to multiaddrs that end with SOMETHING.
includes - dnsaddr suffix matching - caveat about max udp dns response size see: #102 License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
includes - dnsaddr suffix matching - caveat about max udp dns response size see: #102 License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
...to the best of my knowledge.
Added as separate doc in
protocols
dir so existing link in README becomes not 404 :)