Improve documentation of DiversifierKey#diversifier_index
Co-authored-by: str4d <jack@electriccoin.co>
This commit is contained in:
parent
8e934682bb
commit
c72ddb1251
|
@ -160,8 +160,11 @@ impl DiversifierKey {
|
||||||
Self::try_diversifier_internal(&ff, j)
|
Self::try_diversifier_internal(&ff, j)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Decrypts a diversifier using this diversifier key to obtain the
|
/// Returns the diversifier index to which this key maps the given diversifier.
|
||||||
/// diversifier index from which it was originally created.
|
///
|
||||||
|
/// This method cannot be used to verify whether the diversifier was originally
|
||||||
|
/// generated with this diversifier key, because all valid diversifiers can be
|
||||||
|
/// produced by all diversifier keys.
|
||||||
pub fn diversifier_index(&self, d: &Diversifier) -> DiversifierIndex {
|
pub fn diversifier_index(&self, d: &Diversifier) -> DiversifierIndex {
|
||||||
let ff = FF1::<Aes256>::new(&self.0, 2).unwrap();
|
let ff = FF1::<Aes256>::new(&self.0, 2).unwrap();
|
||||||
let dec = ff
|
let dec = ff
|
||||||
|
|
Loading…
Reference in New Issue