op-service: return prefixed env-var in slice

rdovgan · Jun 21, 2023 · f25b2d8 · f25b2d8
1 parent 018a5bb
commit f25b2d8
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 32 deletions.
diff --git a/endpoint-monitor/config.go b/endpoint-monitor/config.go
@@ -25,7 +25,7 @@ const (
 
 func CLIFlags(envPrefix string) []cli.Flag {
 	prefixEnvVars := func(name string) []string {
-		return []string{opservice.PrefixEnvVar(envPrefix, name)}
+		return opservice.PrefixEnvVar(envPrefix, name)
 	}
 	flags := []cli.Flag{
 		&cli.StringSliceFlag{

diff --git a/op-batcher/compressor/cli.go b/op-batcher/compressor/cli.go
@@ -15,32 +15,29 @@ const (
 )
 
 func CLIFlags(envPrefix string) []cli.Flag {
-	prefixEnvVars := func(name string) []string {
-		return []string{opservice.PrefixEnvVar(envPrefix, name)}
-	}
 	return []cli.Flag{
 		&cli.Uint64Flag{
 			Name:    TargetL1TxSizeBytesFlagName,
 			Usage:   "The target size of a batch tx submitted to L1.",
 			Value:   100_000,
-			EnvVars: prefixEnvVars("TARGET_L1_TX_SIZE_BYTES"),
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "TARGET_L1_TX_SIZE_BYTES"),
 		},
 		&cli.IntFlag{
 			Name:    TargetNumFramesFlagName,
 			Usage:   "The target number of frames to create per channel",
 			Value:   1,
-			EnvVars: prefixEnvVars("TARGET_NUM_FRAMES"),
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "TARGET_NUM_FRAMES"),
 		},
 		&cli.Float64Flag{
 			Name:    ApproxComprRatioFlagName,
 			Usage:   "The approximate compression ratio (<= 1.0)",
 			Value:   0.4,
-			EnvVars: prefixEnvVars("APPROX_COMPR_RATIO"),
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "APPROX_COMPR_RATIO"),
 		},
 		&cli.StringFlag{
 			Name:    KindFlagName,
 			Usage:   "The type of compressor. Valid options: " + strings.Join(KindKeys, ", "),
-			EnvVars: prefixEnvVars("COMPRESSOR"),
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "COMPRESSOR"),
 			Value:   RatioKind,
 		},
 	}

diff --git a/op-batcher/flags/flags.go b/op-batcher/flags/flags.go
@@ -19,7 +19,7 @@ import (
 const EnvVarPrefix = "OP_BATCHER"
 
 func prefixEnvVars(name string) []string {
-	return []string{opservice.PrefixEnvVar(EnvVarPrefix, name)}
+	return opservice.PrefixEnvVar(EnvVarPrefix, name)
 }
 
 var (

diff --git a/op-batcher/rpc/config.go b/op-batcher/rpc/config.go
@@ -16,7 +16,7 @@ func CLIFlags(envPrefix string) []cli.Flag {
 		&cli.BoolFlag{
 			Name:    EnableAdminFlagName,
 			Usage:   "Enable the admin API (experimental)",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "RPC_ENABLE_ADMIN")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "RPC_ENABLE_ADMIN"),
 		},
 	}
 }

diff --git a/op-bootnode/flags/flags.go b/op-bootnode/flags/flags.go
@@ -14,7 +14,7 @@ import (
 const envVarPrefix = "OP_BOOTNODE"
 
 func prefixEnvVars(name string) []string {
-	return []string{opservice.PrefixEnvVar(envVarPrefix, name)}
+	return opservice.PrefixEnvVar(envVarPrefix, name)
 }
 
 var (

diff --git a/op-challenger/flags/flags.go b/op-challenger/flags/flags.go
@@ -16,7 +16,7 @@ import (
 const envVarPrefix = "OP_CHALLENGER"
 
 func prefixEnvVars(name string) []string {
-	return []string{opservice.PrefixEnvVar(envVarPrefix, name)}
+	return opservice.PrefixEnvVar(envVarPrefix, name)
 }
 
 var (

diff --git a/op-heartbeat/flags/flags.go b/op-heartbeat/flags/flags.go
@@ -10,7 +10,7 @@ import (
 const envPrefix = "OP_HEARTBEAT"
 
 func prefixEnvVars(name string) []string {
-	return []string{opservice.PrefixEnvVar(envPrefix, name)}
+	return opservice.PrefixEnvVar(envPrefix, name)
 }
 
 const (

diff --git a/op-program/host/flags/flags.go b/op-program/host/flags/flags.go
@@ -16,7 +16,7 @@ import (
 const EnvVarPrefix = "OP_PROGRAM"
 
 func prefixEnvVars(name string) []string {
-	return []string{service.PrefixEnvVar(EnvVarPrefix, name)}
+	return service.PrefixEnvVar(EnvVarPrefix, name)
 }
 
 var (

diff --git a/op-proposer/flags/flags.go b/op-proposer/flags/flags.go
@@ -17,7 +17,7 @@ import (
 const EnvVarPrefix = "OP_PROPOSER"
 
 func prefixEnvVars(name string) []string {
-	return []string{opservice.PrefixEnvVar(EnvVarPrefix, name)}
+	return opservice.PrefixEnvVar(EnvVarPrefix, name)
 }
 
 var (

diff --git a/op-service/log/cli.go b/op-service/log/cli.go
@@ -24,18 +24,18 @@ func CLIFlags(envPrefix string) []cli.Flag {
 			Name:    LevelFlagName,
 			Usage:   "The lowest log level that will be output",
 			Value:   "info",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "LOG_LEVEL")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "LOG_LEVEL"),
 		},
 		&cli.StringFlag{
 			Name:    FormatFlagName,
 			Usage:   "Format the log output. Supported formats: 'text', 'terminal', 'logfmt', 'json', 'json-pretty',",
 			Value:   "text",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "LOG_FORMAT")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "LOG_FORMAT"),
 		},
 		&cli.BoolFlag{
 			Name:    ColorFlagName,
 			Usage:   "Color the log output if in terminal mode",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "LOG_COLOR")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "LOG_COLOR"),
 		},
 	}
 }

diff --git a/op-service/metrics/cli.go b/op-service/metrics/cli.go
@@ -20,19 +20,19 @@ func CLIFlags(envPrefix string) []cli.Flag {
 		&cli.BoolFlag{
 			Name:    EnabledFlagName,
 			Usage:   "Enable the metrics server",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "METRICS_ENABLED")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "METRICS_ENABLED"),
 		},
 		&cli.StringFlag{
 			Name:    ListenAddrFlagName,
 			Usage:   "Metrics listening address",
 			Value:   "0.0.0.0",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "METRICS_ADDR")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "METRICS_ADDR"),
 		},
 		&cli.IntFlag{
 			Name:    PortFlagName,
 			Usage:   "Metrics listening port",
 			Value:   7300,
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "METRICS_PORT")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "METRICS_PORT"),
 		},
 	}
 }

diff --git a/op-service/pprof/cli.go b/op-service/pprof/cli.go
@@ -19,19 +19,19 @@ func CLIFlags(envPrefix string) []cli.Flag {
 		&cli.BoolFlag{
 			Name:    EnabledFlagName,
 			Usage:   "Enable the pprof server",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "PPROF_ENABLED")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "PPROF_ENABLED"),
 		},
 		&cli.StringFlag{
 			Name:    ListenAddrFlagName,
 			Usage:   "pprof listening address",
 			Value:   "0.0.0.0",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "PPROF_ADDR")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "PPROF_ADDR"),
 		},
 		&cli.IntFlag{
 			Name:    PortFlagName,
 			Usage:   "pprof listening port",
 			Value:   6060,
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "PPROF_PORT")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "PPROF_PORT"),
 		},
 	}
 }

diff --git a/op-service/rpc/cli.go b/op-service/rpc/cli.go
@@ -19,13 +19,13 @@ func CLIFlags(envPrefix string) []cli.Flag {
 			Name:    ListenAddrFlagName,
 			Usage:   "rpc listening address",
 			Value:   "0.0.0.0",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "RPC_ADDR")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "RPC_ADDR"),
 		},
 		&cli.IntFlag{
 			Name:    PortFlagName,
 			Usage:   "rpc listening port",
 			Value:   8545,
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "RPC_PORT")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "RPC_PORT"),
 		},
 	}
 }

diff --git a/op-service/tls/cli.go b/op-service/tls/cli.go
@@ -30,7 +30,7 @@ func CLIFlagsWithFlagPrefix(envPrefix string, flagPrefix string) []cli.Flag {
 		return strings.Trim(fmt.Sprintf("%s.%s", flagPrefix, flagName), ".")
 	}
 	prefixEnvVars := func(name string) []string {
-		return []string{opservice.PrefixEnvVar(envPrefix, name)}
+		return opservice.PrefixEnvVar(envPrefix, name)
 	}
 	return []cli.Flag{
 		&cli.StringFlag{

diff --git a/op-service/txmgr/cli.go b/op-service/txmgr/cli.go
@@ -50,7 +50,7 @@ var (
 
 func CLIFlags(envPrefix string) []cli.Flag {
 	prefixEnvVars := func(name string) []string {
-		return []string{opservice.PrefixEnvVar(envPrefix, name)}
+		return opservice.PrefixEnvVar(envPrefix, name)
 	}
 	return append([]cli.Flag{
 		&cli.StringFlag{

diff --git a/op-service/util.go b/op-service/util.go
@@ -16,8 +16,10 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
-func PrefixEnvVar(prefix, suffix string) string {
-	return prefix + "_" + suffix
+// PrefixEnvVar adds a prefix to the environment variable,
+// and returns the env-var wrapped in a slice for usage with urfave CLI v2.
+func PrefixEnvVar(prefix, suffix string) []string {
+	return []string{prefix + "_" + suffix}
 }
 
 // ValidateEnvVars logs all env vars that are found where the env var is

diff --git a/op-signer/client/config.go b/op-signer/client/config.go
@@ -20,12 +20,12 @@ func CLIFlags(envPrefix string) []cli.Flag {
 		&cli.StringFlag{
 			Name:    EndpointFlagName,
 			Usage:   "Signer endpoint the client will connect to",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "ENDPOINT")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "ENDPOINT"),
 		},
 		&cli.StringFlag{
 			Name:    AddressFlagName,
 			Usage:   "Address the signer is signing transactions for",
-			EnvVars: []string{opservice.PrefixEnvVar(envPrefix, "ADDRESS")},
+			EnvVars: opservice.PrefixEnvVar(envPrefix, "ADDRESS"),
 		},
 	}
 	flags = append(flags, optls.CLIFlagsWithFlagPrefix(envPrefix, "signer")...)