@cofhe/hardhat-plugin 0.1.0 → 0.2.0

package/src/index.ts

@@ -0,0 +1,439 @@
+/* eslint-disable no-empty-pattern */
+/* eslint-disable turbo/no-undeclared-env-vars */
+import chalk from 'chalk';
+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 { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
+import {
+  MOCKS_ZK_VERIFIER_SIGNER_ADDRESS,
+  type CofhesdkClient,
+  type CofhesdkConfig,
+  type CofhesdkInputConfig,
+} from '@cofhe/sdk';
+import { createCofhesdkClient, createCofhesdkConfig } from '@cofhe/sdk/node';
+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 { mock_setLoggingEnabled, mock_withLogs } from './logging.js';
+import { mock_expectPlaintext } from './utils.js';
+import { mock_getPlaintext } from './utils.js';
+import type { Contract } from 'ethers';
+import {
+  MockACLArtifact,
+  MockQueryDecrypterArtifact,
+  MockTaskManagerArtifact,
+  MockZkVerifierArtifact,
+  TestBedArtifact,
+} from '@cofhe/mock-contracts';
+import { hardhat } from '@cofhe/sdk/chains';
+export {
+  MockACLArtifact,
+  MockQueryDecrypterArtifact,
+  MockTaskManagerArtifact,
+  MockZkVerifierArtifact,
+  TestBedArtifact,
+} from '@cofhe/mock-contracts';
+
+/**
+ * Configuration interface for the CoFHE Hardhat plugin.
+ * Allows users to configure mock logging and gas warning settings.
+ */
+declare module 'hardhat/types/config' {
+  interface HardhatUserConfig {
+    cofhesdk?: {
+      /** Whether to log mock operations (default: true) */
+      logMocks?: boolean;
+      /** Whether to show gas usage warnings for mock operations (default: true) */
+      gasWarning?: boolean;
+    };
+  }
+
+  interface HardhatConfig {
+    cofhesdk: {
+      /** Whether to log mock operations (default: true) */
+      logMocks: boolean;
+      /** Whether to show gas usage warnings for mock operations (default: true) */
+      gasWarning: boolean;
+    };
+  }
+}
+
+extendConfig((config, userConfig) => {
+  // Allow users to override the localcofhe network config
+  if (userConfig.networks && userConfig.networks.localcofhe) {
+    return;
+  }
+
+  // Default config
+  config.networks.localcofhe = {
+    gas: 'auto',
+    gasMultiplier: 1.2,
+    gasPrice: 'auto',
+    timeout: 10_000,
+    httpHeaders: {},
+    url: 'http://127.0.0.1:42069',
+    accounts: [
+      '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80',
+      '0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d',
+      '0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a',
+      '0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6',
+    ],
+  };
+
+  // Only add Sepolia config if user hasn't defined it
+  if (!userConfig.networks?.['eth-sepolia']) {
+    config.networks['eth-sepolia'] = {
+      url: process.env.SEPOLIA_RPC_URL ?? 'https://ethereum-sepolia.publicnode.com',
+      accounts: process.env.PRIVATE_KEY ? [process.env.PRIVATE_KEY] : [],
+      chainId: 11155111,
+      gas: 'auto',
+      gasMultiplier: 1.2,
+      gasPrice: 'auto',
+      timeout: 60_000,
+      httpHeaders: {},
+    };
+  }
+
+  // Only add Arbitrum Sepolia config if user hasn't defined it
+  if (!userConfig.networks?.['arb-sepolia']) {
+    config.networks['arb-sepolia'] = {
+      url: process.env.ARBITRUM_SEPOLIA_RPC_URL ?? 'https://sepolia-rollup.arbitrum.io/rpc',
+      accounts: process.env.PRIVATE_KEY ? [process.env.PRIVATE_KEY] : [],
+      chainId: 421614,
+      gas: 'auto',
+      gasMultiplier: 1.2,
+      gasPrice: 'auto',
+      timeout: 60_000,
+      httpHeaders: {},
+    };
+  }
+
+  // Add cofhe config
+  config.cofhesdk = {
+    logMocks: userConfig.cofhesdk?.logMocks ?? true,
+    gasWarning: userConfig.cofhesdk?.gasWarning ?? true,
+  };
+});
+
+type UseFaucetArgs = {
+  address?: string;
+};
+
+task(TASK_COFHE_USE_FAUCET, 'Fund an account from the funder')
+  .addOptionalParam('address', 'Address to fund', undefined, types.string)
+  .setAction(async ({ address }: UseFaucetArgs, hre) => {
+    const { network } = hre;
+    const { name: networkName } = network;
+
+    if (networkName !== 'localcofhe') {
+      console.info(chalk.yellow(`Programmatic faucet only supported for localcofhe`));
+      return;
+    }
+
+    if (!address) {
+      console.info(chalk.red(`Failed to get address to fund`));
+      return;
+    }
+
+    console.info(chalk.green(`Getting funds from faucet for ${address}`));
+
+    try {
+      await localcofheFundAccount(hre, address);
+    } catch (e) {
+      console.info(chalk.red(`failed to get funds from localcofhe for ${address}: ${e}`));
+    }
+  });
+
+// DEPLOY TASKS
+
+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) => {
+    await deployMocks(hre, {
+      deployTestBed: deployTestBed ?? true,
+      gasWarning: hre.config.cofhesdk.gasWarning ?? true,
+      silent: silent ?? false,
+    });
+  });
+
+task(TASK_TEST, 'Deploy mock contracts on hardhat').setAction(async ({}, hre, runSuper) => {
+  await deployMocks(hre, {
+    deployTestBed: true,
+    gasWarning: hre.config.cofhesdk.gasWarning ?? true,
+  });
+  return runSuper();
+});
+
+task(TASK_NODE, 'Deploy mock contracts on hardhat').setAction(async ({}, hre, runSuper) => {
+  await deployMocks(hre, {
+    deployTestBed: true,
+    gasWarning: hre.config.cofhesdk.gasWarning ?? true,
+  });
+  return runSuper();
+});
+
+// SET LOG OPS
+
+task(TASK_COFHE_MOCKS_SET_LOG_OPS, 'Set logging for the Mock CoFHE contracts')
+  .addParam('enable', 'Whether to enable logging', false, types.boolean)
+  .setAction(async ({ enable }, hre) => {
+    await mock_setLoggingEnabled(hre, enable);
+  });
+
+// MOCK UTILS
+
+export * from './utils.js';
+export * from './fund.js';
+export * from './logging.js';
+export * from './deploy.js';
+
+/**
+ * Runtime environment extensions for the CoFHE Hardhat plugin.
+ * Provides access to CoFHE initialization, environment checks, and mock utilities.
+ */
+declare module 'hardhat/types/runtime' {
+  export interface HardhatRuntimeEnvironment {
+    cofhesdk: {
+      /**
+       * Create a CoFHE SDK configuration for use with cofhesdk.createCofhesdkClient(...)
+       * @param {CofhesdkInputConfig} config - The CoFHE SDK input configuration
+       * @returns {CofhesdkConfig} The CoFHE SDK configuration
+       */
+      createCofhesdkConfig: (config: CofhesdkInputConfig) => Promise<CofhesdkConfig>;
+      /**
+       * Create a CoFHE SDK client instance
+       * @param {CofhesdkConfig} config - The CoFHE SDK configuration (use createCofhesdkConfig to create with Node.js defaults)
+       * @returns {Promise<CofhesdkClient>} The CoFHE SDK client instance
+       */
+      createCofhesdkClient: (config: CofhesdkConfig) => CofhesdkClient;
+      /**
+       * Create viem clients from a Hardhat ethers signer, to be used with `cofhesdkClient.connect(...)`
+       * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use
+       * @returns {Promise<{ publicClient: PublicClient; walletClient: WalletClient }>} The viem clients
+       */
+      hardhatSignerAdapter: (
+        signer: HardhatEthersSigner
+      ) => Promise<{ publicClient: PublicClient; walletClient: WalletClient }>;
+      /**
+       * Connect a CoFHE SDK client with a Hardhat ethers signer
+       * @param {CofhesdkClient} client - The CoFHE SDK client to connect
+       * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use
+       * @returns {Promise<void>}
+       */
+      connectWithHardhatSigner: (client: CofhesdkClient, signer: HardhatEthersSigner) => Promise<void>;
+      /**
+       * Create and connect to a batteries included client.
+       * Also generates a self-usage a permit for the signer.
+       * If customization is needed, use createCofhesdkClient and connectWithHardhatSigner.
+       * @param {HardhatEthersSigner} signer - The Hardhat ethers signer to use (optional - defaults to first signer)
+       * @returns {Promise<CofhesdkClient>} The CoFHE SDK client instance
+       */
+      createBatteriesIncludedCofhesdkClient: (signer?: HardhatEthersSigner) => Promise<CofhesdkClient>;
+
+      mocks: {
+        /**
+         * **[MOCKS ONLY]**
+         *
+         * Execute a block of code with cofhe mock contracts logging enabled.
+         *
+         * _(If logging only a function, we recommend passing the function name as the closureName (ex "counter.increment()"))_
+         *
+         * Example usage:
+         *
+         * ```ts
+         * await hre.cofhesdk.mocks.withLogs("counter.increment()", async () => {
+         *   await counter.increment();
+         * });
+         * ```
+         *
+         * Expected output:
+         * ```
+         * ┌──────────────────┬──────────────────────────────────────────────────
+         * │ [COFHE-MOCKS]    │ "counter.increment()" logs:
+         * ├──────────────────┴──────────────────────────────────────────────────
+         * ├ FHE.add          | euint32(4473..3424)[0] + euint32(1157..3648)[1]  =>  euint32(1106..1872)[1]
+         * ├ FHE.allowThis    | euint32(1106..1872)[1] -> 0x663f..6602
+         * ├ FHE.allow        | euint32(1106..1872)[1] -> 0x3c44..93bc
+         * └─────────────────────────────────────────────────────────────────────
+         * ```
+         * @param {string} closureName - Name of the code block to log within
+         * @param {() => Promise<void>} closure - The async function to execute
+         */
+        withLogs: (closureName: string, closure: () => Promise<void>) => Promise<void>;
+
+        /**
+         * **[MOCKS ONLY]**
+         *
+         * Enable logging from cofhe mock contracts
+         * @param {string} closureName - Optional name of the code block to enable logging for
+         */
+        enableLogs: (closureName?: string) => Promise<void>;
+
+        /**
+         * **[MOCKS ONLY]**
+         *
+         * Disable logging from cofhe mock contracts
+         */
+        disableLogs: () => Promise<void>;
+
+        /**
+         * **[MOCKS ONLY]**
+         *
+         * Deploy the cofhe mock contracts (normally this is done automatically)
+         * @param {DeployMocksArgs} options - Deployment options
+         */
+        deployMocks: (options: DeployMocksArgs) => Promise<void>;
+
+        /**
+         * **[MOCKS ONLY]**
+         *
+         * Get the plaintext value for a ciphertext hash
+         * @param {bigint} ctHash - The ciphertext hash to look up
+         * @returns {Promise<bigint>} The plaintext value
+         */
+        getPlaintext: (ctHash: bigint) => Promise<bigint>;
+
+        /**
+         * **[MOCKS ONLY]**
+         *
+         * Assert that a ciphertext hash represents an expected plaintext value
+         * @param {bigint} ctHash - The ciphertext hash to check
+         * @param {bigint} expectedValue - The expected plaintext value
+         */
+        expectPlaintext: (ctHash: bigint, expectedValue: bigint) => Promise<void>;
+
+        /**
+         * Get the MockTaskManager contract
+         * @returns {Promise<Contract>} The MockTaskManager contract
+         */
+        getMockTaskManager: () => Promise<Contract>;
+
+        /**
+         * Get the MockACL contract
+         * @returns {Promise<Contract>} The MockACL contract
+         */
+        getMockACL: () => Promise<Contract>;
+
+        /**
+         * Get the MockQueryDecrypter contract
+         * @returns {Promise<Contract>} The MockQueryDecrypter contract
+         */
+        getMockQueryDecrypter: () => Promise<Contract>;
+
+        /**
+         * Get the MockZkVerifier contract
+         * @returns {Promise<Contract>} The MockZkVerifier contract
+         */
+        getMockZkVerifier: () => Promise<Contract>;
+
+        /**
+         * Get the TestBed contract
+         * @returns {Promise<Contract>} The TestBed contract
+         */
+        getTestBed: () => Promise<Contract>;
+      };
+    };
+  }
+}
+
+extendEnvironment((hre) => {
+  hre.cofhesdk = {
+    createCofhesdkConfig: async (config: CofhesdkInputConfig) => {
+      // Create zkv wallet client
+      // This wallet interacts with the MockZkVerifier contract so that the user's connected wallet doesn't have to
+      const zkvHhSigner = await hre.ethers.getImpersonatedSigner(MOCKS_ZK_VERIFIER_SIGNER_ADDRESS);
+      const { walletClient: zkvWalletClient } = await HardhatSignerAdapter(zkvHhSigner);
+
+      // Inject zkv wallet client into config
+      const configWithZkvWalletClient = {
+        environment: 'hardhat' as const,
+        ...config,
+        _internal: {
+          ...config._internal,
+          zkvWalletClient,
+        },
+      };
+
+      return createCofhesdkConfig(configWithZkvWalletClient);
+    },
+    createCofhesdkClient: (config: CofhesdkConfig) => {
+      return createCofhesdkClient(config);
+    },
+    hardhatSignerAdapter: async (signer: HardhatEthersSigner) => {
+      return HardhatSignerAdapter(signer);
+    },
+    connectWithHardhatSigner: async (client: CofhesdkClient, signer: HardhatEthersSigner) => {
+      const { publicClient, walletClient } = await HardhatSignerAdapter(signer);
+      return client.connect(publicClient, walletClient);
+    },
+    createBatteriesIncludedCofhesdkClient: async (signer?: HardhatEthersSigner) => {
+      // Get signer if not provided
+      if (!signer) {
+        [signer] = await hre.ethers.getSigners();
+      }
+
+      // Create config
+      const config = await hre.cofhesdk.createCofhesdkConfig({
+        environment: 'hardhat',
+        supportedChains: [hardhat],
+      });
+
+      // Create client
+      const client = hre.cofhesdk.createCofhesdkClient(config);
+
+      // Connect client
+      await hre.cofhesdk.connectWithHardhatSigner(client, signer);
+
+      // Create self-usage permit
+      await client.permits.createSelf({
+        issuer: signer.address,
+      });
+
+      // Return client
+      return client;
+    },
+    mocks: {
+      withLogs: async (closureName: string, closure: () => Promise<void>) => {
+        return mock_withLogs(hre, closureName, closure);
+      },
+      enableLogs: async (closureName?: string) => {
+        return mock_setLoggingEnabled(hre, true, closureName);
+      },
+      disableLogs: async () => {
+        return mock_setLoggingEnabled(hre, false);
+      },
+      deployMocks: async (options: DeployMocksArgs) => {
+        return deployMocks(hre, options);
+      },
+      getPlaintext: async (ctHash: bigint) => {
+        const [signer] = await hre.ethers.getSigners();
+        return mock_getPlaintext(signer.provider, ctHash);
+      },
+      expectPlaintext: async (ctHash: bigint, expectedValue: bigint) => {
+        const [signer] = await hre.ethers.getSigners();
+        return mock_expectPlaintext(signer.provider, ctHash, expectedValue);
+      },
+      getMockTaskManager: async () => {
+        return await hre.ethers.getContractAt(MockTaskManagerArtifact.abi, MockTaskManagerArtifact.fixedAddress);
+      },
+      getMockACL: async () => {
+        const tm = await hre.ethers.getContractAt(MockTaskManagerArtifact.abi, MockTaskManagerArtifact.fixedAddress);
+        const aclAddress = await tm.acl();
+        return await hre.ethers.getContractAt(MockACLArtifact.abi, aclAddress);
+      },
+      getMockQueryDecrypter: async () => {
+        return await hre.ethers.getContractAt(MockQueryDecrypterArtifact.abi, MockQueryDecrypterArtifact.fixedAddress);
+      },
+      getMockZkVerifier: async () => {
+        return await hre.ethers.getContractAt(MockZkVerifierArtifact.abi, MockZkVerifierArtifact.fixedAddress);
+      },
+      getTestBed: async () => {
+        return await hre.ethers.getContractAt(TestBedArtifact.abi, TestBedArtifact.fixedAddress);
+      },
+    },
+  };
+});

package/src/logging.ts

@@ -0,0 +1,75 @@
+import chalk from 'chalk';
+import { type HardhatRuntimeEnvironment } from 'hardhat/types';
+import { TASK_MANAGER_ADDRESS } from './consts';
+import { MockTaskManagerArtifact } from '@cofhe/mock-contracts';
+
+const getDeployedMockTaskManager = async (hre: HardhatRuntimeEnvironment) => {
+  // Fetch the deployed MockTaskManager
+  const taskManager = await hre.ethers.getContractAt(MockTaskManagerArtifact.abi, TASK_MANAGER_ADDRESS);
+
+  return taskManager;
+};
+
+const getLoggingEnabled = async (hre: HardhatRuntimeEnvironment) => {
+  const taskManager = await getDeployedMockTaskManager(hre);
+  return await taskManager.logOps();
+};
+
+const setLoggingEnabled = async (hre: HardhatRuntimeEnvironment, enabled: boolean) => {
+  const taskManager = await getDeployedMockTaskManager(hre);
+  await taskManager.setLogOps(enabled);
+};
+
+// prettier-ignore
+const printLogsEnabledMessage = (closureMessage: string) => {
+  console.log("┌──────────────────┬──────────────────────────────────────────────────");
+  console.log(`│ [COFHE-MOCKS]    │ ${closureMessage}`);
+  console.log("├──────────────────┴──────────────────────────────────────────────────");
+};
+
+// prettier-ignore
+const printLogsBlockEnd = () => {
+  console.log("└─────────────────────────────────────────────────────────────────────");
+};
+
+export const mock_setLoggingEnabled = async (
+  hre: HardhatRuntimeEnvironment,
+  enabled: boolean,
+  closureName?: string
+) => {
+  try {
+    const initiallyEnabled = await getLoggingEnabled(hre);
+
+    await setLoggingEnabled(hre, enabled);
+
+    // Only print if enabling logs
+    if (enabled) {
+      printLogsEnabledMessage(`${closureName ? `"${chalk.bold(closureName)}" logs:` : 'Logs:'}`);
+    }
+
+    // Only print if disabling logs AND logs currently enabled
+    if (!enabled && initiallyEnabled) {
+      printLogsBlockEnd();
+    }
+  } catch (error) {
+    console.log(chalk.red('mock_setLoggingEnabled error'), error);
+  }
+};
+
+export const mock_withLogs = async (
+  hre: HardhatRuntimeEnvironment,
+  closureName: string,
+  closure: () => Promise<void>
+) => {
+  const initiallyEnabled = await getLoggingEnabled(hre);
+
+  await setLoggingEnabled(hre, true);
+  printLogsEnabledMessage(`"${chalk.bold(closureName)}" logs:`);
+  await closure();
+  printLogsBlockEnd();
+
+  // If logs were disabled, disable them again
+  if (!initiallyEnabled) {
+    await setLoggingEnabled(hre, false);
+  }
+};

package/src/utils.ts

@@ -0,0 +1,75 @@
+import { TASK_MANAGER_ADDRESS, MOCKS_ZK_VERIFIER_ADDRESS } from './consts.js';
+import { expect } from 'chai';
+import { ethers } from 'ethers';
+import { type HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
+
+const mock_checkIsTestnet = async (fnName: string, provider: HardhatEthersProvider | ethers.JsonRpcProvider) => {
+  // Testnet is checked by testing if MockZkVerifier is deployed
+
+  // Get bytecode at ZK_VERIFIER_ADDRESS
+  const bytecode = await provider.getCode(MOCKS_ZK_VERIFIER_ADDRESS);
+
+  // If bytecode is empty, we are on a testnet
+  const isTestnet = bytecode.length === 0;
+
+  // Log if we are on a testnet
+  if (isTestnet) {
+    console.log(`${fnName} - skipped on non-testnet chain`);
+  }
+
+  return isTestnet;
+};
+
+export const mock_getPlaintext = async (provider: HardhatEthersProvider | ethers.JsonRpcProvider, ctHash: bigint) => {
+  // Skip with log if called on a non-testnet chain
+  if (await mock_checkIsTestnet(mock_getPlaintext.name, provider)) return;
+
+  // Connect to MockTaskManager
+  const taskManager = new ethers.Contract(
+    TASK_MANAGER_ADDRESS,
+    ['function mockStorage(uint256) view returns (uint256)'],
+    provider
+  );
+
+  // Fetch the plaintext
+  const plaintext = await taskManager.mockStorage(ctHash);
+
+  return plaintext;
+};
+
+export const mock_getPlaintextExists = async (
+  provider: HardhatEthersProvider | ethers.JsonRpcProvider,
+  ctHash: bigint
+) => {
+  // Skip with log if called on a non-testnet chain
+  if (await mock_checkIsTestnet(mock_getPlaintextExists.name, provider)) return;
+
+  // Connect to MockTaskManager
+  const taskManager = new ethers.Contract(
+    TASK_MANAGER_ADDRESS,
+    ['function inMockStorage(uint256) view returns (bool)'],
+    provider
+  );
+
+  // Fetch the plaintext exists
+  const plaintextExists = await taskManager.inMockStorage(ctHash);
+
+  return plaintextExists;
+};
+
+export const mock_expectPlaintext = async (
+  provider: HardhatEthersProvider | ethers.JsonRpcProvider,
+  ctHash: bigint,
+  expectedValue: bigint
+) => {
+  // Skip with log if called on a non-testnet chain
+  if (await mock_checkIsTestnet(mock_expectPlaintext.name, provider)) return;
+
+  // Expect the plaintext to exist
+  const plaintextExists = await mock_getPlaintextExists(provider, ctHash);
+  expect(plaintextExists).equal(true, 'Plaintext does not exist');
+
+  // Expect the plaintext to have the expected value
+  const plaintext = await mock_getPlaintext(provider, ctHash);
+  expect(plaintext).equal(expectedValue, 'Plaintext value is incorrect');
+};