@cofhe/hardhat-plugin 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @cofhe/hardhat-plugin Changelog
 
+## 0.5.0
+
+### Minor Changes
+
+- f78beb7: Add `@cofhe/hardhat-3-plugin` and `@cofhe/foundry-plugin` packages.
+
+  **`@cofhe/hardhat-3-plugin`** — Hardhat 3 plugin with the same mock contract deployment, `network.cofhe` API, logging, and faucet task as the v2 plugin, adapted to the Hardhat 3 plugin/hook model.
+
+  **`@cofhe/foundry-plugin`** — Foundry test utilities: `CofheTest` base contract (`deployMocks`, `expectPlaintext`, `getPlaintext`) and `CofheClient` SDK mock (`connect`, `createInE*`, `decryptForTx`, `decryptForView`, permits). Usable as a git submodule or npm package, with `remappings.txt` for Hardhat 3 Solidity test compatibility.
+
+  **`mocksDeployVerbosity` config option** added to both Hardhat plugins:
+
+  - `''` — silent
+  - `'v'` — single summary line (new default)
+  - `'vv'` — full per-contract deployment logs (previous default behavior)
+
+- 50bb3e4: Decode custom errors from deployed mock contracts by name instead of raw hex selectors.
+
+  **`@cofhe/mock-contracts`**
+
+  - Replaced transient storage (`tstore`/`tload`) in `MockACL.sol` with block-number-based storage, removing the EVM `cancun` requirement and lowering the Solidity pragma to `>=0.8.19`.
+  - Removed `bytecode` and `deployedBytecode` fields from published artifacts — they are now sourced at runtime from Hardhat's own compilation output.
+
+  **`@cofhe/hardhat-plugin`**
+
+  - Overrides `TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS` to inject a stub file that imports all mock contracts, so Hardhat compiles them and registers their artifacts. This lets the Hardhat network decode mock contract custom errors by name (e.g. `PermissionInvalid_Expired`) rather than raw hex.
+  - Deployment bytecode is now fetched from `hre.artifacts.readArtifact()` instead of the pre-built artifact bundle.
+
+  **`@cofhe/hardhat-3-plugin`**
+
+  - Calls `hre.solidity.build()` during the `hre.created` hook to compile mock contracts once at startup, enabling the EDR to decode their custom errors by name.
+  - `deployFixed` and `deployVariable` now source bytecode from `hre.artifacts.readArtifact()`, ensuring the deployed bytecode matches Hardhat's build info — which is required for error decoding on variable-address contracts like `MockACL`.
+
+### Patch Changes
+
+- a685cd4: **Breaking change: upgraded to tfhe v1.5.3.**
+  Previous cofhesdk versions will no longer function.
+- Updated dependencies [6c4084f]
+- Updated dependencies [50bb3e4]
+- Updated dependencies [788a6e2]
+- Updated dependencies [9a06012]
+- Updated dependencies [503536a]
+- Updated dependencies [a685cd4]
+  - @cofhe/sdk@0.5.0
+  - @cofhe/mock-contracts@0.5.0
+
 ## 0.4.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -7,10 +7,17 @@ import * as ethers from 'ethers';
 import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
 
+/**
+ * Controls deploy-mocks console output.
+ * - `''`   — silent, no output
+ * - `'v'`  — single summary line (default)
+ * - `'vv'` — full per-contract deployment logs
+ */
+type LogMocksDeploy = '' | 'v' | 'vv';
 type DeployMocksArgs = {
     deployTestBed?: boolean;
     gasWarning?: boolean;
-    silent?: boolean;
+    mocksDeployVerbosity?: LogMocksDeploy;
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => Promise<void>;
 
@@ -54,6 +61,13 @@ declare module 'hardhat/types/config' {
             logMocks?: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning?: boolean;
+            /**
+             * Controls deploy-mocks console output.
+             * - `''`   — silent, no output
+             * - `'v'`  — single summary line (default)
+             * - `'vv'` — full per-contract deployment logs
+             */
+            mocksDeployVerbosity?: LogMocksDeploy;
         };
     }
     interface HardhatConfig {
@@ -62,6 +76,7 @@ declare module 'hardhat/types/config' {
             logMocks: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning: boolean;
+            mocksDeployVerbosity: LogMocksDeploy;
         };
     }
 }
@@ -211,4 +226,4 @@ declare module 'hardhat/types/runtime' {
  */
 declare function buildHardhatPluginMocksConfig(mocksConfig: CofheInputConfig['mocks']): NonNullable<CofheInputConfig['mocks']>;
 
-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 };
+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 };

package/dist/index.d.ts

@@ -7,10 +7,17 @@ import * as ethers from 'ethers';
 import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
 
+/**
+ * Controls deploy-mocks console output.
+ * - `''`   — silent, no output
+ * - `'v'`  — single summary line (default)
+ * - `'vv'` — full per-contract deployment logs
+ */
+type LogMocksDeploy = '' | 'v' | 'vv';
 type DeployMocksArgs = {
     deployTestBed?: boolean;
     gasWarning?: boolean;
-    silent?: boolean;
+    mocksDeployVerbosity?: LogMocksDeploy;
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => Promise<void>;
 
@@ -54,6 +61,13 @@ declare module 'hardhat/types/config' {
             logMocks?: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning?: boolean;
+            /**
+             * Controls deploy-mocks console output.
+             * - `''`   — silent, no output
+             * - `'v'`  — single summary line (default)
+             * - `'vv'` — full per-contract deployment logs
+             */
+            mocksDeployVerbosity?: LogMocksDeploy;
         };
     }
     interface HardhatConfig {
@@ -62,6 +76,7 @@ declare module 'hardhat/types/config' {
             logMocks: boolean;
             /** Whether to show gas usage warnings for mock operations (default: true) */
             gasWarning: boolean;
+            mocksDeployVerbosity: LogMocksDeploy;
         };
     }
 }
@@ -211,4 +226,4 @@ declare module 'hardhat/types/runtime' {
  */
 declare function buildHardhatPluginMocksConfig(mocksConfig: CofheInputConfig['mocks']): NonNullable<CofheInputConfig['mocks']>;
 
-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 };
+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 };

package/dist/index.js

@@ -47,6 +47,8 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 var import_chalk3 = __toESM(require("chalk"));
+var import_path = __toESM(require("path"));
+var import_fs = __toESM(require("fs"));
 var import_viem = require("viem");
 var import_config = require("hardhat/config");
 var import_task_names = require("hardhat/builtin-tasks/task-names");
@@ -125,15 +127,14 @@ var import_chai = require("chai");
 var import_ethers = require("ethers");
 var import_hardhat_ethers_provider = require("@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider");
 var deployMockContractFromArtifact = async (hre, artifact) => {
+  const hardhatArtifact = await hre.artifacts.readArtifact(artifact.contractName);
   if (artifact.isFixed) {
-    await hre.network.provider.send("hardhat_setCode", [artifact.fixedAddress, artifact.deployedBytecode]);
-    return getFixedMockContract(hre, artifact);
+    await hre.network.provider.send("hardhat_setCode", [artifact.fixedAddress, hardhatArtifact.deployedBytecode]);
+    return hre.ethers.getContractAt(hardhatArtifact.abi, artifact.fixedAddress);
   }
   const [signer] = await hre.ethers.getSigners();
-  const factory = new hre.ethers.ContractFactory(artifact.abi, artifact.bytecode, signer);
-  const contract = await factory.deploy(
-    /* constructor args */
-  );
+  const factory = new hre.ethers.ContractFactory(hardhatArtifact.abi, hardhatArtifact.bytecode, signer);
+  const contract = await factory.deploy();
   await contract.waitForDeployment();
   return contract;
 };
@@ -141,7 +142,8 @@ var getFixedMockContract = async (hre, artifact) => {
   if (!artifact.isFixed) {
     throw new Error("Artifact is not fixed");
   }
-  return await hre.ethers.getContractAt(artifact.abi, artifact.fixedAddress);
+  const hardhatArtifact = await hre.artifacts.readArtifact(artifact.contractName);
+  return hre.ethers.getContractAt(hardhatArtifact.abi, artifact.fixedAddress);
 };
 var mock_checkIsTestnet = async (fnName, provider) => {
   const bytecode = await provider.getCode(import_sdk.MOCKS_ZK_VERIFIER_ADDRESS);
@@ -186,50 +188,47 @@ var mock_expectPlaintext = async (provider, ctHash, expectedValue) => {
 var deployMocks = async (hre, options = {
   deployTestBed: true,
   gasWarning: true,
-  silent: false
+  mocksDeployVerbosity: "v"
 }) => {
+  verbosity = options.mocksDeployVerbosity ?? "v";
   const isHardhat = await getIsHardhat(hre);
   if (!isHardhat) {
-    logSuccess(`cofhe-hardhat-plugin - deploy mocks - skipped on non-hardhat network ${hre.network.name}`, 0);
+    log("v", `cofhe-hardhat-plugin - deploy mocks - skipped on non-hardhat network ${hre.network.name}`, 0);
     return;
   }
-  isSilent = options.silent ?? false;
-  logEmpty();
-  logSuccess(import_chalk.default.bold("cofhe-hardhat-plugin :: deploy mocks"), 0);
-  logEmpty();
+  await hre.run("compile", { quiet: true });
+  log("vv", import_chalk.default.bold("cofhe-hardhat-plugin :: deploy mocks"), 0);
   const taskManager = await deployMockTaskManager(hre);
   logDeployment("MockTaskManager", await taskManager.getAddress());
   const acl = await deployMockACL(hre);
   logDeployment("MockACL", await acl.getAddress());
   await linkTaskManagerAndACL(taskManager, acl);
-  logSuccess("ACL address set in TaskManager", 2);
+  log("vv", "ACL address set in TaskManager", 2);
   await setVerifierSigner(taskManager);
-  logSuccess("Verifier signer set", 2);
+  log("vv", "Verifier signer set", 2);
   await setDecryptResultSigner(taskManager);
-  logSuccess("Decrypt result signer set", 2);
+  log("vv", "Decrypt result signer set", 2);
   await fundZkVerifierSigner(hre);
-  logSuccess(`ZkVerifier signer (${import_sdk2.MOCKS_ZK_VERIFIER_SIGNER_ADDRESS}) funded`, 1);
+  log("vv", `ZkVerifier signer (${import_sdk2.MOCKS_ZK_VERIFIER_SIGNER_ADDRESS}) funded`, 1);
   const zkVerifierSignerBalance = await getZkVerifierSignerBalance(hre);
-  logSuccess(`ETH balance: ${zkVerifierSignerBalance.toString()}`, 2);
+  log("vv", `ETH balance: ${zkVerifierSignerBalance.toString()}`, 2);
   const zkVerifier = await deployMockZkVerifier(hre);
   logDeployment("MockZkVerifier", await zkVerifier.getAddress());
   const thresholdNetwork = await deployMockThresholdNetwork(hre, acl);
   logDeployment("MockThresholdNetwork", await thresholdNetwork.getAddress());
   if (options.deployTestBed) {
-    logSuccess("TestBed deployment enabled", 2);
     const testBed = await deployTestBedContract(hre);
     logDeployment("TestBed", await testBed.getAddress());
   }
-  logEmpty();
-  logSuccess(import_chalk.default.bold("cofhe-hardhat-plugin :: mocks deployed successfully"), 0);
+  log("v", import_chalk.default.bold("cofhe-hardhat-plugin :: mocks deployed"), 0);
   if (options.gasWarning) {
-    logEmpty();
+    logEmpty("v");
     logWarning(
-      "When using mocks, FHE operations (eg FHE.add / FHE.mul) report a higher gas price due to additional on-chain mocking logic. Deploy your contracts on a testnet chain to check the true gas costs.\n(Disable this warning by setting '@cofhe/sdk.gasWarning' to false in your hardhat config",
+      "When using mocks, FHE operations (eg FHE.add / FHE.mul) report a higher gas price due to additional on-chain mocking logic. Deploy your contracts on a testnet chain to check the true gas costs.\n(Disable this warning by setting 'cofhe.gasWarning: false' in your hardhat config)",
       0
     );
   }
-  logEmpty();
+  logEmpty("v");
 };
 var getIsHardhat = async (hre) => {
   return hre.network.name === "hardhat";
@@ -299,27 +298,31 @@ var deployMockThresholdNetwork = async (hre, acl) => {
 var deployTestBedContract = async (hre) => {
   return deployMockContractFromArtifact(hre, import_mock_contracts.TestBedArtifact);
 };
-var isSilent = false;
-var logEmpty = () => {
-  if (isSilent)
+var verbosity = "v";
+var log = (minVerbosity, message, indent = 1) => {
+  if (verbosity === "")
     return;
-  console.log("");
-};
-var logSuccess = (message, indent = 1) => {
-  if (isSilent)
+  if (minVerbosity === "vv" && verbosity !== "vv")
     return;
   console.log(import_chalk.default.green(`${"  ".repeat(indent)}\u2713 ${message}`));
 };
+var logEmpty = (minVerbosity = "v") => {
+  if (verbosity === "")
+    return;
+  if (minVerbosity === "vv" && verbosity !== "vv")
+    return;
+  console.log("");
+};
 var logWarning = (message, indent = 1) => {
-  if (isSilent)
+  if (verbosity === "")
     return;
   console.log(import_chalk.default.bold(import_chalk.default.yellow(`${"  ".repeat(indent)}\u26A0 NOTE:`)), message);
 };
 var logDeployment = (contractName, address) => {
-  if (isSilent)
+  if (verbosity !== "vv")
     return;
   const paddedName = `${contractName} deployed`.padEnd(36);
-  logSuccess(`${paddedName} ${import_chalk.default.bold(address)}`);
+  console.log(import_chalk.default.green(`  \u2713 ${paddedName} ${import_chalk.default.bold(address)}`));
 };
 
 // src/logging.ts
@@ -361,16 +364,55 @@ var mock_withLogs = async (hre, closureName, closure) => {
   const initiallyEnabled = await getLoggingEnabled(hre);
   await setLoggingEnabled(hre, true);
   printLogsEnabledMessage(`"${import_chalk2.default.bold(closureName)}" logs:`);
-  await closure();
-  printLogsBlockEnd();
-  if (!initiallyEnabled) {
-    await setLoggingEnabled(hre, false);
+  try {
+    await closure();
+  } finally {
+    printLogsBlockEnd();
+    if (!initiallyEnabled) {
+      await setLoggingEnabled(hre, false);
+    }
   }
 };
 
 // src/index.ts
 var import_chains = require("@cofhe/sdk/chains");
 var import_mock_contracts3 = require("@cofhe/mock-contracts");
+var MOCK_STUBS_DIR_NAME = "cofhe-stubs";
+var MOCK_STUBS_FILE_NAME = "CofheMocksImports.sol";
+function getMockContractsSolFiles() {
+  let contractsDir;
+  try {
+    const pkgJson = require.resolve("@cofhe/mock-contracts/package.json");
+    contractsDir = import_path.default.join(import_path.default.dirname(pkgJson), "contracts");
+  } catch {
+    contractsDir = import_path.default.join(process.cwd(), "node_modules", "@cofhe", "mock-contracts", "contracts");
+  }
+  if (!import_fs.default.existsSync(contractsDir)) {
+    return [];
+  }
+  return import_fs.default.readdirSync(contractsDir).filter((f) => f.endsWith(".sol")).map((f) => import_path.default.join(contractsDir, f));
+}
+function generateMockContractsStubContent() {
+  const imports = getMockContractsSolFiles().map((f) => `import "@cofhe/mock-contracts/contracts/${import_path.default.basename(f)}";`).join("\n");
+  return [
+    "// SPDX-License-Identifier: UNLICENSED",
+    "// Auto-generated by @cofhe/hardhat-plugin \u2014 do not edit.",
+    "// Importing mock contracts here causes Hardhat to compile them and register",
+    "// their artifacts, enabling proper revert decoding during tests.",
+    "pragma solidity >=0.8.25 <0.9.0;",
+    "",
+    imports,
+    ""
+  ].join("\n");
+}
+(0, import_config.subtask)(import_task_names.TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS).setAction(async (taskArgs, hre, runSuper) => {
+  const existing = await runSuper(taskArgs);
+  const stubDir = import_path.default.join(hre.config.paths.cache, MOCK_STUBS_DIR_NAME);
+  const stubPath = import_path.default.join(stubDir, MOCK_STUBS_FILE_NAME);
+  import_fs.default.mkdirSync(stubDir, { recursive: true });
+  import_fs.default.writeFileSync(stubPath, generateMockContractsStubContent(), "utf8");
+  return [.../* @__PURE__ */ new Set([...existing, stubPath])];
+});
 (0, import_config.extendConfig)((config, userConfig) => {
   if (userConfig.networks && userConfig.networks.localcofhe) {
     return;
@@ -414,8 +456,9 @@ var import_mock_contracts3 = require("@cofhe/mock-contracts");
     };
   }
   config.cofhe = {
-    logMocks: userConfig.cofhe?.logMocks ?? true,
-    gasWarning: userConfig.cofhe?.gasWarning ?? true
+    logMocks: userConfig.cofhe?.logMocks ?? false,
+    gasWarning: userConfig.cofhe?.gasWarning ?? false,
+    mocksDeployVerbosity: userConfig.cofhe?.mocksDeployVerbosity ?? "v"
   };
 });
 (0, import_config.task)(TASK_COFHE_USE_FAUCET, "Fund an account from the funder").addOptionalParam("address", "Address to fund", void 0, import_config.types.string).setAction(async ({ address }, hre) => {
@@ -436,11 +479,11 @@ var import_mock_contracts3 = require("@cofhe/mock-contracts");
     console.info(import_chalk3.default.red(`failed to get funds from localcofhe for ${address}: ${e}`));
   }
 });
-(0, import_config.task)(TASK_COFHE_MOCKS_DEPLOY, "Deploys the mock contracts on the Hardhat network").addOptionalParam("deployTestBed", "Whether to deploy the test bed", true, import_config.types.boolean).addOptionalParam("silent", "Whether to suppress output", false, import_config.types.boolean).setAction(async ({ deployTestBed, silent }, hre) => {
+(0, import_config.task)(TASK_COFHE_MOCKS_DEPLOY, "Deploys the mock contracts on the Hardhat network").addOptionalParam("deployTestBed", "Whether to deploy the test bed", true, import_config.types.boolean).setAction(async ({ deployTestBed }, hre) => {
   await deployMocks(hre, {
     deployTestBed: deployTestBed ?? true,
     gasWarning: hre.config.cofhe.gasWarning ?? true,
-    silent: silent ?? false
+    mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity
   });
 });
 (0, import_config.task)(import_task_names.TASK_TEST, "Deploy mock contracts on hardhat").setAction(async ({}, hre, runSuper) => {
@@ -452,7 +495,8 @@ var import_mock_contracts3 = require("@cofhe/mock-contracts");
   if (!skipAutoDeploy) {
     await deployMocks(hre, {
       deployTestBed: true,
-      gasWarning: hre.config.cofhe.gasWarning ?? true
+      gasWarning: hre.config.cofhe.gasWarning ?? true,
+      mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity
     });
   }
   return runSuper();
@@ -466,7 +510,8 @@ var import_mock_contracts3 = require("@cofhe/mock-contracts");
   if (!skipAutoDeploy) {
     await deployMocks(hre, {
       deployTestBed: true,
-      gasWarning: hre.config.cofhe.gasWarning ?? true
+      gasWarning: hre.config.cofhe.gasWarning ?? true,
+      mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity
     });
   }
   return runSuper();
@@ -532,7 +577,7 @@ function buildHardhatPluginMocksConfig(mocksConfig) {
         return mock_setLoggingEnabled(hre, false);
       },
       deployMocks: async (options = {}) => {
-        return deployMocks(hre, options);
+        return deployMocks(hre, { mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity, ...options });
       },
       getPlaintext: async (ctHash) => {
         const [signer] = await hre.ethers.getSigners();
@@ -546,7 +591,8 @@ function buildHardhatPluginMocksConfig(mocksConfig) {
       getMockACL: async () => {
         const taskManager = await getFixedMockContract(hre, import_mock_contracts3.MockTaskManagerArtifact);
         const aclAddress = await taskManager.acl();
-        return hre.ethers.getContractAt(import_mock_contracts3.MockACLArtifact.abi, aclAddress);
+        const aclArtifact = await hre.artifacts.readArtifact("MockACL");
+        return hre.ethers.getContractAt(aclArtifact.abi, aclAddress);
       },
       getMockThresholdNetwork: async () => getFixedMockContract(hre, import_mock_contracts3.MockThresholdNetworkArtifact),
       getMockZkVerifier: async () => getFixedMockContract(hre, import_mock_contracts3.MockZkVerifierArtifact),