]> Untitled Git - bdk/commitdiff
[bdk_chain_redesign] Improve `BlockAnchor` docs
author志宇 <hello@evanlinjin.me>
Fri, 7 Apr 2023 01:23:00 +0000 (09:23 +0800)
committer志宇 <hello@evanlinjin.me>
Fri, 7 Apr 2023 01:23:00 +0000 (09:23 +0800)
crates/chain/src/tx_data_traits.rs

index d8cadd13a14522ba616f0dccbaf184c893cb32a1..1399ebeb1b4b29de98f5bc094450193e6e1ced3c 100644 (file)
@@ -34,9 +34,12 @@ impl ForEachTxOut for Transaction {
     }
 }
 
-/// Trait that "anchors" blockchain data in a specific block of height and hash.
+/// Trait that "anchors" blockchain data to a specific block of height and hash.
 ///
-/// This trait is typically associated with blockchain data such as transactions.
+/// I.e. If transaction A is anchored in block B, then if block B is in the best chain, we can
+/// assume that transaction A is also confirmed in the best chain. This does not necessarily mean
+/// that transaction A is confirmed in block B. It could also mean transaction A is confirmed in a
+/// parent block of B.
 pub trait BlockAnchor:
     core::fmt::Debug + Clone + Eq + PartialOrd + Ord + core::hash::Hash + Send + Sync + 'static
 {