feat: eth client address directory #1691

hopeyen · 2025-06-26T23:12:35Z

Why are these changes needed?

Adds address directory support while maintaining backwards compatibility with legacy individual address configuration.

Address directory in all core services (node, churner, batcher, etc.)
Updates deployment scripts to include EigenDADirectory address output
Adds address directory support to test configurations and client examples
Implements proper validation requiring either address directory OR legacy addresses

Services that uses an Eth Client will now be taking eigendaDirectory address in configurations, instead of blsOperatorStateRetriever and eigenDAServiceManager.

Disperser API server, batcher, controller, dataapi, node cmd, node plugin, operator churner, relay, retriever, ejection tool, quorumscan, semvarscan, proxy client

eigenda-directory with each service's flag prefix

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 :(

- Add NewReaderWithAddressDirectory() for address directory-based initialization - ContractNames constants matching AddressDirectoryConstants.sol - optional AddressDirectoryFlag, BlsOperatorStateRetrieverFlag, and EigenDAServiceManagerFlag - validation to require either address directory OR both legacy flags - backward compatibility for existing deployments without address directory

disperser/cmd/batcher/flags/flags.go

operators/churner/config.go

samlaf

Have we thought through the consequences of using a dynamic lookup system like the AddressRegistry (as opposed to hardcoded addresses)? Does it have the exact same behavior as the current strategy of reading from serviceManager pointers?

I guess the thing I'm unsure is... would a contractAddress in the addressRegistry ever change in place? If so, what are the conditions for this/when would we want to do this? If this can happen, then can't you run into a situation where the address changes, the binary crashes, gets restarted and loads from a new contract address, but this new contract then has a breaking api change, and the (hardcoded) bindings then don't work. How do we prevent this from happening?

api/clients/v2/examples/client_construction.go

contracts/bindings/EigenDADirectory/binding.go

contracts/compile.sh

core/eth/reader.go

core/eth/utils.go

pakim249CAL · 2025-06-30T15:23:55Z

Have we thought through the consequences of using a dynamic lookup system like the AddressRegistry (as opposed to hardcoded addresses)? Does it have the exact same behavior as the current strategy of reading from serviceManager pointers?

What behaviors are you looking for here? When will it not be enough to just replace a service manager pointer with this one?

I guess the thing I'm unsure is... would a contractAddress in the addressRegistry ever change in place? If so, what are the conditions for this/when would we want to do this? If this can happen, then can't you run into a situation where the address changes, the binary crashes, gets restarted and loads from a new contract address, but this new contract then has a breaking api change, and the (hardcoded) bindings then don't work. How do we prevent this from happening?

Address changes should happen with communication, just like any contract upgrade. It will be owned by the DA ops multisig. In that sense, it should be handled the same way as any contract upgrade would be. This mechanism allows us to reduce the technical load of doing upgrades.

core/eth/reader.go

github-actions · 2025-07-01T20:32:17Z

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 1, 2025, 8:32 PM

litt3 · 2025-07-02T20:08:55Z

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

@@ -29,6 +29,7 @@ var (
 	)
 	ServiceManagerAddrFlagName        = withFlagPrefix("service-manager-addr")
 	BLSOperatorStateRetrieverFlagName = withFlagPrefix("bls-operator-state-retriever-addr")
+	EigenDADirectoryFlagName          = withFlagPrefix("eigen-da-directory")


you used eigen-da-directory here, but the other flags are named eigenda-directory,

updated 1ea1ff4

litt3 · 2025-07-02T20:13:09Z

api/clients/v2/examples/client_construction.go

+	disperserHostname = "disperser-testnet-holesky.eigenda.xyz"
+
+	// Eth client
+	addressDirectoryAddress = "0x90776Ea0E99E4c38aA1Efe575a61B3E40160A2FE"


here is another case where the term "address directory" is used, instead of "EigenDA Directory"

litt3 · 2025-07-02T20:13:39Z

core/eth/address_directory_reader.go

+
+// AddressDirectoryReader wraps the address directory contract and provides
+// safe getters for contract addresses with zero address validation
+type AddressDirectoryReader struct {


This struct and file name use "address directory" terminology, instead of "EigenDA Directory"

litt3 · 2025-07-02T20:13:49Z

core/eth/reader.go

@@ -65,21 +68,37 @@ var _ core.Reader = (*Reader)(nil)
 func NewReader(
 	logger logging.Logger,
 	client common.EthClient,
-	blsOperatorStateRetrieverHexAddr string,
-	eigenDAServiceManagerHexAddr string) (*Reader, error) {
+	addressDirectoryHexAddr string) (*Reader, error) {


here is another case where the term "address directory" is used, instead of "EigenDA Directory"

litt3 · 2025-07-02T20:14:04Z

core/eth/writer.go

@@ -37,12 +37,11 @@ var _ core.Writer = (*Writer)(nil)
 func NewWriter(
 	logger logging.Logger,
 	client common.EthClient,
-	blsOperatorStateRetrieverHexAddr string,
-	eigenDAServiceManagerHexAddr string) (*Writer, error) {
+	addressDirectoryHexAddr string) (*Writer, error) {


here is another case where the term "address directory" is used, instead of "EigenDA Directory"

litt3 · 2025-07-02T20:14:21Z

operators/churner/tests/churner_test.go

@@ -204,7 +204,7 @@ func TestChurner(t *testing.T) {
 	assert.NoError(t, err)
 }

-func createTransactorFromScratch(privateKey, operatorStateRetriever, serviceManager string, logger logging.Logger) (*eth.Writer, error) {
+func createTransactorFromScratch(privateKey, addressDirectory string, logger logging.Logger) (*eth.Writer, error) {


here is another case where the term "address directory" is used, instead of "EigenDA Directory"

litt3 · 2025-07-02T20:14:28Z

relay/cmd/flags/flags.go

-		Usage:    "Address of the Eigen DA service manager",
-		Required: true,
-		EnvVar:   common.PrefixEnvVar(envVarPrefix, "EIGEN_DA_SERVICE_MANAGER_ADDR"),
+	AddressDirectoryFlag = cli.StringFlag{


here is another case where the term "address directory" is used, instead of "EigenDA Directory"

…directory

samlaf · 2025-07-03T05:40:10Z

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

 	ServiceManagerAddrFlagName        = withFlagPrefix("service-manager-addr")
 	BLSOperatorStateRetrieverFlagName = withFlagPrefix("bls-operator-state-retriever-addr")


think we should mark these as deprecated and hint people to start moving to the eigenda-directory? Prob want to do it across all of our services (apiserver, nodes, etc). Everything in this PR. And eventually we'll remove all other address flags and only keep the eigenda-directory.

not sure if urfave has a way to mark flags as deprecated. If not then we might need to manually log a warn. cc @dmanc who will be updating our helm charts to use these new flags. Can you also add this as a note to this PR description? This kind of external config changes are very important to highlight.

i made a linear ticket for proxy, and for all services ticket. I will add notes to the PR description

samlaf

Please make the binaries backwards compatible again by keeping the old ServiceManager flag around, and allowing binaries to be started with those flags. We don't want to break people.

samlaf · 2025-07-03T06:08:11Z

retriever/flags/flags.go

-	BlsOperatorStateRetrieverFlag = cli.StringFlag{
-		Name:     common.PrefixFlag(FlagPrefix, "bls-operator-state-retriever"),
-		Usage:    "Address of the BLS Operator State Retriever",
-		Required: true,
-		EnvVar:   common.PrefixEnvVar(envPrefix, "BLS_OPERATOR_STATE_RETRIVER"),


don't remove this flag, since thats a breaking change. instead mark it as deprecated and log a warning when its used, prompting the user to use the new flags.

samlaf · 2025-07-03T06:10:02Z

retriever/flags/flags.go

 	}
+	// This flag is kept for retriever's fetchBatchHeader; can later be removed by utilizing AddressDirectoryFlag
 	EigenDAServiceManagerFlag = cli.StringFlag{


you didn't add the flag back, just the config. let's not delete flags until we're ready for the breaking change (which should be announced in advance).

samlaf · 2025-07-03T06:10:37Z

relay/cmd/flags/flags.go

-	BlsOperatorStateRetrieverAddrFlag = cli.StringFlag{
-		Name:     common.PrefixFlag(FlagPrefix, "bls-operator-state-retriever-addr"),
-		Usage:    "Address of the BLS operator state retriever",
-		Required: true,
-		EnvVar:   common.PrefixEnvVar(envVarPrefix, "BLS_OPERATOR_STATE_RETRIEVER_ADDR"),
-	}
-	EigenDAServiceManagerAddrFlag = cli.StringFlag{
-		Name:     common.PrefixFlag(FlagPrefix, "eigen-da-service-manager-addr"),
-		Usage:    "Address of the Eigen DA service manager",
-		Required: true,
-		EnvVar:   common.PrefixEnvVar(envVarPrefix, "EIGEN_DA_SERVICE_MANAGER_ADDR"),


add these flags back, we don't want to create breaking changes. Every binary should be backwards compatible with these old flags. you can mark them as deprecated but not delete.

samlaf · 2025-07-03T06:10:50Z

operators/churner/flags/flags.go

+		Name:     common.PrefixFlag(FlagPrefix, "eigenda-directory"),
+		Usage:    "Address of the EigenDA Address Directory",
+		Required: false,
+		EnvVar:   common.PrefixEnvVar(envPrefix, "EIGENDA_DIRECTORY"),
 	}


dont delete these flags. see my other comments.

samlaf · 2025-07-03T06:12:13Z

node/flags/flags.go

-	BlsOperatorStateRetrieverFlag = cli.StringFlag{
-		Name:     common.PrefixFlag(FlagPrefix, "bls-operator-state-retriever"),
-		Usage:    "Address of the BLS Operator State Retriever",
-		Required: true,
-		EnvVar:   common.PrefixEnvVar(EnvVarPrefix, "BLS_OPERATOR_STATE_RETRIVER"),
-	}
-	EigenDAServiceManagerFlag = cli.StringFlag{
-		Name:     common.PrefixFlag(FlagPrefix, "eigenda-service-manager"),
-		Usage:    "Address of the EigenDA Service Manager",
-		Required: true,
-		EnvVar:   common.PrefixEnvVar(EnvVarPrefix, "EIGENDA_SERVICE_MANAGER"),


please do not ever do this. this will break users and they will scream at us. flag breaking changes should be announced way ahead of time, and should have been deprecated for a while, and any PRs removing flags (breaking API change!) should have its title with an ! like feat!: eth client address directory to mark the breaking change (to be clear we should not do this right now, but the ! is useful to flag to the release captain that a MAJOR version bump is needed)

samlaf · 2025-07-03T07:40:31Z

Please make the binaries backwards compatible again by keeping the old ServiceManager flag around, and allowing binaries to be started with those flags. We don't want to break people.

@hopeyen and I chatted offline. I'm very very sorry, as I caused a lot of churn and back-and-forth on this one, initially requesting that the flags be deleted, and later on realizing this was not good. Mea culpa 😭

Let's discuss during next week's ReleaseMgmt meeting how we want to deal with config changes wrt breaking changes:

are we ok with removing flags (which will cause binaries to crash with an uninformative msg if the old flag is still used)?
if not are we ok with making new flags required (this is also technically a breaking change requiring a MAJOR bump update, but at least its easier for devops person running the binary to fix since they get a nice error msg requesting a new flag to be present)
otherwise we have to keep old flags around with a deprecated warning notice. Also need to discuss the policy around how long before we are OK with removing (and only then bumping the MAJOR version).

samlaf

LGTM except for the wording of the deprecated notice. Please change everywhere and then we can merge.

samlaf · 2025-07-03T09:24:45Z

api/clients/v2/examples/client_construction.go

 	registryCoordinatorAddress       = "0x53012C69A189cfA2D9d29eb6F19B32e0A2EA3490"
 	blsOperatorStateRetrieverAddress = "0x003497Dd77E5B73C40e8aCbB562C8bb0410320E7"
+	eigenDAServiceManagerAddress     = "0xD4A7E1Bd8015057293f0D0A557088c286942e84b"


nit: examples should use SOTA stuff, so should only use the eigendaDirectoryAddress.

blsOperatorStateRetrieverAddress is still used for CertBuilder, that's not changed within this PR.
I will update eigenDAServiceManagerAddress to an empty string because new EthClient take all three arguments

samlaf · 2025-07-03T09:25:41Z

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

@@ -119,18 +119,25 @@ func CLIFlags(envPrefix, category string) []cli.Flag {
 		},
 		&cli.StringFlag{
 			Name:     ServiceManagerAddrFlagName,
-			Usage:    "Address of the EigenDA service manager contract.",
+			Usage:    "[Deprecating soon in favor of EigenDADirectory] Address of the EigenDA Service Manager contract.",


Suggested change

Usage: "[Deprecating soon in favor of EigenDADirectory] Address of the EigenDA Service Manager contract.",

Usage: "[Deprecated: use EigenDADirectory instead] Address of the EigenDA Service Manager contract.",

samlaf · 2025-07-03T09:27:06Z

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

 			EnvVars:  []string{withEnvPrefix(envPrefix, "BLS_OPERATOR_STATE_RETRIEVER_ADDR")},
 			Category: category,
 			Required: false,
 		},
+		&cli.StringFlag{
+			Name:     EigenDADirectoryFlagName,
+			Usage:    "Address of the EigenDA directory contract.",


Suggested change

Usage: "Address of the EigenDA directory contract.",

Usage: "Address of the EigenDA directory contract, which points to all other EigenDA contract addresses. This is the only contract entrypoint needed offchain.",

samlaf · 2025-07-03T09:28:17Z

disperser/cmd/apiserver/flags/flags.go

@@ -48,14 +48,14 @@ var (
 	}
 	BlsOperatorStateRetrieverFlag = cli.StringFlag{
 		Name:     common.PrefixFlag(FlagPrefix, "bls-operator-state-retriever"),
-		Usage:    "Address of the BLS Operator State Retriever",
-		Required: true,
+		Usage:    "[Deprecating soon in favor of EigenDADirectory] Address of the BLS operator state Retriever",


Suggested change

Usage: "[Deprecating soon in favor of EigenDADirectory] Address of the BLS operator state Retriever",

Usage: "[Deprecated: use EigenDADirectory instead] Address of the BLS operator state Retriever",

It is already deprecated. Deprecated means there's a better way to do things and we're giving you some time to switch over to the new method before we delete this old method.

It's already deprecated, and will eventually get deleted. But better not to use relative language like "soon" or "eventually" because thats fuzzy and unuseful.

Plesae change everywhere

hopeyen force-pushed the hope/integrate-address-directory branch 4 times, most recently from 2e39705 to 8d37186 Compare June 27, 2025 13:58

hopeyen changed the title ~~feat: implement backwards-compatible address directory integration~~ feat: eth client address directory Jun 27, 2025

hopeyen force-pushed the hope/integrate-address-directory branch 2 times, most recently from be772d1 to d4eb749 Compare June 27, 2025 19:46

hopeyen force-pushed the hope/integrate-address-directory branch from d4eb749 to cf716c1 Compare June 27, 2025 20:17

hopeyen marked this pull request as ready for review June 27, 2025 20:53

hopeyen requested review from pakim249CAL and a team as code owners June 27, 2025 20:53

hopeyen requested review from anupsv and dmanc June 27, 2025 20:53

hopeyen commented Jun 27, 2025

View reviewed changes

disperser/cmd/batcher/flags/flags.go Outdated Show resolved Hide resolved

litt3 reviewed Jun 27, 2025

View reviewed changes

operators/churner/config.go Outdated Show resolved Hide resolved

hopeyen force-pushed the hope/integrate-address-directory branch 3 times, most recently from 72aa96a to af2f194 Compare June 27, 2025 22:11

feat: fix BLS_OPERATOR_STATE_RETRIEVER typo

2a9ba2d

hopeyen force-pushed the hope/integrate-address-directory branch from af2f194 to 2a9ba2d Compare June 27, 2025 22:12

samlaf reviewed Jun 30, 2025

View reviewed changes

refactor: config valid check, interface binding, getAddress0

23bbb80

hopeyen force-pushed the hope/integrate-address-directory branch from 95291db to 23bbb80 Compare June 30, 2025 17:42

pakim249CAL reviewed Jul 1, 2025

View reviewed changes

core/eth/reader.go Outdated Show resolved Hide resolved

hopeyen added 3 commits July 1, 2025 16:55

fix: check zero addr, rm unused binding, err msg

abca944

feat: address directory reader

6cc92c7

refactor: abstract the getter

47420e9

hopeyen dismissed pakim249CAL’s stale review via 7a9aee4 July 2, 2025 18:19

hopeyen added 5 commits July 2, 2025 20:21

refactor(EigenDADirectory): always get latest list of contract names

a01d3cf

Merge branch 'master' into hope/integrate-address-directory

f3f3f7a

fix(EigenDADirectory): add service manager flag back to retreiver

be3da55

refactor(proxy): add address directory config

d037753

refactor(proxy): add address directory config in test setup

0018c86

litt3 previously approved these changes Jul 2, 2025

View reviewed changes

refactor(EigenDADirectory): rename more address directory to eigenda …

4b8e39f

…directory

hopeyen dismissed litt3’s stale review via 4b8e39f July 2, 2025 20:37

hopeyen added 2 commits July 2, 2025 22:44

refactor(EigenDADirectory): more renaming

1ea1ff4

fix(EigenDADirectory): relay inabox config

569ba0e

pakim249CAL previously approved these changes Jul 2, 2025

View reviewed changes

samlaf reviewed Jul 3, 2025

View reviewed changes

samlaf requested changes Jul 3, 2025

View reviewed changes

hopeyen added 3 commits July 3, 2025 08:38

fix(EigenDADirectory): add back flags and configs

ad4775d

Merge branch 'master' into hope/integrate-address-directory

e24d27a

fix(EigenDADirectory): add back flags and configs

29e64a1

hopeyen dismissed pakim249CAL’s stale review via 29e64a1 July 3, 2025 06:52

fix(EigenDADirectory): inabox config

7651b9b

hopeyen mentioned this pull request Jul 3, 2025

chore(contracts): eigenda directory bindings #1721

Closed

5 tasks

hopeyen added 2 commits July 3, 2025 10:34

fix(EigenDADirectory): make all three flags optional

5dc336e

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

dfc9e70

samlaf previously approved these changes Jul 3, 2025

View reviewed changes

refactor(EigenDADirectory): help msgs

17c3e67

hopeyen dismissed samlaf’s stale review via 17c3e67 July 3, 2025 09:40

samlaf approved these changes Jul 3, 2025

View reviewed changes

pakim249CAL approved these changes Jul 3, 2025

View reviewed changes

hopeyen merged commit 2882c13 into master Jul 3, 2025
47 of 48 checks passed

hopeyen deleted the hope/integrate-address-directory branch July 3, 2025 15:40

		ServiceManagerAddrFlagName = withFlagPrefix("service-manager-addr")
		BLSOperatorStateRetrieverFlagName = withFlagPrefix("bls-operator-state-retriever-addr")

	Usage: "[Deprecating soon in favor of EigenDADirectory] Address of the EigenDA Service Manager contract.",
	Usage: "[Deprecated: use EigenDADirectory instead] Address of the EigenDA Service Manager contract.",

	Usage: "Address of the EigenDA directory contract.",
	Usage: "Address of the EigenDA directory contract, which points to all other EigenDA contract addresses. This is the only contract entrypoint needed offchain.",

feat: eth client address directory #1691

feat: eth client address directory #1691

Uh oh!

Conversation

hopeyen commented Jun 26, 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!

Uh oh!

Uh oh!

samlaf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pakim249CAL commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 1, 2025

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!

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 left a comment

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 3, 2025

Uh oh!

samlaf left a comment

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

hopeyen commented Jun 26, 2025 •

edited

Loading

pakim249CAL commented Jun 30, 2025 •

edited

Loading