Skip to content

Commit 99661be

Browse files
Merge #1289: doc(electrum_ext): fix docs for `RelevantTxids::into_confirmation_tim…
cf0c333 doc(electrum_ext): fix docs for `RelevantTxids::into_confirmation_time_tx_graph` (vmammal) Pull request description: Note also, the bit referring to Electrum's API sounds more like a developer note, so I made it a regular code comment. ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: danielabrozzoni: ACK cf0c333 Tree-SHA512: 0ebd6a753c8a0c573510a4d866068cb6e1c7e356c43b20b5179331a1b7d567e4dfbf7012c63ba9b7b9566bf6564a2d957d12e54d5c0232b7be9869dfe0958e85
2 parents f8f371c + cf0c333 commit 99661be

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

crates/electrum/src/electrum_ext.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,14 @@ impl RelevantTxids {
5656
Ok(graph)
5757
}
5858

59-
/// Finalizes [`RelevantTxids`] with `new_txs` and anchors of type
60-
/// [`ConfirmationTimeHeightAnchor`].
59+
/// Finalizes the update by fetching `missing` txids from the `client`, where the
60+
/// resulting [`TxGraph`] has anchors of type [`ConfirmationTimeHeightAnchor`].
61+
///
62+
/// Refer to [`RelevantTxids`] for more details.
6163
///
6264
/// **Note:** The confirmation time might not be precisely correct if there has been a reorg.
63-
/// Electrum's API intends that we use the merkle proof API, we should change `bdk_electrum` to
64-
/// use it.
65+
// Electrum's API intends that we use the merkle proof API, we should change `bdk_electrum` to
66+
// use it.
6567
pub fn into_confirmation_time_tx_graph(
6668
self,
6769
client: &Client,

0 commit comments

Comments
 (0)