Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: override config values use viper #1502

Merged
merged 12 commits into from
Aug 28, 2024
37 changes: 37 additions & 0 deletions common/utils/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ import (
"os"
"path/filepath"
"reflect"
"regexp"
"strconv"
"strings"
"time"

"github.com/modern-go/reflect2"
"github.com/scroll-tech/go-ethereum/common"
"github.com/scroll-tech/go-ethereum/core"
"github.com/scroll-tech/go-ethereum/crypto"
"github.com/scroll-tech/go-ethereum/log"
)

Expand Down Expand Up @@ -105,6 +108,19 @@ func OverrideConfigWithEnv(cfg interface{}, prefix string) error {
tag = strings.ToLower(field.Name)
}

// This is a private key field, we should handle it specially
if tag == "-" {
envKey := prefix + "_" + strings.ToUpper(camelToUnderscore(field.Name))
if envValue, exists := os.LookupEnv(envKey); exists {
log.Info("Overriding private key with env var", "key", envKey)
err := setField(fieldValue, envValue)
if err != nil {
return err
}
}
continue
}

envKey := prefix + "_" + strings.ToUpper(tag)

switch fieldValue.Kind() {
Expand Down Expand Up @@ -163,8 +179,29 @@ func setField(field reflect.Value, value string) error {
return err
}
field.SetBool(boolValue)
case reflect.Ptr:
if field.Type().Elem().Kind() == reflect.Struct && field.Type().Elem().Name() == "PrivateKey" {
ptrValue, err := crypto.ToECDSA(common.FromHex(value))
if err != nil {
return fmt.Errorf("failed to convert to ecdsa.PrivateKey: %w", err)
}
field.Set(reflect.ValueOf(ptrValue))
} else {
return fmt.Errorf("unsupported struct type: %v", field.Type())
}
default:
return fmt.Errorf("unsupported type: %v", field.Kind())
}
return nil
}

// camelToUnderscore convert camel case tring to under score case string
func camelToUnderscore(str string) string {
re := regexp.MustCompile("[A-Z]")

result := re.ReplaceAllStringFunc(str, func(s string) string {
return "_" + strings.ToLower(s)
})

return result[1:]
}
2 changes: 1 addition & 1 deletion common/version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"runtime/debug"
)

var tag = "v4.4.51"
var tag = "v4.4.52"

var commit = func() string {
if info, ok := debug.ReadBuildInfo(); ok {
Expand Down
27 changes: 27 additions & 0 deletions rollup/internal/config/config_test.go
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
package config

import (
"encoding/hex"
"encoding/json"
"fmt"
"os"
"testing"
"time"

"github.com/scroll-tech/go-ethereum/crypto"
"github.com/stretchr/testify/assert"
)

Expand Down Expand Up @@ -55,4 +57,29 @@ func TestConfig(t *testing.T) {
_, err = NewConfig(tmpFile.Name())
assert.Error(t, err)
})

t.Run("Override config value", func(t *testing.T) {
cfg, err := NewConfig("../../conf/config.json")
assert.NoError(t, err)

os.Setenv("SCROLL_ROLLUP_DB_CONFIG_DSN", "postgres://test:test@postgresql:5432/scroll?sslmode=disable")
os.Setenv("SCROLL_ROLLUP_L1_CONFIG_RELAYER_CONFIG_GAS_ORACLE_SENDER_PRIVATE_KEY", "1616161616161616161616161616161616161616161616161616161616161616")
os.Setenv("SCROLL_ROLLUP_L2_CONFIG_RELAYER_CONFIG_GAS_ORACLE_SENDER_PRIVATE_KEY", "1717171717171717171717171717171717171717171717171717171717171717")
os.Setenv("SCROLL_ROLLUP_L2_CONFIG_RELAYER_CONFIG_COMMIT_SENDER_PRIVATE_KEY", "1818181818181818181818181818181818181818181818181818181818181818")
os.Setenv("SCROLL_ROLLUP_L2_CONFIG_RELAYER_CONFIG_FINALIZE_SENDER_PRIVATE_KEY", "1919191919191919191919191919191919191919191919191919191919191919")
cfg2, err := NewConfig("../../conf/config.json")
assert.NoError(t, err)

assert.NotEqual(t, cfg.DBConfig.DSN, cfg2.DBConfig.DSN)
assert.NotEqual(t, cfg.L1Config.RelayerConfig.GasOracleSenderPrivateKey, cfg2.L1Config.RelayerConfig.GasOracleSenderPrivateKey)
assert.NotEqual(t, cfg.L2Config.RelayerConfig.GasOracleSenderPrivateKey, cfg2.L2Config.RelayerConfig.GasOracleSenderPrivateKey)
assert.NotEqual(t, cfg.L2Config.RelayerConfig.CommitSenderPrivateKey, cfg2.L2Config.RelayerConfig.CommitSenderPrivateKey)
assert.NotEqual(t, cfg.L2Config.RelayerConfig.FinalizeSenderPrivateKey, cfg2.L2Config.RelayerConfig.FinalizeSenderPrivateKey)

assert.Equal(t, cfg2.DBConfig.DSN, "postgres://test:test@postgresql:5432/scroll?sslmode=disable")
assert.Equal(t, hex.EncodeToString(crypto.FromECDSA(cfg2.L1Config.RelayerConfig.GasOracleSenderPrivateKey)), "1616161616161616161616161616161616161616161616161616161616161616")
assert.Equal(t, hex.EncodeToString(crypto.FromECDSA(cfg2.L2Config.RelayerConfig.GasOracleSenderPrivateKey)), "1717171717171717171717171717171717171717171717171717171717171717")
assert.Equal(t, hex.EncodeToString(crypto.FromECDSA(cfg2.L2Config.RelayerConfig.CommitSenderPrivateKey)), "1818181818181818181818181818181818181818181818181818181818181818")
assert.Equal(t, hex.EncodeToString(crypto.FromECDSA(cfg2.L2Config.RelayerConfig.FinalizeSenderPrivateKey)), "1919191919191919191919191919191919191919191919191919191919191919")
})
}
Loading