Skip to content

Commit

Permalink
refactor: move flags from config.go -> flags.go
Browse files Browse the repository at this point in the history
  • Loading branch information
@samlaf
samlaf committed Sep 22, 2024
1 parent 3f4f2ba commit 9f4320b
Show file tree
Hide file tree
Showing 4 changed files with 298 additions and 291 deletions.
296 changes: 9 additions & 287 deletions server/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,64 +5,14 @@ import (
"runtime"
"time"

"github.com/urfave/cli/v2"

"github.com/Layr-Labs/eigenda-proxy/store"
"github.com/Layr-Labs/eigenda-proxy/utils"
"github.com/Layr-Labs/eigenda-proxy/verify"
"github.com/Layr-Labs/eigenda/api/clients"
"github.com/Layr-Labs/eigenda/api/clients/codecs"
"github.com/Layr-Labs/eigenda/encoding/kzg"
"github.com/urfave/cli/v2"
)

const (
// eigenda client flags
EigenDADisperserRPCFlagName = "eigenda-disperser-rpc"
StatusQueryRetryIntervalFlagName = "eigenda-status-query-retry-interval"
StatusQueryTimeoutFlagName = "eigenda-status-query-timeout"
DisableTLSFlagName = "eigenda-disable-tls"
ResponseTimeoutFlagName = "eigenda-response-timeout"
CustomQuorumIDsFlagName = "eigenda-custom-quorum-ids"
SignerPrivateKeyHexFlagName = "eigenda-signer-private-key-hex"
PutBlobEncodingVersionFlagName = "eigenda-put-blob-encoding-version"
DisablePointVerificationModeFlagName = "eigenda-disable-point-verification-mode"

// cert verification flags
CertVerificationEnabledFlagName = "eigenda-cert-verification-enabled"
EthRPCFlagName = "eigenda-eth-rpc"
SvcManagerAddrFlagName = "eigenda-svc-manager-addr"
EthConfirmationDepthFlagName = "eigenda-eth-confirmation-depth"

// kzg flags
G1PathFlagName = "eigenda-g1-path"
G2TauFlagName = "eigenda-g2-tau-path"
CachePathFlagName = "eigenda-cache-path"
MaxBlobLengthFlagName = "eigenda-max-blob-length"

// memstore flags
MemstoreFlagName = "memstore.enabled"
MemstoreExpirationFlagName = "memstore.expiration"
MemstorePutLatencyFlagName = "memstore.put-latency"
MemstoreGetLatencyFlagName = "memstore.get-latency"

// redis client flags
RedisEndpointFlagName = "redis.endpoint"
RedisPasswordFlagName = "redis.password"
RedisDBFlagName = "redis.db"
RedisEvictionFlagName = "redis.eviction"

// S3 client flags
S3CredentialTypeFlagName = "s3.credential-type" // #nosec G101
S3BucketFlagName = "s3.bucket" // #nosec G101
S3PathFlagName = "s3.path"
S3EndpointFlagName = "s3.endpoint"
S3AccessKeyIDFlagName = "s3.access-key-id" // #nosec G101
S3AccessKeySecretFlagName = "s3.access-key-secret" // #nosec G101
S3BackupFlagName = "s3.backup"
S3TimeoutFlagName = "s3.timeout"

// routing flags
FallbackTargets = "routing.fallback-targets"
CacheTargets = "routing.cache-targets"
)

const (
Expand Down Expand Up @@ -111,8 +61,8 @@ type Config struct {
CacheTargets []string

// secondary storage
RedisCfg store.RedisConfig
S3Config store.S3Config
RedisConfig store.RedisConfig
S3Config store.S3Config
}

// GetMaxBlobLength ... returns the maximum blob length in bytes
Expand Down Expand Up @@ -161,7 +111,7 @@ func (cfg *Config) VerificationCfg() *verify.Config {
// ReadConfig ... parses the Config from the provided flags or environment variables.
func ReadConfig(ctx *cli.Context) Config {
cfg := Config{
RedisCfg: store.RedisConfig{
RedisConfig: store.RedisConfig{
Endpoint: ctx.String(RedisEndpointFlagName),
Password: ctx.String(RedisPasswordFlagName),
DB: ctx.Int(RedisDBFlagName),
Expand Down Expand Up @@ -191,17 +141,17 @@ func ReadConfig(ctx *cli.Context) Config {
G1Path: ctx.String(G1PathFlagName),
G2PowerOfTauPath: ctx.String(G2TauFlagName),
CacheDir: ctx.String(CachePathFlagName),
CertVerificationEnabled: ctx.Bool(CertVerificationEnabledFlagName),
MaxBlobLength: ctx.String(MaxBlobLengthFlagName),
CertVerificationEnabled: ctx.Bool(CertVerificationEnabledFlagName),
SvcManagerAddr: ctx.String(SvcManagerAddrFlagName),
EthRPC: ctx.String(EthRPCFlagName),
EthConfirmationDepth: ctx.Int64(EthConfirmationDepthFlagName),
MemstoreEnabled: ctx.Bool(MemstoreFlagName),
MemstoreBlobExpiration: ctx.Duration(MemstoreExpirationFlagName),
MemstoreGetLatency: ctx.Duration(MemstoreGetLatencyFlagName),
MemstorePutLatency: ctx.Duration(MemstorePutLatencyFlagName),
FallbackTargets: ctx.StringSlice(FallbackTargets),
CacheTargets: ctx.StringSlice(CacheTargets),
FallbackTargets: ctx.StringSlice(FallbackTargetsFlagName),
CacheTargets: ctx.StringSlice(CacheTargetsFlagName),
}
// the eigenda client can only wait for 0 confirmations or finality
// the da-proxy has a more fine-grained notion of confirmation depth
Expand Down Expand Up @@ -273,7 +223,7 @@ func (cfg *Config) Check() error {
}
}

if cfg.RedisCfg.Endpoint == "" && cfg.RedisCfg.Password != "" {
if cfg.RedisConfig.Endpoint == "" && cfg.RedisConfig.Password != "" {
return fmt.Errorf("redis password is set, but endpoint is not")
}

Expand All @@ -296,231 +246,3 @@ func (cfg *Config) Check() error {

return nil
}

// s3Flags ... used for S3 backend configuration
func s3Flags() []cli.Flag {
return []cli.Flag{
&cli.StringFlag{
Name: S3CredentialTypeFlagName,
Usage: "The way to authenticate to S3, options are [iam, static]",
EnvVars: prefixEnvVars("S3_CREDENTIAL_TYPE"),
},
&cli.StringFlag{
Name: S3BucketFlagName,
Usage: "bucket name for S3 storage",
EnvVars: prefixEnvVars("S3_BUCKET"),
},
&cli.StringFlag{
Name: S3PathFlagName,
Usage: "path for S3 storage",
EnvVars: prefixEnvVars("S3_PATH"),
},
&cli.StringFlag{
Name: S3EndpointFlagName,
Usage: "endpoint for S3 storage",
Value: "",
EnvVars: prefixEnvVars("S3_ENDPOINT"),
},
&cli.StringFlag{
Name: S3AccessKeyIDFlagName,
Usage: "access key id for S3 storage",
Value: "",
EnvVars: prefixEnvVars("S3_ACCESS_KEY_ID"),
},
&cli.StringFlag{
Name: S3AccessKeySecretFlagName,
Usage: "access key secret for S3 storage",
Value: "",
EnvVars: prefixEnvVars("S3_ACCESS_KEY_SECRET"),
},
&cli.BoolFlag{
Name: S3BackupFlagName,
Usage: "whether to use S3 as a backup store to ensure resiliency in case of EigenDA read failure",
Value: false,
EnvVars: prefixEnvVars("S3_BACKUP"),
},
&cli.DurationFlag{
Name: S3TimeoutFlagName,
Usage: "timeout for S3 storage operations (e.g. get, put)",
Value: 5 * time.Second,
EnvVars: prefixEnvVars("S3_TIMEOUT"),
},
}
}

// redisFlags ... used for Redis backend configuration
func redisFlags() []cli.Flag {
return []cli.Flag{
&cli.StringFlag{
Name: RedisEndpointFlagName,
Usage: "Redis endpoint",
EnvVars: prefixEnvVars("REDIS_ENDPOINT"),
},
&cli.StringFlag{
Name: RedisPasswordFlagName,
Usage: "Redis password",
EnvVars: prefixEnvVars("REDIS_PASSWORD"),
},
&cli.IntFlag{
Name: RedisDBFlagName,
Usage: "Redis database",
Value: 0,
EnvVars: prefixEnvVars("REDIS_DB"),
},
&cli.DurationFlag{
Name: RedisEvictionFlagName,
Usage: "Redis eviction time",
Value: 24 * time.Hour,
EnvVars: prefixEnvVars("REDIS_EVICTION"),
},
}
}

func CLIFlags() []cli.Flag {
// TODO: Decompose all flags into constituent parts based on their respective category / usage
flags := []cli.Flag{
&cli.StringFlag{
Name: EigenDADisperserRPCFlagName,
Usage: "RPC endpoint of the EigenDA disperser.",
EnvVars: prefixEnvVars("EIGENDA_DISPERSER_RPC"),
},
&cli.DurationFlag{
Name: StatusQueryTimeoutFlagName,
Usage: "Duration to wait for a blob to finalize after being sent for dispersal. Default is 30 minutes.",
Value: 30 * time.Minute,
EnvVars: prefixEnvVars("STATUS_QUERY_TIMEOUT"),
},
&cli.DurationFlag{
Name: StatusQueryRetryIntervalFlagName,
Usage: "Interval between retries when awaiting network blob finalization. Default is 5 seconds.",
Value: 5 * time.Second,
EnvVars: prefixEnvVars("STATUS_QUERY_INTERVAL"),
},
&cli.BoolFlag{
Name: DisableTLSFlagName,
Usage: "Disable TLS for gRPC communication with the EigenDA disperser. Default is false.",
Value: false,
EnvVars: prefixEnvVars("GRPC_DISABLE_TLS"),
},
&cli.DurationFlag{
Name: ResponseTimeoutFlagName,
Usage: "Total time to wait for a response from the EigenDA disperser. Default is 60 seconds.",
Value: 60 * time.Second,
EnvVars: prefixEnvVars("RESPONSE_TIMEOUT"),
},
&cli.UintSliceFlag{
Name: CustomQuorumIDsFlagName,
Usage: "Custom quorum IDs for writing blobs. Should not include default quorums 0 or 1.",
Value: cli.NewUintSlice(),
EnvVars: prefixEnvVars("CUSTOM_QUORUM_IDS"),
},
&cli.StringFlag{
Name: SignerPrivateKeyHexFlagName,
Usage: "Hex-encoded signer private key. This key should not be associated with an Ethereum address holding any funds.",
EnvVars: prefixEnvVars("SIGNER_PRIVATE_KEY_HEX"),
},
&cli.UintFlag{
Name: PutBlobEncodingVersionFlagName,
Usage: "Blob encoding version to use when writing blobs from the high-level interface.",
EnvVars: prefixEnvVars("PUT_BLOB_ENCODING_VERSION"),
Value: 0,
},
&cli.BoolFlag{
Name: DisablePointVerificationModeFlagName,
Usage: "Disable point verification mode. This mode performs IFFT on data before writing and FFT on data after reading. Disabling requires supplying the entire blob for verification against the KZG commitment.",
EnvVars: prefixEnvVars("DISABLE_POINT_VERIFICATION_MODE"),
Value: false,
},
&cli.StringFlag{
Name: MaxBlobLengthFlagName,
Usage: "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 slightly exceeds 1GB.",
EnvVars: prefixEnvVars("MAX_BLOB_LENGTH"),
Value: "16MiB",
},
&cli.StringFlag{
Name: G1PathFlagName,
Usage: "Directory path to g1.point file.",
EnvVars: prefixEnvVars("TARGET_KZG_G1_PATH"),
Value: "resources/g1.point",
},
&cli.StringFlag{
Name: G2TauFlagName,
Usage: "Directory path to g2.point.powerOf2 file.",
EnvVars: prefixEnvVars("TARGET_G2_TAU_PATH"),
Value: "resources/g2.point.powerOf2",
},
&cli.StringFlag{
Name: CachePathFlagName,
Usage: "Directory path to SRS tables for caching.",
EnvVars: prefixEnvVars("TARGET_CACHE_PATH"),
Value: "resources/SRSTables/",
},
&cli.BoolFlag{
Name: CertVerificationEnabledFlagName,
Usage: "Whether to verify certificates received from EigenDA disperser.",
EnvVars: prefixEnvVars("CERT_VERIFICATION_ENABLED"),
// TODO: ideally we'd want this to be turned on by default when eigenda backend is used (memstore.enabled=false)
Value: false,
},
&cli.StringFlag{
Name: EthRPCFlagName,
Usage: "JSON RPC node endpoint for the Ethereum network used for finalizing DA blobs.\n" +
"See available list here: https://docs.eigenlayer.xyz/eigenda/networks/\n" +
fmt.Sprintf("Mandatory when %s is true.", CertVerificationEnabledFlagName),
EnvVars: prefixEnvVars("ETH_RPC"),
},
&cli.StringFlag{
Name: SvcManagerAddrFlagName,
Usage: "The deployed EigenDA service manager address.\n" +
"The list can be found here: https://github.com/Layr-Labs/eigenlayer-middleware/?tab=readme-ov-file#current-mainnet-deployment\n" +
fmt.Sprintf("Mandatory when %s is true.", CertVerificationEnabledFlagName),
EnvVars: prefixEnvVars("SERVICE_MANAGER_ADDR"),
},
&cli.Int64Flag{
Name: EthConfirmationDepthFlagName,
Usage: "The number of Ethereum blocks to wait before considering a submitted blob's DA batch submission confirmed.\n" +
"`0` means wait for inclusion only. `-1` means wait for finality.",
EnvVars: prefixEnvVars("ETH_CONFIRMATION_DEPTH"),
Value: -1,
},
&cli.BoolFlag{
Name: MemstoreFlagName,
Usage: "Whether to use mem-store for DA logic.",
EnvVars: prefixEnvVars("MEMSTORE_ENABLED"),
},
&cli.DurationFlag{
Name: MemstoreExpirationFlagName,
Usage: "Duration that a mem-store blob/commitment pair are allowed to live.",
Value: 25 * time.Minute,
EnvVars: prefixEnvVars("MEMSTORE_EXPIRATION"),
},
&cli.DurationFlag{
Name: MemstorePutLatencyFlagName,
Usage: "Artificial latency added for memstore backend to mimic EigenDA's dispersal latency.",
Value: 0,
EnvVars: prefixEnvVars("MEMSTORE_PUT_LATENCY"),
},
&cli.DurationFlag{
Name: MemstoreGetLatencyFlagName,
Usage: "Artificial latency added for memstore backend to mimic EigenDA's retrieval latency.",
Value: 0,
EnvVars: prefixEnvVars("MEMSTORE_GET_LATENCY"),
},
&cli.StringSliceFlag{
Name: FallbackTargets,
Usage: "List of read fallback targets to rollover to if cert can't be read from EigenDA.",
Value: cli.NewStringSlice(),
EnvVars: prefixEnvVars("FALLBACK_TARGETS"),
},
&cli.StringSliceFlag{
Name: CacheTargets,
Usage: "List of caching targets to use fast reads from EigenDA.",
Value: cli.NewStringSlice(),
EnvVars: prefixEnvVars("CACHE_TARGETS"),
},
}

flags = append(flags, s3Flags()...)
flags = append(flags, redisFlags()...)
return flags
}
4 changes: 2 additions & 2 deletions server/config_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (

func validCfg() *Config {
return &Config{
RedisCfg: store.RedisConfig{
RedisConfig: store.RedisConfig{
Endpoint: "localhost:6379",
Password: "password",
DB: 0,
Expand Down Expand Up @@ -186,7 +186,7 @@ func TestConfigVerification(t *testing.T) {

t.Run("BadRedisConfiguration", func(t *testing.T) {
cfg := validCfg()
cfg.RedisCfg.Endpoint = ""
cfg.RedisConfig.Endpoint = ""

err := cfg.Check()
require.Error(t, err)
Expand Down
Loading

0 comments on commit 9f4320b

Please sign in to comment.