[DOC] complete documents

Makefile

@@ -30,7 +30,12 @@ test-subscriber:
 	go run tests/kafka/subscriber/main.go 
 test-mongo:
 	go run tests/mongo/main.go
+test-ganache:
+	go run tests/ganache/main.go
+
+unit-test:
+	go test ./...
 
 
 start-blockchain-algorithm:
-	go run tests/blockchain/main.go
+	go run main.go blockchainAlgorithm

cmd/blockchainAlgorithm.go

@@ -0,0 +1,39 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+
+	"openmyth/blockchain/cmd/srv/blockchain_algorithm"
+)
+
+// blockchainAlgorithmCmd represents the blockchainAlgorithm command
+var blockchainAlgorithmCmd = &cobra.Command{
+	Use:   "blockchainAlgorithm",
+	Short: "A brief description of your command",
+	Long: `A longer description that spans multiple lines and likely contains examples
+and usage of using your command. For example:
+
+Cobra is a CLI library for Go that empowers applications.
+This application is a tool to generate the needed files
+to quickly create a Cobra application.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		blockchain_algorithm.Run(cmd.Context())
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(blockchainAlgorithmCmd)
+
+	// Here you will define your flags and configuration settings.
+
+	// Cobra supports Persistent Flags which will work for this command
+	// and all subcommands, e.g.:
+	// blockchainAlgorithmCmd.PersistentFlags().String("foo", "", "A help for foo")
+
+	// Cobra supports local flags which will only run when this command
+	// is called directly, e.g.:
+	// blockchainAlgorithmCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+}

tests/blockchain/main.go → cmd/srv/blockchain_algorithm/srv.go

@@ -1,6 +1,7 @@
-package main
+package blockchain_algorithm
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"log"
@@ -33,19 +34,19 @@ func getPromptTemplate() *promptui.PromptTemplates {
 }
 
 const (
-	// FEATURE_ADD_DATA_TEXT ...
-	FEATURE_ADD_DATA_TEXT = "add data text"
-	// FEATURE_LIST_BLOCK ...
-	FEATURE_LIST_BLOCK = "list block"
-
-	FEATURE_EXIT = "exit"
+	// FeatureAddDataText represents for add data interaction
+	FeatureAddDataText = "add data text"
+	// FeatureListBlock represents for list block interaction
+	FeatureListBlock = "list block"
+	// FeatureExit represents for exit
+	FeatureExit = "exit"
 )
 
 var (
 	chooseFeature = promptui.Select{
-		Label:     "Choose feature",
-		Items:     []string{FEATURE_ADD_DATA_TEXT, FEATURE_LIST_BLOCK, FEATURE_EXIT},
-		Templates: getSelectTemplate("feature"),
+		Label:     "Choose your interaction",
+		Items:     []string{FeatureAddDataText, FeatureListBlock, FeatureExit},
+		Templates: getSelectTemplate("action"),
 	}
 
 	addData = promptui.Prompt{
@@ -57,11 +58,13 @@ var (
 	}
 )
 
-func main() {
+// Run runs the blockchain algorithm with the specified context.
+//
+// ctx: the context to run the blockchain algorithm
+func Run(_ context.Context) {
 	logger := slog.New(tint.NewHandler(os.Stdout, nil))
 
 	slog.SetDefault(logger)
-	// slog.SetLogLoggerLevel(slog.LevelDebug)
 
 	var (
 		numMiner  int
@@ -92,8 +95,9 @@ func main() {
 		if err != nil {
 			log.Fatalf("failed to select feature: %v", err)
 		}
+		isExit := false
 		switch feature {
-		case FEATURE_ADD_DATA_TEXT:
+		case FeatureAddDataText:
 			data, err := addData.Run()
 			if err != nil {
 				log.Printf("invalid data: %v", err)
@@ -104,7 +108,7 @@ func main() {
 				miner.TransactionCh <- []byte(data)
 			}
 
-		case FEATURE_LIST_BLOCK:
+		case FeatureListBlock:
 			num := rand.Intn(numMiner)
 			bc := miners[num].GetBlockChain()
 			for _, block := range bc.GetBlocks() {
@@ -117,7 +121,10 @@ func main() {
 					nonce: %d
 				`, block.Index, block.Timestamp, block.Data, block.PrevBlockHash, block.Hash, block.Nonce)
 			}
-		case FEATURE_EXIT:
+		case FeatureExit:
+			isExit = true
+		}
+		if isExit {
 			break
 		}
 	}

cmd/srv/contract_reader/srv.go

@@ -37,12 +37,14 @@ type Server struct {
 	service *processor.Service
 }
 
+// NewServer creates a new server instance with a new service.
 func NewServer() *Server {
 	return &Server{
 		service: processor.NewService(),
 	}
 }
 
+// loadClients initializes the user client and factories for the server.
 func (s *Server) loadClients() {
 	userConn := grpc_client.NewGrpcClient(s.service.Cfg.UserService)
 
@@ -52,19 +54,22 @@ func (s *Server) loadClients() {
 
 }
 
+// loadDatabases initializes the MongoDB client for the server.
 func (s *Server) loadDatabases() {
 	s.mongoClient = mongoclient.NewMongoClient(s.service.Cfg.MongoDB.Address())
 
 	s.service.WithFactories(s.mongoClient)
 }
 
+// loadPublisher initializes a publisher for the server.
 func (s *Server) loadPublisher() {
 	clientID := uuid.NewString()
 	s.publisher = kafka.NewPublisher(clientID, s.service.Cfg.Kafka.Address())
 
 	s.service.WithFactories(s.publisher)
 }
 
+// loadEthClient initializes the Ethereum client for the server.
 func (s *Server) loadEthClient(ctx context.Context) {
 	cfg := s.service.Cfg
 
@@ -73,6 +78,7 @@ func (s *Server) loadEthClient(ctx context.Context) {
 	s.service.WithFactories(s.ethClient)
 }
 
+// loadRepositories initializes the necessary repositories for the server.
 func (s *Server) loadRepositories() {
 	s.approvalRepo = mongo.NewApprovalRepository(s.mongoClient, s.service.Cfg.MongoDB.Database)
 	s.transferRepo = mongo.NewTransferRepository(s.mongoClient, s.service.Cfg.MongoDB.Database)
@@ -81,17 +87,11 @@ func (s *Server) loadRepositories() {
 }
 
 // loadServices initializes the contract reader service with the necessary repositories and publisher.
-//
-// No parameters.
-// No return value.
 func (s *Server) loadServices() {
 	s.contractReaderService = services.NewContractReaderService(s.approvalRepo, s.transferRepo, s.blockchainRepo, s.myTokenRepo, s.userClient, s.publisher)
 }
 
 // loadServer initializes the gRPC server for the Contract Reader Service.
-//
-// No parameters.
-// No return value.
 func (s *Server) loadServer() {
 	srv := grpc_server.NewGrpcServer(s.service.Cfg.ContractReaderService)
 
@@ -101,9 +101,6 @@ func (s *Server) loadServer() {
 }
 
 // Run runs the server with the provided context.
-//
-// ctx: the context.Context for the server.
-// No return value.
 func (s *Server) Run(ctx context.Context) {
 	s.service.LoadLogger()
 	s.service.LoadConfig()

cmd/srv/contract_writer/srv.go

@@ -34,18 +34,21 @@ type Server struct {
 	service *processor.Service
 }
 
+// NewServer returns a new Server instance with a new service.
 func NewServer() *Server {
 	return &Server{
 		service: processor.NewService(),
 	}
 }
 
+// loadDatabases initializes the MongoDB client for the server.
 func (s *Server) loadDatabases() {
 	s.mongoClient = mongoclient.NewMongoClient(s.service.Cfg.MongoDB.Address())
 
 	s.service.WithFactories(s.mongoClient)
 }
 
+// loadEthClient initializes the Ethereum clients for the server.
 func (s *Server) loadEthClient(_ context.Context) {
 	cfg := s.service.Cfg
 
@@ -55,17 +58,20 @@ func (s *Server) loadEthClient(_ context.Context) {
 	s.service.WithFactories(s.ethClient, s.wsEthClient)
 }
 
+// loadRepositories initializes the necessary repositories for the server.
 func (s *Server) loadRepositories() {
 	s.approvalRepo = mongo.NewApprovalRepository(s.mongoClient, s.service.Cfg.MongoDB.Database)
 	s.transferRepo = mongo.NewTransferRepository(s.mongoClient, s.service.Cfg.MongoDB.Database)
 	s.myTokenRepo = eth.NewMyTokenRepository(s.ethClient, s.wsEthClient, s.service.Cfg.ContractAddress)
 	s.blockchainRepo = eth.NewBlockchainRepository(s.ethClient)
 }
 
+// loadServices initializes the services in the server with the provided approval repository, transfer repository, MyToken repository, and blockchain repository.
 func (s *Server) loadServices() {
 	s.contractWriter = services.NewContractWriterService(s.approvalRepo, s.transferRepo, s.myTokenRepo, s.blockchainRepo)
 }
 
+// loadSubscriber initializes the subscriber for the server with the specified topics and contract writer callback.
 func (s *Server) loadSubscriber() {
 	s.subscriber = kafka.NewSubscriber(
 		os.Getenv("SERVICE"),
@@ -82,9 +88,6 @@ func (s *Server) loadSubscriber() {
 }
 
 // Run runs the server with the provided context.
-//
-// ctx: the context.Context for the server.
-// No return value.
 func (s *Server) Run(ctx context.Context) {
 	s.service.LoadLogger()
 	s.service.LoadConfig()

cmd/srv/deploy_contract/srv.go

@@ -16,26 +16,31 @@ type Server struct {
 	deployContract *services.DeployContractService
 }
 
+// NewServer creates a new server instance.
 func NewServer() *Server {
 	return &Server{
 		service: *processor.NewService(),
 	}
 }
-func (s *Server) loadEthClient(ctx context.Context) {
+
+// loadEthClient initializes the Ethereum client for the server.
+func (s *Server) loadEthClient(_ context.Context) {
 	cfg := s.service.Cfg
 
 	s.ethClient = eth_client.NewDialClient(cfg.ETHClient.Address())
 
 	s.service.WithFactories(s.ethClient)
 }
 
-func (s *Server) loadServices(ctx context.Context) {
+// loadServices initializes the services in the server with the provided Ethereum client and private key.
+func (s *Server) loadServices(_ context.Context) {
 	cfg := s.service.Cfg
 	s.deployContract = services.NewDeployContractService(s.ethClient, cfg.PrivateKey)
 
 	s.service.WithProcessors(s.deployContract)
 }
 
+// Run runs the server with the provided context.
 func (s *Server) Run(ctx context.Context) {
 	s.service.LoadLogger()
 	s.service.LoadConfig()

cmd/srv/frontend/srv.go

@@ -15,12 +15,14 @@ type Server struct {
 	deployContract *services.DeployContractService
 }
 
+// NewServer creates a new server instance.
 func NewServer() *Server {
 	return &Server{
 		service: *processor.NewService(),
 	}
 }
 
+// loadServer initializes the server to listen on a specified port for HTTP requests.
 func (s *Server) loadServer() {
 	port := s.service.Cfg.Frontend.Port
 	handler := http.FileServer(http.Dir("/html"))
@@ -30,6 +32,7 @@ func (s *Server) loadServer() {
 	}
 }
 
+// Run runs the server with the provided context.
 func (s *Server) Run(ctx context.Context) {
 	s.service.LoadLogger()
 	s.service.LoadConfig()

cmd/srv/gateway/srv.go

@@ -20,12 +20,14 @@ type Server struct {
 	service *processor.Service
 }
 
+// NewServer creates a new server instance.
 func NewServer() *Server {
 	return &Server{
 		service: processor.NewService(),
 	}
 }
 
+// loadClients initializes the user client and contract reader client for the server.
 func (s *Server) loadClients() {
 	userConn := grpc_client.NewGrpcClient(s.service.Cfg.UserService)
 	contractReaderConn := grpc_client.NewGrpcClient(s.service.Cfg.ContractReaderService)
@@ -38,6 +40,7 @@ func (s *Server) loadClients() {
 
 }
 
+// loadServer initializes the HTTP server with the necessary handlers and processors.
 func (s *Server) loadServer(ctx context.Context) {
 	srv := http_server.NewHttpServer(func(mux *runtime.ServeMux) {
 
@@ -50,6 +53,7 @@ func (s *Server) loadServer(ctx context.Context) {
 	s.service.WithProcessors(srv)
 }
 
+// Run runs the server with the provided context.
 func (s *Server) Run(ctx context.Context) {
 	s.service.LoadLogger()
 	s.service.LoadConfig()

internal/blockchain/watcher/watcher.go

@@ -29,7 +29,6 @@ type defaultWatcher struct {
 }
 
 // NewWatcher creates a new Watcher instance.
-//
 // It takes a *eth.EthClient as a parameter and returns a Watcher.
 func NewWatcher(myTokenRepo repositories.MyTokenRepository, publisher pubsub.Publisher) Watcher {
 	return &defaultWatcher{
@@ -40,7 +39,6 @@ func NewWatcher(myTokenRepo repositories.MyTokenRepository, publisher pubsub.Pub
 }
 
 // Start starts the defaultWatcher.
-//
 // It takes a context.Context as a parameter and returns an error.
 func (w *defaultWatcher) Start(ctx context.Context) error {
 	if err := w.migrate(ctx); err != nil {
@@ -71,7 +69,6 @@ func (w *defaultWatcher) Start(ctx context.Context) error {
 }
 
 // Stop stops the defaultWatcher.
-//
 // It takes a context.Context as a parameter and returns an error.
 func (w *defaultWatcher) Stop(_ context.Context) error {
 	w.isRunning = false
@@ -80,7 +77,6 @@ func (w *defaultWatcher) Stop(_ context.Context) error {
 }
 
 // handleEventLog executes a watch on the given event log.
-//
 // It takes a types.Log parameter named evLog and returns an error.
 func (w *defaultWatcher) handleEventLog(evLog types.Log) {
 	if approval, err := w.myTokenRepo.ParseApproval(evLog); err == nil && approval != nil {
@@ -122,10 +118,6 @@ func (w *defaultWatcher) handleEventLog(evLog types.Log) {
 }
 
 // migrate migrates the watcher by filtering logs based on the contract address and handling each event log.
-//
-// Parameters:
-// - ctx: The context.Context object for cancellation and timeouts.
-// Return type: An error.
 func (w *defaultWatcher) migrate(ctx context.Context) error {
 	query := ethereum.FilterQuery{
 		Addresses: []common.Address{