@cofhe/sdk 0.3.1 → 0.4.0

package/core/decrypt/tnDecryptV2.ts

@@ -0,0 +1,343 @@
+import { type Permission } from '@/permits';
+
+import { CofheError, CofheErrorCode } from '../error';
+import { normalizeTnSignature, parseDecryptedBytesToBigInt } from './tnDecryptUtils';
+
+// Polling configuration
+const POLL_INTERVAL_MS = 1000; // 1 second
+const POLL_TIMEOUT_MS = 5 * 60 * 1000; // 5 minutes
+
+type DecryptSubmitResponseV2 = {
+  request_id: string;
+};
+
+type DecryptStatusResponseV2 = {
+  request_id: string;
+  status: 'PROCESSING' | 'COMPLETED';
+  submitted_at: string;
+  completed_at?: string;
+  is_succeed?: boolean;
+  decrypted?: number[];
+  signature?: string;
+  encryption_type?: number;
+  error_message?: string | null;
+};
+
+function assertDecryptSubmitResponseV2(value: unknown): DecryptSubmitResponseV2 {
+  if (value == null || typeof value !== 'object') {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: 'decrypt submit response must be a JSON object',
+      context: {
+        value,
+      },
+    });
+  }
+
+  const v = value as Record<string, unknown>;
+  if (typeof v.request_id !== 'string' || v.request_id.trim().length === 0) {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: 'decrypt submit response missing request_id',
+      context: {
+        value,
+      },
+    });
+  }
+
+  return { request_id: v.request_id };
+}
+
+function assertDecryptStatusResponseV2(value: unknown): DecryptStatusResponseV2 {
+  if (value == null || typeof value !== 'object') {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: 'decrypt status response must be a JSON object',
+      context: {
+        value,
+      },
+    });
+  }
+
+  const v = value as Record<string, unknown>;
+
+  const requestId = v.request_id;
+  const status = v.status;
+  const submittedAt = v.submitted_at;
+
+  if (typeof requestId !== 'string' || requestId.trim().length === 0) {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: 'decrypt status response missing request_id',
+      context: {
+        value,
+      },
+    });
+  }
+
+  if (status !== 'PROCESSING' && status !== 'COMPLETED') {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: 'decrypt status response has invalid status',
+      context: {
+        value,
+        status,
+      },
+    });
+  }
+
+  if (typeof submittedAt !== 'string' || submittedAt.trim().length === 0) {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: 'decrypt status response missing submitted_at',
+      context: {
+        value,
+      },
+    });
+  }
+
+  return value as DecryptStatusResponseV2;
+}
+
+async function submitDecryptRequestV2(
+  thresholdNetworkUrl: string,
+  ctHash: bigint | string,
+  chainId: number,
+  permission: Permission | null
+): Promise<string> {
+  const body: {
+    ct_tempkey: string;
+    host_chain_id: number;
+    permit?: Permission;
+  } = {
+    ct_tempkey: BigInt(ctHash).toString(16).padStart(64, '0'),
+    host_chain_id: chainId,
+  };
+
+  if (permission) {
+    body.permit = permission;
+  }
+
+  let response: Response;
+  try {
+    response = await fetch(`${thresholdNetworkUrl}/v2/decrypt`, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(body),
+    });
+  } catch (e) {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: `decrypt request failed`,
+      hint: 'Ensure the threshold network URL is valid and reachable.',
+      cause: e instanceof Error ? e : undefined,
+      context: {
+        thresholdNetworkUrl,
+        body,
+      },
+    });
+  }
+
+  if (!response.ok) {
+    let errorMessage = `HTTP ${response.status}`;
+    try {
+      const errorBody = (await response.json()) as Record<string, unknown>;
+      const maybeMessage = (errorBody.error_message || errorBody.message) as unknown;
+      if (typeof maybeMessage === 'string' && maybeMessage.length > 0) errorMessage = maybeMessage;
+    } catch {
+      errorMessage = response.statusText || errorMessage;
+    }
+
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: `decrypt request failed: ${errorMessage}`,
+      hint: 'Check the threshold network URL and request parameters.',
+      context: {
+        thresholdNetworkUrl,
+        status: response.status,
+        statusText: response.statusText,
+        body,
+      },
+    });
+  }
+
+  let rawJson: unknown;
+  try {
+    rawJson = (await response.json()) as unknown;
+  } catch (e) {
+    throw new CofheError({
+      code: CofheErrorCode.DecryptFailed,
+      message: `Failed to parse decrypt submit response`,
+      cause: e instanceof Error ? e : undefined,
+      context: {
+        thresholdNetworkUrl,
+        body,
+      },
+    });
+  }
+
+  const submitResponse = assertDecryptSubmitResponseV2(rawJson);
+  return submitResponse.request_id;
+}
+
+async function pollDecryptStatusV2(
+  thresholdNetworkUrl: string,
+  requestId: string
+): Promise<{ decryptedValue: bigint; signature: `0x${string}` }> {
+  const startTime = Date.now();
+  let completed = false;
+
+  while (!completed) {
+    if (Date.now() - startTime > POLL_TIMEOUT_MS) {
+      throw new CofheError({
+        code: CofheErrorCode.DecryptFailed,
+        message: `decrypt polling timed out after ${POLL_TIMEOUT_MS}ms`,
+        hint: 'The request may still be processing. Try again later.',
+        context: {
+          thresholdNetworkUrl,
+          requestId,
+          timeoutMs: POLL_TIMEOUT_MS,
+        },
+      });
+    }
+
+    let response: Response;
+    try {
+      response = await fetch(`${thresholdNetworkUrl}/v2/decrypt/${requestId}`, {
+        method: 'GET',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+      });
+    } catch (e) {
+      throw new CofheError({
+        code: CofheErrorCode.DecryptFailed,
+        message: `decrypt status poll failed`,
+        hint: 'Ensure the threshold network URL is valid and reachable.',
+        cause: e instanceof Error ? e : undefined,
+        context: {
+          thresholdNetworkUrl,
+          requestId,
+        },
+      });
+    }
+
+    if (response.status === 404) {
+      throw new CofheError({
+        code: CofheErrorCode.DecryptFailed,
+        message: `decrypt request not found: ${requestId}`,
+        hint: 'The request may have expired or been invalid.',
+        context: {
+          thresholdNetworkUrl,
+          requestId,
+        },
+      });
+    }
+
+    if (!response.ok) {
+      let errorMessage = `HTTP ${response.status}`;
+      try {
+        const errorBody = (await response.json()) as Record<string, unknown>;
+        const maybeMessage = (errorBody.error_message || errorBody.message) as unknown;
+        if (typeof maybeMessage === 'string' && maybeMessage.length > 0) errorMessage = maybeMessage;
+      } catch {
+        errorMessage = response.statusText || errorMessage;
+      }
+
+      throw new CofheError({
+        code: CofheErrorCode.DecryptFailed,
+        message: `decrypt status poll failed: ${errorMessage}`,
+        context: {
+          thresholdNetworkUrl,
+          requestId,
+          status: response.status,
+          statusText: response.statusText,
+        },
+      });
+    }
+
+    let rawJson: unknown;
+    try {
+      rawJson = (await response.json()) as unknown;
+    } catch (e) {
+      throw new CofheError({
+        code: CofheErrorCode.DecryptFailed,
+        message: `Failed to parse decrypt status response`,
+        cause: e instanceof Error ? e : undefined,
+        context: {
+          thresholdNetworkUrl,
+          requestId,
+        },
+      });
+    }
+
+    const statusResponse = assertDecryptStatusResponseV2(rawJson);
+
+    if (statusResponse.status === 'COMPLETED') {
+      if (statusResponse.is_succeed === false) {
+        const errorMessage = statusResponse.error_message || 'Unknown error';
+        throw new CofheError({
+          code: CofheErrorCode.DecryptFailed,
+          message: `decrypt request failed: ${errorMessage}`,
+          context: {
+            thresholdNetworkUrl,
+            requestId,
+            statusResponse,
+          },
+        });
+      }
+
+      if (statusResponse.error_message) {
+        throw new CofheError({
+          code: CofheErrorCode.DecryptFailed,
+          message: `decrypt request failed: ${statusResponse.error_message}`,
+          context: {
+            thresholdNetworkUrl,
+            requestId,
+            statusResponse,
+          },
+        });
+      }
+
+      if (!Array.isArray(statusResponse.decrypted)) {
+        throw new CofheError({
+          code: CofheErrorCode.DecryptReturnedNull,
+          message: 'decrypt completed but response missing <decrypted> byte array',
+          context: {
+            thresholdNetworkUrl,
+            requestId,
+            statusResponse,
+          },
+        });
+      }
+
+      const decryptedValue = parseDecryptedBytesToBigInt(statusResponse.decrypted);
+      const signature = normalizeTnSignature(statusResponse.signature);
+      return { decryptedValue, signature };
+    }
+
+    await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL_MS));
+  }
+
+  // This should never be reached, but keeps TS and linters happy.
+  throw new CofheError({
+    code: CofheErrorCode.DecryptFailed,
+    message: 'Polling loop exited unexpectedly',
+    context: {
+      thresholdNetworkUrl,
+      requestId,
+    },
+  });
+}
+
+export async function tnDecryptV2(
+  ctHash: bigint | string,
+  chainId: number,
+  permission: Permission | null,
+  thresholdNetworkUrl: string
+): Promise<{ decryptedValue: bigint; signature: `0x${string}` }> {
+  const requestId = await submitDecryptRequestV2(thresholdNetworkUrl, ctHash, chainId, permission);
+  return await pollDecryptStatusV2(thresholdNetworkUrl, requestId);
+}

package/core/decrypt/tnSealOutputV2.ts

@@ -57,12 +57,12 @@ function convertSealedData(sealed: SealOutputStatusResponse['sealed']): EthEncry
  */
 async function submitSealOutputRequest(
   thresholdNetworkUrl: string,
-  ctHash: bigint,
+  ctHash: bigint | string,
   chainId: number,
   permission: Permission
 ): Promise<string> {
   const body = {
-    ct_tempkey: ctHash.toString(16).padStart(64, '0'),
+    ct_tempkey: BigInt(ctHash).toString(16).padStart(64, '0'),
     host_chain_id: chainId,
     permit: permission,
   };
@@ -285,7 +285,7 @@ async function pollSealOutputStatus(thresholdNetworkUrl: string, requestId: stri
 }
 
 export async function tnSealOutputV2(
-  ctHash: bigint,
+  ctHash: bigint | string,
   chainId: number,
   permission: Permission,
   thresholdNetworkUrl: string

package/core/encrypt/cofheMocksZkVerifySign.ts

@@ -13,7 +13,7 @@ import {
 import { MockZkVerifierAbi } from './MockZkVerifierAbi.js';
 import { hardhat } from 'viem/chains';
 import { CofheError, CofheErrorCode } from '../error.js';
-import { privateKeyToAccount } from 'viem/accounts';
+import { privateKeyToAccount, sign } from 'viem/accounts';
 import { MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY, MOCKS_ZK_VERIFIER_ADDRESS } from '../consts.js';
 
 type EncryptableItemWithCtHash = EncryptableItem & {
@@ -181,7 +181,11 @@ async function insertCtHashes(items: EncryptableItemWithCtHash[], walletClient:
  * The mocks verify the EncryptedInputs' signature against the known proof signer account.
  * Locally, we create the proof signatures from the known proof signer account.
  */
-async function createProofSignatures(items: EncryptableItemWithCtHash[], securityZone: number): Promise<string[]> {
+async function createProofSignatures(
+  items: EncryptableItemWithCtHash[],
+  securityZone: number,
+  account: string
+): Promise<string[]> {
   let signatures: string[] = [];
 
   // Create wallet client for the encrypted input signer
@@ -205,16 +209,16 @@ async function createProofSignatures(items: EncryptableItemWithCtHash[], securit
   try {
     for (const item of items) {
       // Pack the data into bytes and hash it
-      const packedData = encodePacked(['uint256', 'int32', 'uint8'], [BigInt(item.data), securityZone, item.utype]);
+      const packedData = encodePacked(
+        ['uint256', 'uint8', 'uint8', 'address', 'uint256'],
+        [BigInt(item.ctHash), item.utype, securityZone, account as `0x${string}`, BigInt(hardhat.id)]
+      );
       const messageHash = keccak256(packedData);
 
-      // Convert to EthSignedMessageHash (adds "\x19Ethereum Signed Message:\n32" prefix)
-      const ethSignedHash = hashMessage({ raw: toBytes(messageHash) });
-
-      // Sign the message
-      const signature = await encInputSignerClient.signMessage({
-        message: { raw: toBytes(ethSignedHash) },
-        account: encInputSignerClient.account!,
+      const signature = await sign({
+        hash: messageHash,
+        privateKey: MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY,
+        to: 'hex',
       });
 
       signatures.push(signature);
@@ -267,7 +271,7 @@ export async function cofheMocksZkVerifySign(
   await insertCtHashes(encryptableItems, _walletClient);
 
   // Locally create the proof signatures from the known proof signer account
-  const signatures = await createProofSignatures(encryptableItems, securityZone);
+  const signatures = await createProofSignatures(encryptableItems, securityZone, account);
 
   // Return the ctHashes and signatures in the same format as CoFHE
   return encryptableItems.map((item, index) => ({

package/core/permits.ts

@@ -85,15 +85,15 @@ const deserialize = (serialized: SerializedPermit) => {
 
 // GET
 
-const getPermit = async (chainId: number, account: string, hash: string): Promise<Permit | undefined> => {
+const getPermit = (chainId: number, account: string, hash: string): Permit | undefined => {
   return permitStore.getPermit(chainId, account, hash);
 };
 
-const getPermits = async (chainId: number, account: string): Promise<Record<string, Permit>> => {
+const getPermits = (chainId: number, account: string): Record<string, Permit> => {
   return permitStore.getPermits(chainId, account);
 };
 
-const getActivePermit = async (chainId: number, account: string): Promise<Permit | undefined> => {
+const getActivePermit = (chainId: number, account: string): Permit | undefined => {
   return permitStore.getActivePermit(chainId, account);
 };
 

package/core/types.ts

@@ -389,6 +389,14 @@ export type EncryptStepCallbackFunction = (state: EncryptStep, context?: Encrypt
 
 // DECRYPT
 
+/**
+ * Decrypted plaintext value returned by view-decryption helpers.
+ *
+ * This is a scalar JS value (not a wrapper object):
+ * - `boolean` for `FheTypes.Bool`
+ * - checksummed address `string` for `FheTypes.Uint160`
+ * - `bigint` for supported integer utypes
+ */
 export type UnsealedItem<U extends FheTypes> = U extends FheTypes.Bool
   ? boolean
   : U extends FheTypes.Uint160