@cofhe/sdk 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @cofhe/sdk Changelog
 
+## 0.3.2
+
+### Patch Changes
+
+- d4e86ea: Aligns with CTA encrypted variables bytes32 representation.
+
+  - **@cofhe/hardhat-plugin**: `hre.cofhe.mocks.getTestBed()`, `getMockTaskManager()`, `getMockACL()`, `getMockThresholdNetwork()`, and `getMockZkVerifier()` now return typed contracts (typechain interfaces) instead of untyped `Contract`. `getPlaintext(ctHash)` and `expectPlaintext(ctHash, value)` now accept bytes32 ctHashes as `string` support cofhe-contracts 0.1.0 CTA changes.
+  - **@cofhe/mock-contracts**: Export typechain-generated contract types (`TestBed`, `MockACL`, `MockTaskManager`, `MockZkVerifier`, `MockThresholdNetwork`) for use with the hardhat plugin. Typechain is run from artifact ABIs only; factory files are not generated.
+  - **@cofhe/abi**: CTA-related types use `bytes32` (string) instead of `uint256`. Decryption and return-type helpers aligned with cofhe-contracts 0.1.0.
+  - **@cofhe/sdk**: Decryption APIs (`decryptForTx`, `decryptForView`, and related builders) now also accept `string` for ciphertext hashes (bytes32) as well as `bigint`.
+
+- 0feaf3f: `cofheClient.decryptForTx` returns a ready-to-use signature
+
+## 0.3.1
+
+### Patch Changes
+
+- 370f0c7: no-op
+
 ## 0.3.0
 
 ### Minor Changes

package/adapters/ethers6.test.ts

@@ -164,6 +164,6 @@ describe('Ethers6Adapter', () => {
         expect(isInsufficientFunds).toBe(true);
         console.log('Expected error (insufficient funds or method not supported):', error.message);
       }
-    }, 10000);
+    }, 20000);
   });
 });

package/core/client.ts

@@ -146,7 +146,7 @@ export function createCofheClientBase<TConfig extends CofheConfig>(
     });
   }
 
-  function decryptForView<U extends FheTypes>(ctHash: bigint, utype: U): DecryptForViewBuilder<U> {
+  function decryptForView<U extends FheTypes>(ctHash: bigint | string, utype: U): DecryptForViewBuilder<U> {
     const state = connectStore.getState();
 
     return new DecryptForViewBuilder({
@@ -163,7 +163,7 @@ export function createCofheClientBase<TConfig extends CofheConfig>(
     });
   }
 
-  function decryptForTx(ctHash: bigint): DecryptForTxBuilderUnset {
+  function decryptForTx(ctHash: bigint | string): DecryptForTxBuilderUnset {
     const state = connectStore.getState();
 
     return new DecryptForTxBuilder({

package/core/clientTypes.ts

@@ -48,9 +48,9 @@ export type CofheClient<TConfig extends CofheConfig = CofheConfig> = {
   /**
    * @deprecated Use `decryptForView` instead. Kept for backward compatibility.
    */
-  decryptHandle<U extends FheTypes>(ctHash: bigint, utype: U): DecryptForViewBuilder<U>;
-  decryptForView<U extends FheTypes>(ctHash: bigint, utype: U): DecryptForViewBuilder<U>;
-  decryptForTx(ctHash: bigint): DecryptForTxBuilderUnset;
+  decryptHandle<U extends FheTypes>(ctHash: bigint | string, utype: U): DecryptForViewBuilder<U>;
+  decryptForView<U extends FheTypes>(ctHash: bigint | string, utype: U): DecryptForViewBuilder<U>;
+  decryptForTx(ctHash: bigint | string): DecryptForTxBuilderUnset;
   permits: CofheClientPermits;
 };
 

package/core/decrypt/cofheMocksDecryptForTx.ts

@@ -1,8 +1,7 @@
 import { type Permit, PermitUtils } from '@/permits';
 
-import { encodePacked, keccak256, pad, toHex, type Hex, type PublicClient } from 'viem';
+import { encodePacked, keccak256, type PublicClient } from 'viem';
 import { sign } from 'viem/accounts';
-import { sleep } from '../utils.js';
 import { MockThresholdNetworkAbi } from './MockThresholdNetworkAbi.js';
 import { FheTypes } from '../types.js';
 import { CofheError, CofheErrorCode } from '../error.js';
@@ -10,25 +9,23 @@ import { MOCKS_DECRYPT_RESULT_SIGNER_PRIVATE_KEY } from '../consts.js';
 import { MOCKS_THRESHOLD_NETWORK_ADDRESS } from '../consts.js';
 
 export type DecryptForTxMocksResult = {
-  ctHash: bigint;
+  ctHash: bigint | string;
   decryptedValue: bigint;
-  signature: string;
+  signature: `0x${string}`;
 };
 
 export async function cofheMocksDecryptForTx(
-  ctHash: bigint,
+  ctHash: bigint | string,
   utype: FheTypes,
   permit: Permit | null,
-  publicClient: PublicClient,
-  mocksDecryptForTxDelay: number
+  publicClient: PublicClient
 ): Promise<DecryptForTxMocksResult> {
-  // Configurable delay before decrypting to simulate the CoFHE decrypt processing time
-  // Recommended 1000ms on web
-  // Recommended 0ms on hardhat (will be called during tests no need for fake delay)
-  if (mocksDecryptForTxDelay > 0) await sleep(mocksDecryptForTxDelay);
+  let allowed: boolean;
+  let error: string;
+  let decryptedValue: bigint;
 
+  // With permit
   if (permit !== null) {
-    // With permit
     let permission = PermitUtils.getPermission(permit, true);
     const permissionWithBigInts = {
       ...permission,
@@ -36,66 +33,22 @@ export async function cofheMocksDecryptForTx(
       validatorId: BigInt(permission.validatorId),
     };
 
-    const [allowed, error, result] = await publicClient.readContract({
+    [allowed, error, decryptedValue] = await publicClient.readContract({
       address: MOCKS_THRESHOLD_NETWORK_ADDRESS,
       abi: MockThresholdNetworkAbi,
       functionName: 'decryptForTxWithPermit',
-      args: [ctHash, permissionWithBigInts],
+      args: [BigInt(ctHash), permissionWithBigInts],
     });
-
-    if (error != '') {
-      throw new CofheError({
-        code: CofheErrorCode.DecryptFailed,
-        message: `mocks decryptForTx call failed: ${error}`,
-      });
-    }
-
-    if (allowed == false) {
-      throw new CofheError({
-        code: CofheErrorCode.DecryptFailed,
-        message: `mocks decryptForTx call failed: ACL Access Denied (NotAllowed)`,
-      });
-    }
-
-    // decryptForTx returns plaintext directly (no sealing/unsealing needed)
-    // Generate a mock threshold network signature (in production, this would be the actual signature)
-    // The signature must be valid for MockTaskManager verification.
-    const chainId = await publicClient.getChainId();
-    const ctHashBigInt = BigInt(ctHash);
-    const resultBigInt = BigInt(result);
-    const encryptionType = Number((ctHashBigInt & (0x7fn << 8n)) >> 8n);
-
-    // Matches Solidity: keccak256(abi.encodePacked(result, uint32(enc_type), uint64(chainId), bytes32(ctHash)))
-    const ctHashBytes32 = pad(toHex(ctHashBigInt), { size: 32 }) as Hex;
-    const packed = encodePacked(
-      ['uint256', 'uint32', 'uint64', 'bytes32'],
-      [resultBigInt, encryptionType, BigInt(chainId), ctHashBytes32]
-    );
-    const messageHash = keccak256(packed);
-
-    // Raw digest signature (no EIP-191 prefix). Must verify against OpenZeppelin ECDSA.recover(messageHash, signature).
-    const signatureHex = await sign({
-      hash: messageHash,
-      privateKey: MOCKS_DECRYPT_RESULT_SIGNER_PRIVATE_KEY,
-      to: 'hex',
+  } else {
+    // Without permit (global allowance)
+    [allowed, error, decryptedValue] = await publicClient.readContract({
+      address: MOCKS_THRESHOLD_NETWORK_ADDRESS,
+      abi: MockThresholdNetworkAbi,
+      functionName: 'decryptForTxWithoutPermit',
+      args: [BigInt(ctHash)],
     });
-    const signature = signatureHex.slice(2); // no 0x prefix
-
-    return {
-      ctHash,
-      decryptedValue: BigInt(result),
-      signature,
-    };
   }
 
-  // Without permit (global allowance)
-  const [allowed, error, result] = await publicClient.readContract({
-    address: MOCKS_THRESHOLD_NETWORK_ADDRESS,
-    abi: MockThresholdNetworkAbi,
-    functionName: 'decryptForTxWithoutPermit',
-    args: [ctHash],
-  });
-
   if (error != '') {
     throw new CofheError({
       code: CofheErrorCode.DecryptFailed,
@@ -113,30 +66,19 @@ export async function cofheMocksDecryptForTx(
   // decryptForTx returns plaintext directly (no sealing/unsealing needed)
   // Generate a mock threshold network signature (in production, this would be the actual signature)
   // The signature must be valid for MockTaskManager verification.
-  const chainId = await publicClient.getChainId();
-  const ctHashBigInt = BigInt(ctHash);
-  const resultBigInt = BigInt(result);
-  const encryptionType = Number((ctHashBigInt & (0x7fn << 8n)) >> 8n);
-
-  // Matches Solidity: keccak256(abi.encodePacked(result, uint32(enc_type), uint64(chainId), bytes32(ctHash)))
-  const ctHashBytes32 = pad(toHex(ctHashBigInt), { size: 32 }) as Hex;
-  const packed = encodePacked(
-    ['uint256', 'uint32', 'uint64', 'bytes32'],
-    [resultBigInt, encryptionType, BigInt(chainId), ctHashBytes32]
-  );
+  const packed = encodePacked(['uint256', 'uint256'], [BigInt(ctHash), decryptedValue]);
   const messageHash = keccak256(packed);
 
   // Raw digest signature (no EIP-191 prefix). Must verify against OpenZeppelin ECDSA.recover(messageHash, signature).
-  const signatureHex = await sign({
+  const signature = await sign({
     hash: messageHash,
     privateKey: MOCKS_DECRYPT_RESULT_SIGNER_PRIVATE_KEY,
     to: 'hex',
   });
-  const signature = signatureHex.slice(2); // no 0x prefix
 
   return {
     ctHash,
-    decryptedValue: BigInt(result),
+    decryptedValue,
     signature,
   };
 }

package/core/decrypt/cofheMocksDecryptForView.ts

@@ -1,24 +1,17 @@
 import { type Permit, PermitUtils } from '@/permits';
 
 import { type PublicClient } from 'viem';
-import { sleep } from '../utils.js';
 import { MockThresholdNetworkAbi } from './MockThresholdNetworkAbi.js';
 import { FheTypes } from '../types.js';
 import { CofheError, CofheErrorCode } from '../error.js';
 import { MOCKS_THRESHOLD_NETWORK_ADDRESS } from '../consts.js';
 
 export async function cofheMocksDecryptForView(
-  ctHash: bigint,
+  ctHash: bigint | string,
   utype: FheTypes,
   permit: Permit,
-  publicClient: PublicClient,
-  mocksDecryptDelay: number
+  publicClient: PublicClient
 ): Promise<bigint> {
-  // Configurable delay before decrypting the output to simulate the CoFHE decrypt processing time
-  // Recommended 1000ms on web
-  // Recommended 0ms on hardhat (will be called during tests no need for fake delay)
-  if (mocksDecryptDelay > 0) await sleep(mocksDecryptDelay);
-
   const permission = PermitUtils.getPermission(permit, true);
   const permissionWithBigInts = {
     ...permission,
@@ -30,7 +23,7 @@ export async function cofheMocksDecryptForView(
     address: MOCKS_THRESHOLD_NETWORK_ADDRESS,
     abi: MockThresholdNetworkAbi,
     functionName: 'querySealOutput',
-    args: [ctHash, BigInt(utype), permissionWithBigInts],
+    args: [BigInt(ctHash), BigInt(utype), permissionWithBigInts],
   });
 
   if (error != '') {

package/core/decrypt/decryptForTxBuilder.ts

@@ -8,7 +8,7 @@ import { CofheError, CofheErrorCode } from '../error.js';
 import { permits } from '../permits.js';
 import { BaseBuilder, type BaseBuilderParams } from '../baseBuilder.js';
 import { cofheMocksDecryptForTx } from './cofheMocksDecryptForTx.js';
-import { getPublicClientChainID } from '../utils.js';
+import { getPublicClientChainID, sleep } from '../utils.js';
 import { tnDecrypt } from './tnDecrypt.js';
 
 /**
@@ -36,13 +36,13 @@ import { tnDecrypt } from './tnDecrypt.js';
 type DecryptForTxPermitSelection = 'unset' | 'with-permit' | 'without-permit';
 
 type DecryptForTxBuilderParams = BaseBuilderParams & {
-  ctHash: bigint;
+  ctHash: bigint | string;
 };
 
 export type DecryptForTxResult = {
-  ctHash: bigint;
+  ctHash: bigint | string;
   decryptedValue: bigint;
-  signature: string; // Threshold network signature for publishDecryptResult
+  signature: `0x${string}`; // Threshold network signature for publishDecryptResult
 };
 
 /**
@@ -56,7 +56,7 @@ export type DecryptForTxBuilderUnset = Omit<DecryptForTxBuilder, 'execute'>;
 export type DecryptForTxBuilderSelected = Omit<DecryptForTxBuilder, 'withPermit' | 'withoutPermit'>;
 
 export class DecryptForTxBuilder extends BaseBuilder {
-  private ctHash: bigint;
+  private ctHash: bigint | string;
   private permitHash?: string;
   private permit?: Permit;
   private permitSelection: DecryptForTxPermitSelection = 'unset';
@@ -271,8 +271,13 @@ export class DecryptForTxBuilder extends BaseBuilder {
   private async mocksDecryptForTx(permit: Permit | null): Promise<DecryptForTxResult> {
     this.assertPublicClient();
 
+    // Configurable delay before decrypting to simulate the CoFHE decrypt processing time
+    // Recommended 1000ms on web
+    // Recommended 0ms on hardhat (will be called during tests no need for fake delay)
     const delay = this.config.mocks.decryptDelay;
-    const result = await cofheMocksDecryptForTx(this.ctHash, 0 as FheTypes, permit, this.publicClient, delay);
+    if (delay > 0) await sleep(delay);
+
+    const result = await cofheMocksDecryptForTx(this.ctHash, 0 as FheTypes, permit, this.publicClient);
     return result;
   }
 

package/core/decrypt/decryptForViewBuilder.ts

@@ -11,7 +11,7 @@ import { BaseBuilder, type BaseBuilderParams } from '../baseBuilder.js';
 import { cofheMocksDecryptForView } from './cofheMocksDecryptForView.js';
 // import { tnSealOutputV1 } from './tnSealOutputV1.js';
 import { tnSealOutputV2 } from './tnSealOutputV2.js';
-import { cofheMocksDecryptForTx } from './cofheMocksDecryptForTx.js';
+import { sleep } from '../utils.js';
 
 /**
  * API
@@ -35,14 +35,14 @@ import { cofheMocksDecryptForTx } from './cofheMocksDecryptForTx.js';
  */
 
 type DecryptForViewBuilderParams<U extends FheTypes> = BaseBuilderParams & {
-  ctHash: bigint;
+  ctHash: bigint | string;
   utype: U;
   permitHash?: string;
   permit?: Permit;
 };
 
 export class DecryptForViewBuilder<U extends FheTypes> extends BaseBuilder {
-  private ctHash: bigint;
+  private ctHash: bigint | string;
   private utype: U;
   private permitHash?: string;
   private permit?: Permit;
@@ -245,8 +245,13 @@ export class DecryptForViewBuilder<U extends FheTypes> extends BaseBuilder {
   private async mocksSealOutput(permit: Permit): Promise<bigint> {
     this.assertPublicClient();
 
+    // Configurable delay before decrypting the output to simulate the CoFHE decrypt processing time
+    // Recommended 1000ms on web
+    // Recommended 0ms on hardhat (will be called during tests no need for fake delay)
     const mocksDecryptDelay = this.config.mocks.decryptDelay;
-    return cofheMocksDecryptForView(this.ctHash, this.utype, permit, this.publicClient, mocksDecryptDelay);
+    if (mocksDecryptDelay > 0) await sleep(mocksDecryptDelay);
+
+    return cofheMocksDecryptForView(this.ctHash, this.utype, permit, this.publicClient);
   }
 
   /**

package/core/decrypt/tnDecrypt.ts

@@ -1,6 +1,7 @@
 import { type Permission } from '@/permits';
 
 import { CofheError, CofheErrorCode } from '../error.js';
+import { parseSignature, serializeSignature } from 'viem';
 
 type TnDecryptResponse = {
   // TN returns bytes in big-endian order, e.g. [0,0,0,42]
@@ -10,7 +11,7 @@ type TnDecryptResponse = {
   error_message: string | null;
 };
 
-function normalizeSignature(signature: unknown): string {
+function normalizeSignature(signature: unknown): `0x${string}` {
   if (typeof signature !== 'string') {
     throw new CofheError({
       code: CofheErrorCode.DecryptReturnedNull,
@@ -29,8 +30,9 @@ function normalizeSignature(signature: unknown): string {
     });
   }
 
-  // SDK uses "no-0x" signatures in mocks/tests; normalize to that format.
-  return trimmed.startsWith('0x') ? trimmed.slice(2) : trimmed;
+  const prefixed = trimmed.startsWith('0x') ? (trimmed as `0x${string}`) : (`0x${trimmed}` as `0x${string}`);
+  const parsed = parseSignature(prefixed);
+  return serializeSignature(parsed);
 }
 
 function parseDecryptedBytesToBigInt(decrypted: unknown): bigint {
@@ -127,17 +129,17 @@ function assertTnDecryptResponse(value: unknown): TnDecryptResponse {
 }
 
 export async function tnDecrypt(
-  ctHash: bigint,
+  ctHash: bigint | string,
   chainId: number,
   permission: Permission | null,
   thresholdNetworkUrl: string
-): Promise<{ decryptedValue: bigint; signature: string }> {
+): Promise<{ decryptedValue: bigint; signature: `0x${string}` }> {
   const body: {
     ct_tempkey: string;
     host_chain_id: number;
     permit?: Permission;
   } = {
-    ct_tempkey: ctHash.toString(16).padStart(64, '0'),
+    ct_tempkey: BigInt(ctHash).toString(16).padStart(64, '0'),
     host_chain_id: chainId,
   };
 

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) => ({