1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
use ark_serialize::{
CanonicalDeserialize, CanonicalSerialize, Compress, SerializationError, Valid, Validate,
};
use ark_std::{
borrow::Borrow,
fmt::{Debug, Display, Formatter, Result as FmtResult},
io::{Read, Write},
ops::{Add, Mul, Neg, Sub},
rand::{
distributions::{Distribution, Standard},
Rng,
},
vec::Vec,
One, Zero,
};
use ark_ff::{fields::Field, PrimeField, ToConstraintField, UniformRand};
use zeroize::Zeroize;
use super::{Projective, SWCurveConfig, SWFlags};
use crate::AffineRepr;
#[derive(Derivative)]
#[derivative(
Copy(bound = "P: SWCurveConfig"),
Clone(bound = "P: SWCurveConfig"),
PartialEq(bound = "P: SWCurveConfig"),
Eq(bound = "P: SWCurveConfig"),
Hash(bound = "P: SWCurveConfig")
)]
#[must_use]
pub struct Affine<P: SWCurveConfig> {
#[doc(hidden)]
pub x: P::BaseField,
#[doc(hidden)]
pub y: P::BaseField,
#[doc(hidden)]
pub infinity: bool,
}
impl<P: SWCurveConfig> PartialEq<Projective<P>> for Affine<P> {
fn eq(&self, other: &Projective<P>) -> bool {
self.into_group() == *other
}
}
impl<P: SWCurveConfig> Display for Affine<P> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
match self.infinity {
true => write!(f, "infinity"),
false => write!(f, "({}, {})", self.x, self.y),
}
}
}
impl<P: SWCurveConfig> Debug for Affine<P> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
match self.infinity {
true => write!(f, "infinity"),
false => write!(f, "({}, {})", self.x, self.y),
}
}
}
impl<P: SWCurveConfig> Affine<P> {
pub fn new(x: P::BaseField, y: P::BaseField) -> Self {
let point = Self {
x,
y,
infinity: false,
};
assert!(point.is_on_curve());
assert!(point.is_in_correct_subgroup_assuming_on_curve());
point
}
pub const fn new_unchecked(x: P::BaseField, y: P::BaseField) -> Self {
Self {
x,
y,
infinity: false,
}
}
pub const fn identity() -> Self {
Self {
x: P::BaseField::ZERO,
y: P::BaseField::ZERO,
infinity: true,
}
}
#[allow(dead_code)]
pub fn get_point_from_x_unchecked(x: P::BaseField, greatest: bool) -> Option<Self> {
Self::get_ys_from_x_unchecked(x).map(|(smaller, larger)| {
if greatest {
Self::new_unchecked(x, larger)
} else {
Self::new_unchecked(x, smaller)
}
})
}
pub fn get_ys_from_x_unchecked(x: P::BaseField) -> Option<(P::BaseField, P::BaseField)> {
let mut x3_plus_ax_plus_b = P::add_b(x.square() * x);
if !P::COEFF_A.is_zero() {
x3_plus_ax_plus_b += P::mul_by_a(x)
};
let y = x3_plus_ax_plus_b.sqrt()?;
let neg_y = -y;
match y < neg_y {
true => Some((y, neg_y)),
false => Some((neg_y, y)),
}
}
pub fn is_on_curve(&self) -> bool {
if !self.infinity {
let mut x3b = P::add_b(self.x.square() * self.x);
if !P::COEFF_A.is_zero() {
x3b += P::mul_by_a(self.x);
};
self.y.square() == x3b
} else {
true
}
}
pub fn to_flags(&self) -> SWFlags {
if self.infinity {
SWFlags::PointAtInfinity
} else if self.y <= -self.y {
SWFlags::YIsPositive
} else {
SWFlags::YIsNegative
}
}
}
impl<P: SWCurveConfig> Affine<P> {
pub fn is_in_correct_subgroup_assuming_on_curve(&self) -> bool {
P::is_in_correct_subgroup_assuming_on_curve(self)
}
}
impl<P: SWCurveConfig> Zeroize for Affine<P> {
fn zeroize(&mut self) {
self.x.zeroize();
self.y.zeroize();
self.infinity.zeroize();
}
}
impl<P: SWCurveConfig> Distribution<Affine<P>> for Standard {
#[inline]
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Affine<P> {
loop {
let x = P::BaseField::rand(rng);
let greatest = rng.gen();
if let Some(p) = Affine::get_point_from_x_unchecked(x, greatest) {
return p.mul_by_cofactor();
}
}
}
}
impl<P: SWCurveConfig> AffineRepr for Affine<P> {
type Config = P;
type BaseField = P::BaseField;
type ScalarField = P::ScalarField;
type Group = Projective<P>;
fn xy(&self) -> Option<(&Self::BaseField, &Self::BaseField)> {
(!self.infinity).then(|| (&self.x, &self.y))
}
#[inline]
fn generator() -> Self {
P::GENERATOR
}
fn zero() -> Self {
Self {
x: P::BaseField::ZERO,
y: P::BaseField::ZERO,
infinity: true,
}
}
fn from_random_bytes(bytes: &[u8]) -> Option<Self> {
P::BaseField::from_random_bytes_with_flags::<SWFlags>(bytes).and_then(|(x, flags)| {
if x.is_zero() && flags.is_infinity() {
Some(Self::identity())
} else if let Some(y_is_positive) = flags.is_positive() {
Self::get_point_from_x_unchecked(x, y_is_positive)
} else {
None
}
})
}
fn mul_bigint(&self, by: impl AsRef<[u64]>) -> Self::Group {
P::mul_affine(self, by.as_ref())
}
#[must_use]
fn mul_by_cofactor_to_group(&self) -> Self::Group {
P::mul_affine(self, Self::Config::COFACTOR)
}
fn clear_cofactor(&self) -> Self {
P::clear_cofactor(self)
}
}
impl<P: SWCurveConfig> Neg for Affine<P> {
type Output = Self;
#[inline]
fn neg(mut self) -> Self {
self.y.neg_in_place();
self
}
}
impl<P: SWCurveConfig, T: Borrow<Self>> Add<T> for Affine<P> {
type Output = Projective<P>;
fn add(self, other: T) -> Projective<P> {
let mut copy = self.into_group();
copy += other.borrow();
copy
}
}
impl<P: SWCurveConfig> Add<Projective<P>> for Affine<P> {
type Output = Projective<P>;
fn add(self, other: Projective<P>) -> Projective<P> {
other + self
}
}
impl<'a, P: SWCurveConfig> Add<&'a Projective<P>> for Affine<P> {
type Output = Projective<P>;
fn add(self, other: &'a Projective<P>) -> Projective<P> {
*other + self
}
}
impl<P: SWCurveConfig, T: Borrow<Self>> Sub<T> for Affine<P> {
type Output = Projective<P>;
fn sub(self, other: T) -> Projective<P> {
let mut copy = self.into_group();
copy -= other.borrow();
copy
}
}
impl<P: SWCurveConfig> Default for Affine<P> {
#[inline]
fn default() -> Self {
Self::identity()
}
}
impl<P: SWCurveConfig, T: Borrow<P::ScalarField>> Mul<T> for Affine<P> {
type Output = Projective<P>;
#[inline]
fn mul(self, other: T) -> Self::Output {
self.mul_bigint(other.borrow().into_bigint())
}
}
impl<P: SWCurveConfig> From<Projective<P>> for Affine<P> {
#[inline]
fn from(p: Projective<P>) -> Affine<P> {
if p.is_zero() {
Affine::identity()
} else if p.z.is_one() {
Affine::new_unchecked(p.x, p.y)
} else {
let zinv = p.z.inverse().unwrap();
let zinv_squared = zinv.square();
let x = p.x * &zinv_squared;
let y = p.y * &(zinv_squared * &zinv);
Affine::new_unchecked(x, y)
}
}
}
impl<P: SWCurveConfig> CanonicalSerialize for Affine<P> {
#[inline]
fn serialize_with_mode<W: Write>(
&self,
writer: W,
compress: ark_serialize::Compress,
) -> Result<(), SerializationError> {
P::serialize_with_mode(self, writer, compress)
}
#[inline]
fn serialized_size(&self, compress: Compress) -> usize {
P::serialized_size(compress)
}
}
impl<P: SWCurveConfig> Valid for Affine<P> {
fn check(&self) -> Result<(), SerializationError> {
if self.is_on_curve() && self.is_in_correct_subgroup_assuming_on_curve() {
Ok(())
} else {
Err(SerializationError::InvalidData)
}
}
}
impl<P: SWCurveConfig> CanonicalDeserialize for Affine<P> {
fn deserialize_with_mode<R: Read>(
reader: R,
compress: Compress,
validate: Validate,
) -> Result<Self, SerializationError> {
P::deserialize_with_mode(reader, compress, validate)
}
}
impl<M: SWCurveConfig, ConstraintF: Field> ToConstraintField<ConstraintF> for Affine<M>
where
M::BaseField: ToConstraintField<ConstraintF>,
{
#[inline]
fn to_field_elements(&self) -> Option<Vec<ConstraintF>> {
let mut x = self.x.to_field_elements()?;
let y = self.y.to_field_elements()?;
let infinity = self.infinity.to_field_elements()?;
x.extend_from_slice(&y);
x.extend_from_slice(&infinity);
Some(x)
}
}