Add logic to ignore unsupported contexts (#44)

* Added logic to ignore unsupported contexts

* Fixed typo

* Improved message structure

* Fixed typo

* Fixed typo

* Simplified logic

* Added comment

* Resolved imports

* Updated versions

* Fixed typos

* Deleted colon

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solarity/hardhat-zkit",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "description": "The ultimate TypeScript environment for Circom development",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

src/core/compile/CompilationFilesResolver.ts

@@ -117,6 +117,7 @@ export class CompilationFilesResolver {
       filteredResolvedFilesInfo = resolvedFilesInfoToCompile;
     }
 
+    Reporter!.reportAllWarnings(spinnerId);
     Reporter!.reportCircuitFilesResolvingResult(spinnerId);
 
     const filteredSourceNamesToCompile: string[] = filteredResolvedFilesInfo.map(

src/core/dependencies/parser/CircomTemplateInputsVisitor.ts

@@ -10,10 +10,13 @@ import {
   VarDefinitionContext,
   RhsValueContext,
   TemplateStmtContext,
+  BlockInstantiationExpressionContext,
+  DotExpressionContext,
 } from "@distributedlab/circom-parser";
 
 import { InputData } from "../../../types/core";
 import { HardhatZKitError } from "../../../errors";
+import { Reporter } from "../../../reporter";
 
 /**
  * Visitor class for the {@link https://www.npmjs.com/package/@distributedlab/circom-parser | @distributedlab/circom-parser} package.
@@ -133,7 +136,24 @@ export class CircomTemplateInputsVisitor extends CircomVisitor<void> {
   _parseRHSValue = (ctx: RhsValueContext): bigint[] => {
     const expressionVisitor = new CircomExpressionVisitor(true, this.vars);
 
+    /**
+     *  Due to the filtering below following expressions are skipped during the input signals resolution:
+     *
+     *  ```circom
+     *  var var1 = functionCall();
+     *  var var2 = component.out;
+     *  ```
+     */
     if (ctx.expression()) {
+      if (
+        ctx.expression() instanceof BlockInstantiationExpressionContext ||
+        ctx.expression() instanceof DotExpressionContext
+      ) {
+        Reporter?.reportUnsupportedExpression(this._templateName, ctx.expression());
+
+        return [0n];
+      }
+
       const expressionResult = expressionVisitor.visitExpression(ctx.expression());
 
       if (Array.isArray(expressionResult)) {

src/reporter/ReporterFacade.ts

@@ -4,7 +4,7 @@ import debug from "debug";
 import { VerifierLanguageType } from "@solarity/zkit";
 
 import { CircuitArtifact } from "../types/artifacts/circuit-artifacts";
-import { CompilationInfo, CircuitSetupInfo } from "../types/core";
+import { CompilationInfo, CircuitSetupInfo, SimpleParserRuleContext } from "../types/core";
 import {
   ProgressReporter,
   CircuitFilesResolvingReporter,
@@ -15,6 +15,7 @@ import {
   VerifiersGenerationReporter,
   VKeyFilesGenerationReporter,
   ZKeyFilesGenerationReporter,
+  WarningsReporter,
 } from "./reporters";
 
 import { createProgressBarProcessor } from "./ProgressBarProcessor";
@@ -31,6 +32,7 @@ class ReporterFacade {
   private _setupReporter!: SetupReporter;
   private _progressReporter!: ProgressReporter;
   private _ptauFileReporter!: PtauFileReporter;
+  private _warningsReporter!: WarningsReporter;
   private _circomCompilerReporter!: CircomCompilerReporter;
   private _circuitCompilationReporter!: CircuitCompilationReporter;
   private _verifiersGenerationReporter!: VerifiersGenerationReporter;
@@ -55,6 +57,7 @@ class ReporterFacade {
     this._vKeyFilesGenerationReporter = new VKeyFilesGenerationReporter(quiet);
     this._zKeyFilesGenerationReporter = new ZKeyFilesGenerationReporter(quiet);
     this._circuitFilesResolvingReporter = new CircuitFilesResolvingReporter(quiet);
+    this._warningsReporter = new WarningsReporter(quiet);
   }
 
   public setQuiet(newValue: boolean) {
@@ -219,6 +222,14 @@ class ReporterFacade {
     this._progressReporter.updateProgressBarValue(valueToAdd);
   }
 
+  public reportUnsupportedExpression(templateName: string, context: SimpleParserRuleContext) {
+    this._warningsReporter.reportUnsupportedExpression(templateName, context);
+  }
+
+  public reportAllWarnings(spinnerId: string | null) {
+    this._warningsReporter.reportAllWarnings(spinnerId);
+  }
+
   public verboseLog(namespace: string, formatterStr: string, logArgs: any[] = []) {
     debug(`hardhat-zkit:${namespace}`)(formatterStr, ...logArgs);
   }

src/reporter/SpinnerProcessor.ts

@@ -31,6 +31,16 @@ export class BaseSpinnerProcessor {
     this._idToSpinnerData.delete(spinnerId);
   }
 
+  public warnSpinner(spinnerId: string, warningMessage: string) {
+    const spinnerData = this._idToSpinnerData.get(spinnerId);
+
+    if (!spinnerData) return;
+
+    spinnerData.spinner.warn(warningMessage);
+
+    this._idToSpinnerData.delete(spinnerId);
+  }
+
   public getWorkingTime(spinnerId: string, fractionDigits: number = 2): string | undefined {
     const spinnerData = this._idToSpinnerData.get(spinnerId);
 

src/reporter/reporters/WarningsReporter.ts

@@ -0,0 +1,44 @@
+import { SpinnerProcessor } from "../../reporter";
+import { BaseReporter } from "../../reporter/reporters/BaseReporter";
+
+import { SimpleParserRuleContext } from "../../types/core";
+
+export class WarningsReporter extends BaseReporter {
+  public warnings: Set<string> = new Set();
+
+  constructor(quiet: boolean) {
+    super(quiet);
+
+    this.warnings = new Set();
+  }
+
+  public reportUnsupportedExpression(templateName: string, context: SimpleParserRuleContext) {
+    if (this.isQuiet()) return;
+
+    this.warnings.add(
+      `\nInside the ${templateName} circuit (${context.start.line}:${context.start.column})
+      \rExpression structure "${context.getText()}" is not supported if used to determine the dimension of an input signal!`,
+    );
+  }
+
+  public reportAllWarnings(spinnerId: string | null) {
+    if (this.isQuiet() || !spinnerId || !this.hasWarnings()) return;
+
+    const resolvingTimeMessage: string = this._getSpinnerWorkingTimeMessage(
+      SpinnerProcessor!.getWorkingTime(spinnerId),
+    );
+
+    SpinnerProcessor!.warnSpinner(
+      spinnerId,
+      `Circuits are ready for the compilation ${resolvingTimeMessage}, however, the analysis ended with warnings:`,
+    );
+
+    for (const warning of this.warnings) {
+      console.warn(warning);
+    }
+  }
+
+  public hasWarnings(): boolean {
+    return this.warnings.size > 0;
+  }
+}

src/reporter/reporters/index.ts

@@ -2,6 +2,7 @@ export * from "./BaseReporter";
 export * from "./SetupReporter";
 export * from "./ProgressReporter";
 export * from "./PtauFileReporter";
+export * from "./WarningsReporter";
 export * from "./CircomCompilerReporter";
 export * from "./CircuitCompilationReporter";
 export * from "./CircuitFilesResolvingReporter";

src/types/core/dependencies/parser/circom-files-visitor.ts

@@ -21,3 +21,20 @@ export type CircomFileData = {
   mainComponentInfo: MainComponent;
   templates: Templates;
 };
+
+export interface Token {
+  tokenIndex: number;
+  line: number;
+  column: number;
+  channel: number;
+  text: string;
+  type: number;
+  start: number;
+  stop: number;
+}
+
+export interface SimpleParserRuleContext {
+  start: Token;
+
+  getText(): string;
+}