@cofhe/sdk 0.2.0 → 0.3.0

package/core/error.ts

@@ -1,4 +1,4 @@
-export enum CofhesdkErrorCode {
+export enum CofheErrorCode {
   InternalError = 'INTERNAL_ERROR',
   UnknownEnvironment = 'UNKNOWN_ENVIRONMENT',
   InitTfheFailed = 'INIT_TFHE_FAILED',
@@ -44,8 +44,8 @@ export enum CofhesdkErrorCode {
   RehydrateKeysStoreFailed = 'REHYDRATE_KEYS_STORE_FAILED',
 }
 
-export type CofhesdkErrorParams = {
-  code: CofhesdkErrorCode;
+export type CofheErrorParams = {
+  code: CofheErrorCode;
   message: string;
   cause?: Error;
   hint?: string;
@@ -53,28 +53,28 @@ export type CofhesdkErrorParams = {
 };
 
 /**
- * CofhesdkError class
+ * CofheError class
  * This class is used to create errors that are specific to the CoFHE SDK
  * It extends the Error class and adds a code, cause, hint, and context
  * The code is used to identify the type of error
- * The cause is used to indicate the inner error that caused the CofhesdkError
+ * The cause is used to indicate the inner error that caused the CofheError
  * The hint is used to provide a hint about how to fix the error
  * The context is used to provide additional context about the state that caused the error
  * The serialize method is used to serialize the error to a JSON string
  * The toString method is used to provide a human-readable string representation of the error
  */
-export class CofhesdkError extends Error {
-  public readonly code: CofhesdkErrorCode;
+export class CofheError extends Error {
+  public readonly code: CofheErrorCode;
   public readonly cause?: Error;
   public readonly hint?: string;
   public readonly context?: Record<string, unknown>;
 
-  constructor({ code, message, cause, hint, context }: CofhesdkErrorParams) {
+  constructor({ code, message, cause, hint, context }: CofheErrorParams) {
     // If there's a cause, append its message to provide full context
     const fullMessage = cause ? `${message} | Caused by: ${cause.message}` : message;
 
     super(fullMessage);
-    this.name = 'CofhesdkError';
+    this.name = 'CofheError';
     this.code = code;
     this.cause = cause;
     this.hint = hint;
@@ -82,22 +82,22 @@ export class CofhesdkError extends Error {
 
     // Maintains proper stack trace for where our error was thrown (only available on V8)
     if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, CofhesdkError);
+      Error.captureStackTrace(this, CofheError);
     }
   }
 
   /**
-   * Creates a CofhesdkError from an unknown error
-   * If the error is a CofhesdkError, it is returned unchanged, else a new CofhesdkError is created
-   * If a wrapperError is provided, it is used to create the new CofhesdkError, else a default is used
+   * Creates a CofheError from an unknown error
+   * If the error is a CofheError, it is returned unchanged, else a new CofheError is created
+   * If a wrapperError is provided, it is used to create the new CofheError, else a default is used
    */
-  static fromError(error: unknown, wrapperError?: CofhesdkErrorParams): CofhesdkError {
-    if (isCofhesdkError(error)) return error;
+  static fromError(error: unknown, wrapperError?: CofheErrorParams): CofheError {
+    if (isCofheError(error)) return error;
 
     const cause = error instanceof Error ? error : new Error(`${error}`);
 
-    return new CofhesdkError({
-      code: wrapperError?.code ?? CofhesdkErrorCode.InternalError,
+    return new CofheError({
+      code: wrapperError?.code ?? CofheErrorCode.InternalError,
       message: wrapperError?.message ?? 'An internal error occurred',
       hint: wrapperError?.hint,
       context: wrapperError?.context,
@@ -165,4 +165,4 @@ const bigintSafeJsonStringify = (value: unknown): string => {
   });
 };
 
-export const isCofhesdkError = (error: unknown): error is CofhesdkError => error instanceof CofhesdkError;
+export const isCofheError = (error: unknown): error is CofheError => error instanceof CofheError;

package/core/fetchKeys.test.ts

@@ -5,11 +5,11 @@ import { sepolia, arbSepolia } from '@/chains';
 
 import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
 import { fetchKeys } from './fetchKeys.js';
-import { type CofhesdkConfig, createCofhesdkConfigBase } from './config.js';
+import { type CofheConfig, createCofheConfigBase } from './config.js';
 import { createKeysStore, type KeysStorage } from './keyStore.js';
 
 describe('fetchKeys', () => {
-  let config: CofhesdkConfig;
+  let config: CofheConfig;
   let mockTfhePublicKeyDeserializer: any;
   let mockCompactPkeCrsDeserializer: any;
   let keysStorage: KeysStorage;
@@ -19,7 +19,7 @@ describe('fetchKeys', () => {
     vi.clearAllMocks();
 
     // Setup config with real chains
-    config = createCofhesdkConfigBase({
+    config = createCofheConfigBase({
       supportedChains: [sepolia, arbSepolia],
     });
 

package/core/fetchKeys.ts

@@ -1,6 +1,6 @@
 import { hardhat } from '@/chains';
 
-import { type CofhesdkConfig, getCoFheUrlOrThrow } from './config.js';
+import { type CofheConfig, getCoFheUrlOrThrow } from './config.js';
 import { type KeysStorage } from './keyStore.js';
 
 const PUBLIC_KEY_LENGTH_MIN = 15_000;
@@ -118,7 +118,7 @@ const fetchCrs = async (
 /**
  * Retrieves the FHE public key and the CRS from the provider.
  * If the key/crs already exists in the store it is returned, else it is fetched, stored, and returned
- * @param {CofhesdkConfig} config - The configuration object for the CoFHE SDK
+ * @param {CofheConfig} config - The configuration object for the CoFHE client
  * @param {number} chainId - The chain to fetch the FHE key for, if no chainId provided, undefined is returned
  * @param securityZone - The security zone for which to retrieve the key (default 0).
  * @param tfhePublicKeyDeserializer - The serializer for the FHE public key (used for validation).
@@ -127,7 +127,7 @@ const fetchCrs = async (
  * @returns {Promise<[[string, boolean], [string, boolean]]>} - A promise that resolves to [[fheKey, fheKeyFetchedFromCoFHE], [crs, crsFetchedFromCoFHE]]
  */
 export const fetchKeys = async (
-  config: CofhesdkConfig,
+  config: CofheConfig,
   chainId: number,
   securityZone: number = 0,
   tfhePublicKeyDeserializer: FheKeyDeserializer,

package/core/index.ts

@@ -1,17 +1,17 @@
 // Client (base implementations)
-export { createCofhesdkClientBase, InitialConnectStore as CONNECT_STORE_DEFAULTS } from './client.js';
+export { createCofheClientBase, InitialConnectStore as CONNECT_STORE_DEFAULTS } from './client.js';
 
 // Configuration (base implementations)
-export { createCofhesdkConfigBase, getCofhesdkConfigItem } from './config.js';
-export type { CofhesdkConfig, CofhesdkInputConfig, CofhesdkInternalConfig } from './config.js';
+export { createCofheConfigBase, getCofheConfigItem } from './config.js';
+export type { CofheConfig, CofheInputConfig, CofheInternalConfig } from './config.js';
 
 // Types
 export type {
   // Client types
-  CofhesdkClient,
-  CofhesdkClientParams,
-  CofhesdkClientConnectionState,
-  CofhesdkClientPermits,
+  CofheClient as CofheClient,
+  CofheClientParams as CofheClientParams,
+  CofheClientConnectionState as CofheClientConnectionState,
+  CofheClientPermits as CofheClientPermits,
 } from './clientTypes.js';
 
 export type {
@@ -59,8 +59,8 @@ export {
 } from './types.js';
 
 // Error handling
-export { CofhesdkError, CofhesdkErrorCode, isCofhesdkError } from './error.js';
-export type { CofhesdkErrorParams } from './error.js';
+export { CofheError, CofheErrorCode, isCofheError } from './error.js';
+export type { CofheErrorParams } from './error.js';
 
 // Key fetching
 export { fetchKeys } from './fetchKeys.js';
@@ -72,7 +72,9 @@ export type { KeysStorage, KeysStore } from './keyStore.js';
 
 // Builders (exported via client, but can be imported directly for typing)
 export { EncryptInputsBuilder } from './encrypt/encryptInputsBuilder.js';
-export { DecryptHandlesBuilder } from './decrypt/decryptHandleBuilder.js';
+export { DecryptForViewBuilder } from './decrypt/decryptForViewBuilder.js';
+export { DecryptForTxBuilder } from './decrypt/decryptForTxBuilder.js';
+export type { DecryptForTxResult } from './decrypt/decryptForTxBuilder.js';
 
 // ZK utilities
 export type {
@@ -83,7 +85,16 @@ export type {
 } from './encrypt/zkPackProveVerify.js';
 export { zkProveWithWorker } from './encrypt/zkPackProveVerify.js';
 
-export { MOCKS_ZK_VERIFIER_SIGNER_ADDRESS } from './encrypt/cofheMocksZkVerifySign.js';
+// Contract addresses
+export {
+  TASK_MANAGER_ADDRESS,
+  MOCKS_ZK_VERIFIER_ADDRESS,
+  MOCKS_ZK_VERIFIER_SIGNER_ADDRESS,
+  MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY,
+  MOCKS_DECRYPT_RESULT_SIGNER_PRIVATE_KEY,
+  MOCKS_THRESHOLD_NETWORK_ADDRESS,
+  TEST_BED_ADDRESS,
+} from './consts.js';
 
 // Utils
 export { fheTypeToString } from './utils.js';

package/core/permits.test.ts

@@ -151,7 +151,7 @@ describe('Core Permits Tests', () => {
         publicClient,
         bobWalletClient
       );
-      permitHash = permits.getHash(createdPermit);
+      permitHash = createdPermit.hash;
     });
 
     it('should get permit by hash', async () => {
@@ -195,9 +195,8 @@ describe('Core Permits Tests', () => {
       const permitKeys = Object.keys(parsedData.state.permits[chainId][bobAddress]);
       expect(permitKeys.length).toBeGreaterThan(0);
 
-      const permitHash = permits.getHash(createdPermit);
       const serializedPermit = permits.serialize(createdPermit);
-      expect(parsedData.state.permits[chainId][bobAddress][permitHash]).toEqual(serializedPermit);
+      expect(parsedData.state.permits[chainId][bobAddress][createdPermit.hash]).toEqual(serializedPermit);
     });
   });
 
@@ -272,7 +271,7 @@ describe('Core Permits Tests', () => {
       });
 
       expect(permit.name).toBe('First Self Permit');
-      expect(permits.getHash(permit)).toBe(permits.getHash(firstPermit));
+      expect(permit.hash).toBe(firstPermit.hash);
 
       // Verify no new permit was created
       const allPermits = await permits.getPermits(chainId, bobAddress);
@@ -381,7 +380,7 @@ describe('Core Permits Tests', () => {
       );
 
       expect(permit.name).toBe('First Sharing Permit');
-      expect(permits.getHash(permit)).toBe(permits.getHash(firstPermit));
+      expect(permit.hash).toBe(firstPermit.hash);
 
       // Verify no new permit was created
       const allPermits = await permits.getPermits(chainId, bobAddress);
@@ -483,7 +482,7 @@ describe('Core Permits Tests', () => {
       });
 
       // Should be the same permit
-      expect(permits.getHash(permit1)).toBe(permits.getHash(permit2));
+      expect(permit1.hash).toBe(permit2.hash);
       expect(permit2.name).toBe('Permit 1'); // Original name
 
       // Only one permit should exist

package/core/permits.ts

@@ -9,6 +9,7 @@ import {
   type SelfPermit,
   type RecipientPermit,
   type SharingPermit,
+  type PermitHashFields,
 } from '@/permits';
 
 import { type PublicClient, type WalletClient } from 'viem';
@@ -21,7 +22,7 @@ const storeActivePermit = async (permit: Permit, publicClient: any, walletClient
   const account = walletClient.account!.address;
 
   permitStore.setPermit(chainId, account, permit);
-  permitStore.setActivePermitHash(chainId, account, PermitUtils.getHash(permit));
+  permitStore.setActivePermitHash(chainId, account, permit.hash);
 };
 
 // Generic function to handle permit creation with error handling
@@ -70,7 +71,7 @@ const importShared = async (
 
 // PERMIT UTILS
 
-const getHash = (permit: Permit) => {
+const getHash = (permit: PermitHashFields) => {
   return PermitUtils.getHash(permit);
 };
 
@@ -167,8 +168,8 @@ const getOrCreateSharingPermit = async (
 
 // REMOVE
 
-const removePermit = async (chainId: number, account: string, hash: string, force?: boolean): Promise<void> =>
-  permitStore.removePermit(chainId, account, hash, force);
+const removePermit = async (chainId: number, account: string, hash: string): Promise<void> =>
+  permitStore.removePermit(chainId, account, hash);
 
 const removeActivePermit = async (chainId: number, account: string): Promise<void> =>
   permitStore.removeActivePermitHash(chainId, account);

package/core/utils.ts

@@ -1,6 +1,6 @@
 import { type PublicClient, type WalletClient } from 'viem';
-import { CofhesdkError, CofhesdkErrorCode } from './error.js';
-import { Encryptable, FheTypes } from './types.js';
+import { CofheError, CofheErrorCode } from './error.js';
+import { FheTypes } from './types.js';
 
 export const toHexString = (bytes: Uint8Array) =>
   bytes.reduce((str, byte) => str + byte.toString(16).padStart(2, '0'), '');
@@ -50,15 +50,15 @@ export async function getPublicClientChainID(publicClient: PublicClient) {
   try {
     chainId = publicClient.chain?.id ?? (await publicClient.getChainId());
   } catch (e) {
-    throw new CofhesdkError({
-      code: CofhesdkErrorCode.PublicWalletGetChainIdFailed,
+    throw new CofheError({
+      code: CofheErrorCode.PublicWalletGetChainIdFailed,
       message: 'getting chain ID from public client failed',
       cause: e instanceof Error ? e : undefined,
     });
   }
   if (chainId === null) {
-    throw new CofhesdkError({
-      code: CofhesdkErrorCode.PublicWalletGetChainIdFailed,
+    throw new CofheError({
+      code: CofheErrorCode.PublicWalletGetChainIdFailed,
       message: 'chain ID from public client is null',
     });
   }
@@ -73,15 +73,15 @@ export async function getWalletClientAccount(walletClient: WalletClient) {
       address = (await walletClient.getAddresses())?.[0];
     }
   } catch (e) {
-    throw new CofhesdkError({
-      code: CofhesdkErrorCode.PublicWalletGetAddressesFailed,
+    throw new CofheError({
+      code: CofheErrorCode.PublicWalletGetAddressesFailed,
       message: 'getting address from wallet client failed',
       cause: e instanceof Error ? e : undefined,
     });
   }
   if (!address) {
-    throw new CofhesdkError({
-      code: CofhesdkErrorCode.PublicWalletGetAddressesFailed,
+    throw new CofheError({
+      code: CofheErrorCode.PublicWalletGetAddressesFailed,
       message: 'address from wallet client is null',
     });
   }

package/dist/chains.cjs

@@ -12,21 +12,18 @@ var CofheChainSchema = zod.z.object({
   /** Network identifier */
   network: zod.z.string().min(1),
   /** coFhe service URL */
-  coFheUrl: zod.z.string().url(),
+  coFheUrl: zod.z.url(),
   /** Verifier service URL */
-  verifierUrl: zod.z.string().url(),
+  verifierUrl: zod.z.url(),
   /** Threshold network service URL */
-  thresholdNetworkUrl: zod.z.string().url(),
+  thresholdNetworkUrl: zod.z.url(),
   /** Environment type */
   environment: EnvironmentSchema
 });
-
-// chains/defineChain.ts
 function defineChain(chainConfig) {
   const result = CofheChainSchema.safeParse(chainConfig);
   if (!result.success) {
-    const errorMessages = result.error.errors.map((err) => `${err.path.join(".")}: ${err.message}`);
-    throw new Error(`Invalid chain configuration: ${errorMessages.join(", ")}`);
+    throw new Error(`Invalid chain configuration: ${zod.z.prettifyError(result.error)}`, { cause: result.error });
   }
   return result.data;
 }

package/dist/chains.d.cts

@@ -1,13 +1,13 @@
-import { C as CofheChain } from './types-KImPrEIe.cjs';
-export { E as Environment } from './types-KImPrEIe.cjs';
+import { C as CofheChain } from './types-YiAC4gig.cjs';
+export { E as Environment } from './types-YiAC4gig.cjs';
 import 'zod';
 
 /**
  * Sepolia testnet chain configuration
  */
 declare const sepolia: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -19,8 +19,8 @@ declare const sepolia: {
  * Arbitrum Sepolia testnet chain configuration
  */
 declare const arbSepolia: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -32,8 +32,8 @@ declare const arbSepolia: {
  * Base Sepolia testnet chain configuration
  */
 declare const baseSepolia: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -45,8 +45,8 @@ declare const baseSepolia: {
  * Hardhat local development chain configuration
  */
 declare const hardhat: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -58,8 +58,8 @@ declare const hardhat: {
  * Localcofhe chain configuration
  */
 declare const localcofhe: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -69,8 +69,8 @@ declare const localcofhe: {
 
 declare const chains: {
     readonly sepolia: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -78,8 +78,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly arbSepolia: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -87,8 +87,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly baseSepolia: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -96,8 +96,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly hardhat: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -105,8 +105,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly localcofhe: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;

package/dist/chains.d.ts

@@ -1,13 +1,13 @@
-import { C as CofheChain } from './types-KImPrEIe.js';
-export { E as Environment } from './types-KImPrEIe.js';
+import { C as CofheChain } from './types-YiAC4gig.js';
+export { E as Environment } from './types-YiAC4gig.js';
 import 'zod';
 
 /**
  * Sepolia testnet chain configuration
  */
 declare const sepolia: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -19,8 +19,8 @@ declare const sepolia: {
  * Arbitrum Sepolia testnet chain configuration
  */
 declare const arbSepolia: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -32,8 +32,8 @@ declare const arbSepolia: {
  * Base Sepolia testnet chain configuration
  */
 declare const baseSepolia: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -45,8 +45,8 @@ declare const baseSepolia: {
  * Hardhat local development chain configuration
  */
 declare const hardhat: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -58,8 +58,8 @@ declare const hardhat: {
  * Localcofhe chain configuration
  */
 declare const localcofhe: {
-    name: string;
     id: number;
+    name: string;
     network: string;
     coFheUrl: string;
     verifierUrl: string;
@@ -69,8 +69,8 @@ declare const localcofhe: {
 
 declare const chains: {
     readonly sepolia: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -78,8 +78,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly arbSepolia: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -87,8 +87,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly baseSepolia: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -96,8 +96,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly hardhat: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;
@@ -105,8 +105,8 @@ declare const chains: {
         environment: "MOCK" | "TESTNET" | "MAINNET";
     };
     readonly localcofhe: {
-        name: string;
         id: number;
+        name: string;
         network: string;
         coFheUrl: string;
         verifierUrl: string;

package/dist/chains.js

@@ -1 +1 @@
-export { arbSepolia, baseSepolia, chains, getChainById, getChainByName, hardhat, localcofhe, sepolia } from './chunk-WEAZ25JO.js';
+export { arbSepolia, baseSepolia, chains, getChainById, getChainByName, hardhat, localcofhe, sepolia } from './chunk-TBLR7NNE.js';