Skip to content

Commit db5b9b6

Browse files
lidelhacdias
authored andcommitted
editorial: clarify routing labels
1 parent a91de63 commit db5b9b6

File tree

5 files changed

+15
-8
lines changed

5 files changed

+15
-8
lines changed

src/bitswap.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ editors:
2828
affiliation:
2929
name: Protocol Labs
3030
url: https://protocol.ai/
31-
tags: ['exchange']
31+
tags: ['exchange', 'routing']
3232
order: 1
3333
---
3434

@@ -40,6 +40,8 @@ Bitswap has two primary jobs:
4040
1. Attempt to acquire blocks from the network that have been requested by the client.
4141
2. Send blocks in its possession to other peers who want them.
4242

43+
Secondary job (since [v1.2.0](#bitswap-1-2-0)) is to act as a basic content routing system for querying connected peers.
44+
4345
## Introduction
4446

4547
Bitswap is a message-based protocol, as opposed to request-response. All messages
@@ -197,6 +199,13 @@ Given that a client *C* wants to fetch data from some server *S*:
197199
about that particular block. It SHOULD particularly send `Cancel` messages for
198200
`Block` requests (as opposed to `Have` requests) that have not yet been answered.
199201

202+
:::note
203+
204+
`Have`'s and `Have`/`DontHave` responses enable Bitswap to be used as
205+
bare-bones content routing system for connected peers.
206+
207+
:::
208+
200209
### Bitswap 1.2.0: Wire Format
201210

202211
```protobuf

src/exchange/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Exchange
33
description: |
4-
Exchange is the way to for sending and receiving content addressed blocks of data.
4+
Exchange is the way to for sending and receiving content-addressed blocks of data.
55
---
66

77
{% include 'header.html' %}

src/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,14 @@ <h3><a href="/meta/">Meta</a></h3>
8282
<section>
8383
<h3><a href="/routing/">Routing</a></h3>
8484
<p>
85-
Routing is the way to determine where to find a given CID, Peer, or IPNS Record on the network;
86-
specifically, which network peers provide specific CIDs.
85+
Routing is the way to determine where to find a given content, peer, or IPNS record.
8786
</p>
8887
{% include 'list.html', posts: collections.routing %}
8988
</section>
9089
<section>
9190
<h3><a href="/exchange/">Exchange</a></h3>
9291
<p>
93-
Exchange is the way to for sending and receiving content addressed blocks of data.
92+
Exchange is the way to for sending and receiving content-addressed blocks of data.
9493
</p>
9594
{% include 'list.html', posts: collections.exchange %}
9695
</section>

src/routing/http-routing-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Delegated Routing V1 HTTP API
33
description: >
44
Delegated routing is a mechanism for IPFS implementations to use for offloading
55
content routing and naming to another process/server. This specification describes
6-
an HTTP API for delegated content routing.
6+
an HTTP API for delegated routing of content, peers, and IPNS.
77
date: 2023-08-31
88
maturity: reliable
99
editors:

src/routing/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: Routing
33
description: |
4-
Routing is the way to determine where to find a given CID, Peer, or IPNS Record on the network;
5-
specifically, which network peers provide specific CIDs.
4+
Routing is the way to determine where to find a given content, peer, or IPNS record.
65
---
76

87
{% include 'header.html' %}

0 commit comments

Comments
 (0)