Merge pull request #183 from algorandfoundation/release/v1.5.0

Release/v1.5.0

Author: nullun

api/catchpoint.go

@@ -16,7 +16,7 @@ const (
 	MainNet CatchPointUrl = "https://algorand-catchpoints.s3.us-east-2.amazonaws.com/channel/mainnet/latest.catchpoint"
 )
 
-const InvalidNetworkParamMsg = "invalid network"
+var ErrInvalidNetwork = errors.New("invalid network")
 
 type LatestCatchpointResponse struct {
 	HTTPResponse   *http.Response
@@ -45,9 +45,8 @@ func GetLatestCatchpointWithResponse(http HttpPkgInterface, network string) (Lat
 		url = TestNet
 	case "mainnet-v1.0", "mainnet":
 		url = MainNet
-	}
-	if url == "" {
-		return response, errors.New(InvalidNetworkParamMsg)
+	default:
+		return response, ErrInvalidNetwork
 	}
 	res, err := http.Get(string(url))
 	response.HTTPResponse = res

cmd/bootstrap.go

@@ -3,6 +3,8 @@ package cmd
 import (
 	"context"
 	"fmt"
+	"time"
+
 	"github.com/algorandfoundation/nodekit/api"
 	"github.com/algorandfoundation/nodekit/cmd/utils/explanations"
 	"github.com/algorandfoundation/nodekit/internal/algod"
@@ -15,7 +17,6 @@ import (
 	"github.com/charmbracelet/lipgloss"
 	"github.com/charmbracelet/log"
 	"github.com/spf13/cobra"
-	"time"
 )
 
 const CheckAlgodInterval = 10 * time.Second
@@ -60,9 +61,9 @@ var bootstrapCmd = &cobra.Command{
 		model := bootstrap.NewModel()
 		log.Warn(style.Yellow.Render(explanations.SudoWarningMsg))
 		// Try to launch the TUI if it's already running and configured
-		if algod.IsInitialized() {
+		if algod.IsInitialized(algodData) {
 			// Parse the data directory
-			dir, err := algod.GetDataDir("")
+			dir, err := algod.GetDataDir(algodData)
 			if err != nil {
 				log.Fatal(err)
 			}
@@ -97,7 +98,7 @@ var bootstrapCmd = &cobra.Command{
 
 		// Exit the application in an invalid state
 		if algod.IsInstalled() && !algod.IsService() {
-			dataDir, _ := algod.GetDataDir("")
+			dataDir, _ := algod.GetDataDir(algodData)
 			if dataDir == "" {
 				dataDir = "<Path to data directory>"
 			}
@@ -119,7 +120,7 @@ var bootstrapCmd = &cobra.Command{
 
 		// Ensure it the service is started,
 		// in this case we won't be able to query state without the node running
-		if algod.IsInstalled() && algod.IsService() && !algod.IsRunning() {
+		if algod.IsInstalled() && algod.IsService() && !algod.IsRunning(algodData) {
 			log.Debug("Algorand is installed, but not running. Attempting to start it automatically.")
 			log.Warn(style.Yellow.Render(explanations.SudoWarningMsg))
 			err := algod.Start()
@@ -168,7 +169,7 @@ var bootstrapCmd = &cobra.Command{
 			}
 		} else {
 			// This should not happen but just in case, ensure it is running
-			if !algod.IsRunning() {
+			if !algod.IsRunning(algodData) {
 				log.Info(style.Green.Render("Starting Algod 🚀"))
 				err := algod.Start()
 				if err != nil {
@@ -178,7 +179,7 @@ var bootstrapCmd = &cobra.Command{
 		}
 
 		// Parse the data directory
-		dataDir, err := algod.GetDataDir("")
+		dataDir, err := algod.GetDataDir(algodData)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -189,7 +190,7 @@ var bootstrapCmd = &cobra.Command{
 			log.Fatal(err)
 		}
 
-		if !algod.IsRunning() {
+		if !algod.IsRunning(algodData) {
 			log.Fatal("algod is not running. Something went wrong with installation")
 		}
 
@@ -205,7 +206,7 @@ var bootstrapCmd = &cobra.Command{
 			}
 			// Get the latest catchpoint
 			catchpoint, _, err := algod.GetLatestCatchpoint(httpPkg, network)
-			if err != nil && err.Error() == api.InvalidNetworkParamMsg {
+			if err != nil && err == api.ErrInvalidNetwork {
 				log.Fatal("This network does not support fast-catchup.")
 			} else {
 				log.Info(style.Green.Render("Latest Catchpoint: " + catchpoint))

cmd/catchup/debug.go

@@ -66,7 +66,7 @@ var debugCmd = utils.WithAlgodFlags(&cobra.Command{
 
 		var isSupported bool
 		catchpoint, _, err := algod.GetLatestCatchpoint(httpPkg, status.Network)
-		if err != nil && err.Error() == api.InvalidNetworkParamMsg {
+		if err != nil && err == api.ErrInvalidNetwork {
 			isSupported = false
 		} else {
 			isSupported = true

cmd/catchup/start.go

@@ -46,7 +46,7 @@ var startCmd = utils.WithAlgodFlags(&cobra.Command{
 
 		// Get the latest catchpoint
 		catchpoint, _, err := algod.GetLatestCatchpoint(httpPkg, status.Network)
-		if err != nil && err.Error() == api.InvalidNetworkParamMsg {
+		if err != nil && err == api.ErrInvalidNetwork {
 			log.Fatal("This network does not support fast-catchup.")
 		} else {
 			log.Info(style.Green.Render("Latest Catchpoint: " + catchpoint))

cmd/configure/algod.go

@@ -0,0 +1,138 @@
+package configure
+
+import (
+	"fmt"
+	"time"
+
+	cmdutils "github.com/algorandfoundation/nodekit/cmd/utils"
+	"github.com/algorandfoundation/nodekit/cmd/utils/explanations"
+	"github.com/algorandfoundation/nodekit/internal/algod"
+	"github.com/algorandfoundation/nodekit/internal/algod/config"
+	"github.com/algorandfoundation/nodekit/internal/algod/utils"
+	"github.com/algorandfoundation/nodekit/ui/style"
+	"github.com/charmbracelet/lipgloss"
+	"github.com/charmbracelet/lipgloss/table"
+	"github.com/charmbracelet/log"
+	"github.com/spf13/cobra"
+)
+
+var enableHybrid bool
+
+// algodShort provides a brief description of the algod command, emphasizing its role in installing algod files.
+var algodShort = "Configure options for the Algorand daemon."
+
+// algodLong provides a detailed description of the algod command, its purpose, and an experimental warning note.
+var algodLong = lipgloss.JoinVertical(
+	lipgloss.Left,
+	style.Purple(style.BANNER),
+	"",
+	style.Bold(algodShort),
+	"",
+	style.BoldUnderline("Overview:"),
+	"Modify various configuration options available for the Algorand daemon.",
+)
+
+// TODO: Check if we should enforce sudo for this.
+// algodCmd is a Cobra command for managing Algorand configuration
+var algodCmd = cmdutils.WithAlgodFlags(&cobra.Command{
+	Use:   "algod",
+	Short: algodShort,
+	Long:  algodLong,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		dataDir, err := algod.GetDataDir(algodData)
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		// Current Node Configuration
+		currentConfig, _ := utils.GetConfigFromDataDir(dataDir)
+
+		// OR (`||`) additional flags for `hasFlags` when adding something new.
+		hasHybrid := cmd.Flags().Lookup("hybrid").Changed
+		hasFlags := hasHybrid
+
+		restartRequired := false
+
+		// Are we doing something? If not, just display the current configuration.
+		if hasFlags {
+			newConfig := &config.Config{
+				// EnableP2PHybridMode: currentConfig.EnableP2PHybridMode,
+			}
+
+			if hasHybrid {
+				newConfig.EnableP2PHybridMode = &enableHybrid
+			}
+
+			mergedConfig := config.MergeAlgodConfigs(*currentConfig, *newConfig)
+			if currentConfig.IsEqual(mergedConfig) {
+				log.Debug("Configuration up to date, nothing to do")
+			} else {
+				err := utils.WriteConfigToDataDir(dataDir, &mergedConfig)
+				if err != nil {
+					log.Warnf("%s", err)
+					log.Fatalf("%s", explanations.AlgorandPermissionErrorMsg)
+				}
+				restartRequired = true
+			}
+
+		} else {
+
+			hybridModeStatus := "Disabled"
+			if currentConfig.EnableP2PHybridMode != nil && *currentConfig.EnableP2PHybridMode {
+				hybridModeStatus = "Enabled"
+			}
+
+			rows := [][]string{
+				{"EnableP2PHybridMode:", hybridModeStatus},
+			}
+
+			var (
+				cellStyle      = lipgloss.NewStyle().Padding(0)
+				optionRowStyle = cellStyle.Align(lipgloss.Right)
+				valueRowStyle  = cellStyle.Align(lipgloss.Left)
+			)
+
+			configurationTable := table.New().
+				Border(lipgloss.HiddenBorder()).
+				StyleFunc(func(row, col int) lipgloss.Style {
+					if col == 0 {
+						return optionRowStyle
+					}
+					return valueRowStyle
+				}).
+				Rows(rows...)
+
+			currentConfiguration := lipgloss.JoinVertical(
+				lipgloss.Left,
+				style.BoldUnderline("Current Configuration:"),
+				configurationTable.String(),
+			)
+
+			fmt.Println(currentConfiguration)
+		}
+
+		if restartRequired {
+			log.Debug("Restarting node...")
+			err = algod.Stop()
+			if err != nil {
+				log.Fatal(err)
+			}
+
+			// Wait 1 second.
+			// Calling stop & start too quickly on Mac (launchctl) appears to
+			// result in a false successfully start. Haven't investigated why.
+			time.Sleep(1 * time.Second)
+
+			err = algod.Start()
+			if err != nil {
+				log.Fatal(err)
+			}
+			log.Debug("Node restarted successfully.")
+		}
+		return nil
+	},
+}, &algodData)
+
+func init() {
+	algodCmd.Flags().BoolVar(&enableHybrid, "hybrid", true, "Enable or Disable P2P Hybrid Mode")
+}

cmd/configure/configure.go

@@ -3,17 +3,17 @@ package configure
 import (
 	"bytes"
 	"fmt"
-	"github.com/algorandfoundation/nodekit/cmd/utils/explanations"
-	"github.com/algorandfoundation/nodekit/internal/algod"
-	"github.com/algorandfoundation/nodekit/internal/algod/utils"
-	"github.com/algorandfoundation/nodekit/ui/style"
-	"github.com/charmbracelet/lipgloss"
 	"os"
 	"os/exec"
 	"runtime"
 	"strings"
 	"text/template"
 
+	"github.com/algorandfoundation/nodekit/cmd/utils/explanations"
+	"github.com/algorandfoundation/nodekit/internal/algod"
+	"github.com/algorandfoundation/nodekit/internal/algod/utils"
+	"github.com/algorandfoundation/nodekit/ui/style"
+	"github.com/charmbracelet/lipgloss"
 	"github.com/spf13/cobra"
 )
 
@@ -33,6 +33,8 @@ var long = lipgloss.JoinVertical(
 	style.Yellow.Render(explanations.ExperimentalWarning),
 )
 
+var algodData = ""
+
 var Cmd = &cobra.Command{
 	Use:   "configure",
 	Short: short,
@@ -42,6 +44,7 @@ var Cmd = &cobra.Command{
 func init() {
 	Cmd.AddCommand(serviceCmd)
 	Cmd.AddCommand(telemetryCmd)
+	Cmd.AddCommand(algodCmd)
 }
 
 const RunningErrorMsg = "algorand is currently running. Please stop the node with *node stop* before configuring"
@@ -50,7 +53,7 @@ const RunningErrorMsg = "algorand is currently running. Please stop the node wit
 func configureNode() error {
 	var systemServiceConfigure bool
 
-	if algod.IsRunning() {
+	if algod.IsRunning(algodData) {
 		return fmt.Errorf(RunningErrorMsg)
 	}
 
@@ -140,9 +143,7 @@ func configureNode() error {
 				}
 				os.Exit(0)
 			}
-
 		} else {
-
 			if promptWrapperYes("Do you want to set one of these directories as the new data directory? (y/N)") {
 
 				selectedPath := promptWrapperSelection("Select an Algorand data directory", paths)
@@ -200,7 +201,6 @@ func editAlgorandServiceFile(dataDirectoryPath string) {
 }
 
 func editLaunchdAlgorandServiceFile(dataDirectoryPath string) {
-
 	algodPath, err := exec.LookPath("algod")
 	if err != nil {
 		fmt.Printf("Failed to find algod binary: %v\n", err)
@@ -253,7 +253,7 @@ func editLaunchdAlgorandServiceFile(dataDirectoryPath string) {
 	}
 
 	// Write the override content to the file
-	err = os.WriteFile(overwriteFilePath, overwriteContent.Bytes(), 0644)
+	err = os.WriteFile(overwriteFilePath, overwriteContent.Bytes(), 0o644)
 	if err != nil {
 		fmt.Printf("Failed to write override file: %v\n", err)
 		os.Exit(1)
@@ -282,7 +282,6 @@ func editLaunchdAlgorandServiceFile(dataDirectoryPath string) {
 
 // Update the algorand.service file
 func editSystemdAlgorandServiceFile(dataDirectoryPath string) {
-
 	algodPath, err := exec.LookPath("algod")
 	if err != nil {
 		fmt.Printf("Failed to find algod binary: %v\n", err)
@@ -294,7 +293,7 @@ func editSystemdAlgorandServiceFile(dataDirectoryPath string) {
 	overrideFilePath := "/etc/systemd/system/algorand.service.d/override.conf"
 
 	// Create the override directory if it doesn't exist
-	err = os.MkdirAll("/etc/systemd/system/algorand.service.d", 0755)
+	err = os.MkdirAll("/etc/systemd/system/algorand.service.d", 0o755)
 	if err != nil {
 		fmt.Printf("Failed to create override directory: %v\n", err)
 		os.Exit(1)
@@ -328,7 +327,7 @@ ExecStart={{.AlgodPath}} -d {{.DataDirectoryPath}}`
 	}
 
 	// Write the override content to the file
-	err = os.WriteFile(overrideFilePath, overrideContent.Bytes(), 0644)
+	err = os.WriteFile(overrideFilePath, overrideContent.Bytes(), 0o644)
 	if err != nil {
 		fmt.Printf("Failed to write override file: %v\n", err)
 		os.Exit(1)