431 lines
12 KiB
Go
431 lines
12 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
flag "github.com/spf13/pflag"
|
|
|
|
"cosmossdk.io/core/address"
|
|
errorsmod "cosmossdk.io/errors"
|
|
"cosmossdk.io/math"
|
|
"cosmossdk.io/x/staking/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client"
|
|
"github.com/cosmos/cosmos-sdk/client/flags"
|
|
"github.com/cosmos/cosmos-sdk/client/tx"
|
|
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
"github.com/cosmos/cosmos-sdk/version"
|
|
)
|
|
|
|
// default values
|
|
var (
|
|
DefaultTokens = sdk.TokensFromConsensusPower(100, sdk.DefaultPowerReduction)
|
|
defaultAmount = DefaultTokens.String() + sdk.DefaultBondDenom
|
|
defaultCommissionRate = "0.1"
|
|
defaultCommissionMaxRate = "0.2"
|
|
defaultCommissionMaxChangeRate = "0.01"
|
|
defaultMinSelfDelegation = "1"
|
|
)
|
|
|
|
// NewTxCmd returns a root CLI command handler for all x/staking transaction commands.
|
|
func NewTxCmd() *cobra.Command {
|
|
stakingTxCmd := &cobra.Command{
|
|
Use: types.ModuleName,
|
|
Short: "Staking transaction subcommands",
|
|
DisableFlagParsing: true,
|
|
SuggestionsMinimumDistance: 2,
|
|
RunE: client.ValidateCmd,
|
|
}
|
|
|
|
stakingTxCmd.AddCommand(
|
|
NewCreateValidatorCmd(),
|
|
NewEditValidatorCmd(),
|
|
)
|
|
|
|
return stakingTxCmd
|
|
}
|
|
|
|
// NewCreateValidatorCmd returns a CLI command handler for creating a MsgCreateValidator transaction.
|
|
// TODO(@julienrbrt): remove this once AutoCLI can flatten nested structs.
|
|
func NewCreateValidatorCmd() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "create-validator [path/to/validator.json]",
|
|
Short: "Create new validator initialized with a self-delegation to it",
|
|
Args: cobra.ExactArgs(1),
|
|
Long: `Create a new validator initialized with a self-delegation by submitting a JSON file with the new validator details.`,
|
|
Example: strings.TrimSpace(
|
|
fmt.Sprintf(`
|
|
$ %s tx staking create-validator path/to/validator.json --from keyname
|
|
|
|
Where validator.json contains:
|
|
|
|
{
|
|
"pubkey": {"@type":"/cosmos.crypto.ed25519.PubKey","key":"oWg2ISpLF405Jcm2vXV+2v4fnjodh6aafuIdeoW+rUw="},
|
|
"amount": "1000000stake",
|
|
"moniker": "myvalidator",
|
|
"identity": "optional identity signature (ex. UPort or Keybase)",
|
|
"website": "validator's (optional) website",
|
|
"security": "validator's (optional) security contact email",
|
|
"details": "validator's (optional) details",
|
|
"commission-rate": "0.1",
|
|
"commission-max-rate": "0.2",
|
|
"commission-max-change-rate": "0.01",
|
|
"min-self-delegation": "1"
|
|
}
|
|
|
|
where we can get the pubkey using "%s tendermint show-validator"
|
|
`, version.AppName, version.AppName)),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
clientCtx, err := client.GetClientTxContext(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
txf, err := tx.NewFactoryCLI(clientCtx, cmd.Flags())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
validator, err := parseAndValidateValidatorJSON(clientCtx.Codec, args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
txf, msg, err := newBuildCreateValidatorMsg(clientCtx, txf, cmd.Flags(), validator, clientCtx.ValidatorAddressCodec)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return tx.GenerateOrBroadcastTxWithFactory(clientCtx, txf, msg)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().String(FlagIP, "", fmt.Sprintf("The node's public IP. It takes effect only when used in combination with --%s", flags.FlagGenerateOnly))
|
|
cmd.Flags().String(FlagNodeID, "", "The node's ID")
|
|
flags.AddTxFlagsToCmd(cmd)
|
|
|
|
return cmd
|
|
}
|
|
|
|
// NewEditValidatorCmd returns a CLI command handler for creating a MsgEditValidator transaction.
|
|
// TODO(@julienrbrt): remove this once AutoCLI can flatten nested structs.
|
|
func NewEditValidatorCmd() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "edit-validator",
|
|
Short: "Edit an existing validator account",
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
clientCtx, err := client.GetClientTxContext(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
moniker, _ := cmd.Flags().GetString(FlagEditMoniker)
|
|
identity, _ := cmd.Flags().GetString(FlagIdentity)
|
|
website, _ := cmd.Flags().GetString(FlagWebsite)
|
|
security, _ := cmd.Flags().GetString(FlagSecurityContact)
|
|
details, _ := cmd.Flags().GetString(FlagDetails)
|
|
description := types.NewDescription(moniker, identity, website, security, details)
|
|
|
|
var newRate *math.LegacyDec
|
|
|
|
commissionRate, _ := cmd.Flags().GetString(FlagCommissionRate)
|
|
if commissionRate != "" {
|
|
rate, err := math.LegacyNewDecFromStr(commissionRate)
|
|
if err != nil {
|
|
return fmt.Errorf("invalid new commission rate: %w", err)
|
|
}
|
|
|
|
newRate = &rate
|
|
}
|
|
|
|
var newMinSelfDelegation *math.Int
|
|
|
|
minSelfDelegationString, _ := cmd.Flags().GetString(FlagMinSelfDelegation)
|
|
if minSelfDelegationString != "" {
|
|
msb, ok := math.NewIntFromString(minSelfDelegationString)
|
|
if !ok {
|
|
return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "minimum self delegation must be a positive integer")
|
|
}
|
|
|
|
newMinSelfDelegation = &msb
|
|
}
|
|
|
|
valAddr, err := clientCtx.ValidatorAddressCodec.BytesToString(clientCtx.GetFromAddress())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
msg := types.NewMsgEditValidator(valAddr, description, newRate, newMinSelfDelegation)
|
|
|
|
return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().AddFlagSet(flagSetDescriptionEdit())
|
|
cmd.Flags().AddFlagSet(flagSetCommissionUpdate())
|
|
cmd.Flags().AddFlagSet(FlagSetMinSelfDelegation())
|
|
flags.AddTxFlagsToCmd(cmd)
|
|
|
|
return cmd
|
|
}
|
|
|
|
func newBuildCreateValidatorMsg(clientCtx client.Context, txf tx.Factory, fs *flag.FlagSet, val validator, valAc address.Codec) (tx.Factory, *types.MsgCreateValidator, error) {
|
|
valAddr := clientCtx.GetFromAddress()
|
|
|
|
description := types.NewDescription(
|
|
val.Moniker,
|
|
val.Identity,
|
|
val.Website,
|
|
val.Security,
|
|
val.Details,
|
|
)
|
|
|
|
valStr, err := valAc.BytesToString(sdk.ValAddress(valAddr))
|
|
if err != nil {
|
|
return txf, nil, err
|
|
}
|
|
msg, err := types.NewMsgCreateValidator(
|
|
valStr, val.PubKey, val.Amount, description, val.CommissionRates, val.MinSelfDelegation,
|
|
)
|
|
if err != nil {
|
|
return txf, nil, err
|
|
}
|
|
if err := msg.Validate(valAc); err != nil {
|
|
return txf, nil, err
|
|
}
|
|
|
|
genOnly, _ := fs.GetBool(flags.FlagGenerateOnly)
|
|
if genOnly {
|
|
ip, _ := fs.GetString(FlagIP)
|
|
p2pPort, _ := fs.GetUint(FlagP2PPort)
|
|
nodeID, _ := fs.GetString(FlagNodeID)
|
|
|
|
if nodeID != "" && ip != "" && p2pPort > 0 {
|
|
txf = txf.WithMemo(fmt.Sprintf("%s@%s:%d", nodeID, ip, p2pPort))
|
|
}
|
|
}
|
|
|
|
return txf, msg, nil
|
|
}
|
|
|
|
// Return the flagset, particular flags, and a description of defaults
|
|
// this is anticipated to be used with the gen-tx
|
|
func CreateValidatorMsgFlagSet(ipDefault string) (fs *flag.FlagSet, defaultsDesc string) {
|
|
fsCreateValidator := flag.NewFlagSet("", flag.ContinueOnError)
|
|
fsCreateValidator.String(FlagIP, ipDefault, "The node's public P2P IP")
|
|
fsCreateValidator.Uint(FlagP2PPort, 26656, "The node's public P2P port")
|
|
fsCreateValidator.String(FlagNodeID, "", "The node's NodeID")
|
|
fsCreateValidator.String(FlagMoniker, "", "The validator's (optional) moniker")
|
|
fsCreateValidator.String(FlagWebsite, "", "The validator's (optional) website")
|
|
fsCreateValidator.String(FlagSecurityContact, "", "The validator's (optional) security contact email")
|
|
fsCreateValidator.String(FlagDetails, "", "The validator's (optional) details")
|
|
fsCreateValidator.String(FlagIdentity, "", "The (optional) identity signature (ex. UPort or Keybase)")
|
|
fsCreateValidator.AddFlagSet(FlagSetCommissionCreate())
|
|
fsCreateValidator.AddFlagSet(FlagSetMinSelfDelegation())
|
|
fsCreateValidator.AddFlagSet(FlagSetAmount())
|
|
fsCreateValidator.AddFlagSet(FlagSetPublicKey())
|
|
|
|
defaultsDesc = fmt.Sprintf(`
|
|
delegation amount: %s
|
|
commission rate: %s
|
|
commission max rate: %s
|
|
commission max change rate: %s
|
|
minimum self delegation: %s
|
|
`, defaultAmount, defaultCommissionRate,
|
|
defaultCommissionMaxRate, defaultCommissionMaxChangeRate,
|
|
defaultMinSelfDelegation)
|
|
|
|
return fsCreateValidator, defaultsDesc
|
|
}
|
|
|
|
type TxCreateValidatorConfig struct {
|
|
ChainID string
|
|
NodeID string
|
|
Moniker string
|
|
|
|
Amount string
|
|
|
|
CommissionRate string
|
|
CommissionMaxRate string
|
|
CommissionMaxChangeRate string
|
|
MinSelfDelegation string
|
|
|
|
PubKey cryptotypes.PubKey
|
|
|
|
IP string
|
|
P2PPort uint
|
|
Website string
|
|
SecurityContact string
|
|
Details string
|
|
Identity string
|
|
}
|
|
|
|
func PrepareConfigForTxCreateValidator(flagSet *flag.FlagSet, moniker, nodeID, chainID string, valPubKey cryptotypes.PubKey) (TxCreateValidatorConfig, error) {
|
|
c := TxCreateValidatorConfig{}
|
|
|
|
ip, err := flagSet.GetString(FlagIP)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
if ip == "" {
|
|
_, _ = fmt.Fprintf(os.Stderr, "failed to retrieve an external IP; the tx's memo field will be unset")
|
|
}
|
|
|
|
p2pPort, err := flagSet.GetUint(FlagP2PPort)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
website, err := flagSet.GetString(FlagWebsite)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
securityContact, err := flagSet.GetString(FlagSecurityContact)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
details, err := flagSet.GetString(FlagDetails)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
identity, err := flagSet.GetString(FlagIdentity)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
c.Amount, err = flagSet.GetString(FlagAmount)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
c.CommissionRate, err = flagSet.GetString(FlagCommissionRate)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
c.CommissionMaxRate, err = flagSet.GetString(FlagCommissionMaxRate)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
c.CommissionMaxChangeRate, err = flagSet.GetString(FlagCommissionMaxChangeRate)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
c.MinSelfDelegation, err = flagSet.GetString(FlagMinSelfDelegation)
|
|
if err != nil {
|
|
return c, err
|
|
}
|
|
|
|
c.IP = ip
|
|
c.P2PPort = p2pPort
|
|
c.Website = website
|
|
c.SecurityContact = securityContact
|
|
c.Identity = identity
|
|
c.NodeID = nodeID
|
|
c.PubKey = valPubKey
|
|
c.Website = website
|
|
c.SecurityContact = securityContact
|
|
c.Details = details
|
|
c.Identity = identity
|
|
c.ChainID = chainID
|
|
c.Moniker = moniker
|
|
|
|
if c.Amount == "" {
|
|
c.Amount = defaultAmount
|
|
}
|
|
|
|
if c.CommissionRate == "" {
|
|
c.CommissionRate = defaultCommissionRate
|
|
}
|
|
|
|
if c.CommissionMaxRate == "" {
|
|
c.CommissionMaxRate = defaultCommissionMaxRate
|
|
}
|
|
|
|
if c.CommissionMaxChangeRate == "" {
|
|
c.CommissionMaxChangeRate = defaultCommissionMaxChangeRate
|
|
}
|
|
|
|
if c.MinSelfDelegation == "" {
|
|
c.MinSelfDelegation = defaultMinSelfDelegation
|
|
}
|
|
|
|
return c, nil
|
|
}
|
|
|
|
// BuildCreateValidatorMsg makes a new MsgCreateValidator.
|
|
func BuildCreateValidatorMsg(clientCtx client.Context, config TxCreateValidatorConfig, txBldr tx.Factory, generateOnly bool) (tx.Factory, sdk.Msg, error) {
|
|
amounstStr := config.Amount
|
|
amount, err := sdk.ParseCoinNormalized(amounstStr)
|
|
if err != nil {
|
|
return txBldr, nil, err
|
|
}
|
|
|
|
valAddr := clientCtx.GetFromAddress()
|
|
description := types.NewDescription(
|
|
config.Moniker,
|
|
config.Identity,
|
|
config.Website,
|
|
config.SecurityContact,
|
|
config.Details,
|
|
)
|
|
|
|
// get the initial validator commission parameters
|
|
rateStr := config.CommissionRate
|
|
maxRateStr := config.CommissionMaxRate
|
|
maxChangeRateStr := config.CommissionMaxChangeRate
|
|
commissionRates, err := buildCommissionRates(rateStr, maxRateStr, maxChangeRateStr)
|
|
if err != nil {
|
|
return txBldr, nil, err
|
|
}
|
|
|
|
// get the initial validator min self delegation
|
|
msbStr := config.MinSelfDelegation
|
|
minSelfDelegation, ok := math.NewIntFromString(msbStr)
|
|
|
|
if !ok {
|
|
return txBldr, nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "minimum self delegation must be a positive integer")
|
|
}
|
|
|
|
valCodec := clientCtx.TxConfig.SigningContext().ValidatorAddressCodec()
|
|
valStr, err := valCodec.BytesToString(valAddr)
|
|
if err != nil {
|
|
return txBldr, nil, err
|
|
}
|
|
|
|
msg, err := types.NewMsgCreateValidator(
|
|
valStr,
|
|
config.PubKey,
|
|
amount,
|
|
description,
|
|
commissionRates,
|
|
minSelfDelegation,
|
|
)
|
|
if err != nil {
|
|
return txBldr, msg, err
|
|
}
|
|
|
|
if generateOnly {
|
|
ip := config.IP
|
|
p2pPort := config.P2PPort
|
|
nodeID := config.NodeID
|
|
|
|
if nodeID != "" && ip != "" && p2pPort > 0 {
|
|
txBldr = txBldr.WithMemo(fmt.Sprintf("%s@%s:%d", nodeID, ip, p2pPort))
|
|
}
|
|
}
|
|
|
|
return txBldr, msg, nil
|
|
}
|