chore: add golangci lint rules (#134)

* add lint rules

* ✍️ changelog

* fix lint

* fix lint

* fix lint

Author: Lazar955

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     uses: babylonlabs-io/.github/.github/workflows/[email protected]
     with:
       go-version: '1.23'
-      go-lint-version: 'v1.60.2'
+      go-lint-version: 'v1.64.8'
       run-unit-tests: true
       run-integration-tests: true
       run-lint: true

.github/workflows/publish.yml

@@ -13,7 +13,7 @@ jobs:
     uses: babylonlabs-io/.github/.github/workflows/[email protected]
     with:
       go-version: '1.23'
-      go-lint-version: 'v1.60.2'
+      go-lint-version: 'v1.64.8'
       run-unit-tests: true
       run-integration-tests: true
       run-lint: true

.golangci.yml

@@ -0,0 +1,78 @@
+run:
+  timeout: 5m
+
+linters:
+  disable-all: true
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - contextcheck
+    - decorder
+    - dogsled
+    - durationcheck
+    - errcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - forbidigo
+    - forcetypeassert
+    - goconst
+    - gocritic
+    - gocyclo
+    - goheader
+    - gomodguard
+    - goprintffuncname
+    - gosimple
+    - govet
+    - grouper
+    - importas
+    - ineffassign
+    - loggercheck
+    - maintidx
+    - makezero
+    - misspell
+    - nakedret
+    - nilerr
+    - nlreturn
+    - noctx
+    - nonamedreturns
+    - nosprintfhostport
+#    - paralleltest
+    - reassign
+    - revive
+    - rowserrcheck
+    - sqlclosecheck
+    - staticcheck
+    - stylecheck
+    - usetesting
+    - testableexamples
+    - tparallel
+    - typecheck
+    - unconvert
+    - unparam
+    - usestdlibvars
+    - unused
+    - wastedassign
+    - whitespace
+#    - wrapcheck # we really should be using this, lax for now todo(lazar): unlax at somepoint, good practice
+
+issues:
+  max-same-issues: 0
+  # Default: https://golangci-lint.run/usage/false-positives/#default-exclusions
+  exclude-dirs:
+    - e2etest
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test\.go
+      linters:
+        - gocyclo
+        - errcheck
+        - dupl
+        - gosec
+    - path-except: _test\.go
+      linters:
+        - forbidigo

CHANGELOG.md

@@ -37,6 +37,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## Unreleased
 
+### Improvements
+
+* [#134](https://github.com/babylonlabs-io/covenant-emulator/pull/134) chore: add golangci lint rules
+
 ## v0.16.0-rc.1
 
 ### Improvements

clientcontroller/babylon.go

@@ -44,7 +44,6 @@ func NewBabylonController(
 	btcParams *chaincfg.Params,
 	logger *zap.Logger,
 ) (*BabylonController, error) {
-
 	bbnConfig := config.BBNConfigToBabylonConfig(cfg)
 
 	if err := bbnConfig.Validate(); err != nil {
@@ -70,6 +69,7 @@ func NewBabylonController(
 func (bc *BabylonController) mustGetTxSigner() string {
 	signer := bc.GetKeyAddress()
 	prefix := bc.cfg.AccountPrefix
+
 	return sdk.MustBech32ifyAddressBytes(prefix, signer)
 }
 
@@ -98,13 +98,13 @@ func (bc *BabylonController) QueryStakingParamsByVersion(version uint32) (*types
 	// query btc checkpoint params
 	ckptParamRes, err := bc.bbnClient.QueryClient.BTCCheckpointParams()
 	if err != nil {
-		return nil, fmt.Errorf("failed to query params of the btccheckpoint module: %v", err)
+		return nil, fmt.Errorf("failed to query params of the btccheckpoint module: %w", err)
 	}
 
 	// query btc staking params
 	stakingParamRes, err := bc.bbnClient.QueryClient.BTCStakingParamsByVersion(version)
 	if err != nil {
-		return nil, fmt.Errorf("failed to query staking params with version %d: %v", version, err)
+		return nil, fmt.Errorf("failed to query staking params with version %d: %w", version, err)
 	}
 
 	covenantPks := make([]*btcec.PublicKey, 0, len(stakingParamRes.Params.CovenantPks))
@@ -210,8 +210,9 @@ func (bc *BabylonController) QueryVerifiedDelegations(limit uint64) ([]*types.De
 func (bc *BabylonController) QueryBTCDelegation(stakingTxHashHex string) (*types.Delegation, error) {
 	resp, err := bc.bbnClient.QueryClient.BTCDelegation(stakingTxHashHex)
 	if err != nil {
-		return nil, fmt.Errorf("failed to query BTC delegation %s: %v", stakingTxHashHex, err)
+		return nil, fmt.Errorf("failed to query BTC delegation %s: %w", stakingTxHashHex, err)
 	}
+
 	return DelegationRespToDelegation(resp.BtcDelegation)
 }
 
@@ -230,7 +231,7 @@ func (bc *BabylonController) queryDelegationsWithStatus(status btcstakingtypes.B
 	for indexDels < delsLimit {
 		res, err := bc.bbnClient.QueryClient.BTCDelegations(status, pagination)
 		if err != nil {
-			return nil, fmt.Errorf("failed to query BTC delegations: %v", err)
+			return nil, fmt.Errorf("failed to query BTC delegations: %w", err)
 		}
 
 		for _, delResp := range res.BtcDelegations {
@@ -271,6 +272,7 @@ func (bc *BabylonController) queryDelegationsWithStatus(status btcstakingtypes.B
 
 func getContextWithCancel(timeout time.Duration) (context.Context, context.CancelFunc) {
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+
 	return ctx, cancel
 }
 
@@ -557,7 +559,7 @@ func (bc *BabylonController) QueryFinalityProviders() ([]*btcstakingtypes.Finali
 		}
 		res, err := queryClient.FinalityProviders(ctx, queryRequest)
 		if err != nil {
-			return nil, fmt.Errorf("failed to query finality providers: %v", err)
+			return nil, fmt.Errorf("failed to query finality providers: %w", err)
 		}
 		fps = append(fps, res.FinalityProviders...)
 		if res.Pagination == nil || res.Pagination.NextKey == nil {
@@ -582,7 +584,7 @@ func (bc *BabylonController) QueryBtcLightClientTip() (*btclctypes.BTCHeaderInfo
 	queryRequest := &btclctypes.QueryTipRequest{}
 	res, err := queryClient.Tip(ctx, queryRequest)
 	if err != nil {
-		return nil, fmt.Errorf("failed to query BTC tip: %v", err)
+		return nil, fmt.Errorf("failed to query BTC tip: %w", err)
 	}
 
 	return res.Header, nil

cmd/covd/flags.go

@@ -8,7 +8,7 @@ const (
 	keyNameFlag        = "key-name"
 	passphraseFlag     = "passphrase"
 	hdPathFlag         = "hd-path"
-	chainIdFlag        = "chain-id"
+	chainIDFlag        = "chain-id"
 	keyringBackendFlag = "keyring-backend"
 
 	defaultChainID        = "chain-test"

cmd/covd/init.go

@@ -54,5 +54,5 @@ func initHome(c *cli.Context) error {
 	defaultConfig := covcfg.DefaultConfigWithHomePath(homePath)
 	fileParser := flags.NewParser(&defaultConfig, flags.Default)
 
-	return flags.NewIniParser(fileParser).WriteFile(covcfg.ConfigFile(homePath), flags.IniIncludeComments|flags.IniIncludeDefaults)
+	return flags.NewIniParser(fileParser).WriteFile(covcfg.File(homePath), flags.IniIncludeComments|flags.IniIncludeDefaults)
 }

cmd/covd/key.go

@@ -26,7 +26,7 @@ var createKeyCommand = cli.Command{
 	Usage:     "Create a Covenant account in the keyring.",
 	Flags: []cli.Flag{
 		cli.StringFlag{
-			Name:  chainIdFlag,
+			Name:  chainIDFlag,
 			Usage: "The chainID of the consumer chain",
 			Value: defaultChainID,
 		},
@@ -61,7 +61,7 @@ var createKeyCommand = cli.Command{
 
 func createKey(ctx *cli.Context) error {
 	homePath := ctx.String(homeFlag)
-	chainID := ctx.String(chainIdFlag)
+	chainID := ctx.String(chainIDFlag)
 	keyName := ctx.String(keyNameFlag)
 	backend := ctx.String(keyringBackendFlag)
 	passphrase := ctx.String(passphraseFlag)
@@ -71,7 +71,7 @@ func createKey(ctx *cli.Context) error {
 	// check the config file exists
 	cfg, err := covcfg.LoadConfig(homePath)
 	if err != nil {
-		return fmt.Errorf("failed to load the config from %s: %w", covcfg.ConfigFile(homePath), err)
+		return fmt.Errorf("failed to load the config from %s: %w", covcfg.File(homePath), err)
 	}
 
 	keyPair, err := keyring.CreateCovenantKey(
@@ -100,7 +100,7 @@ func createKey(ctx *cli.Context) error {
 	cfg.BabylonConfig.KeyringBackend = keyBackend
 	fileParser := flags.NewParser(cfg, flags.Default)
 
-	return flags.NewIniParser(fileParser).WriteFile(covcfg.ConfigFile(homePath), flags.IniIncludeComments|flags.IniIncludeDefaults)
+	return flags.NewIniParser(fileParser).WriteFile(covcfg.File(homePath), flags.IniIncludeComments|flags.IniIncludeDefaults)
 }
 
 var showKeyCommand = cli.Command{
@@ -109,7 +109,7 @@ var showKeyCommand = cli.Command{
 	Usage:     "Show a Covenant account in the keyring.",
 	Flags: []cli.Flag{
 		cli.StringFlag{
-			Name:  chainIdFlag,
+			Name:  chainIDFlag,
 			Usage: "The chainID of the consumer chain",
 			Value: defaultChainID,
 		},
@@ -139,7 +139,7 @@ var showKeyCommand = cli.Command{
 
 func showKey(ctx *cli.Context) error {
 	homePath := ctx.String(homeFlag)
-	chainID := ctx.String(chainIdFlag)
+	chainID := ctx.String(chainIDFlag)
 	keyName := ctx.String(keyNameFlag)
 	backend := ctx.String(keyringBackendFlag)
 	passphrase := ctx.String(passphraseFlag)
@@ -178,13 +178,15 @@ func showKey(ctx *cli.Context) error {
 			BabylonAddr: babylonAddr.String(),
 		},
 	)
+
 	return nil
 }
 
 func printRespJSON(resp interface{}) {
 	jsonBytes, err := json.MarshalIndent(resp, "", "    ")
 	if err != nil {
 		fmt.Println("unable to decode response: ", err)
+
 		return
 	}
 

cmd/covd/start.go

@@ -58,10 +58,7 @@ func start(ctx *cli.Context) error {
 		return fmt.Errorf("failed to create rpc client for the consumer chain: %w", err)
 	}
 
-	signer, err := newRemoteSignerFromConfig(cfg)
-	if err != nil {
-		return fmt.Errorf("failed to create remote signer from config: %w", err)
-	}
+	signer := newRemoteSignerFromConfig(cfg)
 
 	// Perform health check on the remote signer
 	logger.Info("Performing health check on remote signer...")
@@ -70,7 +67,7 @@ func start(ctx *cli.Context) error {
 	}
 	logger.Info("Remote signer health check passed")
 
-	ce, err := covenant.NewCovenantEmulator(cfg, bbnClient, logger, signer)
+	ce, err := covenant.NewEmulator(cfg, bbnClient, logger, signer)
 	if err != nil {
 		return fmt.Errorf("failed to start the covenant emulator: %w", err)
 	}
@@ -82,13 +79,10 @@ func start(ctx *cli.Context) error {
 	}
 
 	srv := covsrv.NewCovenantServer(logger, ce, shutdownInterceptor)
-	if err != nil {
-		return fmt.Errorf("failed to create covenant server: %w", err)
-	}
 
 	return srv.RunUntilShutdown()
 }
 
-func newRemoteSignerFromConfig(cfg *covcfg.Config) (covenant.Signer, error) {
-	return remotesigner.NewRemoteSigner(cfg.RemoteSigner), nil
+func newRemoteSignerFromConfig(cfg *covcfg.Config) covenant.Signer {
+	return remotesigner.NewRemoteSigner(cfg.RemoteSigner)
 }

config/config.go

@@ -61,7 +61,7 @@ type Config struct {
 func LoadConfig(homePath string) (*Config, error) {
 	// The home directory is required to have a configuration file with a specific name
 	// under it.
-	cfgFile := ConfigFile(homePath)
+	cfgFile := File(homePath)
 	if !util.FileExists(cfgFile) {
 		return nil, fmt.Errorf("specified config file does "+
 			"not exist in %s", cfgFile)
@@ -113,7 +113,7 @@ func (cfg *Config) Validate() error {
 	return nil
 }
 
-func ConfigFile(homePath string) string {
+func File(homePath string) string {
 	return filepath.Join(homePath, defaultConfigFileName)
 }