forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 10
/
prompt.go
183 lines (152 loc) · 4.94 KB
/
prompt.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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
package cli
import (
"encoding/json"
"fmt"
"os"
"sort"
"github.com/manifoldco/promptui"
"github.com/spf13/cobra"
"github.com/shapeshift/cosmos-sdk/client"
"github.com/shapeshift/cosmos-sdk/client/flags"
"github.com/shapeshift/cosmos-sdk/codec"
sdk "github.com/shapeshift/cosmos-sdk/types"
govcli "github.com/shapeshift/cosmos-sdk/x/gov/client/cli"
govtypes "github.com/shapeshift/cosmos-sdk/x/gov/types"
)
const (
proposalText = "text"
proposalOther = "other"
draftProposalFileName = "draft_group_proposal.json"
draftMetadataFileName = "draft_group_metadata.json"
)
type proposalType struct {
Name string
Msg sdk.Msg
}
// Prompt the proposal type values and return the proposal and its metadata.
func (p *proposalType) Prompt(cdc codec.Codec, skipMetadata bool) (*Proposal, govtypes.ProposalMetadata, error) {
// set metadata
metadata, err := govcli.PromptMetadata(skipMetadata)
if err != nil {
return nil, metadata, fmt.Errorf("failed to set proposal metadata: %w", err)
}
proposal := &Proposal{
Metadata: "ipfs://CID", // the metadata must be saved on IPFS, set placeholder
Title: metadata.Title,
Summary: metadata.Summary,
}
// set group policy address
policyAddressPrompt := promptui.Prompt{
Label: "Enter group policy address",
Validate: client.ValidatePromptAddress,
}
groupPolicyAddress, err := policyAddressPrompt.Run()
if err != nil {
return nil, metadata, fmt.Errorf("failed to set group policy address: %w", err)
}
proposal.GroupPolicyAddress = groupPolicyAddress
// set proposer address
proposerPrompt := promptui.Prompt{
Label: "Enter proposer address",
Validate: client.ValidatePromptAddress,
}
proposerAddress, err := proposerPrompt.Run()
if err != nil {
return nil, metadata, fmt.Errorf("failed to set proposer address: %w", err)
}
proposal.Proposers = []string{proposerAddress}
if p.Msg == nil {
return proposal, metadata, nil
}
// set messages field
result, err := govcli.Prompt(p.Msg, "msg")
if err != nil {
return nil, metadata, fmt.Errorf("failed to set proposal message: %w", err)
}
message, err := cdc.MarshalInterfaceJSON(result)
if err != nil {
return nil, metadata, fmt.Errorf("failed to marshal proposal message: %w", err)
}
proposal.Messages = append(proposal.Messages, message)
return proposal, metadata, nil
}
// NewCmdDraftProposal let a user generate a draft proposal.
func NewCmdDraftProposal() *cobra.Command {
flagSkipMetadata := "skip-metadata"
cmd := &cobra.Command{
Use: "draft-proposal",
Short: "Generate a draft proposal json file. The generated proposal json contains only one message (skeleton).",
SilenceUsage: true,
RunE: func(cmd *cobra.Command, _ []string) error {
clientCtx, err := client.GetClientTxContext(cmd)
if err != nil {
return err
}
// prompt proposal type
proposalTypesPrompt := promptui.Select{
Label: "Select proposal type",
Items: []string{proposalText, proposalOther},
}
_, selectedProposalType, err := proposalTypesPrompt.Run()
if err != nil {
return fmt.Errorf("failed to prompt proposal types: %w", err)
}
var proposal *proposalType
switch selectedProposalType {
case proposalText:
proposal = &proposalType{Name: proposalText}
case proposalOther:
// prompt proposal type
proposal = &proposalType{Name: proposalOther}
msgPrompt := promptui.Select{
Label: "Select proposal message type:",
Items: func() []string {
msgs := clientCtx.InterfaceRegistry.ListImplementations(sdk.MsgInterfaceProtoName)
sort.Strings(msgs)
return msgs
}(),
}
_, result, err := msgPrompt.Run()
if err != nil {
return fmt.Errorf("failed to prompt proposal types: %w", err)
}
proposal.Msg, err = sdk.GetMsgFromTypeURL(clientCtx.Codec, result)
if err != nil {
// should never happen
panic(err)
}
default:
panic("unexpected proposal type")
}
skipMetadataPrompt, _ := cmd.Flags().GetBool(flagSkipMetadata)
result, metadata, err := proposal.Prompt(clientCtx.Codec, skipMetadataPrompt)
if err != nil {
return err
}
if err := writeFile(draftProposalFileName, result); err != nil {
return err
}
if !skipMetadataPrompt {
if err := writeFile(draftMetadataFileName, metadata); err != nil {
return err
}
}
cmd.Println("The draft proposal has successfully been generated.\nProposals should contain off-chain metadata, please upload the metadata JSON to IPFS.\nThen, replace the generated metadata field with the IPFS CID.")
return nil
},
}
flags.AddTxFlagsToCmd(cmd)
cmd.Flags().Bool(flagSkipMetadata, false, "skip metadata prompt")
return cmd
}
// writeFile writes the input to the file.
func writeFile(fileName string, input any) error {
raw, err := json.MarshalIndent(input, "", " ")
if err != nil {
return fmt.Errorf("failed to marshal proposal: %w", err)
}
if err := os.WriteFile(fileName, raw, 0o600); err != nil {
return err
}
return nil
}