feat: add utilities for testing persistence

Added `persist_txgraph_changeset` function and supporting functions.

Author: 110CodingP

crates/testenv/Cargo.toml

@@ -16,8 +16,10 @@ readme = "README.md"
 workspace = true
 
 [dependencies]
-bdk_chain = { path = "../chain", version = "0.23.0", default-features = false }
+bdk_chain = { version = "0.23.0"}
 electrsd = { version = "0.28.0", features = [ "legacy" ], default-features = false }
+anyhow = "1.0.98"
+tempfile = "3.20.0"
 
 [dev-dependencies]
 bdk_testenv = { path = "." }

crates/testenv/src/lib.rs

@@ -1,3 +1,4 @@
+pub mod persist_test_utils;
 pub mod utils;
 
 use bdk_chain::{

crates/testenv/src/persist_test_utils.rs

@@ -0,0 +1,102 @@
+use crate::block_id;
+use bdk_chain::{
+    bitcoin::{
+        absolute, transaction, Amount, OutPoint, ScriptBuf, Transaction, TxIn, TxOut,
+        Txid,
+    },
+    tx_graph, ConfirmationBlockTime, Merge,
+};
+use bdk_chain::bitcoin::{self, hashes::Hash};
+use std::path::Path;
+use std::sync::Arc;
+
+pub fn create_one_inp_one_out_tx(txid: Txid, amount: u64) -> Transaction {
+    Transaction {
+        version: transaction::Version::ONE,
+        lock_time: absolute::LockTime::ZERO,
+        input: vec![TxIn {
+            previous_output: OutPoint::new(txid, 0),
+            ..TxIn::default()
+        }],
+        output: vec![TxOut {
+            value: Amount::from_sat(amount),
+            script_pubkey: ScriptBuf::new(),
+        }],
+    }
+}
+
+pub fn persist_txgraph_changeset<Db, CreateDb, Initialize, Persist>(
+    filename: &str,
+    create_db: CreateDb,
+    initialize: Initialize,
+    persist: Persist,
+)
+// Can we have this for generic anchor type?
+where
+    CreateDb: Fn(&Path) -> anyhow::Result<Db>,
+    Initialize: Fn(&mut Db) -> anyhow::Result<tx_graph::ChangeSet<ConfirmationBlockTime>>,
+    Persist: Fn(&mut Db, &tx_graph::ChangeSet<ConfirmationBlockTime>) -> anyhow::Result<()>,
+    // A: std::fmt::Debug + PartialEq, // decent assumptions since we should be able to
+    // // decide if two anchors are same or different
+{
+    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 tx1 = Arc::new(create_one_inp_one_out_tx(
+        Txid::from_byte_array([0; 32]),
+        30_000,
+    ));
+    let block_id = block_id!(100, "B");
+
+    let conf_anchor: ConfirmationBlockTime = ConfirmationBlockTime {
+        block_id,
+        confirmation_time: 1,
+    };
+
+    let mut tx_graph_changeset1 = tx_graph::ChangeSet::<ConfirmationBlockTime> {
+        txs: [tx1.clone()].into(),
+        txouts: [].into(),
+        anchors: [(conf_anchor, tx1.compute_txid())].into(),
+        last_seen: [(tx1.compute_txid(), 100)].into(),
+        first_seen: [(tx1.compute_txid(), 50)].into(),
+        last_evicted: [(tx1.compute_txid(), 150)].into(),
+    };
+
+    let changeset = initialize(&mut db).expect("should load empty changeset");
+    assert_eq!(
+        changeset,
+        tx_graph::ChangeSet::<ConfirmationBlockTime>::default()
+    );
+
+    persist(&mut db, &tx_graph_changeset1).unwrap();
+
+    let changeset = initialize(&mut db).unwrap();
+    assert_eq!(changeset, tx_graph_changeset1);
+
+    let tx2 = Arc::new(create_one_inp_one_out_tx(tx1.compute_txid(), 20_000));
+    let block_id = block_id!(101, "REDB");
+
+    let conf_anchor: ConfirmationBlockTime = ConfirmationBlockTime {
+        block_id,
+        confirmation_time: 1,
+    };
+
+    let tx_graph_changeset2 = tx_graph::ChangeSet::<ConfirmationBlockTime> {
+        txs: [tx2.clone()].into(),
+        txouts: [].into(),
+        anchors: [(conf_anchor, tx2.compute_txid())].into(),
+        last_seen: [(tx2.compute_txid(), 200)].into(),
+        first_seen: [(tx2.compute_txid(), 100)].into(),
+        last_evicted: [(tx2.compute_txid(), 150)].into(),
+    };
+
+    persist(&mut db, &tx_graph_changeset2).unwrap();
+
+    let changeset = initialize(&mut db).unwrap();
+
+    tx_graph_changeset1.merge(tx_graph_changeset2);
+
+    assert_eq!(tx_graph_changeset1, changeset);
+}
+
+// perhaps add test for file_store, sqlite, redb here.