Skip to content

Commit 7603757

Browse files
lidelhacdias
authored andcommitted
chore: move bitswap to exchange/
incl. cosmetic editorials
1 parent edf278d commit 7603757

File tree

5 files changed

+50
-27
lines changed

5 files changed

+50
-27
lines changed

BITSWAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Bitswap
22

3-
Moved to https://specs.ipfs.tech/architecture/bitswap/
3+
Moved to https://specs.ipfs.tech/exchange/bitswap/

src/architecture/bitswap.md renamed to src/exchange/bitswap.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,40 @@
11
---
22
title: Bitswap
33
description: >
4-
Bitswap is a data exchange protocol for sending and receiving content addressed
5-
blocks of data. It attempts to acquire blocks from the network that have been
6-
requested by the client, and also send blocks to others who want them.
4+
Bitswap is a libp2p data exchange protocol for sending and receiving content
5+
addressed blocks of data. It attempts to acquire blocks from the p2p network
6+
that have been requested by the client, and also send blocks to others who
7+
want them.
78
date: 2022-08-26
89
maturity: reliable
910
editors:
10-
- name: Adin Schmahmann
11-
github: aschmahmann
11+
- name: Juan Benet
12+
github: jbenet
1213
affiliation:
1314
name: Protocol Labs
1415
url: https://protocol.ai/
15-
- name: David Dias
16-
github: daviddias
16+
- name: Jeromy Johnson
17+
github: whyrusleeping
1718
affiliation:
1819
name: Protocol Labs
1920
url: https://protocol.ai/
20-
- name: Jeromy Johnson
21-
github: whyrusleeping
21+
- name: David Dias
22+
github: daviddias
2223
affiliation:
2324
name: Protocol Labs
2425
url: https://protocol.ai/
25-
- name: Juan Benet
26-
github: jbenet
26+
- name: Adin Schmahmann
27+
github: aschmahmann
2728
affiliation:
2829
name: Protocol Labs
2930
url: https://protocol.ai/
30-
tags: ['architecture']
31+
tags: ['exchange']
3132
order: 1
3233
---
3334

34-
Bitswap is a data exchange protocol for sending and receiving content addressed blocks of data.
35+
Bitswap is a libp2p data exchange protocol for sending and receiving content
36+
addressed blocks of data.
37+
3538
Bitswap has two primary jobs:
3639

3740
1. Attempt to acquire blocks from the network that have been requested by the client.
@@ -238,7 +241,7 @@ message Message {
238241

239242
## Implementations
240243

241-
- [Boxo Bitswap](https://github.com/ipfs/boxo/tree/main/bitswap)
242-
- [js-ipfs-bitswap](https://github.com/ipfs/js-ipfs-bitswap)
244+
- GO: [`boxo/bitswap`](https://github.com/ipfs/boxo/tree/main/bitswap)
245+
- JS: [js-ipfs-bitswap](https://github.com/ipfs/js-ipfs-bitswap)
243246

244-
[unsigned-varint]: https://github.com/multiformats/unsigned-varint
247+
[unsigned-varint]: https://github.com/multiformats/unsigned-varint

src/exchange/index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Exchange
3+
description: |
4+
Exchange is the way to for sending and receiving content addressed blocks of data.
5+
---
6+
7+
{% include 'header.html' %}
8+
9+
<main>
10+
{% include 'list.html', posts: collections.exchange %}
11+
</main>
12+
13+
{% include 'footer.html' %}

src/index.html

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,21 @@ <h3><a href="/meta/">Meta</a></h3>
7979
</p>
8080
{% include 'list.html', posts: collections.meta %}
8181
</section>
82+
<section>
83+
<h3><a href="/routing/">Routing</a></h3>
84+
<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.
87+
</p>
88+
{% include 'list.html', posts: collections.routing %}
89+
</section>
90+
<section>
91+
<h3><a href="/exchange/">Exchange</a></h3>
92+
<p>
93+
Exchange is the way to for sending and receiving content addressed blocks of data.
94+
</p>
95+
{% include 'list.html', posts: collections.exchange %}
96+
</section>
8297
<section>
8398
<h3><a href="/http-gateways/">HTTP Gateways</a></h3>
8499
<p>
@@ -101,14 +116,6 @@ <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
101116
</p>
102117
{% include 'list.html', posts: collections.ipns %}
103118
</section>
104-
<section>
105-
<h3><a href="/routing/">Routing</a></h3>
106-
<p>
107-
Content routing is the way to determine where to find a given CID on the network;
108-
specifically, which network peers provide specific CIDs.
109-
</p>
110-
{% include 'list.html', posts: collections.routing %}
111-
</section>
112119
<section>
113120
<h3><a href="/ipips/">InterPlanetary Improvement Proposals</a></h3>
114121
<p>

src/routing/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Routing
33
description: |
4-
Content routing is the way to determine where to find a given CID on the network;
5-
specifically, which network peers provide specific CIDs.
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.
66
---
77

88
{% include 'header.html' %}

0 commit comments

Comments
 (0)