From a1232f376bd86ef504938f2edd64961ad826d327 Mon Sep 17 00:00:00 2001 From: Ruediger Klaehn Date: Fri, 7 Feb 2025 13:34:41 +0200 Subject: [PATCH 1/4] Update readme - remove mention of using raw quinn, since that is no longer possible - consistently use upper case for QUIC and BLAKE3 - eliminate mention of collections. Collections are just one of many special cases of hash sequences. - remove mention of reexport that does not exist anymore --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ef26c4e49..393fed20c 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # iroh-blobs -This crate provides blob and collection transfer support for iroh. It implements a simple request-response protocol based on blake3 verified streaming. +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 collections. +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](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) verified streams, on the same quic stream. +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. -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. +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. ## Concepts - **Blob:** a sequence of bytes of arbitrary size, without any metadata. -- **Link:** a 32 byte blake3 hash of a blob. +- **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. @@ -64,8 +63,7 @@ async fn main() -> anyhow::Result<()> { ## Examples -Examples that use `iroh-blobs` can be found in the `iroh` crate. the iroh crate publishes `iroh_blobs` as `iroh::bytes`. - +Examples that use `iroh-blobs` can be found in [this repo](https://github.com/n0-computer/iroh-blobs/tree/main/examples). # License From 63a897b57a16fec9951f65cf1c8a2c68433e83b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=BCdiger=20Klaehn?= Date: Fri, 21 Feb 2025 09:49:58 +0100 Subject: [PATCH 2/4] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Philipp Krüger --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 393fed20c..e93564fa4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A request describes data in terms of BLAKE3 hashes and byte ranges. It is possib 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. -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. +This crate is used together with [iroh](https://crates.io/crates/iroh). Connection establishment is left up to the user or higher level APIs. ## Concepts From fc19b79a5411371dd030cb0c0470b546f64f7c02 Mon Sep 17 00:00:00 2001 From: Ruediger Klaehn Date: Fri, 21 Feb 2025 11:07:20 +0200 Subject: [PATCH 3/4] clippy --- src/store/fs.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/store/fs.rs b/src/store/fs.rs index 62fdd877e..8f6adb37f 100644 --- a/src/store/fs.rs +++ b/src/store/fs.rs @@ -1247,7 +1247,7 @@ impl super::Map for Store { type Entry = Entry; async fn get(&self, hash: &Hash) -> io::Result> { - Ok(self.0.get(*hash).await?.map(From::from)) + Ok(self.0.get(*hash).await?) } } From f056f1677deb009038ff79136798990e6f1f7cee Mon Sep 17 00:00:00 2001 From: Ruediger Klaehn Date: Fri, 21 Feb 2025 11:11:18 +0200 Subject: [PATCH 4/4] fix cargo deny --- deny.toml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/deny.toml b/deny.toml index 28b26fe72..34543f643 100644 --- a/deny.toml +++ b/deny.toml @@ -37,4 +37,7 @@ ignore = [ ] [sources] -allow-git = [] +allow-git = [ + "https://github.com/n0-computer/iroh.git", + "https://github.com/n0-computer/quic-rpc.git", +]