@cofhe/hardhat-plugin 0.1.1 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @cofhe/hardhat-plugin Changelog
 
+## 0.2.1
+
+### Patch Changes
+
+- 0000d5e: Mock contracts deployed to alternate fixed addresses to avoid collision with hardhat pre-compiles.
+- Updated dependencies [409bfdf]
+- Updated dependencies [ac47e2f]
+- Updated dependencies [0000d5e]
+- Updated dependencies [8af1b70]
+  - @cofhe/sdk@0.2.1
+  - @cofhe/mock-contracts@0.2.1
+
+## 0.2.0
+
+### Minor Changes
+
+- 8fda09a: Removes `Promise<boolean>` return type from `client.connect(...)`, instead throws an error if the connection fails.
+- e0caeca: Adds `environment: 'node' | 'web' | 'hardhat' | 'react'` option to config. Exposed via `client.config.enviroment`. Automatically populated appropriately within the various `createCofhesdkConfig` functions.
+
+### Patch Changes
+
+- e121108: Fix ACL permission invalid issue. MockACL needs real deployment since etching doesn't call the constructor, so the EIP712 is uninitialized. Also adds additional utility functions to hardhat-plugin:
+
+  - `hre.cofhesdk.connectWithHardhatSigner(client, signer)` - Connect to client with hardhat ethers signer.
+  - `hre.cofhesdk.createBatteriesIncludedCofhesdkClient()` - Creates a batteries included client with signer connected.
+  - `hre.cofhesdk.mocks.getMockTaskManager()` - Gets deployed Mock Taskmanager
+  - `hre.cofhesdk.mocks.getMockACL()` - Gets deployed Mock ACL
+
+- Updated dependencies [8fda09a]
+- Updated dependencies [e121108]
+- Updated dependencies [4057a76]
+- Updated dependencies [dba2759]
+- Updated dependencies [e0caeca]
+- Updated dependencies [7c861af]
+- Updated dependencies [2a9d6c5]
+  - @cofhe/mock-contracts@0.2.0
+  - @cofhe/sdk@0.2.0
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -18,9 +18,9 @@ Add the plugin to your Hardhat config:
 
 ```javascript
 // hardhat.config.js or hardhat.config.ts
-require("cofhe-hardhat-plugin");
+require('cofhe-hardhat-plugin');
 // or if using TypeScript
-import "cofhe-hardhat-plugin";
+import 'cofhe-hardhat-plugin';
 
 module.exports = {
   // ... other config
@@ -83,15 +83,15 @@ The plugin exports several utility functions for working with mock contracts:
 
 ```typescript
 // Get plaintext value from a ciphertext hash
-import { mock_getPlaintext } from "cofhe-hardhat-plugin";
+import { mock_getPlaintext } from 'cofhe-hardhat-plugin';
 const plaintext = await mock_getPlaintext(provider, ctHash);
 
 // Check if a plaintext exists for a ciphertext hash
-import { mock_getPlaintextExists } from "cofhe-hardhat-plugin";
+import { mock_getPlaintextExists } from 'cofhe-hardhat-plugin';
 const exists = await mock_getPlaintextExists(provider, ctHash);
 
 // Test assertion for plaintext values
-import { mock_expectPlaintext } from "cofhe-hardhat-plugin";
+import { mock_expectPlaintext } from 'cofhe-hardhat-plugin';
 await mock_expectPlaintext(provider, ctHash, expectedValue);
 ```
 
@@ -99,15 +99,15 @@ await mock_expectPlaintext(provider, ctHash, expectedValue);
 
 ```typescript
 // Get the CoFHE environment based on network name
-import { getCofheEnvironmentFromNetwork } from "cofhe-hardhat-plugin";
+import { getCofheEnvironmentFromNetwork } from 'cofhe-hardhat-plugin';
 const environment = getCofheEnvironmentFromNetwork(networkName);
 
 // Check if a CoFHE environment is permitted for a given network
-import { isPermittedCofheEnvironment } from "cofhe-hardhat-plugin";
+import { isPermittedCofheEnvironment } from 'cofhe-hardhat-plugin';
 const isPermitted = isPermittedCofheEnvironment(hre, environmentName);
 
 // Initialize CoFHEjs with a Hardhat signer
-import { cofhejs_initializeWithHardhatSigner } from "cofhe-hardhat-plugin";
+import { cofhejs_initializeWithHardhatSigner } from 'cofhe-hardhat-plugin';
 await cofhejs_initializeWithHardhatSigner(signer, options);
 ```
 

package/dist/index.d.mts

@@ -1,11 +1,11 @@
 import { PublicClient, WalletClient } from 'viem';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
-import { Result, CofhesdkInputConfig, CofhesdkConfig, CofhesdkClient } from '@cofhe/sdk';
+import { CofhesdkInputConfig, CofhesdkConfig, CofhesdkClient } from '@cofhe/sdk';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
-export { MockACLArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, TestBedArtifact } from '@cofhe/mock-contracts';
 import * as ethers from 'ethers';
-import { ethers as ethers$1 } from 'ethers';
+import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
+import { MockArtifact } from '@cofhe/mock-contracts';
 
 type DeployMocksArgs = {
     deployTestBed?: boolean;
@@ -14,15 +14,16 @@ type DeployMocksArgs = {
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => 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";
+
+declare const deployMockContractFromArtifact: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
+declare const getFixedMockContract: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
 declare const mock_getPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_getPlaintextExists: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_expectPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint, expectedValue: bigint) => Promise<void>;
 
-declare const expectResultError: <T>(result: Result<T>, errorPartial: string) => void;
-declare const expectResultSuccess: <T>(result: Result<T>) => T;
-declare const expectResultValue: <T>(result: Result<T>, value: T) => T;
-declare const expectResultPartialValue: <T>(result: Result<T>, partial: Partial<T>) => T;
-
 /**
  * Sends funds to the specified address
  * @param hre Hardhat Runtime Environment
@@ -94,30 +95,20 @@ declare module 'hardhat/types/runtime' {
                 walletClient: WalletClient;
             }>;
             /**
-             * Assert that a Result type returned from a function is successful and return its value (result.success === true)
-             * @param {Result<T>} result - The Result to check
-             * @returns {T} The inner data of the Result (non null)
-             */
-            expectResultSuccess: <T>(result: Result<T> | Promise<Result<T>>) => Promise<T>;
-            /**
-             * Assert that a Result type contains an error matching the partial string (result.success === false && result.error.includes(errorPartial))
-             * @param {Result<T>} result - The Result to check
-             * @param {string} errorPartial - The partial error string to match
-             */
-            expectResultError: <T>(result: Result<T> | Promise<Result<T>>, errorPartial: string) => Promise<void>;
-            /**
-             * Assert that a Result type contains a specific value (result.success === true && result.data === value)
-             * @param {Result<T>} result - The Result to check
-             * @param {T} value - The inner data of the Result (non null)
+             * 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>}
              */
-            expectResultValue: <T>(result: Result<T> | Promise<Result<T>>, value: T) => Promise<T>;
+            connectWithHardhatSigner: (client: CofhesdkClient, signer: HardhatEthersSigner) => Promise<void>;
             /**
-             * Assert that a Result type contains a value matching the partial object (result.success === true && result.data.includes(partial))
-             * @param {Result<T>} result - The Result to check
-             * @param {Partial<T>} partial - The partial object to match against
-             * @returns {T} The inner data of the Result (non null)
+             * 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
              */
-            expectResultPartialValue: <T>(result: Result<T> | Promise<Result<T>>, partial: Partial<T>) => Promise<T>;
+            createBatteriesIncludedCofhesdkClient: (signer?: HardhatEthersSigner) => Promise<CofhesdkClient>;
             mocks: {
                 /**
                  * **[MOCKS ONLY]**
@@ -184,9 +175,34 @@ declare module 'hardhat/types/runtime' {
                  * @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>;
             };
         };
     }
 }
 
-export { type DeployMocksArgs, deployMocks, expectResultError, expectResultPartialValue, expectResultSuccess, expectResultValue, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };
+export { type DeployMocksArgs, TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, deployMockContractFromArtifact, deployMocks, getFixedMockContract, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import { PublicClient, WalletClient } from 'viem';
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers';
-import { Result, CofhesdkInputConfig, CofhesdkConfig, CofhesdkClient } from '@cofhe/sdk';
+import { CofhesdkInputConfig, CofhesdkConfig, CofhesdkClient } from '@cofhe/sdk';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
-export { MockACLArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, TestBedArtifact } from '@cofhe/mock-contracts';
 import * as ethers from 'ethers';
-import { ethers as ethers$1 } from 'ethers';
+import { Contract, ethers as ethers$1 } from 'ethers';
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider';
+import { MockArtifact } from '@cofhe/mock-contracts';
 
 type DeployMocksArgs = {
     deployTestBed?: boolean;
@@ -14,15 +14,16 @@ type DeployMocksArgs = {
 };
 declare const deployMocks: (hre: HardhatRuntimeEnvironment, options?: DeployMocksArgs) => 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";
+
+declare const deployMockContractFromArtifact: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
+declare const getFixedMockContract: (hre: HardhatRuntimeEnvironment, artifact: MockArtifact) => Promise<Contract>;
 declare const mock_getPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_getPlaintextExists: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint) => Promise<any>;
 declare const mock_expectPlaintext: (provider: HardhatEthersProvider | ethers$1.JsonRpcProvider, ctHash: bigint, expectedValue: bigint) => Promise<void>;
 
-declare const expectResultError: <T>(result: Result<T>, errorPartial: string) => void;
-declare const expectResultSuccess: <T>(result: Result<T>) => T;
-declare const expectResultValue: <T>(result: Result<T>, value: T) => T;
-declare const expectResultPartialValue: <T>(result: Result<T>, partial: Partial<T>) => T;
-
 /**
  * Sends funds to the specified address
  * @param hre Hardhat Runtime Environment
@@ -94,30 +95,20 @@ declare module 'hardhat/types/runtime' {
                 walletClient: WalletClient;
             }>;
             /**
-             * Assert that a Result type returned from a function is successful and return its value (result.success === true)
-             * @param {Result<T>} result - The Result to check
-             * @returns {T} The inner data of the Result (non null)
-             */
-            expectResultSuccess: <T>(result: Result<T> | Promise<Result<T>>) => Promise<T>;
-            /**
-             * Assert that a Result type contains an error matching the partial string (result.success === false && result.error.includes(errorPartial))
-             * @param {Result<T>} result - The Result to check
-             * @param {string} errorPartial - The partial error string to match
-             */
-            expectResultError: <T>(result: Result<T> | Promise<Result<T>>, errorPartial: string) => Promise<void>;
-            /**
-             * Assert that a Result type contains a specific value (result.success === true && result.data === value)
-             * @param {Result<T>} result - The Result to check
-             * @param {T} value - The inner data of the Result (non null)
+             * 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>}
              */
-            expectResultValue: <T>(result: Result<T> | Promise<Result<T>>, value: T) => Promise<T>;
+            connectWithHardhatSigner: (client: CofhesdkClient, signer: HardhatEthersSigner) => Promise<void>;
             /**
-             * Assert that a Result type contains a value matching the partial object (result.success === true && result.data.includes(partial))
-             * @param {Result<T>} result - The Result to check
-             * @param {Partial<T>} partial - The partial object to match against
-             * @returns {T} The inner data of the Result (non null)
+             * 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
              */
-            expectResultPartialValue: <T>(result: Result<T> | Promise<Result<T>>, partial: Partial<T>) => Promise<T>;
+            createBatteriesIncludedCofhesdkClient: (signer?: HardhatEthersSigner) => Promise<CofhesdkClient>;
             mocks: {
                 /**
                  * **[MOCKS ONLY]**
@@ -184,9 +175,34 @@ declare module 'hardhat/types/runtime' {
                  * @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>;
             };
         };
     }
 }
 
-export { type DeployMocksArgs, deployMocks, expectResultError, expectResultPartialValue, expectResultSuccess, expectResultValue, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };
+export { type DeployMocksArgs, TASK_COFHE_MOCKS_DEPLOY, TASK_COFHE_MOCKS_SET_LOG_OPS, TASK_COFHE_USE_FAUCET, deployMockContractFromArtifact, deployMocks, getFixedMockContract, localcofheFundAccount, localcofheFundWalletIfNeeded, mock_expectPlaintext, mock_getPlaintext, mock_getPlaintextExists, mock_setLoggingEnabled, mock_withLogs };