@cofhe/hardhat-plugin 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @cofhe/hardhat-plugin Changelog
 
+## 0.8.0
+
+### Minor Changes
+
+- 6f7a4c5: Resolve the Task Manager through the `CoFHEAddressBook` (`@fhenixprotocol/cofhe-contracts@1.0.0`). **Breaking:** `TASK_MANAGER_ADDRESS` is removed from `@cofhe/sdk`. Use `getTaskManagerAddress(publicClient)`, which reads `getTm(TASK_MANAGER_ID)` from the book at `COFHE_ADDRESS_BOOK_ADDRESS` (both exported) and caches the result per chain. If the chain has no book, or the id is unset, it throws `TASK_MANAGER_UNRESOLVED`. `verifyDecryptResult`, the ACL/ACP lookups and `useCofheEnabled` / `useCofheReadDecryptionResults` now resolve the Task Manager this way. `@cofhe/react` adds `useCofheTaskManagerAddress()`.
+
+  Mocks: a new `MockCoFHEAddressBook` is deployed at FHE.sol's `COFHE_ADDRESS_BOOK`, and `MockTaskManager` moves to `MOCKS_TASK_MANAGER_ADDRESS` (`0x…5000`) and is registered in the book. `MockACL` now stores its Task Manager (`setTaskManager` / `getTaskManagerAddress`) instead of reading a constant, so its `TASK_MANAGER_ADDRESS_()` getter is gone. All three plugins deploy and wire the book. Hardhat 2 exposes `hre.cofhe.mocks.getMockCoFHEAddressBook()`, Hardhat 3 exposes `conn.cofhe.mocks.MockCoFHEAddressBook`, and Foundry exposes `CofheTest.mockAddressBook`. Contracts must be built against `@fhenixprotocol/cofhe-contracts@1.0.0` or later (the hardhat plugin's peer range is now `>=1.0.0`). Each FHE op now makes one extra `getTm` call on the book, as it does on real networks, so expect slightly higher gas numbers.
+
+### Patch Changes
+
+- 38c34cd: The Hardhat 2 mock deployment now sets the same security zone range (`0..1`) on the mock TaskManager that the Hardhat 3 plugin uses, so inputs for security zone 1 no longer fail in Hardhat 2 mock tests.
+- 9f76f2b: Defining your own `networks.localcofhe` no longer skips the rest of the plugin's config setup. The Sepolia presets and `config.cofhe` are still applied, matching `@cofhe/hardhat-3-plugin`; previously reading `hre.config.cofhe` would crash.
+- b648307: `mock_getPlaintext`, `mock_getPlaintextExists` and `mock_expectPlaintext` now skip on non-mock networks as intended. The check compared `getCode`'s result to an empty string, but `eth_getCode` returns `"0x"` for an empty address, so on a real network these helpers called into the TaskManager and failed with an opaque error. It now matches `@cofhe/hardhat-3-plugin`.
+- ccb7b68: Realistic gas reporting for mocks. Under Foundry, mock-only work is now excluded from gas metering by default (opt out with `mockTaskManager.setMockGasExcluded(false)`), so expect `forge snapshot` numbers to drop. Under Hardhat, mock transactions emit `MockGasConsumed` events (extra receipt logs), and the plugins add `getAdjustedGasUsed(receipt)` / `getAdjustedGasBreakdown(receipt)` plus an opt-in `cofhe.gasSummary` report.
+- Updated dependencies [17ff23e]
+- Updated dependencies [0fe40c3]
+- Updated dependencies [6f7a4c5]
+- Updated dependencies [552d118]
+- Updated dependencies [22eebcc]
+- Updated dependencies [ccb7b68]
+- Updated dependencies [42fccae]
+  - @cofhe/sdk@0.8.0
+  - @cofhe/mock-contracts@0.8.0
+
+## 0.7.1
+
+### Patch Changes
+
+- e907d8c: **Pin `@fhenixprotocol/cofhe-contracts` to the stable `0.2.0`.** 0.7.0 shipped against the
+  `0.2.0-beta.3` prerelease; `0.2.0` is now released and is what `fhenix-confidential-contracts@0.4.0`
+  depends on exactly, so keeping the beta pin resolved two copies of `FHE.sol` in any project using
+  both. Nothing consumer-facing is removed between the two — `isAllowed` becomes `view` (which the
+  mocks already were), and `FHE.div`/`rem` on `euint64` plus `FHE.mul`/`div`/`rem`/`square` on
+  `euint128` are added. The `@cofhe/hardhat-plugin` peer range moves to `>=0.2.0`.
+- Updated dependencies [e907d8c]
+  - @cofhe/mock-contracts@0.7.1
+  - @cofhe/sdk@0.7.1
+
 ## 0.7.0
 
 ### Minor Changes

package/README.md

@@ -25,7 +25,9 @@ import '@cofhe/hardhat-plugin';
 module.exports = {
   // ... other config
   cofhe: {
-    logMocks: true, // Optional: Set to true to log mock operations
+    logMocks: true, // Optional: Log mock FHE operations to the console (default: false)
+    gasSummary: true, // Optional: Print a per-method adjusted-gas summary after tests (default: false)
+    gasWarning: false, // Optional: Warn that mock gas differs from live FHE (default: false)
   },
   // Network configuration is automatically added by the plugin
 };
@@ -45,6 +47,7 @@ This plugin uses [@cofhe/mock-contracts](https://github.com/FhenixProtocol/cofhe
 
 The mock contracts include:
 
+- MockCoFHEAddressBook: Resolves the TaskManager for FHE.sol, deployed at FHE.sol's `COFHE_ADDRESS_BOOK`
 - MockTaskManager: Manages FHE operations and stores plaintext values
 - MockThresholdNetwork: Handles decryption requests
 - MockZkVerifier: Simulates verification of encrypted inputs
@@ -57,6 +60,44 @@ Key differences from the real CoFHE system:
 - Decryption operations are simulated with mock delays
 - Operations are logged using hardhat/console.sol
 
+### Gas Reporting
+
+The on-chain replication of off-chain FHE work makes mock transactions consume more gas than they would on a real CoFHE network. The mock task manager measures this overhead and emits a `MockGasConsumed(uint256)` event for every block of mock-only work, so the plugin can report corrected numbers:
+
+```typescript
+const tx = await myContract.doFheThings();
+const receipt = await tx.wait();
+
+// Gas usage excluding mock overhead — an estimate of real-network cost.
+const adjusted = hre.cofhe.getAdjustedGasUsed(receipt);
+
+// Or the full breakdown:
+const { gasUsed, mockGas, adjustedGasUsed, mockGasEvents } = hre.cofhe.getAdjustedGasBreakdown(receipt);
+```
+
+Both are pure functions of the receipt (no RPC calls). On a real network the receipt carries no mock events, so `adjustedGasUsed` equals `gasUsed` — the same code works everywhere.
+
+To get a per-method overview after every test run, enable the summary table in your config:
+
+```typescript
+cofhe: {
+  gasSummary: true,
+}
+```
+
+```
+[COFHE-MOCKS] Gas summary — adjusted ≈ cost excluding mock-only overhead
+┌──────────────────┬──────────────────────────┬───────┬─────────────────┬────────────────────┬───────────────┐
+│ Contract         │ Method                   │ Calls │ Avg gas (mocks) │ Avg gas (adjusted) │ Mock overhead │
+├──────────────────┼──────────────────────────┼───────┼─────────────────┼────────────────────┼───────────────┤
+│ MyFHEContract    │ storeEncrypted(uint256)  │ 11    │ 179,897         │ 141,482            │ 21%           │
+└──────────────────┴──────────────────────────┴───────┴─────────────────┴────────────────────┴───────────────┘
+```
+
+Note: `eth_estimateGas` is not adjusted — the mock work really does execute, so transactions still need the raw gas limit. Use a testnet for estimate-sensitive flows.
+
+The summary table is reconstructed from chain history after the run: transactions rolled back by `loadFixture` or `evm_snapshot`/`evm_revert` won't appear, and the table is best-effort after forced exits — use `getAdjustedGasUsed(receipt)` inside tests for exact per-transaction numbers.
+
 ### Mock Contracts Deployment
 
 Core mock contracts are automatically deployed when using the Hardhat network:

package/dist/index.d.mts

@@ -2,7 +2,7 @@ import { PublicClient, WalletClient } from 'viem';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
 import { CofheInputConfig, CofheConfig, CofheClient } from '@cofhe/sdk';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
-import { MockArtifact, MockTaskManager, MockACL, MockThresholdNetwork, MockZkVerifier } from '@cofhe/mock-contracts';
+import { MockArtifact, MockCoFHEAddressBook, MockTaskManager, MockACL, MockThresholdNetwork, MockZkVerifier } from '@cofhe/mock-contracts';
 import * as ethers from 'ethers';
 import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
@@ -20,6 +20,29 @@ type DeployMocksArgs = {
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => Promise<void>;
 
+declare const MOCK_GAS_CONSUMED_TOPIC: 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;
+declare const printMockGasSummary: (hre: HardhatRuntimeEnvironment) => 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";
@@ -60,6 +83,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).
+             * Reconstructed from chain history: transactions rolled back by loadFixture /
+             * evm_revert won't appear - use getAdjustedGasUsed(receipt) for exact numbers.
+             * (default: false)
+             */
+            gasSummary?: boolean;
             /**
              * Controls deploy-mocks console output.
              * - `''`   — silent, no output
@@ -75,6 +106,8 @@ declare module 'hardhat/types/config' {
             logMocks: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning: boolean;
+            /** Print a per-method adjusted-gas summary after `hardhat test` (default: false) */
+            gasSummary: boolean;
             mocksDeployVerbosity: LogMocksDeploy;
         };
     }
@@ -123,6 +156,24 @@ declare module 'hardhat/types/runtime' {
              * @returns {Promise<CofheClient>} The CoFHE client instance
              */
             createClientWithBatteries: (signer?: HardhatEthersSigner) => 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.
+             * @param {AdjustableGasReceipt} receipt - The transaction receipt (ethers or viem shape)
+             * @returns {bigint} gasUsed minus mock overhead
+             */
+            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.
+             * @param {AdjustableGasReceipt} receipt - The transaction receipt (ethers or viem shape)
+             * @returns {AdjustedGasBreakdown} The breakdown
+             */
+            getAdjustedGasBreakdown: (receipt: AdjustableGasReceipt) => AdjustedGasBreakdown;
             mocks: {
                 /**
                  * **[MOCKS ONLY]**
@@ -189,6 +240,11 @@ declare module 'hardhat/types/runtime' {
                  * @param {bigint} expectedValue - The expected plaintext value
                  */
                 expectPlaintext: (ctHash: bigint | string, expectedValue: bigint) => Promise<void>;
+                /**
+                 * Get the MockCoFHEAddressBook contract (typed via typechain)
+                 * @returns {Promise<MockCoFHEAddressBook>} The MockCoFHEAddressBook contract
+                 */
+                getMockCoFHEAddressBook: () => Promise<MockCoFHEAddressBook>;
                 /**
                  * Get the MockTaskManager contract (typed via typechain)
                  * @returns {Promise<MockTaskManager>} The MockTaskManager contract
@@ -220,4 +276,4 @@ declare module 'hardhat/types/runtime' {
  */
 declare function buildHardhatPluginMocksConfig(mocksConfig: CofheInputConfig['mocks']): NonNullable<CofheInputConfig['mocks']>;
 
-export { type DeployMocksArgs, type LogMocksDeploy, 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 };
+export { type AdjustableGasReceipt, type AdjustedGasBreakdown, type DeployMocksArgs, type LogMocksDeploy, MOCK_GAS_CONSUMED_TOPIC, TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, buildHardhatPluginMocksConfig, deployMockContractFromArtifact, deployMocks, getFixedMockContract, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getAdjustedGasBreakdown, mock_getAdjustedGasUsed, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs, printMockGasSummary };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { PublicClient, WalletClient } from 'viem';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
 import { CofheInputConfig, CofheConfig, CofheClient } from '@cofhe/sdk';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
-import { MockArtifact, MockTaskManager, MockACL, MockThresholdNetwork, MockZkVerifier } from '@cofhe/mock-contracts';
+import { MockArtifact, MockCoFHEAddressBook, MockTaskManager, MockACL, MockThresholdNetwork, MockZkVerifier } from '@cofhe/mock-contracts';
 import * as ethers from 'ethers';
 import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
@@ -20,6 +20,29 @@ type DeployMocksArgs = {
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => Promise<void>;
 
+declare const MOCK_GAS_CONSUMED_TOPIC: 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;
+declare const printMockGasSummary: (hre: HardhatRuntimeEnvironment) => 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";
@@ -60,6 +83,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).
+             * Reconstructed from chain history: transactions rolled back by loadFixture /
+             * evm_revert won't appear - use getAdjustedGasUsed(receipt) for exact numbers.
+             * (default: false)
+             */
+            gasSummary?: boolean;
             /**
              * Controls deploy-mocks console output.
              * - `''`   — silent, no output
@@ -75,6 +106,8 @@ declare module 'hardhat/types/config' {
             logMocks: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning: boolean;
+            /** Print a per-method adjusted-gas summary after `hardhat test` (default: false) */
+            gasSummary: boolean;
             mocksDeployVerbosity: LogMocksDeploy;
         };
     }
@@ -123,6 +156,24 @@ declare module 'hardhat/types/runtime' {
              * @returns {Promise<CofheClient>} The CoFHE client instance
              */
             createClientWithBatteries: (signer?: HardhatEthersSigner) => 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.
+             * @param {AdjustableGasReceipt} receipt - The transaction receipt (ethers or viem shape)
+             * @returns {bigint} gasUsed minus mock overhead
+             */
+            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.
+             * @param {AdjustableGasReceipt} receipt - The transaction receipt (ethers or viem shape)
+             * @returns {AdjustedGasBreakdown} The breakdown
+             */
+            getAdjustedGasBreakdown: (receipt: AdjustableGasReceipt) => AdjustedGasBreakdown;
             mocks: {
                 /**
                  * **[MOCKS ONLY]**
@@ -189,6 +240,11 @@ declare module 'hardhat/types/runtime' {
                  * @param {bigint} expectedValue - The expected plaintext value
                  */
                 expectPlaintext: (ctHash: bigint | string, expectedValue: bigint) => Promise<void>;
+                /**
+                 * Get the MockCoFHEAddressBook contract (typed via typechain)
+                 * @returns {Promise<MockCoFHEAddressBook>} The MockCoFHEAddressBook contract
+                 */
+                getMockCoFHEAddressBook: () => Promise<MockCoFHEAddressBook>;
                 /**
                  * Get the MockTaskManager contract (typed via typechain)
                  * @returns {Promise<MockTaskManager>} The MockTaskManager contract
@@ -220,4 +276,4 @@ declare module 'hardhat/types/runtime' {
  */
 declare function buildHardhatPluginMocksConfig(mocksConfig: CofheInputConfig['mocks']): NonNullable<CofheInputConfig['mocks']>;
 
-export { type DeployMocksArgs, type LogMocksDeploy, 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 };
+export { type AdjustableGasReceipt, type AdjustedGasBreakdown, type DeployMocksArgs, type LogMocksDeploy, MOCK_GAS_CONSUMED_TOPIC, TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, buildHardhatPluginMocksConfig, deployMockContractFromArtifact, deployMocks, getFixedMockContract, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getAdjustedGasBreakdown, mock_getAdjustedGasUsed, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs, printMockGasSummary };