@cofhe/mock-contracts 0.2.1 → 0.3.0

package/test/TestBed.t.sol

@@ -4,13 +4,20 @@ pragma solidity ^0.8.13;
 import { Test } from 'forge-std/Test.sol';
 import { TestBed } from '../contracts/TestBed.sol';
 import { CoFheTest } from '../contracts/foundry/CoFheTest.sol';
-import { FHE, InEuint32, euint8, euint256 } from '@fhenixprotocol/cofhe-contracts/FHE.sol';
+import { FHE, InEuint32, euint8, euint128 } from '@fhenixprotocol/cofhe-contracts/FHE.sol';
 
+/// @title TestBed Foundry Tests
+/// @notice Foundry-native smoke tests for the CoFHE mock environment and FHE Solidity surface.
+/// @dev This repo deploys `TestBed` inside Foundry tests as a known-good reference contract.
+///      Downstream Foundry users are not required to use `TestBed`; they can deploy/test their own
+///      contracts while inheriting from `CoFheTest` to get helper methods like `createInEuint32(...)`
+///      and `assertHashValue(...)`.
 contract TestBedTest is Test, CoFheTest {
   TestBed private testbed;
 
   address private user = makeAddr('user');
 
+  /// @notice Deploys a fresh TestBed instance for each test.
   function setUp() public {
     // optional ... enable verbose logging from fhe mocks
     // setLog(true);
@@ -18,6 +25,7 @@ contract TestBedTest is Test, CoFheTest {
     testbed = new TestBed();
   }
 
+  /// @notice Fuzz test: create an encrypted input and set it as state.
   function testSetNumberFuzz(uint32 n) public {
     InEuint32 memory number = createInEuint32(n, user);
 
@@ -29,6 +37,7 @@ contract TestBedTest is Test, CoFheTest {
     assertHashValue(testbed.eNumber(), n);
   }
 
+  /// @notice Validates that mock arithmetic matches EVM uint8 wraparound behavior.
   function testOverflow() public {
     euint8 a = FHE.asEuint8(240);
     euint8 b = FHE.asEuint8(240);
@@ -37,6 +46,7 @@ contract TestBedTest is Test, CoFheTest {
     assertHashValue(euint8.unwrap(c), (240 + 240) % 256);
   }
 
+  /// @notice Validates division by zero behavior in the mock implementation.
   function testDivideByZero() public {
     euint8 a = FHE.asEuint8(240);
     euint8 b = FHE.asEuint8(0);
@@ -45,16 +55,17 @@ contract TestBedTest is Test, CoFheTest {
     assertHashValue(euint8.unwrap(c), type(uint8).max);
   }
 
-  function test256BitsNoOverflow() public {
-    euint256 a = FHE.asEuint256(type(uint256).max);
-    euint256 b = FHE.asEuint256(type(uint256).max);
-    euint256 c = FHE.add(a, b);
+  /// @notice Validates 128-bit addition semantics used by the mock implementation.
+  function test128BitsNoOverflow() public {
+    euint128 a = FHE.asEuint128(type(uint128).max);
+    euint128 b = FHE.asEuint128(type(uint128).max);
+    euint128 c = FHE.add(a, b);
 
     uint256 expected;
     unchecked {
-      expected = type(uint256).max + type(uint256).max;
+      expected = type(uint128).max + type(uint128).max;
     }
 
-    assertHashValue(euint256.unwrap(c), expected);
+    assertHashValue(euint128.unwrap(c), expected);
   }
 }

package/src/MockQueryDecrypter.ts

@@ -1,352 +0,0 @@
-// This file is auto-generated by build-artifacts.ts
-import { type MockArtifact } from './types';
-
-export const MockQueryDecrypterArtifact = {
-  contractName: 'MockQueryDecrypter',
-  isFixed: true,
-  fixedAddress: '0x0000000000000000000000000000000000005002',
-  abi: [
-    {
-      type: 'function',
-      name: 'decodeLowLevelReversion',
-      inputs: [
-        {
-          name: 'data',
-          type: 'bytes',
-          internalType: 'bytes',
-        },
-      ],
-      outputs: [
-        {
-          name: 'error',
-          type: 'string',
-          internalType: 'string',
-        },
-      ],
-      stateMutability: 'pure',
-    },
-    {
-      type: 'function',
-      name: 'exists',
-      inputs: [],
-      outputs: [
-        {
-          name: '',
-          type: 'bool',
-          internalType: 'bool',
-        },
-      ],
-      stateMutability: 'pure',
-    },
-    {
-      type: 'function',
-      name: 'initialize',
-      inputs: [
-        {
-          name: '_taskManager',
-          type: 'address',
-          internalType: 'address',
-        },
-        {
-          name: '_acl',
-          type: 'address',
-          internalType: 'address',
-        },
-      ],
-      outputs: [],
-      stateMutability: 'nonpayable',
-    },
-    {
-      type: 'function',
-      name: 'mockAcl',
-      inputs: [],
-      outputs: [
-        {
-          name: '',
-          type: 'address',
-          internalType: 'contract MockACL',
-        },
-      ],
-      stateMutability: 'view',
-    },
-    {
-      type: 'function',
-      name: 'mockQueryDecrypt',
-      inputs: [
-        {
-          name: 'ctHash',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: '',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: 'issuer',
-          type: 'address',
-          internalType: 'address',
-        },
-      ],
-      outputs: [
-        {
-          name: 'allowed',
-          type: 'bool',
-          internalType: 'bool',
-        },
-        {
-          name: 'error',
-          type: 'string',
-          internalType: 'string',
-        },
-        {
-          name: '',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-      ],
-      stateMutability: 'view',
-    },
-    {
-      type: 'function',
-      name: 'mockTaskManager',
-      inputs: [],
-      outputs: [
-        {
-          name: '',
-          type: 'address',
-          internalType: 'contract MockTaskManager',
-        },
-      ],
-      stateMutability: 'view',
-    },
-    {
-      type: 'function',
-      name: 'queryDecrypt',
-      inputs: [
-        {
-          name: 'ctHash',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: '',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: 'permission',
-          type: 'tuple',
-          internalType: 'struct Permission',
-          components: [
-            {
-              name: 'issuer',
-              type: 'address',
-              internalType: 'address',
-            },
-            {
-              name: 'expiration',
-              type: 'uint64',
-              internalType: 'uint64',
-            },
-            {
-              name: 'recipient',
-              type: 'address',
-              internalType: 'address',
-            },
-            {
-              name: 'validatorId',
-              type: 'uint256',
-              internalType: 'uint256',
-            },
-            {
-              name: 'validatorContract',
-              type: 'address',
-              internalType: 'address',
-            },
-            {
-              name: 'sealingKey',
-              type: 'bytes32',
-              internalType: 'bytes32',
-            },
-            {
-              name: 'issuerSignature',
-              type: 'bytes',
-              internalType: 'bytes',
-            },
-            {
-              name: 'recipientSignature',
-              type: 'bytes',
-              internalType: 'bytes',
-            },
-          ],
-        },
-      ],
-      outputs: [
-        {
-          name: 'allowed',
-          type: 'bool',
-          internalType: 'bool',
-        },
-        {
-          name: 'error',
-          type: 'string',
-          internalType: 'string',
-        },
-        {
-          name: '',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-      ],
-      stateMutability: 'view',
-    },
-    {
-      type: 'function',
-      name: 'querySealOutput',
-      inputs: [
-        {
-          name: 'ctHash',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: '',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: 'permission',
-          type: 'tuple',
-          internalType: 'struct Permission',
-          components: [
-            {
-              name: 'issuer',
-              type: 'address',
-              internalType: 'address',
-            },
-            {
-              name: 'expiration',
-              type: 'uint64',
-              internalType: 'uint64',
-            },
-            {
-              name: 'recipient',
-              type: 'address',
-              internalType: 'address',
-            },
-            {
-              name: 'validatorId',
-              type: 'uint256',
-              internalType: 'uint256',
-            },
-            {
-              name: 'validatorContract',
-              type: 'address',
-              internalType: 'address',
-            },
-            {
-              name: 'sealingKey',
-              type: 'bytes32',
-              internalType: 'bytes32',
-            },
-            {
-              name: 'issuerSignature',
-              type: 'bytes',
-              internalType: 'bytes',
-            },
-            {
-              name: 'recipientSignature',
-              type: 'bytes',
-              internalType: 'bytes',
-            },
-          ],
-        },
-      ],
-      outputs: [
-        {
-          name: 'allowed',
-          type: 'bool',
-          internalType: 'bool',
-        },
-        {
-          name: 'error',
-          type: 'string',
-          internalType: 'string',
-        },
-        {
-          name: '',
-          type: 'bytes32',
-          internalType: 'bytes32',
-        },
-      ],
-      stateMutability: 'view',
-    },
-    {
-      type: 'function',
-      name: 'seal',
-      inputs: [
-        {
-          name: 'input',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-        {
-          name: 'key',
-          type: 'bytes32',
-          internalType: 'bytes32',
-        },
-      ],
-      outputs: [
-        {
-          name: '',
-          type: 'bytes32',
-          internalType: 'bytes32',
-        },
-      ],
-      stateMutability: 'pure',
-    },
-    {
-      type: 'function',
-      name: 'unseal',
-      inputs: [
-        {
-          name: 'hashed',
-          type: 'bytes32',
-          internalType: 'bytes32',
-        },
-        {
-          name: 'key',
-          type: 'bytes32',
-          internalType: 'bytes32',
-        },
-      ],
-      outputs: [
-        {
-          name: '',
-          type: 'uint256',
-          internalType: 'uint256',
-        },
-      ],
-      stateMutability: 'pure',
-    },
-    {
-      type: 'error',
-      name: 'NotAllowed',
-      inputs: [],
-    },
-    {
-      type: 'error',
-      name: 'SealingKeyInvalid',
-      inputs: [],
-    },
-    {
-      type: 'error',
-      name: 'SealingKeyMissing',
-      inputs: [],
-    },
-  ],
-  deployedBytecode:
-    '0x608060405234801561000f575f5ffd5b506004361061009c575f3560e01c80637e0f4b5b116100645780637e0f4b5b1461015a5780638a5c8c7f14610178578063a02eb534146101a8578063a0639f54146101da578063ff6957d31461020c5761009c565b806309ba3156146100a05780631a1992a9146100d2578063267c4ae414610102578063485cc955146101205780634cdc014d1461013c575b5f5ffd5b6100ba60048036038101906100b591906110b5565b61023c565b6040516100c9939291906111aa565b60405180910390f35b6100ec60048036038101906100e791906111e6565b61051f565b6040516100f99190611224565b60405180910390f35b61010a61052d565b604051610117919061123d565b60405180910390f35b61013a60048036038101906101359190611256565b610535565b005b6101446105b8565b60405161015191906112ef565b60405180910390f35b6101626105dd565b60405161016f9190611328565b60405180910390f35b610192600480360381019061018d9190611341565b610601565b60405161019f919061138e565b60405180910390f35b6101c260048036038101906101bd91906113a7565b61060f565b6040516101d1939291906113f7565b60405180910390f35b6101f460048036038101906101ef91906110b5565b61089e565b604051610203939291906113f7565b60405180910390f35b61022660048036038101906102219190611433565b610b28565b604051610233919061147a565b60405180910390f35b5f60605f5f5f1b8460a001510361027f576040517fb78926d800000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b5f60015f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1663ae79f04a86896040518363ffffffff1660e01b81526004016102dc9291906115dc565b602060405180830381865afa92505050801561031657506040513d601f19601f820116820180604052508101906103139190611634565b60015b6104025761032261166b565b806308c379a003610353575061033661168a565b8061034157506103b8565b5f815f5f1b9450945094505050610516565b634e487b71036103b857610365611719565b9061037057506103b8565b5f5f5f1b6040518060400160405280600581526020017f50616e6963000000000000000000000000000000000000000000000000000000815250909450945094505050610516565b3d805f81146103e2576040519150601f19603f3d011682016040523d82523d5f602084013e6103e7565b606091505b505f6103f282610b28565b5f5f1b9450945094505050610516565b8091505080610452575f5f5f1b6040518060400160405280600a81526020017f4e6f74416c6c6f776564000000000000000000000000000000000000000000008152509093509350935050610516565b5f5f5f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16631c76642b896040518263ffffffff1660e01b81526004016104ac919061138e565b602060405180830381865afa1580156104c7573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906104eb919061174b565b905060016104fd828860a0015161051f565b60405180602001604052805f8152509094509450945050505b93509350939050565b5f81835f1b18905092915050565b5f6001905090565b815f5f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055508060015f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055505050565b60015f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b5f5f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b5f8183185f1c905092915050565b5f60605f5f60015f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16635faa299a88876040518363ffffffff1660e01b8152600401610670929190611785565b602060405180830381865afa9250505080156106aa57506040513d601f19601f820116820180604052508101906106a79190611634565b60015b610790576106b661166b565b806308c379a0036106e557506106ca61168a565b806106d55750610748565b5f815f9450945094505050610895565b634e487b7103610748576106f7611719565b906107025750610748565b5f5f6040518060400160405280600581526020017f50616e6963000000000000000000000000000000000000000000000000000000815250909450945094505050610895565b3d805f8114610772576040519150601f19603f3d011682016040523d82523d5f602084013e610777565b606091505b505f61078282610b28565b5f9450945094505050610895565b80915050806107de575f5f6040518060400160405280600a81526020017f4e6f74416c6c6f776564000000000000000000000000000000000000000000008152509093509350935050610895565b5f5f5f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16631c76642b896040518263ffffffff1660e01b8152600401610838919061138e565b602060405180830381865afa158015610853573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610877919061174b565b905060018160405180602001604052805f8152509094509450945050505b93509350939050565b5f60605f5f60015f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1663ae79f04a86896040518363ffffffff1660e01b81526004016108ff9291906115dc565b602060405180830381865afa92505050801561093957506040513d601f19601f820116820180604052508101906109369190611634565b60015b610a1f5761094561166b565b806308c379a003610974575061095961168a565b8061096457506109d7565b5f815f9450945094505050610b1f565b634e487b71036109d757610986611719565b9061099157506109d7565b5f5f6040518060400160405280600581526020017f50616e6963000000000000000000000000000000000000000000000000000000815250909450945094505050610b1f565b3d805f8114610a01576040519150601f19603f3d011682016040523d82523d5f602084013e610a06565b606091505b505f610a1182610b28565b5f9450945094505050610b1f565b8091505080610a6d575f5f6040518060400160405280600a81526020017f4e6f74416c6c6f776564000000000000000000000000000000000000000000008152509093509350935050610b1f565b60015f5f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16631c76642b896040518263ffffffff1660e01b8152600401610ac8919061138e565b602060405180830381865afa158015610ae3573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610b07919061174b565b60405180602001604052805f81525090935093509350505b93509350939050565b60605f82610b3590611806565b905063ed0764a160e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191603610bc1576040518060400160405280601981526020017f5065726d697373696f6e496e76616c69645f4578706972656400000000000000815250915050610d5f565b634c40eccb60e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191603610c2e5760405180606001604052806021815260200161189160219139915050610d5f565b638e143bf760e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191603610c9b5760405180606001604052806024815260200161186d60249139915050610d5f565b63cbd3a96660e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191603610d25576040518060400160405280601a81526020017f5065726d697373696f6e496e76616c69645f44697361626c6564000000000000815250915050610d5f565b6040518060400160405280600f81526020017f4c6f77204c6576656c204572726f7200000000000000000000000000000000008152509150505b919050565b5f604051905090565b5f5ffd5b5f5ffd5b5f819050919050565b610d8781610d75565b8114610d91575f5ffd5b50565b5f81359050610da281610d7e565b92915050565b5f5ffd5b5f601f19601f8301169050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b610df282610dac565b810181811067ffffffffffffffff82111715610e1157610e10610dbc565b5b80604052505050565b5f610e23610d64565b9050610e2f8282610de9565b919050565b5f5ffd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f610e6182610e38565b9050919050565b610e7181610e57565b8114610e7b575f5ffd5b50565b5f81359050610e8c81610e68565b92915050565b5f67ffffffffffffffff82169050919050565b610eae81610e92565b8114610eb8575f5ffd5b50565b5f81359050610ec981610ea5565b92915050565b5f819050919050565b610ee181610ecf565b8114610eeb575f5ffd5b50565b5f81359050610efc81610ed8565b92915050565b5f5ffd5b5f5ffd5b5f67ffffffffffffffff821115610f2457610f23610dbc565b5b610f2d82610dac565b9050602081019050919050565b828183375f83830152505050565b5f610f5a610f5584610f0a565b610e1a565b905082815260208101848484011115610f7657610f75610f06565b5b610f81848285610f3a565b509392505050565b5f82601f830112610f9d57610f9c610f02565b5b8135610fad848260208601610f48565b91505092915050565b5f6101008284031215610fcc57610fcb610da8565b5b610fd7610100610e1a565b90505f610fe684828501610e7e565b5f830152506020610ff984828501610ebb565b602083015250604061100d84828501610e7e565b604083015250606061102184828501610d94565b606083015250608061103584828501610e7e565b60808301525060a061104984828501610eee565b60a08301525060c082013567ffffffffffffffff81111561106d5761106c610e34565b5b61107984828501610f89565b60c08301525060e082013567ffffffffffffffff81111561109d5761109c610e34565b5b6110a984828501610f89565b60e08301525092915050565b5f5f5f606084860312156110cc576110cb610d6d565b5b5f6110d986828701610d94565b93505060206110ea86828701610d94565b925050604084013567ffffffffffffffff81111561110b5761110a610d71565b5b61111786828701610fb6565b9150509250925092565b5f8115159050919050565b61113581611121565b82525050565b5f81519050919050565b5f82825260208201905092915050565b8281835e5f83830152505050565b5f61116d8261113b565b6111778185611145565b9350611187818560208601611155565b61119081610dac565b840191505092915050565b6111a481610ecf565b82525050565b5f6060820190506111bd5f83018661112c565b81810360208301526111cf8185611163565b90506111de604083018461119b565b949350505050565b5f5f604083850312156111fc576111fb610d6d565b5b5f61120985828601610d94565b925050602061121a85828601610eee565b9150509250929050565b5f6020820190506112375f83018461119b565b92915050565b5f6020820190506112505f83018461112c565b92915050565b5f5f6040838503121561126c5761126b610d6d565b5b5f61127985828601610e7e565b925050602061128a85828601610e7e565b9150509250929050565b5f819050919050565b5f6112b76112b26112ad84610e38565b611294565b610e38565b9050919050565b5f6112c88261129d565b9050919050565b5f6112d9826112be565b9050919050565b6112e9816112cf565b82525050565b5f6020820190506113025f8301846112e0565b92915050565b5f611312826112be565b9050919050565b61132281611308565b82525050565b5f60208201905061133b5f830184611319565b92915050565b5f5f6040838503121561135757611356610d6d565b5b5f61136485828601610eee565b925050602061137585828601610eee565b9150509250929050565b61138881610d75565b82525050565b5f6020820190506113a15f83018461137f565b92915050565b5f5f5f606084860312156113be576113bd610d6d565b5b5f6113cb86828701610d94565b93505060206113dc86828701610d94565b92505060406113ed86828701610e7e565b9150509250925092565b5f60608201905061140a5f83018661112c565b818103602083015261141c8185611163565b905061142b604083018461137f565b949350505050565b5f6020828403121561144857611447610d6d565b5b5f82013567ffffffffffffffff81111561146557611464610d71565b5b61147184828501610f89565b91505092915050565b5f6020820190508181035f8301526114928184611163565b905092915050565b6114a381610e57565b82525050565b6114b281610e92565b82525050565b6114c181610d75565b82525050565b6114d081610ecf565b82525050565b5f81519050919050565b5f82825260208201905092915050565b5f6114fa826114d6565b61150481856114e0565b9350611514818560208601611155565b61151d81610dac565b840191505092915050565b5f61010083015f83015161153e5f86018261149a565b50602083015161155160208601826114a9565b506040830151611564604086018261149a565b50606083015161157760608601826114b8565b50608083015161158a608086018261149a565b5060a083015161159d60a08601826114c7565b5060c083015184820360c08601526115b582826114f0565b91505060e083015184820360e08601526115cf82826114f0565b9150508091505092915050565b5f6040820190508181035f8301526115f48185611528565b9050611603602083018461137f565b9392505050565b61161381611121565b811461161d575f5ffd5b50565b5f8151905061162e8161160a565b92915050565b5f6020828403121561164957611648610d6d565b5b5f61165684828501611620565b91505092915050565b5f8160e01c9050919050565b5f60033d11156116875760045f5f3e6116845f5161165f565b90505b90565b5f60443d106117165761169b610d64565b60043d036004823e80513d602482011167ffffffffffffffff821117156116c3575050611716565b808201805167ffffffffffffffff8111156116e15750505050611716565b80602083010160043d0385018111156116fe575050505050611716565b61170d82602001850186610de9565b82955050505050505b90565b5f5f60233d111561173357602060045f3e600191505f5190505b9091565b5f8151905061174581610d7e565b92915050565b5f602082840312156117605761175f610d6d565b5b5f61176d84828501611737565b91505092915050565b61177f81610e57565b82525050565b5f6040820190506117985f83018561137f565b6117a56020830184611776565b9392505050565b5f819050602082019050919050565b5f7fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b5f6117f182516117bb565b80915050919050565b5f82821b905092915050565b5f611810826114d6565b8261181a846117ac565b9050611825816117e6565b92506004821015611865576118607fffffffff00000000000000000000000000000000000000000000000000000000836004036008026117fa565b831692505b505091905056fe5065726d697373696f6e496e76616c69645f526563697069656e745369676e61747572655065726d697373696f6e496e76616c69645f4973737565725369676e6174757265a2646970667358221220ea7aaacf8df597acf06d11b043b93f49496ae268dcfd4e421962c00a017689f664736f6c63430008210033',
-} satisfies MockArtifact;