From bff80ec378fab29556099f9830bcb42911658710 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BF=97=E5=AE=87?= Date: Fri, 7 Apr 2023 09:23:00 +0800 Subject: [PATCH] [bdk_chain_redesign] Improve `BlockAnchor` docs --- crates/chain/src/tx_data_traits.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/crates/chain/src/tx_data_traits.rs b/crates/chain/src/tx_data_traits.rs index d8cadd13..1399ebeb 100644 --- a/crates/chain/src/tx_data_traits.rs +++ b/crates/chain/src/tx_data_traits.rs @@ -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 {