Merge pull request #967 from o1-labs/refactor/group-add

o1-labs · Jun 20, 2023 · 1455a7f · 1455a7f
2 parents fdc740a + 6e80437
commit 1455a7f
Show file tree

Hide file tree

Showing 8 changed files with 424 additions and 68 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased](https://github.com/o1-labs/snarkyjs/compare/3fbd9678e...HEAD)
 
-> no unreleased changes yet
+### Breaking changes
+
+- `Group` operations now generate a different set of constraints. This breaks deployed contracts, because the circuit changed. https://github.com/o1-labs/snarkyjs/pull/967
 
 ## [0.11.0](https://github.com/o1-labs/snarkyjs/compare/a632313a...3fbd9678e)
 

diff --git a/src/bindings b/src/bindings
diff --git a/src/examples/primitive_constraint_system.ts b/src/examples/primitive_constraint_system.ts
@@ -45,7 +45,7 @@ const GroupMock = {
   },
   scale() {
     let g1 = Provable.witness(Group, () => Group.generator);
-    let s = Provable.witness(Scalar, () => Scalar.fromBigInt(5n));
+    let s = Provable.witness(Scalar, () => Scalar.from(5n));
     g1.scale(s);
   },
   equals() {

diff --git a/src/examples/regression_test.json b/src/examples/regression_test.json
@@ -140,24 +140,24 @@
     "digest": "Group Primitive",
     "methods": {
       "add": {
-        "rows": 6,
-        "digest": "ef763443bed39d397cb02e683ea9a877"
+        "rows": 33,
+        "digest": "0cc19b3dc379f8706aedfd731f08145f"
       },
       "sub": {
-        "rows": 6,
-        "digest": "329c0221e60d62aaf26ee1631f3f3c5a"
+        "rows": 34,
+        "digest": "ff55b39b569856e1c2025cae39d19e38"
       },
       "scale": {
-        "rows": 106,
-        "digest": "1296dd40b232fb0bc4cd908d47fd88a9"
+        "rows": 114,
+        "digest": "17d1f373892d2c437dc9ce340e17e3d6"
       },
       "equals": {
-        "rows": 27,
-        "digest": "adbcdc756d41853e24612e50b99be285"
+        "rows": 42,
+        "digest": "8d5ab248aa4602e6f77a8ab1015615df"
       },
       "assertions": {
-        "rows": 4,
-        "digest": "8750eb002126017bc297e7b63d4429b9"
+        "rows": 20,
+        "digest": "f4be74b3b20a0f3c3279f0def39c6b35"
       }
     },
     "verificationKey": {

diff --git a/src/lib/group.test.ts b/src/lib/group.test.ts
@@ -1,30 +1,46 @@
-import {
-  shutdown,
-  isReady,
-  Field,
-  Bool,
-  Circuit,
-  Group,
-  Scalar,
-  Provable,
-} from 'snarkyjs';
+import { Bool, Group, Scalar, Provable } from 'snarkyjs';
 
 describe('group', () => {
   let g = Group({
     x: -1,
     y: 2,
   });
-  beforeAll(async () => {
-    await isReady;
-  });
-
-  afterAll(async () => {
-    setTimeout(async () => {
-      await shutdown();
-    }, 0);
-  });
 
   describe('Inside circuit', () => {
+    describe('group membership', () => {
+      it('valid element does not throw', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            Provable.witness(Group, () => g);
+          });
+        }).not.toThrow();
+      });
+
+      it('valid element does not throw', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            Provable.witness(Group, () => Group.generator);
+          });
+        }).not.toThrow();
+      });
+
+      it('Group.zero element does not throw', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            Provable.witness(Group, () => Group.zero);
+          });
+        }).not.toThrow();
+      });
+
+      it('invalid group element throws', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            Provable.witness(Group, () => Group({ x: 2, y: 2 }));
+          });
+        }).toThrow();
+      });
+    });
+
     describe('add', () => {
       it('g+g does not throw', () => {
         expect(() => {
@@ -35,6 +51,55 @@ describe('group', () => {
           });
         }).not.toThrow();
       });
+
+      it('g+zero = g', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const x = Provable.witness(Group, () => g);
+            const zero = Provable.witness(Group, () => Group.zero);
+            x.add(zero).assertEquals(x);
+          });
+        }).not.toThrow();
+      });
+
+      it('zero+g = g', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const x = Provable.witness(Group, () => g);
+            const zero = Provable.witness(Group, () => Group.zero);
+            zero.add(x).assertEquals(x);
+          });
+        }).not.toThrow();
+      });
+
+      it('g+(-g) = zero', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const x = Provable.witness(Group, () => g);
+            const zero = Provable.witness(Group, () => Group.zero);
+            x.add(x.neg()).assertEquals(zero);
+          });
+        }).not.toThrow();
+      });
+
+      it('(-g)+g = zero', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const x = Provable.witness(Group, () => g);
+            const zero = Provable.witness(Group, () => Group.zero);
+            x.neg().add(x).assertEquals(zero);
+          });
+        }).not.toThrow();
+      });
+
+      it('zero + zero = zero', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const zero = Provable.witness(Group, () => Group.zero);
+            zero.add(zero).assertEquals(zero);
+          });
+        }).not.toThrow();
+      });
     });
 
     describe('sub', () => {
@@ -49,6 +114,35 @@ describe('group', () => {
           });
         }).not.toThrow();
       });
+
+      it('g-zero = g', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const x = Provable.witness(Group, () => g);
+            const zero = Provable.witness(Group, () => Group.zero);
+            x.sub(zero).assertEquals(x);
+          });
+        }).not.toThrow();
+      });
+
+      it('zero - g = -g', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const x = Provable.witness(Group, () => g);
+            const zero = Provable.witness(Group, () => Group.zero);
+            zero.sub(x).assertEquals(x.neg());
+          });
+        }).not.toThrow();
+      });
+
+      it('zero - zero = zero', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const zero = Provable.witness(Group, () => Group.zero);
+            zero.sub(zero).assertEquals(zero);
+          });
+        }).not.toThrow();
+      });
     });
 
     describe('neg', () => {
@@ -60,6 +154,15 @@ describe('group', () => {
           });
         }).not.toThrow();
       });
+
+      it('neg(zero) = zero', () => {
+        expect(() => {
+          Provable.runAndCheck(() => {
+            const zero = Provable.witness(Group, () => Group.zero);
+            zero.neg().assertEquals(zero);
+          });
+        }).not.toThrow();
+      });
     });
 
     describe('scale', () => {
@@ -161,6 +264,13 @@ describe('group', () => {
           g.neg();
         }).not.toThrow();
       });
+
+      it('zero.neg = zero', () => {
+        expect(() => {
+          const zero = Group.zero;
+          zero.neg().assertEquals(zero);
+        }).not.toThrow();
+      });
     });
 
     describe('add', () => {
@@ -169,6 +279,41 @@ describe('group', () => {
           g.add(g);
         }).not.toThrow();
       });
+
+      it('g + zero = g', () => {
+        expect(() => {
+          const zero = Group.zero;
+          g.add(zero).assertEquals(g);
+        }).not.toThrow();
+      });
+
+      it('zero + g = g', () => {
+        expect(() => {
+          const zero = Group.zero;
+          zero.add(g).assertEquals(g);
+        }).not.toThrow();
+      });
+
+      it('g + (-g) = zero', () => {
+        expect(() => {
+          const zero = Group.zero;
+          g.add(g.neg()).assertEquals(zero);
+        }).not.toThrow();
+      });
+
+      it('(-g) + g = zero', () => {
+        expect(() => {
+          const zero = Group.zero;
+          g.neg().add(g).assertEquals(zero);
+        }).not.toThrow();
+      });
+
+      it('zero + zero = zero', () => {
+        expect(() => {
+          const zero = Group.zero;
+          zero.add(zero).assertEquals(zero);
+        }).not.toThrow();
+      });
     });
 
     describe('sub', () => {
@@ -177,6 +322,27 @@ describe('group', () => {
           Group.generator.sub(g);
         }).not.toThrow();
       });
+
+      it('g - zero = g', () => {
+        expect(() => {
+          const zero = Group.zero;
+          g.sub(zero).assertEquals(g);
+        }).not.toThrow();
+      });
+
+      it('zero - g = -g', () => {
+        expect(() => {
+          const zero = Group.zero;
+          zero.sub(g).assertEquals(g.neg());
+        }).not.toThrow();
+      });
+
+      it('zero - zero = -zero', () => {
+        expect(() => {
+          const zero = Group.zero;
+          zero.sub(zero).assertEquals(zero);
+        }).not.toThrow();
+      });
     });
 
     describe('scale', () => {
@@ -231,18 +397,20 @@ describe('group', () => {
         y.assertEquals(z);
       });
     });
+
     it('sub', () => {
       let y = Provable.witness(Group, () => g).sub(
         Provable.witness(Group, () => Group.generator)
       );
       let z = g.sub(Group.generator);
       y.assertEquals(z);
     });
+
     it('sub', () => {
       let y = Provable.witness(Group, () => g).assertEquals(
         Provable.witness(Group, () => g)
       );
-      let z = g.assertEquals(g);
+      g.assertEquals(g);
     });
   });
 });