@cofhe/sdk 0.2.0 → 0.3.0

package/dist/node.d.cts

@@ -1,22 +1,22 @@
-import { C as CofhesdkInputConfig, a as CofhesdkConfig, b as CofhesdkClient } from './clientTypes-5_1nwtUe.cjs';
+import { C as CofheInputConfig, a as CofheConfig, b as CofheClient } from './clientTypes-Bhq7pCSA.cjs';
 import 'viem';
-import './types-KImPrEIe.cjs';
+import './types-YiAC4gig.cjs';
 import 'zod';
-import './permit-fUSe6KKq.cjs';
+import './permit-MZ502UBl.cjs';
 import 'zustand/vanilla';
 
 /**
- * Creates a CoFHE SDK configuration for Node.js with filesystem storage as default
- * @param config - The CoFHE SDK input configuration (fheKeyStorage will default to filesystem if not provided)
- * @returns The CoFHE SDK configuration with Node.js defaults applied
+ * Creates a CoFHE configuration for Node.js with filesystem storage as default
+ * @param config - The CoFHE input configuration (fheKeyStorage will default to filesystem if not provided)
+ * @returns The CoFHE configuration with Node.js defaults applied
  */
-declare function createCofhesdkConfig(config: CofhesdkInputConfig): CofhesdkConfig;
+declare function createCofheConfig(config: CofheInputConfig): CofheConfig;
 /**
- * Creates a CoFHE SDK client instance for Node.js with node-tfhe automatically configured
+ * Creates a CoFHE client instance for Node.js with node-tfhe automatically configured
  * TFHE will be initialized automatically on first encryption - no manual setup required
- * @param config - The CoFHE SDK configuration (use createCofhesdkConfig to create with Node.js defaults)
- * @returns The CoFHE SDK client instance
+ * @param config - The CoFHE configuration (use createCofheConfig to create with Node.js defaults)
+ * @returns The CoFHE client instance
  */
-declare function createCofhesdkClient(config: CofhesdkConfig): CofhesdkClient;
+declare function createCofheClient(config: CofheConfig): CofheClient;
 
-export { createCofhesdkClient, createCofhesdkConfig };
+export { createCofheClient, createCofheConfig };

package/dist/node.d.ts

@@ -1,22 +1,22 @@
-import { C as CofhesdkInputConfig, a as CofhesdkConfig, b as CofhesdkClient } from './clientTypes-Es7fyi65.js';
+import { C as CofheInputConfig, a as CofheConfig, b as CofheClient } from './clientTypes-6aTZPQ_4.js';
 import 'viem';
-import './types-KImPrEIe.js';
+import './types-YiAC4gig.js';
 import 'zod';
-import './permit-fUSe6KKq.js';
+import './permit-MZ502UBl.js';
 import 'zustand/vanilla';
 
 /**
- * Creates a CoFHE SDK configuration for Node.js with filesystem storage as default
- * @param config - The CoFHE SDK input configuration (fheKeyStorage will default to filesystem if not provided)
- * @returns The CoFHE SDK configuration with Node.js defaults applied
+ * Creates a CoFHE configuration for Node.js with filesystem storage as default
+ * @param config - The CoFHE input configuration (fheKeyStorage will default to filesystem if not provided)
+ * @returns The CoFHE configuration with Node.js defaults applied
  */
-declare function createCofhesdkConfig(config: CofhesdkInputConfig): CofhesdkConfig;
+declare function createCofheConfig(config: CofheInputConfig): CofheConfig;
 /**
- * Creates a CoFHE SDK client instance for Node.js with node-tfhe automatically configured
+ * Creates a CoFHE client instance for Node.js with node-tfhe automatically configured
  * TFHE will be initialized automatically on first encryption - no manual setup required
- * @param config - The CoFHE SDK configuration (use createCofhesdkConfig to create with Node.js defaults)
- * @returns The CoFHE SDK client instance
+ * @param config - The CoFHE configuration (use createCofheConfig to create with Node.js defaults)
+ * @returns The CoFHE client instance
  */
-declare function createCofhesdkClient(config: CofhesdkConfig): CofhesdkClient;
+declare function createCofheClient(config: CofheConfig): CofheClient;
 
-export { createCofhesdkClient, createCofhesdkConfig };
+export { createCofheClient, createCofheConfig };

package/dist/node.js

@@ -1,6 +1,6 @@
-import { createCofhesdkConfigBase, createCofhesdkClientBase } from './chunk-WGCRJCBR.js';
-import './chunk-WEAZ25JO.js';
-import './chunk-UGBVZNRT.js';
+import { createCofheConfigBase, createCofheClientBase } from './chunk-2TPSCOW3.js';
+import './chunk-TBLR7NNE.js';
+import './chunk-NWDKXBIP.js';
 import { promises } from 'fs';
 import { join } from 'path';
 import { init_panic_hook, TfheCompactPublicKey, CompactPkeCrs, ProvenCompactCiphertextList } from 'node-tfhe';
@@ -71,15 +71,15 @@ var zkBuilderAndCrsGenerator = (fhe, crs) => {
   const zkCrs = CompactPkeCrs.deserialize(fromHexString(crs));
   return { zkBuilder, zkCrs };
 };
-function createCofhesdkConfig(config) {
-  return createCofhesdkConfigBase({
+function createCofheConfig(config) {
+  return createCofheConfigBase({
     environment: "node",
     ...config,
     fheKeyStorage: config.fheKeyStorage === null ? null : config.fheKeyStorage ?? createNodeStorage()
   });
 }
-function createCofhesdkClient(config) {
-  return createCofhesdkClientBase({
+function createCofheClient(config) {
+  return createCofheClientBase({
     config,
     zkBuilderAndCrsGenerator,
     tfhePublicKeyDeserializer,
@@ -88,4 +88,4 @@ function createCofhesdkClient(config) {
   });
 }
 
-export { createCofhesdkClient, createCofhesdkConfig };
+export { createCofheClient, createCofheConfig };

package/dist/{permit-fUSe6KKq.d.cts → permit-MZ502UBl.d.cts}

@@ -1,5 +1,4 @@
-import * as zod from 'zod';
-import { PublicClient, WalletClient } from 'viem';
+import { Hex, PublicClient, WalletClient } from 'viem';
 
 type EthEncryptedData = {
     data: Uint8Array;
@@ -71,7 +70,7 @@ type EIP712Message = Record<string, string>;
 type EIP712Domain = {
     chainId: number;
     name: string;
-    verifyingContract: `0x${string}`;
+    verifyingContract: Hex;
     version: string;
 };
 /**
@@ -83,6 +82,10 @@ type SealingKey = SealingKey$1;
  * Core Permit interface - immutable design for React compatibility
  */
 interface Permit {
+    /**
+     * Stable hash of relevant permit data, used as key in storage
+     */
+    hash: string;
     /**
      * Name for this permit, for organization and UI usage, not included in signature.
      */
@@ -97,7 +100,7 @@ interface Permit {
     /**
      * (base) User that initially created the permission, target of data fetching
      */
-    issuer: `0x${string}`;
+    issuer: Hex;
     /**
      * (base) Expiration timestamp
      */
@@ -106,7 +109,7 @@ interface Permit {
      * (sharing) The user that this permission will be shared with
      * ** optional, use `address(0)` to disable **
      */
-    recipient: `0x${string}`;
+    recipient: Hex;
     /**
      * (issuer defined validation) An id used to query a contract to check this permissions validity
      * ** optional, use `0` to disable **
@@ -116,7 +119,7 @@ interface Permit {
      * (issuer defined validation) The contract to query to determine permission validity
      * ** optional, user `address(0)` to disable **
      */
-    validatorContract: `0x${string}`;
+    validatorContract: Hex;
     /**
      * (base) The publicKey of a sealingPair used to re-encrypt `issuer`s confidential data
      *   (non-sharing) Populated by `issuer`
@@ -129,13 +132,13 @@ interface Permit {
      *   (non-sharing) < issuer, expiration, recipient, validatorId, validatorContract, sealingKey >
      *   (sharing)     < issuer, expiration, recipient, validatorId, validatorContract >
      */
-    issuerSignature: `0x${string}`;
+    issuerSignature: Hex;
     /**
      * (sharing) `signTypedData` signature created by `recipient` with format:
      * (sharing) < sealingKey, issuerSignature>
      * ** required for shared permits **
      */
-    recipientSignature: `0x${string}`;
+    recipientSignature: Hex;
     /**
      * EIP712 domain used to sign this permit.
      * Should not be set manually, included in metadata as part of serialization flows.
@@ -196,7 +199,7 @@ type ImportSharedPermitOptions = {
     recipient: string;
     issuerSignature: string;
     name?: string;
-    expiration?: number;
+    expiration: number;
     validatorId?: number;
     validatorContract?: string;
 };
@@ -210,9 +213,13 @@ type SerializedPermit = Omit<Permit, 'sealingPair'> & {
 /**
  * A type representing the Permission struct that is passed to Permissioned.sol to grant encrypted data access.
  */
-type Permission = Expand<Omit<Permit, 'name' | 'type' | 'sealingPair'> & {
-    sealingKey: `0x${string}`;
+type Permission = Expand<Omit<Permit, 'name' | 'type' | 'sealingPair' | 'hash'> & {
+    sealingKey: Hex;
 }>;
+/**
+ * A type representing the permit fields that are used to generate the hash
+ */
+type PermitHashFields = Pick<Permit, 'type' | 'issuer' | 'expiration' | 'recipient' | 'validatorId' | 'validatorContract'>;
 /**
  * Validation result type
  */
@@ -271,35 +278,21 @@ declare const PermitUtils: {
     /**
      * Validate a permit
      */
-    validate: (permit: Permit) => zod.SafeParseReturnType<{
-        type: "self" | "sharing" | "recipient";
-        issuer: string;
-        recipient?: string | undefined;
-        name?: string | undefined;
-        expiration?: number | undefined;
-        validatorId?: number | undefined;
-        validatorContract?: string | undefined;
-        sealingPair?: {
-            privateKey: string;
-            publicKey: string;
-        } | undefined;
-        issuerSignature?: string | undefined;
-        recipientSignature?: string | undefined;
-    }, {
-        recipient: `0x${string}`;
-        type: "self" | "sharing" | "recipient";
+    validate: (permit: Permit) => {
         name: string;
+        type: "self" | "sharing" | "recipient";
         issuer: `0x${string}`;
         expiration: number;
+        recipient: `0x${string}`;
         validatorId: number;
         validatorContract: `0x${string}`;
-        issuerSignature: string;
-        recipientSignature: string;
+        issuerSignature: `0x${string}`;
+        recipientSignature: `0x${string}`;
         sealingPair?: {
             privateKey: string;
             publicKey: string;
         } | undefined;
-    }>;
+    };
     /**
      * Get the permission object from a permit (for use in contracts)
      */
@@ -307,7 +300,7 @@ declare const PermitUtils: {
     /**
      * Get a stable hash for the permit (used as key in storage)
      */
-    getHash: (permit: Permit) => string;
+    getHash: (permit: PermitHashFields) => string;
     /**
      * Export permit data for sharing (removes sensitive fields)
      */
@@ -344,6 +337,10 @@ declare const PermitUtils: {
      * Check if permit's signed domain is valid for the current chain
      */
     checkSignedDomainValid: (permit: Permit, publicClient: PublicClient) => Promise<boolean>;
+    /**
+     * Check if permit passes the on-chain validation
+     */
+    checkValidityOnChain: (permit: Permit, publicClient: PublicClient) => Promise<boolean>;
 };
 
-export { type CreateSelfPermitOptions as C, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedPermitOptions as I, type Permit as P, type RecipientPermit as R, type SerializedPermit as S, type ValidationResult as V, type PermitSignaturePrimaryType as a, type Permission as b, type EIP712Message as c, type CreateSharingPermitOptions as d, type PermitMetadata as e, type EIP712Domain as f, PermitUtils as g, SealingKey$1 as h, type EthEncryptedData as i, type EIP712Type as j, type PermitType as k, type PermitOf as l, type SelfPermit as m, type SharingPermit as n, type Expand as o };
+export { type CreateSelfPermitOptions as C, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedPermitOptions as I, type Permit as P, type RecipientPermit as R, type SerializedPermit as S, type ValidationResult as V, type PermitSignaturePrimaryType as a, type Permission as b, type EIP712Message as c, type CreateSharingPermitOptions as d, type PermitMetadata as e, type EIP712Domain as f, PermitUtils as g, SealingKey$1 as h, type EthEncryptedData as i, type EIP712Type as j, type PermitType as k, type PermitOf as l, type SelfPermit as m, type SharingPermit as n, type PermitHashFields as o, type Expand as p };

package/dist/{permit-fUSe6KKq.d.ts → permit-MZ502UBl.d.ts}

@@ -1,5 +1,4 @@
-import * as zod from 'zod';
-import { PublicClient, WalletClient } from 'viem';
+import { Hex, PublicClient, WalletClient } from 'viem';
 
 type EthEncryptedData = {
     data: Uint8Array;
@@ -71,7 +70,7 @@ type EIP712Message = Record<string, string>;
 type EIP712Domain = {
     chainId: number;
     name: string;
-    verifyingContract: `0x${string}`;
+    verifyingContract: Hex;
     version: string;
 };
 /**
@@ -83,6 +82,10 @@ type SealingKey = SealingKey$1;
  * Core Permit interface - immutable design for React compatibility
  */
 interface Permit {
+    /**
+     * Stable hash of relevant permit data, used as key in storage
+     */
+    hash: string;
     /**
      * Name for this permit, for organization and UI usage, not included in signature.
      */
@@ -97,7 +100,7 @@ interface Permit {
     /**
      * (base) User that initially created the permission, target of data fetching
      */
-    issuer: `0x${string}`;
+    issuer: Hex;
     /**
      * (base) Expiration timestamp
      */
@@ -106,7 +109,7 @@ interface Permit {
      * (sharing) The user that this permission will be shared with
      * ** optional, use `address(0)` to disable **
      */
-    recipient: `0x${string}`;
+    recipient: Hex;
     /**
      * (issuer defined validation) An id used to query a contract to check this permissions validity
      * ** optional, use `0` to disable **
@@ -116,7 +119,7 @@ interface Permit {
      * (issuer defined validation) The contract to query to determine permission validity
      * ** optional, user `address(0)` to disable **
      */
-    validatorContract: `0x${string}`;
+    validatorContract: Hex;
     /**
      * (base) The publicKey of a sealingPair used to re-encrypt `issuer`s confidential data
      *   (non-sharing) Populated by `issuer`
@@ -129,13 +132,13 @@ interface Permit {
      *   (non-sharing) < issuer, expiration, recipient, validatorId, validatorContract, sealingKey >
      *   (sharing)     < issuer, expiration, recipient, validatorId, validatorContract >
      */
-    issuerSignature: `0x${string}`;
+    issuerSignature: Hex;
     /**
      * (sharing) `signTypedData` signature created by `recipient` with format:
      * (sharing) < sealingKey, issuerSignature>
      * ** required for shared permits **
      */
-    recipientSignature: `0x${string}`;
+    recipientSignature: Hex;
     /**
      * EIP712 domain used to sign this permit.
      * Should not be set manually, included in metadata as part of serialization flows.
@@ -196,7 +199,7 @@ type ImportSharedPermitOptions = {
     recipient: string;
     issuerSignature: string;
     name?: string;
-    expiration?: number;
+    expiration: number;
     validatorId?: number;
     validatorContract?: string;
 };
@@ -210,9 +213,13 @@ type SerializedPermit = Omit<Permit, 'sealingPair'> & {
 /**
  * A type representing the Permission struct that is passed to Permissioned.sol to grant encrypted data access.
  */
-type Permission = Expand<Omit<Permit, 'name' | 'type' | 'sealingPair'> & {
-    sealingKey: `0x${string}`;
+type Permission = Expand<Omit<Permit, 'name' | 'type' | 'sealingPair' | 'hash'> & {
+    sealingKey: Hex;
 }>;
+/**
+ * A type representing the permit fields that are used to generate the hash
+ */
+type PermitHashFields = Pick<Permit, 'type' | 'issuer' | 'expiration' | 'recipient' | 'validatorId' | 'validatorContract'>;
 /**
  * Validation result type
  */
@@ -271,35 +278,21 @@ declare const PermitUtils: {
     /**
      * Validate a permit
      */
-    validate: (permit: Permit) => zod.SafeParseReturnType<{
-        type: "self" | "sharing" | "recipient";
-        issuer: string;
-        recipient?: string | undefined;
-        name?: string | undefined;
-        expiration?: number | undefined;
-        validatorId?: number | undefined;
-        validatorContract?: string | undefined;
-        sealingPair?: {
-            privateKey: string;
-            publicKey: string;
-        } | undefined;
-        issuerSignature?: string | undefined;
-        recipientSignature?: string | undefined;
-    }, {
-        recipient: `0x${string}`;
-        type: "self" | "sharing" | "recipient";
+    validate: (permit: Permit) => {
         name: string;
+        type: "self" | "sharing" | "recipient";
         issuer: `0x${string}`;
         expiration: number;
+        recipient: `0x${string}`;
         validatorId: number;
         validatorContract: `0x${string}`;
-        issuerSignature: string;
-        recipientSignature: string;
+        issuerSignature: `0x${string}`;
+        recipientSignature: `0x${string}`;
         sealingPair?: {
             privateKey: string;
             publicKey: string;
         } | undefined;
-    }>;
+    };
     /**
      * Get the permission object from a permit (for use in contracts)
      */
@@ -307,7 +300,7 @@ declare const PermitUtils: {
     /**
      * Get a stable hash for the permit (used as key in storage)
      */
-    getHash: (permit: Permit) => string;
+    getHash: (permit: PermitHashFields) => string;
     /**
      * Export permit data for sharing (removes sensitive fields)
      */
@@ -344,6 +337,10 @@ declare const PermitUtils: {
      * Check if permit's signed domain is valid for the current chain
      */
     checkSignedDomainValid: (permit: Permit, publicClient: PublicClient) => Promise<boolean>;
+    /**
+     * Check if permit passes the on-chain validation
+     */
+    checkValidityOnChain: (permit: Permit, publicClient: PublicClient) => Promise<boolean>;
 };
 
-export { type CreateSelfPermitOptions as C, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedPermitOptions as I, type Permit as P, type RecipientPermit as R, type SerializedPermit as S, type ValidationResult as V, type PermitSignaturePrimaryType as a, type Permission as b, type EIP712Message as c, type CreateSharingPermitOptions as d, type PermitMetadata as e, type EIP712Domain as f, PermitUtils as g, SealingKey$1 as h, type EthEncryptedData as i, type EIP712Type as j, type PermitType as k, type PermitOf as l, type SelfPermit as m, type SharingPermit as n, type Expand as o };
+export { type CreateSelfPermitOptions as C, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedPermitOptions as I, type Permit as P, type RecipientPermit as R, type SerializedPermit as S, type ValidationResult as V, type PermitSignaturePrimaryType as a, type Permission as b, type EIP712Message as c, type CreateSharingPermitOptions as d, type PermitMetadata as e, type EIP712Domain as f, PermitUtils as g, SealingKey$1 as h, type EthEncryptedData as i, type EIP712Type as j, type PermitType as k, type PermitOf as l, type SelfPermit as m, type SharingPermit as n, type PermitHashFields as o, type Expand as p };