feat: add utility to check indexer persistence

Author: 110CodingP

crates/testenv/src/persist_test_utils.rs

@@ -1,14 +1,13 @@
 use crate::block_id;
+use bdk_chain::bitcoin::{self, hashes::Hash};
 use bdk_chain::{
-    bitcoin::{
-        absolute, transaction, Amount, OutPoint, ScriptBuf, Transaction, TxIn, TxOut,
-        Txid,
-    },
-    tx_graph, ConfirmationBlockTime, Merge,
+    bitcoin::{absolute, transaction, Amount, OutPoint, ScriptBuf, Transaction, TxIn, TxOut, Txid},
+    indexer::keychain_txout,
+    tx_graph, ConfirmationBlockTime, Merge, DescriptorExt
 };
-use bdk_chain::bitcoin::{self, hashes::Hash};
 use std::path::Path;
 use std::sync::Arc;
+use bdk_chain::miniscript::{Descriptor, DescriptorPublicKey};
 
 pub fn create_one_inp_one_out_tx(txid: Txid, amount: u64) -> Transaction {
     Transaction {
@@ -99,4 +98,73 @@ where
     assert_eq!(tx_graph_changeset1, changeset);
 }
 
+pub fn parse_descriptor(descriptor: &str) -> Descriptor<DescriptorPublicKey> {
+    let secp = bdk_chain::bitcoin::secp256k1::Secp256k1::signing_only();
+    Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, descriptor)
+        .unwrap()
+        .0
+}
+
+pub fn persist_indexer_changeset<Db, CreateDb, Initialize, Persist>(
+    filename: &str,
+    create_db: CreateDb,
+    initialize: Initialize,
+    persist: Persist,
+) where
+    CreateDb: Fn(&Path) -> anyhow::Result<Db>,
+    Initialize: Fn(&mut Db) -> anyhow::Result<keychain_txout::ChangeSet>,
+    Persist: Fn(&mut Db, &keychain_txout::ChangeSet) -> anyhow::Result<()>,
+{
+    let temp_dir = tempfile::tempdir().expect("must create tempdir");
+    let file_path = temp_dir.path().join(filename);
+    let mut db = create_db(&file_path).expect("db should get created");
+
+    let descriptor_ids = crate::utils::DESCRIPTORS.map(|d| parse_descriptor(d).descriptor_id());
+
+    let mut keychain_txout_changeset = keychain_txout::ChangeSet {
+        last_revealed: [(descriptor_ids[0], 1), (descriptor_ids[1], 100)].into(),
+        spk_cache: [
+            (
+                descriptor_ids[0],
+                [(0u32, ScriptBuf::from_bytes(vec![1, 2, 3]))].into(),
+            ),
+            (
+                descriptor_ids[1],
+                [
+                    (100u32, ScriptBuf::from_bytes(vec![3])),
+                    (1000u32, ScriptBuf::from_bytes(vec![5, 6, 8])),
+                ]
+                .into(),
+            ),
+        ]
+        .into(),
+    };
+
+    let changeset = initialize(&mut db).expect("should load empty changeset");
+    assert_eq!(changeset, keychain_txout::ChangeSet::default());
+
+
+    persist(&mut db, &keychain_txout_changeset).expect("should persist keychain_txout");
+
+    let changeset = initialize(&mut db).expect("should load persisted changeset");
+
+    assert_eq!(changeset, keychain_txout_changeset);
+
+    let keychain_txout_changeset_new = keychain_txout::ChangeSet {
+        last_revealed: [(descriptor_ids[0], 2)].into(),
+        spk_cache: [(
+            descriptor_ids[0],
+            [(1u32, ScriptBuf::from_bytes(vec![1, 2, 3]))].into(),
+        )]
+        .into(),
+    };
+
+    persist(&mut db, &keychain_txout_changeset_new).expect("should persist second changeset");
+
+    let changeset_new = initialize(&mut db).expect("should load merged changesets");
+    keychain_txout_changeset.merge(keychain_txout_changeset_new);
+
+    assert_eq!(changeset_new, keychain_txout_changeset);
+}
+
 // perhaps add test for file_store, sqlite, redb here.