Improve docs on filter_header

This commit is contained in:
Tobin C. Harding 2022-08-09 15:08:29 +10:00
parent e0fddce9e9
commit e9846ad579
1 changed files with 3 additions and 1 deletions

View File

@ -135,7 +135,9 @@ impl BlockFilter {
Ok(BlockFilter { content: out }) Ok(BlockFilter { content: out })
} }
/// compute this filter's id in a chain of filters /// Computes this filter's ID in a chain of filters (see [BIP 157]).
///
/// [BIP 157]: <https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#Filter_Headers>
pub fn filter_header(&self, previous_filter_header: &FilterHeader) -> FilterHeader { pub fn filter_header(&self, previous_filter_header: &FilterHeader) -> FilterHeader {
let filter_hash = FilterHash::hash(self.content.as_slice()); let filter_hash = FilterHash::hash(self.content.as_slice());
filter_hash.filter_header(previous_filter_header) filter_hash.filter_header(previous_filter_header)