7#include "../field/field.hpp"
8#include "../field/field_utils.hpp"
29 *
this = constant_infinity(_context);
39template <
typename Builder>
70 if (assert_on_curve) {
84template <
typename Builder>
88 , _is_infinity(is_infinity)
90 if (_x.get_context() !=
nullptr) {
92 }
else if (_y.get_context() !=
nullptr) {
99 *
this = constant_infinity(this->
context);
104 if (_x.is_constant() != _y.is_constant()) {
105 if (_x.is_constant()) {
106 _x.convert_constant_to_fixed_witness(
context);
108 _y.convert_constant_to_fixed_witness(
context);
113 BB_ASSERT(!(_x.is_constant() && _y.is_constant() && !_is_infinity.is_constant()),
114 "cycle_group: constant coordinates with non-constant infinity flag");
117 BB_ASSERT(get_value().on_curve(),
"cycle_group: Point is not on curve");
118 if (assert_on_curve) {
132template <
typename Builder>
134 : _x(_in.is_point_at_infinity() ? 0 : _in.x)
135 , _y(_in.is_point_at_infinity() ? 0 : _in.y)
136 , _is_infinity(_in.is_point_at_infinity())
149 field_t x(_context, Group::one.x);
150 field_t y(_context, Group::one.y);
166 if (_context !=
nullptr) {
187template <
typename Builder>
213template <
typename Builder>
219 result = constant_infinity(_context);
234 if (get_context() !=
nullptr) {
235 return get_context();
243 if (is_point_at_infinity().get_value()) {
259 static_assert(Group::curve_a == 0);
262 auto res = _y.madd(_y, -xxx - Group::curve_b);
264 res *= !is_point_at_infinity();
265 res.assert_is_zero();
296template <
typename Builder>
300 if (this->is_constant_point_at_infinity()) {
311 if (hint.has_value()) {
315 const bb::fr x1 = _x.get_value();
316 const bb::fr y1 = modified_y.get_value();
322 const bb::fr x_pow_4 = x1 * (y_pow_2 - Group::curve_b);
323 const bb::fr lambda_squared = (x_pow_4 * 9) / (y_pow_2 * 4);
324 const bb::fr lambda = (x1 * x1 * 3) / (y1 + y1);
325 x3 = lambda_squared - x1 - x1;
326 y3 = lambda * (x1 - x3) - y1;
332 result =
cycle_group(x3, y3, is_point_at_infinity(),
false);
341 .
x1 = _x.get_witness_index(),
342 .y1 = modified_y.get_witness_index(),
367template <
typename Builder>
373 BB_ASSERT(!this->is_constant_point_at_infinity(),
374 "cycle_group::_unconditional_add_or_subtract called on constant point at infinity");
376 "cycle_group::_unconditional_add_or_subtract called on constant point at infinity");
378 auto context = get_context(other);
382 const bool lhs_constant = is_constant();
385 if (lhs_constant && !rhs_constant) {
387 lhs.set_origin_tag(get_origin_tag());
388 return lhs._unconditional_add_or_subtract(other, is_addition, hint);
390 if (!lhs_constant && rhs_constant) {
393 return _unconditional_add_or_subtract(rhs, is_addition, hint);
399 if (hint.has_value()) {
415 if (lhs_constant && rhs_constant) {
423 .
x1 = _x.get_witness_index(),
424 .y1 = _y.get_witness_index(),
429 .is_addition = is_addition,
445template <
typename Builder>
449 return _unconditional_add_or_subtract(other,
true, hint);
458template <
typename Builder>
462 return _unconditional_add_or_subtract(other,
false, hint);
476template <
typename Builder>
480 const field_t x_delta = this->_x - other.
_x;
484 x_delta.
assert_is_not_zero(
"cycle_group::checked_unconditional_add, x-coordinate collision");
486 return unconditional_add(other, hint);
501template <
typename Builder>
505 const field_t x_delta = this->_x - other.
_x;
509 x_delta.
assert_is_not_zero(
"cycle_group::checked_unconditional_subtract, x-coordinate collision");
511 return unconditional_subtract(other, hint);
532 if (this->is_constant_point_at_infinity()) {
539 const bool_t x_coordinates_match = (_x == other.
_x);
540 const bool_t y_coordinates_match = (_y == other.
_y);
553 lambda = (y2 - y1).divide_no_zero_check(x_diff);
563 const field_t add_result_x = lambda.
madd(lambda, -(x2 + x1));
564 const field_t add_result_y = lambda.
madd(x1 - add_result_x, -y1);
570 const bool_t double_predicate = (x_coordinates_match && y_coordinates_match);
575 const bool_t lhs_infinity = is_point_at_infinity();
586 const bool_t infinity_predicate = (x_coordinates_match && !y_coordinates_match);
587 bool_t result_is_infinity = infinity_predicate && (!lhs_infinity && !rhs_infinity);
588 result_is_infinity = result_is_infinity || (lhs_infinity && rhs_infinity);
590 return cycle_group(result_x, result_y, result_is_infinity,
false);
611 if (this->is_constant_point_at_infinity()) {
621 const bool_t x_coordinates_match = (_x == other.
_x);
622 const bool_t y_coordinates_match = (_y == other.
_y);
635 lambda = (-y2 - y1).divide_no_zero_check(x_diff);
644 const field_t sub_result_x = lambda.
madd(lambda, -(x2 + x1));
645 const field_t sub_result_y = lambda.
madd(x1 - sub_result_x, -y1);
653 const bool_t double_predicate = (x_coordinates_match && !y_coordinates_match);
661 const bool_t lhs_infinity = is_point_at_infinity();
672 const bool_t infinity_predicate = (x_coordinates_match && y_coordinates_match);
674 bool_t result_is_infinity = infinity_predicate && (!lhs_infinity && !rhs_infinity);
675 result_is_infinity = result_is_infinity || (lhs_infinity && rhs_infinity);
677 return cycle_group(result_x, result_y, result_is_infinity,
false);
693 result.
_y = (-_y).normalize();
699 *
this = *
this + other;
705 *
this = *
this - other;
729template <
typename Builder>
734 const bool unconditional_add)
736 BB_ASSERT_EQ(!scalars.empty(),
true,
"Empty scalars provided to variable base batch mul!");
737 BB_ASSERT_EQ(scalars.size(), base_points.size(),
"Points/scalars size mismatch in variable base batch mul!");
738 BB_ASSERT_EQ(offset_generators.size(), base_points.size() + 1,
"Too few offset generators provided!");
739 const size_t num_points = scalars.size();
743 for (
auto [scalar, point] :
zip_view(scalars, base_points)) {
758 scalar_slices.reserve(num_points);
759 for (
const auto& scalar : scalars) {
760 scalar_slices.emplace_back(
context, scalar, ROM_TABLE_BITS);
768 std::vector<Element> operation_transcript;
769 Element offset_generator_accumulator = offset_generators[0];
773 for (
size_t i = 0; i < num_points; ++i) {
779 native_straus_tables.emplace_back(
std::move(table));
783 Element accumulator = offset_generators[0];
784 for (
size_t i = 0; i < num_rounds; ++i) {
787 for (
size_t j = 0; j < ROM_TABLE_BITS; ++j) {
788 accumulator = accumulator.
dbl();
789 operation_transcript.push_back(accumulator);
790 offset_generator_accumulator = offset_generator_accumulator.
dbl();
793 for (
size_t j = 0; j < num_points; ++j) {
795 auto slice_value =
static_cast<size_t>(scalar_slices[j].slices_native[num_rounds - i - 1]);
796 const Element point = native_straus_tables[j][slice_value];
797 accumulator += point;
800 operation_transcript.push_back(accumulator);
801 offset_generator_accumulator +=
Element(offset_generators[j + 1]);
807 Element::batch_normalize(&operation_transcript[0], operation_transcript.size());
808 std::vector<AffineElement> operation_hints;
809 operation_hints.reserve(operation_transcript.size());
816 point_tables.reserve(num_points);
817 const size_t hints_per_table = (1ULL << ROM_TABLE_BITS) - 1;
818 for (
size_t i = 0; i < num_points; ++i) {
822 point_tables.push_back(
std::move(table));
826 AffineElement* hint_ptr = &operation_hints[num_points * hints_per_table];
831 field_t coordinate_check_product = 1;
832 for (
size_t i = 0; i < num_rounds; ++i) {
835 for (
size_t j = 0; j < ROM_TABLE_BITS; ++j) {
836 accumulator = accumulator.
dbl(*hint_ptr);
841 for (
size_t j = 0; j < num_points; ++j) {
842 const field_t scalar_slice = scalar_slices[j][num_rounds - i - 1];
844 const cycle_group point = point_tables[j].read(scalar_slice);
845 if (!unconditional_add) {
846 coordinate_check_product *= point.
_x - accumulator.
_x;
855 if (!unconditional_add) {
856 coordinate_check_product.
assert_is_not_zero(
"_variable_base_batch_mul_internal x-coordinate collision");
866 return { accumulator,
AffineElement(offset_generator_accumulator) };
892template <
typename Builder>
896 BB_ASSERT_EQ(scalars.size(), base_points.size(),
"Points/scalars size mismatch in fixed-base batch mul");
905 for (
const auto [point, scalar] :
zip_view(base_points, scalars)) {
907 multitable_ids.push_back(table_id[0]);
908 multitable_ids.push_back(table_id[1]);
909 scalar_limbs.push_back(scalar.lo());
910 scalar_limbs.push_back(scalar.hi());
915 Element offset_generator_accumulator = Group::point_at_infinity;
916 for (
const auto [table_id, scalar] :
zip_view(multitable_ids, scalar_limbs)) {
921 for (
size_t j = 0; j < lookup_data[ColumnIdx::C2].size(); ++j) {
922 const field_t x = lookup_data[ColumnIdx::C2][j];
923 const field_t y = lookup_data[ColumnIdx::C3][j];
927 lookup_points.push_back(
cycle_group(x, y, is_infinity,
false));
930 offset_generator_accumulator += table::get_generator_offset_for_table_id(table_id);
934 std::vector<Element> operation_transcript;
936 Element accumulator = lookup_points[0].get_value();
937 for (
size_t i = 1; i < lookup_points.size(); ++i) {
938 accumulator += (lookup_points[i].get_value());
939 operation_transcript.push_back(accumulator);
945 Element::batch_normalize(&operation_transcript[0], operation_transcript.size());
946 std::vector<AffineElement> operation_hints;
947 operation_hints.reserve(operation_transcript.size());
957 for (
auto& point : lookup_points) {
958 point.set_origin_tag(const_tag);
961 for (
size_t i = 1; i < lookup_points.size(); ++i) {
962 accumulator = accumulator.
unconditional_add(lookup_points[i], operation_hints[i - 1]);
968 return { accumulator, offset_generator_accumulator };
1007template <
typename Builder>
1012 BB_ASSERT_EQ(scalars.size(), base_points.size(),
"Points/scalars size mismatch in batch mul!");
1014 if (scalars.empty()) {
1022 std::vector<AffineElement> fixed_base_points;
1026 for (
auto [point, scalar] :
zip_view(base_points, scalars)) {
1027 result_tag =
OriginTag(result_tag,
OriginTag(point.get_origin_tag(), scalar.get_origin_tag()));
1032 bool can_unconditional_add =
true;
1033 bool has_non_constant_component =
false;
1034 Element constant_acc = Group::point_at_infinity;
1035 for (
const auto [point, scalar] :
zip_view(base_points, scalars)) {
1036 if (scalar.is_constant() && point.is_constant()) {
1038 constant_acc += (point.get_value()) * (scalar.get_value());
1039 }
else if (!scalar.is_constant() && point.is_constant()) {
1040 if (point.get_value().is_point_at_infinity()) {
1042#ifndef FUZZING_DISABLE_WARNINGS
1043 info(
"Warning: Performing batch mul with constant point at infinity!");
1047 auto* ctx = scalar.get_context();
1048 ctx->create_limbed_range_constraint(scalar.lo().get_witness_index(),
1051 "batch_mul: lo range constraint for scalar with constant "
1053 ctx->create_limbed_range_constraint(scalar.hi().get_witness_index(),
1056 "batch_mul: hi range constraint for scalar with constant "
1062 fixed_base_scalars.push_back(scalar);
1063 fixed_base_points.push_back(point.get_value());
1066 variable_base_scalars.push_back(scalar);
1067 variable_base_points.push_back(point);
1069 has_non_constant_component =
true;
1072 variable_base_scalars.push_back(scalar);
1073 variable_base_points.push_back(point);
1074 can_unconditional_add =
false;
1075 has_non_constant_component =
true;
1080 if (!has_non_constant_component) {
1088 Element offset_accumulator = -constant_acc;
1089 const bool has_variable_points = !variable_base_points.empty();
1090 const bool has_fixed_points = !fixed_base_points.empty();
1093 if (has_fixed_points) {
1095 const auto [fixed_accumulator, offset_generator_delta] =
1096 _fixed_base_batch_mul_internal(fixed_base_scalars, fixed_base_points);
1097 offset_accumulator += offset_generator_delta;
1098 result = fixed_accumulator;
1101 if (has_variable_points) {
1103 const size_t num_offset_generators = variable_base_points.size() + 1;
1105 context.generators->get(num_offset_generators, 0, OFFSET_GENERATOR_DOMAIN_SEPARATOR);
1108 const auto [variable_accumulator, offset_generator_delta] = _variable_base_batch_mul_internal(
1109 variable_base_scalars, variable_base_points, offset_generators, can_unconditional_add);
1110 offset_accumulator += offset_generator_delta;
1113 if (has_fixed_points) {
1117 result = variable_accumulator;
1149 return batch_mul({ *
this }, { scalar });
1160 return batch_mul({ *
this }, { scalar });
1171 this->standardize();
1173 const auto equal = (_x == other.
_x) && (_y == other.
_y) && (this->_is_infinity == other.
_is_infinity);
1179 this->standardize();
1181 _x.assert_equal(other.
_x, msg);
1182 _y.assert_equal(other.
_y, msg);
1186template <
typename Builder>
1193 auto _is_infinity_res =
#define BB_ASSERT(expression,...)
#define BB_ASSERT_EQ(actual, expected,...)
constexpr bool is_point_at_infinity() const noexcept
constexpr void self_set_infinity() noexcept
element class. Implements ecc group arithmetic using Jacobian coordinates See https://hyperelliptic....
constexpr element dbl() const noexcept
BB_INLINE constexpr bool is_point_at_infinity() const noexcept
Container for lookup accumulator values and table reads.
Generates plookup tables required to perform fixed-base scalar multiplication over a fixed number of ...
static bool lookup_table_exists_for_point(const affine_element &input)
Returns true iff provided point is one of the two for which we have a precomputed lookup table.
Implements boolean logic in-circuit.
static bool_t conditional_assign(const bool_t< Builder > &predicate, const bool_t &lhs, const bool_t &rhs)
Conditionally assign lhs or rhs based on predicate, always returns normalized result.
Builder * get_context() const
cycle_group represents a group Element of the proving system's embedded curve, i.e....
cycle_group dbl(const std::optional< AffineElement > hint=std::nullopt) const
Evaluates a point doubling using Ultra ECC double gate (if non-constant)
static cycle_group from_constant_witness(Builder *_context, const AffineElement &_in)
Converts a native AffineElement into a witness, but constrains the witness values to be known constan...
cycle_group & operator*=(const cycle_scalar &scalar)
void standardize()
Convert the point to standard form.
cycle_group unconditional_add(const cycle_group &other, const std::optional< AffineElement > hint=std::nullopt) const
Evaluate incomplete ECC point addition over *this and other.
void validate_on_curve() const
On-curve check.
bool_t operator==(cycle_group &other)
Builder * get_context(const cycle_group &other) const
cycle_group & operator-=(const cycle_group &other)
static cycle_group conditional_assign(const bool_t &predicate, const cycle_group &lhs, const cycle_group &rhs)
void unset_free_witness_tag()
Unset the free witness flag for the cycle_group's tags.
cycle_group checked_unconditional_subtract(const cycle_group &other, const std::optional< AffineElement > hint=std::nullopt) const
Evaluate incomplete ECC point subtraction over *this and other, with x-coordinate collision checks.
cycle_group _unconditional_add_or_subtract(const cycle_group &other, bool is_addition, const std::optional< AffineElement > hint) const
Will evaluate ECC point addition or subtraction over *this and other.
static cycle_group from_witness(Builder *_context, const AffineElement &_in)
Converts an AffineElement into a circuit witness.
cycle_group operator-() const
Negates a point.
static cycle_group one(Builder *_context)
Construct a constant cycle_group representation of Group::one.
void set_free_witness_tag()
Set the free witness flag for the cycle_group's tags.
void set_origin_tag(OriginTag tag) const
Set the origin tag for x, y and _is_infinity members of cycle_group.
cycle_group & operator+=(const cycle_group &other)
static cycle_group constant_infinity(Builder *_context=nullptr)
Construct a constant point at infinity.
bool is_constant_point_at_infinity() const
bool_t is_point_at_infinity() const
static batch_mul_internal_output _variable_base_batch_mul_internal(std::span< cycle_scalar > scalars, std::span< cycle_group > base_points, std::span< AffineElement const > offset_generators, bool unconditional_add)
Internal logic to perform a variable-base batch mul using the Straus MSM algorithm.
cycle_group(Builder *_context=nullptr)
Construct a new constant point at infinity cycle group object.
AffineElement get_value() const
OriginTag get_origin_tag() const
Get the origin tag of cycle_group (a merege of origin tags of x, y and _is_infinity members)
cycle_group operator*(const cycle_scalar &scalar) const
static batch_mul_internal_output _fixed_base_batch_mul_internal(std::span< cycle_scalar > scalars, std::span< AffineElement > base_points)
Internal algorithm to perform a fixed-base batch mul.
void assert_equal(cycle_group &other, std::string const &msg="cycle_group::assert_equal")
cycle_group operator+(const cycle_group &other) const
Evaluate ECC point addition over *this and other.
cycle_group unconditional_subtract(const cycle_group &other, const std::optional< AffineElement > hint=std::nullopt) const
Evaluate incomplete ECC point subtraction over *this and other.
Builder * get_context() const
cycle_group checked_unconditional_add(const cycle_group &other, const std::optional< AffineElement > hint=std::nullopt) const
Evaluate incomplete ECC point addition over *this and other, with x-coordinate collision checks.
static cycle_group batch_mul(const std::vector< cycle_group > &base_points, const std::vector< BigScalarField > &scalars, GeneratorContext context={})
Represents a member of the Grumpkin curve scalar field (i.e. BN254 base field).
static constexpr size_t NUM_BITS
static constexpr size_t LO_BITS
static constexpr size_t HI_BITS
void assert_equal(const field_t &rhs, std::string const &msg="field_t::assert_equal") const
Copy constraint: constrain that *this field is equal to rhs element.
field_t madd(const field_t &to_mul, const field_t &to_add) const
static void evaluate_polynomial_identity(const field_t &a, const field_t &b, const field_t &c, const field_t &d, const std::string &msg="field_t::evaluate_polynomial_identity")
Given a, b, c, d, constrain a * b + c + d = 0 by creating a big_mul_gate.
Builder * get_context() const
OriginTag get_origin_tag() const
bb::fr get_value() const
Given a := *this, compute its value given by a.v * a.mul + a.add.
static field_t from_witness(Builder *ctx, const bb::fr &input)
bool_t< Builder > is_zero() const
Validate whether a field_t element is zero.
void convert_constant_to_fixed_witness(Builder *ctx)
void set_origin_tag(const OriginTag &new_tag) const
field_t add_two(const field_t &add_b, const field_t &add_c) const
Efficiently compute (this + a + b) using big_mul gate.
static field_t conditional_assign(const bool_t< Builder > &predicate, const field_t &lhs, const field_t &rhs)
void assert_is_not_zero(std::string const &msg="field_t::assert_is_not_zero") const
Constrain *this to be non-zero by establishing that it has an inverse.
uint32_t get_witness_index() const
Get the witness index of the current field element.
static plookup::ReadData< field_pt > get_lookup_accumulators(const plookup::MultiTableId id, const field_pt &key_a, const field_pt &key_b=0, const bool is_2_to_1_lookup=false)
straus_lookup_table computes a lookup table of size 1 << table_bits
static std::vector< Element > compute_native_table(const Element &base_point, const Element &offset_generator, size_t table_bits)
Compute the output points generated when computing the Straus lookup table.
StrictMock< MockContext > context
bb::curve::BN254::Element Element
constexpr T ceil_div(const T &numerator, const T &denominator)
Computes the ceiling of the division of two integral types.
std::conditional_t< IsGoblinBigGroup< C, Fq, Fr, G >, element_goblin::goblin_element< C, goblin_field< C >, Fr, G >, element_default::element< C, Fq, Fr, G > > element
element wraps either element_default::element or element_goblin::goblin_element depending on parametr...
void mark_witness_as_used(const field_t< Builder > &field)
Mark a field_t witness as used (for UltraBuilder only).
field< Bn254FrParams > fr
Univariate< Fr, domain_end > operator*(const Fr &ff, const Univariate< Fr, domain_end > &uv)
constexpr decltype(auto) get(::tuplet::tuple< T... > &&t) noexcept
This file contains part of the logic for the Origin Tag mechanism that tracks the use of in-circuit p...
static OriginTag constant()
BB_INLINE constexpr field sqr() const noexcept
static constexpr field zero()
Stores temporary variables produced by internal multiplication algorithms.