Deployment: Improve version management (#789)

* base implementation

* modify make salt

* refactor prefix -> suffix

* write version in env/files

* add version and fix env files

* add suffix separation (it mimics testnet deployments)

* fix makeSalt to work correctly in all current cases

* add legacy support to makeSalt

* fix preview with legacy

* simplify and double-check correct behavior

* adapt PoolHooks to BaseDeployer

* add pharos

* fix imports

* remove warnings

* add test create address vs preview address

* correctness

* fix teg env CI job

* ensure version length

* fix comment

* use constant for the version

Author: lemunozm

.github/ci-scripts/compute-env-tags.js

@@ -12,7 +12,7 @@
  * 
  * Tag format: deploy-${environment}-${version}-${shortSha}
  *   - environment: from `network.environment` (e.g. mainnet, testnet)
- *   - version: from deploymentInfo["deploy:protocol"].version
+ *   - version: highest semver found across all contracts[*].version in the env file
  *   - shortSha: first 7 chars of the deployment gitCommit
  * 
  * The tag points directly to the deployment commit SHA referenced in the env file,
@@ -73,24 +73,28 @@ function extractTagInfo(filePath) {
             return [];
         }
 
+        // Determine the version from the highest version found across all contracts
+        const version = findHighestContractVersion(chain.contracts);
+
         const results = [];
 
-        // Look for deploy:protocol.version
+        // Look for deploy:protocol gitCommit
         const protocolDeploy = deploymentInfo["deploy:protocol"];
         if (protocolDeploy?.gitCommit) {
             results.push({
                 environment,
-                version: protocolDeploy.version || null,
+                version,
                 gitCommit: protocolDeploy.gitCommit,
             });
         }
 
-        // Fallback: check any deploymentInfo entry for gitCommit
-        for (const value of Object.values(deploymentInfo)) {
+        // Fallback: check any other deploymentInfo entry for gitCommit
+        for (const [key, value] of Object.entries(deploymentInfo)) {
+            if (key === "deploy:protocol") continue;
             if (value?.gitCommit) {
                 results.push({
                     environment,
-                    version: value.version || null,
+                    version,
                     gitCommit: value.gitCommit,
                 });
             }
@@ -119,6 +123,56 @@ function generateTimestamp() {
     return `${year}${month}${day}-${hours}${minutes}${seconds}`;
 }
 
+/**
+ * Parses a version string into its numeric components.
+ * Supports formats: "v3.1.0", "v3.1", "v3", "3.1.0", "3.1", "3" (optional 'v' prefix)
+ * @param {string} versionStr - Version string to parse
+ * @returns {{ major: number, minor: number, patch: number, original: string } | null}
+ */
+function parseVersion(versionStr) {
+    if (!versionStr || typeof versionStr !== "string") return null;
+    const cleaned = versionStr.replace(/^v/i, "");
+    const parts = cleaned.split(".").map((p) => parseInt(p, 10));
+    if (parts.length === 0 || parts.some(isNaN)) return null;
+    return {
+        major: parts[0] || 0,
+        minor: parts[1] || 0,
+        patch: parts[2] || 0,
+        original: versionStr,
+    };
+}
+
+/**
+ * Compares two parsed versions. Returns positive if a > b, negative if a < b, 0 if equal.
+ * @param {{ major: number, minor: number, patch: number }} a
+ * @param {{ major: number, minor: number, patch: number }} b
+ * @returns {number}
+ */
+function compareVersions(a, b) {
+    if (a.major !== b.major) return a.major - b.major;
+    if (a.minor !== b.minor) return a.minor - b.minor;
+    return a.patch - b.patch;
+}
+
+/**
+ * Finds the highest version across all contracts in the env file.
+ * @param {Object} contracts - The contracts object from the env JSON
+ * @returns {string|null} The highest version string found, or null if none
+ */
+function findHighestContractVersion(contracts) {
+    if (!contracts || typeof contracts !== "object") return null;
+    let highest = null;
+    for (const contract of Object.values(contracts)) {
+        if (!contract?.version) continue;
+        const parsed = parseVersion(contract.version);
+        if (!parsed) continue;
+        if (!highest || compareVersions(parsed, highest) > 0) {
+            highest = parsed;
+        }
+    }
+    return highest?.original || null;
+}
+
 /**
  * Sanitizes a version string for use in a git tag name
  * @param {string} version - Version string (e.g., "v3.1", "test-v3.0.1")

.github/workflows/deploy.yml

@@ -6,8 +6,8 @@ on:
       - ".github/workflows/deploy.yml"
   workflow_dispatch:
     inputs:
-      version:
-        description: "Deployment version (e.g. v3.1.5) - if not provided, the job will generate a unique version number"
+      suffix:
+        description: "Salt suffix for isolated deployments (e.g. PR-123). Leave empty for canonical versioned addresses."
         required: false
         type: string
         default: "TEST"
@@ -50,18 +50,18 @@ jobs:
         id: set-vars
         run: |
           if [ "${{ github.event_name }}" = "pull_request" ]; then
-            echo "version=PR-${{ github.run_number }}-${{ github.sha }}" >> $GITHUB_OUTPUT
+            echo "suffix=PR-${{ github.run_number }}-${{ github.sha }}" >> $GITHUB_OUTPUT
             echo "dry=--dry-run" >> $GITHUB_OUTPUT
           else
-            if [ "${{ github.event.inputs.version }}" = "TEST" ]; then
-              echo "version=TEST-${{ github.run_number }}-${{ github.sha }}" >> $GITHUB_OUTPUT
+            if [ "${{ github.event.inputs.suffix }}" = "TEST" ]; then
+              echo "suffix=TEST-${{ github.run_number }}-${{ github.sha }}" >> $GITHUB_OUTPUT
             else
-              echo "version=${{ github.event.inputs.version }}" >> $GITHUB_OUTPUT
+              echo "suffix=${{ github.event.inputs.suffix }}" >> $GITHUB_OUTPUT
             fi
             echo "dry=" >> $GITHUB_OUTPUT
           fi
       - name: Deploying all testnets
         env:
-          VERSION: ${{ steps.set-vars.outputs.version }}
+          SUFFIX: ${{ steps.set-vars.outputs.suffix }}
         run: |
           python3 script/deploy/deploy.py ${{ steps.set-vars.outputs.dry }} deploy:testnets