Web3 1940 ezkl and plain/zk ultrahonk variants (#68)

* feat: ultrahonk variant plain and zk options

* feat: ezkl support

Author: rushby

.github/workflows/ci-build-and-test.yml

@@ -39,7 +39,10 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
+          node-version: '20.x'
+
+      - name: Use npm 11.6.2
+        run: npm i -g npm@11.6.2
 
       - name: Install dependencies
         run: npm ci

DOCS.md

@@ -72,10 +72,22 @@ session.verify().ultraplonk({
 session.verify().sp1().execute({...})
 ```
 
+### EZKL
+
+```typescript
+session.verify().ezkl().execute({...})
+```
+
 ### UltraHonk
 
+Supports variants: `Plain`, `ZK`
+
+**Note for v1.3.0+**: The `variant` option is required for runtime version 1.3.0 or later.
+
 ```typescript
-session.verify().ultrahonk().execute({...})
+session.verify().ultrahonk({
+  variant: UltrahonkVariant.Plain
+}).execute({...})
 ```
 
 ### Runtime Versions and Network Compatibility

README.md

@@ -63,9 +63,20 @@ session.verify().ultraplonk({
 session.verify().sp1().execute({...})
 ```
 
+### EZKL
+```typescript
+session.verify().ezkl().execute({...})
+```
+
 ### UltraHonk
+Supports variants: `Plain`, `ZK`
+
+**Note for v1.3.0+**: The `variant` option is required for runtime version 1.3.0 or later.
+
 ```typescript
-session.verify().ultrahonk().execute({...})
+session.verify().ultrahonk({
+  variant: UltrahonkVariant.Plain
+}).execute({...})
 ```
 
 ## Runtime Versions and Network Compatibility

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "zkverifyjs",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Submit proofs to zkVerify and query proof state with ease using our npm package.",
   "author": "zkVerify <web3-platform@zkverify.io>",
   "license": "GPL-3.0",
@@ -67,6 +67,7 @@
     "blockchain",
     "crypto",
     "cryptography",
+    "ezkl",
     "fflonk",
     "groth16",
     "javascript",

package.json

@@ -3,8 +3,10 @@ import {
   Library,
   Plonky2HashFunction,
   Risc0Version,
+  UltrahonkVariant,
 } from '../enums';
 import {
+  EZKLProcessor,
   FflonkProcessor,
   Groth16Processor,
   Plonky2Processor,
@@ -48,6 +50,7 @@ export const SupportedNetworkConfig: Record<SupportedNetwork, NetworkConfig> = {
 };
 
 export enum ProofType {
+  ezkl = 'ezkl',
   fflonk = 'fflonk',
   groth16 = 'groth16',
   plonky2 = 'plonky2',
@@ -64,6 +67,10 @@ export interface ProofConfig {
 }
 
 export const proofConfigurations: Record<ProofType, ProofConfig> = {
+  [ProofType.ezkl]: {
+    pallet: 'settlementEzklPallet',
+    processor: EZKLProcessor,
+  },
   [ProofType.fflonk]: {
     pallet: 'settlementFFlonkPallet',
     processor: FflonkProcessor,
@@ -97,7 +104,12 @@ export const proofConfigurations: Record<ProofType, ProofConfig> = {
 
 export interface ProofOptions {
   proofType: ProofType;
-  config?: Groth16Config | Plonky2Config | Risc0Config | UltraplonkConfig; // ADD_NEW_PROOF_TYPE
+  config?:
+    | Groth16Config
+    | Plonky2Config
+    | Risc0Config
+    | UltraplonkConfig
+    | UltrahonkConfig; // ADD_NEW_PROOF_TYPE
 }
 
 export interface Groth16Config {
@@ -117,11 +129,16 @@ export interface UltraplonkConfig {
   numberOfPublicInputs: number;
 }
 
+export interface UltrahonkConfig {
+  variant: UltrahonkVariant;
+}
+
 export type AllProofConfigs =
   | Groth16Config
   | Plonky2Config
   | Risc0Config
   | UltraplonkConfig
+  | UltrahonkConfig
   | undefined;
 // ADD_NEW_PROOF_TYPE - options if needed.
 
@@ -151,6 +168,9 @@ export const zkvTypes = {
     config: 'Plonky2Config',
     bytes: 'Bytes',
   },
+  EzklVk: {
+    vkBytes: 'Bytes',
+  },
 };
 
 export const zkvRpc = {
@@ -249,6 +269,16 @@ export const zkvRpc = {
       ],
       type: 'H256',
     },
+    ezkl: {
+      description: 'Get the hash of an Ezkl verification key artifact',
+      params: [
+        {
+          name: 'vk',
+          type: 'EzklVK',
+        },
+      ],
+      type: 'H256',
+    },
     // ADD_NEW_PROOF_TYPE
   },
 };