feat: add predicate to msm and ecadd

Author: TomAFrench

barretenberg/cpp/src/barretenberg/dsl/acir_format/ec_operations.hpp

@@ -18,13 +18,25 @@ struct EcAdd {
     WitnessOrConstant<bb::fr> input2_x;
     WitnessOrConstant<bb::fr> input2_y;
     WitnessOrConstant<bb::fr> input2_infinite;
+    // Predicate indicating whether the constraint should be disabled:
+    // - true: the constraint is valid
+    // - false: the constraint is disabled, i.e it must not fail and can return whatever.
+    WitnessOrConstant<bb::fr> predicate;
     uint32_t result_x;
     uint32_t result_y;
     uint32_t result_infinite;
 
     // for serialization, update with any new fields
-    MSGPACK_FIELDS(
-        input1_x, input1_y, input1_infinite, input2_x, input2_y, input2_infinite, result_x, result_y, result_infinite);
+    MSGPACK_FIELDS(input1_x,
+                   input1_y,
+                   input1_infinite,
+                   input2_x,
+                   input2_y,
+                   input2_infinite,
+                   predicate,
+                   result_x,
+                   result_y,
+                   result_infinite);
     friend bool operator==(EcAdd const& lhs, EcAdd const& rhs) = default;
 };
 

barretenberg/cpp/src/barretenberg/dsl/acir_format/ecdsa_constraints.test.cpp

@@ -3,6 +3,7 @@
 #include "acir_format_mocks.hpp"
 #include "barretenberg/crypto/ecdsa/ecdsa.hpp"
 #include "barretenberg/dsl/acir_format/utils.hpp"
+#include "barretenberg/dsl/acir_format/witness_constant.hpp"
 #include "barretenberg/stdlib/primitives/curves/secp256k1.hpp"
 #include "barretenberg/stdlib/primitives/curves/secp256r1.hpp"
 
@@ -86,6 +87,7 @@ template <class Curve> class EcdsaConstraintsTest : public ::testing::Test {
                                             .signature = signature_indices,
                                             .pub_x_indices = pub_x_indices,
                                             .pub_y_indices = pub_y_indices,
+                                            .predicate = WitnessOrConstant<bb::fr>::from_constant(bb::fr::one()),
                                             .result = result_index };
 
         return num_variables;

barretenberg/cpp/src/barretenberg/dsl/acir_format/multi_scalar_mul.hpp

@@ -17,13 +17,17 @@ namespace acir_format {
 struct MultiScalarMul {
     std::vector<WitnessOrConstant<bb::fr>> points;
     std::vector<WitnessOrConstant<bb::fr>> scalars;
+    // Predicate indicating whether the constraint should be disabled:
+    // - true: the constraint is valid
+    // - false: the constraint is disabled, i.e it must not fail and can return whatever.
+    WitnessOrConstant<bb::fr> predicate;
 
     uint32_t out_point_x;
     uint32_t out_point_y;
     uint32_t out_point_is_infinite;
 
     // for serialization, update with any new fields
-    MSGPACK_FIELDS(points, scalars, out_point_x, out_point_y, out_point_is_infinite);
+    MSGPACK_FIELDS(points, scalars, predicate, out_point_x, out_point_y, out_point_is_infinite);
     friend bool operator==(MultiScalarMul const& lhs, MultiScalarMul const& rhs) = default;
 };
 

barretenberg/cpp/src/barretenberg/dsl/acir_format/serde/acir.hpp

@@ -2984,6 +2984,7 @@ struct BlackBoxFuncCall {
     struct MultiScalarMul {
         std::vector<Acir::FunctionInput> points;
         std::vector<Acir::FunctionInput> scalars;
+        Acir::FunctionInput predicate;
         std::shared_ptr<std::array<Acir::Witness, 3>> outputs;
 
         friend bool operator==(const MultiScalarMul&, const MultiScalarMul&);
@@ -2992,9 +2993,10 @@ struct BlackBoxFuncCall {
 
         void msgpack_pack(auto& packer) const
         {
-            packer.pack_map(3);
+            packer.pack_map(4);
             packer.pack(std::make_pair("points", points));
             packer.pack(std::make_pair("scalars", scalars));
+            packer.pack(std::make_pair("predicate", predicate));
             packer.pack(std::make_pair("outputs", outputs));
         }
 
@@ -3004,13 +3006,15 @@ struct BlackBoxFuncCall {
             auto kvmap = Helpers::make_kvmap(o, name);
             Helpers::conv_fld_from_kvmap(kvmap, name, "points", points, false);
             Helpers::conv_fld_from_kvmap(kvmap, name, "scalars", scalars, false);
+            Helpers::conv_fld_from_kvmap(kvmap, name, "predicate", predicate, false);
             Helpers::conv_fld_from_kvmap(kvmap, name, "outputs", outputs, false);
         }
     };
 
     struct EmbeddedCurveAdd {
         std::shared_ptr<std::array<Acir::FunctionInput, 3>> input1;
         std::shared_ptr<std::array<Acir::FunctionInput, 3>> input2;
+        Acir::FunctionInput predicate;
         std::shared_ptr<std::array<Acir::Witness, 3>> outputs;
 
         friend bool operator==(const EmbeddedCurveAdd&, const EmbeddedCurveAdd&);
@@ -3019,9 +3023,10 @@ struct BlackBoxFuncCall {
 
         void msgpack_pack(auto& packer) const
         {
-            packer.pack_map(3);
+            packer.pack_map(4);
             packer.pack(std::make_pair("input1", input1));
             packer.pack(std::make_pair("input2", input2));
+            packer.pack(std::make_pair("predicate", predicate));
             packer.pack(std::make_pair("outputs", outputs));
         }
 
@@ -3031,6 +3036,7 @@ struct BlackBoxFuncCall {
             auto kvmap = Helpers::make_kvmap(o, name);
             Helpers::conv_fld_from_kvmap(kvmap, name, "input1", input1, false);
             Helpers::conv_fld_from_kvmap(kvmap, name, "input2", input2, false);
+            Helpers::conv_fld_from_kvmap(kvmap, name, "predicate", predicate, false);
             Helpers::conv_fld_from_kvmap(kvmap, name, "outputs", outputs, false);
         }
     };
@@ -6331,6 +6337,9 @@ inline bool operator==(const BlackBoxFuncCall::MultiScalarMul& lhs, const BlackB
     if (!(lhs.scalars == rhs.scalars)) {
         return false;
     }
+    if (!(lhs.predicate == rhs.predicate)) {
+        return false;
+    }
     if (!(lhs.outputs == rhs.outputs)) {
         return false;
     }
@@ -6363,6 +6372,7 @@ void serde::Serializable<Acir::BlackBoxFuncCall::MultiScalarMul>::serialize(
 {
     serde::Serializable<decltype(obj.points)>::serialize(obj.points, serializer);
     serde::Serializable<decltype(obj.scalars)>::serialize(obj.scalars, serializer);
+    serde::Serializable<decltype(obj.predicate)>::serialize(obj.predicate, serializer);
     serde::Serializable<decltype(obj.outputs)>::serialize(obj.outputs, serializer);
 }
 
@@ -6374,6 +6384,7 @@ Acir::BlackBoxFuncCall::MultiScalarMul serde::Deserializable<Acir::BlackBoxFuncC
     Acir::BlackBoxFuncCall::MultiScalarMul obj;
     obj.points = serde::Deserializable<decltype(obj.points)>::deserialize(deserializer);
     obj.scalars = serde::Deserializable<decltype(obj.scalars)>::deserialize(deserializer);
+    obj.predicate = serde::Deserializable<decltype(obj.predicate)>::deserialize(deserializer);
     obj.outputs = serde::Deserializable<decltype(obj.outputs)>::deserialize(deserializer);
     return obj;
 }
@@ -6388,6 +6399,9 @@ inline bool operator==(const BlackBoxFuncCall::EmbeddedCurveAdd& lhs, const Blac
     if (!(lhs.input2 == rhs.input2)) {
         return false;
     }
+    if (!(lhs.predicate == rhs.predicate)) {
+        return false;
+    }
     if (!(lhs.outputs == rhs.outputs)) {
         return false;
     }
@@ -6421,6 +6435,7 @@ void serde::Serializable<Acir::BlackBoxFuncCall::EmbeddedCurveAdd>::serialize(
 {
     serde::Serializable<decltype(obj.input1)>::serialize(obj.input1, serializer);
     serde::Serializable<decltype(obj.input2)>::serialize(obj.input2, serializer);
+    serde::Serializable<decltype(obj.predicate)>::serialize(obj.predicate, serializer);
     serde::Serializable<decltype(obj.outputs)>::serialize(obj.outputs, serializer);
 }
 
@@ -6432,6 +6447,7 @@ Acir::BlackBoxFuncCall::EmbeddedCurveAdd serde::Deserializable<Acir::BlackBoxFun
     Acir::BlackBoxFuncCall::EmbeddedCurveAdd obj;
     obj.input1 = serde::Deserializable<decltype(obj.input1)>::deserialize(deserializer);
     obj.input2 = serde::Deserializable<decltype(obj.input2)>::deserialize(deserializer);
+    obj.predicate = serde::Deserializable<decltype(obj.predicate)>::deserialize(deserializer);
     obj.outputs = serde::Deserializable<decltype(obj.outputs)>::deserialize(deserializer);
     return obj;
 }

barretenberg/cpp/src/barretenberg/dsl/acir_format/witness_constant.hpp

@@ -25,6 +25,15 @@ template <typename FF> struct WitnessOrConstant {
             .is_constant = false,
         };
     }
+
+    static WitnessOrConstant from_constant(FF value)
+    {
+        return WitnessOrConstant{
+            .index = 0,
+            .value = value,
+            .is_constant = true,
+        };
+    }
 };
 
 template <typename Builder, typename FF>