@solarity/zkit 0.1.1 → 0.2.1

package/README.md

@@ -3,12 +3,11 @@
 
 # ZKit - Circom Zero Knowledge Kit
 
-**A zero knowledge kit that helps you develop circuits using Circom.**
+**A zero knowledge kit that helps you interact with Circom circuits.**
 
-- Compile and interact with circuits without snarkjs hassle.
 - Generate and verify ZK proofs with a single line of code.
 - Render optimized Solidity verifiers.
-- Forget about native dependencies - everything is in TypeScript.
+- Build and work with ZK witnesses.
 
 ## Installation
 
@@ -20,67 +19,42 @@ npm install --save-dev @solarity/zkit
 
 ## Usage
 
-### CircomZKit
-
-ZKit is a configless package, which means you don't need to provide any configuration to use it:
-
-```typescript
-import { CircomZKit } from "@solarity/zkit";
-
-async function main() {
-  const zkit = new CircomZKit();
-  
-  const multiplier = zkit.getCircuit("Multiplier");
-  
-  // Generates artifacts in the "./zkit-artifacts" directory
-  await multiplier.compile();
-
-  // Generates ZK proof
-  const proof = await multiplier.generateProof({ a: 2, b: 3});
-}
-```
-
-By default, ZKit will look for the circuit file in the `./circuits` directory. However, you can change this by providing a custom one:
-
-```typescript
-new CircomZKit({ circuitsDir: "./my-circuits" });
-```
-
-To generate zkey, the power-of-tau file is required. ZKit automatically downloads those files from [Hermes](https://hermez.s3-eu-west-1.amazonaws.com/) to the `${HOME}/.zkit/.ptau` directory, so you don't need to re-download them every time you start a new project.
-
-You can also provide a custom path to the directory where the power-of-tau files are stored:
+> [!IMPORTANT]
+> The kit is not meant to be used directly as its fitness relies heavily on the environment, Circom compilation artifacts management, processing of remappings, etc. Consider using [hardhat-zkit](https://github.com/dl-solarity/hardhat-zkit) which is a complete, developer-friendly package.
 
-```typescript
-new CircomZKit({ ptauDir: "./my-ptau" });
-```
+### CircuitZKit
 
-> [!IMPORTANT]
-> Note that all the files in the `ptauDir` directory must have the `powers-of-tau-{x}.ptau` name format, where `{x}` is a maximum degree (2<sup>x</sup>) of constraints a `ptau` supports.
+`CircuitZKit` is a user-friendly interface for interacting with circom circuits.
 
-ZKit may also ask you for the permission to download the power-of-tau files. You can enable this by toggling off the `allowDownload` option:
+To create a CircuitZKit object it is necessary to pass a config:
 
 ```typescript
-new CircomZKit({ allowDownload: false });
+CircuitZKitConfig = {
+  circuitName: string;
+  circuitArtifactsPath: string;
+  verifierDirPath: string;
+  templateType?: VerifierTemplateType;
+};
 ```
 
-### CircuitZKit
-
-Once you created a `CircuitZKit` instance using the `getCircuit` method, you can manage the underlying circuit using the following methods:
+This config contains all the information required to work with the circuit, namely:
 
-> [!NOTE]
-> You should first compile the circuit before creating verifiers or generating proofs.
+- `circuitName` - Name of the circuit file without extension
+- `circuitArtifactsPath` - Full path to compilation artifacts for the desired circuit
+- `verifierDirPath` - Full path to the directory where Solidity verifier file will be generated
+- `templateType` - The type of template that will be used to generate the Solidity verifier contract. Right now only `groth16` is supported
 
-#### compile()
+#### getTemplate()
 
-Compiles the circuit and generates the artifacts in the `./zkit-artifacts` or in the provided `artifactsDir` directory. The default output is `r1cs`, `zkey` and `vkey` files.
+Static `CircuitZKit` function that returns the contents of a template file by the passed type.
 
 ```typescript
-await multiplier.compile();
+const templateContent = CircuitZKit.getTemplate("groth16");
 ```
 
 #### createVerifier()
 
-Creates Solidity verifier contract  in the `./contracts/verifiers` or in the provided `verifiersDir` directory. 
+Creates a Solidity verifier contract on `verifierDirPath` path, which was specified in the config.
 
 ```typescript
 await multiplier.createVerifier();
@@ -92,7 +66,7 @@ Generates a proof for the given inputs.
 
 ```typescript
 /// { proof: { pi_a, pi_b, pi_c, protocol, curve }, publicSignals: [6] }
-const proof = await multiplier.generateProof({ a: 2, b: 3});
+const proof = await multiplier.generateProof({ a: 2, b: 3 });
 ```
 
 #### verifyProof()
@@ -116,5 +90,3 @@ const calldata = await multiplier.generateCalldata(proof);
 ## Known limitations
 
 - Currently, ZKit supports only the Groth16 proving system.
-- Zkey generation doesn't allow additional contributions.
-- The `compile` method may cause [issues](https://github.com/iden3/snarkjs/issues/494).

package/dist/core/CircuitZKit.d.ts

@@ -1,34 +1,29 @@
-import { CompileOptions } from "../config/config";
-import { ManagerZKit } from "./ManagerZKit";
-import { Calldata, Inputs, ProofStruct } from "../types/types";
+import { ArtifactsFileType, Calldata, CircuitZKitConfig, Inputs, ProofStruct, VerifierTemplateType } from "../types/circuit-zkit";
 /**
  * `CircuitZKit` represents a single circuit and provides a high-level API to work with it.
- *
- * @dev This class is not meant to be used directly. Use the `CircomZKit` to create its instance.
  */
 export declare class CircuitZKit {
-    private readonly _circuit;
-    private readonly _manager;
+    private readonly _config;
+    constructor(_config: CircuitZKitConfig);
     /**
-     * Creates a new instance of `CircuitZKit`.
+     * Returns the Solidity verifier template for the specified proving system.
      *
-     * @param {string} _circuit - The path to the circuit.
-     * @param {ManagerZKit} _manager - The manager that maintains the global state.
+     * @param {VerifierTemplateType} templateType - The template type.
+     * @returns {string} The Solidity verifier template.
      */
-    constructor(_circuit: string, _manager: ManagerZKit);
+    static getTemplate(templateType: VerifierTemplateType): string;
     /**
-     * Compiles the circuit and generates the artifacts.
-     *
-     * @dev If compilation fails, the latest valid artifacts will be preserved.
-     * @dev Doesn't show the compilation error if `quiet` is set to `true`.
-     *
-     * @param {Partial<CompileOptions>} [options=defaultCompileOptions] - Compilation options.
+     * Creates a Solidity verifier contract.
      */
-    compile(options?: Partial<CompileOptions>): Promise<void>;
+    createVerifier(): Promise<void>;
     /**
-     * Creates a verifier contract.
+     * Creates a witness for the given inputs.
+     *
+     * @dev The `inputs` should be in the same order as the circuit expects them.
+     *
+     * @param {Inputs} inputs - The inputs for the circuit.
      */
-    createVerifier(): Promise<void>;
+    createWitness(inputs: Inputs): Promise<void>;
     /**
      * Generates a proof for the given inputs.
      *
@@ -58,90 +53,36 @@ export declare class CircuitZKit {
      */
     generateCalldata(proof: ProofStruct): Promise<Calldata>;
     /**
-     * Returns the circuit ID. The circuit ID is the name of the circuit file without the extension.
+     * Returns the circuit name. The circuit name is the name of the circuit file without the extension.
      *
-     * @returns {string} The circuit ID.
+     * @returns {string} The circuit name.
      */
-    getCircuitId(): string;
+    getCircuitName(): string;
     /**
-     * Returns the verifier ID. The verifier ID is the name of the circuit file without the extension, suffixed with "Verifier".
+     * Returns the verifier name. The verifier name is the name of the circuit file without the extension, suffixed with "Verifier".
      *
-     * @returns {string} The verifier ID.
+     * @returns {string} The verifier name.
      */
-    getVerifierId(): string;
+    getVerifierName(): string;
     /**
-     * Generates zero-knowledge key for the circuit.
+     * Returns the type of verifier template that was stored in the config
      *
-     * @param {CompileOptions} options - Compilation options.
-     * @param {string} outDir - The directory to save the generated key.
-     * @todo This method may cause issues https://github.com/iden3/snarkjs/issues/494
+     * @returns {VerifierTemplateType} The verifier template type.
      */
-    private _generateZKey;
+    getTemplateType(): VerifierTemplateType;
     /**
-     * Generates verification key for the circuit.
+     * Returns the path to the file of the given type inside artifacts directory. Throws an error if the file doesn't exist.
      *
-     * @param {string} outDir - The directory to save the generated key.
-     */
-    private _generateVKey;
-    /**
-     * Returns the arguments to compile the circuit.
-     *
-     * @param {CompileOptions} options - Compilation options.
-     * @param {string} outDir - The directory to save the compiled artifacts.
-     * @returns {string[]} The arguments to compile the circuit.
-     */
-    private _getCompileArgs;
-    /**
-     * Compiles the circuit.
-     *
-     * @param {CompileOptions} options - Compilation options.
-     * @param {string} outDir - The directory to save the compiled artifacts.
-     */
-    private _compile;
-    /**
-     * Returns the number of constraints in the circuit. This value is used to fetch the correct `ptau` file.
-     *
-     * @param {string} outDir - The directory where the compiled artifacts are saved.
-     * @returns {Promise<number>} The number of constraints in the circuit.
-     */
-    _getConstraints(outDir: string): Promise<number>;
-    /**
-     * Returns the path to the file of the given type.
-     *
-     * @param {FileType} fileType - The type of the file.
-     * @param {string | undefined} temp - The temporary directory to use.
+     * @param {ArtifactsFileType} fileType - The type of the file.
      * @returns {string} The path to the file.
      */
-    private _getFile;
-    /**
-     * Returns the path to the directory of the given type.
-     *
-     * @param {DirType} dirType - The type of the directory.
-     * @returns {string} The path to the directory.
-     */
-    private _getDir;
+    mustGetArtifactsFilePath(fileType: ArtifactsFileType): string;
     /**
-     * Returns the path to the file of the given type. Throws an error if the file doesn't exist.
+     * Returns the path to the file of the given type inside artifacts directory.
      *
-     * @param {FileType} fileType - The type of the file.
-     * @param {string | undefined} temp - The temporary directory to use.
+     * @param {ArtifactsFileType} fileType - The type of the file.
      * @returns {string} The path to the file.
      */
-    private _mustGetFile;
-    /**
-     * Moves the files from the temporary directory to the output directory.
-     *
-     * @param {string} tempDir - The temporary directory.
-     * @param {string} outDir - The output directory.
-     */
-    private _moveFromTempDirToOutDir;
-    /**
-     * Returns a new instance of `CircomRunner`. The `CircomRunner` is used to compile the circuit.
-     *
-     * @param {string[]} args - The arguments to run the `circom` compiler.
-     * @param {boolean} quiet - Whether to suppress the compilation error.
-     * @returns {typeof CircomRunner} The `CircomRunner` instance.
-     */
-    private _getCircomRunner;
+    getArtifactsFilePath(fileType: ArtifactsFileType): string;
 }
 //# sourceMappingURL=CircuitZKit.d.ts.map

package/dist/core/CircuitZKit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CircuitZKit.d.ts","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":"AAMA,OAAO,EAAyB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAqB,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAKlF;;;;GAIG;AACH,qBAAa,WAAW;IAQpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAR3B;;;;;OAKG;gBAEgB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW;IAGxC;;;;;;;OAOG;IACU,OAAO,CAAC,OAAO,GAAE,OAAO,CAAC,cAAc,CAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB7F;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA0B5C;;;;;;;;OAQG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhE;;;;;;;;OAQG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ9D;;;;;;OAMG;IACU,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMpE;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAI7B;;;;OAIG;IACI,aAAa,IAAI,MAAM;IAI9B;;;;;;OAMG;YACW,aAAa;IA0B3B;;;;OAIG;YACW,aAAa;IAS3B;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAYvB;;;;;OAKG;YACW,QAAQ;IAiBtB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkCtD;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAuBhB;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAef;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAUpB;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAmBhC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;CAczB"}
+{"version":3,"file":"CircuitZKit.d.ts","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,iBAAiB,EACjB,QAAQ,EACR,iBAAiB,EACjB,MAAM,EACN,WAAW,EACX,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,iBAAiB;IAEvD;;;;;OAKG;WACW,WAAW,CAAC,YAAY,EAAE,oBAAoB,GAAG,MAAM;IASrE;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB5C;;;;;;OAMG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzD;;;;;;;;OAQG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhE;;;;;;;;OAQG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ9D;;;;;;OAMG;IACU,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMpE;;;;OAIG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;OAIG;IACI,eAAe,IAAI,MAAM;IAIhC;;;;OAIG;IACI,eAAe,IAAI,oBAAoB;IAI9C;;;;;OAKG;IACI,wBAAwB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM;IAUpE;;;;;OAKG;IACI,oBAAoB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM;CAmCjE"}