Docs

w3f · Feb 28, 2024 · 2799d46 · 2799d46
1 parent 2af5bd2
commit 2799d46
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/ark-secret-scalar/src/lib.rs b/ark-secret-scalar/src/lib.rs
@@ -88,6 +88,7 @@ impl<F: PrimeField> SecretScalar<F> {
         SecretScalar(self.0.clone())
     }
 
+    /// Randomply resplit the secret in two components.
     pub fn resplit(&mut self) {
         let mut xof = Rng2Xof(getrandom_or_panic());
         let x = xof_read_reduced(&mut xof);
@@ -110,6 +111,7 @@ impl<F: PrimeField> SecretScalar<F> {
         (lhs[0] * rhs) + (lhs[1] * rhs)
     }
 
+    /// Get the secret scalar value by joining the two components.
     pub fn scalar(&self) -> F {
         self.0[0] + self.0[1]
     }