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

Minor fixes to documentation

This commit is contained in:
str4d 2021-03-26 14:18:01 +13:00 committed by GitHub
parent c3c7bd1d9c
commit d73483f5da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
zcash_client_backend/src/welding_rig.rs
View File

@ -24,7 +24,7 @@ use crate::wallet::{AccountId, WalletShieldedOutput, WalletShieldedSpend, Wallet
/// The given [`CommitmentTree`] and existing [`IncrementalWitness`]es are incremented /// The given [`CommitmentTree`] and existing [`IncrementalWitness`]es are incremented
/// with this output's commitment. /// with this output's commitment.
/// ///
/// [`ScanningKey`]: zcash_client_backend::welding_rig::ScanningKey /// [`ScanningKey`]: crate::welding_rig::ScanningKey
#[allow(clippy::too_many_arguments)] #[allow(clippy::too_many_arguments)]
fn scan_output<P: consensus::Parameters, K: ScanningKey>( fn scan_output<P: consensus::Parameters, K: ScanningKey>(
params: &P, params: &P,
@ -105,7 +105,7 @@ pub trait ScanningKey {
/// obtained by trial decryption. /// obtained by trial decryption.
type Nf; type Nf;
/// Attempt to decrypt a Sapling note and payment address /// Attempts to decrypt a Sapling note and payment address
/// from the specified ciphertext using this scanning key. /// from the specified ciphertext using this scanning key.
fn try_decryption<P: consensus::Parameters>( fn try_decryption<P: consensus::Parameters>(
&self, &self,
@ -116,7 +116,8 @@ pub trait ScanningKey {
ct: &[u8], ct: &[u8],
) -> Option<(Note, PaymentAddress)>; ) -> Option<(Note, PaymentAddress)>;
/// Produce the nullifier for the specified note and witness, if possible. /// Produces the nullifier for the specified note and witness, if possible.
///
/// IVK-based implementations of this trait cannot successfully derive /// IVK-based implementations of this trait cannot successfully derive
/// nullifiers, in which case `Self::Nf` should be set to the unit type /// nullifiers, in which case `Self::Nf` should be set to the unit type
/// and this function is a no-op. /// and this function is a no-op.
@ -185,7 +186,7 @@ impl ScanningKey for SaplingIvk {
/// [`ExtendedFullViewingKey`]: zcash_primitives::zip32::ExtendedFullViewingKey /// [`ExtendedFullViewingKey`]: zcash_primitives::zip32::ExtendedFullViewingKey
/// [`SaplingIvk`]: zcash_primitives::primitives::SaplingIvk /// [`SaplingIvk`]: zcash_primitives::primitives::SaplingIvk
/// [`CompactBlock`]: crate::proto::compact_formats::CompactBlock /// [`CompactBlock`]: crate::proto::compact_formats::CompactBlock
/// [`ScanningKey`]: zcash_client_backend::welding_rig::ScanningKey /// [`ScanningKey`]: crate::welding_rig::ScanningKey
/// [`CommitmentTree`]: zcash_primitives::merkle_tree::CommitmentTree /// [`CommitmentTree`]: zcash_primitives::merkle_tree::CommitmentTree
/// [`IncrementalWitness`]: zcash_primitives::merkle_tree::IncrementalWitness /// [`IncrementalWitness`]: zcash_primitives::merkle_tree::IncrementalWitness
/// [`WalletShieldedOutput`]: crate::wallet::WalletShieldedOutput /// [`WalletShieldedOutput`]: crate::wallet::WalletShieldedOutput