vss_client/
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/// Implements a thin-client ([`client::VssClient`]) to access a hosted instance of Versioned Storage Service (VSS).
15pub mod client;
16
17/// Implements the error type ([`error::VssError`]) returned on interacting with [`client::VssClient`]
18pub mod error;
19
20/// Contains request/response types generated from the API definition of VSS.
21pub mod types;
22
23/// Contains utils for encryption, requests-retries etc.
24pub mod util;
25
26// Encryption-Decryption related crate-only helpers.
27pub(crate) mod crypto;
28
29/// A collection of header providers.
30pub mod headers;