zec
/
librustzcash
mirror of https://github.com/zcash/librustzcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

zcash_client_backend: Add detail to documentation of `suggest_scan_ranges` 

Fixes #971
This commit is contained in:
Kris Nuttycombe 2023-09-20 12:39:36 -06:00
parent 6b472fd684
commit 996fea70ac
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
zcash_client_backend/src/data_api.rs
View File

@ -257,7 +257,11 @@ pub trait WalletRead {
/// tree size information for each block; or else the scan is likely to fail if notes belonging
/// to the wallet are detected.
///
/// The returned range(s) may include block heights beyond the current chain tip.
/// The returned range(s) may include block heights beyond the current chain tip. Ranges are
/// returned in order of descending priority, and higher-priority ranges should always be
/// scanned before lower-priority ranges; in particular, ranges with [`ScanPriority::Verify`]
/// priority must always be scanned first in order to avoid blockchain continuity errors in the
/// case of a reorg.
///
/// [`CompactBlock`]: crate::proto::compact_formats::CompactBlock
fn suggest_scan_ranges(&self) -> Result<Vec<ScanRange>, Self::Error>;