@cofhe/mock-contracts 0.1.1 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @cofhe/mock-contracts Changelog
 
+## 0.2.1
+
+### Patch Changes
+
+- ac47e2f: Add `PermitUtils.checkValidityOnChain` to validate permits against the on-chain deployed ACL (source of truth).
+- 0000d5e: Mock contracts deployed to alternate fixed addresses to avoid collision with hardhat pre-compiles.
+
+## 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
+
 ## 0.1.1
 
 ### Patch Changes

package/contracts/ABITest.sol

@@ -0,0 +1,99 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import '@fhenixprotocol/cofhe-contracts/FHE.sol';
+
+contract ABITest {
+  euint32 public eNumber;
+  uint256 public numberHash;
+
+  euint8 public eUint8;
+  euint16 public eUint16;
+  euint32 public eUint32;
+  euint64 public eUint64;
+  euint128 public eUint128;
+  ebool public eBool;
+  eaddress public eAddress;
+
+  constructor() {
+    eUint8 = FHE.asEuint8(1);
+    eUint16 = FHE.asEuint16(1);
+    eUint32 = FHE.asEuint32(1);
+    eUint64 = FHE.asEuint64(1);
+    eUint128 = FHE.asEuint128(1);
+    eBool = FHE.asEbool(true);
+    eAddress = FHE.asEaddress(address(0));
+  }
+
+  struct ContainsEncryptedInput {
+    uint256 value;
+    InEuint32 encryptedInput;
+  }
+
+  struct ContainsEncryptedResult {
+    uint256 value;
+    euint32 encryptedResult;
+  }
+
+  // INPUTS
+
+  function fnNoEncryptedInputs(uint8 value) public {}
+
+  function fnEncryptedInput(InEuint32 memory inNumber) public {}
+
+  function fnBlendedInputsIncludingEncryptedInput(uint256 value, InEuint32 memory inNumber) public {}
+
+  function fnAllEncryptedInputs(
+    InEuint8 memory inEuint8,
+    InEuint16 memory inEuint16,
+    InEuint32 memory inEuint32,
+    InEuint64 memory inEuint64,
+    InEuint128 memory inEuint128,
+    InEbool memory inEbool,
+    InEaddress memory inEaddress
+  ) public {}
+
+  function fnStructContainsEncryptedInput(ContainsEncryptedInput memory containsEncryptedInput) public {}
+
+  function fnArrayContainsEncryptedInput(InEuint32[] memory inEuint32Array) public {}
+
+  function fnTupleContainsEncryptedInput(InEuint32[2] memory inEuint32Array) public {}
+
+  // OUTPUTS
+
+  function fnReturnNoEncrypted() public pure returns (uint256) {
+    return 1;
+  }
+
+  function fnReturnEncrypted() public view returns (euint32) {
+    return eUint32;
+  }
+
+  function fnReturnBlendedIncludingEncrypted() public view returns (uint256, euint32) {
+    return (1, eUint32);
+  }
+
+  function fnReturnEncryptedArray() public view returns (euint32[] memory) {
+    euint32[] memory encryptedArray = new euint32[](1);
+    encryptedArray[0] = eUint32;
+    return encryptedArray;
+  }
+
+  function fnReturnEncryptedStruct() public view returns (ContainsEncryptedResult memory) {
+    ContainsEncryptedResult memory encryptedResult = ContainsEncryptedResult({ value: 1, encryptedResult: eUint32 });
+    return encryptedResult;
+  }
+
+  function fnReturnAllEncrypted() public view returns (euint8, euint16, euint32, euint64, euint128, ebool, eaddress) {
+    return (eUint8, eUint16, eUint32, eUint64, eUint128, eBool, eAddress);
+  }
+
+  // EVENTS
+
+  event EventNoEncryptedInputs(uint8 value);
+  event EncryptedValue(euint32 value);
+  event BlendedValue(uint256 value, euint32 encryptedValue);
+  event EncryptedArray(euint32[] value);
+  event EncryptedStruct(ContainsEncryptedResult value);
+  event AllEncrypted(euint8, euint16, euint32, euint64, euint128, ebool, eaddress);
+}

package/contracts/MockACL.sol

@@ -66,7 +66,7 @@ contract MockACL is MockPermissioned {
     keccak256(abi.encode(uint256(keccak256('cofhe.storage.ACL')) - 1)) & ~bytes32(uint256(0xff));
 
   /// @custom:oz-upgrades-unsafe-allow constructor
-  constructor() {}
+  constructor() MockPermissioned() {}
 
   function exists() public pure returns (bool) {
     return true;
@@ -335,4 +335,8 @@ contract MockACL is MockPermissioned {
   ) public view withPermission(permission) returns (bool) {
     return isAllowed(handle, permission.issuer);
   }
+
+  function checkPermitValidity(Permission memory permission) public view withPermission(permission) returns (bool) {
+    return true;
+  }
 }

package/dist/index.d.mts

@@ -1,12 +1,18 @@
-type MocksArtifact = {
+type MockArtifact = {
     contractName: string;
-    fixedAddress: string;
     abi: any;
+} & ({
+    isFixed: true;
+    fixedAddress: string;
     deployedBytecode: string;
-};
+} | {
+    isFixed: false;
+    bytecode: string;
+});
 
 declare const MockTaskManagerArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -69,7 +75,7 @@ declare const MockTaskManagerArtifact: {
 
 declare const MockACLArtifact: {
     contractName: string;
-    fixedAddress: string;
+    isFixed: false;
     abi: ({
         type: string;
         inputs: never[];
@@ -126,11 +132,12 @@ declare const MockACLArtifact: {
         outputs?: undefined;
         anonymous?: undefined;
     })[];
-    deployedBytecode: string;
+    bytecode: string;
 };
 
 declare const MockZkVerifierArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -177,6 +184,7 @@ declare const MockZkVerifierArtifact: {
 
 declare const MockQueryDecrypterArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -214,6 +222,7 @@ declare const MockQueryDecrypterArtifact: {
 
 declare const TestBedArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -258,4 +267,4 @@ declare const TestBedArtifact: {
     deployedBytecode: string;
 };
 
-export { MockACLArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, type MocksArtifact, TestBedArtifact };
+export { MockACLArtifact, type MockArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, TestBedArtifact };

package/dist/index.d.ts

@@ -1,12 +1,18 @@
-type MocksArtifact = {
+type MockArtifact = {
     contractName: string;
-    fixedAddress: string;
     abi: any;
+} & ({
+    isFixed: true;
+    fixedAddress: string;
     deployedBytecode: string;
-};
+} | {
+    isFixed: false;
+    bytecode: string;
+});
 
 declare const MockTaskManagerArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -69,7 +75,7 @@ declare const MockTaskManagerArtifact: {
 
 declare const MockACLArtifact: {
     contractName: string;
-    fixedAddress: string;
+    isFixed: false;
     abi: ({
         type: string;
         inputs: never[];
@@ -126,11 +132,12 @@ declare const MockACLArtifact: {
         outputs?: undefined;
         anonymous?: undefined;
     })[];
-    deployedBytecode: string;
+    bytecode: string;
 };
 
 declare const MockZkVerifierArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -177,6 +184,7 @@ declare const MockZkVerifierArtifact: {
 
 declare const MockQueryDecrypterArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -214,6 +222,7 @@ declare const MockQueryDecrypterArtifact: {
 
 declare const TestBedArtifact: {
     contractName: string;
+    isFixed: true;
     fixedAddress: string;
     abi: ({
         type: string;
@@ -258,4 +267,4 @@ declare const TestBedArtifact: {
     deployedBytecode: string;
 };
 
-export { MockACLArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, type MocksArtifact, TestBedArtifact };
+export { MockACLArtifact, type MockArtifact, MockQueryDecrypterArtifact, MockTaskManagerArtifact, MockZkVerifierArtifact, TestBedArtifact };