Merge pull request #129 from PracticalParticle/work

JaCoderX · web-flow · commit 4a7b5d3c9715 · 2026-03-14T22:50:08.000+02:00
chore: consolidate versioning approach in EngineBlox library and rela…
diff --git a/.github/workflows/sync-contract-versions.yml b/.github/workflows/sync-contract-versions.yml
@@ -73,15 +73,15 @@ jobs:
           DIFF_OUTPUT=$(git diff contracts/core/lib/EngineBlox.sol)
           
           # Check if diff contains only version constant changes
-          # Version constants are: VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH
-          if echo "$DIFF_OUTPUT" | grep -qE "^[-+].*VERSION_(MAJOR|MINOR|PATCH)" && \
-             ! echo "$DIFF_OUTPUT" | grep -vE "^[-+].*VERSION_(MAJOR|MINOR|PATCH)|^@|^index|^---|^\+\+\+" | grep -qE "^[-+]"; then
-            echo "✓ Only version constants changed, safe to commit"
+          # Version constant is: string public constant VERSION = "..."
+          if echo "$DIFF_OUTPUT" | grep -qE "^[-+].*constant\s+VERSION\s*=" && \
+             ! echo "$DIFF_OUTPUT" | grep -vE "^[-+].*constant\s+VERSION\s*=|^@|^index|^---|^\+\+\+" | grep -qE "^[-+]"; then
+            echo "✓ Only version constant changed, safe to commit"
             echo "safe=true" >> $GITHUB_OUTPUT
           else
-            echo "❌ ERROR: Changes detected in EngineBlox.sol are not limited to version constants!"
+            echo "❌ ERROR: Changes detected in EngineBlox.sol are not limited to version constant!"
             echo ""
-            echo "The workflow detected changes beyond VERSION_MAJOR, VERSION_MINOR, or VERSION_PATCH."
+            echo "The workflow detected changes beyond the VERSION constant."
             echo "This could indicate uncommitted changes were accidentally included."
             echo ""
             echo "Full diff:"
diff --git a/abi/EngineBlox.abi.json b/abi/EngineBlox.abi.json
@@ -689,38 +689,12 @@
   },
   {
     "inputs": [],
-    "name": "VERSION_MAJOR",
+    "name": "VERSION",
     "outputs": [
       {
-        "internalType": "uint8",
-        "name": "",
-        "type": "uint8"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "VERSION_MINOR",
-    "outputs": [
-      {
-        "internalType": "uint8",
+        "internalType": "string",
         "name": "",
-        "type": "uint8"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "VERSION_PATCH",
-    "outputs": [
-      {
-        "internalType": "uint8",
-        "name": "",
-        "type": "uint8"
+        "type": "string"
       }
     ],
     "stateMutability": "view",
diff --git a/contracts/core/lib/EngineBlox.sol b/contracts/core/lib/EngineBlox.sol
@@ -32,9 +32,7 @@ import "./interfaces/IEventForwarder.sol";
 library EngineBlox {
     // ============ VERSION INFORMATION ============
     bytes32 public constant PROTOCOL_NAME_HASH = keccak256("Bloxchain");
-    uint8 public constant VERSION_MAJOR = 1;
-    uint8 public constant VERSION_MINOR = 0;
-    uint8 public constant VERSION_PATCH = 0;
+    string public constant VERSION = "1.0.0";
     
     // ============ SYSTEM SAFETY LIMITS ============
     // These constants define the safety range limits for system operations
@@ -206,10 +204,25 @@ library EngineBlox {
     bytes32 public constant NATIVE_TRANSFER_OPERATION = keccak256("NATIVE_TRANSFER");
     
     // EIP-712 Type Hashes (selective meta-tx payload: MetaTxRecord = txId + params + payment only)
-    // These follow the standard EIP-712 convention so that eth_signTypedData_v4 and equivalent
+    // These follow the canonical EIP-712 convention so that eth_signTypedData_v4 and equivalent
     // wallet typed-data signers can reproduce the same hashes when given matching type definitions.
-    bytes32 private constant META_TX_TYPE_HASH = keccak256("MetaTransaction(MetaTxRecord txRecord,MetaTxParams params,bytes data)");
-    bytes32 private constant META_TX_RECORD_TYPE_HASH = keccak256("MetaTxRecord(uint256 txId,TxParams params,PaymentDetails payment)");
+    //
+    // Canonical primary type string for MetaTransaction (primary type + all referenced types,
+    // appended in alphabetical order by type name
+    bytes32 private constant META_TX_TYPE_HASH = keccak256(
+        "MetaTransaction(MetaTxRecord txRecord,MetaTxParams params,bytes data)"
+        "MetaTxParams(uint256 chainId,uint256 nonce,address handlerContract,bytes4 handlerSelector,uint8 action,uint256 deadline,uint256 maxGasPrice,address signer)"
+        "MetaTxRecord(uint256 txId,TxParams params,PaymentDetails payment)"
+        "PaymentDetails(address recipient,uint256 nativeTokenAmount,address erc20TokenAddress,uint256 erc20TokenAmount)"
+        "TxParams(address requester,address target,uint256 value,uint256 gasLimit,bytes32 operationType,bytes4 executionSelector,bytes executionParams)"
+    );
+
+    // Canonical primary type string for MetaTxRecord (primary type + its referenced types).
+    bytes32 private constant META_TX_RECORD_TYPE_HASH = keccak256(
+        "MetaTxRecord(uint256 txId,TxParams params,PaymentDetails payment)"
+        "PaymentDetails(address recipient,uint256 nativeTokenAmount,address erc20TokenAddress,uint256 erc20TokenAmount)"
+        "TxParams(address requester,address target,uint256 value,uint256 gasLimit,bytes32 operationType,bytes4 executionSelector,bytes executionParams)"
+    );
     bytes32 private constant TX_PARAMS_TYPE_HASH = keccak256("TxParams(address requester,address target,uint256 value,uint256 gasLimit,bytes32 operationType,bytes4 executionSelector,bytes executionParams)");
     bytes32 private constant META_TX_PARAMS_TYPE_HASH = keccak256("MetaTxParams(uint256 chainId,uint256 nonce,address handlerContract,bytes4 handlerSelector,uint8 action,uint256 deadline,uint256 maxGasPrice,address signer)");
     bytes32 private constant PAYMENT_DETAILS_TYPE_HASH = keccak256("PaymentDetails(address recipient,uint256 nativeTokenAmount,address erc20TokenAddress,uint256 erc20TokenAmount)");
@@ -1713,13 +1726,15 @@ library EngineBlox {
      * @return The EIP-712 digest (no prefix; use standard recovery)
      */
     function generateMessageHash(MetaTransaction memory metaTx) private view returns (bytes32) {
-        bytes32 domainSeparator = keccak256(abi.encode(
-            DOMAIN_SEPARATOR_TYPE_HASH,
-            PROTOCOL_NAME_HASH,
-            keccak256(abi.encodePacked(VERSION_MAJOR, ".", VERSION_MINOR, ".", VERSION_PATCH)),
-            block.chainid,
-            address(this)
-        ));
+        bytes32 domainSeparator = keccak256(
+            abi.encode(
+                DOMAIN_SEPARATOR_TYPE_HASH,
+                PROTOCOL_NAME_HASH,
+                keccak256(bytes(VERSION)),
+                block.chainid,
+                address(this)
+            )
+        );
 
         TxParams memory tp = metaTx.txRecord.params;
         bytes32 txParamsStructHash = keccak256(abi.encode(
@@ -1778,11 +1793,20 @@ library EngineBlox {
 
     /**
      * @dev Recovers the signer from the EIP-712 digest and signature. Uses standard EIP-712 recovery (no message prefix).
-     *      Integrators must sign the digest returned by generateMessageHash as a raw hash—e.g.
-     *      account.sign({ hash: contractDigest }) or equivalent raw-hash signing API—with no
-     *      EIP-191/personal prefix, so signatures match this ecrecover(messageHash, v, r, s) verification.
-     *      Do NOT use personal_sign or generic eth_signTypedData_v4; the contract uses abi.encodePacked
-     *      for the domain version and a custom META_TX_TYPE_HASH, so those produce incompatible hashes.
+     *
+     *      Integrators have two equivalent options:
+     *      - Use typed-data signing (eth_signTypedData_v4 / signTypedData) with:
+     *          - primaryType: MetaTransaction
+     *          - domain: { name: "Bloxchain", version: "1.0.0", chainId, verifyingContract }
+     *          - types: MetaTransaction, MetaTxRecord, TxParams, MetaTxParams, PaymentDetails
+     *        In this case the wallet computes the same digest as generateMessageHash and signs it.
+     *      - Sign the digest returned by generateMessageHash as a raw hash—e.g.
+     *        account.sign({ hash: contractDigest }) or equivalent raw-hash signing API—with no
+     *        EIP-191/personal prefix.
+     *
+     *      In all cases, this function applies ecrecover(messageHash, v, r, s) over the raw EIP-712 digest.
+     *      personal_sign / EIP-191-prefixed signatures remain incompatible.
+     *
      * @param messageHash The EIP-712 digest (keccak256("\x19\x01" || domainSeparator || structHash))
      * @param signature The signature (r, s, v)
      * @return The address of the signer
diff --git a/scripts/sync-versions.cjs b/scripts/sync-versions.cjs
@@ -11,6 +11,7 @@ const rootPackageJsonPath = path.join(rootDir, 'package.json');
 const contractsPackageJsonPath = path.join(rootDir, 'package', 'package.json');
 const sdkPackageJsonPath = path.join(rootDir, 'sdk', 'typescript', 'package.json');
 const engineBloxPath = path.join(rootDir, 'contracts', 'core', 'lib', 'EngineBlox.sol');
+const sdkEngineBloxPath = path.join(rootDir, 'sdk', 'typescript', 'lib', 'EngineBlox.tsx');
 
 // Parse command line arguments for tag
 let preReleaseTag = null;
@@ -140,52 +141,20 @@ if (fs.existsSync(engineBloxPath)) {
   let engineBloxContent = fs.readFileSync(engineBloxPath, 'utf8');
   let updated = false;
   
-  // Update VERSION_MAJOR (uses base version, no pre-release tag)
-  const majorRegex = /(uint8\s+public\s+constant\s+VERSION_MAJOR\s*=\s*)(\d+)/;
-  const majorMatch = engineBloxContent.match(majorRegex);
-  if (majorMatch) {
-    const oldMajor = parseInt(majorMatch[2], 10);
-    if (oldMajor !== versionMajor) {
-      engineBloxContent = engineBloxContent.replace(majorRegex, `$1${versionMajor}`);
+  // Update VERSION string (uses base version, no pre-release tag)
+  const versionRegex = /(string\s+public\s+constant\s+VERSION\s*=\s*)"([^"]*)"/;
+  const versionMatch = engineBloxContent.match(versionRegex);
+  if (versionMatch) {
+    const oldVersion = versionMatch[2];
+    if (oldVersion !== baseVersion) {
+      engineBloxContent = engineBloxContent.replace(versionRegex, `$1"${baseVersion}"`);
       updated = true;
-      console.log(`✅ EngineBlox.sol VERSION_MAJOR: ${oldMajor} → ${versionMajor} (base version, no pre-release tag)`);
+      console.log(`✅ EngineBlox.sol VERSION: "${oldVersion}" → "${baseVersion}" (base version, no pre-release tag)`);
     } else {
-      console.log(`✓  EngineBlox.sol VERSION_MAJOR: ${versionMajor} (already synced)`);
+      console.log(`✓  EngineBlox.sol VERSION: "${baseVersion}" (already synced)`);
     }
   } else {
-    console.warn('⚠️  Could not find VERSION_MAJOR constant in EngineBlox.sol');
-  }
-  
-  // Update VERSION_MINOR (uses base version, no pre-release tag)
-  const minorRegex = /(uint8\s+public\s+constant\s+VERSION_MINOR\s*=\s*)(\d+)/;
-  const minorMatch = engineBloxContent.match(minorRegex);
-  if (minorMatch) {
-    const oldMinor = parseInt(minorMatch[2], 10);
-    if (oldMinor !== versionMinor) {
-      engineBloxContent = engineBloxContent.replace(minorRegex, `$1${versionMinor}`);
-      updated = true;
-      console.log(`✅ EngineBlox.sol VERSION_MINOR: ${oldMinor} → ${versionMinor} (base version, no pre-release tag)`);
-    } else {
-      console.log(`✓  EngineBlox.sol VERSION_MINOR: ${versionMinor} (already synced)`);
-    }
-  } else {
-    console.warn('⚠️  Could not find VERSION_MINOR constant in EngineBlox.sol');
-  }
-  
-  // Update VERSION_PATCH (uses base version, no pre-release tag)
-  const patchRegex = /(uint8\s+public\s+constant\s+VERSION_PATCH\s*=\s*)(\d+)/;
-  const patchMatch = engineBloxContent.match(patchRegex);
-  if (patchMatch) {
-    const oldPatch = parseInt(patchMatch[2], 10);
-    if (oldPatch !== versionPatch) {
-      engineBloxContent = engineBloxContent.replace(patchRegex, `$1${versionPatch}`);
-      updated = true;
-      console.log(`✅ EngineBlox.sol VERSION_PATCH: ${oldPatch} → ${versionPatch} (base version, no pre-release tag)`);
-    } else {
-      console.log(`✓  EngineBlox.sol VERSION_PATCH: ${versionPatch} (already synced)`);
-    }
-  } else {
-    console.warn('⚠️  Could not find VERSION_PATCH constant in EngineBlox.sol');
+    console.warn('⚠️  Could not find VERSION constant in EngineBlox.sol');
   }
   
   if (updated) {
@@ -199,4 +168,22 @@ if (fs.existsSync(engineBloxPath)) {
   console.warn('⚠️  EngineBlox.sol not found');
 }
 
+// Update SDK EngineBlox.tsx VERSION string (same as contract, base version only)
+if (fs.existsSync(sdkEngineBloxPath)) {
+  let sdkContent = fs.readFileSync(sdkEngineBloxPath, 'utf8');
+  const sdkVersionRegex = /(static readonly VERSION: string = )"([^"]*)"/;
+  const sdkMatch = sdkContent.match(sdkVersionRegex);
+  if (sdkMatch && sdkMatch[2] !== baseVersion) {
+    sdkContent = sdkContent.replace(sdkVersionRegex, `$1"${baseVersion}"`);
+    fs.writeFileSync(sdkEngineBloxPath, sdkContent, 'utf8');
+    console.log(`✅ SDK EngineBlox.tsx VERSION: "${sdkMatch[2]}" → "${baseVersion}"`);
+  } else if (sdkMatch) {
+    console.log(`✓  SDK EngineBlox.tsx VERSION: "${baseVersion}" (already synced)`);
+  } else {
+    console.warn('⚠️  Could not find VERSION in SDK EngineBlox.tsx');
+  }
+} else {
+  console.warn('⚠️  SDK EngineBlox.tsx not found');
+}
+
 console.log('\n✅ Version sync complete!');
diff --git a/sdk/typescript/abi/EngineBlox.abi.json b/sdk/typescript/abi/EngineBlox.abi.json
@@ -689,38 +689,12 @@
   },
   {
     "inputs": [],
-    "name": "VERSION_MAJOR",
+    "name": "VERSION",
     "outputs": [
       {
-        "internalType": "uint8",
-        "name": "",
-        "type": "uint8"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "VERSION_MINOR",
-    "outputs": [
-      {
-        "internalType": "uint8",
+        "internalType": "string",
         "name": "",
-        "type": "uint8"
-      }
-    ],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "VERSION_PATCH",
-    "outputs": [
-      {
-        "internalType": "uint8",
-        "name": "",
-        "type": "uint8"
+        "type": "string"
       }
     ],
     "stateMutability": "view",
diff --git a/sdk/typescript/lib/EngineBlox.tsx b/sdk/typescript/lib/EngineBlox.tsx
@@ -23,7 +23,7 @@ const keccak256 = (str: string): Hex => {
  * 
  * // Access constants
  * const protocolName = EngineBlox.PROTOCOL_NAME_HASH;
- * const version = `${EngineBlox.VERSION_MAJOR}.${EngineBlox.VERSION_MINOR}.${EngineBlox.VERSION_PATCH}`;
+ * const version = EngineBlox.VERSION;
  * 
  * // Use pure functions
  * const signer = EngineBlox.recoverSigner(messageHash, signature);
@@ -41,19 +41,9 @@ export class EngineBlox {
   static readonly PROTOCOL_NAME_HASH: Hex = keccak256("Bloxchain");
   
   /**
-   * Major version number
+   * Protocol version string (semver, e.g. "1.0.0"). Matches EngineBlox.sol VERSION and EIP-712 domain version.
    */
-  static readonly VERSION_MAJOR: number = 1;
-  
-  /**
-   * Minor version number
-   */
-  static readonly VERSION_MINOR: number = 0;
-  
-  /**
-   * Patch version number
-   */
-  static readonly VERSION_PATCH: number = 0;
+  static readonly VERSION: string = "1.0.0";
 
   // ============ FUNCTION SELECTORS ============
   
diff --git a/sdk/typescript/utils/metaTx/metaTransaction.tsx b/sdk/typescript/utils/metaTx/metaTransaction.tsx
@@ -14,11 +14,12 @@ import {
 } from '../../interfaces/lib.index';
 import { TxAction } from '../../types/lib.index';
 import BaseStateMachineABI from '../../abi/BaseStateMachine.abi.json';
+import { EngineBlox } from '../../lib/EngineBlox';
 
 /** EIP-712 domain and types matching EngineBlox (selective MetaTxRecord: txId, params, payment only) */
 export const META_TX_DOMAIN = {
   name: 'Bloxchain' as const,
-  version: '1.0.0' as const,
+  version: EngineBlox.VERSION,
   chainId: 0, // set per sign
   verifyingContract: '0x' as Address // set per sign
 };
diff --git a/test/foundry/helpers/TestHelpers.sol b/test/foundry/helpers/TestHelpers.sol
@@ -92,8 +92,19 @@ library TestHelpers {
 contract MetaTxSigner is Test {
     // EIP-712 type hashes matching EngineBlox (selective MetaTxRecord: txId, params, payment only)
     // These must stay in sync with EngineBlox.META_TX_TYPE_HASH and EngineBlox.META_TX_RECORD_TYPE_HASH.
-    bytes32 private constant META_TX_TYPE_HASH = keccak256("MetaTransaction(MetaTxRecord txRecord,MetaTxParams params,bytes data)");
-    bytes32 private constant META_TX_RECORD_TYPE_HASH = keccak256("MetaTxRecord(uint256 txId,TxParams params,PaymentDetails payment)");
+    bytes32 private constant META_TX_TYPE_HASH = keccak256(
+        "MetaTransaction(MetaTxRecord txRecord,MetaTxParams params,bytes data)"
+        "MetaTxParams(uint256 chainId,uint256 nonce,address handlerContract,bytes4 handlerSelector,uint8 action,uint256 deadline,uint256 maxGasPrice,address signer)"
+        "MetaTxRecord(uint256 txId,TxParams params,PaymentDetails payment)"
+        "PaymentDetails(address recipient,uint256 nativeTokenAmount,address erc20TokenAddress,uint256 erc20TokenAmount)"
+        "TxParams(address requester,address target,uint256 value,uint256 gasLimit,bytes32 operationType,bytes4 executionSelector,bytes executionParams)"
+    );
+
+    bytes32 private constant META_TX_RECORD_TYPE_HASH = keccak256(
+        "MetaTxRecord(uint256 txId,TxParams params,PaymentDetails payment)"
+        "PaymentDetails(address recipient,uint256 nativeTokenAmount,address erc20TokenAddress,uint256 erc20TokenAmount)"
+        "TxParams(address requester,address target,uint256 value,uint256 gasLimit,bytes32 operationType,bytes4 executionSelector,bytes executionParams)"
+    );
     bytes32 private constant TX_PARAMS_TYPE_HASH = keccak256("TxParams(address requester,address target,uint256 value,uint256 gasLimit,bytes32 operationType,bytes4 executionSelector,bytes executionParams)");
     bytes32 private constant META_TX_PARAMS_TYPE_HASH = keccak256("MetaTxParams(uint256 chainId,uint256 nonce,address handlerContract,bytes4 handlerSelector,uint8 action,uint256 deadline,uint256 maxGasPrice,address signer)");
     bytes32 private constant PAYMENT_DETAILS_TYPE_HASH = keccak256("PaymentDetails(address recipient,uint256 nativeTokenAmount,address erc20TokenAddress,uint256 erc20TokenAmount)");
@@ -120,13 +131,15 @@ contract MetaTxSigner is Test {
         EngineBlox.MetaTransaction memory metaTx,
         address verifyingContract
     ) public view returns (bytes32) {
-        bytes32 domainSeparator = keccak256(abi.encode(
-            DOMAIN_SEPARATOR_TYPE_HASH,
-            PROTOCOL_NAME_HASH,
-            keccak256(abi.encodePacked(uint8(1), ".", uint8(0), ".", uint8(0))),
-            block.chainid,
-            verifyingContract
-        ));
+        bytes32 domainSeparator = keccak256(
+            abi.encode(
+                DOMAIN_SEPARATOR_TYPE_HASH,
+                PROTOCOL_NAME_HASH,
+                keccak256(bytes("1.0.0")),
+                block.chainid,
+                verifyingContract
+            )
+        );
 
         EngineBlox.TxParams memory tp = metaTx.txRecord.params;
         bytes32 txParamsStructHash = keccak256(abi.encode(
