@cofhe/hardhat-3-plugin 0.7.1 → 0.8.0

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { HardhatPlugin } from 'hardhat/types/plugins';
 import { PublicClient, WalletClient } from 'viem';
 import { CofheInputConfig, CofheConfig, CofheClient } from '@cofhe/sdk';
 import { ArtifactManager } from 'hardhat/types/artifacts';
-import { MockTaskManagerArtifact, MockACLArtifact, MockZkVerifierArtifact, MockThresholdNetworkArtifact } from '@cofhe/mock-contracts';
+import { MockCoFHEAddressBookArtifact, MockTaskManagerArtifact, MockACLArtifact, MockZkVerifierArtifact, MockThresholdNetworkArtifact } from '@cofhe/mock-contracts';
 
 /**
  * Controls deploy-mocks console output.
@@ -13,6 +13,7 @@ import { MockTaskManagerArtifact, MockACLArtifact, MockZkVerifierArtifact, MockT
 type LogMocksDeploy = '' | 'v' | 'vv';
 /** Keyed map of deployed mock contract addresses returned by `deployMocks`. */
 type DeployedMockContracts = {
+    MockCoFHEAddressBook: `0x${string}`;
     MockTaskManager: `0x${string}`;
     MockACL: `0x${string}`;
     ACPTimestampRevoker: `0x${string}`;
@@ -31,6 +32,47 @@ type DeployContext = {
 };
 declare function deployMocks(ctx: DeployContext, options?: DeployMocksArgs): Promise<DeployedMockContracts>;
 
+declare const MOCK_GAS_CONSUMED_EVENT: {
+    readonly name: "MockGasConsumed";
+    readonly type: "event";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "gas";
+    }];
+};
+declare const MOCK_GAS_CONSUMED_TOPIC: `0x${string}`;
+type AdjustableGasReceipt = {
+    gasUsed: bigint | number | string;
+    logs?: ReadonlyArray<{
+        address: string;
+        topics: ReadonlyArray<string>;
+        data: string;
+    }>;
+};
+type AdjustedGasBreakdown = {
+    /** Raw gas used by the transaction (includes mock overhead). */
+    gasUsed: bigint;
+    /** Gas consumed by mock-only work (FHE op replication, decrypt-task storage, mock logging). */
+    mockGas: bigint;
+    /** gasUsed - mockGas: an estimate of what the transaction would cost on a real CoFHE network. */
+    adjustedGasUsed: bigint;
+    /** Number of MockGasConsumed events - roughly the number of mock-only blocks executed. */
+    mockGasEvents: number;
+};
+declare const mock_getAdjustedGasBreakdown: (receipt: AdjustableGasReceipt) => AdjustedGasBreakdown;
+declare const mock_getAdjustedGasUsed: (receipt: AdjustableGasReceipt) => bigint;
+type MockGasSummaryRow = {
+    contract: string;
+    method: string;
+    calls: number;
+    totalGasUsed: string;
+    totalMockGas: string;
+};
+declare const collectMockGasRows: (publicClient: PublicClient, artifacts: ArtifactManager, fromBlock?: bigint) => Promise<MockGasSummaryRow[]>;
+declare const registerGasSummaryConnection: (publicClient: PublicClient, artifacts: ArtifactManager, cacheDir: string, fromBlock: bigint) => void;
+declare const cleanGasSummaryDir: (cacheDir: string) => void;
+declare const printMockGasSummaryFromDir: (cacheDir: string) => void;
+
 interface CofheConnection {
     /**
      * Create a CoFHE configuration. Defaults to hardhat environment;
@@ -45,6 +87,20 @@ interface CofheConnection {
      * first account from the connection is used automatically.
      */
     createClientWithBatteries(walletClient?: WalletClient): Promise<CofheClient>;
+    /**
+     * Returns a transaction's gas usage excluding mock-only overhead (FHE op replication,
+     * decrypt-task storage, mock logging) - an estimate of what the transaction would cost
+     * on a real CoFHE network. Pure function of the receipt (sums the mock task manager's
+     * MockGasConsumed events from `receipt.logs`); on a real network the receipt carries no
+     * such events and the raw `gasUsed` is returned unchanged.
+     */
+    getAdjustedGasUsed(receipt: AdjustableGasReceipt): bigint;
+    /**
+     * Full gas breakdown of a transaction receipt: raw `gasUsed`, the mock-only `mockGas`,
+     * the `adjustedGasUsed` (raw minus mock), and the number of mock gas events.
+     * See getAdjustedGasUsed.
+     */
+    getAdjustedGasBreakdown(receipt: AdjustableGasReceipt): AdjustedGasBreakdown;
     mocks: {
         /** Deploy (or re-deploy) the mock contracts. */
         deployMocks(options?: DeployMocksArgs): Promise<void>;
@@ -58,6 +114,11 @@ interface CofheConnection {
         getPlaintext(ctHash: bigint | string): Promise<bigint>;
         /** Assert that a ciphertext hash represents the expected plaintext value. */
         expectPlaintext(ctHash: bigint | string, expectedValue: bigint): Promise<void>;
+        /** MockCoFHEAddressBook contract descriptor — spread into readContract / writeContract */
+        MockCoFHEAddressBook: {
+            address: `0x${string}`;
+            abi: typeof MockCoFHEAddressBookArtifact.abi;
+        };
         /** MockTaskManager contract descriptor — spread into readContract / writeContract */
         MockTaskManager: {
             address: `0x${string}`;
@@ -87,6 +148,14 @@ declare module 'hardhat/types/config' {
             logMocks?: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning?: boolean;
+            /**
+             * Print a per-method gas summary after `hardhat test`, showing raw gas next to
+             * adjusted gas (mock-only overhead excluded - an estimate of real-network cost).
+             * Collected per test worker from chain history: transactions rolled back by
+             * snapshots won't appear, and the table is best-effort after forced exits -
+             * use getAdjustedGasUsed(receipt) for exact numbers. (default: false)
+             */
+            gasSummary?: boolean;
             /**
              * Controls deploy-mocks console output.
              * - `''`   — silent, no output
@@ -100,6 +169,8 @@ declare module 'hardhat/types/config' {
         cofhe: {
             logMocks: boolean;
             gasWarning: boolean;
+            /** Print a per-method adjusted-gas summary after `hardhat test` (default: false) */
+            gasSummary: boolean;
             mocksDeployVerbosity: LogMocksDeploy;
         };
     }
@@ -148,4 +219,4 @@ declare function mock_expectPlaintext(publicClient: PublicClient, ctHash: bigint
 
 declare const plugin: HardhatPlugin;
 
-export { type DeployContext, type DeployMocksArgs, type DeployedMockContracts, type LogMocksDeploy, TASK_COFHE_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, plugin as default, deployMocks, getMockContractsNpmPaths, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_setLoggingEnabled, mock_withLogs };
+export { type AdjustableGasReceipt, type AdjustedGasBreakdown, type DeployContext, type DeployMocksArgs, type DeployedMockContracts, type LogMocksDeploy, MOCK_GAS_CONSUMED_EVENT, MOCK_GAS_CONSUMED_TOPIC, type MockGasSummaryRow, TASK_COFHE_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, cleanGasSummaryDir, collectMockGasRows, plugin as default, deployMocks, getMockContractsNpmPaths, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getAdjustedGasBreakdown, mock_getAdjustedGasUsed, mock_getPlaintext, mock_setLoggingEnabled, mock_withLogs, printMockGasSummaryFromDir, registerGasSummaryConnection };

package/dist/index.js

@@ -3,7 +3,7 @@ import {
   getMockContractsNpmPaths,
   mock_expectPlaintext,
   mock_getPlaintext
-} from "./chunk-E7DR6EGV.js";
+} from "./chunk-FDCRLC5K.js";
 import {
   localcofheFundAccount,
   localcofheFundWalletIfNeeded
@@ -11,10 +11,20 @@ import {
 import {
   mock_setLoggingEnabled,
   mock_withLogs
-} from "./chunk-IVRNGFNF.js";
+} from "./chunk-NYXXHYHW.js";
+import {
+  MOCK_GAS_CONSUMED_EVENT,
+  MOCK_GAS_CONSUMED_TOPIC,
+  cleanGasSummaryDir,
+  collectMockGasRows,
+  mock_getAdjustedGasBreakdown,
+  mock_getAdjustedGasUsed,
+  printMockGasSummaryFromDir,
+  registerGasSummaryConnection
+} from "./chunk-6G2MCXNM.js";
 
 // src/index.ts
-import { task } from "hardhat/config";
+import { overrideTask, task } from "hardhat/config";
 import { ArgumentType } from "hardhat/types/arguments";
 
 // src/consts.ts
@@ -25,8 +35,8 @@ var TASK_COFHE_SET_LOG_OPS = "cofhe:set-log-ops";
 var plugin = {
   id: "@cofhe/hardhat-3-plugin",
   hookHandlers: {
-    config: async () => import("./config-YK3LB5IH.js"),
-    hre: async () => import("./hre-CYH6NXPG.js")
+    config: async () => import("./config-VUCAYBHC.js"),
+    hre: async () => import("./hre-T3TPXWIY.js")
   },
   tasks: [
     task(TASK_COFHE_USE_FAUCET, "Fund an account via the localcofhe faucet").addOption({
@@ -35,20 +45,30 @@ var plugin = {
       type: ArgumentType.STRING_WITHOUT_DEFAULT,
       defaultValue: void 0
     }).setAction(async () => import("./use-faucet-O732FNWJ.js")).build(),
-    task(TASK_COFHE_SET_LOG_OPS, "Enable or disable CoFHE mock contract logging").addFlag({ name: "enable", description: "Whether to enable logging" }).setAction(async () => import("./set-log-ops-GVEQWMZP.js")).build()
+    task(TASK_COFHE_SET_LOG_OPS, "Enable or disable CoFHE mock contract logging").addFlag({ name: "enable", description: "Whether to enable logging" }).setAction(async () => import("./set-log-ops-2OIBBSDL.js")).build(),
+    // Prints the adjusted-gas summary after `hardhat test` when cofhe.gasSummary is enabled.
+    overrideTask("test").setAction(async () => import("./test-gas-summary-WK6CULNO.js")).build()
   ]
 };
 var index_default = plugin;
 export {
+  MOCK_GAS_CONSUMED_EVENT,
+  MOCK_GAS_CONSUMED_TOPIC,
   TASK_COFHE_SET_LOG_OPS,
   TASK_COFHE_USE_FAUCET,
+  cleanGasSummaryDir,
+  collectMockGasRows,
   index_default as default,
   deployMocks,
   getMockContractsNpmPaths,
   localcofheFundAccount,
   localcofheFundWalletIfNeeded,
   mock_expectPlaintext,
+  mock_getAdjustedGasBreakdown,
+  mock_getAdjustedGasUsed,
   mock_getPlaintext,
   mock_setLoggingEnabled,
-  mock_withLogs
+  mock_withLogs,
+  printMockGasSummaryFromDir,
+  registerGasSummaryConnection
 };

package/dist/{set-log-ops-GVEQWMZP.js → set-log-ops-2OIBBSDL.js}

@@ -1,6 +1,6 @@
 import {
   mock_setLoggingEnabled
-} from "./chunk-IVRNGFNF.js";
+} from "./chunk-NYXXHYHW.js";
 
 // src/tasks/set-log-ops.ts
 import { createPublicClient, createWalletClient, custom } from "viem";

package/dist/test-gas-summary-WK6CULNO.js

@@ -0,0 +1,19 @@
+import {
+  cleanGasSummaryDir,
+  printMockGasSummaryFromDir
+} from "./chunk-6G2MCXNM.js";
+
+// src/tasks/test-gas-summary.ts
+var action = async (args, hre, runSuper) => {
+  if (!hre.config.cofhe.gasSummary) {
+    return runSuper(args);
+  }
+  cleanGasSummaryDir(hre.config.paths.cache);
+  const result = await runSuper(args);
+  printMockGasSummaryFromDir(hre.config.paths.cache);
+  return result;
+};
+var test_gas_summary_default = action;
+export {
+  test_gas_summary_default as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cofhe/hardhat-3-plugin",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Hardhat 3 plugin for CoFHE — deploys mock contracts and wires up the hre.cofhe interface",
   "type": "module",
   "main": "./dist/index.js",
@@ -28,8 +28,8 @@
   "dependencies": {
     "chalk": "4.1.2",
     "viem": "2.38.6",
-    "@cofhe/mock-contracts": "0.7.1",
-    "@cofhe/sdk": "0.7.1"
+    "@cofhe/mock-contracts": "0.8.0",
+    "@cofhe/sdk": "0.8.0"
   },
   "devDependencies": {
     "@types/node": "20.19.15",

package/src/config.ts

@@ -59,6 +59,7 @@ export function resolvePluginConfig(userConfig: HardhatUserConfig, resolvedConfi
   resolvedConfig.cofhe = {
     logMocks: userConfig.cofhe?.logMocks ?? false,
     gasWarning: userConfig.cofhe?.gasWarning ?? false,
+    gasSummary: userConfig.cofhe?.gasSummary ?? false,
     mocksDeployVerbosity: (userConfig.cofhe?.mocksDeployVerbosity ?? 'v') as LogMocksDeploy,
   };
 }

package/src/deploy.ts

@@ -4,9 +4,16 @@ import { createTestClient, custom } from 'viem';
 import chalk from 'chalk';
 import { privateKeyToAccount } from 'viem/accounts';
 
-import { MockACLArtifact, MockTaskManagerArtifact, MockThresholdNetworkArtifact } from '@cofhe/mock-contracts';
 import {
-  TASK_MANAGER_ADDRESS,
+  MockACLArtifact,
+  MockCoFHEAddressBookArtifact,
+  MockTaskManagerArtifact,
+  MockThresholdNetworkArtifact,
+} from '@cofhe/mock-contracts';
+import {
+  COFHE_ADDRESS_BOOK_ADDRESS,
+  TASK_MANAGER_ID,
+  MOCKS_TASK_MANAGER_ADDRESS,
   MOCKS_ZK_VERIFIER_ADDRESS,
   MOCKS_ZK_VERIFIER_SIGNER_ADDRESS,
   MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY,
@@ -24,6 +31,7 @@ export type LogMocksDeploy = '' | 'v' | 'vv';
 
 /** Keyed map of deployed mock contract addresses returned by `deployMocks`. */
 export type DeployedMockContracts = {
+  MockCoFHEAddressBook: `0x${string}`;
   MockTaskManager: `0x${string}`;
   MockACL: `0x${string}`;
   ACPTimestampRevoker: `0x${string}`;
@@ -71,14 +79,18 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
 
   log('vv', chalk.bold('cofhe-hardhat-3-plugin :: deploy mocks'), 0);
 
+  // 0. Deploy CoFHEAddressBook to the address FHE.sol resolves the TaskManager through
+  await deployFixed(ctx.publicClient, 'MockCoFHEAddressBook', COFHE_ADDRESS_BOOK_ADDRESS, ctx.artifacts);
+  logDeployment('MockCoFHEAddressBook', COFHE_ADDRESS_BOOK_ADDRESS);
+
   // 1. Deploy TaskManager to its fixed address
-  await deployFixed(ctx.publicClient, 'MockTaskManager', TASK_MANAGER_ADDRESS, ctx.artifacts);
-  logDeployment('MockTaskManager', TASK_MANAGER_ADDRESS);
+  await deployFixed(ctx.publicClient, 'MockTaskManager', MOCKS_TASK_MANAGER_ADDRESS, ctx.artifacts);
+  logDeployment('MockTaskManager', MOCKS_TASK_MANAGER_ADDRESS);
 
   // 2. Initialize TaskManager — owner = first connected account
   const [account] = await ctx.walletClient.getAddresses();
   await ctx.walletClient.writeContract({
-    address: TASK_MANAGER_ADDRESS,
+    address: MOCKS_TASK_MANAGER_ADDRESS,
     abi: MockTaskManagerArtifact.abi,
     functionName: 'initialize',
     args: [account],
@@ -86,9 +98,20 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
     chain: null,
   });
 
+  // 2b. Register TaskManager in the CoFHEAddressBook
+  await ctx.walletClient.writeContract({
+    address: COFHE_ADDRESS_BOOK_ADDRESS,
+    abi: MockCoFHEAddressBookArtifact.abi,
+    functionName: 'setTm',
+    args: [TASK_MANAGER_ID, MOCKS_TASK_MANAGER_ADDRESS],
+    account,
+    chain: null,
+  });
+  log('vv', 'TaskManager registered in CoFHEAddressBook', 2);
+
   // 3. Configure security zones
   await ctx.walletClient.writeContract({
-    address: TASK_MANAGER_ADDRESS,
+    address: MOCKS_TASK_MANAGER_ADDRESS,
     abi: MockTaskManagerArtifact.abi,
     functionName: 'setSecurityZones',
     args: [0, 1],
@@ -102,7 +125,7 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
 
   // 5. Link ACL into TaskManager
   await ctx.walletClient.writeContract({
-    address: TASK_MANAGER_ADDRESS,
+    address: MOCKS_TASK_MANAGER_ADDRESS,
     abi: MockTaskManagerArtifact.abi,
     functionName: 'setACLContract',
     args: [aclAddress],
@@ -111,6 +134,17 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
   });
   log('vv', 'ACL address set in TaskManager', 2);
 
+  // 5a. Link TaskManager into ACL
+  await ctx.walletClient.writeContract({
+    address: aclAddress,
+    abi: MockACLArtifact.abi,
+    functionName: 'setTaskManager',
+    args: [MOCKS_TASK_MANAGER_ADDRESS],
+    account,
+    chain: null,
+  });
+  log('vv', 'TaskManager address set in ACL', 2);
+
   // 5b. ACP (ACP V3): default revoker (verification is inherited by the ACL)
   const acpRevokerAddress = await deployVariable(ctx, 'ACPTimestampRevoker', []);
   logDeployment('ACPTimestampRevoker', acpRevokerAddress);
@@ -140,7 +174,7 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
   // 6. Set ZkVerifier signer (the key is well-known and shared with the SDK)
   const verifierSigner = privateKeyToAccount(MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY);
   await ctx.walletClient.writeContract({
-    address: TASK_MANAGER_ADDRESS,
+    address: MOCKS_TASK_MANAGER_ADDRESS,
     abi: MockTaskManagerArtifact.abi,
     functionName: 'setVerifierSigner',
     args: [verifierSigner.address],
@@ -152,7 +186,7 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
   // 7. Set decrypt result signer
   const decryptSigner = privateKeyToAccount(MOCKS_DECRYPT_RESULT_SIGNER_PRIVATE_KEY);
   await ctx.walletClient.writeContract({
-    address: TASK_MANAGER_ADDRESS,
+    address: MOCKS_TASK_MANAGER_ADDRESS,
     abi: MockTaskManagerArtifact.abi,
     functionName: 'setDecryptResultSigner',
     args: [decryptSigner.address],
@@ -187,7 +221,7 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
     address: MockThresholdNetworkArtifact.fixedAddress as `0x${string}`,
     abi: MockThresholdNetworkArtifact.abi,
     functionName: 'initialize',
-    args: [TASK_MANAGER_ADDRESS, aclAddress],
+    args: [MOCKS_TASK_MANAGER_ADDRESS, aclAddress],
     account,
     chain: null,
   });
@@ -197,8 +231,8 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
   if (gasWarning) {
     logEmpty('v');
     logWarning(
-      'When using mocks, FHE operations report a higher gas price due to on-chain mocking logic. ' +
-        'Deploy your contracts on a testnet to check true gas costs.\n' +
+      'When using mocks, FHE operations consume extra gas replicating off-chain CoFHE work on-chain. ' +
+        "Use conn.cofhe.getAdjustedGasUsed(receipt) or set 'cofhe.gasSummary: true' to see gas numbers with that overhead excluded.\n" +
         "(Disable this warning by setting 'cofhe.gasWarning: false' in your Hardhat config)",
       0
     );
@@ -207,7 +241,8 @@ export async function deployMocks(ctx: DeployContext, options: DeployMocksArgs =
   logEmpty('v');
 
   return {
-    MockTaskManager: TASK_MANAGER_ADDRESS,
+    MockCoFHEAddressBook: COFHE_ADDRESS_BOOK_ADDRESS,
+    MockTaskManager: MOCKS_TASK_MANAGER_ADDRESS,
     MockACL: aclAddress,
     ACPTimestampRevoker: acpRevokerAddress,
     ACPShareRegistry: acpShareRegistryAddress,