@cofhe/hardhat-plugin 0.7.1 → 1.0.0-alpha.0

package/dist/index.mjs

@@ -7,7 +7,7 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
 });
 
 // src/index.ts
-import chalk3 from "chalk";
+import chalk4 from "chalk";
 import path from "path";
 import fs from "fs";
 import "viem";
@@ -82,26 +82,28 @@ import "hardhat/types";
 import chalk from "chalk";
 import { Wallet } from "ethers";
 import {
+  MockCoFHEAddressBookArtifact,
   MockTaskManagerArtifact,
   MockACLArtifact,
   ACPTimestampRevokerArtifact,
   ACPShareRegistryArtifact,
+  MockERC1967ProxyArtifact,
   MockZkVerifierArtifact,
   MockThresholdNetworkArtifact
 } from "@cofhe/mock-contracts";
 import {
-  TASK_MANAGER_ADDRESS as TASK_MANAGER_ADDRESS2,
+  TASK_MANAGER_ID,
   MOCKS_ZK_VERIFIER_SIGNER_ADDRESS,
   MOCKS_DECRYPT_RESULT_SIGNER_PRIVATE_KEY,
   MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY
 } from "@cofhe/sdk";
 
 // src/utils.ts
-import { TASK_MANAGER_ADDRESS, MOCKS_ZK_VERIFIER_ADDRESS } from "@cofhe/sdk";
+import { MOCKS_TASK_MANAGER_ADDRESS, MOCKS_ZK_VERIFIER_ADDRESS } from "@cofhe/sdk";
 import { expect } from "chai";
 import { ethers } from "ethers";
 import "@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider";
-var deployMockContractFromArtifact = async (hre, artifact) => {
+var deployMockContractFromArtifact = async (hre, artifact, constructorArgs = []) => {
   const hardhatArtifact = await hre.artifacts.readArtifact(artifact.contractName);
   if (artifact.isFixed) {
     await hre.network.provider.send("hardhat_setCode", [artifact.fixedAddress, hardhatArtifact.deployedBytecode]);
@@ -109,7 +111,7 @@ var deployMockContractFromArtifact = async (hre, artifact) => {
   }
   const [signer] = await hre.ethers.getSigners();
   const factory = new hre.ethers.ContractFactory(hardhatArtifact.abi, hardhatArtifact.bytecode, signer);
-  const contract = await factory.deploy();
+  const contract = await factory.deploy(...constructorArgs);
   await contract.waitForDeployment();
   return contract;
 };
@@ -122,7 +124,7 @@ var getFixedMockContract = async (hre, artifact) => {
 };
 var mock_checkIsTestnet = async (fnName, provider) => {
   const bytecode = await provider.getCode(MOCKS_ZK_VERIFIER_ADDRESS);
-  const isTestnet = bytecode.length === 0;
+  const isTestnet = !bytecode || bytecode.length <= 2;
   if (isTestnet) {
     console.log(`${fnName} - skipped on non-testnet chain`);
   }
@@ -132,7 +134,7 @@ var mock_getPlaintext = async (provider, ctHash) => {
   if (await mock_checkIsTestnet(mock_getPlaintext.name, provider))
     return;
   const taskManager = new ethers.Contract(
-    TASK_MANAGER_ADDRESS,
+    MOCKS_TASK_MANAGER_ADDRESS,
     ["function mockStorage(uint256) view returns (uint256)"],
     provider
   );
@@ -143,7 +145,7 @@ var mock_getPlaintextExists = async (provider, ctHash) => {
   if (await mock_checkIsTestnet(mock_getPlaintextExists.name, provider))
     return;
   const taskManager = new ethers.Contract(
-    TASK_MANAGER_ADDRESS,
+    MOCKS_TASK_MANAGER_ADDRESS,
     ["function inMockStorage(uint256) view returns (bool)"],
     provider
   );
@@ -172,20 +174,30 @@ var deployMocks = async (hre, options = {
   }
   await hre.run("compile", { quiet: true });
   log("vv", chalk.bold("cofhe-hardhat-plugin :: deploy mocks"), 0);
+  const addressBook = await deployMockAddressBook(hre);
+  logDeployment("MockCoFHEAddressBook", await addressBook.getAddress());
   const taskManager = await deployMockTaskManager(hre);
   logDeployment("MockTaskManager", await taskManager.getAddress());
+  await registerTaskManager(addressBook, taskManager);
+  log("vv", "TaskManager registered in CoFHEAddressBook", 2);
   const acl = await deployMockACL(hre);
   logDeployment("MockACL", await acl.getAddress());
   const acpRevoker = await deployMockContractFromArtifact(hre, ACPTimestampRevokerArtifact);
   logDeployment("ACPTimestampRevoker", await acpRevoker.getAddress());
   await (await acl.setDefaultRevokerContract(await acpRevoker.getAddress())).wait();
   log("vv", "Default revoker contract set in ACL", 2);
-  const acpShareRegistry = await deployMockContractFromArtifact(hre, ACPShareRegistryArtifact);
+  const acpShareRegistryImpl = await deployMockContractFromArtifact(hre, ACPShareRegistryArtifact);
+  const [registryAdmin] = await hre.ethers.getSigners();
+  const acpShareRegistryProxy = await deployMockContractFromArtifact(hre, MockERC1967ProxyArtifact, [
+    await acpShareRegistryImpl.getAddress(),
+    acpShareRegistryImpl.interface.encodeFunctionData("initialize", [registryAdmin.address])
+  ]);
+  const acpShareRegistry = acpShareRegistryImpl.attach(await acpShareRegistryProxy.getAddress());
   logDeployment("ACPShareRegistry", await acpShareRegistry.getAddress());
   await (await acl.setShareRegistry(await acpShareRegistry.getAddress())).wait();
   log("vv", "Share registry set in ACL", 2);
   await linkTaskManagerAndACL(taskManager, acl);
-  log("vv", "ACL address set in TaskManager", 2);
+  log("vv", "ACL address set in TaskManager, TaskManager address set in ACL", 2);
   await setVerifierSigner(taskManager);
   log("vv", "Verifier signer set", 2);
   await setDecryptResultSigner(taskManager);
@@ -196,13 +208,13 @@ var deployMocks = async (hre, options = {
   log("vv", `ETH balance: ${zkVerifierSignerBalance.toString()}`, 2);
   const zkVerifier = await deployMockZkVerifier(hre);
   logDeployment("MockZkVerifier", await zkVerifier.getAddress());
-  const thresholdNetwork = await deployMockThresholdNetwork(hre, acl);
+  const thresholdNetwork = await deployMockThresholdNetwork(hre, taskManager, acl);
   logDeployment("MockThresholdNetwork", await thresholdNetwork.getAddress());
   log("v", chalk.bold("cofhe-hardhat-plugin :: mocks deployed"), 0);
   if (options.gasWarning) {
     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.gasWarning: false' in your hardhat config)",
+      "When using mocks, FHE operations (eg FHE.add / FHE.mul) consume extra gas replicating off-chain CoFHE work on-chain. Use hre.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
     );
   }
@@ -211,11 +223,25 @@ var deployMocks = async (hre, options = {
 var getIsHardhat = async (hre) => {
   return hre.network.name === "hardhat";
 };
+var deployMockAddressBook = async (hre) => {
+  const addressBook = await deployMockContractFromArtifact(hre, MockCoFHEAddressBookArtifact);
+  const bookExists = await addressBook.exists();
+  if (!bookExists) {
+    throw new Error("MockCoFHEAddressBook does not exist");
+  }
+  return addressBook;
+};
+var registerTaskManager = async (addressBook, taskManager) => {
+  const setTmTx = await addressBook.setTm(TASK_MANAGER_ID, await taskManager.getAddress());
+  await setTmTx.wait();
+};
 var deployMockTaskManager = async (hre) => {
   const [signer] = await hre.ethers.getSigners();
   const taskManager = await deployMockContractFromArtifact(hre, MockTaskManagerArtifact);
   const initTx = await taskManager.initialize(signer.address);
   await initTx.wait();
+  const securityZonesTx = await taskManager.setSecurityZones(0, 1);
+  await securityZonesTx.wait();
   const tmExists = await taskManager.exists();
   if (!tmExists) {
     throw new Error("MockTaskManager does not exist");
@@ -244,6 +270,8 @@ var linkTaskManagerAndACL = async (taskManager, acl) => {
   const aclAddress = await acl.getAddress();
   const linkAclTx = await taskManager.setACLContract(aclAddress);
   await linkAclTx.wait();
+  const linkTaskManagerTx = await acl.setTaskManager(await taskManager.getAddress());
+  await linkTaskManagerTx.wait();
 };
 var setVerifierSigner = async (taskManager) => {
   const signer = new Wallet(MOCKS_ZK_VERIFIER_SIGNER_PRIVATE_KEY);
@@ -263,9 +291,9 @@ var deployMockZkVerifier = async (hre) => {
   }
   return zkVerifier;
 };
-var deployMockThresholdNetwork = async (hre, acl) => {
+var deployMockThresholdNetwork = async (hre, taskManager, acl) => {
   const thresholdNetwork = await deployMockContractFromArtifact(hre, MockThresholdNetworkArtifact);
-  const initTx = await thresholdNetwork.initialize(TASK_MANAGER_ADDRESS2, await acl.getAddress());
+  const initTx = await thresholdNetwork.initialize(await taskManager.getAddress(), await acl.getAddress());
   await initTx.wait();
   const exists = await thresholdNetwork.exists();
   if (!exists) {
@@ -349,10 +377,159 @@ var mock_withLogs = async (hre, closureName, closure) => {
   }
 };
 
+// src/gas.ts
+import chalk3 from "chalk";
+import { ethers as ethers2 } from "ethers";
+import { MOCKS_TASK_MANAGER_ADDRESS as MOCKS_TASK_MANAGER_ADDRESS2 } from "@cofhe/sdk";
+var MOCK_GAS_CONSUMED_TOPIC = ethers2.id("MockGasConsumed(uint256)");
+var mock_getAdjustedGasBreakdown = (receipt) => {
+  let mockGas = 0n;
+  let mockGasEvents = 0;
+  for (const log2 of receipt.logs ?? []) {
+    if (log2.address.toLowerCase() === MOCKS_TASK_MANAGER_ADDRESS2.toLowerCase() && log2.topics[0] === MOCK_GAS_CONSUMED_TOPIC) {
+      mockGas += BigInt(log2.data);
+      mockGasEvents += 1;
+    }
+  }
+  const gasUsed = BigInt(receipt.gasUsed);
+  return { gasUsed, mockGas, adjustedGasUsed: mockGas > gasUsed ? 0n : gasUsed - mockGas, mockGasEvents };
+};
+var mock_getAdjustedGasUsed = (receipt) => mock_getAdjustedGasBreakdown(receipt).adjustedGasUsed;
+var shortAddress = (address) => `${address.slice(0, 6)}..${address.slice(-4)}`;
+var buildSelectorNameMap = async (hre) => {
+  const selectorNames = /* @__PURE__ */ new Map();
+  for (const fqn of await hre.artifacts.getAllFullyQualifiedNames()) {
+    try {
+      const artifact = await hre.artifacts.readArtifact(fqn);
+      const iface = new ethers2.Interface(artifact.abi);
+      iface.forEachFunction((fn) => {
+        if (!selectorNames.has(fn.selector))
+          selectorNames.set(fn.selector, fn.format("sighash"));
+      });
+    } catch {
+    }
+  }
+  return selectorNames;
+};
+var buildAddressNameMap = async (hre, addresses) => {
+  const codeToName = /* @__PURE__ */ new Map();
+  for (const fqn of await hre.artifacts.getAllFullyQualifiedNames()) {
+    try {
+      const artifact = await hre.artifacts.readArtifact(fqn);
+      if (artifact.deployedBytecode && artifact.deployedBytecode !== "0x") {
+        codeToName.set(artifact.deployedBytecode.toLowerCase(), artifact.contractName);
+      }
+    } catch {
+    }
+  }
+  const addressNames = /* @__PURE__ */ new Map();
+  for (const address of addresses) {
+    try {
+      const code = await hre.network.provider.send("eth_getCode", [address, "latest"]);
+      addressNames.set(address, codeToName.get(code.toLowerCase()) ?? shortAddress(address));
+    } catch {
+      addressNames.set(address, shortAddress(address));
+    }
+  }
+  return addressNames;
+};
+var printMockGasSummary = async (hre) => {
+  if (hre.network.name !== "hardhat")
+    return;
+  let logs;
+  try {
+    logs = await hre.network.provider.send("eth_getLogs", [
+      { fromBlock: "0x0", toBlock: "latest", address: MOCKS_TASK_MANAGER_ADDRESS2, topics: [MOCK_GAS_CONSUMED_TOPIC] }
+    ]);
+  } catch {
+    return;
+  }
+  if (!logs || logs.length === 0)
+    return;
+  const mockGasPerTx = /* @__PURE__ */ new Map();
+  for (const log2 of logs) {
+    mockGasPerTx.set(log2.transactionHash, (mockGasPerTx.get(log2.transactionHash) ?? 0n) + BigInt(log2.data));
+  }
+  const aggregates = /* @__PURE__ */ new Map();
+  for (const [txHash, mockGas] of mockGasPerTx) {
+    try {
+      const receipt = await hre.network.provider.send("eth_getTransactionReceipt", [txHash]);
+      const tx = await hre.network.provider.send("eth_getTransactionByHash", [txHash]);
+      if (!receipt)
+        continue;
+      const target = tx?.to ?? receipt.contractAddress;
+      if (!target)
+        continue;
+      const to = ethers2.getAddress(target);
+      const selector = tx?.to ? (tx.input ?? "0x").slice(0, 10) : "(deployment)";
+      const key = `${to}:${selector}`;
+      const aggregate = aggregates.get(key) ?? { to, selector, calls: 0, totalGasUsed: 0n, totalMockGas: 0n };
+      aggregate.calls += 1;
+      aggregate.totalGasUsed += BigInt(receipt.gasUsed);
+      aggregate.totalMockGas += mockGas;
+      aggregates.set(key, aggregate);
+    } catch {
+    }
+  }
+  if (aggregates.size === 0)
+    return;
+  const selectorNames = await buildSelectorNameMap(hre);
+  const addressNames = await buildAddressNameMap(hre, [...new Set([...aggregates.values()].map((a) => a.to))]);
+  const merged = /* @__PURE__ */ new Map();
+  for (const a of aggregates.values()) {
+    const contract = addressNames.get(a.to) ?? shortAddress(a.to);
+    const method = selectorNames.get(a.selector) ?? a.selector;
+    const key = `${contract}:${method}`;
+    const row = merged.get(key) ?? { contract, method, calls: 0, totalGasUsed: 0n, totalMockGas: 0n };
+    row.calls += a.calls;
+    row.totalGasUsed += a.totalGasUsed;
+    row.totalMockGas += a.totalMockGas;
+    merged.set(key, row);
+  }
+  const rows = [...merged.values()].map((r) => {
+    const avgGasUsed = r.totalGasUsed / BigInt(r.calls);
+    const avgMockGas = r.totalMockGas / BigInt(r.calls);
+    return {
+      contract: r.contract,
+      method: r.method,
+      calls: r.calls,
+      avgGasUsed,
+      avgAdjusted: avgMockGas > avgGasUsed ? 0n : avgGasUsed - avgMockGas,
+      overheadPct: avgGasUsed === 0n ? 0 : Math.min(100, Number(avgMockGas * 100n / avgGasUsed))
+    };
+  }).sort((a, b) => a.contract.localeCompare(b.contract) || a.method.localeCompare(b.method));
+  const headers = ["Contract", "Method", "Calls", "Avg gas (mocks)", "Avg gas (adjusted)", "Mock overhead"];
+  const cells = rows.map((r) => [
+    r.contract,
+    r.method,
+    String(r.calls),
+    r.avgGasUsed.toLocaleString(),
+    r.avgAdjusted.toLocaleString(),
+    `${r.overheadPct}%`
+  ]);
+  const widths = headers.map((h, i) => Math.max(h.length, ...cells.map((row) => row[i].length)));
+  const line = (row) => `\u2502 ${row.map((cell, i) => cell.padEnd(widths[i])).join(" \u2502 ")} \u2502`;
+  const divider = (l, m, r) => `${l}${widths.map((w) => "\u2500".repeat(w + 2)).join(m)}${r}`;
+  console.log("");
+  console.log(chalk3.bold("[COFHE-MOCKS] Gas summary") + chalk3.dim(" \u2014 adjusted \u2248 cost excluding mock-only overhead"));
+  console.log(divider("\u250C", "\u252C", "\u2510"));
+  console.log(line(headers));
+  console.log(divider("\u251C", "\u253C", "\u2524"));
+  for (const row of cells)
+    console.log(line(row));
+  console.log(divider("\u2514", "\u2534", "\u2518"));
+  console.log(
+    chalk3.dim(
+      "Raw numbers include on-chain replication of off-chain CoFHE work; adjusted numbers estimate real-network cost. estimateGas remains unadjusted."
+    )
+  );
+};
+
 // src/index.ts
 import { hardhat } from "@cofhe/sdk/chains";
 import {
   MockThresholdNetworkArtifact as MockThresholdNetworkArtifact2,
+  MockCoFHEAddressBookArtifact as MockCoFHEAddressBookArtifact2,
   MockTaskManagerArtifact as MockTaskManagerArtifact3,
   MockZkVerifierArtifact as MockZkVerifierArtifact2
 } from "@cofhe/mock-contracts";
@@ -393,23 +570,22 @@ subtask(TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS).setAction(async (taskArgs, hre,
   return [.../* @__PURE__ */ new Set([...existing, stubPath])];
 });
 extendConfig((config, userConfig) => {
-  if (userConfig.networks && userConfig.networks.localcofhe) {
-    return;
+  if (!userConfig.networks?.localcofhe) {
+    config.networks.localcofhe = {
+      gas: "auto",
+      gasMultiplier: 1.2,
+      gasPrice: "auto",
+      timeout: 1e4,
+      httpHeaders: {},
+      url: "http://127.0.0.1:42069",
+      accounts: [
+        "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
+        "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
+        "0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a",
+        "0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6"
+      ]
+    };
   }
-  config.networks.localcofhe = {
-    gas: "auto",
-    gasMultiplier: 1.2,
-    gasPrice: "auto",
-    timeout: 1e4,
-    httpHeaders: {},
-    url: "http://127.0.0.1:42069",
-    accounts: [
-      "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
-      "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
-      "0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a",
-      "0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6"
-    ]
-  };
   if (!userConfig.networks?.["eth-sepolia"]) {
     config.networks["eth-sepolia"] = {
       url: process.env.SEPOLIA_RPC_URL ?? "https://ethereum-sepolia.publicnode.com",
@@ -437,6 +613,7 @@ extendConfig((config, userConfig) => {
   config.cofhe = {
     logMocks: userConfig.cofhe?.logMocks ?? false,
     gasWarning: userConfig.cofhe?.gasWarning ?? false,
+    gasSummary: userConfig.cofhe?.gasSummary ?? false,
     mocksDeployVerbosity: userConfig.cofhe?.mocksDeployVerbosity ?? "v"
   };
 });
@@ -444,18 +621,18 @@ task(TASK_COFHE_USE_FAUCET, "Fund an account from the funder").addOptionalParam(
   const { network } = hre;
   const { name: networkName } = network;
   if (networkName !== "localcofhe") {
-    console.info(chalk3.yellow(`Programmatic faucet only supported for localcofhe`));
+    console.info(chalk4.yellow(`Programmatic faucet only supported for localcofhe`));
     return;
   }
   if (!address) {
-    console.info(chalk3.red(`Failed to get address to fund`));
+    console.info(chalk4.red(`Failed to get address to fund`));
     return;
   }
-  console.info(chalk3.green(`Getting funds from faucet for ${address}`));
+  console.info(chalk4.green(`Getting funds from faucet for ${address}`));
   try {
     await localcofheFundAccount(hre, address);
   } catch (e) {
-    console.info(chalk3.red(`failed to get funds from localcofhe for ${address}: ${e}`));
+    console.info(chalk4.red(`failed to get funds from localcofhe for ${address}: ${e}`));
   }
 });
 task(TASK_COFHE_MOCKS_DEPLOY, "Deploys the mock contracts on the Hardhat network").setAction(
@@ -478,7 +655,11 @@ task(TASK_TEST, "Deploy mock contracts on hardhat").setAction(async ({}, hre, ru
       mocksDeployVerbosity: hre.config.cofhe.mocksDeployVerbosity
     });
   }
-  return runSuper();
+  const result = await runSuper();
+  if (hre.config.cofhe.gasSummary) {
+    await printMockGasSummary(hre);
+  }
+  return result;
 });
 task(TASK_NODE, "Deploy mock contracts on hardhat").setAction(async ({}, hre, runSuper) => {
   const skipAutoDeploy = (() => {
@@ -544,6 +725,8 @@ extendEnvironment((hre) => {
       });
       return client;
     },
+    getAdjustedGasUsed: mock_getAdjustedGasUsed,
+    getAdjustedGasBreakdown: mock_getAdjustedGasBreakdown,
     mocks: {
       withLogs: async (closureName, closure) => {
         return mock_withLogs(hre, closureName, closure);
@@ -565,6 +748,7 @@ extendEnvironment((hre) => {
         const [signer] = await hre.ethers.getSigners();
         return mock_expectPlaintext(signer.provider, ctHash, expectedValue);
       },
+      getMockCoFHEAddressBook: async () => getFixedMockContract(hre, MockCoFHEAddressBookArtifact2),
       getMockTaskManager: async () => getFixedMockContract(hre, MockTaskManagerArtifact3),
       getMockACL: async () => {
         const taskManager = await getFixedMockContract(hre, MockTaskManagerArtifact3);
@@ -578,6 +762,7 @@ extendEnvironment((hre) => {
   };
 });
 export {
+  MOCK_GAS_CONSUMED_TOPIC,
   TASK_COFHE_MOCKS_DEPLOY,
   TASK_COFHE_MOCKS_SET_LOG_OPS,
   TASK_COFHE_USE_FAUCET,
@@ -588,9 +773,12 @@ export {
   localcofheFundAccount,
   localcofheFundWalletIfNeeded,
   mock_expectPlaintext,
+  mock_getAdjustedGasBreakdown,
+  mock_getAdjustedGasUsed,
   mock_getPlaintext,
   mock_getPlaintextExists,
   mock_setLoggingEnabled,
-  mock_withLogs
+  mock_withLogs,
+  printMockGasSummary
 };
 //# sourceMappingURL=index.mjs.map