R4R: CLI UX Updates #1

PENDING.md

@@ -8,9 +8,12 @@ BREAKING CHANGES
 * Gaia CLI  (`gaiacli`)
     * [x/stake] Validator.Owner renamed to Validator.Operator
     * [cli] unsafe_reset_all, show_validator, and show_node_id have been renamed to unsafe-reset-all, show-validator, and show-node-id
+    * [cli] \#1983 --print-response now defaults to true in commands that create and send a transaction
+    * [cli] \#1983 you can now pass --pubkey or --address to gaiacli keys show to return a plaintext representation of the key's address or public key for use with other commands
     * [cli] \#2061 changed proposalID in governance REST endpoints to proposal-id
     * [cli] \#2014 `gaiacli advanced` no longer exists - to access `ibc`, `rest-server`, and `validator-set` commands use `gaiacli ibc`, `gaiacli rest-server`, and `gaiacli tendermint`, respectively
 
+
 * Gaia
     * Make the transient store key use a distinct store key. [#2013](https://github.com/cosmos/cosmos-sdk/pull/2013)
     * [x/stake] \#1901 Validator type's Owner field renamed to Operator; Validator's GetOwner() renamed accordingly to comply with the SDK's Validator interface.

client/flags.go

@@ -52,7 +52,7 @@ func PostCommands(cmds ...*cobra.Command) []*cobra.Command {
 		c.Flags().Int64(FlagGas, 200000, "gas limit to set per-transaction")
 		c.Flags().Bool(FlagAsync, false, "broadcast transactions asynchronously")
 		c.Flags().Bool(FlagJson, false, "return output in json format")
-		c.Flags().Bool(FlagPrintResponse, false, "return tx response (only works with async = false)")
+		c.Flags().Bool(FlagPrintResponse, true, "return tx response (only works with async = false)")
 	}
 	return cmds
 }

client/keys/show.go

@@ -4,10 +4,20 @@ import (
 	"encoding/json"
 	"net/http"
 
-	keys "github.com/cosmos/cosmos-sdk/crypto/keys"
+	"github.com/cosmos/cosmos-sdk/crypto/keys"
 	"github.com/gorilla/mux"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+	"github.com/pkg/errors"
+	"github.com/tendermint/tmlibs/cli"
+)
+
+const (
+	// FlagAddress is the flag for the user's address on the command line.
+	FlagAddress = "address"
+	// FlagPublicKey represents the user's public key on the command line.
+	FlagPublicKey = "pubkey"
 )
 
 var showKeysCmd = &cobra.Command{
@@ -18,13 +28,38 @@ var showKeysCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		name := args[0]
 		info, err := getKey(name)
-		if err == nil {
-			printInfo(info)
+		if err != nil {
+			return err
+		}
+
+		showAddress := viper.GetBool(FlagAddress)
+		showPublicKey := viper.GetBool(FlagPublicKey)
+		outputSet := cmd.Flag(cli.OutputFlag).Changed
+		if showAddress && showPublicKey {
+			return errors.New("cannot use both --address and --pubkey at once")
+		}
+		if outputSet && (showAddress || showPublicKey) {
+			return errors.New("cannot use --output with --address or --pubkey")
 		}
-		return err
+		if showAddress {
+			printKeyAddress(info)
+			return nil
+		}
+		if showPublicKey {
+			printPubKey(info)
+			return nil
+		}
+
+		printInfo(info)
+		return nil
 	},
 }
 
+func init() {
+	showKeysCmd.Flags().Bool(FlagAddress, false, "output the address only (overrides --output)")
+	showKeysCmd.Flags().Bool(FlagPublicKey, false, "output the public key only (overrides --output)")
+}
+
 func getKey(name string) (keys.Info, error) {
 	kb, err := GetKeyBase()
 	if err != nil {

client/keys/utils.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/spf13/viper"
 
-	keys "github.com/cosmos/cosmos-sdk/crypto/keys"
+	"github.com/cosmos/cosmos-sdk/crypto/keys"
 	"github.com/tendermint/tendermint/libs/cli"
 	dbm "github.com/tendermint/tendermint/libs/db"
 
@@ -173,3 +173,19 @@ func printInfos(infos []keys.Info) {
 func printKeyOutput(ko KeyOutput) {
 	fmt.Printf("%s\t%s\t%s\t%s\n", ko.Name, ko.Type, ko.Address, ko.PubKey)
 }
+
+func printKeyAddress(info keys.Info) {
+	ko, err := Bech32KeyOutput(info)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(ko.Address.String())
+}
+
+func printPubKey(info keys.Info) {
+	ko, err := Bech32KeyOutput(info)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(ko.PubKey)
+}

client/tx/search.go

@@ -27,7 +27,20 @@ const (
 func SearchTxCmd(cdc *wire.Codec) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "txs",
-		Short: "Search for all transactions that match the given tags",
+		Short: "Search for all transactions that match the given tags.",
+		Long: strings.TrimSpace(`
+Search for transactions that match the given tags. By default, transactions must match ALL tags 
+passed to the --tags option. To match any transaction, use the --any option.
+
+For example:
+
+$ gaiacli tendermint txs --tag test1,test2
+
+will match any transaction tagged with both test1,test2. To match a transaction tagged with either
+test1 or test2, use:
+
+$ gaiacli tendermint txs --tag test1,test2 --any
+`),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			tags := viper.GetStringSlice(flagTags)
 
@@ -52,7 +65,7 @@ func SearchTxCmd(cdc *wire.Codec) *cobra.Command {
 
 	// TODO: change this to false once proofs built in
 	cmd.Flags().Bool(client.FlagTrustNode, true, "Don't verify proofs for responses")
-	cmd.Flags().StringSlice(flagTags, nil, "Tags that must match (may provide multiple)")
+	cmd.Flags().StringSlice(flagTags, nil, "Comma-separated list of tags that must match")
 	cmd.Flags().Bool(flagAny, false, "Return transactions that match ANY tag, rather than ALL")
 	return cmd
 }

server/tm_cmds.go

@@ -69,7 +69,7 @@ func ShowValidatorCmd(ctx *Context) *cobra.Command {
 func UnsafeResetAllCmd(ctx *Context) *cobra.Command {
 	return &cobra.Command{
 		Use:   "unsafe-reset-all",
-		Short: "Reset blockchain database, priv_validator.json file, and the logger",
+		Short: "Resets the blockchain database, removes address book files, and resets priv_validator.json to the genesis state",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cfg := ctx.Config
 			tcmd.ResetAll(cfg.DBDir(), cfg.P2P.AddrBookFile(), cfg.PrivValidatorFile(), ctx.Logger)