docs(wallet): Explain .take usage

bitcoindevkit · Dec 10, 2024 · caa0f13 · caa0f13
1 parent 1196405
commit caa0f13
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/wallet/src/wallet/mod.rs b/crates/wallet/src/wallet/mod.rs
@@ -1844,6 +1844,9 @@ impl Wallet {
             .graph()
             .list_canonical_txs(&self.chain, chain_tip)
             .filter(|canon_tx| prev_txids.contains(&canon_tx.tx_node.txid))
+            // This is for a small performance gain. Although `.filter` filters out excess txs, it
+            // will still consume the internal `CanonicalIter` entirely. Having a `.take` here
+            // allows us to stop further unnecessary canonicalization.
             .take(prev_txids.len())
             .map(|canon_tx| {
                 let txid = canon_tx.tx_node.txid;