Add golangci-lint to CI

.github/workflows/go.yml

@@ -32,5 +32,10 @@ jobs:
     - name: Build
       run: make build
 
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v2
+      with:
+        version: v1.29
+
     - name: Test
       run: go test -v ./...

Makefile

@@ -19,6 +19,9 @@ build: clean
 
 buidl: build
 
+lint:
+	golangci-lint run ./...
+
 init:
 	./build/hubble init
 

aggregator/aggregator.go

@@ -59,7 +59,10 @@ func NewAggregator() *Aggregator {
 
 // OnStart starts new block subscription
 func (a *Aggregator) OnStart() error {
-	a.BaseService.OnStart() // Always call the overridden method.
+	err := a.BaseService.OnStart() // Always call the overridden method.
+	if err != nil {
+		return err
+	}
 
 	ctx, cancelAggregating := context.WithCancel(context.Background())
 	a.cancelAggregating = cancelAggregating

cmd/flags.go

@@ -1,15 +1,11 @@
 package main
 
 const (
-	FlagFromID        = "from"
-	FlagToID          = "to"
-	FlagPrivKey       = "privkey"
-	FlagPubKey        = "pubkey"
-	FlagAmount        = "amount"
-	FlagFee           = "fee"
-	FlagSignature     = "sig"
-	FlagNonce         = "nonce"
-	FlagTokenID       = "token"
-	FlagDatabaseName  = "dbname"
-	FlagNumberOfUsers = "count"
+	FlagFromID       = "from"
+	FlagToID         = "to"
+	FlagPrivKey      = "privkey"
+	FlagPubKey       = "pubkey"
+	FlagAmount       = "amount"
+	FlagFee          = "fee"
+	FlagDatabaseName = "dbname"
 )

cmd/main.go

@@ -41,10 +41,15 @@ func main() {
 	)
 
 	// bind with-heimdall-config config with root cmd
-	viper.BindPFlag(
+	err := viper.BindPFlag(
 		WithConfigPathFlag,
 		rootCmd.Flags().Lookup(WithConfigPathFlag),
 	)
+	if err != nil {
+		fmt.Println("BindPFlag Error", err)
+		return
+	}
+
 	rootCmd.AddCommand(initCmd())
 	rootCmd.AddCommand(startCmd())
 	rootCmd.AddCommand(resetCmd())
@@ -56,7 +61,7 @@ func main() {
 	rootCmd.AddCommand(migrationCmd)
 
 	executor := Executor{rootCmd, os.Exit}
-	if err := executor.Command.Execute(); err != nil {
+	if err = executor.Command.Execute(); err != nil {
 		fmt.Println("Error while executing command", err)
 		return
 	}

cmd/start.go

@@ -59,16 +59,21 @@ func startCmd() *cobra.Command {
 			go func() {
 				// sig is a ^C, handle it
 				for range catchSignal {
-					aggregator.Stop()
-					syncer.Stop()
+					if err := aggregator.Stop(); err != nil {
+						log.Fatalln("Unable to stop aggregator", "error", err)
+					}
+					if err := syncer.Stop(); err != nil {
+						log.Fatalln("Unable to stop syncer", "error", err)
+					}
+
 					core.DBInstance.Close()
 					// exit
 					os.Exit(1)
 				}
 			}()
 
 			if err := syncer.Start(); err != nil {
-				log.Fatalln("Unable to start syncer", "error")
+				log.Fatalln("Unable to start syncer", "error", err)
 			}
 
 			if err := aggregator.Start(); err != nil {
@@ -143,10 +148,14 @@ func loadGenesisData(genesis config.Genesis) {
 
 	// load params
 	newParams := core.Params{StakeAmount: genesis.StakeAmount, MaxDepth: genesis.MaxTreeDepth, MaxDepositSubTreeHeight: genesis.MaxDepositSubTreeHeight}
-	core.DBInstance.UpdateStakeAmount(newParams.StakeAmount)
-	core.DBInstance.UpdateMaxDepth(newParams.MaxDepth)
-	core.DBInstance.UpdateDepositSubTreeHeight(newParams.MaxDepositSubTreeHeight)
-	core.DBInstance.UpdateFinalisationTimePerBatch(40320)
+	err = core.DBInstance.UpdateStakeAmount(newParams.StakeAmount)
+	common.PanicIfError(err)
+	err = core.DBInstance.UpdateMaxDepth(newParams.MaxDepth)
+	common.PanicIfError(err)
+	err = core.DBInstance.UpdateDepositSubTreeHeight(newParams.MaxDepositSubTreeHeight)
+	common.PanicIfError(err)
+	err = core.DBInstance.UpdateFinalisationTimePerBatch(40320)
+	common.PanicIfError(err)
 
 	// load sync status
 	err = core.DBInstance.InitSyncStatus(genesis.StartEthBlock)

cmd/tx.go

@@ -55,11 +55,16 @@ func sendTransferTx() *cobra.Command {
 	cmd.Flags().StringP(FlagPubKey, "", "", "--pubkey=<pubkey>")
 	cmd.Flags().StringP(FlagPrivKey, "", "", "--privkey=<privkey>")
 	cmd.Flags().StringP(FlagAmount, "", "", "--amount=<amount>")
-	cmd.MarkFlagRequired(FlagToID)
-	cmd.MarkFlagRequired(FlagFromID)
-	cmd.MarkFlagRequired(FlagPubKey)
-	cmd.MarkFlagRequired(FlagPrivKey)
-	cmd.MarkFlagRequired(FlagAmount)
+	err := cmd.MarkFlagRequired(FlagToID)
+	common.PanicIfError(err)
+	err = cmd.MarkFlagRequired(FlagFromID)
+	common.PanicIfError(err)
+	err = cmd.MarkFlagRequired(FlagPubKey)
+	common.PanicIfError(err)
+	err = cmd.MarkFlagRequired(FlagPrivKey)
+	common.PanicIfError(err)
+	err = cmd.MarkFlagRequired(FlagAmount)
+	common.PanicIfError(err)
 	return cmd
 }
 
@@ -172,9 +177,18 @@ func validateAndTransfer(db core.DB, bazooka core.Bazooka, fromIndex, toIndex, a
 		return
 	}
 
-	tx := core.NewPendingTx(fromIndex, toIndex, core.TX_TRANSFER_TYPE, []byte(""), txData)
-	tx.SignTx(priv, pub, common.Keccak256(tx.GetSignBytes()))
-	tx.AssignHash()
+	tx, err := core.NewPendingTx(fromIndex, toIndex, core.TX_TRANSFER_TYPE, []byte(""), txData)
+	if err != nil {
+		return
+	}
+	err = tx.SignTx(priv, pub, common.Keccak256(tx.GetSignBytes()))
+	if err != nil {
+		return
+	}
+	err = tx.AssignHash()
+	if err != nil {
+		return
+	}
 
 	fmt.Println("Sending new tx", tx.String())
 

common/unpack.go

@@ -132,17 +132,6 @@ func capitalise(input string) string {
 	return toCamelCase(strings.ToUpper(input[:1]) + input[1:])
 }
 
-// decapitalise makes a camel-case string which starts with a lower case character.
-func decapitalise(input string) string {
-	for len(input) > 0 && input[0] == '_' {
-		input = input[1:]
-	}
-	if len(input) == 0 {
-		return ""
-	}
-	return toCamelCase(strings.ToLower(input[:1]) + input[1:])
-}
-
 // toCamelCase converts an under-score string to a camel-case string
 func toCamelCase(input string) string {
 	toupper := false

common/util.go

@@ -65,9 +65,11 @@ func KeccakFromString(data string) (hash common.Hash, err error) {
 
 }
 
-func RlpHash(x interface{}) (h common.Hash) {
+func RlpHash(x interface{}) (h common.Hash, err error) {
 	hw := sha3.NewLegacyKeccak256()
-	rlp.Encode(hw, x)
+	if err = rlp.Encode(hw, x); err != nil {
+		return
+	}
 	hw.Sum(h[:0])
-	return h
+	return h, nil
 }

core/account.go

@@ -151,7 +151,10 @@ func (db *DB) AddNewAccount(acc Account) error {
 // UpdateAccount updates the account
 func (db *DB) UpdateAccount(leaf Account) error {
 	db.Logger.Info("Updated account pubkey", "ID", leaf.ID)
-	leaf.PopulateHash()
+	err := leaf.PopulateHash()
+	if err != nil {
+		return err
+	}
 	siblings, err := db.GetAccountSiblings(leaf.Path)
 	if err != nil {
 		return err
@@ -232,7 +235,10 @@ func (db *DB) storeAccountLeaf(pdaLeaf Account, path string, siblings []Account)
 // InsertCoordinatorPubkeyAccounts inserts the coordinator accounts
 func (db *DB) InsertCoordinatorPubkeyAccounts(coordinatorAccount *Account, depth uint64) error {
 	coordinatorAccount.UpdatePath(GenCoordinatorPath(depth))
-	coordinatorAccount.PopulateHash()
+	err := coordinatorAccount.PopulateHash()
+	if err != nil {
+		return err
+	}
 	coordinatorAccount.Type = TYPE_TERMINAL
 	return db.Instance.Create(&coordinatorAccount).Error
 }

core/bazooka.go

@@ -371,7 +371,12 @@ func (b *Bazooka) DecodeTransferTx(txBytes []byte) (from, to, nonce, txType, amo
 
 func (b *Bazooka) EncodeState(id, balance, nonce, token uint64) (accountBytes []byte, err error) {
 	opts := bind.CallOpts{From: config.OperatorAddress}
-	accountBytes, err = b.Frontend.Encode(&opts, rollupclient.TypesUserState{big.NewInt(int64(id)), big.NewInt(int64(token)), big.NewInt(int64(balance)), big.NewInt(int64(nonce))})
+	accountBytes, err = b.Frontend.Encode(&opts, rollupclient.TypesUserState{
+		PubkeyIndex: big.NewInt(int64(id)),
+		TokenType:   big.NewInt(int64(token)),
+		Balance:     big.NewInt(int64(balance)),
+		Nonce:       big.NewInt(int64(nonce)),
+	})
 	if err != nil {
 		return
 	}

core/tx.go

@@ -44,17 +44,20 @@ func NewTx(from, to, txType uint64, sig, data []byte) Tx {
 }
 
 // NewPendingTx creates a new transaction
-func NewPendingTx(from, to, txType uint64, sig, data []byte) Tx {
-	tx := Tx{
+func NewPendingTx(from, to, txType uint64, sig, data []byte) (tx Tx, err error) {
+	tx = Tx{
 		To:        to,
 		From:      from,
 		Data:      data,
 		Signature: sig,
 		Status:    TX_STATUS_PENDING,
 		Type:      txType,
 	}
-	tx.AssignHash()
-	return tx
+
+	if err = tx.AssignHash(); err != nil {
+		return
+	}
+	return
 }
 
 // GetSignBytes returns the transaction data that has to be signed
@@ -87,12 +90,16 @@ func (tx *Tx) SignTx(key string, pubkey string, txBytes [32]byte) (err error) {
 }
 
 // AssignHash creates a tx hash and add it to the tx
-func (t *Tx) AssignHash() {
+func (t *Tx) AssignHash() (err error) {
 	if t.TxHash != "" {
+		return nil
+	}
+	hash, err := common.RlpHash(t)
+	if err != nil {
 		return
 	}
-	hash := common.RlpHash(t)
 	t.TxHash = hash.String()
+	return nil
 }
 
 func (t *Tx) String() string {
@@ -186,8 +193,10 @@ func (tx *Tx) GetWitnessTranfer() (fromMerkleProof, toMerkleProof StateMerklePro
 	dbCopy, _ := NewDB()
 
 	// fetch from state MP
-	DBInstance.FetchMPWithID(tx.From, &fromMerkleProof)
-
+	err = DBInstance.FetchMPWithID(tx.From, &fromMerkleProof)
+	if err != nil {
+		return
+	}
 	toState, err := DBInstance.GetStateByIndex(tx.To)
 	if err != nil {
 		return
@@ -326,7 +335,6 @@ func ProcessTxs(db DB, bz Bazooka, txs []Tx, isSyncing bool) (commitments []Comm
 			commitment := Commitment{Txs: txInCommitment, UpdatedRoot: newRoot, BatchType: tx.Type, AggregatedSignature: aggregatedSig.ToBytes()}
 			commitments = append(commitments, commitment)
 		}
-		currentRoot = newRoot
 	}
 
 	return commitments, nil

core/utils.go

@@ -1,7 +1,6 @@
 package core
 
 import (
-	"fmt"
 	"math/big"
 	"strconv"
 	"strings"
@@ -52,16 +51,6 @@ func UintToString(a uint64) string {
 	return strconv.FormatUint(a, 2)
 }
 
-func isRight(path string) bool {
-	dataRune := []rune(path)
-	// if the bit is 0
-	if dataRune[len(path)-1] == 48 {
-		return false
-	} else {
-		return true
-	}
-}
-
 func GetNthBitFromRight(path string, index int) int {
 	dataRune := []rune(path)
 	// if the bit is 0
@@ -112,10 +101,6 @@ func GetAdjacentNodePath(path string) (string, error) {
 	return pad.Left(UintToString(adjacentNodePath), len(path), "0"), nil
 }
 
-func padNumberWithZero(value string, depth uint64) string {
-	return fmt.Sprintf("%03v", value)
-}
-
 // goes from 3 to 000000000011
 func SolidityPathToNodePath(path uint64, depth uint64) (string, error) {
 	pathWithoutPrefix := UintToString(path)

core/utils_test.go

@@ -25,6 +25,9 @@ func TestBasicPathMutations(t *testing.T) {
 		panic(err)
 	}
 	data, err := StringToUint(newPath)
+	if err != nil {
+		panic(err)
+	}
 	fmt.Println("path generated", newPath, "data", data)
 }
 

listener/processors.go

@@ -239,6 +239,9 @@ func (s *Syncer) SendDepositFinalisationTx() {
 	}
 
 	err = s.loadedBazooka.FireDepositFinalisation(nodeToBeReplaced, siblings, params.MaxDepositSubTreeHeight)
+	if err != nil {
+		return
+	}
 }
 
 func (s *Syncer) applyTxsFromBatch(txsBytes []byte, txType uint64, isSyncing bool) (newRoot core.ByteArray, err error) {

listener/syncer.go

@@ -66,7 +66,7 @@ func NewSyncer() Syncer {
 	if err != nil {
 		panic(err)
 	}
-
+	//nolint:govet // will fix later in #76
 	return *syncerService
 }
 
@@ -161,7 +161,8 @@ func (s *Syncer) startSubscription(ctx context.Context, subscription ethereum.Su
 		case err := <-subscription.Err():
 			// stop service
 			s.Logger.Error("Error while subscribing new blocks", "error", err)
-			s.Stop()
+			err = s.Stop()
+			s.Logger.Error("Error while stopping", "error", err)
 
 			// cancel subscription
 			s.cancelSubscription()