@cofhe/sdk 0.2.0 → 0.3.0

package/web/encryptInputs.web.test.ts

@@ -1,18 +1,18 @@
-import { arbSepolia as cofhesdkArbSepolia } from '@/chains';
-import { Encryptable, FheTypes, type CofhesdkClient, CofhesdkErrorCode, CofhesdkError } from '@/core';
+import { arbSepolia as cofheArbSepolia } from '@/chains';
+import { Encryptable, FheTypes, type CofheClient, CofheErrorCode, CofheError } from '@/core';
 
 import { describe, it, expect, beforeAll, beforeEach } 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 } from './index.js';
+import { createCofheClient, createCofheConfig } from './index.js';
 
 // Real test setup - runs in browser with real tfhe
 const TEST_PRIVATE_KEY = '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80';
 
 describe('@cofhe/web - Encrypt Inputs Browser Tests', () => {
-  let cofhesdkClient: CofhesdkClient;
+  let cofheClient: CofheClient;
   let publicClient: PublicClient;
   let walletClient: WalletClient;
 
@@ -32,39 +32,39 @@ describe('@cofhe/web - Encrypt Inputs Browser Tests', () => {
   });
 
   beforeEach(() => {
-    const config = createCofhesdkConfig({
-      supportedChains: [cofhesdkArbSepolia],
+    const config = createCofheConfig({
+      supportedChains: [cofheArbSepolia],
     });
-    cofhesdkClient = createCofhesdkClient(config);
+    cofheClient = createCofheClient(config);
   });
 
   describe('Browser TFHE Initialization', () => {
     it('should initialize tfhe on first encryption', async () => {
-      await cofhesdkClient.connect(publicClient, walletClient);
+      await cofheClient.connect(publicClient, walletClient);
 
       // This will trigger real TFHE initialization in browser
-      const result = await cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).encrypt();
+      const result = await cofheClient.encryptInputs([Encryptable.uint128(100n)]).execute();
 
       // If we get here, TFHE was initialized successfully
       expect(result).toBeDefined();
     }, 60000); // Longer timeout for real operations
 
     it('should handle multiple encryptions without re-initializing', async () => {
-      await cofhesdkClient.connect(publicClient, walletClient);
+      await cofheClient.connect(publicClient, walletClient);
 
       // First encryption
-      expect(cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).encrypt()).resolves.not.toThrow();
+      expect(cofheClient.encryptInputs([Encryptable.uint128(100n)]).execute()).resolves.not.toThrow();
 
       // Second encryption should reuse initialization
-      expect(cofhesdkClient.encryptInputs([Encryptable.uint64(50n)]).encrypt()).resolves.not.toThrow();
+      expect(cofheClient.encryptInputs([Encryptable.uint64(50n)]).execute()).resolves.not.toThrow();
     }, 60000);
   });
 
   describe('Browser Encryption', () => {
     it('should encrypt a bool with real TFHE in browser', async () => {
-      await cofhesdkClient.connect(publicClient, walletClient);
+      await cofheClient.connect(publicClient, walletClient);
 
-      const result = await cofhesdkClient.encryptInputs([Encryptable.bool(true)]).encrypt();
+      const result = await cofheClient.encryptInputs([Encryptable.bool(true)]).execute();
 
       expect(result).toBeDefined();
       expect(result.length).toBe(1);
@@ -77,7 +77,7 @@ describe('@cofhe/web - Encrypt Inputs Browser Tests', () => {
     }, 60000);
 
     it('should encrypt all supported types together', async () => {
-      await cofhesdkClient.connect(publicClient, walletClient);
+      await cofheClient.connect(publicClient, walletClient);
 
       const inputs = [
         Encryptable.bool(false),
@@ -89,7 +89,7 @@ describe('@cofhe/web - Encrypt Inputs Browser Tests', () => {
         Encryptable.address('0x742d35Cc6634C0532925a3b844D16faC4c175E99'),
       ];
 
-      const result = await cofhesdkClient.encryptInputs(inputs).encrypt();
+      const result = await cofheClient.encryptInputs(inputs).execute();
       expect(result).toBeDefined();
 
       expect(result.length).toBe(7);
@@ -106,15 +106,15 @@ describe('@cofhe/web - Encrypt Inputs Browser Tests', () => {
 
   describe('Browser Builder Pattern', () => {
     it('should support chaining builder methods with real encryption', async () => {
-      await cofhesdkClient.connect(publicClient, walletClient);
+      await cofheClient.connect(publicClient, walletClient);
 
-      const snapshot = cofhesdkClient.getSnapshot();
-      const encrypted = await cofhesdkClient
+      const snapshot = cofheClient.getSnapshot();
+      const encrypted = await cofheClient
         .encryptInputs([Encryptable.uint128(100n)])
         .setChainId(snapshot.chainId!)
         .setAccount(snapshot.account!)
         .setSecurityZone(0)
-        .encrypt();
+        .execute();
 
       expect(encrypted.length).toBe(1);
       expect(encrypted[0].utype).toBe(FheTypes.Uint128);
@@ -125,41 +125,41 @@ describe('@cofhe/web - Encrypt Inputs Browser Tests', () => {
     it('should fail gracefully when not connected', async () => {
       // Don't connect the client
       try {
-        const promise = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).encrypt();
+        const promise = cofheClient.encryptInputs([Encryptable.uint128(100n)]).execute();
       } catch (error) {
-        expect(error).toBeInstanceOf(CofhesdkError);
-        expect((error as CofhesdkError).code).toBe(CofhesdkErrorCode.NotConnected);
+        expect(error).toBeInstanceOf(CofheError);
+        expect((error as CofheError).code).toBe(CofheErrorCode.NotConnected);
       }
     }, 30000);
 
     it('should handle invalid CoFHE URL', async () => {
-      const badConfig = createCofhesdkConfig({
+      const badConfig = createCofheConfig({
         supportedChains: [
           {
-            ...cofhesdkArbSepolia,
+            ...cofheArbSepolia,
             coFheUrl: 'http://invalid-cofhe-url.local',
             verifierUrl: 'http://invalid-verifier-url.local',
           },
         ],
       });
 
-      const badClient = createCofhesdkClient(badConfig);
+      const badClient = createCofheClient(badConfig);
       await badClient.connect(publicClient, walletClient);
 
-      const promise = badClient.encryptInputs([Encryptable.uint128(100n)]).encrypt();
+      const promise = badClient.encryptInputs([Encryptable.uint128(100n)]).execute();
       expect(promise).rejects.toThrow();
     }, 60000);
   });
 
   describe('Browser Performance', () => {
     it('should handle consecutive encryptions efficiently', async () => {
-      await cofhesdkClient.connect(publicClient, walletClient);
+      await cofheClient.connect(publicClient, walletClient);
 
       const start = Date.now();
 
       // Perform 5 encryptions
       for (let i = 0; i < 5; i++) {
-        await cofhesdkClient.encryptInputs([Encryptable.uint128(BigInt(i))]).encrypt();
+        await cofheClient.encryptInputs([Encryptable.uint128(BigInt(i))]).execute();
       }
 
       const duration = Date.now() - start;

package/web/index.ts

@@ -1,11 +1,11 @@
 // Web specific functionality only
 
 import {
-  createCofhesdkClientBase,
-  createCofhesdkConfigBase,
-  type CofhesdkClient,
-  type CofhesdkConfig,
-  type CofhesdkInputConfig,
+  createCofheClientBase,
+  createCofheConfigBase,
+  type CofheClient,
+  type CofheConfig,
+  type CofheInputConfig,
   type ZkBuilderAndCrsGenerator,
   type FheKeyDeserializer,
   type EncryptableItem,
@@ -95,12 +95,12 @@ async function zkProveWithWorker(
 }
 
 /**
- * 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)
- * @returns The CoFHE SDK configuration with web defaults applied
+ * Creates a CoFHE configuration for web with IndexedDB storage as default
+ * @param config - The CoFHE input configuration (fheKeyStorage will default to IndexedDB if not provided)
+ * @returns The CoFHE configuration with web defaults applied
  */
-export function createCofhesdkConfig(config: CofhesdkInputConfig): CofhesdkConfig {
-  return createCofhesdkConfigBase({
+export function createCofheConfig(config: CofheInputConfig): CofheConfig {
+  return createCofheConfigBase({
     environment: 'web',
     ...config,
     fheKeyStorage: config.fheKeyStorage === null ? null : config.fheKeyStorage ?? createWebStorage(),
@@ -108,14 +108,14 @@ export function createCofhesdkConfig(config: CofhesdkInputConfig): CofhesdkConfi
 }
 
 /**
- * Creates a CoFHE SDK client instance for web with TFHE automatically configured
+ * Creates a CoFHE 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
+ * @param config - The CoFHE configuration (use createCofheConfig to create with web defaults)
+ * @returns The CoFHE client instance
  */
-export function createCofhesdkClient<TConfig extends CofhesdkConfig>(config: TConfig): CofhesdkClient<TConfig> {
-  return createCofhesdkClientBase({
+export function createCofheClient<TConfig extends CofheConfig>(config: TConfig): CofheClient<TConfig> {
+  return createCofheClientBase({
     config,
     zkBuilderAndCrsGenerator,
     tfhePublicKeyDeserializer,
@@ -141,16 +141,16 @@ 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,
+export function createCofheClientWithCustomWorker(
+  config: CofheConfig,
   customZkProveWorkerFn: (
     fheKeyHex: string,
     crsHex: string,
     items: EncryptableItem[],
     metadata: Uint8Array
   ) => Promise<Uint8Array>
-): CofhesdkClient {
-  return createCofhesdkClientBase({
+): CofheClient {
+  return createCofheClientBase({
     config,
     zkBuilderAndCrsGenerator,
     tfhePublicKeyDeserializer,

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

@@ -1,7 +1,7 @@
 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 { createCofheClient, createCofheConfig } from './index.js';
+import { Encryptable, type CofheClient } from '@/core';
+import { arbSepolia as cofheArbSepolia } from '@/chains';
 import { arbitrumSepolia as viemArbitrumSepolia } from 'viem/chains';
 import { createPublicClient, createWalletClient, http, type PublicClient, type WalletClient } from 'viem';
 import { privateKeyToAccount } from 'viem/accounts';
@@ -9,7 +9,7 @@ import { privateKeyToAccount } from 'viem/accounts';
 const TEST_PRIVATE_KEY = '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80';
 
 describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
-  let cofhesdkClient: CofhesdkClient;
+  let cofheClient: CofheClient;
   let publicClient: PublicClient;
   let walletClient: WalletClient;
 
@@ -28,23 +28,23 @@ describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
   });
 
   beforeEach(async () => {
-    const config = createCofhesdkConfig({
-      supportedChains: [cofhesdkArbSepolia],
+    const config = createCofheConfig({
+      supportedChains: [cofheArbSepolia],
     });
-    cofhesdkClient = createCofhesdkClient(config);
-    await cofhesdkClient.connect(publicClient, walletClient);
+    cofheClient = createCofheClient(config);
+    await cofheClient.connect(publicClient, walletClient);
   });
 
   describe('setUseWorker method', () => {
     it('should have setUseWorker method on EncryptInputsBuilder', () => {
-      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]);
+      const builder = cofheClient.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 builder = cofheClient.encryptInputs([Encryptable.uint128(100n)]);
       const returnedBuilder = builder.setUseWorker(false);
 
       // Should return the same builder instance (or at least same type)
@@ -53,37 +53,37 @@ describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
 
     it('should allow chaining with other builder methods', () => {
       // Should be able to chain setUseWorker with setStepCallback
-      const builder = cofhesdkClient
+      const builder = cofheClient
         .encryptInputs([Encryptable.uint128(100n)])
         .setUseWorker(false)
-        .setStepCallback(() => {});
+        .onStep(() => {});
 
       expect(builder).toBeDefined();
-      expect(builder).toHaveProperty('encrypt');
+      expect(builder).toHaveProperty('execute');
     });
 
     it('should accept true parameter', () => {
       expect(() => {
-        cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
+        cofheClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
       }).not.toThrow();
     });
 
     it('should accept false parameter', () => {
       expect(() => {
-        cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(false);
+        cofheClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(false);
       }).not.toThrow();
     });
 
     it('should have getUseWorker method', () => {
-      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]);
+      const builder = cofheClient.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);
+      const builderWithWorkers = cofheClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
+      const builderWithoutWorkers = cofheClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(false);
 
       // Should reflect config values
       expect(builderWithWorkers.getUseWorker()).toBe(true);
@@ -91,7 +91,7 @@ describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
     });
 
     it('should reflect changes from setUseWorker', () => {
-      const builder = cofhesdkClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
+      const builder = cofheClient.encryptInputs([Encryptable.uint128(100n)]).setUseWorker(true);
       expect(builder.getUseWorker()).toBe(true);
 
       builder.setUseWorker(false);
@@ -104,23 +104,23 @@ describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
 
   describe('Worker function availability', () => {
     it('should initialize client without errors', () => {
-      const config = createCofhesdkConfig({
-        supportedChains: [cofhesdkArbSepolia],
+      const config = createCofheConfig({
+        supportedChains: [cofheArbSepolia],
         useWorkers: true,
       });
 
       expect(() => {
-        createCofhesdkClient(config);
+        createCofheClient(config);
       }).not.toThrow();
     });
 
     it('should handle worker function when workers enabled', async () => {
-      const config = createCofhesdkConfig({
-        supportedChains: [cofhesdkArbSepolia],
+      const config = createCofheConfig({
+        supportedChains: [cofheArbSepolia],
         useWorkers: true,
       });
 
-      const client = createCofhesdkClient(config);
+      const client = createCofheClient(config);
       await client.connect(publicClient, walletClient);
       const builder = client.encryptInputs([Encryptable.uint128(100n)]);
 
@@ -131,12 +131,12 @@ describe('@cofhe/sdk/web - EncryptInputsBuilder Worker Methods', () => {
     });
 
     it('should handle when workers disabled', async () => {
-      const config = createCofhesdkConfig({
-        supportedChains: [cofhesdkArbSepolia],
+      const config = createCofheConfig({
+        supportedChains: [cofheArbSepolia],
         useWorkers: false,
       });
 
-      const client = createCofhesdkClient(config);
+      const client = createCofheClient(config);
       await client.connect(publicClient, walletClient);
       const builder = client.encryptInputs([Encryptable.uint128(100n)]);