Skip to content

Commit

Permalink
editorial: clarify routing labels
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Oct 3, 2023
1 parent 866bbf6 commit ffe3536
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 8 deletions.
11 changes: 10 additions & 1 deletion src/bitswap.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ editors:
affiliation:
name: Protocol Labs
url: https://protocol.ai/
tags: ['exchange']
tags: ['exchange', 'routing']
order: 1
---

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

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

## Introduction

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

:::note

`Have`'s and `Have`/`DontHave` responses enable Bitswap to be used as
bare-bones content routing system for connected peers.

:::

### Bitswap 1.2.0: Wire Format

```protobuf
Expand Down
2 changes: 1 addition & 1 deletion src/exchange/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Exchange
description: |
Exchange is the way to for sending and receiving content addressed blocks of data.
Exchange is the way to for sending and receiving content-addressed blocks of data.
---

{% include 'header.html' %}
Expand Down
5 changes: 2 additions & 3 deletions src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,14 @@ <h3><a href="/meta/">Meta</a></h3>
<section>
<h3><a href="/routing/">Routing</a></h3>
<p>
Routing is the way to determine where to find a given CID, Peer, or IPNS Record on the network;
specifically, which network peers provide specific CIDs.
Routing is the way to determine where to find a given content, peer, or IPNS record.
</p>
{% include 'list.html', posts: collections.routing %}
</section>
<section>
<h3><a href="/exchange/">Exchange</a></h3>
<p>
Exchange is the way to for sending and receiving content addressed blocks of data.
Exchange is the way to for sending and receiving content-addressed blocks of data.
</p>
{% include 'list.html', posts: collections.exchange %}
</section>
Expand Down
2 changes: 1 addition & 1 deletion src/routing/http-routing-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Routing V1 HTTP API
description: >
Delegated routing is a mechanism for IPFS implementations to use for offloading
content routing and naming to another process/server. This specification describes
an HTTP API for delegated content routing.
an HTTP API for delegated routing of content, peers, and IPNS.
date: 2023-08-31
maturity: reliable
editors:
Expand Down
3 changes: 1 addition & 2 deletions src/routing/index.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Routing
description: |
Routing is the way to determine where to find a given CID, Peer, or IPNS Record on the network;
specifically, which network peers provide specific CIDs.
Routing is the way to determine where to find a given content, peer, or IPNS record.
---

{% include 'header.html' %}
Expand Down

0 comments on commit ffe3536

Please sign in to comment.