forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge tag 'v0.42.5' into v0.42.6-sentinel
Release v0.42.5
- Loading branch information
Showing
44 changed files
with
15,163 additions
and
23,985 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,25 @@ | ||
| # Cosmos SDK v0.42.4 "Stargate" Release Notes | ||
| # Cosmos SDK v0.42.5 "Stargate" Release Notes | ||
|
|
||
| This release includes an important Tendermint update that fixes a security issue with Tendermint light clients. For more information, see [Tendermint v0.34.9 release notes](https://github.com/tendermint/tendermint/blob/v0.34.9/CHANGELOG.md#v0.34.9). | ||
| This release includes various minor bugfixes and improvments, including: | ||
|
|
||
| See the [Cosmos SDK v0.42.4 milestone](https://github.com/cosmos/cosmos-sdk/milestone/43?closed=1) on our issue tracker for further details. | ||
| - Fix support for building the Cosmos SDK on ARM architectures, | ||
| - Fix the `[appd] keys show/list` CLI subcommands for multisigs, | ||
| - Internal code performance improvment. | ||
|
|
||
| It also introduces one new feature: adding the `[appd] config` subcommand back to the SDK. | ||
|
|
||
| See the [Cosmos SDK v0.42.5 milestone](https://github.com/cosmos/cosmos-sdk/milestone/44?closed=1) on our issue tracker for the exhaustive list of all changes. | ||
|
|
||
| ### The `config` Subcommand | ||
|
|
||
| One new feature introduced in the Stargate series was the merging of the two CLI binaries `[appd]` and `[appcli]` into one single application binary. In this process, the `[appcli] config` subcommand, which was used to save client-side configuration into a TOML file, was removed. | ||
|
|
||
| Due to [popular demand](https://github.com/cosmos/cosmos-sdk/issues/8529), we have introduced this feature back to the SDK, under the `[appd] config` subcommand. The functionality is as follows: | ||
|
|
||
| - `[appd] config`: Output all client-side configuration. | ||
| - `[appd] config [config-name]`: Get the given configuration (e.g. `keyring-backend` or `node-id`). | ||
| - `[appd] config [config-name] [config-value]`: Set and persist the given configuration with the new value. | ||
|
|
||
| All configurations are persisted to the filesystem, under the path `$APP_HOME/config/client.toml`. For the list of all possible client-side configurations, please have a look at this `client.toml` file, as it is heavily commented. | ||
|
|
||
| Environment variables binding to client-side configuration also works. For example, the command `KEYRING_BACKEND=os [appd] tx bank send ...` will bind ENV variable to the `keyring-backend` config. The order or precedence for config is: `flags > env vars > client.toml file`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| package config | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "path/filepath" | ||
|
|
||
| tmcli "github.com/tendermint/tendermint/libs/cli" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/client" | ||
| "github.com/cosmos/cosmos-sdk/client/flags" | ||
| ) | ||
|
|
||
| // Cmd returns a CLI command to interactively create an application CLI | ||
| // config file. | ||
| func Cmd() *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: | ||
| // print all client config fields to sdt out | ||
| s, _ := json.MarshalIndent(conf, "", "\t") | ||
| 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) | ||
| 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.SetChainID(value) | ||
| case flags.FlagKeyringBackend: | ||
| conf.SetKeyringBackend(value) | ||
| case tmcli.OutputFlag: | ||
| conf.SetOutput(value) | ||
| case flags.FlagNode: | ||
| conf.SetNode(value) | ||
| case flags.FlagBroadcastMode: | ||
| conf.SetBroadcastMode(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 | ||
| } | ||
|
|
||
| func errUnknownConfigKey(key string) error { | ||
| return fmt.Errorf("unknown configuration key: %q", key) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/client" | ||
| ) | ||
|
|
||
| // Default constants | ||
| const ( | ||
| chainID = "" | ||
| keyringBackend = "os" | ||
| output = "text" | ||
| node = "tcp://localhost:26657" | ||
| broadcastMode = "sync" | ||
| ) | ||
|
|
||
| type ClientConfig 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"` | ||
| } | ||
|
|
||
| // defaultClientConfig returns the reference to ClientConfig with default values. | ||
| func defaultClientConfig() *ClientConfig { | ||
| return &ClientConfig{chainID, keyringBackend, output, node, broadcastMode} | ||
| } | ||
|
|
||
| func (c *ClientConfig) SetChainID(chainID string) { | ||
| c.ChainID = chainID | ||
| } | ||
|
|
||
| func (c *ClientConfig) SetKeyringBackend(keyringBackend string) { | ||
| c.KeyringBackend = keyringBackend | ||
| } | ||
|
|
||
| func (c *ClientConfig) SetOutput(output string) { | ||
| c.Output = output | ||
| } | ||
|
|
||
| func (c *ClientConfig) SetNode(node string) { | ||
| c.Node = node | ||
| } | ||
|
|
||
| func (c *ClientConfig) SetBroadcastMode(broadcastMode string) { | ||
| c.BroadcastMode = broadcastMode | ||
| } | ||
|
|
||
| // ReadFromClientConfig reads values from client.toml file and updates them in client Context | ||
| func ReadFromClientConfig(ctx client.Context) (client.Context, error) { | ||
| configPath := filepath.Join(ctx.HomeDir, "config") | ||
| configFilePath := filepath.Join(configPath, "client.toml") | ||
| conf := defaultClientConfig() | ||
|
|
||
| // if config.toml file does not exist we create it and write default ClientConfig values into it. | ||
| if _, err := os.Stat(configFilePath); os.IsNotExist(err) { | ||
| if err := ensureConfigPath(configPath); err != nil { | ||
| return ctx, fmt.Errorf("couldn't make client config: %v", err) | ||
| } | ||
|
|
||
| if err := writeConfigToFile(configFilePath, conf); err != nil { | ||
| return ctx, fmt.Errorf("could not write client config to the file: %v", err) | ||
| } | ||
| } | ||
|
|
||
| conf, err := getClientConfig(configPath, ctx.Viper) | ||
| if err != nil { | ||
| return ctx, fmt.Errorf("couldn't get client config: %v", err) | ||
| } | ||
| // we need to update KeyringDir field on Client Context first cause it is used in NewKeyringFromBackend | ||
| ctx = ctx.WithOutputFormat(conf.Output). | ||
| WithChainID(conf.ChainID). | ||
| WithKeyringDir(ctx.HomeDir) | ||
|
|
||
| keyring, err := client.NewKeyringFromBackend(ctx, conf.KeyringBackend) | ||
| if err != nil { | ||
| return ctx, fmt.Errorf("couldn't get key ring: %v", err) | ||
| } | ||
|
|
||
| ctx = ctx.WithKeyring(keyring) | ||
|
|
||
| // https://github.com/cosmos/cosmos-sdk/issues/8986 | ||
| client, err := client.NewClientFromNode(conf.Node) | ||
| if err != nil { | ||
| return ctx, fmt.Errorf("couldn't get client from nodeURI: %v", err) | ||
| } | ||
|
|
||
| ctx = ctx.WithNodeURI(conf.Node). | ||
| WithClient(client). | ||
| WithBroadcastMode(conf.BroadcastMode) | ||
|
|
||
| return ctx, nil | ||
| } |
Oops, something went wrong.