vss_client_ng/lib.rs
1//! Client-side library to interact with Versioned Storage Service (VSS).
2//!
3//! VSS is an open-source project designed to offer a server-side cloud storage solution specifically
4//! tailored for noncustodial Lightning supporting mobile wallets. Its primary objective is to
5//! simplify the development process for Lightning wallets by providing a secure means to store
6//! and manage the essential state required for Lightning Network (LN) operations.
7//!
8//! Learn more [here](https://github.com/lightningdevkit/vss-server/blob/main/README.md).
9
10#![deny(rustdoc::broken_intra_doc_links)]
11#![deny(rustdoc::private_intra_doc_links)]
12#![deny(missing_docs)]
13
14// Crate re-exports
15pub use bitreq;
16pub use prost;
17
18/// Implements a thin-client ([`client::VssClient`]) to access a hosted instance of Versioned Storage Service (VSS).
19pub mod client;
20
21/// Implements the error type ([`error::VssError`]) returned on interacting with [`client::VssClient`]
22pub mod error;
23
24/// Contains request/response types generated from the API definition of VSS.
25pub mod types;
26
27/// Contains utils for encryption, requests-retries etc.
28pub mod util;
29
30/// A collection of header providers.
31pub mod headers;