iroh-blobs

Crates.ioiroh-blobs
lib.rsiroh-blobs
version0.18.0
sourcesrc
created_at2024-05-13 15:07:36.796419
updated_at2024-06-07 13:52:19.151899
descriptionblob and collection transfer support for iroh
homepage
repositoryhttps://github.com/n0-computer/iroh
max_upload_size
id1238532
size765,493
Friedel Ziegelmayer (dignifiedquire)

documentation

README

iroh-blobs

This crate provides blob and collection transfer support for iroh. It implements a simple request-response protocol based on blake3 verified streaming.

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 collections.

The requester opens a quic stream to the provider and sends the request. The provider answers with the requested data, encoded as blake3 verified streams, on the same quic stream.

This crate is usually used together with iroh-net, but can also be used with normal quinn connections. Connection establishment is left up to the user or a higher level APIs such as the iroh CLI.

Concepts

  • Blob: a sequence of bytes of arbitrary size, without any metadata.

  • Link: a 32 byte blake3 hash of a blob.

  • Collection: any blob that contains links. The simplest collection is just an array of 32 byte blake3 hashes.

  • Provider: The side that provides data and answers requests. Providers wait for incoming requests from Requests.

  • Requester: The side that asks for data. It is initiating requests to one or many providers.

Examples

Examples that use iroh-blobs can be found in the iroh crate. the iroh crate publishes iroh_blobs as iroh::bytes.

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 1304

cargo fmt