-
Notifications
You must be signed in to change notification settings - Fork 580
/
config.go
346 lines (289 loc) · 10.6 KB
/
config.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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
package cmd
import (
"bytes"
"encoding/json"
"fmt"
"os"
"path/filepath"
"reflect"
"strconv"
"text/template"
"github.com/spf13/cobra"
"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/client/flags"
viper "github.com/spf13/viper"
tmcli "github.com/tendermint/tendermint/libs/cli"
)
// Default constants
const (
chainID = ""
keyringBackend = "os"
output = "text"
node = "tcp://localhost:26657"
broadcastMode = "sync"
)
type OsmosisCustomClient struct {
ChainID string `mapstructure:"chain-id" json:"chain-id"`
KeyringBackend string `mapstructure:"keyring-backend" json:"keyring-backend"`
Output string `mapstructure:"output" json:"output"`
Node string `mapstructure:"node" json:"node"`
BroadcastMode string `mapstructure:"broadcast-mode" json:"broadcast-mode"`
Gas string `mapstructure:"gas" json:"gas"`
GasPrices string `mapstructure:"gas-prices" json:"gas-prices"`
GasAdjustment string `mapstructure:"gas-adjustment" json:"gas-adjustment"`
Fees string `mapstructure:"fees" json:"fees"`
HumanReadableDenomsInput bool `mapstructure:"human-readable-denoms-input" json:"human-readable-denoms-input"`
HumanReadableDenomsOutput bool `mapstructure:"human-readable-denoms-output" json:"human-readable-denoms-output"`
}
// defaultClientConfig returns the reference to ClientConfig with default values.
func defaultClientConfig() *OsmosisCustomClient {
return &OsmosisCustomClient{ChainID: chainID, KeyringBackend: keyringBackend, Output: output, Node: node, BroadcastMode: broadcastMode}
}
func (c *OsmosisCustomClient) SetChainID(chainID string) {
c.ChainID = chainID
}
func (c *OsmosisCustomClient) SetKeyringBackend(keyringBackend string) {
c.KeyringBackend = keyringBackend
}
func (c *OsmosisCustomClient) SetOutput(output string) {
c.Output = output
}
func (c *OsmosisCustomClient) SetNode(node string) {
c.Node = node
}
func (c *OsmosisCustomClient) SetBroadcastMode(broadcastMode string) {
c.BroadcastMode = broadcastMode
}
// Override sdk ConfigCmd func
func ConfigCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "config <key> [value]",
Short: "Create or query an application CLI configuration file",
RunE: runConfigCmd,
Args: cobra.RangeArgs(0, 2),
}
return cmd
}
func runConfigCmd(cmd *cobra.Command, args []string) error {
clientCtx := client.GetClientContextFromCmd(cmd)
configPath := filepath.Join(clientCtx.HomeDir, "config")
conf, err := getClientConfig(configPath, clientCtx.Viper)
if err != nil {
return fmt.Errorf("couldn't get client config: %v", err)
}
switch len(args) {
case 0:
s, err := json.MarshalIndent(conf, "", "\t")
if err != nil {
return err
}
cmd.Println(string(s))
case 1:
// it's a get
key := args[0]
switch key {
case flags.FlagChainID:
cmd.Println(conf.ChainID)
case flags.FlagKeyringBackend:
cmd.Println(conf.KeyringBackend)
case tmcli.OutputFlag:
cmd.Println(conf.Output)
case flags.FlagNode:
cmd.Println(conf.Node)
case flags.FlagBroadcastMode:
cmd.Println(conf.BroadcastMode)
case flags.FlagGas:
cmd.Println(conf.Gas)
case flags.FlagGasPrices:
cmd.Println(conf.GasPrices)
case flags.FlagGasAdjustment:
cmd.Println(conf.GasAdjustment)
case flags.FlagFees:
cmd.Println(conf.Fees)
default:
err := errUnknownConfigKey(key)
return fmt.Errorf("couldn't get the value for the key: %v, error: %v", key, err)
}
case 2:
// it's set
key, value := args[0], args[1]
switch key {
case flags.FlagChainID:
conf.ChainID = value
case flags.FlagKeyringBackend:
conf.KeyringBackend = value
case tmcli.OutputFlag:
conf.Output = value
case flags.FlagNode:
conf.Node = value
case flags.FlagBroadcastMode:
conf.BroadcastMode = value
case flags.FlagGas:
conf.Gas = value
case flags.FlagGasPrices:
conf.GasPrices = value
case flags.FlagGasAdjustment:
conf.GasAdjustment = value
case flags.FlagFees:
conf.Fees = value
default:
return errUnknownConfigKey(key)
}
confFile := filepath.Join(configPath, "client.toml")
if err := writeConfigToFile(confFile, conf); err != nil {
return fmt.Errorf("could not write client config to the file: %v", err)
}
default:
panic("cound not execute config command")
}
return nil
}
const defaultConfigTemplate = `# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
###############################################################################
### Client Configuration ###
###############################################################################
# The network chain ID
chain-id = "{{ .ChainID }}"
# The keyring's backend, where the keys are stored (os|file|kwallet|pass|test|memory)
keyring-backend = "{{ .KeyringBackend }}"
# CLI output format (text|json)
output = "{{ .Output }}"
# <host>:<port> to Tendermint RPC interface for this chain
node = "{{ .Node }}"
# Transaction broadcasting mode (sync|async)
broadcast-mode = "{{ .BroadcastMode }}"
# Human-readable denoms: Input
# If enabled, when using CLI, user can input 0 exponent denoms (atom, scrt, avax, wbtc, etc.) instead of their ibc equivalents.
# Note, this will also change the coin's value to it's base value if the input or flag is a coin.
# Example:
# * 10.45atom input will automatically change to 10450000ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2
# * uakt will change to ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4
# * 12000000uscrt will change to 12000000ibc/0954E1C28EB7AF5B72D24F3BC2B47BBB2FDF91BDDFD57B74B99E133AED40972A
# This feature isn't stable yet, and outputs will change in subsequent releases
human-readable-denoms-input = {{ .HumanReadableDenomsInput }}
# Human-readable denoms: Output
# If enabled, CLI response return base denoms (uatom, uscrt, wavax-wei, wbtc-satoshi, etc.) instead of their ibc equivalents.
# This feature isn't stable yet, and outputs will change in subsequent releases
human-readable-denoms-output = {{ .HumanReadableDenomsOutput }}
###############################################################################
### Osmosis Tx Configuration ###
###############################################################################
# Amount of gas per transaction
gas = "{{ .Gas }}"
# Price per unit of gas (ex: 0.005uosmo)
gas-prices = "{{ .GasPrices }}"
gas-adjustment = "{{ .GasAdjustment }}"
fees = "{{ .Fees }}"
`
// writeConfigToFile parses defaultConfigTemplate, renders config using the template and writes it to
// configFilePath. If nil is provided as config, the default config is used.
func writeConfigToFile(configFilePath string, config *OsmosisCustomClient) error {
var buffer bytes.Buffer
defaultOsmosisCustomClient := defaultClientConfig()
tmpl := template.New("clientConfigFileTemplate")
configTemplate, err := tmpl.Parse(defaultConfigTemplate)
if err != nil {
return err
}
// Loop through the fields of the provided config and replace values in the default client
if config != nil {
configValue := reflect.ValueOf(config).Elem()
defaultValue := reflect.ValueOf(defaultOsmosisCustomClient).Elem()
for i := 0; i < configValue.NumField(); i++ {
configField := configValue.Field(i)
defaultField := defaultValue.Field(i)
// Check if the field is a pointer type
if configField.Kind() == reflect.Ptr {
// If it's a pointer type, check if it's nil
if !configField.IsNil() {
defaultField.Set(configField.Elem())
}
} else {
// For non-pointer types, check if the value is the zero value
if !reflect.DeepEqual(configField.Interface(), reflect.Zero(configField.Type()).Interface()) {
defaultField.Set(configField)
}
}
}
}
if err := configTemplate.Execute(&buffer, defaultOsmosisCustomClient); err != nil {
return err
}
return os.WriteFile(configFilePath, buffer.Bytes(), 0o600)
}
// getClientConfig reads values from client.toml file and unmarshalls them into ClientConfig
func getClientConfig(configPath string, v *viper.Viper) (*OsmosisCustomClient, error) {
v.AddConfigPath(configPath)
v.SetConfigName("client")
v.SetConfigType("toml")
if err := v.ReadInConfig(); err != nil {
return nil, err
}
conf := new(OsmosisCustomClient)
if err := v.Unmarshal(conf); err != nil {
return nil, err
}
return conf, nil
}
// Reads the custom extra values in the config.toml file if set.
// If they are, then use them.
func SetCustomEnvVariablesFromClientToml(ctx client.Context) {
configFilePath := filepath.Join(ctx.HomeDir, "config", "client.toml")
if _, err := os.Stat(configFilePath); os.IsNotExist(err) {
return
}
viper := ctx.Viper
viper.SetConfigFile(configFilePath)
if err := viper.ReadInConfig(); err != nil {
panic(err)
}
setEnvFromConfig := func(key string, envVar string) {
// if the user sets the env key manually, then we don't want to override it
if os.Getenv(envVar) != "" {
return
}
// reads from the config file
val := viper.GetString(key)
if val != "" {
// Sets the env for this instance of the app only.
os.Setenv(envVar, val)
}
}
// Bound custom flags to environment variable
// gas
setEnvFromConfig("gas", "OSMOSISD_GAS")
setEnvFromConfig("gas-prices", "OSMOSISD_GAS_PRICES")
setEnvFromConfig("gas-adjustment", "OSMOSISD_GAS_ADJUSTMENT")
// fees
setEnvFromConfig("fees", "OSMOSISD_FEES")
// human readable denoms
setEnvFromConfig("human-readable-denoms-input", "OSMOSISD_HUMAN_READABLE_DENOMS_INPUT")
setEnvFromConfig("human-readable-denoms-output", "OSMOSISD_HUMAN_READABLE_DENOMS_OUTPUT")
}
func errUnknownConfigKey(key string) error {
return fmt.Errorf("unknown configuration key: %q", key)
}
func GetHumanReadableDenomEnvVariables() (bool, bool) {
humanReadableDenomsInputStr := os.Getenv("OSMOSISD_HUMAN_READABLE_DENOMS_INPUT")
humanReadableDenomsInput, err := strconv.ParseBool(humanReadableDenomsInputStr)
if err != nil {
return false, false
}
humanReadableDenomsOutputStr := os.Getenv("OSMOSISD_HUMAN_READABLE_DENOMS_OUTPUT")
humanReadableDenomsOutput, err := strconv.ParseBool(humanReadableDenomsOutputStr)
if err != nil {
return false, false
}
return humanReadableDenomsInput, humanReadableDenomsOutput
}
func GetChainId(initClientCtx client.Context, cmd *cobra.Command) string {
chainID := initClientCtx.ChainID
// Get the pflag.FlagSet for the command.
flagSet := cmd.Flags()
// Check if the "chain-id" flag exists.
if chainIDFlag := flagSet.Lookup(flags.FlagChainID); chainIDFlag != nil {
chainID = chainIDFlag.Value.String()
}
return chainID
}