backport: rename config ChainName to ChainType (#87)

CHANGELOG.md

@@ -44,6 +44,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 * [#114](https://github.com/babylonlabs-io/finality-provider/pull/114) Bump Babylon version to v0.15.0
 * [#102](https://github.com/babylonlabs-io/finality-provider/pull/102) Improve `eotsd keys add` command
 * [#104](https://github.com/babylonlabs-io/finality-provider/pull/104) Print fpd binary version
+* [#87](https://github.com/babylonlabs-io/finality-provider/pull/87) Rename ChainName to ChainType
 
 ## v0.9.1
 

clientcontroller/interface.go

@@ -17,7 +17,7 @@ import (
 )
 
 const (
-	babylonConsumerChainName = "babylon"
+	babylonConsumerChainType = "babylon"
 )
 
 type ClientController interface {
@@ -82,14 +82,14 @@ type ClientController interface {
 	Close() error
 }
 
-func NewClientController(chainName string, bbnConfig *fpcfg.BBNConfig, netParams *chaincfg.Params, logger *zap.Logger) (ClientController, error) {
+func NewClientController(chainType string, bbnConfig *fpcfg.BBNConfig, netParams *chaincfg.Params, logger *zap.Logger) (ClientController, error) {
 	var (
 		cc  ClientController
 		err error
 	)
 
-	switch chainName {
-	case babylonConsumerChainName:
+	switch chainType {
+	case babylonConsumerChainType:
 		cc, err = NewBabylonController(bbnConfig, netParams, logger)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create Babylon rpc client: %w", err)

finality-provider/config/config.go

@@ -18,7 +18,7 @@ import (
 )
 
 const (
-	defaultChainName               = "babylon"
+	defaultChainType               = "babylon"
 	defaultLogLevel                = zapcore.InfoLevel
 	defaultLogDirname              = "logs"
 	defaultLogFilename             = "fpd.log"
@@ -55,8 +55,8 @@ var (
 // Config is the main config for the fpd cli command
 type Config struct {
 	LogLevel string `long:"loglevel" description:"Logging level for all subsystems" choice:"trace" choice:"debug" choice:"info" choice:"warn" choice:"error" choice:"fatal"`
-	// ChainName and ChainID (if any) of the chain config identify a consumer chain
-	ChainName                string        `long:"chainname" description:"the name of the consumer chain" choice:"babylon"`
+	// ChainType and ChainID (if any) of the chain config identify a consumer chain
+	ChainType                string        `long:"chaintype" description:"the type of the consumer chain" choice:"babylon"`
 	NumPubRand               uint32        `long:"numPubRand" description:"The number of Schnorr public randomness for each commitment"`
 	NumPubRandMax            uint32        `long:"numpubrandmax" description:"The upper bound of the number of Schnorr public randomness for each commitment"`
 	MinRandHeightGap         uint32        `long:"minrandheightgap" description:"The minimum gap between the last committed rand height and the current Babylon block height"`
@@ -91,7 +91,7 @@ func DefaultConfigWithHome(homePath string) Config {
 	bbnCfg.KeyDirectory = homePath
 	pollerCfg := DefaultChainPollerConfig()
 	cfg := Config{
-		ChainName:                defaultChainName,
+		ChainType:                defaultChainType,
 		LogLevel:                 defaultLogLevel.String(),
 		DatabaseConfig:           DefaultDBConfigWithHomePath(homePath),
 		BabylonConfig:            &bbnCfg,

finality-provider/service/app.go

@@ -59,9 +59,9 @@ func NewFinalityProviderAppFromConfig(
 	db kvdb.Backend,
 	logger *zap.Logger,
 ) (*FinalityProviderApp, error) {
-	cc, err := clientcontroller.NewClientController(cfg.ChainName, cfg.BabylonConfig, &cfg.BTCNetParams, logger)
+	cc, err := clientcontroller.NewClientController(cfg.ChainType, cfg.BabylonConfig, &cfg.BTCNetParams, logger)
 	if err != nil {
-		return nil, fmt.Errorf("failed to create rpc client for the consumer chain %s: %v", cfg.ChainName, err)
+		return nil, fmt.Errorf("failed to create rpc client for the consumer chain %s: %v", cfg.ChainType, err)
 	}
 
 	// if the EOTSManagerAddress is empty, run a local EOTS manager;

itest/e2e_test.go

@@ -161,7 +161,7 @@ func TestFinalityProviderEditCmd(t *testing.T) {
 
 	cfg := tm.Fpa.GetConfig()
 	cfg.BabylonConfig.Key = testFpName
-	cc, err := clientcontroller.NewClientController(cfg.ChainName, cfg.BabylonConfig, &cfg.BTCNetParams, zap.NewNop())
+	cc, err := clientcontroller.NewClientController(cfg.ChainType, cfg.BabylonConfig, &cfg.BTCNetParams, zap.NewNop())
 	require.NoError(t, err)
 	tm.Fpa.UpdateClientController(cc)
 

itest/test_manager.go

@@ -204,7 +204,8 @@ func StartManagerWithFinalityProvider(t *testing.T) (*TestManager, *service.Fina
 	fpBbnKeyInfo, err := service.CreateChainKey(cfg.BabylonConfig.KeyDirectory, cfg.BabylonConfig.ChainID, cfg.BabylonConfig.Key, cfg.BabylonConfig.KeyringBackend, passphrase, hdPath, "")
 	require.NoError(t, err)
 
-	cc, err := clientcontroller.NewClientController(cfg.ChainName, cfg.BabylonConfig, &cfg.BTCNetParams, zap.NewNop())
+	cc, err := clientcontroller.NewClientController(cfg.ChainType, cfg.BabylonConfig, &cfg.BTCNetParams, zap.NewNop())
+
 	require.NoError(t, err)
 	app.UpdateClientController(cc)
 
@@ -253,7 +254,7 @@ func StartManagerWithFinalityProvider(t *testing.T) (*TestManager, *service.Fina
 
 	// goes back to old key in app
 	cfg.BabylonConfig.Key = oldKey
-	cc, err = clientcontroller.NewClientController(cfg.ChainName, cfg.BabylonConfig, &cfg.BTCNetParams, zap.NewNop())
+	cc, err = clientcontroller.NewClientController(cfg.ChainType, cfg.BabylonConfig, &cfg.BTCNetParams, zap.NewNop())
 	require.NoError(t, err)
 	app.UpdateClientController(cc)