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

docs: add dnsaddr protocol spec #102

Merged
merged 4 commits into from
Nov 11, 2019
Merged

docs: add dnsaddr protocol spec #102

merged 4 commits into from
Nov 11, 2019

Conversation

alanshaw
Copy link
Member

...to the best of my knowledge.

Added as separate doc in protocols dir so existing link in README becomes not 404 :)

...to the best of my knowledge.

Added as separate doc in `protocols` dir so existing link in README becomes not 404 :)
Copy link

@jacobheun jacobheun left a 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.

protocols/DNSADDR.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ntninja ntninja left a comment

Choose a reason for hiding this comment

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

LGTM

@alanshaw alanshaw mentioned this pull request Nov 11, 2019
9 tasks
Copy link
Member

@lidel lidel left a 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

protocols/DNSADDR.md Outdated Show resolved Hide resolved
Co-Authored-By: Marcin Rataj <lidel@lidel.org>
Copy link
Member

@raulk raulk left a 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! ❤️

@olizilla
Copy link
Contributor

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

@alanshaw alanshaw merged commit 91c32b6 into master Nov 11, 2019
@alanshaw alanshaw deleted the docs/dnsaddr-spec branch November 11, 2019 18:20
@lidel
Copy link
Member

lidel commented Nov 11, 2019

@olizilla mind adding a PR against protocols/DNSADDR.md with UDP limitation you discovered? (in "Caveats" section or something) 🙏 I am pretty sure it will save someone a ton of time in low-level debug 👀

@@ -0,0 +1,38 @@
# `dnsaddr`
Copy link
Member

Choose a reason for hiding this comment

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

@alanshaw

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.

olizilla added a commit that referenced this pull request Nov 12, 2019
includes
- dnsaddr suffix matching
- caveat about max udp dns response size

see: #102

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
olizilla added a commit that referenced this pull request Nov 12, 2019
includes
- dnsaddr suffix matching
- caveat about max udp dns response size

see: #102

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
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 this pull request may close these issues.

7 participants