Clarify docstring about the Jubjub prime-order subgroup on generate_trapdoor()

This commit is contained in:
Deirdre Connolly 2020-08-05 01:13:39 -04:00 committed by Deirdre Connolly
parent f816761a5c
commit 0c299972ec
1 changed files with 4 additions and 4 deletions

View File

@ -21,10 +21,10 @@ use crate::{
/// Generates a random scalar from the scalar field 𝔽_{r_𝕁}. /// Generates a random scalar from the scalar field 𝔽_{r_𝕁}.
/// ///
/// The prime order subgroup 𝕁^(r) is the order-r_𝕁 subgroup of 𝕁 after the /// The prime order subgroup 𝕁^(r) is the order-r_𝕁 subgroup of 𝕁 that consists
/// Edwards cofactor h_𝕁 = 8 is factored out. This function is useful when /// of the points whose order divides r. This function is useful when generating
/// generating the uniform distribution on 𝔽_{r_𝕁} needed for Sapling /// the uniform distribution on 𝔽_{r_𝕁} needed for Sapling commitment schemes'
/// commitment schemes' trapdoor generators. /// trapdoor generators.
/// ///
/// https://zips.z.cash/protocol/protocol.pdf#jubjub /// https://zips.z.cash/protocol/protocol.pdf#jubjub
pub fn generate_trapdoor<T>(csprng: &mut T) -> jubjub::Fr pub fn generate_trapdoor<T>(csprng: &mut T) -> jubjub::Fr