/
tx_cmd_wrap.go
117 lines (100 loc) · 3.12 KB
/
tx_cmd_wrap.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
package osmocli
import (
"fmt"
"strings"
"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/client/flags"
"github.com/cosmos/cosmos-sdk/client/tx"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
func TxIndexCmd(moduleName string) *cobra.Command {
cmd := IndexCmd(moduleName)
cmd.Short = fmt.Sprintf("%s transactions subcommands", moduleName)
return cmd
}
type TxCliDesc struct {
Use string
Short string
Long string
Example string
NumArgs int
// Contract: len(args) = NumArgs
ParseAndBuildMsg func(clientCtx client.Context, args []string, flags *pflag.FlagSet) (sdk.Msg, error)
TxSignerFieldName string
Flags FlagDesc
// Map of FieldName -> FlagName
CustomFlagOverrides map[string]string
// Map of FieldName -> CustomParseFn
CustomFieldParsers map[string]CustomFieldParserFn
}
var _ Descriptor = &TxCliDesc{}
// Implement Descriptor interface
func (desc TxCliDesc) GetCustomFlagOverrides() map[string]string {
return desc.CustomFlagOverrides
}
// Implement Descriptor interface
func (desc *TxCliDesc) AttachToUse(str string) {
desc.Use += str
}
func AddTxCmd[M sdk.Msg](cmd *cobra.Command, f func() (*TxCliDesc, M)) {
desc, _ := f()
subCmd := BuildTxCli[M](desc)
cmd.AddCommand(subCmd)
}
func BuildTxCli[M sdk.Msg](desc *TxCliDesc) *cobra.Command {
desc.TxSignerFieldName = strings.ToLower(desc.TxSignerFieldName)
if desc.NumArgs == 0 {
// NumArgs = NumFields - 1, since 1 field is from the msg
desc.NumArgs = ParseNumFields[M]() - 1 - len(desc.CustomFlagOverrides) - len(desc.CustomFieldParsers)
}
if desc.ParseAndBuildMsg == nil {
desc.ParseAndBuildMsg = func(clientCtx client.Context, args []string, flags *pflag.FlagSet) (sdk.Msg, error) {
flagAdvice := FlagAdvice{
IsTx: true,
TxSenderFieldName: desc.TxSignerFieldName,
FromValue: clientCtx.GetFromAddress().String(),
CustomFlagOverrides: desc.CustomFlagOverrides,
CustomFieldParsers: desc.CustomFieldParsers,
}.Sanitize()
return ParseFieldsFromFlagsAndArgs[M](flagAdvice, flags, args)
}
}
attachFieldsToUse[M](desc)
return desc.BuildCommandCustomFn()
}
// Creates a new cobra command given the description.
// Its up to then caller to add CLI flags, aside from `flags.AddTxFlagsToCmd(cmd)`
func (desc TxCliDesc) BuildCommandCustomFn() *cobra.Command {
cmd := &cobra.Command{
Use: desc.Use,
Short: desc.Short,
Args: cobra.ExactArgs(desc.NumArgs),
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
}
txf = txf.WithTxConfig(clientCtx.TxConfig).WithAccountRetriever(clientCtx.AccountRetriever)
msg, err := desc.ParseAndBuildMsg(clientCtx, args, cmd.Flags())
if err != nil {
return err
}
return tx.GenerateOrBroadcastTxWithFactory(clientCtx, txf, msg)
},
}
if desc.Example != "" {
cmd.Example = desc.Example
}
if desc.Long != "" {
cmd.Long = desc.Long
}
flags.AddTxFlagsToCmd(cmd)
AddFlags(cmd, desc.Flags)
return cmd
}