## Description Closes: #12085 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
102 lines
2.9 KiB
Go
102 lines
2.9 KiB
Go
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 ctx.ChainID != "" {
|
|
conf.ChainID = ctx.ChainID // chain-id will be written to the client.toml while initiating the chain.
|
|
}
|
|
|
|
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
|
|
}
|