[aztec-prover] fix: args and default envs (#143)

* fix: args * fix: bump version * feat: comment default envs * fix: example * docs: update readme
NethermindEth · Aug 28, 2024 · 80f0af7 · 80f0af7
1 parent 3992ec9
commit 80f0af7
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 48 deletions.
diff --git a/charts/aztec-prover/Chart.yaml b/charts/aztec-prover/Chart.yaml
@@ -15,6 +15,6 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.1.1
 maintainers:
   - name: 0xDones
diff --git a/charts/aztec-prover/README.md b/charts/aztec-prover/README.md
@@ -1,9 +1,15 @@
 # aztec-prover
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 A Helm chart for Kubernetes
 
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| 0xDones |  |  |
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -32,35 +38,23 @@ A Helm chart for Kubernetes
 | nameOverride | string | `""` |  |
 | nodeSelector | object | `{}` |  |
 | persistence.accessModes[0] | string | `"ReadWriteOnce"` |  |
-| persistence.enabled | bool | `false` |  |
+| persistence.enabled | bool | `true` |  |
 | persistence.mountPath | string | `"/data"` |  |
 | persistence.size | string | `"50Gi"` |  |
 | persistence.storageClass | string | `""` |  |
 | podAnnotations | object | `{}` |  |
 | podLabels | object | `{}` |  |
 | podSecurityContext | object | `{}` |  |
-| proverAgent.args[0] | string | `"start --prover"` |  |
+| proverAgent.args[0] | string | `"start"` |  |
+| proverAgent.args[1] | string | `"--prover"` |  |
 | proverAgent.enabled | bool | `false` |  |
-| proverAgent.env.AZTEC_NODE_URL | string | `"http://aztec-prover-node:8080"` |  |
-| proverAgent.env.IS_DEV_NET | string | `"true"` |  |
-| proverAgent.env.LOG_JSON | string | `"false"` |  |
-| proverAgent.env.LOG_LEVEL | string | `"debug"` |  |
-| proverAgent.env.OTEL_EXPORTER_OTLP_ENDPOINT | string | `""` |  |
-| proverAgent.env.PROVER_AGENTS | string | `"1"` |  |
-| proverAgent.env.PROVER_REAL_PROOFS | string | `"true"` |  |
+| proverAgent.env | object | `{}` |  |
 | proverAgent.name | string | `"agent"` |  |
-| proverNode.args[0] | string | `"start --prover-node --archiver"` |  |
+| proverNode.args[0] | string | `"start"` |  |
+| proverNode.args[1] | string | `"--prover-node"` |  |
+| proverNode.args[2] | string | `"--archiver"` |  |
 | proverNode.enabled | bool | `true` |  |
-| proverNode.env.AZTEC_PORT | string | `"8080"` |  |
-| proverNode.env.DATA_DIRECTORY | string | `"/data"` |  |
-| proverNode.env.ETHEREUM_HOST | string | `"https://provernet-mainnet-fork.aztec.network:8545/$APIKEY"` |  |
-| proverNode.env.IS_DEV_NET | string | `"true"` |  |
-| proverNode.env.L1_CHAIN_ID | string | `"677692"` |  |
-| proverNode.env.LOG_JSON | string | `"false"` |  |
-| proverNode.env.LOG_LEVEL | string | `"debug"` |  |
-| proverNode.env.OTEL_EXPORTER_OTLP_ENDPOINT | string | `""` |  |
-| proverNode.env.PROVER_REAL_PROOFS | string | `"true"` |  |
-| proverNode.env.TX_PROVIDER_NODE_URL | string | `"https://api.aztec.network/provernet/aztec-node-1/$APIKEY"` |  |
+| proverNode.env | object | `{}` |  |
 | proverNode.name | string | `"node"` |  |
 | readinessProbe.httpGet.path | string | `"/status"` |  |
 | readinessProbe.httpGet.port | string | `"http"` |  |

diff --git a/charts/aztec-prover/values.yaml b/charts/aztec-prover/values.yaml
@@ -18,67 +18,69 @@ proverNode:
   enabled: true
   name: node
   args:
-    - "start --prover-node --archiver"
+    - "start"
+    - "--prover-node"
+    - "--archiver"
   env:
+    {}
     # URL to an Ethereum node.
-    ETHEREUM_HOST: "https://provernet-mainnet-fork.aztec.network:8545/$APIKEY"
+    # ETHEREUM_HOST: "https://provernet-mainnet-fork.aztec.network:8545/$APIKEY"
     # Chain ID for the L1 Ethereum chain.
-    L1_CHAIN_ID: "677692"
+    # L1_CHAIN_ID: "677692"
     # Local folder where archive and world state data is stored.
-    DATA_DIRECTORY: "/data"
+    # DATA_DIRECTORY: "/data"
     # Port where the JSON-RPC APIs will be served.
-    AZTEC_PORT: "8080"
+    # AZTEC_PORT: "8080"
     # URL to an Aztec node that acts as transaction provider and as source of truth for the L1 contract addresses.
-    TX_PROVIDER_NODE_URL: "https://api.aztec.network/provernet/aztec-node-1/$APIKEY"
-    # Private key used for publishing proofs to L1. Ensure it corresponds to an address with ETH to pay for gas.
-    # PROVER_PUBLISHER_PRIVATE_KEY: ""
+    # TX_PROVIDER_NODE_URL: "https://api.aztec.network/provernet/aztec-node-1/$APIKEY"
     ####################
     # Common Envs
     ####################
     # Whether to generate actual proofs, as opposed to only simulating the circuit and outputting fake proofs. Set to true for the scope of the integration.
-    PROVER_REAL_PROOFS: "true"
+    # PROVER_REAL_PROOFS: "true"
     # Whether to skip consensus checks. Set to true for the scope of the integration.
-    IS_DEV_NET: "true"
+    # IS_DEV_NET: "true"
     # One of debug, verbose, info, warn, or error.
-    LOG_LEVEL: "debug"
+    # LOG_LEVEL: "debug"
     # Set to true to output logs in ndJSON format (unreleased).
-    LOG_JSON: "false"
+    # LOG_JSON: "false"
     #  Optional URL for pushing telemetry data to a remote OpenTelemetry data collector.
-    OTEL_EXPORTER_OTLP_ENDPOINT: ""
+    # OTEL_EXPORTER_OTLP_ENDPOINT: ""
 
 proverAgent:
   enabled: false
   name: agent
   args:
-    - "start --prover"
+    - "start"
+    - "--prover"
   env:
+    {}
     # URL to the prover node that acts as a proving job source.
-    AZTEC_NODE_URL: "http://aztec-prover-node:8080"
+    # AZTEC_NODE_URL: "http://aztec-prover-node:8080"
     # Maximum concurrency for this given prover agent. Defaults to 1.
-    PROVER_AGENTS: "1"
-    ####################
+    # PROVER_AGENTS: "1"
+    # ###################
     # Common Envs
-    ####################
+    # ###################
     # Whether to generate actual proofs, as opposed to only simulating the circuit and outputting fake proofs. Set to true for the scope of the integration.
-    PROVER_REAL_PROOFS: "true"
+    # PROVER_REAL_PROOFS: "true"
     # Whether to skip consensus checks. Set to true for the scope of the integration.
-    IS_DEV_NET: "true"
+    # IS_DEV_NET: "true"
     # One of debug, verbose, info, warn, or error.
-    LOG_LEVEL: "debug"
+    # LOG_LEVEL: "debug"
     # Set to true to output logs in ndJSON format (unreleased).
-    LOG_JSON: "false"
+    # LOG_JSON: "false"
     #  Optional URL for pushing telemetry data to a remote OpenTelemetry data collector.
-    OTEL_EXPORTER_OTLP_ENDPOINT: ""
+    # OTEL_EXPORTER_OTLP_ENDPOINT: ""
 
 extraObjects:
   []
   # - apiVersion: v1
   #   kind: Secret
   #   metadata:
   #     name: '{{ include "aztec-prover.fullname" . }}'
-  #   spec:
-  #     stringData:
-  #       PROVER_PUBLISHER_PRIVATE_KEY: "0x1234567890abcdef"
+  #   stringData:
+  #     PROVER_PUBLISHER_PRIVATE_KEY: "<PRIVATE KEY>"
 
 envFrom:
   []