pczt: Document how `expected_fvk` is used by `Spend::verify_nullifier`
This commit is contained in:
parent
88b64418c5
commit
0d39b4444f
|
@ -56,8 +56,12 @@ impl super::Spend {
|
||||||
/// - `rseed`
|
/// - `rseed`
|
||||||
/// - `witness`
|
/// - `witness`
|
||||||
///
|
///
|
||||||
|
/// In addition, at least one of the `proof_generation_key` field or `expected_fvk`
|
||||||
|
/// must be provided.
|
||||||
|
///
|
||||||
/// The provided [`FullViewingKey`] is ignored if the spent note is a dummy note.
|
/// The provided [`FullViewingKey`] is ignored if the spent note is a dummy note.
|
||||||
/// Otherwise, it will be checked against the `proof_generation_key` field (if set).
|
/// Otherwise, it will be checked against the `proof_generation_key` field (if both
|
||||||
|
/// are set).
|
||||||
pub fn verify_nullifier(
|
pub fn verify_nullifier(
|
||||||
&self,
|
&self,
|
||||||
expected_fvk: Option<&FullViewingKey>,
|
expected_fvk: Option<&FullViewingKey>,
|
||||||
|
|
Loading…
Reference in New Issue