Feature/json rpc api improvements

.golangci.yml

@@ -32,6 +32,15 @@ linters:
       - common-false-positives
       - legacy
       - std-error-handling
+    rules:
+      - path: internal/jsonrpc/api/.*\.go
+        text: avoid meaningless package names
+        linters:
+          - revive
+      - path: internal/jsonrpc/.*\.go
+        text: avoid package names that conflict with Go standard library package names
+        linters:
+          - revive
     paths:
       - third_party$
       - builtin$

cmd/cartesi-rollups-cli/root/app/execution-parameters/execution_parameters.go

@@ -72,7 +72,7 @@ func init() {
 
 }
 
-func run(cmd *cobra.Command, args []string) {
+func run(cmd *cobra.Command, _ []string) {
 	// If no subcommand is provided, show help
 	err := cmd.Help()
 	cobra.CheckErr(err)
@@ -82,7 +82,7 @@ func run(cmd *cobra.Command, args []string) {
 var getCmd = &cobra.Command{
 	Use:   "get [application] [parameter]",
 	Short: "Get a specific configuration parameter",
-	Args:  cobra.ExactArgs(2), // nolint: mnd
+	Args:  cobra.ExactArgs(2), //nolint:mnd
 	Run:   runGet,
 	Long: `
 Supported Environment Variables:
@@ -93,7 +93,7 @@ Supported Environment Variables:
 var setCmd = &cobra.Command{
 	Use:   "set [application] [parameter] [value]",
 	Short: "Set a specific configuration parameter",
-	Args:  cobra.ExactArgs(3), // nolint: mnd
+	Args:  cobra.ExactArgs(3), //nolint:mnd
 	Run:   runSet,
 	Long: `
 Supported Environment Variables:
@@ -157,7 +157,8 @@ func runGet(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	params, err := repo.GetExecutionParameters(ctx, app.ID)
@@ -194,7 +195,8 @@ func runSet(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	params, err := repo.GetExecutionParameters(ctx, app.ID)
@@ -230,7 +232,8 @@ func runList(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	params, err := repo.GetExecutionParameters(ctx, app.ID)
@@ -256,7 +259,8 @@ func runDump(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	params, err := repo.GetExecutionParameters(ctx, app.ID)
@@ -284,7 +288,8 @@ func runLoad(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	// Read JSON from stdin with size limit to prevent memory exhaustion

cmd/cartesi-rollups-cli/root/app/list/list.go

@@ -1,7 +1,7 @@
 // (c) Cartesi and individual authors (see AUTHORS)
 // SPDX-License-Identifier: Apache-2.0 (see LICENSE)
 
-package list
+package list //nolint:revive // The package implements the CLI's "list" subcommand.
 
 import (
 	"encoding/json"
@@ -36,7 +36,7 @@ func init() {
 	})
 }
 
-func run(cmd *cobra.Command, args []string) {
+func run(cmd *cobra.Command, _ []string) {
 	ctx := cmd.Context()
 
 	dsn, err := config.GetDatabaseConnection()

cmd/cartesi-rollups-cli/root/app/register/register.go

@@ -82,7 +82,7 @@ func init() {
 		"Application template hash. (DO NOT USE IN PRODUCTION)\nThis value is retrieved from the application contract",
 	)
 
-	Cmd.Flags().Uint64VarP(&epochLength, "epoch-length", "e", 0, // nolint: mnd
+	Cmd.Flags().Uint64VarP(&epochLength, "epoch-length", "e", 0,
 		"Consensus Epoch length. (DO NOT USE IN PRODUCTION)\nThis value is retrieved from the consensus contract",
 	)
 
@@ -121,7 +121,7 @@ func init() {
 	})
 }
 
-func run(cmd *cobra.Command, args []string) {
+func run(cmd *cobra.Command, _ []string) {
 	ctx := cmd.Context()
 
 	validName, err := config.ToApplicationNameFromString(name)
@@ -181,7 +181,8 @@ func run(cmd *cobra.Command, args []string) {
 		if err != nil {
 			fmt.Fprintf(os.Stderr, "Failed to get epoch length from consensus: %v\n",
 				cli.DecorateRevert(err, iconsensus.IConsensusMetaData))
-			os.Exit(1)
+			repo.Close()
+			os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 		}
 	}
 
@@ -266,7 +267,7 @@ func run(cmd *cobra.Command, args []string) {
 		if executionParametersFileParam == "-" {
 			filePath = os.Stdin.Name()
 		}
-		contents, err := os.ReadFile(filePath)
+		contents, err := os.ReadFile(filePath) //nolint:gosec // The CLI user explicitly supplies this path.
 		cobra.CheckErr(err)
 
 		decoder := json.NewDecoder(strings.NewReader(string(contents)))

cmd/cartesi-rollups-cli/root/app/remove/remove.go

@@ -62,11 +62,13 @@ func run(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	if app.Enabled {
 		fmt.Fprintf(os.Stderr, "Error: Application %s has enabled=true. Must disable it first\n", app.Name)
+		repo.Close()
 		os.Exit(1)
 	}
 

cmd/cartesi-rollups-cli/root/app/status/status.go

@@ -22,7 +22,7 @@ var Cmd = &cobra.Command{
 	Use:     "status [app-name-or-address] [new-status]",
 	Short:   "Display application status or set the enabled flag",
 	Example: examples,
-	Args:    cobra.RangeArgs(1, 2), // nolint: mnd
+	Args:    cobra.RangeArgs(1, 2), //nolint:mnd
 	Run:     run,
 	Long: `
 Supported Environment Variables:
@@ -67,7 +67,8 @@ func run(cmd *cobra.Command, args []string) {
 	cobra.CheckErr(err)
 	if app == nil {
 		fmt.Fprintf(os.Stderr, "application %q not found\n", nameOrAddress)
-		os.Exit(1)
+		repo.Close()
+		os.Exit(1) //nolint:gocritic // The repository is closed explicitly before exiting.
 	}
 
 	// If no new status is provided, display the current status, operator
@@ -93,6 +94,7 @@ func run(cmd *cobra.Command, args []string) {
 				fmt.Printf("Accounts drive merkle root: %s\n", app.AccountsDriveMerkleRoot.Hex())
 			}
 		}
+		repo.Close()
 		os.Exit(0)
 	}
 
@@ -107,11 +109,13 @@ func run(cmd *cobra.Command, args []string) {
 		targetEnabled = false
 	default:
 		fmt.Fprintf(os.Stderr, "Error: Invalid status %q. Valid values are 'enabled' or 'disabled'\n", newStatus)
+		repo.Close()
 		os.Exit(1)
 	}
 
 	if app.Enabled == targetEnabled && (app.Status != model.ApplicationStatus_Failed || !targetEnabled) {
 		fmt.Printf("Application %s enabled flag is already %t\n", app.Name, app.Enabled)
+		repo.Close()
 		os.Exit(0)
 	}
 
@@ -126,10 +130,12 @@ func run(cmd *cobra.Command, args []string) {
 		confirmed, err := cli.ConfirmPrompt("Proceed?")
 		if err != nil {
 			fmt.Fprintf(os.Stderr, "Error reading input: %v\n", err)
+			repo.Close()
 			os.Exit(1)
 		}
 		if !confirmed {
 			fmt.Println("Aborted.")
+			repo.Close()
 			os.Exit(0)
 		}
 	}

cmd/cartesi-rollups-cli/root/contract/contract.go

@@ -161,7 +161,7 @@ func computeIConsensusV3InterfaceID() [4]byte {
 		if !ok {
 			panic(fmt.Errorf("computeIConsensusV3InterfaceID: method %q not found in IConsensus ABI", name))
 		}
-		if len(m.ID) != 4 {
+		if len(m.ID) != 4 { //nolint:mnd // ABI method selectors are exactly four bytes.
 			panic(fmt.Errorf("computeIConsensusV3InterfaceID: method %q selector is %d bytes, expected 4", name, len(m.ID)))
 		}
 		for i := range 4 {

cmd/cartesi-rollups-cli/root/db/check/check.go

@@ -30,7 +30,7 @@ func init() {
 	})
 }
 
-func run(cmd *cobra.Command, args []string) {
+func run(_ *cobra.Command, _ []string) {
 	dsnURL, err := config.GetDatabaseConnection()
 	cobra.CheckErr(err)
 
@@ -40,13 +40,13 @@ func run(cmd *cobra.Command, args []string) {
 		if err == nil {
 			break
 		}
-		if i == 4 { // nolint: mnd
+		if i == 4 { //nolint:mnd
 			fmt.Fprintf(os.Stderr, "Failed to connect to database. (%s)\n", dsnURL)
 			os.Exit(1)
 		}
 		fmt.Fprintf(os.Stderr, "Connection to database failed. Trying again... (%s)\n", dsnURL)
 		// wait before retrying
-		time.Sleep(5 * time.Second) // nolint: mnd
+		time.Sleep(5 * time.Second) //nolint:mnd
 	}
 	defer s.Close()
 

cmd/cartesi-rollups-cli/root/db/init/init.go

@@ -35,7 +35,7 @@ func init() {
 	})
 }
 
-func run(cmd *cobra.Command, args []string) {
+func run(_ *cobra.Command, _ []string) {
 	var s *schema.Schema
 	var err error
 
@@ -47,13 +47,13 @@ func run(cmd *cobra.Command, args []string) {
 		if err == nil {
 			break
 		}
-		if i == 4 { // nolint: mnd
+		if i == 4 { //nolint:mnd
 			fmt.Fprintf(os.Stderr, "Failed to connect to database. (%s)\n", dsnURL)
 			os.Exit(1)
 		}
 		fmt.Fprintf(os.Stderr, "Connection to database failed. Trying again... (%s)\n", dsnURL)
 		// wait before retrying
-		time.Sleep(5 * time.Second) // nolint: mnd
+		time.Sleep(5 * time.Second) //nolint:mnd
 	}
 	defer s.Close()