cli

package
v0.0.0-...-6828584 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2024 License: Apache-2.0 Imports: 22 Imported by: 5

Documentation

Index

Constants

View Source
const (
	FlagTitle   = "title"
	FlagDeposit = "deposit"

	FlagMetadata  = "metadata"
	FlagSummary   = "summary"
	FlagExpedited = "expedited"

	// Deprecated: only used for v1beta1 legacy proposals.
	FlagProposal = "proposal"
	// Deprecated: only used for v1beta1 legacy proposals.
	FlagDescription = "description"
	// Deprecated: only used for v1beta1 legacy proposals.
	FlagProposalType = "type"
)

Proposal flags

Variables

View Source
var ProposalFlags = []string{
	FlagTitle,
	FlagDescription,
	FlagProposalType,
	FlagDeposit,
}

ProposalFlags defines the core required fields of a legacy proposal. It is used to verify that these values are not provided in conjunction with a JSON proposal file.

Functions

func AddGovPropFlagsToCmd

func AddGovPropFlagsToCmd(cmd *cobra.Command)

AddGovPropFlagsToCmd adds flags for defining MsgSubmitProposal fields.

See also ReadGovPropFlags.

func NewCmdDraftProposal

func NewCmdDraftProposal() *cobra.Command

NewCmdDraftProposal let a user generate a draft proposal.

func NewCmdSubmitLegacyProposal

func NewCmdSubmitLegacyProposal() *cobra.Command

NewCmdSubmitLegacyProposal implements submitting a proposal transaction command. Deprecated: please use NewCmdSubmitProposal instead.

func NewCmdSubmitProposal

func NewCmdSubmitProposal() *cobra.Command

NewCmdSubmitProposal implements submitting a proposal transaction command.

func NewCmdWeightedVote

func NewCmdWeightedVote() *cobra.Command

NewCmdWeightedVote implements creating a new weighted vote command. TODO(@julienrbrt): remove this once AutoCLI can flatten nested structs.

func NewTxCmd

func NewTxCmd(legacyPropCmds []*cobra.Command) *cobra.Command

NewTxCmd returns the transaction commands for this module governance ModuleClient is slightly different from other ModuleClients in that it contains a slice of legacy "proposal" child commands. These commands are respective to the proposal type handlers that are implemented in other modules but are mounted under the governance CLI (eg. parameter change proposals).

func Prompt

func Prompt[T any](data T, namePrefix string, addressCodec address.Codec) (T, error)

Prompt prompts the user for all values of the given type. data is the struct to be filled namePrefix is the name to be displayed as "Enter <namePrefix> <field>" TODO: when bringing this in autocli, use proto message instead this will simplify the get address logic

func PromptMetadata

func PromptMetadata(skip bool, addressCodec address.Codec) (types.ProposalMetadata, error)

PromptMetadata prompts for proposal metadata or only title and summary if skip is true

func ReadGovPropCmdFlags

func ReadGovPropCmdFlags(proposer string, flagSet *pflag.FlagSet) (*govv1.MsgSubmitProposal, error)

ReadGovPropCmdFlags parses a MsgSubmitProposal from the provided context and flags. Setting the messages is up to the caller.

See also AddGovPropFlagsToCmd.

func ReadGovPropFlags

func ReadGovPropFlags(clientCtx client.Context, flagSet *pflag.FlagSet) (*govv1.MsgSubmitProposal, error)

ReadGovPropFlags parses a MsgSubmitProposal from the provided context and flags. Setting the messages is up to the caller.

See also AddGovPropFlagsToCmd. Deprecated: use ReadPropCmdFlags instead, as this depends on global bech32 prefixes.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL