config

Documentation

Index

• Constants
• func CreateClientConfig(ctx client.Context, customClientTemplate string, customConfig interface{}) (client.Context, error)
• func ReadFromClientConfig(ctx client.Context) (client.Context, error)
• type ClientConfig
• type Config
  • func DefaultConfig() *Config
• type GRPCConfig

Constants

const (
	DefaultClientConfigTemplate = `` /* 1237-byte string literal not displayed */

)

Functions

func CreateClientConfig

func CreateClientConfig(ctx client.Context, customClientTemplate string, customConfig interface{}) (client.Context, error)

CreateClientConfig reads the client.toml file and returns a new populated client.Context If the client.toml file does not exist, it creates one with default values. It takes a customClientTemplate and customConfig as input that can be used to overwrite the default config and enhance the client.toml file. The custom template/config must be both provided or be "" and nil.

func ReadFromClientConfig

func ReadFromClientConfig(ctx client.Context) (client.Context, error)

ReadFromClientConfig reads values from client.toml file and updates them in client.Context It uses CreateClientConfig internally with no custom template and custom config. Deprecated: use CreateClientConfig instead.

Types

type ClientConfig

type ClientConfig Config

ClientConfig is an alias for Config for backward compatibility Deprecated: use Config instead which avoid name stuttering

type Config

type Config struct {
	ChainID               string     `mapstructure:"chain-id" json:"chain-id"`
	KeyringBackend        string     `mapstructure:"keyring-backend" json:"keyring-backend"`
	KeyringDefaultKeyName string     `mapstructure:"keyring-default-keyname" json:"keyring-default-keyname"`
	Output                string     `mapstructure:"output" json:"output"`
	Node                  string     `mapstructure:"node" json:"node"`
	BroadcastMode         string     `mapstructure:"broadcast-mode" json:"broadcast-mode"`
	GRPC                  GRPCConfig `mapstructure:",squash"`
}

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns default config for the client.toml

type GRPCConfig

type GRPCConfig struct {
	Address  string `mapstructure:"grpc-address"  json:"grpc-address"`
	Insecure bool   `mapstructure:"grpc-insecure"  json:"grpc-insecure"`
}

GRPCConfig holds the gRPC client configuration.