Doc improvements #1693
Labels
audit
Suggested as result of external code audit
documentation
Improvements or additions to documentation
module-blockchain
bdk_chain
CheckPoint
's doc comment could mention it's guaranteed to always have at least one element, since it's an invariant relied upon across the project.merge_chains
's doc comment is outdated.walk_descendants
's doc could mention it excludes the root tx from the iterator.SpkIterator::next()
, derived_descriptor's descriptor is unwrapped because "the descriptor cannot need hardened derivation". It'd be better to have "we check it's never hardened in the constructor" as it's a stronger invariant. (Mentioning as I initially missed it was also checked inSpkIterator::new_with_range()
by re-assigning to end the minimum between end andBIP32_MAX_INDEX
.)bdk_esplora
The text was updated successfully, but these errors were encountered: