feat(chain): Add initial_changeset to graphs

Add `initial_changeset` to TxGraph and IndexedTxGraph

Author: danielabrozzoni

crates/chain/src/indexed_tx_graph.rs

@@ -61,6 +61,13 @@ impl<A: Anchor, I: Indexer> IndexedTxGraph<A, I> {
 
         self.graph.apply_changeset(graph);
     }
+
+    /// Determines the changeset between self and the empty [`IndexedTxGraph`].
+    pub fn initial_changeset(&self) -> ChangeSet<A, I::ChangeSet> {
+        let graph = self.graph.initial_changeset();
+        let indexer = self.index.initial_changeset();
+        ChangeSet { graph, indexer }
+    }
 }
 
 impl<A: Anchor, I: Indexer> IndexedTxGraph<A, I>
@@ -234,6 +241,9 @@ pub trait Indexer {
     /// Apply changeset to itself.
     fn apply_changeset(&mut self, changeset: Self::ChangeSet);
 
+    /// Determines the changeset between self and the empty [`Indexer`].
+    fn initial_changeset(&self) -> Self::ChangeSet;
+
     /// Determines whether the transaction should be included in the index.
     fn is_tx_relevant(&self, tx: &Transaction) -> bool;
 }

crates/chain/src/keychain.rs

@@ -20,6 +20,7 @@ mod txout_index;
 pub use txout_index::*;
 
 /// Represents updates to the derivation index of a [`KeychainTxOutIndex`].
+/// It maps each keychain `K` to its last revealed index.
 ///
 /// It can be applied to [`KeychainTxOutIndex`] with [`apply_changeset`]. [`ChangeSet] are
 /// monotone in that they will never decrease the revealed derivation index.

crates/chain/src/keychain/txout_index.rs

@@ -98,6 +98,10 @@ impl<K: Clone + Ord + Debug> Indexer for KeychainTxOutIndex<K> {
         self.scan(tx)
     }
 
+    fn initial_changeset(&self) -> Self::ChangeSet {
+        super::ChangeSet(self.last_revealed.clone())
+    }
+
     fn apply_changeset(&mut self, changeset: Self::ChangeSet) {
         self.apply_changeset(changeset)
     }

crates/chain/src/spk_txout_index.rs

@@ -66,6 +66,8 @@ impl<I: Clone + Ord> Indexer for SpkTxOutIndex<I> {
         Default::default()
     }
 
+    fn initial_changeset(&self) -> Self::ChangeSet {}
+
     fn apply_changeset(&mut self, _changeset: Self::ChangeSet) {
         // This applies nothing.
     }

crates/chain/src/tx_graph.rs

@@ -438,6 +438,11 @@ impl<A: Clone + Ord> TxGraph<A> {
         changeset
     }
 
+    /// Determines the changeset between self and the empty [`TxGraph`].
+    pub fn initial_changeset(&self) -> ChangeSet<A> {
+        Self::default().apply_update(self.clone())
+    }
+
     /// Applies [`ChangeSet`] to [`TxGraph`].
     pub fn apply_changeset(&mut self, changeset: ChangeSet<A>) {
         for tx in changeset.txs {

crates/chain/tests/test_indexed_tx_graph.rs

@@ -65,16 +65,20 @@ fn insert_relevant_txs() {
 
     let txs = [tx_c, tx_b, tx_a];
 
+    let changeset = indexed_tx_graph::ChangeSet {
+        graph: tx_graph::ChangeSet {
+            txs: txs.clone().into(),
+            ..Default::default()
+        },
+        indexer: keychain::ChangeSet([((), 9_u32)].into()),
+    };
+
     assert_eq!(
         graph.insert_relevant_txs(txs.iter().map(|tx| (tx, None)), None),
-        indexed_tx_graph::ChangeSet {
-            graph: tx_graph::ChangeSet {
-                txs: txs.into(),
-                ..Default::default()
-            },
-            indexer: keychain::ChangeSet([((), 9_u32)].into()),
-        }
-    )
+        changeset,
+    );
+
+    assert_eq!(graph.initial_changeset(), changeset,);
 }
 
 #[test]

crates/chain/tests/test_keychain_txout_index.rs

@@ -43,6 +43,8 @@ fn spk_at_index(descriptor: &Descriptor<DescriptorPublicKey>, index: u32) -> Scr
 
 #[test]
 fn test_set_all_derivation_indices() {
+    use bdk_chain::indexed_tx_graph::Indexer;
+
     let (mut txout_index, _, _) = init_txout_index();
     let derive_to: BTreeMap<_, _> =
         [(TestKeychain::External, 12), (TestKeychain::Internal, 24)].into();
@@ -56,6 +58,7 @@ fn test_set_all_derivation_indices() {
         keychain::ChangeSet::default(),
         "no changes if we set to the same thing"
     );
+    assert_eq!(txout_index.initial_changeset().as_inner(), &derive_to);
 }
 
 #[test]

crates/chain/tests/test_tx_graph.rs

@@ -141,14 +141,14 @@ fn insert_txouts() {
         changeset,
         ChangeSet {
             txs: [update_txs.clone()].into(),
-            txouts: update_ops.into(),
+            txouts: update_ops.clone().into(),
             anchors: [(conf_anchor, update_txs.txid()), (unconf_anchor, h!("tx2"))].into(),
             last_seen: [(h!("tx2"), 1000000)].into()
         }
     );
 
     // Apply changeset and check the new graph counts.
-    graph.apply_changeset(changeset);
+    graph.apply_changeset(changeset.clone());
     assert_eq!(graph.all_txouts().count(), 4);
     assert_eq!(graph.full_txs().count(), 1);
     assert_eq!(graph.floating_txouts().count(), 3);
@@ -186,6 +186,17 @@ fn insert_txouts() {
         )]
         .into()
     );
+
+    // Check that the initial_changeset is correct
+    assert_eq!(
+        graph.initial_changeset(),
+        ChangeSet {
+            txs: [update_txs.clone()].into(),
+            txouts: update_ops.into_iter().chain(original_ops).collect(),
+            anchors: [(conf_anchor, update_txs.txid()), (unconf_anchor, h!("tx2"))].into(),
+            last_seen: [(h!("tx2"), 1000000)].into()
+        }
+    );
 }
 
 #[test]