feat: update infra definitions for zkSync v29 (#17)

coffeexcoin · web-flow · commit 7ccd6152c207 · 2025-08-21T09:06:35.000-04:00
* updates for v28.8.0; consensus required

* rm gossipStaticOutbound

* update scripts and docker example

* versions

* make RUST_LOG configurable

* error only on gen secrets

* quote

* up

* reset env file

* updates for 29.0.0 alpha; disable consensus for now

* update for v29.1.0

* formatting; make consensus configmap conditional

* fix helm; add lint wf

* wf

* wf
diff --git a/.github/workflows/helm-lint.yaml b/.github/workflows/helm-lint.yaml
@@ -0,0 +1,82 @@
+name: Helm Lint and Test
+
+on:
+  push:
+    branches: [ main, develop ]
+    paths:
+      - 'charts/**'
+  pull_request:
+    branches: [ main, develop ]
+    paths:
+      - 'charts/**'
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: 'latest'
+
+      - name: Add Helm repositories
+        run: |
+          helm repo add stakewise https://charts.stakewise.io
+          helm repo update
+
+      - name: Install Helm dependencies
+        run: |
+          for chart in charts/*/; do
+            if [ -f "$chart/Chart.yaml" ]; then
+              echo "Installing dependencies for $chart"
+              helm dependency update "$chart"
+            fi
+          done
+
+      - name: Lint Helm charts
+        run: |
+          for chart in charts/*/; do
+            if [ -f "$chart/Chart.yaml" ]; then
+              echo "Linting $chart"
+              helm lint "$chart"
+            fi
+          done
+
+      - name: Template Helm charts
+        run: |
+          for chart in charts/*/; do
+            if [ -f "$chart/Chart.yaml" ]; then
+              echo "Templating $chart"
+              helm template test "$chart" --debug
+            fi
+          done
+
+      - name: Package Helm charts
+        run: |
+          for chart in charts/*/; do
+            if [ -f "$chart/Chart.yaml" ]; then
+              echo "Packaging $chart"
+              helm package "$chart"
+            fi
+          done
+
+      - name: Run Helm tests (if available)
+        run: |
+          for chart in charts/*/; do
+            if [ -f "$chart/Chart.yaml" ]; then
+              echo "Checking for tests in $chart"
+              if [ -d "$chart/templates/tests" ]; then
+                echo "Test templates found in $chart"
+                # Note: Actual test execution would require a Kubernetes cluster
+                # This step validates that test templates can be rendered
+                helm template test "$chart" --show-only templates/tests/ || true
+              else
+                echo "No test templates found in $chart - skipping"
+              fi
+            fi
+          done
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
 .idea
 .vscode
 
+consensus_secrets.yaml
+
 # ignore fetched subcharts
 **/charts/**/charts
 
diff --git a/README.md b/README.md
@@ -14,12 +14,22 @@ Override the appropriate env file (`.env.testnet` or `.env.mainnet`) with any va
 ### Mainnet
 ```sh
 cd docker
+./run.sh mainnet up
+```
+or
+```sh
+cd docker
 docker compose --env-file .env.mainnet -f external-node.yml up -d
 ```
 
 ### Testnet
 ```sh
 cd docker
+./run.sh testnet up
+```
+or
+```sh
+cd docker
 docker compose --env-file .env.testnet -f external-node.yml up -d
 ```
 
diff --git a/charts/abstract-node/Chart.yaml b/charts/abstract-node/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: abstract-node
 description: External node for syncing and serving blockchain data for Abstract
-version: 0.1.27
+version: 0.1.29
 type: application
 icon: https://abstract-assets.abs.xyz/icons/light.png
 keywords:
@@ -11,7 +11,7 @@ keywords:
 home: https://abs.xyz
 sources:
   - https://github.com/matter-labs/zksync-era
-appVersion: "28.6.0"
+appVersion: "29.1.0"
 
 dependencies:
   - name: common
diff --git a/charts/abstract-node/templates/configmap-consensus.yaml b/charts/abstract-node/templates/configmap-consensus.yaml
@@ -0,0 +1,15 @@
+{{- if or .Values.consensus.enabled -}}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "common.names.fullname" . }}-consensus
+  labels:
+    {{- include "common.labels.standard" . | nindent 4 }}
+data:
+  config.yaml: |
+    server_addr: '0.0.0.0:{{ .Values.consensus.port }}'
+    public_addr: '{{ .Values.consensus.publicAddress }}:{{ .Values.consensus.port }}'
+    debug_page_addr: '0.0.0.0:{{ .Values.consensus.debugPagePort }}'
+    max_payload_size: {{ .Values.consensus.maxPayloadSize }}
+    gossip_dynamic_inbound_limit: {{ .Values.consensus.gossipDynamicInboundLimit }}
+{{- end }}
diff --git a/charts/abstract-node/templates/statefulset.yaml b/charts/abstract-node/templates/statefulset.yaml
@@ -46,6 +46,25 @@ spec:
     {{- end }}
       serviceAccountName: {{ include "common.names.serviceAccountName" . }}
       priorityClassName: {{ .Values.priorityClassName | quote }}
+      {{- if .Values.consensus.enabled }}
+      initContainers:
+      - name: init-consensus-secrets
+        image: "{{ .Values.image.registry }}/{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        command:
+        - "/bin/sh"
+        - "-c"
+        - >
+         if [ ! -f /consensus/secrets.yaml ]; then
+           /usr/bin/zksync_external_node generate-secrets > /consensus/secrets.yaml && 
+           echo 'Created secrets'
+         else
+           echo 'Secrets already exist'
+         fi
+        volumeMounts:
+        - name: consensus-secrets
+          mountPath: /consensus
+      {{- end }}
       containers:
         - name: {{ .Chart.Name }}
           image: "{{ .Values.image.registry }}/{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
@@ -147,6 +166,12 @@ spec:
             - name: EN_EXPERIMENTAL_SNAPSHOTS_RECOVERY_L1_BATCH
               value: {{ .Values.node.experimentalSnapshotsRecoveryL1Batch | quote }}
             {{- end }}
+            {{- if .Values.consensus.enabled }}
+            - name: EN_CONSENSUS_CONFIG_PATH
+              value: "/consensus/config.yaml"
+            - name: EN_CONSENSUS_SECRETS_PATH
+              value: "/consensus/secrets.yaml"
+            {{- end }}
           ports:
           {{- if .Values.rpc.http.enabled }}
             - name: http
@@ -164,11 +189,24 @@ spec:
             - name: healthcheck
               containerPort: {{ .Values.healthcheck.port }}
           {{- end }}
+          {{- if .Values.consensus.enabled }}
+            - name: consensus
+              containerPort: {{ .Values.consensus.port }}
+            - name: debug-page
+              containerPort: {{ .Values.consensus.debugPagePort }}
+          {{- end }}
           volumeMounts:
             - name: statekeeper
               mountPath: /db/ext-node/state_keeper
             - name: lightweight
               mountPath: /db/ext-node/lightweight
+            {{- if .Values.consensus.enabled }}
+            - name: consensus-secrets
+              mountPath: /consensus
+            - name: consensus-config
+              mountPath: /consensus/config.yaml
+              subPath: config.yaml
+            {{- end }}
         {{- with .Values.resources }}
           resources:
             {{ toYaml . | nindent 12 | trim }}
@@ -217,8 +255,28 @@ spec:
           emptyDir: {}
         - name: lightweight
           emptyDir: {}
+        {{- if .Values.consensus.enabled }}
+        - name: consensus-secrets
+          emptyDir: {}
+        {{- end }}
 {{- else }}
   volumeClaimTemplates:
+    {{- if .Values.consensus.enabled }}
+    - metadata:
+        name: consensus-secrets
+        labels:
+          {{- include "common.labels.statefulset" . | nindent 10 }}
+      {{- with .Values.persistence.annotations }}
+        annotations:
+          {{ toYaml . | nindent 10 | trim }}
+      {{- end }}
+      spec:
+        accessModes: {{ .Values.persistence.accessModes }}
+        storageClassName: {{ .Values.persistence.storageClassName }}
+        resources:
+          requests:
+            storage: {{ .Values.persistence.consensus.size | quote }}
+    {{- end }}
     - metadata:
         name: lightweight
         labels:
diff --git a/charts/abstract-node/values.yaml b/charts/abstract-node/values.yaml
@@ -79,7 +79,7 @@ image:
   registry: docker.io
   repository: matterlabs/external-node
   pullPolicy: IfNotPresent
-  tag: "v28.6.0"
+  tag: "v29.1.0"
 
 # This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
 imagePullSecrets: []
@@ -165,6 +165,15 @@ rpc:
     enabled: true
     port: "3061"
 
+consensus:
+  # Consensus is currently disabled for Abstract
+  enabled: false
+  port: "3054"
+  publicAddress: "127.0.0.1"
+  debugPagePort: "5000"
+  maxPayloadSize: '5000000'
+  gossipDynamicInboundLimit: '100'
+
 ## Healthcheck configuration.
 ##
 healthcheck:
@@ -253,10 +262,13 @@ persistence:
   accessModes:
     - ReadWriteOnce
   annotations: {}
+  consensus:
+    size: 1Mi
   lightweight:
     size: 10Gi
   statekeeper:
     size: 10Gi
+  
 
 ## Node labels for pod assignment
 ## ref: https://kubernetes.io/docs/user-guide/node-selection/
diff --git a/docker/.env.mainnet b/docker/.env.mainnet
@@ -1,6 +1,6 @@
 # Don't change these values unless you know what you're doing
 NETWORK=mainnet
-EN_VERSION=v28.6.0
+EN_VERSION=v29.1.0
 EN_MAIN_NODE_URL=https://api.mainnet.abs.xyz
 EN_L1_CHAIN_ID=1
 EN_L2_CHAIN_ID=2741
diff --git a/docker/.env.testnet b/docker/.env.testnet
@@ -1,6 +1,6 @@
 # Don't change these values unless you know what you're doing
 NETWORK=testnet
-EN_VERSION=v28.6.0
+EN_VERSION=v29.1.0
 EN_MAIN_NODE_URL=https://api.testnet.abs.xyz
 EN_L1_CHAIN_ID=11155111
 EN_L2_CHAIN_ID=11124
diff --git a/docker/configs/consensus_config.yaml b/docker/configs/consensus_config.yaml
@@ -0,0 +1,5 @@
+server_addr: '0.0.0.0:3054'
+public_addr: '127.0.0.1:3054'
+debug_page_addr: '0.0.0.0:5000'
+max_payload_size: 5000000
+gossip_dynamic_inbound_limit: 100
diff --git a/docker/configs/generate_secrets.sh b/docker/configs/generate_secrets.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+if [ ! -s $1 ]; then
+  /usr/bin/zksync_external_node generate-secrets | tail -n 4 > $1
+fi
diff --git a/docker/external-node.yml b/docker/external-node.yml
@@ -49,18 +49,34 @@ services:
     environment:
       - POSTGRES_PASSWORD=${DB_PASSWORD:-notsecurepassword}
       - PGPORT=5430
+  # Generation of consensus secrets.
+  # The secrets are generated iff the secrets file doesn't already exist.
+  generate-secrets:
+    image: "matterlabs/external-node:${EN_VERSION:-v29.1.0}"
+    entrypoint:
+      [
+      "/configs/generate_secrets.sh",
+      "/configs/consensus_secrets.yaml",
+      ]
+    volumes:
+      - ./configs:/configs
   external-node:
-    image: "matterlabs/external-node:${EN_VERSION:-v28.6.0}"
+    image: "matterlabs/external-node:${EN_VERSION:-v29.1.0}"
     entrypoint: ["/usr/bin/entrypoint.sh"]
     restart: always
     depends_on:
       postgres:
         condition: service_healthy
+      generate-secrets:
+        condition: service_completed_successfully
     ports:
       - "127.0.0.1:${EN_HTTP_PORT:-3060}:${EN_HTTP_PORT:-3060}"
       - "127.0.0.1:${EN_WS_PORT:-3061}:${EN_WS_PORT:-3061}"
       - "127.0.0.1:${EN_HEALTHCHECK_PORT:-3081}:${EN_HEALTHCHECK_PORT:-3081}"
       - "127.0.0.1:${EN_PROMETHEUS_PORT:-3322}:${EN_PROMETHEUS_PORT:-3322}"
+      # Consensus is currently disabled for Abstract
+      # - "127.0.0.1:${EN_CONSENSUS_PORT:-3054}:${EN_CONSENSUS_PORT:-3054}"
+      #- "127.0.0.1:${EN_CONSENSUS_DEBUG_PAGE_PORT:-5000}:${EN_CONSENSUS_DEBUG_PAGE_PORT:-5000}"
     volumes:
       - rocksdb:/db
       - ./configs:/configs
@@ -89,7 +105,10 @@ services:
       EN_SNAPSHOTS_RECOVERY_ENABLED: ${EN_SNAPSHOTS_RECOVERY_ENABLED:-true}
       EN_SNAPSHOTS_OBJECT_STORE_BUCKET_BASE_URL: ${EN_SNAPSHOTS_OBJECT_STORE_BUCKET_BASE_URL:-raas-abstract-mainnet-external-node-snapshots}
       EN_SNAPSHOTS_OBJECT_STORE_MODE: "GCSAnonymousReadOnly"
-      RUST_LOG: "warn,zksync=info,zksync_core::metadata_calculator=debug,zksync_state=debug,zksync_utils=debug,zksync_web3_decl::client=error"
+      RUST_LOG: ${RUST_LOG:-warn,zksync=info,zksync_core::metadata_calculator=debug,zksync_state=debug,zksync_utils=debug,zksync_web3_decl::client=error}
+      # Consensus is currently disabled for Abstract
+      #EN_CONSENSUS_CONFIG_PATH: "/configs/consensus_config.yaml"
+      #EN_CONSENSUS_SECRETS_PATH: "/configs/consensus_secrets.yaml"
 
 volumes:
   postgres: {}
diff --git a/docker/run.sh b/docker/run.sh
@@ -3,7 +3,16 @@ if [ "$1" != "mainnet" ] && [ "$1" != "testnet" ]; then
     echo "Error: First argument must be either 'mainnet' or 'testnet'" >&2
     exit 1
 fi
+if [ "$2" != "up" ] && [ "$2" != "down" ]; then
+    echo "Error: Second argument must be either 'up' or 'down'" >&2
+    exit 1
+fi
 
 ENV_FILE=".env.$1"
+if [ "$2" == "up" ]; then
+  DIRECTION="up -d"
+else
+  DIRECTION="down"
+fi
 
-docker compose --env-file $ENV_FILE -f external-node.yml up -d
+docker compose --env-file $ENV_FILE -f external-node.yml $DIRECTION
