* init * Fix bank proto messages * missing conversions * remove casttype for addresses * Fix tests * Fix consaddress * more test fixes * Fix tests * fixed tests * migrate missing proto declarations * format * Fix format * Fix alignment * Fix more tests * Fix ibc merge issue * Fix fmt * Fix more tests * Fix missing address declarations * Fix staking tests * Fix more tests * Fix config * fixed tests * Fix more tests * Update staking grpc tests * Fix merge issue * fixed failing tests in x/distr * fixed sim tests * fixed failing tests * Fix bugs * Add logs * fixed slashing issue * Fix staking grpc tests * Fix all bank tests :) * Fix tests in distribution * Fix more tests in distr * Fix slashing tests * Fix statking tests * Fix evidence tests * Fix gov tests * Fix bug in create vesting account * Fix test * remove fmt * fixed gov tests * fixed x/ibc tests * fixed x/ibc-transfer tests * fixed staking tests * fixed staking tests * fixed test * fixed distribution issue * fix pagination test * fmt * lint * fix build * fix format * revert tally tests * revert tally tests * lint * Fix sim test * revert * revert * fixed tally issue * fix tests * revert * fmt * refactor * remove `GetAddress()` * remove fmt * revert fmt.Striger usage * Fix tests * Fix rest test * disable interfacer lint check * make proto-format * add nolint rule * remove stray println Co-authored-by: aleem1314 <aleem.md789@gmail.com> Co-authored-by: atheesh <atheesh@vitwit.com> |
||
---|---|---|
.. | ||
api | ||
config | ||
grpc | ||
mock | ||
types | ||
README.md | ||
constructors_test.go | ||
export.go | ||
export_test.go | ||
init.go | ||
init_test.go | ||
pruning.go | ||
pruning_test.go | ||
start.go | ||
test_helpers.go | ||
tm_cmds.go | ||
util.go |
README.md
Server
The server
package is responsible for providing the mechanisms necessary to
start an ABCI Tendermint application and providing the CLI framework necessary
to fully bootstrap an application. The package exposes two core commands, StartCmd
and ExportCmd
.
Preliminary
The root command of an application typically is constructed with three core sub-commands, query commands, tx commands, and auxiliary commands such as genesis utilities, and starting an application binary.
It is vital that the root command of an application set the appropriate PersistentPreRun(E)
function so all child commands have access to the server and client contexts.
These contexts are set as their default values initially and maybe modified,
scoped to the command, in their respective PersistentPreRun(E)
functions. Note,
the client.Context
is typically pre-populated with "default" values that may be
useful for all commands to inherit and override if necessary.
Example:
var (
rootCmd = &cobra.Command{
Use: "simd",
Short: "simulation app",
PersistentPreRunE: func(cmd *cobra.Command, _ []string) error {
if err := client.SetCmdClientContextHandler(initClientCtx, cmd); err != nil {
return err
}
return server.InterceptConfigsPreRunHandler(cmd)
},
}
encodingConfig = simapp.MakeEncodingConfig()
initClientCtx = client.Context{}.
WithJSONMarshaler(encodingConfig.Marshaler).
WithTxConfig(encodingConfig.TxConfig).
WithCodec(encodingConfig.Amino).
WithInput(os.Stdin).
WithAccountRetriever(types.NewAccountRetriever(encodingConfig.Marshaler)).
WithBroadcastMode(flags.BroadcastBlock).
WithHomeDir(simapp.DefaultNodeHome)
)
The SetCmdClientContextHandler
call reads persistent flags via ReadPersistentCommandFlags
which creates a client.Context
and sets that on the root command's Context
.
The InterceptConfigsPreRunHandler
call creates a viper literal, default server.Context
,
and a logger and sets that on the root command's Context
. The server.Context
will be modified and saved to disk via the internal interceptConfigs
call, which
either reads or creates a Tendermint configuration based on the home path provided.
In addition, interceptConfigs
also reads and loads the application configuration,
app.toml
, and binds that to the server.Context
viper literal. This is vital
so the application can get access to not only the CLI flags, but also to the
application configuration values provided by this file.
StartCmd
The StartCmd
accepts an AppCreator
function which returns an Application
.
The AppCreator
is responsible for constructing the application based on the
options provided to it via AppOptions
. The AppOptions
interface type defines
a single method, Get() interface{}
, and is implemented as a viper
literal that exists in the server.Context
. All the possible options an application
may use and provide to the construction process are defined by the StartCmd
and by the application's config file, app.toml
.
The application can either be started in-process or as an external process. The former creates a Tendermint service and the latter creates a Tendermint Node.
Under the hood, StartCmd
will call GetServerContextFromCmd
, which provides
the command access to a server.Context
. This context provides access to the
viper literal, the Tendermint config and logger. This allows flags to be bound
the viper literal and passed to the application construction.
Example:
func newApp(logger log.Logger, db dbm.DB, traceStore io.Writer, appOpts server.AppOptions) server.Application {
var cache sdk.MultiStorePersistentCache
if cast.ToBool(appOpts.Get(server.FlagInterBlockCache)) {
cache = store.NewCommitKVStoreCacheManager()
}
skipUpgradeHeights := make(map[int64]bool)
for _, h := range cast.ToIntSlice(appOpts.Get(server.FlagUnsafeSkipUpgrades)) {
skipUpgradeHeights[int64(h)] = true
}
pruningOpts, err := server.GetPruningOptionsFromFlags(appOpts)
if err != nil {
panic(err)
}
return simapp.NewSimApp(
logger, db, traceStore, true, skipUpgradeHeights,
cast.ToString(appOpts.Get(flags.FlagHome)),
cast.ToUint(appOpts.Get(server.FlagInvCheckPeriod)),
baseapp.SetPruning(pruningOpts),
baseapp.SetMinGasPrices(cast.ToString(appOpts.Get(server.FlagMinGasPrices))),
baseapp.SetHaltHeight(cast.ToUint64(appOpts.Get(server.FlagHaltHeight))),
baseapp.SetHaltTime(cast.ToUint64(appOpts.Get(server.FlagHaltTime))),
baseapp.SetInterBlockCache(cache),
baseapp.SetTrace(cast.ToBool(appOpts.Get(server.FlagTrace))),
)
}
Note, some of the options provided are exposed via CLI flags in the start command
and some are also allowed to be set in the application's app.toml
. It is recommend
to use the cast
package for type safety guarantees and due to the limitations of
CLI flag types.