Skip to content

Commit bbdb37e

Browse files
skaunovPratyush
andauthored
Resolve #152 (#153)
* Resolve #152 (Plus minor docs formatting.) * add the changelog entry * fixing unrelated lint --------- Co-authored-by: Pratyush Mishra <[email protected]>
1 parent 2d627e3 commit bbdb37e

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [\#82](https://github.com/arkworks-rs/poly-commit/pull/82) Add multivariate opening challenge strategy. Integrate with sponge API.
1414

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

1718
### Bug fixes
1819

poly-commit/src/kzg10/mod.rs

+7-6
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,9 @@ where
211211

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

242-
pub(crate) fn open_with_witness_polynomial<'a>(
242+
/// Yields a [`Proof`] with a witness polynomial.
243+
pub fn open_with_witness_polynomial<'a>(
243244
powers: &Powers<E>,
244245
point: P::Point,
245246
randomness: &Randomness<E::ScalarField, P>,
@@ -282,8 +283,8 @@ where
282283
})
283284
}
284285

285-
/// On input a polynomial `p` and a point `point`, outputs a proof for the same.
286-
pub(crate) fn open<'a>(
286+
/// On input a polynomial `p` and a `point`, outputs a [`Proof`] for the same.
287+
pub fn open<'a>(
287288
powers: &Powers<E>,
288289
p: &P,
289290
point: P::Point,

0 commit comments

Comments
 (0)