Skip to content

Commit 46687fe

Browse files
Update comments
1 parent 016ede0 commit 46687fe

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

halo2_gadgets/src/ecc.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ pub trait EccInstructions<C: CurveAffine>:
7777
value: Value<C>,
7878
) -> Result<Self::NonIdentityPoint, Error>;
7979

80-
/// Witnesses the given constant point as a private input to the circuit.
81-
/// This returns an error if the point is the identity.
80+
/// Witnesses the given constant point with both coordinates pinned via fixed columns.
81+
/// Returns an error if the point is the identity.
8282
fn witness_point_non_id_from_constant(
8383
&self,
8484
layouter: &mut impl Layouter<C::Base>,
@@ -288,7 +288,8 @@ pub struct NonIdentityPoint<C: CurveAffine, EccChip: EccInstructions<C>> {
288288
}
289289

290290
impl<C: CurveAffine, EccChip: EccInstructions<C>> NonIdentityPoint<C, EccChip> {
291-
/// Constructs a new point with the given value.
291+
/// Witnesses the given point with only on-curve / non-identity constraints.
292+
/// For known-constant points use [`NonIdentityPoint::new_from_constant`].
292293
pub fn new(
293294
chip: EccChip,
294295
mut layouter: impl Layouter<C::Base>,
@@ -298,7 +299,7 @@ impl<C: CurveAffine, EccChip: EccInstructions<C>> NonIdentityPoint<C, EccChip> {
298299
point.map(|inner| NonIdentityPoint { chip, inner })
299300
}
300301

301-
/// Constructs a new point with the given value.
302+
/// Witnesses the given constant point with both coordinates pinned via fixed columns.
302303
pub fn new_from_constant(
303304
chip: EccChip,
304305
mut layouter: impl Layouter<C::Base>,

0 commit comments

Comments
 (0)