|
1 | 1 | # iroh-blobs
|
2 | 2 |
|
3 |
| -This crate provides blob and collection transfer support for iroh. It implements a simple request-response protocol based on blake3 verified streaming. |
| 3 | +This crate provides blob and blob sequence transfer support for iroh. It implements a simple request-response protocol based on BLAKE3 verified streaming. |
4 | 4 |
|
5 |
| -A request describes data in terms of blake3 hashes and byte ranges. It is possible to |
6 |
| -request blobs or ranges of blobs, as well as collections. |
| 5 | +A request describes data in terms of BLAKE3 hashes and byte ranges. It is possible to request blobs or ranges of blobs, as well as entire sequences of blobs in one request. |
7 | 6 |
|
8 |
| -The requester opens a quic stream to the provider and sends the request. The provider answers with the requested data, encoded as [blake3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) verified streams, on the same quic stream. |
| 7 | +The requester opens a QUIC stream to the provider and sends the request. The provider answers with the requested data, encoded as [BLAKE3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) verified streams, on the same QUIC stream. |
9 | 8 |
|
10 |
| -This crate is usually used together with [iroh](https://crates.io/crates/iroh), but can also be used with normal [quinn](https://crates.io/crates/quinn) connections. Connection establishment is left up to the user or a higher level APIs such as the iroh CLI. |
| 9 | +This crate is used together with [iroh](https://crates.io/crates/iroh). Connection establishment is left up to the user or a higher level APIs such as the iroh CLI. |
11 | 10 |
|
12 | 11 | ## Concepts
|
13 | 12 |
|
14 | 13 | - **Blob:** a sequence of bytes of arbitrary size, without any metadata.
|
15 | 14 |
|
16 |
| -- **Link:** a 32 byte blake3 hash of a blob. |
| 15 | +- **Link:** a 32 byte BLAKE3 hash of a blob. |
17 | 16 |
|
18 | 17 | - **HashSeq:** a blob that contains a sequence of links. Its size is a multiple of 32.
|
19 | 18 |
|
@@ -64,8 +63,7 @@ async fn main() -> anyhow::Result<()> {
|
64 | 63 |
|
65 | 64 | ## Examples
|
66 | 65 |
|
67 |
| -Examples that use `iroh-blobs` can be found in the `iroh` crate. the iroh crate publishes `iroh_blobs` as `iroh::bytes`. |
68 |
| - |
| 66 | +Examples that use `iroh-blobs` can be found in [this repository](https://github.com/n0-computer/iroh-blobs/tree/main/examples). |
69 | 67 |
|
70 | 68 | # License
|
71 | 69 |
|
|
0 commit comments