feat: eth client address directory (#1691)

* feat: integrate address directory to eth reader
- 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

* feat: fix BLS_OPERATOR_STATE_RETRIEVER typo

* refactor: config valid check, interface binding, getAddress0

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

* feat: address directory reader

* refactor: abstract the getter

* rebase: master; add check of contract names

* refactor: remove old new eth reader/writer method

* refactor: update flags and configs for address dir

* fix: chuner config lint

* fix: more lints

* fix: more lints

* fix: inabox config

* refactor(ethClient): comment cleanup

* refactor(EigenDADirectory): update names and validation

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

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

* refactor(proxy): add address directory config

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

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

* refactor(EigenDADirectory): more renaming

* fix(EigenDADirectory): relay inabox config

* fix(EigenDADirectory): add back flags and configs

* fix(EigenDADirectory): add back flags and configs

* fix(EigenDADirectory): inabox config

* fix(EigenDADirectory): make all three flags optional

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

* refactor(EigenDADirectory): help msgs

Author: hopeyen

api/clients/v2/examples/client_construction.go

@@ -28,12 +28,16 @@ import (
 // These constants are specific to the EigenDA holesky testnet. To execute the provided examples on a different
 // network, you will need to set these constants to the correct values, based on the chosen network.
 const (
-	ethRPCURL                        = "https://ethereum-holesky-rpc.publicnode.com"
-	disperserHostname                = "disperser-testnet-holesky.eigenda.xyz"
-	certVerifierRouterAddress        = "0x7F40A8e1B62aa1c8Afed23f6E8bAe0D340A4BC4e"
-	registryCoordinatorAddress       = "0x53012C69A189cfA2D9d29eb6F19B32e0A2EA3490"
+	ethRPCURL                  = "https://ethereum-holesky-rpc.publicnode.com"
+	disperserHostname          = "disperser-testnet-holesky.eigenda.xyz"
+	certVerifierRouterAddress  = "0x7F40A8e1B62aa1c8Afed23f6E8bAe0D340A4BC4e"
+	registryCoordinatorAddress = "0x53012C69A189cfA2D9d29eb6F19B32e0A2EA3490"
+	// To build Eth Client
+	eigendaDirectoryAddress = "0x90776Ea0E99E4c38aA1Efe575a61B3E40160A2FE"
+	// These two addresses are no longer required for the Eth Client, but parameter is still being taken until we deprecate the flags
+	eigenDAServiceManagerAddress = ""
+	// blsOperatorStateRetrieverAddress is still used for CertBuilder
 	blsOperatorStateRetrieverAddress = "0x003497Dd77E5B73C40e8aCbB562C8bb0410320E7"
-	eigenDAServiceManagerAddress     = "0xD4A7E1Bd8015057293f0D0A557088c286942e84b"
 )
 
 func createPayloadDisperser(privateKey string) (*payloaddispersal.PayloadDisperser, error) {
@@ -332,6 +336,7 @@ func createEthReader(logger logging.Logger, ethClient common.EthClient) (*eth.Re
 	ethReader, err := eth.NewReader(
 		logger,
 		ethClient,
+		eigendaDirectoryAddress,
 		blsOperatorStateRetrieverAddress,
 		eigenDAServiceManagerAddress,
 	)

api/proxy/common/client_config_v2.go

@@ -37,6 +37,7 @@ type ClientConfigV2 struct {
 	// Fields required for validator payload retrieval
 	BLSOperatorStateRetrieverAddr string
 	EigenDAServiceManagerAddr     string
+	EigenDADirectory              string
 
 	// 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.
@@ -77,6 +78,10 @@ func (cfg *ClientConfigV2) Check() error {
 	}
 
 	if slices.Contains(cfg.RetrieversToEnable, ValidatorRetrieverType) {
+		if cfg.EigenDADirectory == "" {
+			return fmt.Errorf("EigenDA directory is required for validator retrieval in EigenDA V2 backend")
+		}
+
 		if cfg.BLSOperatorStateRetrieverAddr == "" {
 			return fmt.Errorf(
 				"BLS operator state retriever address is required for validator retrieval in EigenDA V2 backend")

api/proxy/common/eigenda_network.go

@@ -10,6 +10,20 @@ const (
 	SepoliaTestnetEigenDANetwork EigenDANetwork = "sepolia_testnet"
 )
 
+// GetEigenDADirectory returns, as a string, the address of the EigenDADirectory contract for the network.
+func (n EigenDANetwork) GetEigenDADirectory() (string, error) {
+	switch n {
+	case HoleskyTestnetEigenDANetwork:
+		return "0x90776Ea0E99E4c38aA1Efe575a61B3E40160A2FE", nil
+	case HoleskyPreprodEigenDANetwork:
+		return "0xfB676e909f376efFDbDee7F17342aCF55f6Ec502", nil
+	case SepoliaTestnetEigenDANetwork:
+		return "0x9620dC4B3564198554e4D2b06dEFB7A369D90257", nil
+	default:
+		return "", fmt.Errorf("unknown network type: %s", n)
+	}
+}
+
 // GetServiceManagerAddress returns, as a string, the address of the EigenDAServiceManager contract for the network.
 func (n EigenDANetwork) GetServiceManagerAddress() (string, error) {
 	switch n {

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("eigenda-directory")
 	RelayTimeoutFlagName              = withFlagPrefix("relay-timeout")
 	ValidatorTimeoutFlagName          = withFlagPrefix("validator-timeout")
 	ContractCallTimeoutFlagName       = withFlagPrefix("contract-call-timeout")
@@ -118,18 +119,25 @@ func CLIFlags(envPrefix, category string) []cli.Flag {
 		},
 		&cli.StringFlag{
 			Name:     ServiceManagerAddrFlagName,
-			Usage:    "Address of the EigenDA service manager contract.",
+			Usage:    "[Deprecated: use EigenDADirectory instead] Address of the EigenDA Service Manager contract.",
 			EnvVars:  []string{withEnvPrefix(envPrefix, "SERVICE_MANAGER_ADDR")},
 			Category: category,
 			Required: false,
 		},
 		&cli.StringFlag{
 			Name:     BLSOperatorStateRetrieverFlagName,
-			Usage:    "Address of the BLS operator state retriever contract.",
+			Usage:    "[Deprecated: use EigenDADirectory instead] Address of the BLS operator state retriever contract.",
 			EnvVars:  []string{withEnvPrefix(envPrefix, "BLS_OPERATOR_STATE_RETRIEVER_ADDR")},
 			Category: category,
 			Required: false,
 		},
+		&cli.StringFlag{
+			Name:     EigenDADirectoryFlagName,
+			Usage:    "Address of the EigenDA directory contract, which points to all other EigenDA contract addresses. This is the only contract entrypoint needed offchain..",
+			EnvVars:  []string{withEnvPrefix(envPrefix, "EIGENDA_DIRECTORY")},
+			Category: category,
+			Required: false,
+		},
 		&cli.DurationFlag{
 			Name:     ContractCallTimeoutFlagName,
 			Usage:    "Timeout used when performing smart contract call operation (i.e, eth_call).",
@@ -234,6 +242,15 @@ func ReadClientConfigV2(ctx *cli.Context) (common.ClientConfigV2, error) {
 		}
 	}
 
+	eigenDADirectory := ctx.String(EigenDADirectoryFlagName)
+	if eigenDADirectory == "" {
+		eigenDADirectory, err = eigenDANetwork.GetEigenDADirectory()
+		if err != nil {
+			return common.ClientConfigV2{}, fmt.Errorf(
+				"service manager address wasn't specified, and failed to get it from the specified network: %w", err)
+		}
+	}
+
 	serviceManagerAddress := ctx.String(ServiceManagerAddrFlagName)
 	if serviceManagerAddress == "" {
 		serviceManagerAddress, err = eigenDANetwork.GetServiceManagerAddress()
@@ -271,6 +288,7 @@ func ReadClientConfigV2(ctx *cli.Context) (common.ClientConfigV2, error) {
 		BLSOperatorStateRetrieverAddr:      blsOperatorStateRetrieverAddress,
 		EigenDACertVerifierOrRouterAddress: ctx.String(CertVerifierRouterOrImmutableVerifierAddrFlagName),
 		EigenDAServiceManagerAddr:          serviceManagerAddress,
+		EigenDADirectory:                   eigenDADirectory,
 		RBNRecencyWindowSize:               ctx.Uint64(RBNRecencyWindowSizeFlagName),
 		EigenDANetwork:                     eigenDANetwork,
 	}, nil

api/proxy/docs/help_out.txt

@@ -55,13 +55,14 @@ GLOBAL OPTIONS:
    --eigenda.v2.blob-status-poll-interval value  Duration to query for blob status updates during dispersal. (default: 1s) [$EIGENDA_PROXY_EIGENDA_V2_BLOB_STATUS_POLL_INTERVAL]
    --eigenda.v2.blob-version value               Blob params version used when dispersing. This refers to a global version maintained by EigenDA
 governance and is injected in the BlobHeader before dispersing. Currently only supports (0). (default: 0) [$EIGENDA_PROXY_EIGENDA_V2_BLOB_PARAMS_VERSION]
-   --eigenda.v2.bls-operator-state-retriever-addr value                Address of the BLS operator state retriever contract. [$EIGENDA_PROXY_EIGENDA_V2_BLS_OPERATOR_STATE_RETRIEVER_ADDR]
+   --eigenda.v2.bls-operator-state-retriever-addr value                [Deprecated: use EigenDADirectory instead] Address of the BLS operator state retriever contract. [$EIGENDA_PROXY_EIGENDA_V2_BLS_OPERATOR_STATE_RETRIEVER_ADDR]
    --eigenda.v2.cert-verifier-router-or-immutable-verifier-addr value  Address of either the EigenDACertVerifierRouter or immutable EigenDACertVerifier contract. Required for performing eth_calls to verify EigenDA certificates. [$EIGENDA_PROXY_EIGENDA_V2_CERT_VERIFIER_ROUTER_OR_IMMUTABLE_VERIFIER_ADDR]
    --eigenda.v2.contract-call-timeout value                            Timeout used when performing smart contract call operation (i.e, eth_call). (default: 10s) [$EIGENDA_PROXY_EIGENDA_V2_CONTRACT_CALL_TIMEOUT]
    --eigenda.v2.disable-point-evaluation                               Disables IFFT transformation done during payload encoding. Using this mode results in blobs that can't be proven. (default: false) [$EIGENDA_PROXY_EIGENDA_V2_DISABLE_POINT_EVALUATION]
    --eigenda.v2.disable-tls                                            Disable TLS for gRPC communication with the EigenDA disperser and retrieval subnet. (default: false) [$EIGENDA_PROXY_EIGENDA_V2_GRPC_DISABLE_TLS]
    --eigenda.v2.disperse-blob-timeout value                            Maximum amount of time to wait for a blob to disperse against v2 protocol. (default: 2m0s) [$EIGENDA_PROXY_EIGENDA_V2_DISPERSE_BLOB_TIMEOUT]
    --eigenda.v2.disperser-rpc value                                    RPC endpoint of the EigenDA disperser. [$EIGENDA_PROXY_EIGENDA_V2_DISPERSER_RPC]
+   --eigenda.v2.eigenda-directory value                                Address of the EigenDA directory contract, which points to all other EigenDA contract addresses. This is the only contract entrypoint needed offchain.. [$EIGENDA_PROXY_EIGENDA_V2_EIGENDA_DIRECTORY]
    --eigenda.v2.eth-rpc value                                          URL of the Ethereum RPC endpoint. [$EIGENDA_PROXY_EIGENDA_V2_ETH_RPC]
    --eigenda.v2.max-blob-length value                                  Maximum blob length to be written or read from EigenDA. Determines the number of SRS points
 loaded into memory for KZG commitments. Example units: '30MiB', '4Kb', '30MB'. Maximum size
@@ -78,7 +79,7 @@ in the rollup's batch inbox. A cert is valid when cert.RBN < certL1InclusionBloc
 and otherwise is considered stale and verification will fail, and a 418 HTTP error will be returned.
 This check is optional and will be skipped when set to 0. (default: 0) [$EIGENDA_PROXY_EIGENDA_V2_RBN_RECENCY_WINDOW_SIZE]
    --eigenda.v2.relay-timeout value           Timeout used when querying an individual relay for blob contents. (default: 10s) [$EIGENDA_PROXY_EIGENDA_V2_RELAY_TIMEOUT]
-   --eigenda.v2.service-manager-addr value    Address of the EigenDA service manager contract. [$EIGENDA_PROXY_EIGENDA_V2_SERVICE_MANAGER_ADDR]
+   --eigenda.v2.service-manager-addr value    [Deprecated: use EigenDADirectory instead] Address of the EigenDA Service Manager contract. [$EIGENDA_PROXY_EIGENDA_V2_SERVICE_MANAGER_ADDR]
    --eigenda.v2.signer-payment-key-hex value  Hex-encoded signer private key. Used for authorizing payments with EigenDA disperser. Should not be associated with an Ethereum address holding any funds. [$EIGENDA_PROXY_EIGENDA_V2_SIGNER_PRIVATE_KEY_HEX]
    --eigenda.v2.validator-timeout value       Timeout used when retrieving chunks directly from EigenDA validators. This is a secondary retrieval method, in case retrieval from the relay network fails. (default: 2m0s) [$EIGENDA_PROXY_EIGENDA_V2_VALIDATOR_TIMEOUT]
 

api/proxy/store/builder/config_test.go

@@ -70,6 +70,7 @@ func validCfg() Config {
 			MaxBlobSizeBytes:                   maxBlobLengthBytes,
 			BLSOperatorStateRetrieverAddr:      "0x000000000004324311",
 			EigenDAServiceManagerAddr:          "0x000000000005324322",
+			EigenDADirectory:                   "0x000000000006324333",
 			RetrieversToEnable: []common.RetrieverType{
 				common.RelayRetrieverType,
 				common.ValidatorRetrieverType,

api/proxy/store/builder/storage_manager_builder.go

@@ -521,6 +521,7 @@ func buildEthReader(log logging.Logger,
 	ethReader, err := eth.NewReader(
 		log,
 		ethClient,
+		clientConfigV2.EigenDADirectory,
 		clientConfigV2.BLSOperatorStateRetrieverAddr,
 		clientConfigV2.EigenDAServiceManagerAddr,
 	)

api/proxy/test/testutils/setup.go

@@ -47,16 +47,19 @@ const (
 	preprodCertVerifierAddress              = "0xCCFE3d87fB7D369f1eeE65221a29A83f1323043C"
 	preprodSvcManagerAddress                = "0x54A03db2784E3D0aCC08344D05385d0b62d4F432"
 	preprodBLSOperatorStateRetrieverAddress = "0x003497Dd77E5B73C40e8aCbB562C8bb0410320E7"
+	preprodEigenDADirectory                 = "0xfB676e909f376efFDbDee7F17342aCF55f6Ec502"
 
 	disperserTestnetHostname                = "disperser-testnet-holesky.eigenda.xyz"
 	testnetCertVerifierAddress              = "0xd305aeBcdEc21D00fDF8796CE37d0e74836a6B6e"
 	testnetSvcManagerAddress                = "0xD4A7E1Bd8015057293f0D0A557088c286942e84b"
 	testnetBLSOperatorStateRetrieverAddress = "0x003497Dd77E5B73C40e8aCbB562C8bb0410320E7"
+	testnetEigenDADirectory                 = "0x90776Ea0E99E4c38aA1Efe575a61B3E40160A2FE"
 
 	disperserSepoliaHostname                = "disperser-testnet-sepolia.eigenda.xyz"
 	sepoliaCertVerifierAddress              = "0x58D2B844a894f00b7E6F9F492b9F43aD54Cd4429"
 	sepoliaSvcManagerAddress                = "0x3a5acf46ba6890B8536420F4900AC9BC45Df4764"
 	sepoliaBLSOperatorStateRetrieverAddress = "0x22478d082E9edaDc2baE8443E4aC9473F6E047Ff"
+	sepoliaEigenDADirectory                 = "0x9620dC4B3564198554e4D2b06dEFB7A369D90257"
 )
 
 var (
@@ -263,6 +266,7 @@ func BuildTestSuiteConfig(testCfg TestConfig) config.AppConfig {
 	var certVerifierAddress string
 	var svcManagerAddress string
 	var blsOperatorStateRetrieverAddress string
+	var eigenDADirectory string
 	switch testCfg.Backend {
 	case MemstoreBackend:
 		break // no need to set these fields for local tests
@@ -271,16 +275,19 @@ func BuildTestSuiteConfig(testCfg TestConfig) config.AppConfig {
 		certVerifierAddress = preprodCertVerifierAddress
 		svcManagerAddress = preprodSvcManagerAddress
 		blsOperatorStateRetrieverAddress = preprodBLSOperatorStateRetrieverAddress
+		eigenDADirectory = preprodEigenDADirectory
 	case TestnetBackend:
 		disperserHostname = disperserTestnetHostname
 		certVerifierAddress = testnetCertVerifierAddress
 		svcManagerAddress = testnetSvcManagerAddress
 		blsOperatorStateRetrieverAddress = testnetBLSOperatorStateRetrieverAddress
+		eigenDADirectory = testnetEigenDADirectory
 	case SepoliaBackend:
 		disperserHostname = disperserSepoliaHostname
 		certVerifierAddress = sepoliaCertVerifierAddress
 		svcManagerAddress = sepoliaSvcManagerAddress
 		blsOperatorStateRetrieverAddress = sepoliaBLSOperatorStateRetrieverAddress
+		eigenDADirectory = sepoliaEigenDADirectory
 	default:
 		panic("Unsupported backend")
 	}
@@ -353,6 +360,7 @@ func BuildTestSuiteConfig(testCfg TestConfig) config.AppConfig {
 			EigenDACertVerifierOrRouterAddress: certVerifierAddress,
 			BLSOperatorStateRetrieverAddr:      blsOperatorStateRetrieverAddress,
 			EigenDAServiceManagerAddr:          svcManagerAddress,
+			EigenDADirectory:                   eigenDADirectory,
 			RetrieversToEnable:                 testCfg.Retrievers,
 		},
 	}