Documentation ¶
Overview ¶
The commands from the SDK are defined with `cobra` and configured with the `viper` package.
This takes place in the `InterceptConfigsPreRunHandler` function. Since the `viper` package is used for configuration the precedence is dictated by that package. That is
1. Command line switches 2. Environment variables 3. Files from configuration values 4. Default values
The global configuration instance exposed by the `viper` package is not used by Cosmos SDK in this function. A new instance of `viper.Viper` is created and the following is performed. The environmental variable prefix is set to the current program name. Environmental variables consider the underscore to be equivalent to the `.` or `-` character. This means that an configuration value called `rpc.laddr` would be read from an environmental variable called `MYTOOL_RPC_LADDR` if the current program name is `mytool`.
Running the `InterceptConfigsPreRunHandler` also reads `app.toml` and `config.toml` from the home directory under the `config` directory. If `config.toml` or `app.toml` do not exist then those files are created and populated with default values. `InterceptConfigsPreRunHandler` takes two parameters to set/update a custom template to create custom `app.toml`. If these parameters are empty, the server then creates a default template provided by the SDK.
Index ¶
- Constants
- func AddCommands(rootCmd *cobra.Command, defaultNodeHome string, appCreator types.AppCreator, ...)
- func DefaultBaseappOptions(appOpts types.AppOptions) []func(*baseapp.BaseApp)
- func ExportCmd(appExporter types.AppExporter, defaultNodeHome string) *cobra.Command
- func ExternalIP() (string, error)
- func GetAppDBBackend(opts types.AppOptions) dbm.BackendType
- func GetPruningOptionsFromFlags(appOpts types.AppOptions) (pruningtypes.PruningOptions, error)
- func InterceptConfigsPreRunHandler(cmd *cobra.Command, customAppConfigTemplate string, ...) error
- func ListenForQuitSignals(cancelFn context.CancelFunc, logger log.Logger)
- func NewRollbackCmd(appCreator types.AppCreator, defaultNodeHome string) *cobra.Command
- func QueryBlockCmd() *cobra.Command
- func QueryBlocksCmd() *cobra.Command
- func RegisterSwaggerAPI(_ client.Context, rtr *mux.Router, swaggerEnabled bool) error
- func SetCmdServerContext(cmd *cobra.Command, serverCtx *Context) error
- func ShowAddressCmd() *cobra.Command
- func ShowNodeIDCmd() *cobra.Command
- func ShowValidatorCmd() *cobra.Command
- func StartCmd(appCreator types.AppCreator, defaultNodeHome string) *cobra.Command
- func TrapSignal(cleanupFunc func())
- func VersionCmd() *cobra.Command
- type Context
- type ErrorCode
Constants ¶
const ( FlagHeight = "height" FlagForZeroHeight = "for-zero-height" FlagJailAllowedAddrs = "jail-allowed-addrs" FlagModulesToExport = "modules-to-export" )
const ( FlagMinGasPrices = "minimum-gas-prices" FlagHaltHeight = "halt-height" FlagHaltTime = "halt-time" FlagInterBlockCache = "inter-block-cache" FlagUnsafeSkipUpgrades = "unsafe-skip-upgrades" FlagTrace = "trace" FlagInvCheckPeriod = "inv-check-period" FlagPruning = "pruning" FlagPruningKeepRecent = "pruning-keep-recent" FlagPruningInterval = "pruning-interval" FlagIndexEvents = "index-events" FlagMinRetainBlocks = "min-retain-blocks" FlagIAVLCacheSize = "iavl-cache-size" FlagDisableIAVLFastNode = "iavl-disable-fastnode" FlagIAVLLazyLoading = "iavl-lazy-loading" // state sync-related flags FlagStateSyncSnapshotInterval = "state-sync.snapshot-interval" FlagStateSyncSnapshotKeepRecent = "state-sync.snapshot-keep-recent" // api-related flags FlagAPIEnable = "api.enable" FlagAPISwagger = "api.swagger" FlagAPIAddress = "api.address" FlagAPIMaxOpenConnections = "api.max-open-connections" FlagRPCReadTimeout = "api.rpc-read-timeout" FlagRPCWriteTimeout = "api.rpc-write-timeout" FlagRPCMaxBodyBytes = "api.rpc-max-body-bytes" FlagAPIEnableUnsafeCORS = "api.enabled-unsafe-cors" // mempool flags FlagMempoolMaxTxs = "mempool.max-txs" )
const ServerContextKey = sdk.ContextKey("server.context")
ServerContextKey defines the context key used to retrieve a server.Context from a command's Context.
Variables ¶
This section is empty.
Functions ¶
func AddCommands ¶
func AddCommands(rootCmd *cobra.Command, defaultNodeHome string, appCreator types.AppCreator, appExport types.AppExporter, addStartFlags types.ModuleInitFlags)
add server commands
func DefaultBaseappOptions ¶
func DefaultBaseappOptions(appOpts types.AppOptions) []func(*baseapp.BaseApp)
DefaultBaseappOptions returns the default baseapp options provided by the Cosmos SDK
func ExportCmd ¶
func ExportCmd(appExporter types.AppExporter, defaultNodeHome string) *cobra.Command
ExportCmd dumps app state to JSON.
func ExternalIP ¶
https://stackoverflow.com/questions/23558425/how-do-i-get-the-local-ip-address-in-go TODO there must be a better way to get external IP
func GetAppDBBackend ¶
func GetAppDBBackend(opts types.AppOptions) dbm.BackendType
GetAppDBBackend gets the backend type to use for the application DBs.
func GetPruningOptionsFromFlags ¶
func GetPruningOptionsFromFlags(appOpts types.AppOptions) (pruningtypes.PruningOptions, error)
GetPruningOptionsFromFlags parses command flags and returns the correct PruningOptions. If a pruning strategy is provided, that will be parsed and returned, otherwise, it is assumed custom pruning options are provided.
func InterceptConfigsPreRunHandler ¶
func InterceptConfigsPreRunHandler(cmd *cobra.Command, customAppConfigTemplate string, customAppConfig interface{}, cmtConfig *cmtcfg.Config) error
InterceptConfigsPreRunHandler performs a pre-run function for the root daemon application command. It will create a Viper literal and a default server Context. The server CometBFT configuration will either be read and parsed or created and saved to disk, where the server Context is updated to reflect the CometBFT configuration. It takes custom app config template and config settings to create a custom CometBFT configuration. If the custom template is empty, it uses default-template provided by the server. The Viper literal is used to read and parse the application configuration. Command handlers can fetch the server Context to get the CometBFT configuration or to get access to Viper.
func ListenForQuitSignals ¶
func ListenForQuitSignals(cancelFn context.CancelFunc, logger log.Logger)
ListenForQuitSignals listens for SIGINT and SIGTERM. When a signal is received, the cleanup function is called, indicating the caller can gracefully exit or return.
Note, this performs a non-blocking process so the caller must ensure the corresponding context derived from the cancelFn is used correctly.
func NewRollbackCmd ¶
func NewRollbackCmd(appCreator types.AppCreator, defaultNodeHome string) *cobra.Command
NewRollbackCmd creates a command to rollback CometBFT and multistore state by one height.
func QueryBlockCmd ¶
QueryBlockCmd implements the default command for a Block query.
func QueryBlocksCmd ¶
QueryBlocksCmd returns a command to search through blocks by events.
func RegisterSwaggerAPI ¶
RegisterSwaggerAPI provides a common function which registers swagger route with API Server
func SetCmdServerContext ¶
SetCmdServerContext sets a command's Context value to the provided argument.
func ShowAddressCmd ¶
ShowAddressCmd - show this node's validator address
func ShowNodeIDCmd ¶
ShowNodeIDCmd - ported from CometBFT, dump node ID to stdout
func ShowValidatorCmd ¶
ShowValidatorCmd - ported from CometBFT, show this node's validator info
func StartCmd ¶
func StartCmd(appCreator types.AppCreator, defaultNodeHome string) *cobra.Command
StartCmd runs the service passed in, either stand-alone or in-process with CometBFT.
func TrapSignal ¶
func TrapSignal(cleanupFunc func())
TrapSignal traps SIGINT and SIGTERM and terminates the server correctly.
func VersionCmd ¶
VersionCmd prints CometBFT and ABCI version numbers.
Types ¶
type Context ¶
server context
func GetServerContextFromCmd ¶
GetServerContextFromCmd returns a Context from a command or an empty Context if it has not been set.
func NewContext ¶
func NewDefaultContext ¶
func NewDefaultContext() *Context
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
gogoreflection
Package gogoreflection implements gRPC reflection for gogoproto consumers the normal reflection library does not work as it points to a different singleton registry.
|
Package gogoreflection implements gRPC reflection for gogoproto consumers the normal reflection library does not work as it points to a different singleton registry. |
reflection/v2alpha1
Package v2alpha1 is a reverse proxy.
|
Package v2alpha1 is a reverse proxy. |