Better code organization

src/main.rs

@@ -221,7 +221,7 @@ async fn update_status(
 }
 
 pub struct Ledger {
-    _inner: verax::Ledger<'static, verax::Batch<'static>, verax::SQLite<'static>>,
+    _inner: verax::Ledger<'static, verax::storage::Cache<'static, verax::storage::SQLite<'static>>>,
 }
 
 #[actix_web::main]
@@ -237,20 +237,21 @@ async fn main() -> std::io::Result<()> {
     ]);
 
     let settings = "sqlite:./test.db"
-        .parse::<verax::sqlite::SqliteConnectOptions>()
+        .parse::<verax::storage::sqlite::SqliteConnectOptions>()
         .expect("valid settings")
         .create_if_missing(true);
 
-    let pool = verax::sqlite::SqlitePoolOptions::new()
+    let pool = verax::storage::sqlite::SqlitePoolOptions::new()
         .connect_with(settings)
         .await
         .expect("pool");
 
-    let storage = verax::SQLite::new(pool.clone(), asset_manager.clone());
+    let storage = verax::storage::SQLite::new(pool.clone(), asset_manager.clone());
     storage.setup().await.expect("setup");
 
     HttpServer::new(move || {
-        let storage = verax::SQLite::new(pool.clone(), asset_manager.clone());
+        let inner_storage = verax::storage::SQLite::new(pool.clone(), asset_manager.clone());
+        let storage = verax::storage::Cache::new(inner_storage);
         let ledger = verax::Ledger::new(storage, asset_manager.clone());
         App::new()
             .wrap(Logger::default())

utxo/src/lib.rs

@@ -23,15 +23,12 @@
 mod amount;
 mod asset;
 mod asset_manager;
-mod cache;
 mod changelog;
 mod error;
 mod id;
 mod ledger;
 mod payment;
 mod serde;
-#[cfg(any(feature = "sqlite", test))]
-pub mod sqlite;
 mod status;
 pub mod storage;
 #[cfg(test)]
@@ -52,6 +49,3 @@ pub use self::{
     status::Status,
     transaction::{Transaction, Type},
 };
-
-#[cfg(any(feature = "sqlite", test))]
-pub use self::sqlite::{Batch, SQLite};

utxo/src/cache/mod.rs → utxo/src/storage/cache/mod.rs

@@ -1,3 +1,4 @@
+//! Cache storage implementation.
 use crate::{
     amount::AmountCents,
     asset::AssetId,
@@ -14,6 +15,11 @@ mod batch;
 
 pub(crate) type CacheStorage<K, V> = Arc<RwLock<HashMap<K, V>>>;
 
+/// Cache storage implementation.
+///
+/// This cache will wrap any actual storage and will add an in memory caching to
+/// offer better performance. This layer will also manager cache eviction and
+/// invalidation.
 pub struct Cache<'a, S>
 where
     S: Storage<'a> + Sync + Send,
@@ -29,7 +35,7 @@ impl<'a, S> Cache<'a, S>
 where
     S: Storage<'a> + Sync + Send,
 {
-    #[allow(unused)]
+    /// Create a new cache storage.
     pub fn new(storage: S) -> Self {
         Self {
             payments: Arc::new(RwLock::new(HashMap::new())),
@@ -134,7 +140,8 @@ where
 mod test {
     use super::*;
     use crate::{
-        storage_test_suite, tests::deposit, AssetDefinition, AssetManager, Ledger, SQLite, Status,
+        storage::sqlite::SQLite, storage_test_suite, tests::deposit, AssetDefinition, AssetManager,
+        Ledger, Status,
     };
     use sqlx::sqlite::{SqliteConnectOptions, SqlitePoolOptions};
     use std::fs::remove_file;

utxo/src/storage.rs → utxo/src/storage/mod.rs

@@ -8,6 +8,13 @@ use crate::{
 };
 use serde::{de::DeserializeOwned, Serialize};
 
+pub mod cache;
+#[cfg(any(feature = "sqlite", test))]
+pub mod sqlite;
+pub use self::cache::Cache;
+#[cfg(any(feature = "sqlite", test))]
+pub use self::sqlite::SQLite;
+
 #[derive(thiserror::Error, Debug, Serialize)]
 /// Storage error
 pub enum Error {

utxo/src/tests/mod.rs

@@ -1,5 +1,5 @@
 use crate::{
-    asset_manager::AssetDefinition, sqlite::SQLite, storage::Storage, AccountId, Amount,
+    asset_manager::AssetDefinition, storage::sqlite::SQLite, storage::Storage, AccountId, Amount,
     AssetManager, Error, Ledger, Status, TransactionId,
 };
 use sqlx::sqlite::SqlitePoolOptions;