feat: support a separate storage directory for observers.sqlite (#354)

* chore: observers db dir

* fix: control observers path only on db functions

* chore: test structure

* test: incorrect predicate

* fix: test predicate registration

* test: more

* fix: duplicate uuid test

Author: rafaelcr

.cargo/config.toml

@@ -1,2 +1,5 @@
 [alias]
 ordhook-install = "install --path components/ordhook-cli --locked --force"
+
+[env]
+RUST_TEST_THREADS = "1"

components/ordhook-cli/src/cli/mod.rs

@@ -579,7 +579,7 @@ async fn handle_command(opts: Opts, ctx: &Context) -> Result<(), String> {
                     false,
                 )?;
 
-                let _ = initialize_observers_db(&config.expected_cache_path(), ctx);
+                let _ = initialize_observers_db(&config, ctx);
 
                 scan_bitcoin_chainstate_via_rpc_using_predicate(
                     &predicate_spec,
@@ -631,7 +631,10 @@ async fn handle_command(opts: Opts, ctx: &Context) -> Result<(), String> {
                                 if row.operation == "transfer_receive" {
                                     continue;
                                 }
-                                println!("BRC-20 {} {} {}", row.operation, row.tick, row.avail_balance);
+                                println!(
+                                    "BRC-20 {} {} {}",
+                                    row.operation, row.tick, row.avail_balance
+                                );
                             }
                         }
                         None => todo!(),

components/ordhook-cli/src/config/file.rs

@@ -65,6 +65,10 @@ impl ConfigFile {
         let config = Config {
             storage: StorageConfig {
                 working_dir: config_file.storage.working_dir.unwrap_or("ordhook".into()),
+                observers_working_dir: config_file
+                    .storage
+                    .observers_working_dir
+                    .unwrap_or("observers".into()),
             },
             http_api: match config_file.http_api {
                 None => PredicatesApi::Off,
@@ -176,6 +180,7 @@ pub struct LogConfigFile {
 #[derive(Deserialize, Debug, Clone)]
 pub struct StorageConfigFile {
     pub working_dir: Option<String>,
+    pub observers_working_dir: Option<String>,
 }
 
 #[derive(Deserialize, Debug, Clone)]

components/ordhook-core/src/config/mod.rs

@@ -44,6 +44,7 @@ pub struct LogConfig {
 #[derive(Clone, Debug)]
 pub struct StorageConfig {
     pub working_dir: String,
+    pub observers_working_dir: String,
 }
 
 #[derive(Clone, Debug)]
@@ -161,10 +162,17 @@ impl Config {
         destination_path
     }
 
+    pub fn expected_observers_cache_path(&self) -> PathBuf {
+        let mut destination_path = PathBuf::new();
+        destination_path.push(&self.storage.observers_working_dir);
+        destination_path
+    }
+
     pub fn devnet_default() -> Config {
         Config {
             storage: StorageConfig {
                 working_dir: default_cache_path(),
+                observers_working_dir: default_observers_cache_path(),
             },
             http_api: PredicatesApi::Off,
             snapshot: SnapshotConfig::Build,
@@ -199,6 +207,7 @@ impl Config {
         Config {
             storage: StorageConfig {
                 working_dir: default_cache_path(),
+                observers_working_dir: default_observers_cache_path(),
             },
             http_api: PredicatesApi::Off,
             snapshot: SnapshotConfig::Build,
@@ -233,6 +242,7 @@ impl Config {
         Config {
             storage: StorageConfig {
                 working_dir: default_cache_path(),
+                observers_working_dir: default_observers_cache_path(),
             },
             http_api: PredicatesApi::Off,
             snapshot: SnapshotConfig::Download(SnapshotConfigDownloadUrls {
@@ -272,3 +282,9 @@ pub fn default_cache_path() -> String {
     cache_path.push("ordhook");
     format!("{}", cache_path.display())
 }
+
+pub fn default_observers_cache_path() -> String {
+    let mut cache_path = std::env::current_dir().expect("unable to get current dir");
+    cache_path.push("observers");
+    format!("{}", cache_path.display())
+}

components/ordhook-core/src/core/meta_protocols/brc20/db.rs

@@ -9,9 +9,8 @@ use crate::{
 };
 use chainhook_sdk::{
     types::{
-        BitcoinBlockData, BitcoinTransactionData, BlockIdentifier, Brc20BalanceData,
-        Brc20Operation, Brc20TokenDeployData, Brc20TransferData, OrdinalInscriptionRevealData,
-        OrdinalOperation,
+        BitcoinBlockData, BitcoinTransactionData, Brc20BalanceData, Brc20Operation,
+        Brc20TokenDeployData, Brc20TransferData, OrdinalInscriptionRevealData, OrdinalOperation,
     },
     utils::Context,
 };

components/ordhook-core/src/download/mod.rs

@@ -190,7 +190,9 @@ async fn validate_or_download_archive_file(
 
     if should_download {
         try_info!(ctx, "Downloading {remote_archive_url}");
-        match download_and_decompress_archive_file(remote_archive_url, file_name, &config, &ctx).await {
+        match download_and_decompress_archive_file(remote_archive_url, file_name, &config, &ctx)
+            .await
+        {
             Ok(_) => {}
             Err(e) => {
                 try_error!(ctx, "{e}");

components/ordhook-core/src/scan/bitcoin.rs

@@ -157,8 +157,7 @@ pub async fn scan_bitcoin_chainstate_via_rpc_using_predicate(
             Err(e) => return Err(format!("Scan aborted: {e}")),
         }
         {
-            let observers_db_conn =
-                open_readwrite_observers_db_conn_or_panic(&config.expected_cache_path(), &ctx);
+            let observers_db_conn = open_readwrite_observers_db_conn_or_panic(&config, &ctx);
             update_observer_progress(
                 &predicate_spec.uuid,
                 current_block_height,