Skip to content

Commit ebf5e86

Browse files
authored
Merge pull request #497 from ipfs/dht
Add IPFS Kademlia DHT Specification
2 parents a5b6db6 + 3ab3eeb commit ebf5e86

File tree

5 files changed

+812
-4
lines changed

5 files changed

+812
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
out/
22
node_modules/
33
super-linter.log
4+
node_modules/

src/bitswap-protocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ editors:
2929
name: Protocol Labs
3030
url: https://protocol.ai/
3131
tags: ['exchange', 'routing']
32-
order: 1
32+
order: 2
3333
---
3434

3535
Bitswap is a libp2p data exchange protocol for sending and receiving content

src/ipns/ipns-record.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ editors:
3434
name: Protocol Labs
3535
url: https://protocol.ai/
3636
xref:
37+
- kad-dht
3738
- ipip-0337
3839
- ipns-pubsub-router
3940
tags: ['ipns']
@@ -290,7 +291,7 @@ Once the record is created, it is ready to be spread through the network. This w
290291

291292
The means of distribution are left unspecified. Implementations MAY choose to
292293
publish signed record using multiple routing systems, such as
293-
[libp2p Kademlia DHT](https://github.com/libp2p/specs/tree/master/kad-dht) or :cite[ipns-pubsub-router] (see [Routing record](#routing-record)).
294+
:cite[kad-dht] or :cite[ipns-pubsub-router] (see [Routing record](#routing-record)).
294295

295296
On the other side, each peer must be able to get a record published by another node. It only needs to have the unique identifier used to publish the record to the network. Taking into account the routing system being used, we may obtain a set of occurrences of the record from the network. In this case, records can be compared using the sequence number, in order to obtain the most recent one.
296297

@@ -474,7 +475,11 @@ Note: Base32 according to the :cite[rfc4648].
474475
#### Routing Record
475476

476477
The routing record is spread across the network according to the available routing systems.
477-
The two routing systems currently available in IPFS are the [libp2p Kademlia DHT](https://github.com/libp2p/specs/tree/master/kad-dht) and :cite[ipns-pubsub-router].
478+
The two routing systems currently available in IPFS are the :cite[kad-dht] and :cite[ipns-pubsub-router].
479+
480+
When using :cite[kad-dht] for routing, implementations SHOULD follow the retrieval strategies
481+
documented in the IPFS Kademlia DHT specification, including the recommended quorum value
482+
for IPNS record lookups.
478483

479484
**Key format:** `/ipns/BINARY_ID`
480485

src/routing/http-routing-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ thanks:
5151
xref:
5252
- ipip-0337
5353
- ipns-record
54-
order: 0
54+
order: 3
5555
tags: ['routing']
5656
---
5757

0 commit comments

Comments
 (0)