@noir-lang/noir_js 1.0.0-beta.3-7000792.nightly → 1.0.0-beta.4-17958e3.nightly

package/lib/base64_decode.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.base64Decode = void 0;
+exports.base64Decode = base64Decode;
 // Since this is a simple function, we can use feature detection to
 // see if we are in the nodeJs environment or the browser environment.
 function base64Decode(input) {
@@ -16,4 +16,3 @@ function base64Decode(input) {
         throw new Error('No implementation found for base64 decoding.');
     }
 }
-exports.base64Decode = base64Decode;

package/lib/debug.cjs

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDebugSymbols = parseDebugSymbols;
+exports.extractCallStack = extractCallStack;
+const pako_1 = require("pako");
+const base64_decode_1 = require("./base64_decode.cjs");
+function parseDebugSymbols(debugSymbols) {
+    return JSON.parse((0, pako_1.inflate)((0, base64_decode_1.base64Decode)(debugSymbols), { to: 'string', raw: true })).debug_infos;
+}
+/**
+ * Extracts the call stack from an thrown by the acvm.
+ * @param error - The error to extract from.
+ * @param debug - The debug metadata of the program called.
+ * @param files - The files used for compilation of the program.
+ * @returns The call stack, if available.
+ */
+function extractCallStack(error, debug, files) {
+    if (!('callStack' in error) || !error.callStack) {
+        return undefined;
+    }
+    const { callStack, brilligFunctionId } = error;
+    if (!debug) {
+        return callStack;
+    }
+    try {
+        return resolveOpcodeLocations(callStack, debug, files, brilligFunctionId);
+    }
+    catch (_err) {
+        return callStack;
+    }
+}
+/**
+ * Resolves the source code locations from an array of opcode locations
+ */
+function resolveOpcodeLocations(opcodeLocations, debug, files, brilligFunctionId) {
+    return opcodeLocations.flatMap((opcodeLocation) => getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, files, brilligFunctionId));
+}
+/**
+ * Extracts the call stack from the location of a failing opcode and the debug metadata.
+ * One opcode can point to multiple calls due to inlining.
+ */
+function getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, files, brilligFunctionId) {
+    let callStack = debug.locations[opcodeLocation] || [];
+    if (callStack.length === 0) {
+        const brilligLocation = extractBrilligLocation(opcodeLocation);
+        if (brilligFunctionId !== undefined && brilligLocation !== undefined) {
+            callStack = debug.brillig_locations[brilligFunctionId][brilligLocation] || [];
+        }
+    }
+    return callStack.map((call) => {
+        const { file: fileId, span } = call;
+        const { path, source } = files[fileId];
+        const locationText = source.substring(span.start, span.end);
+        const precedingText = source.substring(0, span.start);
+        const previousLines = precedingText.split('\n');
+        // Lines and columns in stacks are one indexed.
+        const line = previousLines.length;
+        const column = previousLines[previousLines.length - 1].length + 1;
+        return {
+            filePath: path,
+            line,
+            column,
+            locationText,
+        };
+    });
+}
+/**
+ * Extracts a brillig location from an opcode location.
+ */
+function extractBrilligLocation(opcodeLocation) {
+    const splitted = opcodeLocation.split('.');
+    if (splitted.length === 2) {
+        return splitted[1];
+    }
+    return undefined;
+}

package/lib/debug.d.ts

@@ -0,0 +1,37 @@
+import { DebugFileMap, DebugInfo, OpcodeLocation } from '@noir-lang/types';
+import { ExecutionError } from '@noir-lang/acvm_js';
+/**
+ * A stack of calls, resolved or not
+ */
+type CallStack = SourceCodeLocation[] | OpcodeLocation[];
+/**
+ * A resolved pointer to a failing section of the noir source code.
+ */
+interface SourceCodeLocation {
+    /**
+     * The path to the source file.
+     */
+    filePath: string;
+    /**
+     * The line number of the location.
+     */
+    line: number;
+    /**
+     * The column number of the location.
+     */
+    column: number;
+    /**
+     * The source code text of the location.
+     */
+    locationText: string;
+}
+export declare function parseDebugSymbols(debugSymbols: string): DebugInfo[];
+/**
+ * Extracts the call stack from an thrown by the acvm.
+ * @param error - The error to extract from.
+ * @param debug - The debug metadata of the program called.
+ * @param files - The files used for compilation of the program.
+ * @returns The call stack, if available.
+ */
+export declare function extractCallStack(error: ExecutionError, debug: DebugInfo, files: DebugFileMap): CallStack | undefined;
+export {};

package/lib/debug.mjs

@@ -0,0 +1,72 @@
+import { inflate } from 'pako';
+import { base64Decode } from "./base64_decode.mjs";
+export function parseDebugSymbols(debugSymbols) {
+    return JSON.parse(inflate(base64Decode(debugSymbols), { to: 'string', raw: true })).debug_infos;
+}
+/**
+ * Extracts the call stack from an thrown by the acvm.
+ * @param error - The error to extract from.
+ * @param debug - The debug metadata of the program called.
+ * @param files - The files used for compilation of the program.
+ * @returns The call stack, if available.
+ */
+export function extractCallStack(error, debug, files) {
+    if (!('callStack' in error) || !error.callStack) {
+        return undefined;
+    }
+    const { callStack, brilligFunctionId } = error;
+    if (!debug) {
+        return callStack;
+    }
+    try {
+        return resolveOpcodeLocations(callStack, debug, files, brilligFunctionId);
+    }
+    catch (_err) {
+        return callStack;
+    }
+}
+/**
+ * Resolves the source code locations from an array of opcode locations
+ */
+function resolveOpcodeLocations(opcodeLocations, debug, files, brilligFunctionId) {
+    return opcodeLocations.flatMap((opcodeLocation) => getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, files, brilligFunctionId));
+}
+/**
+ * Extracts the call stack from the location of a failing opcode and the debug metadata.
+ * One opcode can point to multiple calls due to inlining.
+ */
+function getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, files, brilligFunctionId) {
+    let callStack = debug.locations[opcodeLocation] || [];
+    if (callStack.length === 0) {
+        const brilligLocation = extractBrilligLocation(opcodeLocation);
+        if (brilligFunctionId !== undefined && brilligLocation !== undefined) {
+            callStack = debug.brillig_locations[brilligFunctionId][brilligLocation] || [];
+        }
+    }
+    return callStack.map((call) => {
+        const { file: fileId, span } = call;
+        const { path, source } = files[fileId];
+        const locationText = source.substring(span.start, span.end);
+        const precedingText = source.substring(0, span.start);
+        const previousLines = precedingText.split('\n');
+        // Lines and columns in stacks are one indexed.
+        const line = previousLines.length;
+        const column = previousLines[previousLines.length - 1].length + 1;
+        return {
+            filePath: path,
+            line,
+            column,
+            locationText,
+        };
+    });
+}
+/**
+ * Extracts a brillig location from an opcode location.
+ */
+function extractBrilligLocation(opcodeLocation) {
+    const splitted = opcodeLocation.split('.');
+    if (splitted.length === 2) {
+        return splitted[1];
+    }
+    return undefined;
+}

package/lib/index.cjs

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.abi = exports.acvm = exports.Noir = exports.and = exports.xor = exports.blake2s256 = exports.ecdsa_secp256k1_verify = exports.ecdsa_secp256r1_verify = void 0;
 const acvm = __importStar(require("@noir-lang/acvm_js"));

package/lib/program.cjs

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Noir = void 0;
 const witness_generation_js_1 = require("./witness_generation.cjs");

package/lib/witness_generation.cjs

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateWitness = void 0;
+exports.generateWitness = generateWitness;
 const noirc_abi_1 = require("@noir-lang/noirc_abi");
 const base64_decode_js_1 = require("./base64_decode.cjs");
 const acvm_js_1 = require("@noir-lang/acvm_js");
+const debug_js_1 = require("./debug.cjs");
 const defaultForeignCallHandler = async (name, args) => {
     if (name == 'print') {
         // By default we do not print anything for `print` foreign calls due to a need for formatting,
@@ -14,25 +15,39 @@ const defaultForeignCallHandler = async (name, args) => {
     }
     throw Error(`Unexpected oracle during execution: ${name}(${args.join(', ')})`);
 };
-function parseErrorPayload(abi, originalError) {
-    const payload = originalError.rawAssertionPayload;
-    if (!payload)
-        return originalError;
+function enrichExecutionError(artifact, originalError) {
     const enrichedError = originalError;
-    try {
-        // Decode the payload
-        const decodedPayload = (0, noirc_abi_1.abiDecodeError)(abi, payload);
-        if (typeof decodedPayload === 'string') {
-            // If it's a string, just add it to the error message
-            enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+    if (originalError.rawAssertionPayload) {
+        try {
+            // Decode the payload
+            const decodedPayload = (0, noirc_abi_1.abiDecodeError)(artifact.abi, originalError.rawAssertionPayload);
+            if (typeof decodedPayload === 'string') {
+                // If it's a string, just add it to the error message
+                enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+            }
+            else {
+                // If not, attach the payload to the original error
+                enrichedError.decodedAssertionPayload = decodedPayload;
+            }
         }
-        else {
-            // If not, attach the payload to the original error
-            enrichedError.decodedAssertionPayload = decodedPayload;
+        catch (_errorDecoding) {
+            // Ignore errors decoding the payload
         }
     }
-    catch (_errorDecoding) {
-        // Ignore errors decoding the payload
+    try {
+        // Decode the callstack
+        const callStack = (0, debug_js_1.extractCallStack)(originalError, (0, debug_js_1.parseDebugSymbols)(artifact.debug_symbols)[originalError.acirFunctionId], artifact.file_map);
+        enrichedError.noirCallStack = callStack?.map((errorLocation) => {
+            if (typeof errorLocation === 'string') {
+                return `at opcode ${errorLocation}`;
+            }
+            else {
+                return `at ${errorLocation.locationText} (${errorLocation.filePath}:${errorLocation.line}:${errorLocation.column})`;
+            }
+        });
+    }
+    catch (_errorResolving) {
+        // Ignore errors resolving the callstack
     }
     return enrichedError;
 }
@@ -49,9 +64,8 @@ async function generateWitness(compiledProgram, inputs, foreignCallHandler = def
     catch (err) {
         // Typescript types catched errors as unknown or any, so we need to narrow its type to check if it has raw assertion payload.
         if (typeof err === 'object' && err !== null && 'rawAssertionPayload' in err) {
-            throw parseErrorPayload(compiledProgram.abi, err);
+            throw enrichExecutionError(compiledProgram, err);
         }
         throw new Error(`Circuit execution failed: ${err}`);
     }
 }
-exports.generateWitness = generateWitness;

package/lib/witness_generation.d.ts

@@ -3,5 +3,6 @@ import { WitnessStack, ForeignCallHandler, ExecutionError } from '@noir-lang/acv
 import { CompiledCircuit } from '@noir-lang/types';
 export type ErrorWithPayload = ExecutionError & {
     decodedAssertionPayload?: any;
+    noirCallStack?: string[];
 };
 export declare function generateWitness(compiledProgram: CompiledCircuit, inputs: InputMap, foreignCallHandler?: ForeignCallHandler): Promise<WitnessStack>;

package/lib/witness_generation.mjs

@@ -1,6 +1,7 @@
 import { abiDecodeError, abiEncode } from '@noir-lang/noirc_abi';
 import { base64Decode } from "./base64_decode.mjs";
 import { executeProgram } from '@noir-lang/acvm_js';
+import { extractCallStack, parseDebugSymbols } from "./debug.mjs";
 const defaultForeignCallHandler = async (name, args) => {
     if (name == 'print') {
         // By default we do not print anything for `print` foreign calls due to a need for formatting,
@@ -11,25 +12,39 @@ const defaultForeignCallHandler = async (name, args) => {
     }
     throw Error(`Unexpected oracle during execution: ${name}(${args.join(', ')})`);
 };
-function parseErrorPayload(abi, originalError) {
-    const payload = originalError.rawAssertionPayload;
-    if (!payload)
-        return originalError;
+function enrichExecutionError(artifact, originalError) {
     const enrichedError = originalError;
-    try {
-        // Decode the payload
-        const decodedPayload = abiDecodeError(abi, payload);
-        if (typeof decodedPayload === 'string') {
-            // If it's a string, just add it to the error message
-            enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+    if (originalError.rawAssertionPayload) {
+        try {
+            // Decode the payload
+            const decodedPayload = abiDecodeError(artifact.abi, originalError.rawAssertionPayload);
+            if (typeof decodedPayload === 'string') {
+                // If it's a string, just add it to the error message
+                enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+            }
+            else {
+                // If not, attach the payload to the original error
+                enrichedError.decodedAssertionPayload = decodedPayload;
+            }
         }
-        else {
-            // If not, attach the payload to the original error
-            enrichedError.decodedAssertionPayload = decodedPayload;
+        catch (_errorDecoding) {
+            // Ignore errors decoding the payload
         }
     }
-    catch (_errorDecoding) {
-        // Ignore errors decoding the payload
+    try {
+        // Decode the callstack
+        const callStack = extractCallStack(originalError, parseDebugSymbols(artifact.debug_symbols)[originalError.acirFunctionId], artifact.file_map);
+        enrichedError.noirCallStack = callStack?.map((errorLocation) => {
+            if (typeof errorLocation === 'string') {
+                return `at opcode ${errorLocation}`;
+            }
+            else {
+                return `at ${errorLocation.locationText} (${errorLocation.filePath}:${errorLocation.line}:${errorLocation.column})`;
+            }
+        });
+    }
+    catch (_errorResolving) {
+        // Ignore errors resolving the callstack
     }
     return enrichedError;
 }
@@ -46,7 +61,7 @@ export async function generateWitness(compiledProgram, inputs, foreignCallHandle
     catch (err) {
         // Typescript types catched errors as unknown or any, so we need to narrow its type to check if it has raw assertion payload.
         if (typeof err === 'object' && err !== null && 'rawAssertionPayload' in err) {
-            throw parseErrorPayload(compiledProgram.abi, err);
+            throw enrichExecutionError(compiledProgram, err);
         }
         throw new Error(`Circuit execution failed: ${err}`);
     }

package/package.json

@@ -3,8 +3,8 @@
   "contributors": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "1.0.0-beta.3-7000792.nightly",
-  "packageManager": "yarn@3.5.1",
+  "version": "1.0.0-beta.4-17958e3.nightly",
+  "packageManager": "yarn@4.5.2",
   "license": "(MIT OR Apache-2.0)",
   "type": "module",
   "homepage": "https://noir-lang.org/",
@@ -17,9 +17,10 @@
     "url": "https://github.com/noir-lang/noir/issues"
   },
   "dependencies": {
-    "@noir-lang/acvm_js": "1.0.0-beta.3-7000792.nightly",
-    "@noir-lang/noirc_abi": "1.0.0-beta.3-7000792.nightly",
-    "@noir-lang/types": "1.0.0-beta.3-7000792.nightly"
+    "@noir-lang/acvm_js": "1.0.0-beta.4-17958e3.nightly",
+    "@noir-lang/noirc_abi": "1.0.0-beta.4-17958e3.nightly",
+    "@noir-lang/types": "1.0.0-beta.4-17958e3.nightly",
+    "pako": "^2.1.0"
   },
   "files": [
     "lib",
@@ -43,24 +44,25 @@
     "test:node:cjs": "mocha --timeout 25000 --exit --config ./.mocharc.cjs.json",
     "prettier": "prettier 'src/**/*.ts'",
     "prettier:fix": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
-    "lint": "NODE_NO_WARNINGS=1 eslint . --ext .ts --ignore-path ./.eslintignore  --max-warnings 0",
+    "lint": "NODE_NO_WARNINGS=1 eslint . --max-warnings 0",
     "nightly:version": "jq --arg new_version \"-$(git rev-parse --short HEAD)$1\" '.version = .version + $new_version' package.json > package-tmp.json && mv package-tmp.json package.json",
     "publish": "echo 📡 publishing `$npm_package_name` && yarn npm publish",
     "clean": "rm -rf ./lib"
   },
   "devDependencies": {
     "@types/chai": "^4",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.6.2",
-    "@types/prettier": "^3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.13.10",
+    "@types/pako": "^2",
+    "@types/prettier": "^3.0.0",
     "chai": "^4.4.1",
-    "eslint": "^8.57.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "mocha": "^10.2.0",
-    "prettier": "3.2.5",
-    "ts-node": "^10.9.1",
+    "eslint": "^9.24.0",
+    "eslint-plugin-prettier": "^5.2.6",
+    "mocha": "^11.1.0",
+    "prettier": "3.5.3",
+    "ts-node": "^10.9.2",
     "tsc-multi": "^1.1.0",
-    "tsx": "^4.6.2",
-    "typescript": "^5.4.2"
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.3"
   }
 }