Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
* Resolve arkworks-rs#152

(Plus minor docs formatting.)

* add the changelog entry

* fixing unrelated lint

---------

Co-authored-by: Pratyush Mishra <[email protected]>
  • Loading branch information
skaunov and Pratyush authored Oct 25, 2024
1 parent 2d627e3 commit bbdb37e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [\#82](https://github.com/arkworks-rs/poly-commit/pull/82) Add multivariate opening challenge strategy. Integrate with sponge API.

### Improvements
- [\#152](https://github.com/arkworks-rs/poly-commit/issues/152) Expose `kzg10::open_with_witness_polynomial` and `open` downstream.

### Bug fixes

Expand Down
13 changes: 7 additions & 6 deletions poly-commit/src/kzg10/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ where

/// Compute witness polynomial.
///
/// The witness polynomial w(x) the quotient of the division (p(x) - p(z)) / (x - z)
/// Observe that this quotient does not change with z because
/// p(z) is the remainder term. We can therefore omit p(z) when computing the quotient.
/// The witness polynomial $w(x)$ the quotient of the division (p(x) - p(z)) / (x - z)
/// Observe that this quotient does not change with $z$ because
/// $p(z)$ is the remainder term. We can therefore omit $p(z)$ when computing the quotient.
pub fn compute_witness_polynomial(
p: &P,
point: P::Point,
Expand All @@ -239,7 +239,8 @@ where
Ok((witness_polynomial, random_witness_polynomial))
}

pub(crate) fn open_with_witness_polynomial<'a>(
/// Yields a [`Proof`] with a witness polynomial.
pub fn open_with_witness_polynomial<'a>(
powers: &Powers<E>,
point: P::Point,
randomness: &Randomness<E::ScalarField, P>,
Expand Down Expand Up @@ -282,8 +283,8 @@ where
})
}

/// On input a polynomial `p` and a point `point`, outputs a proof for the same.
pub(crate) fn open<'a>(
/// On input a polynomial `p` and a `point`, outputs a [`Proof`] for the same.
pub fn open<'a>(
powers: &Powers<E>,
p: &P,
point: P::Point,
Expand Down

0 comments on commit bbdb37e

Please sign in to comment.