chore(proxy): consolidate dotenv examples files into single one #1800

samlaf · 2025-07-24T14:46:00Z

Why are these changes needed?

Closes DAINT-649.

Having multiple example files is a source of bug and confusion. its also hard to maintain. Consolidating into a single .env.example file. People should figure out how to populate it for their own network anyways.

Also removed all the config values that have sane defaults, and only left the ones that are mandatory to set. This removes a lot of cognitive load on our users, and will be a helpful simplification I believe.

Checks

I've made sure the tests are passing. Note that there might be a few flaky tests, in that case, please comment that they are not relevant.
I've checked the new test coverage and the coverage percentage didn't drop.
Testing Strategy
- Unit tests
- Integration tests
- This PR is not tested :(

Having multiple example files is a source of bug and confusion. its also hard to maintain. Consolidating into a single .env.example file. People should figure out how to populate it for their own network anyways. Also removed all the config values that have sane defaults, and only left the ones that are mandatory to set. This removes a lot of cognitive load on our users, and will be a helpful simplification I believe.

Very minor bug that was being misread. belive its a urfave bug but havent spent more time investigating.

github-actions · 2025-07-24T14:46:23Z

The latest Buf updates on your PR. Results from workflow Buf Proto / buf (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`✅ passed`	Jul 25, 2025, 4:59 PM

bxue-l2 · 2025-07-25T02:06:05Z

.github/workflows/test-proxy.yml

@@ -50,7 +37,7 @@ jobs:
          experimental: true
          working_directory: api/proxy
      - name: Run flag test
-        run: ${{ github.workspace }}/api/proxy/scripts/test-proxy-startup-with-env-vars.sh ${{ matrix.env-file }}
+        run: ${{ github.workspace }}/api/proxy/scripts/test-proxy-startup-with-env-vars.sh .env.example


Are you going to take the suggestion to not use the.env file?

bxue-l2 · 2025-07-25T02:16:47Z

api/proxy/.env.example

+#
+# See https://layr-labs.github.io/eigenda/integration/spec/6-secure-integration.html#upgradable-quorums-and-thresholds-for-optimistic-verification
+# for more details.
+EIGENDA_PROXY_EIGENDA_V2_CERT_VERIFIER_ROUTER_OR_IMMUTABLE_VERIFIER_ADDR=0x61692e93b6B045c444e942A91EcD1527F23A3FB7


think it is better to remove both mainnet and this address, but feel free to ignore

And if you want to leave a default one, perhaps it is better to leave the one for Sepolia.

Because for me now it's good to have a mental load.

bxue-l2 · 2025-07-25T02:17:49Z

api/proxy/.env.example

+# SRS data that will be read into memory. Reading in a large amount of SRS data can cause long startup times, and since
+# you only actually need to read the amount of SRS data that corresponds to the size of the largest blob that will be
+# sent, decreasing this value is a crude sort of optimization.
+EIGENDA_PROXY_EIGENDA_V2_MAX_BLOB_LENGTH=1MiB


Since we have spent so much word here, maybe it's also good to add a caution to readers that this is different from the payload size because of padding and headers.

bxue-l2 · 2025-07-25T02:20:59Z

api/proxy/.env.example

+# Allowed distance (in L1 blocks) between the eigenDA cert's reference block number (RBN)
+# and the L1 block number at which the cert was included in the rollup's batch inbox.
+# A cert is considered valid if certL1InclusionBlock <= cert.RBN + rbnRecencyWindowSize,
+# otherwise an HTTP 418 (TEAPOT) error is returned to indicate that is should be dropped.


For secure integration, for insecure integration, I don't think we have made a decision on which one is better.

stall or

skip
when encountering a derivation error. What is your vote on this, though this is a broader discussion.

bxue-l2 · 2025-07-25T02:25:39Z

api/proxy/.env.example

+# === V2 Configuration ===
+
+# Hex-encoded signer private key for payments with EigenDA V2 disperser.
+EIGENDA_PROXY_EIGENDA_V2_SIGNER_PRIVATE_KEY_HEX="0000000000000000000100000000000000000000000000000000000000000000"


Pretty surprised that this private key is allowed.

Hey, how'd you get access to my cold storage key?!?!?

litt3 · 2025-07-25T14:31:51Z

api/proxy/config/v2/eigendaflags/cli.go

+for the exact values getting set by this flag. All of those values can also be manually
+set via their respective flags, and take precedence over the default values set by the network flag.
+If all of those other flags are manually configured, the network flag may be omitted. 
+Permitted EigenDANetwork values include %s, %s, %s, & %s.`,
 				common.MainnetEigenDANetwork,
 				common.HoleskyTestnetEigenDANetwork,
 				common.HoleskyPreprodEigenDANetwork,


Here's a thought:

right now, the eigenda_network is a bit hard to maintain. If you want to add a network type, you have to define the name constant, and then make sure you add the correct values to each switch statement in that file.

It would be a lot easier if we just defined an EigenDANetwork struct type, which contains all the necessary fields. Then all values for a given network would be defined together.

Additionally, if we maintained a list of all existing EigenDANetwork types in eigenda_network.go, we could use it for logs like this (join all the names with , ), and then adding a new network type wouldn't entail modifying multiple files, it would all be contained in eigenda_network.go

This isn't necessarily something that needs to be done right now, or at all.

litt3 · 2025-07-25T14:39:37Z

api/proxy/store/cli.go

+	// since our code downstream doesn't work well with empty strings.
+	// Specifically, if the env var is simply set to nothing like `EIGENDA_PROXY_STORAGE_CACHE_TARGETS=`,
+	// it will result in an empty string being added to the slice
+	// for some reason... seems like a bug in urfave/cli?


If not a bug, at least an unpleasant user experience.

litt3 · 2025-07-25T14:41:16Z

api/proxy/.env.example

+# === V2 Configuration ===
+
+# Hex-encoded signer private key for payments with EigenDA V2 disperser.
+EIGENDA_PROXY_EIGENDA_V2_SIGNER_PRIVATE_KEY_HEX="0000000000000000000100000000000000000000000000000000000000000000"


Hey, how'd you get access to my cold storage key?!?!?

litt3 · 2025-07-25T14:44:43Z

api/proxy/.env.example

+# === Storage Configuration ===
+
+# The storage backends to enable. Options are [V1, V2]
+EIGENDA_PROXY_STORAGE_BACKENDS_TO_ENABLE=V1,V2


Consider adding additional guidance here:

The contents of this field dictate whether the structures to support the given backend are instantiated or not.

Reasons to include both V1 and V2 include:

You're dispersing to one, but still want to support reads from the other

You want to change which backend you are dispersing to on the fly, i.e. you're migrating from V1 to V2. So everything would be going through V1 at first, but the necessary structures would exist to switch to V2 dispersals, without requiring a restart

litt3 · 2025-07-25T14:46:20Z

api/proxy/.env.example

+EIGENDA_PROXY_STORAGE_BACKENDS_TO_ENABLE=V1,V2
+
+# Target EigenDA backend version (V1 or V2) for blob dispersals (POST routes).
+EIGENDA_PROXY_STORAGE_DISPERSAL_BACKEND=V2


consider noting that whichever you choose, it must also be part of the EIGENDA_PROXY_STORAGE_BACKENDS_TO_ENABLE list

litt3 · 2025-07-25T14:55:08Z

api/proxy/.env.example

+# === Metrics Configuration ===
+
+# Enable the metrics server, which is disabled by default.
+EIGENDA_PROXY_METRICS_ENABLED=true


Depending on which merges first, you'll need to make sure to remove this, considering your PR to enable metrics by default

litt3 · 2025-07-25T14:55:34Z

api/proxy/README.md

   - Set `EIGENDA_PROXY_STORAGE_DISPERSAL_BACKEND=V2`, so that the proxy started with this config will immediately
 enable V2 dispersal

-3. **Scheduled Migration**
+1. **Scheduled Migration**


improper numbering

* chore(proxy): enable metrics server by default This simplifies the .env.example config file, and makes one less configuration to search for for new users. * chore: make gen output

samlaf · 2025-07-25T17:37:20Z

I merged #1801 into this by mistake... should prob revert that. Although its a small change so might be fine to just merge all of this together.

litt3 · 2025-07-25T19:31:10Z

I merged #1801 into this by mistake... should prob revert that. Although its a small change so might be fine to just merge all of this together.

@samlaf I'd say just merge together. Not something we'd do intentionally, but also not worth too much effort to undo

samlaf added 2 commits July 24, 2025 22:07

fix(proxy): cache/fallback cli ingestion bug

25252a9

Very minor bug that was being misread. belive its a urfave bug but havent spent more time investigating.

samlaf requested a review from a team as a code owner July 24, 2025 14:46

samlaf requested review from litt3, ethenotethan and bxue-l2 July 24, 2025 14:46

samlaf added 2 commits July 24, 2025 23:20

fix: build

1a9f799

chore(proxy): make gen-static-help-output

ca9f197

bxue-l2 previously approved these changes Jul 25, 2025

View reviewed changes

bxue-l2 reviewed Jul 25, 2025

View reviewed changes

litt3 previously approved these changes Jul 25, 2025

View reviewed changes

chore: proxy turn on metrics server by default (#1801)

e95d71f

* chore(proxy): enable metrics server by default This simplifies the .env.example config file, and makes one less configuration to search for for new users. * chore: make gen output

samlaf dismissed stale reviews from litt3 and bxue-l2 via e95d71f July 25, 2025 16:59

chore(proxy): consolidate dotenv examples files into single one #1800

Are you sure you want to change the base?

chore(proxy): consolidate dotenv examples files into single one #1800

Conversation

samlaf commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why are these changes needed?

Checks

Uh oh!

github-actions bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bxue-l2 Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bxue-l2 Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samlaf commented Jul 25, 2025

Uh oh!

litt3 commented Jul 25, 2025

Uh oh!

Uh oh!

samlaf commented Jul 24, 2025 •

edited

Loading

github-actions bot commented Jul 24, 2025 •

edited

Loading

bxue-l2 Jul 25, 2025 •

edited

Loading

bxue-l2 Jul 25, 2025 •

edited

Loading