@noir-lang/noir_js 0.29.0 → 0.30.0

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export { ecdsa_secp256r1_verify, ecdsa_secp256k1_verify, keccak256, blake2s256,
 export { InputMap } from '@noir-lang/noirc_abi';
 export { WitnessMap, ForeignCallHandler, ForeignCallInput, ForeignCallOutput } from '@noir-lang/acvm_js';
 export { Noir } from './program.js';
+export { ErrorWithPayload } from './witness_generation.js';
 /** @ignore */
 export { acvm, abi };
 export { CompiledCircuit, ProofData };

package/lib/witness_generation.cjs

@@ -19,15 +19,30 @@ const defaultForeignCallHandler = async (name, args) => {
         // If a user needs to print values then they should provide a custom foreign call handler.
         return [];
     }
-    else if (name == 'assert_message') {
-        // By default we do not do anything for `assert_message` foreign calls due to a need for formatting,
-        // however we provide an empty response in order to not halt execution.
-        //
-        // If a user needs to use dynamic assertion messages then they should provide a custom foreign call handler.
-        return [];
-    }
     throw Error(`Unexpected oracle during execution: ${name}(${args.join(', ')})`);
 };
+function parseErrorPayload(abi, originalError) {
+    const payload = originalError.rawAssertionPayload;
+    if (!payload)
+        return 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}`;
+        }
+        else {
+            // If not, attach the payload to the original error
+            enrichedError.decodedAssertionPayload = decodedPayload;
+        }
+    }
+    catch (_errorDecoding) {
+        // Ignore errors decoding the payload
+    }
+    return enrichedError;
+}
 // Generates the witnesses needed to feed into the chosen proving system
 async function generateWitness(compiledProgram, inputs, foreignCallHandler = defaultForeignCallHandler) {
     // Throws on ABI encoding error
@@ -39,6 +54,10 @@ async function generateWitness(compiledProgram, inputs, foreignCallHandler = def
         return solvedWitness;
     }
     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 new Error(`Circuit execution failed: ${err}`);
     }
 }

package/lib/witness_generation.d.ts

@@ -1,4 +1,7 @@
 import { InputMap } from '@noir-lang/noirc_abi';
-import { WitnessStack, ForeignCallHandler } from '@noir-lang/acvm_js';
+import { WitnessStack, ForeignCallHandler, ExecutionError } from '@noir-lang/acvm_js';
 import { CompiledCircuit } from '@noir-lang/types';
+export type ErrorWithPayload = ExecutionError & {
+    decodedAssertionPayload?: any;
+};
 export declare function generateWitness(compiledProgram: CompiledCircuit, inputs: InputMap, foreignCallHandler?: ForeignCallHandler): Promise<WitnessStack>;

package/lib/witness_generation.mjs

@@ -1,4 +1,4 @@
-import { abiEncode } from '@noir-lang/noirc_abi';
+import { abiDecodeError, abiEncode } from '@noir-lang/noirc_abi';
 import { base64Decode } from "./base64_decode.mjs";
 import { createBlackBoxSolver, executeProgramWithBlackBoxSolver, } from '@noir-lang/acvm_js';
 let solver;
@@ -16,15 +16,30 @@ const defaultForeignCallHandler = async (name, args) => {
         // If a user needs to print values then they should provide a custom foreign call handler.
         return [];
     }
-    else if (name == 'assert_message') {
-        // By default we do not do anything for `assert_message` foreign calls due to a need for formatting,
-        // however we provide an empty response in order to not halt execution.
-        //
-        // If a user needs to use dynamic assertion messages then they should provide a custom foreign call handler.
-        return [];
-    }
     throw Error(`Unexpected oracle during execution: ${name}(${args.join(', ')})`);
 };
+function parseErrorPayload(abi, originalError) {
+    const payload = originalError.rawAssertionPayload;
+    if (!payload)
+        return 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}`;
+        }
+        else {
+            // If not, attach the payload to the original error
+            enrichedError.decodedAssertionPayload = decodedPayload;
+        }
+    }
+    catch (_errorDecoding) {
+        // Ignore errors decoding the payload
+    }
+    return enrichedError;
+}
 // Generates the witnesses needed to feed into the chosen proving system
 export async function generateWitness(compiledProgram, inputs, foreignCallHandler = defaultForeignCallHandler) {
     // Throws on ABI encoding error
@@ -36,6 +51,10 @@ export async function generateWitness(compiledProgram, inputs, foreignCallHandle
         return solvedWitness;
     }
     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 new Error(`Circuit execution failed: ${err}`);
     }
 }

package/package.json

@@ -3,7 +3,7 @@
   "contributors": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "0.29.0",
+  "version": "0.30.0",
   "packageManager": "yarn@3.5.1",
   "license": "(MIT OR Apache-2.0)",
   "type": "module",
@@ -17,9 +17,9 @@
     "url": "https://github.com/noir-lang/noir/issues"
   },
   "dependencies": {
-    "@noir-lang/acvm_js": "0.45.0",
-    "@noir-lang/noirc_abi": "0.29.0",
-    "@noir-lang/types": "0.29.0"
+    "@noir-lang/acvm_js": "0.46.0",
+    "@noir-lang/noirc_abi": "0.30.0",
+    "@noir-lang/types": "0.30.0"
   },
   "files": [
     "lib",