ARCO-209: fix linter errors

bitcoin-sv · Oct 28, 2024 · 2e1ceb0 · 2e1ceb0
1 parent 9432ff1
commit 2e1ceb0
Show file tree

Hide file tree

Showing 38 changed files with 116 additions and 114 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -331,7 +331,7 @@ issues:
   max-same-issues: 50
 
   exclude:
-    - "don't use an underscore in package name"
+    - "don't use an underscore in package name" # exclude check from revive linter
 
 #  exclude-rules:
 #    - source: "(noinspection|TODO)"

diff --git a/Makefile b/Makefile
@@ -50,6 +50,10 @@ lint:
 	golangci-lint run -v ./...
 	staticcheck ./...
 
+.PHONY: lint_fix
+lint_fix:
+	golangci-lint run -v ./... --fix
+
 .PHONY: gen_go
 gen_go:
 	go generate ./...

diff --git a/cmd/arc/services/blocktx.go b/cmd/arc/services/blocktx.go
@@ -2,9 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	natscore "github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_core"
-	natsjetstream "github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_jetstream"
-	natsconnection "github.com/bitcoin-sv/arc/internal/message_queue/nats/nats_connection"
 	"log/slog"
 	"net"
 	"time"
@@ -13,6 +10,9 @@ import (
 	"github.com/bitcoin-sv/arc/internal/blocktx"
 	"github.com/bitcoin-sv/arc/internal/blocktx/store"
 	"github.com/bitcoin-sv/arc/internal/blocktx/store/postgresql"
+	"github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_core"
+	"github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_jetstream"
+	"github.com/bitcoin-sv/arc/internal/message_queue/nats/nats_connection"
 	"github.com/bitcoin-sv/arc/internal/version"
 	"github.com/libsv/go-p2p"
 	"google.golang.org/grpc"
@@ -44,26 +44,26 @@ func StartBlockTx(logger *slog.Logger, arcConfig *config.ArcConfig) (func(), err
 	requestTxChannel := make(chan []byte, chanBufferSize)
 
 	var mqClient blocktx.MessageQueueClient
-	natsConnection, err := natsconnection.New(arcConfig.MessageQueue.URL, logger)
+	natsConnection, err := nats_connection.New(arcConfig.MessageQueue.URL, logger)
 	if err != nil {
 		return nil, fmt.Errorf("failed to establish connection to message queue at URL %s: %v", arcConfig.MessageQueue.URL, err)
 	}
 
 	if arcConfig.MessageQueue.Streaming.Enabled {
-		opts := []natsjetstream.Option{natsjetstream.WithSubscribedTopics(blocktx.RegisterTxTopic, blocktx.RequestTxTopic)}
+		opts := []nats_jetstream.Option{nats_jetstream.WithSubscribedTopics(blocktx.RegisterTxTopic, blocktx.RequestTxTopic)}
 		if arcConfig.MessageQueue.Streaming.FileStorage {
-			opts = append(opts, natsjetstream.WithFileStorage())
+			opts = append(opts, nats_jetstream.WithFileStorage())
 		}
 
-		mqClient, err = natsjetstream.New(natsConnection, logger,
+		mqClient, err = nats_jetstream.New(natsConnection, logger,
 			[]string{blocktx.MinedTxsTopic, blocktx.RegisterTxTopic, blocktx.RequestTxTopic},
 			opts...,
 		)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create nats client: %v", err)
 		}
 	} else {
-		mqClient = natscore.New(natsConnection, natscore.WithLogger(logger))
+		mqClient = nats_core.New(natsConnection, nats_core.WithLogger(logger))
 	}
 
 	processorOpts := []func(handler *blocktx.Processor){

diff --git a/cmd/arc/services/k8s_watcher.go b/cmd/arc/services/k8s_watcher.go
@@ -2,11 +2,11 @@ package cmd
 
 import (
 	"fmt"
-	k8swatcher "github.com/bitcoin-sv/arc/internal/k8s_watcher"
 	"log/slog"
 
 	"github.com/bitcoin-sv/arc/config"
 	"github.com/bitcoin-sv/arc/internal/blocktx/blocktx_api"
+	"github.com/bitcoin-sv/arc/internal/k8s_watcher"
 	"github.com/bitcoin-sv/arc/internal/k8s_watcher/k8s_client"
 	"github.com/bitcoin-sv/arc/internal/metamorph/metamorph_api"
 	"github.com/bitcoin-sv/arc/pkg/blocktx"
@@ -23,7 +23,7 @@ func StartK8sWatcher(logger *slog.Logger, arcConfig *config.ArcConfig) (func(),
 
 	metamorphClient := metamorph.NewClient(metamorph_api.NewMetaMorphAPIClient(mtmConn))
 
-	k8sClient, err := k8sclient.New()
+	k8sClient, err := k8s_client.New()
 	if err != nil {
 		return nil, fmt.Errorf("failed to get k8s-client: %v", err)
 	}
@@ -35,7 +35,7 @@ func StartK8sWatcher(logger *slog.Logger, arcConfig *config.ArcConfig) (func(),
 
 	blocktxClient := blocktx.NewClient(blocktx_api.NewBlockTxAPIClient(blocktxConn))
 
-	k8sWatcher := k8swatcher.New(metamorphClient, blocktxClient, k8sClient, arcConfig.K8sWatcher.Namespace, k8swatcher.WithLogger(logger))
+	k8sWatcher := k8s_watcher.New(metamorphClient, blocktxClient, k8sClient, arcConfig.K8sWatcher.Namespace, k8s_watcher.WithLogger(logger))
 	err = k8sWatcher.Start()
 	if err != nil {
 		return nil, fmt.Errorf("faile to start k8s-watcher: %v", err)

diff --git a/cmd/arc/services/metamorph.go b/cmd/arc/services/metamorph.go
@@ -3,11 +3,6 @@ package cmd
 import (
 	"context"
 	"fmt"
-	"github.com/bitcoin-sv/arc/internal/cache"
-	grpcopts "github.com/bitcoin-sv/arc/internal/grpc_opts"
-	natscore "github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_core"
-	natsjetstream "github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_jetstream"
-	natsconnection "github.com/bitcoin-sv/arc/internal/message_queue/nats/nats_connection"
 	"log/slog"
 	"net"
 	"net/url"
@@ -24,7 +19,12 @@ import (
 
 	"github.com/bitcoin-sv/arc/config"
 	"github.com/bitcoin-sv/arc/internal/blocktx/blocktx_api"
+	"github.com/bitcoin-sv/arc/internal/cache"
 	"github.com/bitcoin-sv/arc/internal/callbacker/callbacker_api"
+	"github.com/bitcoin-sv/arc/internal/grpc_opts"
+	"github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_core"
+	"github.com/bitcoin-sv/arc/internal/message_queue/nats/client/nats_jetstream"
+	"github.com/bitcoin-sv/arc/internal/message_queue/nats/nats_connection"
 	"github.com/bitcoin-sv/arc/internal/metamorph"
 	"github.com/bitcoin-sv/arc/internal/metamorph/metamorph_api"
 	"github.com/bitcoin-sv/arc/internal/metamorph/store"
@@ -56,26 +56,26 @@ func StartMetamorph(logger *slog.Logger, arcConfig *config.ArcConfig, cacheStore
 	submittedTxsChan := make(chan *metamorph_api.TransactionRequest, chanBufferSize)
 
 	var mqClient metamorph.MessageQueueClient
-	natsClient, err := natsconnection.New(arcConfig.MessageQueue.URL, logger)
+	natsClient, err := nats_connection.New(arcConfig.MessageQueue.URL, logger)
 	if err != nil {
 		return nil, fmt.Errorf("failed to establish connection to message queue at URL %s: %v", arcConfig.MessageQueue.URL, err)
 	}
 
 	if arcConfig.MessageQueue.Streaming.Enabled {
-		opts := []natsjetstream.Option{natsjetstream.WithSubscribedTopics(metamorph.MinedTxsTopic, metamorph.SubmitTxTopic)}
+		opts := []nats_jetstream.Option{nats_jetstream.WithSubscribedTopics(metamorph.MinedTxsTopic, metamorph.SubmitTxTopic)}
 		if arcConfig.MessageQueue.Streaming.FileStorage {
-			opts = append(opts, natsjetstream.WithFileStorage())
+			opts = append(opts, nats_jetstream.WithFileStorage())
 		}
 
-		mqClient, err = natsjetstream.New(natsClient, logger,
+		mqClient, err = nats_jetstream.New(natsClient, logger,
 			[]string{metamorph.MinedTxsTopic, metamorph.SubmitTxTopic, metamorph.RegisterTxTopic, metamorph.RequestTxTopic},
 			opts...,
 		)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create nats client: %v", err)
 		}
 	} else {
-		mqClient = natscore.New(natsClient, natscore.WithLogger(logger))
+		mqClient = nats_core.New(natsClient, nats_core.WithLogger(logger))
 	}
 
 	procLogger := logger.With(slog.String("module", "mtm-proc"))
@@ -292,7 +292,7 @@ func initPeerManager(logger *slog.Logger, s store.MetamorphStore, arcConfig *con
 }
 
 func initGrpcCallbackerConn(address, prometheusEndpoint string, grpcMsgSize int) (callbacker_api.CallbackerAPIClient, error) {
-	dialOpts, err := grpcopts.GetGRPCClientOpts(prometheusEndpoint, grpcMsgSize)
+	dialOpts, err := grpc_opts.GetGRPCClientOpts(prometheusEndpoint, grpcMsgSize)
 	if err != nil {
 		return nil, err
 	}

diff --git a/cmd/broadcaster-cli/app/keyset/balance/balance.go b/cmd/broadcaster-cli/app/keyset/balance/balance.go
@@ -26,7 +26,7 @@ var Cmd = &cobra.Command{
 
 		logger := helper.GetLogger()
 
-		wocClient := wocclient.New(!isTestnet, wocclient.WithAuth(wocAPIKey), wocclient.WithLogger(logger))
+		wocClient := woc_client.New(!isTestnet, woc_client.WithAuth(wocAPIKey), woc_client.WithLogger(logger))
 
 		keySetsMap, err := helper.GetSelectedKeySets()
 		if err != nil {

diff --git a/cmd/broadcaster-cli/app/keyset/topup/topup.go b/cmd/broadcaster-cli/app/keyset/topup/topup.go
@@ -26,7 +26,7 @@ var Cmd = &cobra.Command{
 
 		logger := helper.GetLogger()
 
-		wocClient := wocclient.New(!isTestnet, wocclient.WithAuth(wocAPIKey), wocclient.WithLogger(logger))
+		wocClient := woc_client.New(!isTestnet, woc_client.WithAuth(wocAPIKey), woc_client.WithLogger(logger))
 
 		keySetsMap, err := helper.GetSelectedKeySets()
 		if err != nil {

diff --git a/cmd/broadcaster-cli/app/keyset/utxos/utxos.go b/cmd/broadcaster-cli/app/keyset/utxos/utxos.go
@@ -32,7 +32,7 @@ var Cmd = &cobra.Command{
 		}
 
 		logger := helper.GetLogger()
-		wocClient := wocclient.New(!isTestnet, wocclient.WithAuth(wocAPIKey), wocclient.WithLogger(logger))
+		wocClient := woc_client.New(!isTestnet, woc_client.WithAuth(wocAPIKey), woc_client.WithLogger(logger))
 
 		keySetsMap, err := helper.GetSelectedKeySets()
 		if err != nil {

diff --git a/cmd/broadcaster-cli/app/utxos/broadcast/broadcast.go b/cmd/broadcaster-cli/app/utxos/broadcast/broadcast.go
@@ -113,7 +113,7 @@ var Cmd = &cobra.Command{
 			return fmt.Errorf("failed to create client: %v", err)
 		}
 
-		wocClient := wocclient.New(!isTestnet, wocclient.WithAuth(wocAPIKey), wocclient.WithLogger(logger))
+		wocClient := woc_client.New(!isTestnet, woc_client.WithAuth(wocAPIKey), woc_client.WithLogger(logger))
 
 		opts := []func(p *broadcaster.Broadcaster){
 			broadcaster.WithFees(miningFeeSat),

diff --git a/cmd/broadcaster-cli/app/utxos/consolidate/consolidate.go b/cmd/broadcaster-cli/app/utxos/consolidate/consolidate.go
@@ -3,6 +3,7 @@ package consolidate
 import (
 	"errors"
 	"fmt"
+	"github.com/bitcoin-sv/arc/internal/woc_client"
 	"log/slog"
 	"os"
 	"os/signal"
@@ -11,7 +12,6 @@ import (
 
 	"github.com/bitcoin-sv/arc/cmd/broadcaster-cli/helper"
 	"github.com/bitcoin-sv/arc/internal/broadcaster"
-	"github.com/bitcoin-sv/arc/internal/woc_client"
 )
 
 var Cmd = &cobra.Command{
@@ -61,7 +61,7 @@ var Cmd = &cobra.Command{
 
 		names := helper.GetOrderedKeys(keySetsMap)
 
-		wocClient := wocclient.New(!isTestnet, wocclient.WithAuth(wocAPIKey), wocclient.WithLogger(logger))
+		wocClient := woc_client.New(!isTestnet, woc_client.WithAuth(wocAPIKey), woc_client.WithLogger(logger))
 		cs := make([]broadcaster.Consolidator, 0, len(keySetsMap))
 		for _, keyName := range names {
 			ks := keySetsMap[keyName]

diff --git a/cmd/broadcaster-cli/app/utxos/create/create.go b/cmd/broadcaster-cli/app/utxos/create/create.go
@@ -3,14 +3,14 @@ package create
 import (
 	"errors"
 	"fmt"
+	"github.com/bitcoin-sv/arc/internal/woc_client"
 	"log"
 	"log/slog"
 	"os"
 	"os/signal"
 
 	"github.com/bitcoin-sv/arc/cmd/broadcaster-cli/helper"
 	"github.com/bitcoin-sv/arc/internal/broadcaster"
-	"github.com/bitcoin-sv/arc/internal/woc_client"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -79,7 +79,7 @@ var Cmd = &cobra.Command{
 
 		names := helper.GetOrderedKeys(keySetsMap)
 
-		wocClient := wocclient.New(!isTestnet, wocclient.WithAuth(wocAPIKey), wocclient.WithLogger(logger))
+		wocClient := woc_client.New(!isTestnet, woc_client.WithAuth(wocAPIKey), woc_client.WithLogger(logger))
 		creators := make([]broadcaster.Creator, 0, len(keySetsMap)) // Use the Creator interface for flexibility
 		for _, keyName := range names {
 			ks := keySetsMap[keyName]

diff --git a/examples/customhandler/handler.go b/examples/customhandler/handler.go
@@ -2,11 +2,11 @@ package main
 
 import (
 	"context"
-	transactionhandler "github.com/bitcoin-sv/arc/pkg/api/transaction_handler"
 	"net/http"
 
 	"github.com/bitcoin-sv/arc/pkg/api"
 	"github.com/bitcoin-sv/arc/pkg/api/handler"
+	"github.com/bitcoin-sv/arc/pkg/api/transaction_handler"
 	"github.com/bitcoin-sv/arc/pkg/blocktx"
 	"github.com/labstack/echo/v4"
 	"github.com/ordishs/go-bitcoin"
@@ -28,7 +28,7 @@ func (c *CustomMerkleRootsVerifier) VerifyMerkleRoots(ctx context.Context, merkl
 
 func NewCustomHandler() (api.ServerInterface, error) {
 	// add a single bitcoin node
-	node, err := transactionhandler.NewBitcoinNode("localhost", 8332, "user", "mypassword", false)
+	node, err := transaction_handler.NewBitcoinNode("localhost", 8332, "user", "mypassword", false)
 	if err != nil {
 		return nil, err
 	}

diff --git a/examples/simple/main.go b/examples/simple/main.go
@@ -2,14 +2,14 @@ package main
 
 import (
 	"fmt"
-	transactionhandler "github.com/bitcoin-sv/arc/pkg/api/transaction_handler"
 	"log/slog"
 	"os"
 
 	"github.com/bitcoin-sv/arc/config"
 	"github.com/bitcoin-sv/arc/pkg/api"
 	apiHandler "github.com/bitcoin-sv/arc/pkg/api/handler"
 	merklerootsverifier "github.com/bitcoin-sv/arc/pkg/api/merkle_roots_verifier"
+	"github.com/bitcoin-sv/arc/pkg/api/transaction_handler"
 	"github.com/labstack/echo/v4"
 )
 
@@ -24,7 +24,7 @@ func main() {
 	}
 
 	// add a single bitcoin node
-	txHandler, err := transactionhandler.NewBitcoinNode("localhost", 8332, "user", "mypassword", false)
+	txHandler, err := transaction_handler.NewBitcoinNode("localhost", 8332, "user", "mypassword", false)
 	if err != nil {
 		panic(err)
 	}

diff --git a/internal/blocktx/server.go b/internal/blocktx/server.go
@@ -3,13 +3,13 @@ package blocktx
 import (
 	"context"
 	"errors"
-	grpcopts "github.com/bitcoin-sv/arc/internal/grpc_opts"
 	"log/slog"
 	"net"
 	"time"
 
 	"github.com/bitcoin-sv/arc/internal/blocktx/blocktx_api"
 	"github.com/bitcoin-sv/arc/internal/blocktx/store"
+	"github.com/bitcoin-sv/arc/internal/grpc_opts"
 	"github.com/libsv/go-p2p"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/reflection"
@@ -43,7 +43,7 @@ func NewServer(storeI store.BlocktxStore, logger *slog.Logger, pm p2p.PeerManage
 // StartGRPCServer function.
 func (s *Server) StartGRPCServer(address string, grpcMessageSize int, prometheusEndpoint string, logger *slog.Logger) error {
 	// LEVEL 0 - no security / no encryption
-	srvMetrics, opts, cleanup, err := grpcopts.GetGRPCServerOpts(logger, prometheusEndpoint, grpcMessageSize, "blocktx")
+	srvMetrics, opts, cleanup, err := grpc_opts.GetGRPCServerOpts(logger, prometheusEndpoint, grpcMessageSize, "blocktx")
 	if err != nil {
 		return err
 	}

diff --git a/internal/callbacker/dispatcher_test.go b/internal/callbacker/dispatcher_test.go
@@ -39,7 +39,7 @@ func TestCallbackDispatcher(t *testing.T) {
 	for _, tc := range tcs {
 		t.Run(tc.name, func(t *testing.T) {
 			// given
-			cMq := &SendCallbackInterfaceMock{
+			cMq := &SenderIMock{
 				SendFunc: func(_, _ string, _ *Callback) bool { return true },
 			}
 

diff --git a/internal/callbacker/send_manager_test.go b/internal/callbacker/send_manager_test.go
@@ -62,7 +62,7 @@ func TestSendManager(t *testing.T) {
 	for _, tc := range tcs {
 		t.Run(tc.name, func(t *testing.T) {
 			// given
-			cMq := &SendCallbackInterfaceMock{
+			cMq := &SenderIMock{
 				SendFunc:      func(_, _ string, _ *Callback) bool { return true },
 				SendBatchFunc: func(_, _ string, _ []*Callback) bool { return true },
 			}
@@ -162,7 +162,7 @@ func TestSendManager_Quarantine(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			// given
 			sendOK := true
-			senderMq := &SendCallbackInterfaceMock{
+			senderMq := &SenderIMock{
 				SendFunc:      func(_, _ string, _ *Callback) bool { return sendOK },
 				SendBatchFunc: func(_, _ string, _ []*Callback) bool { return sendOK },
 			}

diff --git a/internal/callbacker/server.go b/internal/callbacker/server.go
@@ -3,13 +3,13 @@ package callbacker
 import (
 	"context"
 	"errors"
-	grpcopts "github.com/bitcoin-sv/arc/internal/grpc_opts"
 	"log/slog"
 	"net"
 	"os"
 	"time"
 
 	"github.com/bitcoin-sv/arc/internal/callbacker/callbacker_api"
+	"github.com/bitcoin-sv/arc/internal/grpc_opts"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/reflection"
 	"google.golang.org/protobuf/types/known/emptypb"
@@ -51,7 +51,7 @@ func NewServer(dispatcher *CallbackDispatcher, opts ...ServerOption) *Server {
 func (s *Server) Serve(address string, grpcMessageSize int, prometheusEndpoint string) error {
 	// LEVEL 0 - no security / no encryption
 
-	srvMetrics, opts, cleanup, err := grpcopts.GetGRPCServerOpts(s.logger, prometheusEndpoint, grpcMessageSize, "callbacker")
+	srvMetrics, opts, cleanup, err := grpc_opts.GetGRPCServerOpts(s.logger, prometheusEndpoint, grpcMessageSize, "callbacker")
 	if err != nil {
 		return err
 	}

diff --git a/internal/grpc_opts/grpc_opts.go b/internal/grpc_opts/grpc_opts.go
@@ -1,4 +1,4 @@
-package grpcopts
+package grpc_opts
 
 import (
 	"context"

diff --git a/internal/k8s_watcher/k8s_client/client.go b/internal/k8s_watcher/k8s_client/client.go
@@ -1,4 +1,4 @@
-package k8sclient
+package k8s_client
 
 import (
 	"context"