cmd.go

// Package cmd provides the cli for running the halo consensus client.
package cmd

import (
	"context"
	"os"

	"github.com/omni-network/omni/halo/app"
	halocfg "github.com/omni-network/omni/halo/config"
	"github.com/omni-network/omni/lib/buildinfo"
	libcmd "github.com/omni-network/omni/lib/cmd"
	"github.com/omni-network/omni/lib/errors"
	"github.com/omni-network/omni/lib/log"

	cmtcfg "github.com/cometbft/cometbft/config"

	"github.com/spf13/cobra"
)

// New returns a new root cobra command that handles our command line tool.
func New() *cobra.Command {
	return libcmd.NewRootCmd(
		"halo",
		"Halo is a consensus client implementation for the Omni Protocol",
		newRunCmd("run", app.Run),
		newInitCmd(),
		newRollbackCmd(),
		buildinfo.NewVersionCmd(),
		newConsKeyCmd(),
		newStatusCmd(),
		newReadyCmd(),
	)
}

// newRunCmd returns a new cobra command that runs the halo consensus client.
func newRunCmd(name string, runFunc func(context.Context, app.Config) error) *cobra.Command {
	haloCfg := halocfg.DefaultConfig()
	logCfg := log.DefaultConfig()

	cmd := &cobra.Command{
		Use:   name,
		Short: "Runs the halo consensus client",
		RunE: func(cmd *cobra.Command, _ []string) error {
			ctx, err := log.Init(cmd.Context(), logCfg)
			if err != nil {
				return err
			}
			if err := libcmd.LogFlags(ctx, cmd.Flags()); err != nil {
				return err
			}

			cometCfg, err := parseCometConfig(ctx, haloCfg.HomeDir)
			if err != nil {
				return err
			}

			return runFunc(ctx, app.Config{
				Config: haloCfg,
				Comet:  cometCfg,
			})
		},
	}

	bindRunFlags(cmd, &haloCfg)
	log.BindFlags(cmd.Flags(), &logCfg)

	return cmd
}

func newRollbackCmd() *cobra.Command {
	logCfg := log.DefaultConfig()
	haloCfg := halocfg.DefaultConfig()
	rollCfg := app.DefaultRollbackConfig()

	cmd := &cobra.Command{
		Use:   "rollback",
		Short: "Rollback Cosmos SDK and CometBFT state by one height",
		Long: `
A state rollback is performed to recover from an incorrect application state transition,
when CometBFT has persisted an incorrect app hash and is thus unable to make
progress. Rollback overwrites a state at height n with the state at height n - 1.
The application also rolls back to height n - 1. Upon restarting the transactions
in block n will be re-executed against the application. If --hard=true, the block
itself will also be deleted and re-downloaded from the p2p network. Note that a
different block N cannot be re-built/re-proposed since that would result in validator slashing.
`,
		RunE: func(cmd *cobra.Command, _ []string) error {
			ctx, err := log.Init(cmd.Context(), logCfg)
			if err != nil {
				return err
			}
			if err := libcmd.LogFlags(ctx, cmd.Flags()); err != nil {
				return err
			}

			cmtCfg, err := parseCometConfig(ctx, haloCfg.HomeDir)
			if err != nil {
				return err
			}

			appCfg := app.Config{
				Config: haloCfg,
				Comet:  cmtCfg,
			}

			return app.Rollback(ctx, appCfg, rollCfg)
		},
	}

	bindRunFlags(cmd, &haloCfg)
	bindRollbackFlags(cmd.Flags(), &rollCfg)
	log.BindFlags(cmd.Flags(), &logCfg)

	return cmd
}

func newConsKeyCmd() *cobra.Command {
	home := halocfg.DefaultConfig().HomeDir

	cmd := &cobra.Command{
		Use:   "consensus-pubkey",
		Short: "Print the consensus public key",
		Long: "Print the consensus public key of the node used for CometBFT consensus and cross-chain attestations in 33 byte compressed hex format." +
			"This is equivalent to: cat halo/config/priv_validator_key.json | jq -r .pub_key.value | base64 -d | xxd -ps -c33",
		RunE: func(cmd *cobra.Command, _ []string) error {
			cfg := cmtcfg.DefaultConfig()
			cfg.RootDir = home

			file := cfg.PrivValidatorKeyFile()
			if _, err := os.Stat(file); err != nil {
				return errors.Wrap(err, "<home>/config/priv_validator_key.json not found", "file", file)
			}

			key, err := app.LoadCometFilePV(file)
			if err != nil {
				return errors.Wrap(err, "load comet file priv validator", "file", file)
			}

			cmd.Printf("Consensus public key: %x\n", key.PubKey().Bytes())

			return nil
		},
	}

	libcmd.BindHomeFlag(cmd.Flags(), &home)

	return cmd
}