Skip to content

Add IPFS Kademlia DHT Specification #497

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

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
out/
node_modules/
super-linter.log
node_modules/
2 changes: 1 addition & 1 deletion src/bitswap-protocol.md
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ editors:
name: Protocol Labs
url: https://protocol.ai/
tags: ['exchange', 'routing']
order: 1
order: 2
---

Bitswap is a libp2p data exchange protocol for sending and receiving content
2 changes: 1 addition & 1 deletion src/routing/http-routing-v1.md
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ editors:
url: https://ipshipyard.com
xref:
- ipns-record
order: 0
order: 3
tags: ['routing']
---

787 changes: 787 additions & 0 deletions src/routing/kad-dht.md
Copy link
Member

Choose a reason for hiding this comment

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

nit: document uses "recommended" multiple times, are those all in the spirit of RECOMMENDED from RFC 2119 (means SHOULD)?

Or should (not pun intended) we replace those with specific SHOULD/MAY per case basis?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Most of the "recommended" are for values/strategies that can be defined freely by implementers, they are not part of the protocol. In this case, "recommended" is more of a suggestion for values/strategies already used in implementations, e.g a safe default. Implementers are free to choose different values/strategies if they have other needs.

Hence the nuance should (not pun intended) be less than SHOULD but more than MAY. I think SHOULD is closer though.

I can either:

  • Replace the occurrences with SHOULD
  • Rephrase to suggested or safe default.

Large diffs are not rendered by default.