Clarify zero-conf shielded note behaviour for `get_wallet_summary`

Co-authored-by: Daira Emma Hopwood <daira@jacaranda.org>
This commit is contained in:
str4d 2023-09-06 00:18:11 +01:00 committed by GitHub
parent 6cbb107c71
commit 1e12e9d0e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions

View File

@ -584,6 +584,9 @@ impl ScanProgress for SubtreeScanProgress {
///
/// This may be used to obtain a balance that ignores notes that have been detected so recently
/// that they are not yet spendable, or for which it is not yet possible to construct witnesses.
///
/// `min_confirmations` can be 0, but that case is currently treated identically to
/// `min_confirmations == 1` for shielded notes. This behaviour may change in the future.
pub(crate) fn get_wallet_summary(
conn: &rusqlite::Connection,
min_confirmations: u32,