@cofhe/hardhat-plugin 0.4.0 → 0.5.0

package/src/index.ts

@@ -1,9 +1,11 @@
 /* eslint-disable no-empty-pattern */
 /* eslint-disable turbo/no-undeclared-env-vars */
 import chalk from 'chalk';
+import path from 'path';
+import fs from 'fs';
 import { type PublicClient, type WalletClient } from 'viem';
-import { extendConfig, extendEnvironment, task, types } from 'hardhat/config';
-import { TASK_TEST, TASK_NODE } from 'hardhat/builtin-tasks/task-names';
+import { extendConfig, extendEnvironment, task, subtask, types } from 'hardhat/config';
+import { TASK_TEST, TASK_NODE, TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS } from 'hardhat/builtin-tasks/task-names';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
 import {
   type CofheClient,
@@ -16,13 +18,12 @@ import { HardhatSignerAdapter } from '@cofhe/sdk/adapters';
 
 import { localcofheFundAccount } from './fund.js';
 import { TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET } from './consts.js';
-import { deployMocks, type DeployMocksArgs } from './deploy.js';
+import { deployMocks, type DeployMocksArgs, type LogMocksDeploy } from './deploy.js';
 import { mock_setLoggingEnabled, mock_withLogs } from './logging.js';
 import { getFixedMockContract, mock_expectPlaintext } from './utils.js';
 import { mock_getPlaintext } from './utils.js';
 import { hardhat } from '@cofhe/sdk/chains';
 import {
-  MockACLArtifact,
   MockThresholdNetworkArtifact,
   MockTaskManagerArtifact,
   MockZkVerifierArtifact,
@@ -45,6 +46,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;
     };
   }
 
@@ -54,10 +62,77 @@ declare module 'hardhat/types/config' {
       logMocks: boolean;
       /** Whether to show gas usage warnings for mock operations (default: true) */
       gasWarning: boolean;
+      mocksDeployVerbosity: LogMocksDeploy;
     };
   }
 }
 
+const MOCK_STUBS_DIR_NAME = 'cofhe-stubs';
+const MOCK_STUBS_FILE_NAME = 'CofheMocksImports.sol';
+
+/**
+ * Returns the absolute paths of every .sol file shipped inside the
+ * @cofhe/mock-contracts/contracts directory.
+ */
+function getMockContractsSolFiles(): string[] {
+  let contractsDir: string;
+  try {
+    const pkgJson = require.resolve('@cofhe/mock-contracts/package.json');
+    contractsDir = path.join(path.dirname(pkgJson), 'contracts');
+  } catch {
+    contractsDir = path.join(process.cwd(), 'node_modules', '@cofhe', 'mock-contracts', 'contracts');
+  }
+
+  if (!fs.existsSync(contractsDir)) {
+    return [];
+  }
+
+  return fs
+    .readdirSync(contractsDir)
+    .filter((f) => f.endsWith('.sol'))
+    .map((f) => path.join(contractsDir, f));
+}
+
+/**
+ * Generates a stub Solidity file that imports every contract from
+ * @cofhe/mock-contracts/contracts.  Writing it to the Hardhat cache directory
+ * (which is inside the project root) means:
+ *   - localPathToSourceName() accepts it (no HH1007)
+ *   - Hardhat resolves the npm-style "@cofhe/mock-contracts/..." imports
+ *     the same way it resolves any other node_modules dependency
+ *   - All mock contract artifacts end up in hre.artifacts, giving Hardhat
+ *     full ABI knowledge so it can decode reverts and traces
+ */
+function generateMockContractsStubContent(): string {
+  const imports = getMockContractsSolFiles()
+    .map((f) => `import "@cofhe/mock-contracts/contracts/${path.basename(f)}";`)
+    .join('\n');
+
+  return [
+    '// SPDX-License-Identifier: UNLICENSED',
+    '// Auto-generated by @cofhe/hardhat-plugin — 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');
+}
+
+subtask(TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS).setAction(async (taskArgs: { sourcePath?: string }, hre, runSuper) => {
+  const existing: string[] = await runSuper(taskArgs);
+
+  // Write the stub inside the Hardhat cache dir so that it lives within the
+  // project root — a requirement of localPathToSourceName (HH1007).
+  const stubDir = path.join(hre.config.paths.cache, MOCK_STUBS_DIR_NAME);
+  const stubPath = path.join(stubDir, MOCK_STUBS_FILE_NAME);
+  fs.mkdirSync(stubDir, { recursive: true });
+  fs.writeFileSync(stubPath, generateMockContractsStubContent(), 'utf8');
+
+  return [...new Set([...existing, stubPath])];
+});
+
 extendConfig((config, userConfig) => {
   // Allow users to override the localcofhe network config
   if (userConfig.networks && userConfig.networks.localcofhe) {
@@ -110,8 +185,9 @@ extendConfig((config, userConfig) => {
 
   // Add cofhe config
   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') as LogMocksDeploy,
   };
 });
 
@@ -148,12 +224,11 @@ task(TASK_COFHE_USE_FAUCET, 'Fund an account from the funder')
 
 task(TASK_COFHE_MOCKS_DEPLOY, 'Deploys the mock contracts on the Hardhat network')
   .addOptionalParam('deployTestBed', 'Whether to deploy the test bed', true, types.boolean)
-  .addOptionalParam('silent', 'Whether to suppress output', false, types.boolean)
-  .setAction(async ({ deployTestBed, silent }: DeployMocksArgs, hre) => {
+  .setAction(async ({ deployTestBed }: DeployMocksArgs, hre) => {
     await deployMocks(hre, {
       deployTestBed: deployTestBed ?? true,
       gasWarning: hre.config.cofhe.gasWarning ?? true,
-      silent: silent ?? false,
+      mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity,
     });
   });
 
@@ -169,6 +244,7 @@ task(TASK_TEST, 'Deploy mock contracts on hardhat').setAction(async ({}, hre, ru
     await deployMocks(hre, {
       deployTestBed: true,
       gasWarning: hre.config.cofhe.gasWarning ?? true,
+      mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity,
     });
   }
   return runSuper();
@@ -185,6 +261,7 @@ task(TASK_NODE, 'Deploy mock contracts on hardhat').setAction(async ({}, hre, ru
     await deployMocks(hre, {
       deployTestBed: true,
       gasWarning: hre.config.cofhe.gasWarning ?? true,
+      mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity,
     });
   }
   return runSuper();
@@ -438,7 +515,7 @@ extendEnvironment((hre) => {
         return mock_setLoggingEnabled(hre, false);
       },
       deployMocks: async (options: DeployMocksArgs = {}) => {
-        return deployMocks(hre, options);
+        return deployMocks(hre, { mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity, ...options });
       },
       getPlaintext: async (ctHash: bigint | string) => {
         const [signer] = await hre.ethers.getSigners();
@@ -453,7 +530,8 @@ extendEnvironment((hre) => {
       getMockACL: async () => {
         const taskManager = await getFixedMockContract(hre, MockTaskManagerArtifact);
         const aclAddress = await taskManager.acl();
-        return hre.ethers.getContractAt(MockACLArtifact.abi, aclAddress) as unknown as MockACL;
+        const aclArtifact = await hre.artifacts.readArtifact('MockACL');
+        return hre.ethers.getContractAt(aclArtifact.abi, aclAddress) as unknown as MockACL;
       },
       getMockThresholdNetwork: async () =>
         getFixedMockContract(hre, MockThresholdNetworkArtifact) as unknown as Promise<MockThresholdNetwork>,

package/src/logging.ts

@@ -59,11 +59,14 @@ export const mock_withLogs = async (
 
   await setLoggingEnabled(hre, true);
   printLogsEnabledMessage(`"${chalk.bold(closureName)}" logs:`);
-  await closure();
-  printLogsBlockEnd();
+  try {
+    await closure();
+  } finally {
+    printLogsBlockEnd();
 
-  // If logs were disabled, disable them again
-  if (!initiallyEnabled) {
-    await setLoggingEnabled(hre, false);
+    // If logs were disabled, disable them again
+    if (!initiallyEnabled) {
+      await setLoggingEnabled(hre, false);
+    }
   }
 };

package/src/utils.ts

@@ -7,20 +7,22 @@ import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 
 // Deployment utils
 
-/// Deploys a mock contract from a pre-built artifact from the mock-contracts package
-/// If the mock contract should be deployed to a fixed address, `hardhat_setCode` op is used to set the code at the fixed address
-/// Otherwise, we deploy the contract using ethers.js to a non-fixed address
+/// Deploys a mock contract from a pre-built artifact from the mock-contracts package.
+/// ABI and bytecode are sourced from Hardhat's artifact registry (populated during compilation)
+/// so that Hardhat can decode reverts and trace calls against these contracts.
+/// If the mock contract should be deployed to a fixed address, `hardhat_setCode` is used.
+/// Otherwise, ethers.js deploys it to a normal address.
 export const deployMockContractFromArtifact = async (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => {
-  // Use hardhat_setCode to deploy to fixed address
+  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);
   }
 
-  // Use ethers.js to deploy to variable address
   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 as Contract;
 };
@@ -29,7 +31,8 @@ export const getFixedMockContract = async (hre: HardhatRuntimeEnvironment, artif
   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);
 };
 
 // Testing utils