@cofhe/hardhat-plugin 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @cofhe/hardhat-plugin Changelog
 
+## 0.3.0
+
+### Minor Changes
+
+- 35024b6: Remove `sdk` from function names and exported types. Rename:
+
+  - `createCofhesdkConfig` -> `createCofheConfig`
+  - `createCofhesdkClient` -> `createCofheClient`
+  - `hre.cofhesdk.*` -> `hre.cofhe.*`
+  - `hre.cofhesdk.createCofheConfig()` → `hre.cofhe.createConfig()`
+  - `hre.cofhesdk.createCofheClient()` → `hre.cofhe.createClient()`
+  - `hre.cofhesdk.createBatteriesIncludedCofheClient()` → `hre.cofhe.createClientWithBatteries()`
+
+- 29c2401: implement decrypt-with-proof flows and related tests:
+
+  - Implement production `decryptForTx` backed by Threshold Network `POST /decrypt`, with explicit permit vs global-allowance selection.
+  - Rename mocks “Query Decrypter” -> “Threshold Network” and update SDK constants/contracts/artifacts accordingly.
+  - Extend mock contracts + hardhat plugin to publish & verify decryption results on-chain, and add end-to-end integration tests.
+
+### Patch Changes
+
+- 5467d77: Adds `config.mocks.encryptDelay: number | [number, number, number, number, number]` to allow configurable mock encryption delay. Defaults to 0 delay on hardhat to keep tests quick.
+- Updated dependencies [35024b6]
+- Updated dependencies [5467d77]
+- Updated dependencies [73b1502]
+- Updated dependencies [29c2401]
+- Updated dependencies [650ea48]
+  - @cofhe/mock-contracts@0.3.0
+  - @cofhe/sdk@0.3.0
+
+## 0.2.1
+
+### Patch Changes
+
+- 0000d5e: Mock contracts deployed to alternate fixed addresses to avoid collision with hardhat pre-compiles.
+- Updated dependencies [409bfdf]
+- Updated dependencies [ac47e2f]
+- Updated dependencies [0000d5e]
+- Updated dependencies [8af1b70]
+  - @cofhe/sdk@0.2.1
+  - @cofhe/mock-contracts@0.2.1
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -46,7 +46,7 @@ This plugin uses [cofhe-mock-contracts](https://github.com/FhenixProtocol/cofhe-
 The mock contracts include:
 
 - MockTaskManager: Manages FHE operations and stores plaintext values
-- MockQueryDecrypter: Handles decryption requests
+- MockThresholdNetwork: Handles decryption requests
 - MockZkVerifier: Simulates verification of encrypted inputs
 - ACL: Handles access control
 
@@ -64,6 +64,12 @@ Mock contracts are automatically deployed when using the Hardhat network:
 - Running tests: `npx hardhat test`
 - Starting a local node: `npx hardhat node`
 
+To disable this automatic deployment (for example, when your tests only use external RPCs and don't need the in-process Hardhat network), set:
+
+```bash
+COFHE_SKIP_MOCKS_DEPLOY=1
+```
+
 You can also manually deploy mock contracts:
 
 ```bash

package/dist/index.d.mts

@@ -1,11 +1,11 @@
 import { PublicClient, WalletClient } from 'viem';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
-import { CofhesdkInputConfig, CofhesdkConfig, CofhesdkClient } from '@cofhe/sdk';
+import { CofheInputConfig, CofheConfig, CofheClient } from '@cofhe/sdk';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 import * as ethers from 'ethers';
-import { ethers as ethers$1, Contract } from 'ethers';
-export { MockACLArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, TestBedArtifact } from '@cofhe/mock-contracts';
+import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
+import { MockArtifact } from '@cofhe/mock-contracts';
 
 type DeployMocksArgs = {
     deployTestBed?: boolean;
@@ -14,6 +14,12 @@ type DeployMocksArgs = {
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => Promise<void>;
 
+declare const TASK_COFHE_USE_FAUCET = "task:cofhe:usefaucet";
+declare const TASK_COFHE_MOCKS_SET_LOG_OPS = "task:cofhe-mocks:setlogops";
+declare const TASK_COFHE_MOCKS_DEPLOY = "task:cofhe-mocks:deploy";
+
+declare const deployMockContractFromArtifact: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
+declare const getFixedMockContract: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
 declare const mock_getPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_getPlaintextExists: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_expectPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint, expectedValue: bigint) => Promise<void>;
@@ -43,7 +49,7 @@ declare const mock_withLogs: (hre: HardhatRuntimeEnvironment, closureName: strin
  */
 declare module 'hardhat/types/config' {
     interface HardhatUserConfig {
-        cofhesdk?: {
+        cofhe?: {
             /** Whether to log mock operations (default: true) */
             logMocks?: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
@@ -51,7 +57,7 @@ declare module 'hardhat/types/config' {
         };
     }
     interface HardhatConfig {
-        cofhesdk: {
+        cofhe: {
             /** Whether to log mock operations (default: true) */
             logMocks: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
@@ -66,21 +72,21 @@ declare module 'hardhat/types/config' {
  */
 declare module 'hardhat/types/runtime' {
     interface HardhatRuntimeEnvironment {
-        cofhesdk: {
+        cofhe: {
             /**
-             * Create a CoFHE SDK configuration for use with cofhesdk.createCofhesdkClient(...)
-             * @param {CofhesdkInputConfig} config - The CoFHE SDK input configuration
-             * @returns {CofhesdkConfig} The CoFHE SDK configuration
+             * Create a CoFHE configuration for use with hre.cofhe.createClient(...)
+             * @param {CofheInputConfig} config - The CoFHE input configuration
+             * @returns {CofheConfig} The CoFHE configuration
              */
-            createCofhesdkConfig: (config: CofhesdkInputConfig) => Promise<CofhesdkConfig>;
+            createConfig: (config: CofheInputConfig) => Promise<CofheConfig>;
             /**
-             * Create a CoFHE SDK client instance
-             * @param {CofhesdkConfig} config - The CoFHE SDK configuration (use createCofhesdkConfig to create with Node.js defaults)
-             * @returns {Promise<CofhesdkClient>} The CoFHE SDK client instance
+             * Create a CoFHE client instance
+             * @param {CofheConfig} config - The CoFHE configuration (use createCofheConfig to create with Node.js defaults)
+             * @returns {Promise<CofheClient>} The CoFHE client instance
              */
-            createCofhesdkClient: (config: CofhesdkConfig) => CofhesdkClient;
+            createClient: (config: CofheConfig) => CofheClient;
             /**
-             * Create viem clients from a Hardhat ethers signer, to be used with `cofhesdkClient.connect(...)`
+             * Create viem clients from a Hardhat ethers signer, to be used with `cofheClient.connect(...)`
              * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use
              * @returns {Promise<{ publicClient: PublicClient; walletClient: WalletClient }>} The viem clients
              */
@@ -89,20 +95,20 @@ declare module 'hardhat/types/runtime' {
                 walletClient: WalletClient;
             }>;
             /**
-             * Connect a CoFHE SDK client with a Hardhat ethers signer
-             * @param {CofhesdkClient} client - The CoFHE SDK client to connect
+             * Connect a CoFHE client with a Hardhat ethers signer
+             * @param {CofheClient} client - The CoFHE client to connect
              * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use
              * @returns {Promise<void>}
              */
-            connectWithHardhatSigner: (client: CofhesdkClient, signer: HardhatEthersSigner) => Promise<void>;
+            connectWithHardhatSigner: (client: CofheClient, signer: HardhatEthersSigner) => Promise<void>;
             /**
              * Create and connect to a batteries included client.
              * Also generates a self-usage a permit for the signer.
-             * If customization is needed, use createCofhesdkClient and connectWithHardhatSigner.
+             * If customization is needed, use createCofheClient and connectWithHardhatSigner.
              * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use (optional - defaults to first signer)
-             * @returns {Promise<CofhesdkClient>} The CoFHE SDK client instance
+             * @returns {Promise<CofheClient>} The CoFHE client instance
              */
-            createBatteriesIncludedCofhesdkClient: (signer?: HardhatEthersSigner) => Promise<CofhesdkClient>;
+            createClientWithBatteries: (signer?: HardhatEthersSigner) => Promise<CofheClient>;
             mocks: {
                 /**
                  * **[MOCKS ONLY]**
@@ -114,7 +120,7 @@ declare module 'hardhat/types/runtime' {
                  * Example usage:
                  *
                  * ```ts
-                 * await hre.cofhesdk.mocks.withLogs("counter.increment()", async () => {
+                 * await hre.cofhe.mocks.withLogs("counter.increment()", async () => {
                  *   await counter.increment();
                  * });
                  * ```
@@ -180,10 +186,10 @@ declare module 'hardhat/types/runtime' {
                  */
                 getMockACL: () => Promise<Contract>;
                 /**
-                 * Get the MockQueryDecrypter contract
-                 * @returns {Promise<Contract>} The MockQueryDecrypter contract
+                 * Get the MockThresholdNetwork contract
+                 * @returns {Promise<Contract>} The MockThresholdNetwork contract
                  */
-                getMockQueryDecrypter: () => Promise<Contract>;
+                getMockThresholdNetwork: () => Promise<Contract>;
                 /**
                  * Get the MockZkVerifier contract
                  * @returns {Promise<Contract>} The MockZkVerifier contract
@@ -198,5 +204,11 @@ declare module 'hardhat/types/runtime' {
         };
     }
 }
+/**
+ * Builds the mocks config for the hardhat plugin.
+ * Defaults `encryptDelay` to `0` so tests run without artificial wait times,
+ * unless the user has explicitly provided a value.
+ */
+declare function buildHardhatPluginMocksConfig(mocksConfig: CofheInputConfig['mocks']): NonNullable<CofheInputConfig['mocks']>;
 
-export { type DeployMocksArgs, deployMocks, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };
+export { type DeployMocksArgs, TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, buildHardhatPluginMocksConfig, deployMockContractFromArtifact, deployMocks, getFixedMockContract, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import { PublicClient, WalletClient } from 'viem';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
-import { CofhesdkInputConfig, CofhesdkConfig, CofhesdkClient } from '@cofhe/sdk';
+import { CofheInputConfig, CofheConfig, CofheClient } from '@cofhe/sdk';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 import * as ethers from 'ethers';
-import { ethers as ethers$1, Contract } from 'ethers';
-export { MockACLArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, TestBedArtifact } from '@cofhe/mock-contracts';
+import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
+import { MockArtifact } from '@cofhe/mock-contracts';
 
 type DeployMocksArgs = {
     deployTestBed?: boolean;
@@ -14,6 +14,12 @@ type DeployMocksArgs = {
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => Promise<void>;
 
+declare const TASK_COFHE_USE_FAUCET = "task:cofhe:usefaucet";
+declare const TASK_COFHE_MOCKS_SET_LOG_OPS = "task:cofhe-mocks:setlogops";
+declare const TASK_COFHE_MOCKS_DEPLOY = "task:cofhe-mocks:deploy";
+
+declare const deployMockContractFromArtifact: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
+declare const getFixedMockContract: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
 declare const mock_getPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_getPlaintextExists: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_expectPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint, expectedValue: bigint) => Promise<void>;
@@ -43,7 +49,7 @@ declare const mock_withLogs: (hre: HardhatRuntimeEnvironment, closureName: strin
  */
 declare module 'hardhat/types/config' {
     interface HardhatUserConfig {
-        cofhesdk?: {
+        cofhe?: {
             /** Whether to log mock operations (default: true) */
             logMocks?: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
@@ -51,7 +57,7 @@ declare module 'hardhat/types/config' {
         };
     }
     interface HardhatConfig {
-        cofhesdk: {
+        cofhe: {
             /** Whether to log mock operations (default: true) */
             logMocks: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
@@ -66,21 +72,21 @@ declare module 'hardhat/types/config' {
  */
 declare module 'hardhat/types/runtime' {
     interface HardhatRuntimeEnvironment {
-        cofhesdk: {
+        cofhe: {
             /**
-             * Create a CoFHE SDK configuration for use with cofhesdk.createCofhesdkClient(...)
-             * @param {CofhesdkInputConfig} config - The CoFHE SDK input configuration
-             * @returns {CofhesdkConfig} The CoFHE SDK configuration
+             * Create a CoFHE configuration for use with hre.cofhe.createClient(...)
+             * @param {CofheInputConfig} config - The CoFHE input configuration
+             * @returns {CofheConfig} The CoFHE configuration
              */
-            createCofhesdkConfig: (config: CofhesdkInputConfig) => Promise<CofhesdkConfig>;
+            createConfig: (config: CofheInputConfig) => Promise<CofheConfig>;
             /**
-             * Create a CoFHE SDK client instance
-             * @param {CofhesdkConfig} config - The CoFHE SDK configuration (use createCofhesdkConfig to create with Node.js defaults)
-             * @returns {Promise<CofhesdkClient>} The CoFHE SDK client instance
+             * Create a CoFHE client instance
+             * @param {CofheConfig} config - The CoFHE configuration (use createCofheConfig to create with Node.js defaults)
+             * @returns {Promise<CofheClient>} The CoFHE client instance
              */
-            createCofhesdkClient: (config: CofhesdkConfig) => CofhesdkClient;
+            createClient: (config: CofheConfig) => CofheClient;
             /**
-             * Create viem clients from a Hardhat ethers signer, to be used with `cofhesdkClient.connect(...)`
+             * Create viem clients from a Hardhat ethers signer, to be used with `cofheClient.connect(...)`
              * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use
              * @returns {Promise<{ publicClient: PublicClient; walletClient: WalletClient }>} The viem clients
              */
@@ -89,20 +95,20 @@ declare module 'hardhat/types/runtime' {
                 walletClient: WalletClient;
             }>;
             /**
-             * Connect a CoFHE SDK client with a Hardhat ethers signer
-             * @param {CofhesdkClient} client - The CoFHE SDK client to connect
+             * Connect a CoFHE client with a Hardhat ethers signer
+             * @param {CofheClient} client - The CoFHE client to connect
              * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use
              * @returns {Promise<void>}
              */
-            connectWithHardhatSigner: (client: CofhesdkClient, signer: HardhatEthersSigner) => Promise<void>;
+            connectWithHardhatSigner: (client: CofheClient, signer: HardhatEthersSigner) => Promise<void>;
             /**
              * Create and connect to a batteries included client.
              * Also generates a self-usage a permit for the signer.
-             * If customization is needed, use createCofhesdkClient and connectWithHardhatSigner.
+             * If customization is needed, use createCofheClient and connectWithHardhatSigner.
              * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use (optional - defaults to first signer)
-             * @returns {Promise<CofhesdkClient>} The CoFHE SDK client instance
+             * @returns {Promise<CofheClient>} The CoFHE client instance
              */
-            createBatteriesIncludedCofhesdkClient: (signer?: HardhatEthersSigner) => Promise<CofhesdkClient>;
+            createClientWithBatteries: (signer?: HardhatEthersSigner) => Promise<CofheClient>;
             mocks: {
                 /**
                  * **[MOCKS ONLY]**
@@ -114,7 +120,7 @@ declare module 'hardhat/types/runtime' {
                  * Example usage:
                  *
                  * ```ts
-                 * await hre.cofhesdk.mocks.withLogs("counter.increment()", async () => {
+                 * await hre.cofhe.mocks.withLogs("counter.increment()", async () => {
                  *   await counter.increment();
                  * });
                  * ```
@@ -180,10 +186,10 @@ declare module 'hardhat/types/runtime' {
                  */
                 getMockACL: () => Promise<Contract>;
                 /**
-                 * Get the MockQueryDecrypter contract
-                 * @returns {Promise<Contract>} The MockQueryDecrypter contract
+                 * Get the MockThresholdNetwork contract
+                 * @returns {Promise<Contract>} The MockThresholdNetwork contract
                  */
-                getMockQueryDecrypter: () => Promise<Contract>;
+                getMockThresholdNetwork: () => Promise<Contract>;
                 /**
                  * Get the MockZkVerifier contract
                  * @returns {Promise<Contract>} The MockZkVerifier contract
@@ -198,5 +204,11 @@ declare module 'hardhat/types/runtime' {
         };
     }
 }
+/**
+ * Builds the mocks config for the hardhat plugin.
+ * Defaults `encryptDelay` to `0` so tests run without artificial wait times,
+ * unless the user has explicitly provided a value.
+ */
+declare function buildHardhatPluginMocksConfig(mocksConfig: CofheInputConfig['mocks']): NonNullable<CofheInputConfig['mocks']>;
 
-export { type DeployMocksArgs, deployMocks, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };
+export { type DeployMocksArgs, TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, buildHardhatPluginMocksConfig, deployMockContractFromArtifact, deployMocks, getFixedMockContract, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };