cosmos-sdk/x/genutil/client/cli/validate_genesis.go
mergify[bot] f78ed4997f
feat(x/genutil): add better error messages for genesis validation (backport #21701) (#21708)
Co-authored-by: Eric Mokaya <4112301+ziscky@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
2024-09-13 12:43:39 +02:00

79 lines
2.4 KiB
Go

package cli
import (
"encoding/json"
"errors"
"fmt"
"io"
"strings"
"github.com/spf13/cobra"
"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/server"
"github.com/cosmos/cosmos-sdk/types/module"
"github.com/cosmos/cosmos-sdk/x/genutil/types"
)
const chainUpgradeGuide = "https://github.com/cosmos/cosmos-sdk/blob/main/UPGRADING.md"
// ValidateGenesisCmd takes a genesis file, and makes sure that it is valid.
func ValidateGenesisCmd(mbm module.BasicManager) *cobra.Command {
return &cobra.Command{
Use: "validate [file]",
Aliases: []string{"validate-genesis"},
Args: cobra.RangeArgs(0, 1),
Short: "Validates the genesis file at the default location or at the location passed as an arg",
RunE: func(cmd *cobra.Command, args []string) (err error) {
serverCtx := server.GetServerContextFromCmd(cmd)
clientCtx := client.GetClientContextFromCmd(cmd)
cdc := clientCtx.Codec
// Load default if passed no args, otherwise load passed file
var genesis string
if len(args) == 0 {
genesis = serverCtx.Config.GenesisFile()
} else {
genesis = args[0]
}
appGenesis, err := types.AppGenesisFromFile(genesis)
if err != nil {
return enrichUnmarshalError(err)
}
if err := appGenesis.ValidateAndComplete(); err != nil {
return fmt.Errorf("make sure that you have correctly migrated all CometBFT consensus params. Refer the UPGRADING.md (%s): %w", chainUpgradeGuide, err)
}
var genState map[string]json.RawMessage
if err := json.Unmarshal(appGenesis.AppState, &genState); err != nil {
if strings.Contains(err.Error(), "unexpected end of JSON input") {
return fmt.Errorf("app_state is missing in the genesis file: %s", err.Error())
}
return fmt.Errorf("error unmarshalling genesis doc %s: %w", genesis, err)
}
if err = mbm.ValidateGenesis(cdc, clientCtx.TxConfig, genState); err != nil {
errStr := fmt.Sprintf("error validating genesis file %s: %s", genesis, err.Error())
if errors.Is(err, io.EOF) {
errStr = fmt.Sprintf("%s: section is missing in the app_state", errStr)
}
return fmt.Errorf("%s", errStr)
}
fmt.Fprintf(cmd.OutOrStdout(), "File at %s is a valid genesis file\n", genesis)
return nil
},
}
}
func enrichUnmarshalError(err error) error {
var syntaxErr *json.SyntaxError
if errors.As(err, &syntaxErr) {
return fmt.Errorf("error at offset %d: %s", syntaxErr.Offset, syntaxErr.Error())
}
return err
}