engine/
lib.rs

1// Copyright 2020-2021 IOTA Stiftung
2// SPDX-License-Identifier: Apache-2.0
3
4//! A system for securely managing secrets.
5//!
6//! This top-level crate contains references to the others that make up
7//! the IOTA Stronghold's low-level crates known as "Stronghold-Engine".
8//!
9//! # Layout
10//!
11//! This framework is divided into the following crates:
12//!
13//! - `vault`: logic and abstractions for the storage layer
14//! - `snapshot`: method for storing the state of the vault in a file
15//! - `store`: a simple unencrypted storage protocol
16//!
17//! ## WARNING
18//!
19//! This library has not yet been audited for security, so use at your own peril.
20//! Until a formal third-party security audit has taken place, the IOTA Foundation
21//! makes no guarantees to the fitness of this library for any purposes.
22
23pub mod snapshot;
24pub mod store;
25pub mod vault;
26pub use runtime;