chore: nlreturn lint (#251)

closes issue #235

.golangci.yml

@@ -37,7 +37,7 @@ linters:
     - misspell
     - nakedret
     - nilerr
-    #    - nlreturn # Style wise I personally like this one, todo(lazar): unlax at somepoint, good practice
+    - nlreturn
     - noctx
     - nonamedreturns
     - nosprintfhostport

CHANGELOG.md

@@ -37,6 +37,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## Unreleased
 
+### Improvements
+
+* [#251](https://github.com/babylonlabs-io/finality-provider/pull/251) chore: nlreturn lint
+
 ## v0.14.2
 
 ### Bug Fixes

clientcontroller/babylon.go

@@ -75,6 +75,7 @@ func NewBabylonController(
 func (bc *BabylonController) mustGetTxSigner() string {
 	signer := bc.GetKeyAddress()
 	prefix := bc.cfg.AccountPrefix
+
 	return sdk.MustBech32ifyAddressBytes(prefix, signer)
 }
 
@@ -288,6 +289,7 @@ func (bc *BabylonController) QueryFinalityProviderVotingPower(fpPk *btcec.Public
 		// therefore, it should be treated as the fp having 0 voting power
 		if strings.Contains(err.Error(), finalitytypes.ErrVotingPowerTableNotUpdated.Error()) {
 			bc.logger.Info("the voting power table not updated yet")
+
 			return 0, nil
 		}
 
@@ -338,6 +340,7 @@ func (bc *BabylonController) QueryBlocks(startHeight, endHeight uint64, limit ui
 	if count > uint64(limit) {
 		count = uint64(limit)
 	}
+
 	return bc.queryLatestBlocks(sdk.Uint64ToBigEndian(startHeight), count, finalitytypes.QueriedBlockStatus_ANY, false)
 }
 
@@ -367,6 +370,7 @@ func (bc *BabylonController) queryLatestBlocks(startKey []byte, count uint64, st
 
 func getContextWithCancel(timeout time.Duration) (context.Context, context.CancelFunc) {
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+
 	return ctx, cancel
 }
 
@@ -558,6 +562,7 @@ func (bc *BabylonController) EditFinalityProvider(fpPk *btcec.PublicKey,
 		if reqValue != "" {
 			return reqValue
 		}
+
 		return defaultValue
 	}
 

clientcontroller/retry_utils.go

@@ -42,6 +42,7 @@ func (e ExpectedError) Error() string {
 	if e.error == nil {
 		return "expected error"
 	}
+
 	return e.error.Error()
 }
 
@@ -52,6 +53,7 @@ func (e ExpectedError) Unwrap() error {
 // Is adds support for errors.Is usage on isExpected
 func (ExpectedError) Is(err error) bool {
 	_, isExpected := err.(ExpectedError)
+
 	return isExpected
 }
 

eotsmanager/client/rpcclient.go

@@ -89,6 +89,7 @@ func (c *EOTSManagerGRpcClient) SaveEOTSKeyName(pk *btcec.PublicKey, keyName str
 		EotsPk:  pk.SerializeUncompressed(),
 	}
 	_, err := c.client.SaveEOTSKeyName(context.Background(), req)
+
 	return err
 }
 

eotsmanager/cmd/eotsd/daemon/keys.go

@@ -82,6 +82,7 @@ func saveKeyOnPostRun(cmd *cobra.Command, commandName string) {
 	subCmd.PostRunE = func(cmd *cobra.Command, args []string) error {
 		keyName := args[0]
 		_, err := saveKeyNameMapping(cmd, keyName)
+
 		return err
 	}
 }
@@ -246,6 +247,7 @@ func printFromKey(cmd *cobra.Command, keyName string, eotsPk *types.BIP340PubKey
 	ctx := cmd.Context()
 	mnemonic := ctx.Value(mnemonicCtxKey).(string) //nolint: forcetypeassert
 	showMnemonic := ctx.Value(mnemonicShowCtxKey).(bool)
+
 	return printCreatePubKeyHex(cmd, k, eotsPk, showMnemonic, mnemonic, clientCtx.OutputFormat)
 }
 

eotsmanager/cmd/eotsd/daemon/keysadd.go

@@ -40,6 +40,7 @@ func runAddCmdPrepare(cmd *cobra.Command, args []string) error {
 	}
 
 	buf := bufio.NewReader(clientCtx.Input)
+
 	return runAddCmd(clientCtx, cmd, args, buf)
 }
 
@@ -297,6 +298,7 @@ func runAddCmd(ctx client.Context, cmd *cobra.Command, args []string, inBuf *buf
 	// used later for printing the values if needed
 	ctxWithValues := context.WithValue(cmd.Context(), mnemonicCtxKey, mnemonic)        //nolint: revive,staticcheck
 	cmd.SetContext(context.WithValue(ctxWithValues, mnemonicShowCtxKey, showMnemonic)) //nolint: revive,staticcheck
+
 	return nil
 }
 
@@ -308,6 +310,7 @@ func validateMultisigThreshold(k, nKeys int) error {
 		return fmt.Errorf(
 			"threshold k of n multisignature: %d < %d", nKeys, k)
 	}
+
 	return nil
 }
 
@@ -322,5 +325,6 @@ func readMnemonicFromFile(filePath string) (string, error) {
 	if err != nil {
 		return "", err
 	}
+
 	return string(bz), nil
 }

eotsmanager/config/config.go

@@ -131,5 +131,6 @@ func DefaultConfigWithHomePath(homePath string) *Config {
 	if err := cfg.Validate(); err != nil {
 		panic(err)
 	}
+
 	return cfg
 }

eotsmanager/localmanager.go

@@ -170,6 +170,7 @@ func LoadBIP340PubKeyFromKeyName(kr keyring.Keyring, keyName string) (*bbntypes.
 			return nil, err
 		}
 		eotsPk = bbntypes.NewBIP340PubKeyFromBTCPK(pk)
+
 		return eotsPk, nil
 	default:
 		return nil, fmt.Errorf("unsupported key type in keyring")
@@ -286,6 +287,7 @@ func (lm *LocalEOTSManager) SignSchnorrSig(fpPk []byte, msg []byte, passphrase s
 func (lm *LocalEOTSManager) signSchnorrSigFromPrivKey(privKey *btcec.PrivateKey, fpPk []byte, msg []byte) (*schnorr.Signature, error) {
 	// Update metrics
 	lm.metrics.IncrementEotsFpTotalSchnorrSignCounter(hex.EncodeToString(fpPk))
+
 	return schnorr.Sign(privKey, msg)
 }
 
@@ -306,6 +308,7 @@ func (lm *LocalEOTSManager) SignSchnorrSigFromKeyname(keyName, passphrase string
 	if err != nil {
 		return nil, nil, fmt.Errorf("failed to schnorr sign: %w", err)
 	}
+
 	return signature, eotsPk, nil
 }
 
@@ -320,6 +323,7 @@ func (lm *LocalEOTSManager) getRandomnessPair(fpPk []byte, chainID []byte, heigh
 		return nil, nil, err
 	}
 	privRand, pubRand := randgenerator.GenerateRandomness(record.PrivKey.Serialize(), chainID, height)
+
 	return privRand, pubRand, nil
 }
 
@@ -363,6 +367,7 @@ func (lm *LocalEOTSManager) eotsPrivKeyFromKeyName(keyName string) (*btcec.Priva
 	switch v := privKeyCached.(type) {
 	case *secp256k1.PrivKey:
 		privKey, _ = btcec.PrivKeyFromBytes(v.Key)
+
 		return privKey, nil
 	default:
 		return nil, fmt.Errorf("unsupported key type in keyring")
@@ -371,6 +376,7 @@ func (lm *LocalEOTSManager) eotsPrivKeyFromKeyName(keyName string) (*btcec.Priva
 
 func (lm *LocalEOTSManager) keyExists(name string) bool {
 	_, err := lm.kr.Key(name)
+
 	return err == nil
 }
 

eotsmanager/service/rpcserver.go

@@ -32,6 +32,7 @@ func newRPCServer(
 func (r *rpcServer) RegisterWithGrpcServer(grpcServer *grpc.Server) error {
 	// Register the main RPC server.
 	proto.RegisterEOTSManagerServer(grpcServer, r)
+
 	return nil
 }
 

eotsmanager/store/eotsstore.go

@@ -96,6 +96,7 @@ func (s *EOTSStore) GetEOTSKeyName(pk []byte) (string, error) {
 		}
 
 		keyName = string(keyNameBytes)
+
 		return nil
 	}, func() {})
 
@@ -190,6 +191,7 @@ func (s *EOTSStore) GetSignRecord(eotsPk, chainID []byte, height uint64) (*Signi
 		if errors.Is(err, ErrSignRecordNotFound) {
 			return nil, false, nil
 		}
+
 		return nil, false, err
 	}
 

finality-provider/cmd/fpd/daemon/commit_pr.go

@@ -32,6 +32,7 @@ WARNING: this can drain the finality provider's balance if the target height is
 		RunE:    runCommandCommitPubRand,
 	}
 	cmd.Flags().Uint64("start-height", math.MaxUint64, "The block height to start committing pubrand from (optional)")
+
 	return cmd
 }
 
@@ -99,5 +100,6 @@ func runCommandCommitPubRand(cmd *cobra.Command, args []string) error {
 	if startHeight == math.MaxUint64 {
 		return fp.TestCommitPubRand(targetHeight)
 	}
+
 	return fp.TestCommitPubRandWithStartHeight(startHeight, targetHeight)
 }

finality-provider/cmd/fpd/daemon/daemon_commands.go

@@ -40,6 +40,7 @@ func CommandGetDaemonInfo() *cobra.Command {
 		RunE:    runCommandGetDaemonInfo,
 	}
 	cmd.Flags().String(fpdDaemonAddressFlag, defaultFpdDaemonAddress, "The RPC server address of fpd")
+
 	return cmd
 }
 
@@ -65,6 +66,7 @@ func runCommandGetDaemonInfo(cmd *cobra.Command, _ []string) error {
 	}
 
 	printRespJSON(info)
+
 	return nil
 }
 
@@ -139,6 +141,7 @@ Where finality-provider.json contains:
 				return err
 			}
 		}
+
 		return nil
 	}
 
@@ -195,6 +198,7 @@ func runCommandCreateFP(ctx client.Context, cmd *cobra.Command, _ []string) erro
 	}
 
 	printRespJSON(res)
+
 	return nil
 }
 
@@ -265,6 +269,7 @@ func getDescriptionFromFlags(f *pflag.FlagSet) (stakingtypes.Description, error)
 	}
 
 	description := stakingtypes.NewDescription(monikerStr, identityStr, websiteStr, securityContactStr, detailsStr)
+
 	return description.EnsureLength()
 }
 
@@ -279,6 +284,7 @@ func CommandLsFP() *cobra.Command {
 		RunE:    runCommandLsFP,
 	}
 	cmd.Flags().String(fpdDaemonAddressFlag, defaultFpdDaemonAddress, "The RPC server address of fpd")
+
 	return cmd
 }
 
@@ -318,6 +324,7 @@ func CommandInfoFP() *cobra.Command {
 		RunE:    runCommandInfoFP,
 	}
 	cmd.Flags().String(fpdDaemonAddressFlag, defaultFpdDaemonAddress, "The RPC server address of fpd")
+
 	return cmd
 }
 
@@ -552,6 +559,7 @@ func printRespJSON(resp interface{}) {
 	jsonBytes, err := json.MarshalIndent(resp, "", "    ")
 	if err != nil {
 		fmt.Println("unable to decode response: ", err)
+
 		return
 	}
 
@@ -579,6 +587,7 @@ func loadKeyName(homeDir string, cmd *cobra.Command) (string, error) {
 	if keyName == "" {
 		return "", fmt.Errorf("the key in config is empty")
 	}
+
 	return keyName, nil
 }
 

finality-provider/cmd/fpd/daemon/init.go

@@ -24,6 +24,7 @@ func CommandInit() *cobra.Command {
 		RunE:    fpcmd.RunEWithClientCtx(runInitCmd),
 	}
 	cmd.Flags().Bool(forceFlag, false, "Override existing configuration")
+
 	return cmd
 }
 

finality-provider/cmd/fpd/daemon/keys.go

@@ -17,5 +17,6 @@ func CommandKeys() *cobra.Command {
 	}
 
 	keyAddCmd.Long += "\nIf this key is needed to run as the default for the finality-provider daemon, remind to update the fpd.conf"
+
 	return keysCmd
 }

finality-provider/cmd/fpd/daemon/start.go

@@ -32,6 +32,7 @@ func CommandStart() *cobra.Command {
 	cmd.Flags().String(fpEotsPkFlag, "", "The EOTS public key of the finality-provider to start")
 	cmd.Flags().String(passphraseFlag, "", "The pass phrase used to decrypt the private key")
 	cmd.Flags().String(rpcListenerFlag, "", "The address that the RPC server listens to")
+
 	return cmd
 }
 
@@ -97,6 +98,7 @@ func runStartCmd(ctx client.Context, cmd *cobra.Command, _ []string) error {
 	}
 
 	fpServer := service.NewFinalityProviderServer(cfg, logger, fpApp, dbBackend, shutdownInterceptor)
+
 	return fpServer.RunUntilShutdown()
 }
 

finality-provider/proto/finality_providers.go

@@ -14,11 +14,13 @@ func (sfp *FinalityProvider) MustGetBTCPK() *btcec.PublicKey {
 	if err != nil {
 		panic(fmt.Errorf("failed to parse BTC PK: %w", err))
 	}
+
 	return btcPubKey
 }
 
 func (sfp *FinalityProvider) MustGetBIP340BTCPK() *bbn.BIP340PubKey {
 	btcPK := sfp.MustGetBTCPK()
+
 	return bbn.NewBIP340PubKeyFromBTCPK(btcPK)
 }
 
@@ -27,6 +29,7 @@ func NewFinalityProviderInfo(sfp *FinalityProvider) (*FinalityProviderInfo, erro
 	if err := des.Unmarshal(sfp.Description); err != nil {
 		return nil, err
 	}
+
 	return &FinalityProviderInfo{
 		FpAddr:   sfp.FpAddr,
 		BtcPkHex: sfp.MustGetBIP340BTCPK().MarshalHex(),

finality-provider/service/app.go

@@ -69,6 +69,7 @@ func NewFinalityProviderAppFromConfig(
 	}
 
 	logger.Info("successfully connected to a remote EOTS manager", zap.String("address", cfg.EOTSManagerAddress))
+
 	return NewFinalityProviderApp(cfg, cc, em, db, logger)
 }
 
@@ -223,6 +224,7 @@ func (app *FinalityProviderApp) SyncAllFinalityProvidersStatus() error {
 					zap.Uint64("power", power),
 				)
 			}
+
 			continue
 		}
 		slashed, jailed, err := app.cc.QueryFinalityProviderSlashedOrJailed(fp.BtcPk)
@@ -299,6 +301,7 @@ func (app *FinalityProviderApp) Stop() error {
 
 			if err := app.fpIns.Stop(); err != nil {
 				stopErr = fmt.Errorf("failed to close the fp instance: %w", err)
+
 				return
 			}
 
@@ -308,11 +311,13 @@ func (app *FinalityProviderApp) Stop() error {
 		app.logger.Debug("Stopping EOTS manager")
 		if err := app.eotsManager.Close(); err != nil {
 			stopErr = fmt.Errorf("failed to close the EOTS manager: %w", err)
+
 			return
 		}
 
 		app.logger.Debug("FinalityProviderApp successfully stopped")
 	})
+
 	return stopErr
 }
 

finality-provider/service/benchmark_helper.go

@@ -39,6 +39,7 @@ func (fp *FinalityProviderInstance) HelperCommitPubRand(tipHeight uint64) (*type
 			zap.Uint64("block_height", tipHeight),
 			zap.Uint64("last_committed_height", lastCommittedHeight),
 		)
+
 		return nil, nil, nil
 	}