@cofhe/sdk 0.1.1 → 0.2.1

package/dist/node.d.cts

@@ -1,8 +1,8 @@
-import { d as CofhesdkInputConfig, b as CofhesdkConfig, a as CofhesdkClient } from './types-bB7wLj0q.cjs';
-import './permit-S9CnI6MF.cjs';
-import 'zod';
+import { C as CofhesdkInputConfig, a as CofhesdkConfig, b as CofhesdkClient } from './clientTypes-e4filDzK.cjs';
 import 'viem';
-import './types-KImPrEIe.cjs';
+import './types-YiAC4gig.cjs';
+import 'zod';
+import './permit-MZ502UBl.cjs';
 import 'zustand/vanilla';
 
 /**

package/dist/node.d.ts

@@ -1,8 +1,8 @@
-import { d as CofhesdkInputConfig, b as CofhesdkConfig, a as CofhesdkClient } from './types-PhwGgQvs.js';
-import './permit-S9CnI6MF.js';
-import 'zod';
+import { C as CofhesdkInputConfig, a as CofhesdkConfig, b as CofhesdkClient } from './clientTypes-RqkgkV2i.js';
 import 'viem';
-import './types-KImPrEIe.js';
+import './types-YiAC4gig.js';
+import 'zod';
+import './permit-MZ502UBl.js';
 import 'zustand/vanilla';
 
 /**

package/dist/node.js

@@ -1,6 +1,6 @@
-import { createCofhesdkConfigBase, createCofhesdkClientBase } from './chunk-KFGPTJ6X.js';
-import './chunk-GZCQQYVI.js';
-import './chunk-LU7BMUUT.js';
+import { createCofhesdkConfigBase, createCofhesdkClientBase } from './chunk-I5WFEYXX.js';
+import './chunk-TBLR7NNE.js';
+import './chunk-R3B5TMVX.js';
 import { promises } from 'fs';
 import { join } from 'path';
 import { init_panic_hook, TfheCompactPublicKey, CompactPkeCrs, ProvenCompactCiphertextList } from 'node-tfhe';
@@ -73,6 +73,7 @@ var zkBuilderAndCrsGenerator = (fhe, crs) => {
 };
 function createCofhesdkConfig(config) {
   return createCofhesdkConfigBase({
+    environment: "node",
     ...config,
     fheKeyStorage: config.fheKeyStorage === null ? null : config.fheKeyStorage ?? createNodeStorage()
   });

package/dist/{permit-S9CnI6MF.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;
@@ -55,9 +54,9 @@ declare class SealingKey$1 {
  * Asynchronously generates a new SealingKey.
  * This function uses the 'nacl' library to create a new public/private key pair for sealing purposes.
  * A sealing key is used to encrypt data such that it can only be unsealed (decrypted) by the owner of the corresponding private key.
- * @returns {Promise<SealingKey>} - A promise that resolves to a new SealingKey object containing the hexadecimal strings of the public and private keys.
+ * @returns {SealingKey} - A new SealingKey object containing the hexadecimal strings of the public and private keys.
  */
-declare const GenerateSealingKey: () => Promise<SealingKey$1>;
+declare const GenerateSealingKey: () => SealingKey$1;
 
 /**
  * EIP712 related types
@@ -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,19 +132,35 @@ 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.
      */
     _signedDomain?: EIP712Domain;
 }
+/**
+ * Permit discriminant helpers
+ */
+type PermitType = Permit['type'];
+/**
+ * Utility type to narrow a permit to a specific discriminant.
+ *
+ * Note: this only narrows the `type` field. Runtime/validation constraints
+ * (e.g. recipient == zeroAddress for self permits) are enforced elsewhere.
+ */
+type PermitOf<T extends PermitType> = Expand<Omit<Permit, 'type'> & {
+    type: T;
+}>;
+type SelfPermit = PermitOf<'self'>;
+type SharingPermit = PermitOf<'sharing'>;
+type RecipientPermit = PermitOf<'recipient'>;
 /**
  * Optional additional metadata of a Permit
  * Can be passed into the constructor, but not necessary
@@ -180,7 +199,7 @@ type ImportSharedPermitOptions = {
     recipient: string;
     issuerSignature: string;
     name?: string;
-    expiration?: number;
+    expiration: number;
     validatorId?: number;
     validatorContract?: string;
 };
@@ -194,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
  */
@@ -219,31 +242,31 @@ declare const PermitUtils: {
     /**
      * Create a self permit for personal use
      */
-    createSelf: (options: CreateSelfPermitOptions) => Promise<Permit>;
+    createSelf: (options: CreateSelfPermitOptions) => SelfPermit;
     /**
      * Create a sharing permit to be shared with another user
      */
-    createSharing: (options: CreateSharingPermitOptions) => Promise<Permit>;
+    createSharing: (options: CreateSharingPermitOptions) => SharingPermit;
     /**
      * Import a shared permit from various input formats
      */
-    importShared: (options: ImportSharedPermitOptions | any | string) => Promise<Permit>;
+    importShared: (options: ImportSharedPermitOptions | string) => RecipientPermit;
     /**
      * Sign a permit with the provided wallet client
      */
-    sign: (permit: Permit, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    sign: <T extends Permit>(permit: T, publicClient: PublicClient, walletClient: WalletClient) => Promise<T>;
     /**
      * Create and sign a self permit in one operation
      */
-    createSelfAndSign: (options: CreateSelfPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    createSelfAndSign: (options: CreateSelfPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<SelfPermit>;
     /**
      * Create and sign a sharing permit in one operation
      */
-    createSharingAndSign: (options: CreateSharingPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    createSharingAndSign: (options: CreateSharingPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<SharingPermit>;
     /**
      * Import and sign a shared permit in one operation from various input formats
      */
-    importSharedAndSign: (options: ImportSharedPermitOptions | any | string, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    importSharedAndSign: (options: ImportSharedPermitOptions | string, publicClient: PublicClient, walletClient: WalletClient) => Promise<RecipientPermit>;
     /**
      * Deserialize a permit from serialized data
      */
@@ -255,35 +278,21 @@ declare const PermitUtils: {
     /**
      * Validate a permit
      */
-    validate: (permit: Permit) => zod.SafeParseReturnType<{
-        type: "self" | "sharing" | "recipient";
-        issuer: string;
-        recipient?: string | undefined;
-        sealingPair?: {
-            privateKey: string;
-            publicKey: string;
-        } | undefined;
-        name?: string | undefined;
-        expiration?: number | undefined;
-        validatorId?: number | undefined;
-        validatorContract?: string | undefined;
-        issuerSignature?: string | undefined;
-        recipientSignature?: string | undefined;
-    }, {
-        recipient: `0x${string}`;
+    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)
      */
@@ -291,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)
      */
@@ -328,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 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 Expand as k };
+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-S9CnI6MF.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;
@@ -55,9 +54,9 @@ declare class SealingKey$1 {
  * Asynchronously generates a new SealingKey.
  * This function uses the 'nacl' library to create a new public/private key pair for sealing purposes.
  * A sealing key is used to encrypt data such that it can only be unsealed (decrypted) by the owner of the corresponding private key.
- * @returns {Promise<SealingKey>} - A promise that resolves to a new SealingKey object containing the hexadecimal strings of the public and private keys.
+ * @returns {SealingKey} - A new SealingKey object containing the hexadecimal strings of the public and private keys.
  */
-declare const GenerateSealingKey: () => Promise<SealingKey$1>;
+declare const GenerateSealingKey: () => SealingKey$1;
 
 /**
  * EIP712 related types
@@ -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,19 +132,35 @@ 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.
      */
     _signedDomain?: EIP712Domain;
 }
+/**
+ * Permit discriminant helpers
+ */
+type PermitType = Permit['type'];
+/**
+ * Utility type to narrow a permit to a specific discriminant.
+ *
+ * Note: this only narrows the `type` field. Runtime/validation constraints
+ * (e.g. recipient == zeroAddress for self permits) are enforced elsewhere.
+ */
+type PermitOf<T extends PermitType> = Expand<Omit<Permit, 'type'> & {
+    type: T;
+}>;
+type SelfPermit = PermitOf<'self'>;
+type SharingPermit = PermitOf<'sharing'>;
+type RecipientPermit = PermitOf<'recipient'>;
 /**
  * Optional additional metadata of a Permit
  * Can be passed into the constructor, but not necessary
@@ -180,7 +199,7 @@ type ImportSharedPermitOptions = {
     recipient: string;
     issuerSignature: string;
     name?: string;
-    expiration?: number;
+    expiration: number;
     validatorId?: number;
     validatorContract?: string;
 };
@@ -194,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
  */
@@ -219,31 +242,31 @@ declare const PermitUtils: {
     /**
      * Create a self permit for personal use
      */
-    createSelf: (options: CreateSelfPermitOptions) => Promise<Permit>;
+    createSelf: (options: CreateSelfPermitOptions) => SelfPermit;
     /**
      * Create a sharing permit to be shared with another user
      */
-    createSharing: (options: CreateSharingPermitOptions) => Promise<Permit>;
+    createSharing: (options: CreateSharingPermitOptions) => SharingPermit;
     /**
      * Import a shared permit from various input formats
      */
-    importShared: (options: ImportSharedPermitOptions | any | string) => Promise<Permit>;
+    importShared: (options: ImportSharedPermitOptions | string) => RecipientPermit;
     /**
      * Sign a permit with the provided wallet client
      */
-    sign: (permit: Permit, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    sign: <T extends Permit>(permit: T, publicClient: PublicClient, walletClient: WalletClient) => Promise<T>;
     /**
      * Create and sign a self permit in one operation
      */
-    createSelfAndSign: (options: CreateSelfPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    createSelfAndSign: (options: CreateSelfPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<SelfPermit>;
     /**
      * Create and sign a sharing permit in one operation
      */
-    createSharingAndSign: (options: CreateSharingPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    createSharingAndSign: (options: CreateSharingPermitOptions, publicClient: PublicClient, walletClient: WalletClient) => Promise<SharingPermit>;
     /**
      * Import and sign a shared permit in one operation from various input formats
      */
-    importSharedAndSign: (options: ImportSharedPermitOptions | any | string, publicClient: PublicClient, walletClient: WalletClient) => Promise<Permit>;
+    importSharedAndSign: (options: ImportSharedPermitOptions | string, publicClient: PublicClient, walletClient: WalletClient) => Promise<RecipientPermit>;
     /**
      * Deserialize a permit from serialized data
      */
@@ -255,35 +278,21 @@ declare const PermitUtils: {
     /**
      * Validate a permit
      */
-    validate: (permit: Permit) => zod.SafeParseReturnType<{
-        type: "self" | "sharing" | "recipient";
-        issuer: string;
-        recipient?: string | undefined;
-        sealingPair?: {
-            privateKey: string;
-            publicKey: string;
-        } | undefined;
-        name?: string | undefined;
-        expiration?: number | undefined;
-        validatorId?: number | undefined;
-        validatorContract?: string | undefined;
-        issuerSignature?: string | undefined;
-        recipientSignature?: string | undefined;
-    }, {
-        recipient: `0x${string}`;
+    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)
      */
@@ -291,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)
      */
@@ -328,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 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 Expand as k };
+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 };