]> Untitled Git - bdk/commitdiff
doc(chain): Clarify direct_conflicts_of_tx's docs
authorDaniela Brozzoni <danielabrozzoni@protonmail.com>
Fri, 29 Sep 2023 14:51:15 +0000 (16:51 +0200)
committerDaniela Brozzoni <danielabrozzoni@protonmail.com>
Tue, 3 Oct 2023 13:12:35 +0000 (15:12 +0200)
Co-authored-by: Wei Chen <wzc110@gmail.com>
crates/chain/src/tx_graph.rs

index 4c0cdb3d83dca83defe8b02b570eb86c1fb906f7..036f116d0ca997d256fefa701637b0c801f3f21e 100644 (file)
@@ -381,8 +381,9 @@ impl<A> TxGraph<A> {
     /// transaction's inputs (spends). The conflicting txids are returned with the given
     /// transaction's vin (in which it conflicts).
     ///
-    /// Note that this only returns directly conflicting txids and does not include descendants of
-    /// those txids (which are technically also conflicting).
+    /// Note that this only returns directly conflicting txids and won't include:
+    /// - descendants of conflicting transactions (which are technically also conflicting)
+    /// - transactions conflicting with the given transaction's ancestors
     pub fn direct_conflicts_of_tx<'g>(
         &'g self,
         tx: &'g Transaction,