config

package
v0.47.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2023 License: Apache-2.0 Imports: 12 Imported by: 2,965

Documentation

Index

Constants

View Source 
const (

	// DefaultAPIAddress defines the default address to bind the API server to.
	DefaultAPIAddress = "tcp://localhost:1317"

	// DefaultGRPCAddress defines the default address to bind the gRPC server to.
	DefaultGRPCAddress = "localhost:9090"

	// DefaultGRPCWebAddress defines the default address to bind the gRPC-web server to.
	DefaultGRPCWebAddress = "localhost:9091"

	// DefaultGRPCMaxRecvMsgSize defines the default gRPC max message size in
	// bytes the server can receive.
	DefaultGRPCMaxRecvMsgSize = 1024 * 1024 * 10

	// DefaultGRPCMaxSendMsgSize defines the default gRPC max message size in
	// bytes the server can send.
	DefaultGRPCMaxSendMsgSize = math.MaxInt32

	// FileStreamer defines the store streaming type for file streaming.
	FileStreamer = "file"
)
View Source 
const DefaultConfigTemplate = `` /* 11360-byte string literal not displayed */

Variables

This section is empty.

Functions

func SetConfigTemplate added in v0.43.0 

func SetConfigTemplate(customTemplate string)

SetConfigTemplate sets the custom app config template for the application

func WriteConfigFile 

func WriteConfigFile(configFilePath string, config interface{})

WriteConfigFile renders config using the template and writes it to configFilePath.

Types

type APIConfig added in v0.40.0 

type APIConfig struct {
	// Enable defines if the API server should be enabled.
	Enable bool `mapstructure:"enable"`

	// Swagger defines if swagger documentation should automatically be registered.
	Swagger bool `mapstructure:"swagger"`

	// EnableUnsafeCORS defines if CORS should be enabled (unsafe - use it at your own risk)
	EnableUnsafeCORS bool `mapstructure:"enabled-unsafe-cors"`

	// Address defines the API server to listen on
	Address string `mapstructure:"address"`

	// MaxOpenConnections defines the number of maximum open connections
	MaxOpenConnections uint `mapstructure:"max-open-connections"`

	// RPCReadTimeout defines the Tendermint RPC read timeout (in seconds)
	RPCReadTimeout uint `mapstructure:"rpc-read-timeout"`

	// RPCWriteTimeout defines the Tendermint RPC write timeout (in seconds)
	RPCWriteTimeout uint `mapstructure:"rpc-write-timeout"`

	// RPCMaxBodyBytes defines the Tendermint maximum request body (in bytes)
	RPCMaxBodyBytes uint `mapstructure:"rpc-max-body-bytes"`
}

APIConfig defines the API listener configuration.

type BaseConfig 

type BaseConfig struct {
	// The minimum gas prices a validator is willing to accept for processing a
	// transaction. A transaction's fees must meet the minimum of any denomination
	// specified in this config (e.g. 0.25token1;0.0001token2).
	MinGasPrices string `mapstructure:"minimum-gas-prices"`

	Pruning           string `mapstructure:"pruning"`
	PruningKeepRecent string `mapstructure:"pruning-keep-recent"`
	PruningInterval   string `mapstructure:"pruning-interval"`

	// HaltHeight contains a non-zero block height at which a node will gracefully
	// halt and shutdown that can be used to assist upgrades and testing.
	//
	// Note: Commitment of state will be attempted on the corresponding block.
	HaltHeight uint64 `mapstructure:"halt-height"`

	// HaltTime contains a non-zero minimum block time (in Unix seconds) at which
	// a node will gracefully halt and shutdown that can be used to assist
	// upgrades and testing.
	//
	// Note: Commitment of state will be attempted on the corresponding block.
	HaltTime uint64 `mapstructure:"halt-time"`

	// MinRetainBlocks defines the minimum block height offset from the current
	// block being committed, such that blocks past this offset may be pruned
	// from Tendermint. It is used as part of the process of determining the
	// ResponseCommit.RetainHeight value during ABCI Commit. A value of 0 indicates
	// that no blocks should be pruned.
	//
	// This configuration value is only responsible for pruning Tendermint blocks.
	// It has no bearing on application state pruning which is determined by the
	// "pruning-*" configurations.
	//
	// Note: Tendermint block pruning is dependant on this parameter in conunction
	// with the unbonding (safety threshold) period, state pruning and state sync
	// snapshot parameters to determine the correct minimum value of
	// ResponseCommit.RetainHeight.
	MinRetainBlocks uint64 `mapstructure:"min-retain-blocks"`

	// InterBlockCache enables inter-block caching.
	InterBlockCache bool `mapstructure:"inter-block-cache"`

	// IndexEvents defines the set of events in the form {eventType}.{attributeKey},
	// which informs Tendermint what to index. If empty, all events will be indexed.
	IndexEvents []string `mapstructure:"index-events"`

	// IavlCacheSize set the size of the iavl tree cache.
	IAVLCacheSize uint64 `mapstructure:"iavl-cache-size"`

	// IAVLDisableFastNode enables or disables the fast sync node.
	IAVLDisableFastNode bool `mapstructure:"iavl-disable-fastnode"`

	// IAVLLazyLoading enable/disable the lazy loading of iavl store.
	IAVLLazyLoading bool `mapstructure:"iavl-lazy-loading"`

	// AppDBBackend defines the type of Database to use for the application and snapshots databases.
	// An empty string indicates that the Tendermint config's DBBackend value should be used.
	AppDBBackend string `mapstructure:"app-db-backend"`
}

BaseConfig defines the server's basic configuration

type Config 

type Config struct {
	BaseConfig `mapstructure:",squash"`

	// Telemetry defines the application telemetry configuration
	Telemetry telemetry.Config `mapstructure:"telemetry"`
	API       APIConfig        `mapstructure:"api"`
	GRPC      GRPCConfig       `mapstructure:"grpc"`
	Rosetta   RosettaConfig    `mapstructure:"rosetta"`
	GRPCWeb   GRPCWebConfig    `mapstructure:"grpc-web"`
	StateSync StateSyncConfig  `mapstructure:"state-sync"`
	Store     StoreConfig      `mapstructure:"store"`
	Streamers StreamersConfig  `mapstructure:"streamers"`
	Mempool   MempoolConfig    `mapstructure:"mempool"`
}

Config defines the server's top level configuration

func DefaultConfig 

func DefaultConfig() *Config

DefaultConfig returns server's default configuration.

func GetConfig added in v0.40.0 

func GetConfig(v *viper.Viper) (Config, error)

GetConfig returns a fully parsed Config object.

func ParseConfig 

func ParseConfig(v *viper.Viper) (*Config, error)

ParseConfig retrieves the default environment configuration for the application.

func (*Config) GetMinGasPrices 

func (c *Config) GetMinGasPrices() sdk.DecCoins

GetMinGasPrices returns the validator's minimum gas prices based on the set configuration.

func (*Config) SetMinGasPrices 

func (c *Config) SetMinGasPrices(gasPrices sdk.DecCoins)

SetMinGasPrices sets the validator's minimum gas prices.

func (Config) ValidateBasic added in v0.43.0 

func (c Config) ValidateBasic() error

ValidateBasic returns an error if min-gas-prices field is empty in BaseConfig. Otherwise, it returns nil.

type FileStreamerConfig added in v0.45.12 

type FileStreamerConfig struct {
	Keys     []string `mapstructure:"keys"`
	WriteDir string   `mapstructure:"write_dir"`
	Prefix   string   `mapstructure:"prefix"`
	// OutputMetadata specifies if output the block metadata file which includes
	// the abci requests/responses, otherwise only the data file is outputted.
	OutputMetadata bool `mapstructure:"output-metadata"`
	// StopNodeOnError specifies if propagate the streamer errors to the consensus
	// state machine, it's nesserary for data integrity of output.
	StopNodeOnError bool `mapstructure:"stop-node-on-error"`
	// Fsync specifies if calling fsync after writing the files, it slows down
	// the commit, but don't lose data in face of system crash.
	Fsync bool `mapstructure:"fsync"`
}

FileStreamerConfig defines the file streaming configuration options.

type GRPCConfig added in v0.40.0 

type GRPCConfig struct {
	// Enable defines if the gRPC server should be enabled.
	Enable bool `mapstructure:"enable"`

	// Address defines the API server to listen on
	Address string `mapstructure:"address"`

	// MaxRecvMsgSize defines the max message size in bytes the server can receive.
	// The default value is 10MB.
	MaxRecvMsgSize int `mapstructure:"max-recv-msg-size"`

	// MaxSendMsgSize defines the max message size in bytes the server can send.
	// The default value is math.MaxInt32.
	MaxSendMsgSize int `mapstructure:"max-send-msg-size"`
}

GRPCConfig defines configuration for the gRPC server.

type GRPCWebConfig added in v0.43.0 

type GRPCWebConfig struct {
	// Enable defines if the gRPC-web should be enabled.
	Enable bool `mapstructure:"enable"`

	// Address defines the gRPC-web server to listen on
	Address string `mapstructure:"address"`

	// EnableUnsafeCORS defines if CORS should be enabled (unsafe - use it at your own risk)
	EnableUnsafeCORS bool `mapstructure:"enable-unsafe-cors"`
}

GRPCWebConfig defines configuration for the gRPC-web server.

type MempoolConfig added in v0.47.0 

type MempoolConfig struct {
	// MaxTxs defines the behavior of the mempool. A negative value indicates
	// the mempool is disabled entirely, zero indicates that the mempool is
	// unbounded in how many txs it may contain, and a positive value indicates
	// the maximum amount of txs it may contain.
	MaxTxs int `mapstructure:"max-txs"`
}

MempoolConfig defines the configurations for the SDK built-in app-side mempool implementations.

type RosettaConfig added in v0.43.0 

type RosettaConfig struct {
	// Address defines the API server to listen on
	Address string `mapstructure:"address"`

	// Blockchain defines the blockchain name
	// defaults to DefaultBlockchain
	Blockchain string `mapstructure:"blockchain"`

	// Network defines the network name
	Network string `mapstructure:"network"`

	// Retries defines the maximum number of retries
	// rosetta will do before quitting
	Retries int `mapstructure:"retries"`

	// Enable defines if the API server should be enabled.
	Enable bool `mapstructure:"enable"`

	// Offline defines if the server must be run in offline mode
	Offline bool `mapstructure:"offline"`

	// EnableFeeSuggestion defines if the server should suggest fee by default
	EnableFeeSuggestion bool `mapstructure:"enable-fee-suggestion"`

	// GasToSuggest defines gas limit when calculating the fee
	GasToSuggest int `mapstructure:"gas-to-suggest"`

	// DenomToSuggest defines the defult denom for fee suggestion
	DenomToSuggest string `mapstructure:"denom-to-suggest"`
}

RosettaConfig defines the Rosetta API listener configuration.

type StateSyncConfig added in v0.40.0 

type StateSyncConfig struct {
	// SnapshotInterval sets the interval at which state sync snapshots are taken.
	// 0 disables snapshots.
	SnapshotInterval uint64 `mapstructure:"snapshot-interval"`

	// SnapshotKeepRecent sets the number of recent state sync snapshots to keep.
	// 0 keeps all snapshots.
	SnapshotKeepRecent uint32 `mapstructure:"snapshot-keep-recent"`
}

StateSyncConfig defines the state sync snapshot configuration.

type StoreConfig added in v0.45.12 

type StoreConfig struct {
	Streamers []string `mapstructure:"streamers"`
}

StoreConfig defines application configuration for state streaming and other storage related operations.

type StreamersConfig added in v0.45.12 

type StreamersConfig struct {
	File FileStreamerConfig `mapstructure:"file"`
}

StreamersConfig defines concrete state streaming configuration options. These fields are required to be set when state streaming is enabled via a non-empty list defined by 'StoreConfig.Streamers'.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.