update: config re-name addr to rpc_url (#20)

* update: config name addr to url

* update to RPC_URL

Author: ericvelazquez

op-translator/internal/config/config.go

@@ -28,9 +28,9 @@ var (
 )
 
 type Config struct {
-	SettlementChainAddr        string `koanf:"settlement_chain_addr"`
-	SequencingChainAddr        string `koanf:"sequencing_chain_addr"`
-	MetaBasedChainAddr         string `koanf:"meta_based_chain_addr"`
+	SettlementChainRPCURL      string `koanf:"settlement_chain_rpc_url"`
+	SequencingChainRPCURL      string `koanf:"sequencing_chain_rpc_url"`
+	MetaBasedChainRPCURL       string `koanf:"meta_based_chain_rpc_url"`
 	SequencingContractAddress  string `koanf:"sequencing_contract_address"`
 	BatcherAddress             string `koanf:"batcher_address"`
 	BatchInboxAddress          string `koanf:"batch_inbox_address"`
@@ -48,9 +48,9 @@ type Config struct {
 // setCLIFlags sets all valid CLI flags for the app
 func setCLIFlags(f *pflag.FlagSet) {
 	f.Int("port", defaultPort, "Server port number for the app")
-	f.String("settlement_chain_addr", "https://sepolia.base.org", "Settlement chain address")
-	f.String("sequencing_chain_addr", "https://sepolia.base.org", "Sequencing chain address")
-	f.String("meta_based_chain_addr", "https://sepolia.base.org", "Meta based chain address")
+	f.String("settlement_chain_rpc_url", "https://sepolia.base.org", "Settlement chain address")
+	f.String("sequencing_chain_rpc_url", "https://sepolia.base.org", "Sequencing chain address")
+	f.String("meta_based_chain_rpc_url", "https://sepolia.base.org", "Meta based chain address")
 	f.String("log_level", constants.Info.String(), "Log level for the app")
 	f.Int("frame_size", defaultFrameSize, "Size of each frame in bytes. Max is 1,000,000")
 	f.Bool("pretty", false, "Pretty print JSON log responses")
@@ -67,9 +67,9 @@ func setCLIFlags(f *pflag.FlagSet) {
 // hydrateFromConfMap sets the Config values from the koanf conf map
 func hydrateFromConfMap(config *Config) {
 	config.Port = k.Int("port")
-	config.SettlementChainAddr = k.String("settlement_chain_addr")
-	config.SequencingChainAddr = k.String("sequencing_chain_addr")
-	config.MetaBasedChainAddr = k.String("meta_based_chain_addr")
+	config.SettlementChainRPCURL = k.String("settlement_chain_rpc_url")
+	config.SequencingChainRPCURL = k.String("sequencing_chain_rpc_url")
+	config.MetaBasedChainRPCURL = k.String("meta_based_chain_rpc_url")
 	config.FrameSize = k.Int("frame_size")
 	config.LogLevel = k.String("log_level")
 	config.Pretty = k.Bool("pretty")
@@ -136,17 +136,17 @@ func ValidateConfigValues(config *Config) (result error) {
 		result = multierror.Append(result, errors.New("frameSize must be less than maximum"))
 	}
 
-	_, err := url.ParseRequestURI(config.SequencingChainAddr)
+	_, err := url.ParseRequestURI(config.SequencingChainRPCURL)
 	if err != nil {
 		result = multierror.Append(result, fmt.Errorf("invalid URL for sequencing chain address: %w", err))
 	}
 
-	_, err = url.ParseRequestURI(config.SettlementChainAddr)
+	_, err = url.ParseRequestURI(config.SettlementChainRPCURL)
 	if err != nil {
 		result = multierror.Append(result, fmt.Errorf("invalid URL for settlement chain address: %w", err))
 	}
 
-	_, err = url.ParseRequestURI(config.MetaBasedChainAddr)
+	_, err = url.ParseRequestURI(config.MetaBasedChainRPCURL)
 	if err != nil {
 		result = multierror.Append(result, fmt.Errorf("invalid URL for meta based chain address: %w", err))
 	}

op-translator/internal/config/config_test.go

@@ -15,9 +15,9 @@ func validConfig() config.Config {
 	return config.Config{
 		Port:                       1234,
 		FrameSize:                  100,
-		SequencingChainAddr:        "http://example.com",
-		SettlementChainAddr:        "https://example.org",
-		MetaBasedChainAddr:         "https://example.io",
+		SequencingChainRPCURL:      "http://example.com",
+		SettlementChainRPCURL:      "https://example.org",
+		MetaBasedChainRPCURL:       "https://example.io",
 		LogLevel:                   constants.Info.String(),
 		Pretty:                     false,
 		SequencingContractAddress:  "0x0000000000000000000000000000000000000000",
@@ -59,21 +59,21 @@ func TestValidateConfigValues(t *testing.T) {
 		{
 			name: "Invalid sequencingChainAddr",
 			configChangeUnderTest: func(c *config.Config) {
-				c.SequencingChainAddr = "invalid sequencing chain address"
+				c.SequencingChainRPCURL = "invalid sequencing chain address"
 			},
 			expectedErrors: []string{"invalid URL for sequencing chain address"},
 		},
 		{
 			name: "Invalid settlementChainAddr",
 			configChangeUnderTest: func(c *config.Config) {
-				c.SettlementChainAddr = "invalid settlement chain address"
+				c.SettlementChainRPCURL = "invalid settlement chain address"
 			},
 			expectedErrors: []string{"invalid URL for settlement chain address"},
 		},
 		{
 			name: "Invalid metaBasedChainAddr",
 			configChangeUnderTest: func(c *config.Config) {
-				c.MetaBasedChainAddr = "invalid meta based chain address"
+				c.MetaBasedChainRPCURL = "invalid meta based chain address"
 			},
 			expectedErrors: []string{"invalid URL for meta based chain address"},
 		},
@@ -131,9 +131,9 @@ func TestValidateConfigValues(t *testing.T) {
 			configChangeUnderTest: func(c *config.Config) {
 				c.Port = -1
 				c.FrameSize = 0
-				c.SequencingChainAddr = "invalid"
-				c.SettlementChainAddr = "also invalid"
-				c.MetaBasedChainAddr = "https://example.io"
+				c.SequencingChainRPCURL = "invalid"
+				c.SettlementChainRPCURL = "also invalid"
+				c.MetaBasedChainRPCURL = "https://example.io"
 				c.SequencePerSettlementBlock = 0
 			},
 			expectedErrors: []string{

op-translator/internal/server/server.go

@@ -18,7 +18,7 @@ import (
 
 func TranslatorHandler(cfg *config.Config, translator any) (*http.ServeMux, error) {
 	// Setup proxy
-	parsedURL, err := url.Parse(cfg.SettlementChainAddr)
+	parsedURL, err := url.Parse(cfg.SettlementChainRPCURL)
 	if err != nil {
 		return nil, err
 	}

op-translator/internal/server/server_test.go

@@ -66,7 +66,7 @@ func TestProxyEndpoint(t *testing.T) {
 	defer mockBackend.Close()
 
 	config := mocks.DefaultTestingConfig
-	config.SettlementChainAddr = mockBackend.URL
+	config.SettlementChainRPCURL = mockBackend.URL
 	router, err := server.TranslatorHandler(config, mockTranslator)
 	assert.NoError(t, err)
 

op-translator/mocks/config_mock.go

@@ -30,9 +30,9 @@ var DefaultTestingConfig = &config.Config{
 	SettlementStartBlock:       TestingSettlementStartBlock,
 	SequencePerSettlementBlock: TestingSequencePerSettlementBlock,
 	BatcherPrivateKey:          TestingBatcherPrivateKey,
-	SettlementChainAddr:        "http://localhost:8545",
-	SequencingChainAddr:        "http://localhost:8545",
-	MetaBasedChainAddr:         "http://localhost:8545",
+	SettlementChainRPCURL:      "http://localhost:8545",
+	SequencingChainRPCURL:      "http://localhost:8545",
+	MetaBasedChainRPCURL:       "http://localhost:8545",
 	BatchInboxAddress:          TestingBatchInboxAddress,
 	BatcherAddress:             TestingBatcherAddress,
 	SettlementChainID:          TestingSettlementChainID,

op-translator/pkg/translator/batch_provider.go

@@ -41,12 +41,12 @@ type MetaBasedBatchProvider struct {
 }
 
 func InitMetaBasedBatchProvider(cfg *config.Config) *MetaBasedBatchProvider {
-	sequencingChain, err := rpc.Connect(cfg.SequencingChainAddr)
+	sequencingChain, err := rpc.Connect(cfg.SequencingChainRPCURL)
 	if err != nil {
 		log.Panic().Err(err).Msg("Failed to initialize sequencing chain")
 	}
 
-	metaBasedChain, err := rpc.Connect(cfg.MetaBasedChainAddr)
+	metaBasedChain, err := rpc.Connect(cfg.MetaBasedChainRPCURL)
 	if err != nil {
 		log.Panic().Err(err).Msg("Failed to initialize metabased chain")
 	}

op-translator/pkg/translator/translator.go

@@ -36,7 +36,7 @@ type OPTranslator struct {
 }
 
 func Init(cfg *config.Config) *OPTranslator {
-	settlementChain, err := rpc.Connect(cfg.SettlementChainAddr)
+	settlementChain, err := rpc.Connect(cfg.SettlementChainRPCURL)
 	if err != nil {
 		log.Panic().Err(err).Msg("Failed to initialize settlement chain")
 	}

op-translator/template.env

@@ -1,9 +1,9 @@
 ## NOTE: keys are case-sensitive
 
 PORT=9999
-SETTLEMENT_CHAIN_ADDR=http://localhost:8548
-SEQUENCING_CHAIN_ADDR=http://localhost:8548
-META_BASED_CHAIN_ADDR=http://localhost:8548
+SETTLEMENT_CHAIN_RPC_URL=http://localhost:8548
+SEQUENCING_CHAIN_RPC_URL=http://localhost:8548
+META_BASED_CHAIN_RPC_URL=http://localhost:8548
 FRAME_SIZE=<>
 LOG_LEVEL=debug
 SEQUENCING_CONTRACT_ADDRESS=<>