From 41ca63e29d7819c4e78f62a8295e0072af435f76 Mon Sep 17 00:00:00 2001 From: SpaghettiSats Date: Thu, 21 Sep 2023 12:35:29 +0200 Subject: [PATCH] docs: improve chain tip definition --- crates/chain/src/tx_graph.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/crates/chain/src/tx_graph.rs b/crates/chain/src/tx_graph.rs index 734ed2888..eb2114029 100644 --- a/crates/chain/src/tx_graph.rs +++ b/crates/chain/src/tx_graph.rs @@ -645,7 +645,7 @@ impl TxGraph { /// Get the position of the transaction in `chain` with tip `chain_tip`. /// /// This method is like [`try_get_chain_position`] except it restricts the - /// chain to a custom tip. The tip doesn't even need to be in the same chain as the tip. + /// chain to a custom tip. The tip doesn't even need to be in the same chain as the current tip. /// You can use this to find information about a point in the past or on a fork if your /// chain oracle supports that. /// @@ -758,7 +758,7 @@ impl TxGraph { /// If no in-chain transaction spends `outpoint`, `None` will be returned. /// /// This method is like [`try_get_chain_spend`] except it restricts the chain to a custom tip. - /// The tip doesn't even need to be in the same chain as the tip. You can use this to find information + /// The tip doesn't even need to be in the same chain as the current tip. You can use this to find information /// about a point in the past or on a fork if your chain oracle supports that. /// /// # Error @@ -845,7 +845,7 @@ impl TxGraph { /// List graph transactions that are in `chain` with `chain_tip`. /// /// This method is like `try_list_chain_txs` except it restricts the chain to a custom tip. - /// The tip doesn't even need to be in the same chain as the tip. You can use this to find information + /// The tip doesn't even need to be in the same chain as the current tip. You can use this to find information /// about a point in the past or on a fork if your chain oracle supports that. /// /// Each transaction is represented as a [`CanonicalTx`] that contains where the transaction is @@ -932,7 +932,7 @@ impl TxGraph { /// `chain_tip`. /// /// This method is like [`try_filter_chain_txouts`] except it restricts the chain to a custom tip. - /// The tip doesn't even need to be in the same chain as the tip. You can use this to find information + /// The tip doesn't even need to be in the same chain as the current tip. You can use this to find information /// about a point in the past or on a fork if your chain oracle supports that. /// /// `outpoints` is a list of outpoints we are interested in, coupled with an outpoint identifier @@ -1059,7 +1059,7 @@ impl TxGraph { /// `chain` with `chain_tip`. /// /// This method is like [`try_filter_chain_unspents`] except it restricts the chain to a custom tip. - /// The tip doesn't even need to be in the same chain as the tip. You can use this to find information + /// The tip doesn't even need to be in the same chain as the current tip. You can use this to find information /// about a point in the past or on a fork if your chain oracle supports that. /// /// `outpoints` is a list of outpoints we are interested in, coupled with an outpoint identifier @@ -1157,7 +1157,7 @@ impl TxGraph { /// Get the total balance of `outpoints` that are in `chain` of `chain_tip`. /// /// This method is like [`try_balance`] except it restricts the chain to a custom tip. - /// The tip doesn't even need to be in the same chain as the tip. You can use this to find information + /// The tip doesn't even need to be in the same chain as the current tip. You can use this to find information /// about a point in the past or on a fork if your chain oracle supports that. /// /// The output of `trust_predicate` should return `true` for scripts that we trust.