frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc(electrum_ext): fix docs for RelevantTxids::into_confirmation_time_tx_graph

Browse Source
This commit is contained in:
vmammal 2024-01-17 13:49:58 -05:00
parent 40f0765d30
commit cf0c333744
No known key found for this signature in database
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/electrum/src/electrum_ext.rs
View File

@ -56,12 +56,14 @@ impl RelevantTxids {
Ok(graph) Ok(graph)
} }
/// Finalizes [`RelevantTxids`] with `new_txs` and anchors of type /// Finalizes the update by fetching `missing` txids from the `client`, where the
/// [`ConfirmationTimeHeightAnchor`]. /// resulting [`TxGraph`] has anchors of type [`ConfirmationTimeHeightAnchor`].
///
/// Refer to [`RelevantTxids`] for more details.
/// ///
/// **Note:** The confirmation time might not be precisely correct if there has been a reorg. /// **Note:** The confirmation time might not be precisely correct if there has been a reorg.
/// Electrum's API intends that we use the merkle proof API, we should change `bdk_electrum` to // Electrum's API intends that we use the merkle proof API, we should change `bdk_electrum` to
/// use it. // use it.
pub fn into_confirmation_time_tx_graph( pub fn into_confirmation_time_tx_graph(
self, self,
client: &Client, client: &Client,