Merge pull request #12 from distributed-lab/fix/not-0

Fix bug related to false positive resolution in if statement

Author: Arvolear

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@distributedlab/circom-parser",
   "description": "Circom circuit parser built with ANTLR4",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

package.json

@@ -63,7 +63,7 @@ export class ExpressionHelper {
 
     const result = visitor.visitExpression(this._expressionContext);
 
-    if (result === null) {
+    if (result === null || result === undefined) {
       return [null, visitor.getErrors()];
     }
 
@@ -91,7 +91,7 @@ class ExpressionVisitor extends ExtendedCircomVisitor<CircomValueType | null> {
     if (ctx.TERNARY_CONDITION() && ctx.TERNARY_ALTERNATIVE()) {
       const conditionResult = this.visit(ctx._cond);
 
-      if (conditionResult === null) {
+      if (conditionResult === null || conditionResult === undefined) {
         this.addError(
           "Failed to resolve the condition of a ternary expression",
           ctx._cond,
@@ -124,7 +124,7 @@ class ExpressionVisitor extends ExtendedCircomVisitor<CircomValueType | null> {
       const variableValue =
         this.variableContext[ctx.identifierStatement().ID().getText()];
 
-      if (variableValue === undefined) {
+      if (variableValue === undefined || variableValue === null) {
         this.addError(
           `Variable ${ctx.identifierStatement().ID().getText()} is not defined`,
           ctx.identifierStatement(),
@@ -153,7 +153,10 @@ class ExpressionVisitor extends ExtendedCircomVisitor<CircomValueType | null> {
 
     const variableName = ctx.identifierStatement().ID().getText() + reference;
 
-    if (this.variableContext[variableName] === undefined) {
+    if (
+      this.variableContext[variableName] === undefined ||
+      this.variableContext[variableName] === null
+    ) {
       this.addError(
         `Variable ${variableName} is not defined`,
         ctx.identifierStatement(),
@@ -184,7 +187,7 @@ class ExpressionVisitor extends ExtendedCircomVisitor<CircomValueType | null> {
     for (let i = 0; i < ctx.expressionList().expression_list().length; i++) {
       const resolvedItem = this.visit(ctx.expressionList().expression(i));
 
-      if (!resolvedItem) {
+      if (resolvedItem === null || resolvedItem === undefined) {
         this.addError(
           `Failed to resolve the ${i} element of an array.`,
           ctx.expressionList().expression(i),
@@ -220,7 +223,7 @@ class ExpressionVisitor extends ExtendedCircomVisitor<CircomValueType | null> {
 
     const firstExpression = this.visit(ctx.expression(0));
 
-    if (firstExpression === null) {
+    if (firstExpression === null || firstExpression === undefined) {
       this.addError(
         "Failed to resolve the first expression of an operation",
         ctx.expression(0),
@@ -256,7 +259,7 @@ class ExpressionVisitor extends ExtendedCircomVisitor<CircomValueType | null> {
 
     const secondExpression = this.visit(ctx.expression(1));
 
-    if (secondExpression === null) {
+    if (secondExpression === null || secondExpression === undefined) {
       this.addError(
         "Failed to resolve the second expression of an operation",
         ctx.expression(1),

src/utils/ExpressionHelper.ts

@@ -10,7 +10,7 @@ export function parseSimpleIdentifierList(
 ): string[] {
   const result: string[] = [];
 
-  if (!ctx) {
+  if (ctx === null || ctx === undefined) {
     return result;
   }
 

src/utils/common.ts

@@ -184,8 +184,6 @@ describe("Circom Template Inputs Visitor", () => {
 
     visitor.startParse();
 
-    console.log(visitor.templateInputs);
-
     expect(visitor.errors.length).to.equal(0);
 
     expect(visitor.templateInputs.base.type).to.equal("input");
@@ -206,4 +204,33 @@ describe("Circom Template Inputs Visitor", () => {
     expect(visitor.templateInputs.another.type).to.equal("output");
     expect(visitor.templateInputs.another.dimension).to.deep.equal([4]);
   });
+
+  it("should analyse the EcAdd.circom circuit", () => {
+    const data = getData("EcAdd.circom");
+
+    const visitor = new CircomTemplateInputsVisitor(
+      "EcAdd.circom",
+      data.templates[data.mainComponentInfo.templateName!].context,
+      buildVariableContext(
+        data.templates[data.mainComponentInfo.templateName!].parameters,
+        data.mainComponentInfo.parameters,
+      ),
+    );
+
+    visitor.startParse();
+
+    expect(visitor.errors.length).to.equal(0);
+
+    expect(visitor.templateInputs.in1.type).to.equal("input");
+    expect(visitor.templateInputs.in1.dimension).to.deep.equal([2, 4]);
+
+    expect(visitor.templateInputs.in2.type).to.equal("input");
+    expect(visitor.templateInputs.in2.dimension).to.deep.equal([2, 4]);
+
+    expect(visitor.templateInputs.dummy.type).to.equal("input");
+    expect(visitor.templateInputs.dummy.dimension).to.deep.equal([]);
+
+    expect(visitor.templateInputs.out.type).to.equal("output");
+    expect(visitor.templateInputs.out.dimension).to.deep.equal([2, 4]);
+  });
 });

test/circom-template-inputs-visitor.test.ts

@@ -0,0 +1,11 @@
+pragma circom 2.1.6;
+
+template EllipticCurveAdd(CHUNK_SIZE, CHUNK_NUMBER, A, B, P) {
+    signal input in1[2][CHUNK_NUMBER];
+    signal input in2[2][CHUNK_NUMBER];
+    signal input dummy;
+
+    signal output out[2][CHUNK_NUMBER];
+}
+
+component main = EllipticCurveAdd(64, 4, [0, 0, 0, 0], [7, 0, 0, 0],[18446744069414583343, 18446744073709551615, 18446744073709551615, 18446744073709551615]);