chore: unlax linter a bit more (#143)

`nlreturn` gives a more consistent code style by requiring a new line
above return/continue/break statements

.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

@@ -45,6 +45,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 * [#136](https://github.com/babylonlabs-io/vigilante/pull/136) rate limit activations
 * [#141](https://github.com/babylonlabs-io/vigilante/pull/141) decrement tracked delegations in atomic slasher
+* [#143](https://github.com/babylonlabs-io/vigilante/pull/143) adds nlreturn linter rule
 
 ## v0.18.0
 

btcclient/client_wallet.go

@@ -78,6 +78,7 @@ func (c *Client) GetNetParams() *chaincfg.Params {
 	if err != nil {
 		panic(fmt.Errorf("failed to get BTC network params: %w", err))
 	}
+
 	return net
 }
 
@@ -123,6 +124,7 @@ func (c *Client) GetHighUTXOAndSum() (*btcjson.ListUnspentResult, float64, error
 		}
 		sum += utxo.Amount
 	}
+
 	return &highUTXO, sum, nil
 }
 

btcclient/query.go

@@ -43,6 +43,7 @@ func (c *Client) GetBlockByHash(blockHash *chainhash.Hash) (*types.IndexedBlock,
 	if height < 0 || height > int64(math.MaxUint32) {
 		panic(fmt.Errorf("height (%d) is out of uint32 range", height)) // software bug, panic
 	}
+
 	return types.NewIndexedBlock(uint32(height), &mBlock.Header, btcTxs), mBlock, nil
 }
 
@@ -74,6 +75,7 @@ func (c *Client) getBestBlockHashWithRetry() (*chainhash.Hash, error) {
 		if err != nil {
 			return err
 		}
+
 		return nil
 	},
 		retry.Delay(c.retrySleepTime),
@@ -82,6 +84,7 @@ func (c *Client) getBestBlockHashWithRetry() (*chainhash.Hash, error) {
 	); err != nil {
 		c.logger.Debug(
 			"failed to query the best block hash", zap.Error(err))
+
 		return nil, err
 	}
 
@@ -99,6 +102,7 @@ func (c *Client) getBlockHashWithRetry(height uint32) (*chainhash.Hash, error) {
 		if err != nil {
 			return err
 		}
+
 		return nil
 	},
 		retry.Delay(c.retrySleepTime),
@@ -107,6 +111,7 @@ func (c *Client) getBlockHashWithRetry(height uint32) (*chainhash.Hash, error) {
 	); err != nil {
 		c.logger.Debug(
 			"failed to query the block hash", zap.Uint32("height", height), zap.Error(err))
+
 		return nil, err
 	}
 
@@ -124,6 +129,7 @@ func (c *Client) getBlockWithRetry(hash *chainhash.Hash) (*wire.MsgBlock, error)
 		if err != nil {
 			return err
 		}
+
 		return nil
 	},
 		retry.Delay(c.retrySleepTime),
@@ -132,6 +138,7 @@ func (c *Client) getBlockWithRetry(hash *chainhash.Hash) (*wire.MsgBlock, error)
 	); err != nil {
 		c.logger.Debug(
 			"failed to query the block", zap.String("hash", hash.String()), zap.Error(err))
+
 		return nil, err
 	}
 
@@ -149,6 +156,7 @@ func (c *Client) getBlockVerboseWithRetry(hash *chainhash.Hash) (*btcjson.GetBlo
 		if err != nil {
 			return err
 		}
+
 		return nil
 	},
 		retry.Delay(c.retrySleepTime),
@@ -157,6 +165,7 @@ func (c *Client) getBlockVerboseWithRetry(hash *chainhash.Hash) (*btcjson.GetBlo
 	); err != nil {
 		c.logger.Debug(
 			"failed to query the block verbose", zap.String("hash", hash.String()), zap.Error(err))
+
 		return nil, err
 	}
 
@@ -232,13 +241,15 @@ func (c *Client) getBlockCountWithRetry() (int64, error) {
 		if err != nil {
 			return err
 		}
+
 		return nil
 	},
 		retry.Delay(c.retrySleepTime),
 		retry.MaxDelay(c.maxRetrySleepTime),
 		retry.Attempts(c.maxRetryTimes),
 	); err != nil {
 		c.logger.Debug("failed to query get block count", zap.Error(err))
+
 		return 0, err
 	}
 

btcstaking-tracker/atomicslasher/atomic_slasher.go

@@ -56,6 +56,7 @@ func New(
 ) *AtomicSlasher {
 	logger := parentLogger.With(zap.String("module", "atomic_slasher"))
 	bbnAdapter := NewBabylonAdapter(logger, cfg, retrySleepTime, maxRetrySleepTime, maxRetryTimes, bbnClient)
+
 	return &AtomicSlasher{
 		quit:              make(chan struct{}),
 		cfg:               cfg,
@@ -87,6 +88,7 @@ func (as *AtomicSlasher) Start() error {
 
 		as.logger.Info("atomic slasher started")
 	})
+
 	return startErr
 }
 
@@ -99,6 +101,7 @@ func (as *AtomicSlasher) Stop() error {
 		as.wg.Wait()
 		as.logger.Info("stopping atomic slasher")
 	})
+
 	return stopErr
 }
 

btcstaking-tracker/atomicslasher/babylon_adapter.go

@@ -51,6 +51,7 @@ func (ba *BabylonAdapter) BTCStakingParams(ctx context.Context, version uint32)
 				return err
 			}
 			bsParams = &resp.Params
+
 			return nil
 		},
 		retry.Context(ctx),
@@ -71,6 +72,7 @@ func (ba *BabylonAdapter) BTCDelegation(ctx context.Context, stakingTxHashHex st
 				return err
 			}
 			resp = resp2
+
 			return nil
 		},
 		retry.Context(ctx),
@@ -132,5 +134,6 @@ func (ba *BabylonAdapter) ReportSelectiveSlashing(
 
 	// TODO: what are unrecoverable/expected errors?
 	_, err := ba.bbnClient.ReliablySendMsg(ctx, msg, []*errors.Error{}, []*errors.Error{})
+
 	return err
 }

btcstaking-tracker/atomicslasher/routines.go

@@ -27,6 +27,7 @@ func (as *AtomicSlasher) btcDelegationTracker() {
 				}
 				as.btcDelIndex.Add(trackedDel)
 				as.metrics.TrackedBTCDelegationsGauge.Inc()
+
 				return nil
 			})
 			if err != nil {
@@ -46,6 +47,7 @@ func (as *AtomicSlasher) slashingTxTracker() {
 	blockNotifier, err := as.btcNotifier.RegisterBlockEpochNtfn(nil)
 	if err != nil {
 		as.logger.Error("failed to register block notifier", zap.Error(err))
+
 		return
 	}
 	defer blockNotifier.Cancel()
@@ -73,6 +75,7 @@ func (as *AtomicSlasher) slashingTxTracker() {
 					zap.String("block_hash", blockEpoch.Hash.String()),
 					zap.Error(err),
 				)
+
 				continue
 			}
 			// filter out slashing tx / unbonding slashing tx, and
@@ -115,6 +118,7 @@ func (as *AtomicSlasher) selectiveSlashingReporter() {
 					zap.String("staking_tx_hash", stakingTxHashStr),
 					zap.Error(err),
 				)
+
 				continue
 			}
 			// get parameter at the version of this BTC delegation
@@ -128,6 +132,7 @@ func (as *AtomicSlasher) selectiveSlashingReporter() {
 					zap.Uint32("version", paramsVersion),
 					zap.Error(err),
 				)
+
 				continue
 			}
 			// get covenant Schnorr signature in tx
@@ -143,6 +148,7 @@ func (as *AtomicSlasher) selectiveSlashingReporter() {
 					zap.String("staking_tx_hash", stakingTxHashStr),
 					zap.Error(err),
 				)
+
 				continue
 			}
 
@@ -156,6 +162,7 @@ func (as *AtomicSlasher) selectiveSlashingReporter() {
 					zap.String("fp_pk", fpPK.MarshalHex()),
 					zap.Error(err),
 				)
+
 				continue
 			}
 			cancel()
@@ -166,6 +173,7 @@ func (as *AtomicSlasher) selectiveSlashingReporter() {
 					zap.String("fp_pk", fpPK.MarshalHex()),
 					zap.Error(err),
 				)
+
 				continue
 			}
 
@@ -186,6 +194,7 @@ func (as *AtomicSlasher) selectiveSlashingReporter() {
 					zap.String("staking_tx_hash", stakingTxHashStr),
 					zap.Error(err),
 				)
+
 				continue
 			}
 

btcstaking-tracker/atomicslasher/types.go

@@ -190,6 +190,7 @@ func parseSlashingTxWitness(
 		if len(fpWitnessStack[i]) != 0 {
 			fpIdx = i
 			fpPK = &fpPKs[i]
+
 			break
 		}
 	}

btcstaking-tracker/btcslasher/bootstrapping.go

@@ -49,6 +49,7 @@ func (bs *BTCSlasher) Bootstrap(startHeight uint64) error {
 			if err != nil {
 				bs.logger.Errorf("failed to extract BTC SK of the slashed finality provider %s: %v", fpBTCPKHex, err)
 				accumulatedErrs = multierror.Append(accumulatedErrs, err)
+
 				continue
 			}
 
@@ -57,6 +58,7 @@ func (bs *BTCSlasher) Bootstrap(startHeight uint64) error {
 			if err := bs.SlashFinalityProvider(fpBTCSK); err != nil {
 				bs.logger.Errorf("failed to slash finality provider %s: %v", fpBTCPKHex, err)
 				accumulatedErrs = multierror.Append(accumulatedErrs, err)
+
 				continue
 			}
 		}

btcstaking-tracker/btcslasher/btc_utils.go

@@ -12,6 +12,7 @@ import (
 // TODO: ensure k-deep?
 func (bs *BTCSlasher) isTxSubmittedToBitcoin(txHash *chainhash.Hash) bool {
 	_, err := bs.BTCClient.GetRawTransaction(txHash)
+
 	return err == nil
 }
 
@@ -43,6 +44,7 @@ func (bs *BTCSlasher) isTaprootOutputSpendable(txBytes []byte, outIdx uint32) (b
 			"tx %s output is already unspendable",
 			stakingMsgTxHash.String(),
 		)
+
 		return false, nil
 	}
 	// spendable

btcstaking-tracker/btcslasher/slasher.go

@@ -126,6 +126,7 @@ func (bs *BTCSlasher) Start() error {
 		// load module parameters
 		if err := bs.LoadParams(); err != nil {
 			startErr = err
+
 			return
 		}
 
@@ -162,13 +163,15 @@ func (bs *BTCSlasher) slashingEnforcer() {
 		select {
 		case <-bs.quit:
 			bs.logger.Debug("handle delegations loop quit")
+
 			return
 		case fpBTCSK, ok := <-bs.slashedFPSKChan:
 			if !ok {
 				// slasher receives the channel from outside, so its lifecycle
 				// is out of slasher's control. So we need to ensure the channel
 				// is not closed yet
 				bs.logger.Debug("slashedFKSK channel is already closed, terminating the slashing enforcer")
+
 				return
 			}
 			// slash all the BTC delegations of this finality provider
@@ -213,6 +216,7 @@ func (bs *BTCSlasher) equivocationTracker() {
 		select {
 		case <-bs.quit:
 			bs.logger.Debug("handle delegations loop quit")
+
 			return
 		case resultEvent := <-bs.finalitySigChan:
 			evidence := filterEvidence(&resultEvent)
@@ -230,6 +234,7 @@ func (bs *BTCSlasher) equivocationTracker() {
 			fpBTCSK, err := evidence.ExtractBTCSK()
 			if err != nil {
 				bs.logger.Errorf("failed to extract BTC SK of the slashed finality provider %s: %v", fpBTCPKHex, err)
+
 				continue
 			}
 
@@ -274,6 +279,7 @@ func (bs *BTCSlasher) SlashFinalityProvider(extractedFpBTCSK *btcec.PrivateKey)
 			// Acquire the semaphore before interacting with the BTC node
 			if err := sem.Acquire(ctx, 1); err != nil {
 				bs.logger.Errorf("failed to acquire semaphore: %v", err)
+
 				return
 			}
 			defer sem.Release(1)
@@ -309,5 +315,6 @@ func (bs *BTCSlasher) Stop() error {
 
 		bs.logger.Info("stopped slasher")
 	})
+
 	return stopErr
 }

btcstaking-tracker/btcslasher/slasher_test.go

@@ -315,6 +315,7 @@ func newBTCDelegatorDelegationsResponse(delegations []*bstypes.BTCDelegatorDeleg
 			delListResp = append(delListResp, bstypes.NewBTCDelegationResponse(del, status))
 		}
 	}
+
 	return &bstypes.BTCDelegatorDelegationsResponse{
 		Dels: delListResp,
 	}

btcstaking-tracker/btcslasher/slasher_utils.go

@@ -292,6 +292,7 @@ func findFPIdxInWitness(fpBTCPK *bbn.BIP340PubKey, fpBtcPkList []bbn.BIP340PubKe
 			return i, nil
 		}
 	}
+
 	return 0, fmt.Errorf("the given finality provider's PK is not found in the BTC delegation")
 }
 
@@ -461,9 +462,11 @@ func filterEvidence(resultEvent *coretypes.ResultEvent) *ftypes.Evidence {
 				if err := jsonpb.UnmarshalString(eventData[0], &evidence); err != nil {
 					continue
 				}
+
 				return &evidence
 			}
 		}
 	}
+
 	return nil
 }

btcstaking-tracker/stakingeventwatcher/expected_babylon_client.go

@@ -208,6 +208,7 @@ func (bca *BabylonClientAdapter) QueryHeaderDepth(headerHash *chainhash.Hash) (u
 			return err
 		}
 		response = depthResponse
+
 		return nil
 	},
 		retry.Attempts(5),
@@ -217,6 +218,7 @@ func (bca *BabylonClientAdapter) QueryHeaderDepth(headerHash *chainhash.Hash) (u
 		if strings.Contains(err.Error(), btclctypes.ErrHeaderDoesNotExist.Error()) {
 			return 0, fmt.Errorf("%s: %w", err.Error(), ErrHeaderNotKnownToBabylon)
 		}
+
 		return 0, err
 	}