Adding `iroh_blobs` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add iroh-blobs

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

iroh-blobs = "0.97.0"

The iroh_blobs library will be automatically available globally. Read the iroh_blobs library documentation.

Back to the crate overview.

Readme

iroh-blobs

NOTE: this version of iroh-blobs is not yet considered production quality. For now, if you need production quality, use iroh-blobs 0.35

This crate provides blob and blob sequence 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 entire sequences of blobs in one request.

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 used together with iroh. Connection establishment is left up to the user or higher level APIs.

Concepts

Blob: a sequence of bytes of arbitrary size, without any metadata.
Link: a 32 byte BLAKE3 hash of a blob.
HashSeq: a blob that contains a sequence of links. Its size is a multiple of 32.
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.

A node can be a provider and a requester at the same time.

Getting started

The iroh-blobs protocol was designed to be used in conjunction with iroh. Iroh is a networking library for making direct connections, these connections are what power the data transfers in iroh-blobs.

Iroh provides a Router that takes an Endpoint and any protocols needed for the application. Similar to a router in webserver library, it runs a loop accepting incoming connections and routes them to the specific protocol handler, based on ALPN.

Here is a basic example of how to set up iroh-blobs with iroh:

use iroh::{protocol::Router, Endpoint};
use iroh_blobs::{store::mem::MemStore, BlobsProtocol, ticket::BlobTicket};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // create an iroh endpoint that includes the standard discovery mechanisms
    // we've built at number0
    let endpoint = Endpoint::bind().await?;

    // create a protocol handler using an in-memory blob store.
    let store = MemStore::new();
    let tag = store.add_slice(b"Hello world").await?;
  
    let _ = endpoint.online().await;
    let addr = endpoint.addr();
    let ticket = BlobTicket::new(addr, tag.hash, tag.format);

    // build the router
    let blobs = BlobsProtocol::new(&store, None);
    let router = Router::builder(endpoint)
        .accept(iroh_blobs::ALPN, blobs)
        .spawn();

    println!("We are now serving {}", ticket);

    // wait for control-c
    tokio::signal::ctrl_c().await;

    // clean shutdown of router and store
    router.shutdown().await?;
    Ok(())
}

Examples

Examples that use iroh-blobs can be found in this repo.

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.

Adding iroh_blobs library as a dependency

Adding `iroh_blobs` library as a dependency