Skip to content

Commit c562f33

Browse files
committed
Clarify 'should' vs 'will' in get_relevant_txids
1 parent 2f4457f commit c562f33

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

lightning/src/chain/mod.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,15 +151,15 @@ pub trait Confirm {
151151
/// in the event of a chain reorganization, it must not be called with a `header` that is no
152152
/// longer in the chain as of the last call to [`best_block_updated`].
153153
///
154-
/// [chain order]: Confirm#Order
154+
/// [chain order]: Confirm#order
155155
/// [`best_block_updated`]: Self::best_block_updated
156156
fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32);
157157

158158
/// Processes a transaction that is no longer confirmed as result of a chain reorganization.
159159
///
160160
/// Should be called for any transaction returned by [`get_relevant_txids`] if it has been
161-
/// reorganized out of the best chain. Once called, the given transaction should not be returned
162-
/// by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
161+
/// reorganized out of the best chain. Once called, the given transaction will not be returned
162+
/// by [`get_relevant_txids`], unless it has been reconfirmed via [`transactions_confirmed`].
163163
///
164164
/// [`get_relevant_txids`]: Self::get_relevant_txids
165165
/// [`transactions_confirmed`]: Self::transactions_confirmed
@@ -173,9 +173,9 @@ pub trait Confirm {
173173

174174
/// Returns transactions that should be monitored for reorganization out of the chain.
175175
///
176-
/// Should include any transactions passed to [`transactions_confirmed`] that have insufficient
177-
/// confirmations to be safe from a chain reorganization. Should not include any transactions
178-
/// passed to [`transaction_unconfirmed`] unless later reconfirmed.
176+
/// Will include any transactions passed to [`transactions_confirmed`] that have insufficient
177+
/// confirmations to be safe from a chain reorganization. Will not include any transactions
178+
/// passed to [`transaction_unconfirmed`], unless later reconfirmed.
179179
///
180180
/// May be called to determine the subset of transactions that must still be monitored for
181181
/// reorganization. Will be idempotent between calls but may change as a result of calls to the

0 commit comments

Comments
 (0)