Skip to content

Commit

Permalink
chore: move bitswap to exchange/
Browse files Browse the repository at this point in the history
incl. cosmetic editorials
  • Loading branch information
lidel committed Sep 19, 2023
1 parent ae158cb commit 8f3cec5
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 27 deletions.
2 changes: 1 addition & 1 deletion BITSWAP.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Bitswap

Moved to https://specs.ipfs.tech/architecture/bitswap/
Moved to https://specs.ipfs.tech/exchange/bitswap/
35 changes: 19 additions & 16 deletions src/architecture/bitswap.md → src/exchange/bitswap.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,40 @@
---
title: Bitswap
description: >
Bitswap is a data exchange protocol for sending and receiving content addressed
blocks of data. It attempts to acquire blocks from the network that have been
requested by the client, and also send blocks to others who want them.
Bitswap is a libp2p data exchange protocol for sending and receiving content
addressed blocks of data. It attempts to acquire blocks from the p2p network
that have been requested by the client, and also send blocks to others who
want them.
date: 2022-08-26
maturity: reliable
editors:
- name: Adin Schmahmann
github: aschmahmann
- name: Juan Benet
github: jbenet
affiliation:
name: Protocol Labs
url: https://protocol.ai/
- name: David Dias
github: daviddias
- name: Jeromy Johnson
github: whyrusleeping
affiliation:
name: Protocol Labs
url: https://protocol.ai/
- name: Jeromy Johnson
github: whyrusleeping
- name: David Dias
github: daviddias
affiliation:
name: Protocol Labs
url: https://protocol.ai/
- name: Juan Benet
github: jbenet
- name: Adin Schmahmann
github: aschmahmann
affiliation:
name: Protocol Labs
url: https://protocol.ai/
tags: ['architecture']
tags: ['exchange']
order: 1
---

Bitswap is a data exchange protocol for sending and receiving content addressed blocks of data.
Bitswap is a libp2p data exchange protocol for sending and receiving content
addressed blocks of data.

Bitswap has two primary jobs:

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

## Implementations

- [Boxo Bitswap](https://github.com/ipfs/boxo/tree/main/bitswap)
- [js-ipfs-bitswap](https://github.com/ipfs/js-ipfs-bitswap)
- GO: [`boxo/bitswap`](https://github.com/ipfs/boxo/tree/main/bitswap)
- JS: [js-ipfs-bitswap](https://github.com/ipfs/js-ipfs-bitswap)

[unsigned-varint]: https://github.com/multiformats/unsigned-varint
[unsigned-varint]: https://github.com/multiformats/unsigned-varint
13 changes: 13 additions & 0 deletions src/exchange/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Exchange
description: |
Exchange is the way to for sending and receiving content addressed blocks of data.
---

{% include 'header.html' %}

<main>
{% include 'list.html', posts: collections.exchange %}
</main>

{% include 'footer.html' %}
23 changes: 15 additions & 8 deletions src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,21 @@ <h3><a href="/meta/">Meta</a></h3>
</p>
{% include 'list.html', posts: collections.meta %}
</section>
<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.
</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.
</p>
{% include 'list.html', posts: collections.exchange %}
</section>
<section>
<h3><a href="/http-gateways/">HTTP Gateways</a></h3>
<p>
Expand All @@ -94,14 +109,6 @@ <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
</p>
{% include 'list.html', posts: collections.ipns %}
</section>
<section>
<h3><a href="/routing/">Routing</a></h3>
<p>
Content routing is the way to determine where to find a given CID on the network;
specifically, which network peers provide specific CIDs.
</p>
{% include 'list.html', posts: collections.routing %}
</section>
<section>
<h3><a href="/ipips/">InterPlanetary Improvement Proposals</a></h3>
<p>
Expand Down
4 changes: 2 additions & 2 deletions src/routing/index.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Routing
description: |
Content routing is the way to determine where to find a given CID on the network;
specifically, which network peers provide specific CIDs.
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.
---

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

0 comments on commit 8f3cec5

Please sign in to comment.