@noir-lang/noir_js 0.19.0 → 0.19.1

package/lib/index.cjs

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Noir = exports.and = exports.xor = exports.sha256 = exports.blake2s256 = exports.keccak256 = exports.ecdsa_secp256k1_verify = exports.ecdsa_secp256r1_verify = exports.abi = exports.acvm = void 0;
+exports.abi = exports.acvm = exports.Noir = exports.and = exports.xor = exports.sha256 = exports.blake2s256 = exports.keccak256 = exports.ecdsa_secp256k1_verify = exports.ecdsa_secp256r1_verify = void 0;
 const acvm = __importStar(require("@noir-lang/acvm_js"));
 exports.acvm = acvm;
 const abi = __importStar(require("@noir-lang/noirc_abi"));

package/lib/index.d.ts

@@ -1,6 +1,9 @@
 import * as acvm from '@noir-lang/acvm_js';
 import * as abi from '@noir-lang/noirc_abi';
-export { acvm, abi };
+import { CompiledCircuit, ProofData } from '@noir-lang/types';
 export { ecdsa_secp256r1_verify, ecdsa_secp256k1_verify, keccak256, blake2s256, sha256, xor, and, } from '@noir-lang/acvm_js';
 export { WitnessMap, ForeignCallHandler, ForeignCallInput, ForeignCallOutput } from '@noir-lang/acvm_js';
 export { Noir } from './program.js';
+/** @ignore */
+export { acvm, abi };
+export { CompiledCircuit, ProofData };

package/lib/index.mjs

@@ -1,5 +1,6 @@
 import * as acvm from '@noir-lang/acvm_js';
 import * as abi from '@noir-lang/noirc_abi';
-export { acvm, abi };
 export { ecdsa_secp256r1_verify, ecdsa_secp256k1_verify, keccak256, blake2s256, sha256, xor, and, } from '@noir-lang/acvm_js';
 export { Noir } from "./program.mjs";
+/** @ignore */
+export { acvm, abi };

package/lib/program.cjs

@@ -34,6 +34,7 @@ class Noir {
         this.circuit = circuit;
         this.backend = backend;
     }
+    /** @ignore */
     async init() {
         // If these are available, then we are in the
         // web environment. For the node environment, this
@@ -42,6 +43,17 @@ class Noir {
             await Promise.all([(0, noirc_abi_1.default)(), (0, acvm_js_1.default)()]);
         }
     }
+    /**
+     *
+     * @description
+     * Destroys the underlying backend instance.
+     *
+     * @example
+     * ```typescript
+     * await noir.destroy();
+     * ```
+     *
+     */
     async destroy() {
         await this.backend?.destroy();
     }
@@ -51,17 +63,48 @@ class Noir {
         return this.backend;
     }
     // Initial inputs to your program
+    /**
+     * @description
+     * Allows to execute a circuit to get its witness and return value.
+     *
+     * @example
+     * ```typescript
+     * async execute(inputs)
+     * ```
+     */
     async execute(inputs, foreignCallHandler) {
         await this.init();
         const witness = await (0, witness_generation_js_1.generateWitness)(this.circuit, inputs, foreignCallHandler);
         const { return_value: returnValue } = (0, noirc_abi_1.abiDecode)(this.circuit.abi, witness);
         return { witness: (0, acvm_js_1.compressWitness)(witness), returnValue };
     }
-    // Initial inputs to your program
+    /**
+     *
+     * @description
+     * Generates a witness and a proof given an object as input.
+     *
+     * @example
+     * ```typescript
+     * async generateFinalproof(input)
+     * ```
+     *
+     */
     async generateFinalProof(inputs) {
         const { witness } = await this.execute(inputs);
         return this.getBackend().generateFinalProof(witness);
     }
+    /**
+     *
+     * @description
+     * Instantiates the verification key and verifies a proof.
+     *
+     *
+     * @example
+     * ```typescript
+     * async verifyFinalProof(proof)
+     * ```
+     *
+     */
     async verifyFinalProof(proofData) {
         return this.getBackend().verifyFinalProof(proofData);
     }

package/lib/program.d.ts

@@ -5,13 +5,57 @@ export declare class Noir {
     private circuit;
     private backend?;
     constructor(circuit: CompiledCircuit, backend?: Backend | undefined);
+    /** @ignore */
     init(): Promise<void>;
+    /**
+     *
+     * @description
+     * Destroys the underlying backend instance.
+     *
+     * @example
+     * ```typescript
+     * await noir.destroy();
+     * ```
+     *
+     */
     destroy(): Promise<void>;
     private getBackend;
+    /**
+     * @description
+     * Allows to execute a circuit to get its witness and return value.
+     *
+     * @example
+     * ```typescript
+     * async execute(inputs)
+     * ```
+     */
     execute(inputs: InputMap, foreignCallHandler?: ForeignCallHandler): Promise<{
         witness: Uint8Array;
         returnValue: InputValue;
     }>;
+    /**
+     *
+     * @description
+     * Generates a witness and a proof given an object as input.
+     *
+     * @example
+     * ```typescript
+     * async generateFinalproof(input)
+     * ```
+     *
+     */
     generateFinalProof(inputs: InputMap): Promise<ProofData>;
+    /**
+     *
+     * @description
+     * Instantiates the verification key and verifies a proof.
+     *
+     *
+     * @example
+     * ```typescript
+     * async verifyFinalProof(proof)
+     * ```
+     *
+     */
     verifyFinalProof(proofData: ProofData): Promise<boolean>;
 }

package/lib/program.mjs

@@ -8,6 +8,7 @@ export class Noir {
         this.circuit = circuit;
         this.backend = backend;
     }
+    /** @ignore */
     async init() {
         // If these are available, then we are in the
         // web environment. For the node environment, this
@@ -16,6 +17,17 @@ export class Noir {
             await Promise.all([initAbi(), initACVM()]);
         }
     }
+    /**
+     *
+     * @description
+     * Destroys the underlying backend instance.
+     *
+     * @example
+     * ```typescript
+     * await noir.destroy();
+     * ```
+     *
+     */
     async destroy() {
         await this.backend?.destroy();
     }
@@ -25,17 +37,48 @@ export class Noir {
         return this.backend;
     }
     // Initial inputs to your program
+    /**
+     * @description
+     * Allows to execute a circuit to get its witness and return value.
+     *
+     * @example
+     * ```typescript
+     * async execute(inputs)
+     * ```
+     */
     async execute(inputs, foreignCallHandler) {
         await this.init();
         const witness = await generateWitness(this.circuit, inputs, foreignCallHandler);
         const { return_value: returnValue } = abiDecode(this.circuit.abi, witness);
         return { witness: compressWitness(witness), returnValue };
     }
-    // Initial inputs to your program
+    /**
+     *
+     * @description
+     * Generates a witness and a proof given an object as input.
+     *
+     * @example
+     * ```typescript
+     * async generateFinalproof(input)
+     * ```
+     *
+     */
     async generateFinalProof(inputs) {
         const { witness } = await this.execute(inputs);
         return this.getBackend().generateFinalProof(witness);
     }
+    /**
+     *
+     * @description
+     * Instantiates the verification key and verifies a proof.
+     *
+     *
+     * @example
+     * ```typescript
+     * async verifyFinalProof(proof)
+     * ```
+     *
+     */
     async verifyFinalProof(proofData) {
         return this.getBackend().verifyFinalProof(proofData);
     }

package/package.json

@@ -3,14 +3,14 @@
   "collaborators": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "0.19.0",
+  "version": "0.19.1",
   "packageManager": "yarn@3.5.1",
   "license": "(MIT OR Apache-2.0)",
   "type": "module",
   "dependencies": {
-    "@noir-lang/acvm_js": "0.31.0",
-    "@noir-lang/noirc_abi": "0.19.0",
-    "@noir-lang/types": "0.19.0"
+    "@noir-lang/acvm_js": "0.32.0",
+    "@noir-lang/noirc_abi": "0.19.1",
+    "@noir-lang/types": "0.19.1"
   },
   "files": [
     "lib",