ringdrop 0.14.0

P2P streamed file transfer with ring-based access control, built on iroh and bao protocols
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

#![deny(elided_lifetimes_in_paths)]
#![deny(unreachable_pub)]
#![warn(missing_docs)]

//! # ringdrop
//!
//! P2P file transfer with ring-based access control, built on [iroh] (QUIC +
//! hole-punching) and [iroh-blobs] (BLAKE3 chunked storage with bao encoding).
//!
//! ## Architecture
//!
//! ```text
//!             ┌─────────────────────┐
//!             │     CLI (rdrop)     │
//!             │          ↕          │
//!             │    DaemonClient     │
//!             └──────────┼──────────┘
//! ┌──────────────────────↕───────────────────────┐
//! │                 DaemonServer                 │
//! │               (owns the Node)                │
//! │  ┌───────────────────┴────────────────────┐  │
//! │  │                  Node                  │  │
//! │  │  ┌──────────────────────────────────┐  │  │
//! │  │  │ FsStore  Registry  Grants  Peers │  │  │
//! │  │  │    └───────────┬─────────────┘   │  │  │
//! │  │  │  ┌─────────────┴─────────────┐   │  │  │
//! │  │  │  │        RingGate           │   │  │  │
//! │  │  │  │    (/iroh-rings/2)        │   │  │  │
//! │  │  │  ├───────────────────────────┤   │  │  │
//! │  │  │  │     CatalogHandler        │   │  │  │
//! │  │  │  │  (/ringdrop/catalog/0)    │   │  │  │
//! │  │  │  └─────────────┬─────────────┘   │  │  │
//! │  │  │            Endpoint              │  │  │
//! │  │  │           (QUIC/iroh)            │  │  │
//! │  │  └───────────────┼┼┼────────────────┘  │  │
//! │  └──────────────────┼┼┼───────────────────┘  │
//! └─────────────────────┼┼┼──────────────────────┘
//!                    internet
//! ```
//!
//! A [`core::Node`] wraps an iroh QUIC endpoint, an iroh-blobs persistent blob
//! store, a `Registry` that tracks ring membership and permission-typed
//! resource associations, and two protocol handlers registered on the endpoint:
//! a `RingGate` (`/iroh-rings/2`) that enforces access control — a blob is only
//! served to a peer that holds [`Permission::Read`] on it — and a
//! `CatalogHandler` (`/ringdrop/catalog/0`) that lets authorised peers query
//! the local blob list.
//!
//! [`Permission::Read`]: iroh_rings::Permission
//!
//! The [`daemon`] module runs a `Node` as a background TCP server so that the
//! CLI can talk to it over a local IPC connection.
//!
//! [`EndpointId`]: iroh::EndpointId

pub mod cli;
pub mod config;
pub mod core;
pub mod daemon;
pub(crate) mod local_store;
pub mod util;