import "github.com/cosmos/cosmos-sdk/baseapp"
abci.go baseapp.go helpers.go options.go queryrouter.go router.go state.go
const (
// MainStoreKey is the string representation of the main store
MainStoreKey = "main"
)func DefaultStoreLoader(ms sdk.CommitMultiStore) error
DefaultStoreLoader will be used by default and loads the latest version
SetHaltHeight returns a BaseApp option function that sets the halt block height.
SetHaltTime returns a BaseApp option function that sets the halt block time.
func SetInterBlockCache(cache sdk.MultiStorePersistentCache) func(*BaseApp)
SetInterBlockCache provides a BaseApp option function that sets the inter-block cache.
SetMinGasPrices returns an option that sets the minimum gas prices on the app.
func SetPruning(opts sdk.PruningOptions) func(*BaseApp)
SetPruning sets a pruning option on the multistore associated with the app
type BaseApp struct {
// contains filtered or unexported fields
}BaseApp reflects the ABCI application implementation.
func NewBaseApp(
name string, logger log.Logger, db dbm.DB, txDecoder sdk.TxDecoder, options ...func(*BaseApp),
) *BaseAppNewBaseApp returns a reference to an initialized BaseApp. It accepts a variadic number of option functions, which act on the BaseApp to set configuration choices.
NOTE: The db is used to store the version number for now.
AppVersion returns the application's version string.
func (app *BaseApp) BeginBlock(req abci.RequestBeginBlock) (res abci.ResponseBeginBlock)
BeginBlock implements the ABCI application interface.
func (app *BaseApp) CheckTx(req abci.RequestCheckTx) abci.ResponseCheckTx
CheckTx implements the ABCI interface and executes a tx in CheckTx mode. In CheckTx mode, messages are not executed. This means messages are only validated and only the AnteHandler is executed. State is persisted to the BaseApp's internal CheckTx state if the AnteHandler passes. Otherwise, the ResponseCheckTx will contain releveant error information. Regardless of tx execution outcome, the ResponseCheckTx will contain relevant gas execution context.
func (app *BaseApp) Commit() (res abci.ResponseCommit)
Commit implements the ABCI interface. It will commit all state that exists in the deliver state's multi-store and includes the resulting commit ID in the returned abci.ResponseCommit. Commit will set the check state based on the latest header and reset the deliver state. Also, if a non-zero halt height is defined in config, Commit will execute a deferred function call to check against that height and gracefully halt if it matches the latest committed height.
func (app *BaseApp) DeliverTx(req abci.RequestDeliverTx) abci.ResponseDeliverTx
DeliverTx implements the ABCI interface and executes a tx in DeliverTx mode. State only gets persisted if all messages are valid and get executed successfully. Otherwise, the ResponseDeliverTx will contain releveant error information. Regardless of tx execution outcome, the ResponseDeliverTx will contain relevant gas execution context.
func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBlock)
EndBlock implements the ABCI interface.
func (app *BaseApp) FilterPeerByAddrPort(info string) abci.ResponseQuery
FilterPeerByAddrPort filters peers by address/port.
func (app *BaseApp) FilterPeerByID(info string) abci.ResponseQuery
FilterPeerByIDfilters peers by node ID.
func (app *BaseApp) Info(req abci.RequestInfo) abci.ResponseInfo
Info implements the ABCI interface.
func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitChain)
InitChain implements the ABCI interface. It runs the initialization logic directly on the CommitMultiStore.
IsSealed returns true if the BaseApp is sealed and false otherwise.
LastBlockHeight returns the last committed block height.
LastCommitID returns the last CommitID of the multistore.
func (app *BaseApp) LoadLatestVersion(baseKey *sdk.KVStoreKey) error
LoadLatestVersion loads the latest application version. It will panic if called more than once on a running BaseApp.
LoadVersion loads the BaseApp application version. It will panic if called more than once on a running baseapp.
Logger returns the logger of the BaseApp.
func (app *BaseApp) MountKVStores(keys map[string]*sdk.KVStoreKey)
MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.
MountStore mounts a store to the provided key in the BaseApp multistore, using the default DB.
MountStoreWithDB mounts a store to the provided key in the BaseApp multistore, using a specified DB.
MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.
func (app *BaseApp) MountTransientStores(keys map[string]*sdk.TransientStoreKey)
MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.
Name returns the name of the BaseApp.
Context with current {check, deliver}State of the app used by tests.
func (app *BaseApp) Query(req abci.RequestQuery) abci.ResponseQuery
Query implements the ABCI interface. It delegates to CommitMultiStore if it implements Queryable.
func (app *BaseApp) QueryRouter() sdk.QueryRouter
QueryRouter returns the QueryRouter of a BaseApp.
Router returns the router of the BaseApp.
Seal seals a BaseApp. It prohibits any further modifications to a BaseApp.
func (app *BaseApp) SetAddrPeerFilter(pf sdk.PeerFilter)
func (app *BaseApp) SetAnteHandler(ah sdk.AnteHandler)
SetAppVersion sets the application's version string.
func (app *BaseApp) SetBeginBlocker(beginBlocker sdk.BeginBlocker)
func (app *BaseApp) SetCMS(cms store.CommitMultiStore)
SetCommitMultiStoreTracer sets the store tracer on the BaseApp's underlying CommitMultiStore.
func (app *BaseApp) SetEndBlocker(endBlocker sdk.EndBlocker)
func (app *BaseApp) SetIDPeerFilter(pf sdk.PeerFilter)
func (app *BaseApp) SetInitChainer(initChainer sdk.InitChainer)
func (app *BaseApp) SetOption(req abci.RequestSetOption) (res abci.ResponseSetOption)
SetOption implements the ABCI interface.
SetRouter allows us to customize the router.
func (app *BaseApp) SetStoreLoader(loader StoreLoader)
SetStoreLoader allows us to customize the rootMultiStore initialization.
type QueryRouter struct {
// contains filtered or unexported fields
}func NewQueryRouter() *QueryRouter
NewQueryRouter returns a reference to a new QueryRouter.
func (qrt *QueryRouter) AddRoute(path string, q sdk.Querier) sdk.QueryRouter
AddRoute adds a query path to the router with a given Querier. It will panic if a duplicate route is given. The route must be alphanumeric.
func (qrt *QueryRouter) Route(path string) sdk.Querier
Route returns the Querier for a given query route path.
type Router struct {
// contains filtered or unexported fields
}NewRouter returns a reference to a new router.
AddRoute adds a route path to the router with a given handler. The route must be alphanumeric.
Route returns a handler for a given route path.
TODO: Handle expressive matches.
type StoreLoader func(ms sdk.CommitMultiStore) error
StoreLoader defines a customizable function to control how we load the CommitMultiStore from disk. This is useful for state migration, when loading a datastore written with an older version of the software. In particular, if a module changed the substore key name (or removed a substore) between two versions of the software.
func StoreLoaderWithUpgrade(upgrades *storetypes.StoreUpgrades) StoreLoader
StoreLoaderWithUpgrade is used to prepare baseapp with a fixed StoreLoader pattern. This is useful in test cases, or with custom upgrade loading logic.
func UpgradeableStoreLoader(upgradeInfoPath string) StoreLoader
UpgradeableStoreLoader can be configured by SetStoreLoader() to check for the existence of a given upgrade file - json encoded StoreUpgrades data.
If not file is present, it will peform the default load (no upgrades to store).
If the file is present, it will parse the file and execute those upgrades (rename or delete stores), while loading the data. It will also delete the upgrade file upon successful load, so that the upgrade is only applied once, and not re-applied on next restart
This is useful for in place migrations when a store key is renamed between two versions of the software. (TODO: this code will move to x/upgrades when PR #4233 is merged, here mainly to help test the design)
Package baseapp imports 22 packages (graph) and is imported by 63 packages. Updated 2020-02-07. Refresh now. Tools for package owners.