@cofhe/sdk 0.1.1 → 0.2.1

package/web/index.ts

@@ -8,11 +8,16 @@ import {
   type CofhesdkInputConfig,
   type ZkBuilderAndCrsGenerator,
   type FheKeyDeserializer,
+  type EncryptableItem,
+  fheTypeToString,
 } from '@/core';
 
 // Import web-specific storage (internal use only)
 import { createWebStorage } from './storage.js';
 
+// Import worker manager
+import { getWorkerManager, terminateWorker, areWorkersAvailable } from './workerManager.js';
+
 // Import tfhe for web
 import init, { init_panic_hook, TfheCompactPublicKey, ProvenCompactCiphertextList, CompactPkeCrs } from 'tfhe';
 
@@ -68,6 +73,27 @@ const zkBuilderAndCrsGenerator: ZkBuilderAndCrsGenerator = (fhe: string, crs: st
   return { zkBuilder, zkCrs };
 };
 
+/**
+ * Worker-enabled zkProve function
+ * This submits proof generation to a Web Worker
+ */
+async function zkProveWithWorker(
+  fheKeyHex: string,
+  crsHex: string,
+  items: EncryptableItem[],
+  metadata: Uint8Array
+): Promise<Uint8Array> {
+  // Serialize items for worker (convert enum to string name)
+  const serializedItems = items.map((item) => ({
+    utype: fheTypeToString(item.utype),
+    data: typeof item.data === 'bigint' ? item.data.toString() : item.data,
+  }));
+
+  // Submit to worker
+  const workerManager = getWorkerManager();
+  return await workerManager.submitProof(fheKeyHex, crsHex, serializedItems, metadata);
+}
+
 /**
  * Creates a CoFHE SDK configuration for web with IndexedDB storage as default
  * @param config - The CoFHE SDK input configuration (fheKeyStorage will default to IndexedDB if not provided)
@@ -75,6 +101,7 @@ const zkBuilderAndCrsGenerator: ZkBuilderAndCrsGenerator = (fhe: string, crs: st
  */
 export function createCofhesdkConfig(config: CofhesdkInputConfig): CofhesdkConfig {
   return createCofhesdkConfigBase({
+    environment: 'web',
     ...config,
     fheKeyStorage: config.fheKeyStorage === null ? null : config.fheKeyStorage ?? createWebStorage(),
   });
@@ -83,15 +110,52 @@ export function createCofhesdkConfig(config: CofhesdkInputConfig): CofhesdkConfi
 /**
  * Creates a CoFHE SDK client instance for web with TFHE automatically configured
  * TFHE will be initialized automatically on first encryption - no manual setup required
+ * Workers are automatically enabled if available (can be disabled via config.useWorkers)
  * @param config - The CoFHE SDK configuration (use createCofhesdkConfig to create with web defaults)
  * @returns The CoFHE SDK client instance
  */
-export function createCofhesdkClient(config: CofhesdkConfig): CofhesdkClient {
+export function createCofhesdkClient<TConfig extends CofhesdkConfig>(config: TConfig): CofhesdkClient<TConfig> {
+  return createCofhesdkClientBase({
+    config,
+    zkBuilderAndCrsGenerator,
+    tfhePublicKeyDeserializer,
+    compactPkeCrsDeserializer,
+    initTfhe,
+    // Always provide the worker function if available - config.useWorkers controls usage
+    // areWorkersAvailable will return true if the Worker API is available and false in Node.js
+    zkProveWorkerFn: areWorkersAvailable() ? zkProveWithWorker : undefined,
+  });
+}
+
+/**
+ * Terminate the worker (call on app cleanup)
+ */
+export { terminateWorker };
+
+/**
+ * Check if workers are available
+ */
+export { areWorkersAvailable };
+
+/**
+ * Test helper: Create a client with custom worker function (for testing fallback behavior)
+ * @internal - Only for testing purposes
+ */
+export function createCofhesdkClientWithCustomWorker(
+  config: CofhesdkConfig,
+  customZkProveWorkerFn: (
+    fheKeyHex: string,
+    crsHex: string,
+    items: EncryptableItem[],
+    metadata: Uint8Array
+  ) => Promise<Uint8Array>
+): CofhesdkClient {
   return createCofhesdkClientBase({
     config,
     zkBuilderAndCrsGenerator,
     tfhePublicKeyDeserializer,
     compactPkeCrsDeserializer,
     initTfhe,
+    zkProveWorkerFn: customZkProveWorkerFn,
   });
 }

package/web/storage.ts

@@ -1,20 +1,34 @@
 import type { IStorage } from '@/core';
-import { get, set, del } from 'idb-keyval';
-
+import { constructClient } from 'iframe-shared-storage';
 /**
  * Creates a web storage implementation using IndexedDB
  * @returns IStorage implementation for browser environments
  */
 export const createWebStorage = (): IStorage => {
+  const client = constructClient({
+    iframe: {
+      src: 'https://iframe-shared-storage.vercel.app/hub.html',
+      messagingOptions: {
+        enableLog: 'both',
+      },
+
+      iframeReadyTimeoutMs: 30_000, // if the iframe is not initied during this interval AND a reuqest is made, such request will throw an error
+      methodCallTimeoutMs: 10_000, // if a method call is not answered during this interval, the call will throw an error
+      methodCallRetries: 3, // number of retries for a method call if it times out
+    },
+  });
+
+  const indexedDBKeyval = client.indexedDBKeyval;
   return {
     getItem: async (name: string) => {
-      return (await get(name)) || null;
+      // IndexedDBKeyval returns undefined if not found, but we want null (a json-deserialized value is expected)
+      return (await indexedDBKeyval.get(name)) ?? null;
     },
     setItem: async (name: string, value: any) => {
-      await set(name, value);
+      await indexedDBKeyval.set(name, value);
     },
     removeItem: async (name: string) => {
-      await del(name);
+      await indexedDBKeyval.del(name);
     },
   };
 };

package/web/worker.builder.web.test.ts

@@ -0,0 +1,148 @@
+import { describe, it, expect, beforeAll, beforeEach } from 'vitest';
+import { createCofhesdkClient, createCofhesdkConfig } from './index.js';
+import { Encryptable, type CofhesdkClient } from '@/core';
+import { arbSepolia as cofhesdkArbSepolia } from '@/chains';
+import { arbitrumSepolia as viemArbitrumSepolia } from 'viem/chains';
+import { createPublicClient, createWalletClient, http, type PublicClient, type WalletClient } from 'viem';
+import { privateKeyToAccount } from 'viem/accounts';
+
+const TEST_PRIVATE_KEY = '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80';
+
+describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
+  let cofhesdkClient: CofhesdkClient;
+  let publicClient: PublicClient;
+  let walletClient: WalletClient;
+
+  beforeAll(() => {
+    publicClient = createPublicClient({
+      chain: viemArbitrumSepolia,
+      transport: http(),
+    });
+
+    const account = privateKeyToAccount(TEST_PRIVATE_KEY);
+    walletClient = createWalletClient({
+      chain: viemArbitrumSepolia,
+      transport: http(),
+      account,
+    });
+  });
+
+  beforeEach(async () => {
+    const config = createCofhesdkConfig({
+      supportedChains: [cofhesdkArbSepolia],
+    });
+    cofhesdkClient = createCofhesdkClient(config);
+    await cofhesdkClient.connect(publicClient, walletClient);
+  });
+
+  describe('setUseWorker method', () => {
+    it('should have setUseWorker method on EncryptInputsBuilder', () => {
+      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]);
+
+      expect(builder).toHaveProperty('setUseWorker');
+      expect(typeof builder.setUseWorker).toBe('function');
+    });
+
+    it('should return builder for method chaining', () => {
+      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]);
+      const returnedBuilder = builder.setUseWorker(false);
+
+      // Should return the same builder instance (or at least same type)
+      expect(returnedBuilder).toBe(builder);
+    });
+
+    it('should allow chaining with other builder methods', () => {
+      // Should be able to chain setUseWorker with setStepCallback
+      const builder = cofhesdkClient
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setUseWorker(false)
+        .setStepCallback(() => {});
+
+      expect(builder).toBeDefined();
+      expect(builder).toHaveProperty('encrypt');
+    });
+
+    it('should accept true parameter', () => {
+      expect(() => {
+        cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
+      }).not.toThrow();
+    });
+
+    it('should accept false parameter', () => {
+      expect(() => {
+        cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(false);
+      }).not.toThrow();
+    });
+
+    it('should have getUseWorker method', () => {
+      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]);
+
+      expect(builder).toHaveProperty('getUseWorker');
+      expect(typeof builder.getUseWorker).toBe('function');
+    });
+
+    it('should return current useWorker value', () => {
+      const builderWithWorkers = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
+      const builderWithoutWorkers = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(false);
+
+      // Should reflect config values
+      expect(builderWithWorkers.getUseWorker()).toBe(true);
+      expect(builderWithoutWorkers.getUseWorker()).toBe(false);
+    });
+
+    it('should reflect changes from setUseWorker', () => {
+      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
+      expect(builder.getUseWorker()).toBe(true);
+
+      builder.setUseWorker(false);
+      expect(builder.getUseWorker()).toBe(false);
+
+      builder.setUseWorker(true);
+      expect(builder.getUseWorker()).toBe(true);
+    });
+  });
+
+  describe('Worker function availability', () => {
+    it('should initialize client without errors', () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true,
+      });
+
+      expect(() => {
+        createCofhesdkClient(config);
+      }).not.toThrow();
+    });
+
+    it('should handle worker function when workers enabled', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true,
+      });
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+      const builder = client.encryptInputs([Encryptable.uint128(100n)]);
+
+      // Should not throw even though workers aren't available in Node
+      expect(() => {
+        builder.setUseWorker(true);
+      }).not.toThrow();
+    });
+
+    it('should handle when workers disabled', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: false,
+      });
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+      const builder = client.encryptInputs([Encryptable.uint128(100n)]);
+
+      expect(() => {
+        builder.setUseWorker(false);
+      }).not.toThrow();
+    });
+  });
+});

package/web/worker.config.web.test.ts

@@ -0,0 +1,329 @@
+import { arbSepolia as cofhesdkArbSepolia } from '@/chains';
+import { Encryptable } from '@/core';
+
+import { describe, it, expect, beforeAll } from 'vitest';
+import type { PublicClient, WalletClient } from 'viem';
+import { createPublicClient, createWalletClient, http } from 'viem';
+import { privateKeyToAccount } from 'viem/accounts';
+import { arbitrumSepolia as viemArbitrumSepolia } from 'viem/chains';
+import { createCofhesdkClient, createCofhesdkConfig, createCofhesdkClientWithCustomWorker } from './index.js';
+
+const TEST_PRIVATE_KEY = '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80';
+
+describe('@cofhe/sdk/web - Worker Configuration Tests', () => {
+  let publicClient: PublicClient;
+  let walletClient: WalletClient;
+
+  beforeAll(() => {
+    publicClient = createPublicClient({
+      chain: viemArbitrumSepolia,
+      transport: http(),
+    });
+
+    const account = privateKeyToAccount(TEST_PRIVATE_KEY);
+    walletClient = createWalletClient({
+      chain: viemArbitrumSepolia,
+      transport: http(),
+      account,
+    });
+  });
+
+  describe('useWorkers config flag', () => {
+    it('should use workers by default (useWorkers: true)', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        // useWorkers defaults to true
+      });
+
+      expect(config.useWorkers).toBe(true);
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+
+      // Track step callbacks to see worker usage
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      // Check that worker was attempted
+      expect(proveContext).toBeDefined();
+      expect(proveContext.useWorker).toBe(true);
+      // Note: Workers may fail to initialize in Playwright test environment
+      // due to WASM module loading issues. Verify fallback works correctly.
+      expect(proveContext.usedWorker).toBeDefined();
+      // The test cannot load tfhe module, so the worker fallback occurs.
+      // The real test is to check that usedWorker is true
+      // TBD: Find a way to test this in the test environment.
+
+      // Log if fallback occurred for debugging
+      if (!proveContext.usedWorker) {
+        console.log('Worker fallback occurred (expected in test env):', proveContext.workerFailedError);
+        expect(proveContext.workerFailedError).toBeDefined();
+      }
+    }, 60000);
+
+    it('should disable workers when useWorkers: false', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: false,
+      });
+
+      expect(config.useWorkers).toBe(false);
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+
+      // Track step callbacks
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      // Should explicitly NOT use workers
+      expect(proveContext).toBeDefined();
+      expect(proveContext.useWorker).toBe(false);
+      expect(proveContext.usedWorker).toBe(false);
+    }, 60000);
+  });
+
+  describe('setUseWorker() method', () => {
+    it('should override config with setUseWorker(false)', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true, // Config says true
+      });
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+
+      // Track step callbacks
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setUseWorker(false) // Override to false
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      // Should respect the override
+      expect(proveContext.useWorker).toBe(false);
+      expect(proveContext.usedWorker).toBe(false);
+    }, 60000);
+
+    it('should override config with setUseWorker(true)', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: false, // Config says false
+      });
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+
+      // Track step callbacks
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setUseWorker(true) // Override to true
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      // Should use worker since we overrode to true
+      expect(proveContext.useWorker).toBe(true);
+    }, 60000);
+  });
+
+  describe('Step callback worker context', () => {
+    it('should include worker debug info in prove step', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+      });
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      // Verify all worker-related fields are present
+      expect(proveContext).toBeDefined();
+      expect(proveContext).toHaveProperty('useWorker');
+      expect(proveContext).toHaveProperty('usedWorker');
+      expect(proveContext).toHaveProperty('isEnd');
+      expect(proveContext).toHaveProperty('duration');
+
+      // If worker failed, should have error message
+      if (proveContext.useWorker && !proveContext.usedWorker) {
+        expect(proveContext).toHaveProperty('workerFailedError');
+        expect(typeof proveContext.workerFailedError).toBe('string');
+      }
+    }, 60000);
+  });
+
+  describe('Worker fallback behavior', () => {
+    it('should fallback to main thread when worker fails', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true,
+      });
+
+      // Create a worker function that ALWAYS fails
+      const failingWorkerFn = async () => {
+        throw new Error('Worker failed intentionally');
+      };
+
+      // Inject the failing worker into the client
+      const client = createCofhesdkClientWithCustomWorker(config, failingWorkerFn);
+      await client.connect(publicClient, walletClient);
+
+      // Track step callbacks to verify fallback
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n)])
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      // Verify encryption succeeded via fallback to main thread
+      expect(result).toBeDefined();
+      expect(result.length).toBe(1);
+
+      // Verify worker was attempted but failed, triggering fallback
+      expect(proveContext).toBeDefined();
+      expect(proveContext.useWorker).toBe(true); // Worker was requested
+      expect(proveContext.usedWorker).toBe(false); // But it failed
+      expect(proveContext.workerFailedError).toBe('Worker failed intentionally');
+    }, 60000);
+
+    it('should fallback when encrypting multiple values', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true,
+      });
+
+      // Failing worker with different error message
+      const failingWorkerFn = async () => {
+        throw new Error('Worker unavailable');
+      };
+
+      const client = createCofhesdkClientWithCustomWorker(config, failingWorkerFn);
+      await client.connect(publicClient, walletClient);
+
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint128(100n), Encryptable.uint64(50n), Encryptable.bool(true)])
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      // All values should encrypt successfully via fallback
+      expect(result).toBeDefined();
+      expect(result.length).toBe(3);
+
+      // Verify fallback occurred
+      expect(proveContext.useWorker).toBe(true);
+      expect(proveContext.usedWorker).toBe(false);
+      expect(proveContext.workerFailedError).toBe('Worker unavailable');
+    }, 60000);
+
+    it('should handle async worker errors gracefully', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true,
+      });
+
+      // Worker that fails after a delay
+      const asyncFailingWorkerFn = async () => {
+        await new Promise((resolve) => setTimeout(resolve, 10));
+        throw new Error('Async worker failure');
+      };
+
+      const client = createCofhesdkClientWithCustomWorker(config, asyncFailingWorkerFn);
+      await client.connect(publicClient, walletClient);
+
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint8(42n)])
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      expect(proveContext.useWorker).toBe(true);
+      expect(proveContext.usedWorker).toBe(false);
+      expect(proveContext.workerFailedError).toBe('Async worker failure');
+    }, 60000);
+
+    it('should work without worker when explicitly disabled', async () => {
+      const config = createCofhesdkConfig({
+        supportedChains: [cofhesdkArbSepolia],
+        useWorkers: true, // Config says use workers
+      });
+
+      const client = createCofhesdkClient(config);
+      await client.connect(publicClient, walletClient);
+
+      let proveContext: any;
+      const result = await client
+        .encryptInputs([Encryptable.uint8(42n)])
+        .setUseWorker(false) // But override to disable worker
+        .setStepCallback((step, context) => {
+          if (step === 'prove' && context?.isEnd) {
+            proveContext = context;
+          }
+        })
+        .encrypt();
+
+      expect(result).toBeDefined();
+
+      // Should NOT attempt worker at all
+      expect(proveContext.useWorker).toBe(false);
+      expect(proveContext.usedWorker).toBe(false);
+      expect(proveContext.workerFailedError).toBeUndefined();
+    }, 60000);
+  });
+});