blossom-rs 0.5.6

Full-featured Blossom (BUD-01) blob storage library for Rust — embeddable server, async client, BIP-340 Nostr auth
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! # blossom-rs
//!
//! Full-featured [Blossom](https://github.com/hzrd149/blossom) blob storage library for Rust.
//!
//! Content-addressed blob storage over HTTP with BIP-340 Schnorr authorization
//! via Nostr kind:24242 events.
//!
//! ## Features
//!
//! - **Embeddable server**: mount a Blossom-compliant Axum router into your app
//! - **Async client**: upload/download with multi-server failover and SHA256 integrity
//! - **BIP-340 auth**: kind:24242 Nostr events for upload/download/delete authorization
//! - **Pluggable storage**: memory (testing), filesystem, S3-compatible backends
//! - **Database layer**: metadata persistence with SQLite/Postgres support
//! - **Access control**: pluggable authorization (whitelist, custom policies)
//! - **File statistics**: egress tracking with DashMap accumulator
//! - **Trait-based**: implement `BlossomSigner` for your own identity type
//!
//! ## Quick Start
//!
//! ```rust,ignore
//! use blossom_rs::{BlobServer, FilesystemBackend, Signer};
//!
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! // Generate a signer (or implement BlossomSigner for your own type)
//! let signer = Signer::generate();
//!
//! // Create a server with filesystem storage
//! let server = BlobServer::new(
//!     FilesystemBackend::new("/tmp/blobs")?,
//!     "http://localhost:3000",
//! );
//!
//! // Mount into your Axum app
//! let app = server.router();
//! # Ok(())
//! # }
//! ```

pub mod access;
pub mod auth;
pub mod db;
pub mod integrity;
pub mod labels;
pub mod lfs;
pub mod locks;
pub mod media;
pub mod nostr_events;
pub mod otel;
pub mod protocol;
pub mod ratelimit;
pub mod stats;
pub mod storage;
pub mod traits;
pub mod transport;
pub mod webhooks;
mod xdelta3;

#[cfg(feature = "server")]
pub mod server;

#[cfg(feature = "client")]
pub mod client;

// Re-exports for convenience.
pub use access::{AccessControl, Role, RoleBasedAccess};
pub use auth::{
    auth_header_value, build_blossom_auth, build_blossom_auth_with_extra_tags, BlossomSigner,
    Signer,
};
pub use db::{BlobDatabase, MemoryDatabase};
pub use labels::{MediaLabeler, NoopLabeler};
pub use lfs::{
    compress, LfsContext, LfsFileVersion, LfsStorageStats, LfsStorageType, LfsVersionDatabase,
    LfsVersionError, MemoryLfsVersionDatabase,
};
pub use locks::{LockDatabase, LockError, LockFilters, LockRecord, MemoryLockDatabase};
pub use media::{MediaProcessor, PassthroughProcessor};
pub use protocol::{BlobDescriptor, NostrEvent};
pub use storage::{BlobBackend, MemoryBackend};
pub use traits::BlobClient;

#[cfg(feature = "filesystem")]
pub use storage::FilesystemBackend;

#[cfg(feature = "s3")]
pub use storage::{S3Backend, S3Config};

#[cfg(feature = "server")]
pub use server::BlobServer;

#[cfg(feature = "client")]
pub use client::batch::{upload_batch, upload_batch_concurrent, DEFAULT_MAX_CONCURRENT};
#[cfg(feature = "client")]
pub use client::multi::{MultiTransportClient, Transport};
#[cfg(feature = "client")]
pub use client::BlossomClient;

#[cfg(feature = "db-sqlite")]
pub use db::SqliteDatabase;

#[cfg(feature = "db-postgres")]
pub use db::PostgresDatabase;