refactor: updates to HTTPZ (#739)

* refactor: updates to HTTPZ

* docs: fix broken link

Author: PacificYield

codegen/main.ts

@@ -4,7 +4,7 @@ import path from 'path';
 import { validateFHETypes, validateOperators } from './common';
 import { generateOverloads } from './generateOverloads';
 import { ALL_OPERATORS } from './operators';
-import { generateSolidityFheType, generateSolidityImplLib, generateSolidityTFHELib } from './templates';
+import { generateSolidityFheType, generateSolidityHTTPZLib, generateSolidityImplLib } from './templates';
 import {
   generateSolidityOverloadTestFiles,
   generateSolidityUnitTestContracts,
@@ -19,7 +19,7 @@ import { ALL_FHE_TYPES } from './types';
  * This function performs the following steps:
  * 1. Generates FHE types from a JSON file.
  * 2. Validates and processes the list of operators.
- * 3. Generates Solidity source code for TFHE and implementation contracts.
+ * 3. Generates Solidity source code for HTTPZ and implementation contracts.
  * 4. Splits the generated overloads into multiple shards to avoid exceeding Solidity's contract size limit.
  * 5. Writes the generated Solidity contracts and test files to the appropriate directories.
  * 6. Generates TypeScript test code for the split overloads and writes them to the test directory.
@@ -36,7 +36,7 @@ function generateAllFiles() {
   /// Generate core Solidity contract files.
   writeFileSync('lib/FheType.sol', generateSolidityFheType(ALL_FHE_TYPES));
   writeFileSync('lib/Impl.sol', generateSolidityImplLib(ALL_OPERATORS));
-  writeFileSync('lib/TFHE.sol', generateSolidityTFHELib(ALL_OPERATORS, ALL_FHE_TYPES));
+  writeFileSync('lib/HTTPZ.sol', generateSolidityHTTPZLib(ALL_OPERATORS, ALL_FHE_TYPES));
 
   // TODO: For now, the testgen only supports automatically generated tests for euintXX.
   /// Generate overloads, split them into shards, and generate Solidity contracts to be used for TypeScript unit test files.
@@ -49,11 +49,11 @@ function generateAllFiles() {
   const overloadShards = splitOverloadsToShards(generateSolidityOverloadTestFiles(ALL_OPERATORS, ALL_FHE_TYPES));
   mkdirSync('contracts/tests', { recursive: true });
   overloadShards.forEach((os) => {
-    writeFileSync(`examples/tests/TFHETestSuite${os.shardNumber}.sol`, generateSolidityUnitTestContracts(os));
+    writeFileSync(`examples/tests/HTTPZTestSuite${os.shardNumber}.sol`, generateSolidityUnitTestContracts(os));
   });
 
   const tsSplits: string[] = generateTypeScriptTestCode(overloadShards, numberOfTestSplits);
-  tsSplits.forEach((split, splitIdx) => writeFileSync(`test/tfheOperations/tfheOperations${splitIdx + 1}.ts`, split));
+  tsSplits.forEach((split, splitIdx) => writeFileSync(`test/httpzOperations/httpzOperations${splitIdx + 1}.ts`, split));
 }
 
 generateAllFiles();

codegen/overloads.json

@@ -130,11 +130,11 @@ function handleSolidityBinaryOperatorForImpl(op: Operator): string {
   return (
     `
     /**
-     * @dev Returns the FHEVM config.
+     * @dev Returns the HTTPZ config.
      */
     function ${op.name}(bytes32 lhs, bytes32 rhs${scalarArg}) internal returns (bytes32 result) {
         ${scalarSection}
-        FHEVMConfigStruct storage $ = getFHEVMConfig();
+        HTTPZConfigStruct storage $ = getHTTPZConfig();
         result = ITFHEExecutor($.TFHEExecutorAddress).${op.fheLibName}(lhs, rhs, scalarByte);
     }` + '\n'
   );
@@ -166,28 +166,28 @@ ${generateInputVerifierInterface()}
  * @notice  This library is the core implementation for computing FHE operations (e.g. add, sub, xor).
  */
 library Impl {
-  /// keccak256(abi.encode(uint256(keccak256("fhevm.storage.FHEVMConfig")) - 1)) & ~bytes32(uint256(0xff))
-  bytes32 private constant FHEVMConfigLocation = 0xed8d60e34876f751cc8b014c560745351147d9de11b9347c854e881b128ea600;
+  /// keccak256(abi.encode(uint256(keccak256("httpz.storage.HTTPZConfig")) - 1)) & ~bytes32(uint256(0xff))
+  bytes32 private constant HTTPZConfigLocation = 0x15b1d18ad3df4183245a6a11b17d9fa31dc4c35ffbf591bdfd0f9704a799c300;
 
   /**
-   * @dev Returns the FHEVM config.
+   * @dev Returns the HTTPZ config.
    */
-  function getFHEVMConfig() internal pure returns (FHEVMConfigStruct storage $) {
+  function getHTTPZConfig() internal pure returns (HTTPZConfigStruct storage $) {
       assembly {
-          $.slot := FHEVMConfigLocation
+          $.slot := HTTPZConfigLocation
       }
   }
 
   /**
-   * @notice            Sets the FHEVM addresses.
-   * @param fhevmConfig FHEVM config struct that contains contract addresses.
+   * @notice            Sets the coprocessor addresses.
+   * @param httpzConfig HTTPZ config struct that contains contract addresses.
   */
-  function setFHEVM(FHEVMConfigStruct memory fhevmConfig) internal {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
-      $.ACLAddress = fhevmConfig.ACLAddress;
-      $.TFHEExecutorAddress = fhevmConfig.TFHEExecutorAddress;
-      $.KMSVerifierAddress = fhevmConfig.KMSVerifierAddress;
-      $.InputVerifierAddress = fhevmConfig.InputVerifierAddress;
+  function setCoprocessor(HTTPZConfigStruct memory httpzConfig) internal {
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
+      $.ACLAddress = httpzConfig.ACLAddress;
+      $.TFHEExecutorAddress = httpzConfig.TFHEExecutorAddress;
+      $.KMSVerifierAddress = httpzConfig.KMSVerifierAddress;
+      $.InputVerifierAddress = httpzConfig.InputVerifierAddress;
   }
 `);
 
@@ -214,10 +214,10 @@ function generateImplCoprocessorInterface(operators: Operator[]): string {
 
   res.push(`
     /**
-     * @title   FHEVMConfigStruct
+     * @title   HTTPZConfigStruct
      * @notice  This struct contains all addresses of core contracts, which are needed in a typical dApp.
      */
-    struct FHEVMConfigStruct {
+    struct HTTPZConfigStruct {
         address ACLAddress;
         address TFHEExecutorAddress;
         address KMSVerifierAddress;
@@ -414,7 +414,7 @@ function generateInputVerifierInterface(): string {
   `;
 }
 
-export function generateSolidityTFHELib(operators: Operator[], fheTypes: FheType[]): string {
+export function generateSolidityHTTPZLib(operators: Operator[], fheTypes: FheType[]): string {
   const res: string[] = [];
 
   res.push(`// SPDX-License-Identifier: BSD-3-Clause-Clear
@@ -426,11 +426,11 @@ export function generateSolidityTFHELib(operators: Operator[], fheTypes: FheType
   ${createSolidityTypeAliasesFromFheTypes(fheTypes)}
 
   /**
-   * @title   TFHE
+   * @title   HTTPZ
    * @notice  This library is the interaction point for all smart contract developers
-   *          that interact with TFHE.
+   *          that interact with the HTTPZ protocol.
    */
-  library TFHE {
+  library HTTPZ {
 
   /// @notice Returned if the input's length is greater than 64 bytes.
   error InputLengthAbove64Bytes(uint256 inputLength);
@@ -442,11 +442,11 @@ export function generateSolidityTFHELib(operators: Operator[], fheTypes: FheType
   error InputLengthAbove256Bytes(uint256 inputLength);
 
     /**
-     * @notice            Sets the FHEVM addresses.
-     * @param fhevmConfig FHEVM config struct that contains contract addresses.
+     * @notice            Sets the coprocessor addresses.
+     * @param httpzConfig HTTPZ config struct that contains contract addresses.
     */
-    function setFHEVM(FHEVMConfigStruct memory fhevmConfig) internal {
-        Impl.setFHEVM(fhevmConfig);
+    function setCoprocessor(HTTPZConfigStruct memory httpzConfig) internal {
+        Impl.setCoprocessor(httpzConfig);
     }
   `);
 
@@ -973,7 +973,7 @@ function handleSolidityTFHEConvertPlaintextAndEinputToRespectiveType(fheType: Ad
 function handleUnaryOperatorForImpl(op: Operator): string {
   return `
     function ${op.name}(bytes32 ct) internal returns (bytes32 result) {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       result = ITFHEExecutor($.TFHEExecutorAddress).${op.fheLibName}(ct);
     }
   `;
@@ -1089,7 +1089,7 @@ function generateCustomMethodsForImpl(): string {
     *      If 'control's value is 'false', the result has the same value as 'ifFalse'.
     */
     function select(bytes32 control, bytes32 ifTrue, bytes32 ifFalse) internal returns (bytes32 result) {
-        FHEVMConfigStruct storage $ = getFHEVMConfig();
+        HTTPZConfigStruct storage $ = getHTTPZConfig();
         result = ITFHEExecutor($.TFHEExecutorAddress).fheIfThenElse(control, ifTrue, ifFalse);
     }
 
@@ -1105,7 +1105,7 @@ function generateCustomMethodsForImpl(): string {
         bytes memory inputProof,
         FheType toType
     ) internal returns (bytes32 result) {
-        FHEVMConfigStruct storage $ = getFHEVMConfig();
+        HTTPZConfigStruct storage $ = getHTTPZConfig();
         result = ITFHEExecutor($.TFHEExecutorAddress).verifyCiphertext(inputHandle, msg.sender, inputProof, toType);
         IACL($.ACLAddress).allowTransient(result, msg.sender);
     }
@@ -1120,7 +1120,7 @@ function generateCustomMethodsForImpl(): string {
         bytes32 ciphertext,
         FheType toType
     ) internal returns (bytes32 result) {
-        FHEVMConfigStruct storage $ = getFHEVMConfig();
+        HTTPZConfigStruct storage $ = getHTTPZConfig();
         result = ITFHEExecutor($.TFHEExecutorAddress).cast(ciphertext, toType);
     }
 
@@ -1134,7 +1134,7 @@ function generateCustomMethodsForImpl(): string {
         uint256 value,
         FheType toType
     ) internal returns (bytes32 result) {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
         result = ITFHEExecutor($.TFHEExecutorAddress).trivialEncrypt(value, toType);
     }
 
@@ -1148,7 +1148,7 @@ function generateCustomMethodsForImpl(): string {
       bytes memory value,
       FheType toType
     ) internal returns (bytes32 result) {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
         result = ITFHEExecutor($.TFHEExecutorAddress).trivialEncrypt(value, toType);
     }
 
@@ -1166,7 +1166,7 @@ function generateCustomMethodsForImpl(): string {
       } else {
           scalarByte = 0x00;
       }
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       result = ITFHEExecutor($.TFHEExecutorAddress).fheEq(lhs, rhs, scalarByte);
   }
 
@@ -1184,17 +1184,17 @@ function generateCustomMethodsForImpl(): string {
       } else {
           scalarByte = 0x00;
       }
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       result = ITFHEExecutor($.TFHEExecutorAddress).fheNe(lhs, rhs, scalarByte);
   }
 
     function rand(FheType randType) internal returns(bytes32 result) {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       result = ITFHEExecutor($.TFHEExecutorAddress).fheRand(randType);
     }
 
     function randBounded(uint256 upperBound, FheType randType) internal returns(bytes32 result) {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       result = ITFHEExecutor($.TFHEExecutorAddress).fheRandBounded(upperBound, randType);
     }
 
@@ -1207,7 +1207,7 @@ function generateCustomMethodsForImpl(): string {
      * @param account       Address of the account.
      */
     function allowTransient(bytes32 handle, address account) internal {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       IACL($.ACLAddress).allowTransient(handle, account);
     }
 
@@ -1219,7 +1219,7 @@ function generateCustomMethodsForImpl(): string {
      * @param account       Address of the account.
      */
     function allow(bytes32 handle, address account) internal {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       IACL($.ACLAddress).allow(handle, account);
     }
 
@@ -1228,7 +1228,7 @@ function generateCustomMethodsForImpl(): string {
      *      with Account Abstraction when bundling several UserOps calling the TFHEExecutorCoprocessor.
      */
     function cleanTransientStorageACL() internal {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       IACL($.ACLAddress).cleanTransientStorage();
     }
 
@@ -1238,7 +1238,7 @@ function generateCustomMethodsForImpl(): string {
      *      with Account Abstraction when bundling several UserOps calling the TFHEExecutorCoprocessor.
      */
     function cleanTransientStorageInputVerifier() internal {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       IInputVerifier($.InputVerifierAddress).cleanTransientStorage();
     }
 
@@ -1251,7 +1251,7 @@ function generateCustomMethodsForImpl(): string {
      * @return isAllowed    Whether the account can access the handle.
      */
     function isAllowed(bytes32 handle, address account) internal view returns (bool) {
-      FHEVMConfigStruct storage $ = getFHEVMConfig();
+      HTTPZConfigStruct storage $ = getHTTPZConfig();
       return IACL($.ACLAddress).isAllowed(handle, account);
     }
     `;

codegen/templates.ts

@@ -266,17 +266,17 @@ function generateIntroTestCode(shards: OverloadShard[], idxSplit: number): strin
   `);
   shards.forEach((os) => {
     intro.push(`
-  import type { TFHETestSuite${os.shardNumber} } from '../../types/contracts/tests/TFHETestSuite${os.shardNumber}';
+  import type { HTTPZTestSuite${os.shardNumber} } from '../../types/contracts/tests/HTTPZTestSuite${os.shardNumber}';
   `);
   });
 
   shards.forEach((os) => {
     intro.push(`
-async function deployTfheTestFixture${os.shardNumber}(): Promise<TFHETestSuite${os.shardNumber}> {
+async function deployHTTPZTestFixture${os.shardNumber}(): Promise<HTTPZTestSuite${os.shardNumber}> {
   const signers = await getSigners();
   const admin = signers.alice;
 
-  const contractFactory = await ethers.getContractFactory('TFHETestSuite${os.shardNumber}');
+  const contractFactory = await ethers.getContractFactory('HTTPZTestSuite${os.shardNumber}');
   const contract = await contractFactory.connect(admin).deploy();
   await contract.waitForDeployment();
 
@@ -286,7 +286,7 @@ async function deployTfheTestFixture${os.shardNumber}(): Promise<TFHETestSuite${
   });
 
   intro.push(`
-    describe('TFHE operations ${idxSplit}', function () {
+    describe('HTTPZ operations ${idxSplit}', function () {
         before(async function () {
             await initSigners(1);
             this.signers = await getSigners();
@@ -295,7 +295,7 @@ async function deployTfheTestFixture${os.shardNumber}(): Promise<TFHETestSuite${
 
   shards.forEach((os) => {
     intro.push(`
-            const contract${os.shardNumber} = await deployTfheTestFixture${os.shardNumber}();
+            const contract${os.shardNumber} = await deployHTTPZTestFixture${os.shardNumber}();
             this.contract${os.shardNumber}Address = await contract${os.shardNumber}.getAddress();
             this.contract${os.shardNumber} = contract${os.shardNumber};
     `);
@@ -420,7 +420,7 @@ function ensureNumberAcceptableInBitRange(bits: number, input: number | bigint)
 /**
  * Generates Solidity unit test contracts for a given OverloadShard.
  *
- * This function creates a Solidity contract named `TFHETestSuite` followed by the shard number.
+ * This function creates a Solidity contract named `HTTPZTestSuite` followed by the shard number.
  * The contract includes several public variables of different encrypted types (ebool, euint8, euint16, euint32, euint64, euint128, euint256)
  * and a constructor that sets the FHEVM configuration using the default configuration from `FHEVMConfig`.
  * It also calls the `generateLibCallTest` function to add additional test logic to the contract.
@@ -435,10 +435,10 @@ export function generateSolidityUnitTestContracts(os: OverloadShard): string {
         // SPDX-License-Identifier: BSD-3-Clause-Clear
         pragma solidity ^0.8.24;
 
-        import "../../lib/TFHE.sol";
+        import "../../lib/HTTPZ.sol";
         import "../FHEVMConfig.sol";
 
-        contract TFHETestSuite${os.shardNumber} {
+        contract HTTPZTestSuite${os.shardNumber} {
           ebool public resEbool;
           euint8 public resEuint8;
           euint16 public resEuint16;
@@ -451,7 +451,7 @@ export function generateSolidityUnitTestContracts(os: OverloadShard): string {
           ebytes256 public resEbytes256;
 
           constructor() {
-            TFHE.setFHEVM(FHEVMConfig.defaultConfig());
+            HTTPZ.setCoprocessor(FHEVMConfig.defaultConfig());
           }
 
     `);
@@ -473,7 +473,7 @@ export function generateSolidityUnitTestContracts(os: OverloadShard): string {
  *
  * This function iterates over the overloads in the provided overload shard and generates
  * a Solidity function for each overload. The generated function includes the necessary
- * argument processing, type casting, and the appropriate TFHE library call. The result
+ * argument processing, type casting, and the appropriate HTTPZ library call. The result
  * of the library call is then allowed and assigned to the corresponding state variable.
  */
 function generateLibCallTest(os: OverloadShard, res: string[]) {
@@ -504,10 +504,10 @@ function generateLibCallTest(os: OverloadShard, res: string[]) {
       res.push(`${functionTypeToEncryptedType(o.returnType)} result = ${o.unaryOperator}aProc;`);
       res.push('\n');
     } else {
-      res.push(`${functionTypeToEncryptedType(o.returnType)} result = TFHE.${o.name}(${tfheArgs});`);
+      res.push(`${functionTypeToEncryptedType(o.returnType)} result = HTTPZ.${o.name}(${tfheArgs});`);
       res.push('\n');
     }
-    res.push('TFHE.allowThis(result);');
+    res.push('HTTPZ.allowThis(result);');
     res.push(`${stateVar[functionTypeToEncryptedType(o.returnType) as keyof typeof stateVar]} = result;
         }
     `);
@@ -586,13 +586,13 @@ function signatureContractEncryptedSignature(s: OverloadSignature): string {
 function castExpressionToType(argExpr: string, outputType: FunctionType): string {
   switch (outputType.type) {
     case ArgumentType.Euint:
-      return `TFHE.asEuint${outputType.bits}(${argExpr}, inputProof)`;
+      return `HTTPZ.asEuint${outputType.bits}(${argExpr}, inputProof)`;
     case ArgumentType.Uint:
       return argExpr;
     case ArgumentType.Ebool:
-      return `TFHE.asEbool(${argExpr})`;
+      return `HTTPZ.asEbool(${argExpr})`;
     // case ArgumentType.Ebytes:
-    //  return `TFHE.asEbytes${outputType.bits / 8}(${argExpr})`;
+    //  return `HTTPZ.asEbytes${outputType.bits / 8}(${argExpr})`;
   }
 }