import "github.com/cosmos/cosmos-sdk/baseapp"
abci.go baseapp.go grpcrouter.go grpcrouter_helpers.go grpcserver.go helpers.go options.go params.go queryrouter.go recovery.go router.go state.go
const Paramspace = "baseapp"Paramspace defines the parameter subspace to be used for the paramstore.
var (
ParamStoreKeyBlockParams = []byte("BlockParams")
ParamStoreKeyEvidenceParams = []byte("EvidenceParams")
ParamStoreKeyValidatorParams = []byte("ValidatorParams")
)Parameter store keys for all the consensus parameter types.
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.
SetIndexEvents provides a BaseApp option function that sets the events to index.
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.
SetMinRetainBlocks returns a BaseApp option function that sets the minimum block retention height value when determining which heights to prune during ABCI Commit.
func SetPruning(opts sdk.PruningOptions) func(*BaseApp)
SetPruning sets a pruning option on the multistore associated with the app
SetSnapshotInterval sets the snapshot interval.
SetSnapshotKeepRecent sets the recent snapshots to keep.
SetSnapshotStore sets the snapshot store.
SetTrace will turn on or off trace flag
ValidateBlockParams defines a stateless validation on BlockParams. This function is called whenever the parameters are updated or stored.
ValidateEvidenceParams defines a stateless validation on EvidenceParams. This function is called whenever the parameters are updated or stored.
ValidateValidatorParams defines a stateless validation on ValidatorParams. This function is called whenever the parameters are updated or stored.
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.
func (app *BaseApp) AddRunTxRecoveryHandler(handlers ...RecoveryHandler)
AddRunTxRecoveryHandler adds custom app.runTx method panic handlers.
AppVersion returns the application's version string.
func (app *BaseApp) ApplySnapshotChunk(req abci.RequestApplySnapshotChunk) abci.ResponseApplySnapshotChunk
ApplySnapshotChunk implements the ABCI interface. It delegates to app.snapshotManager if set.
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
FilterPeerByID filters peers by node ID.
func (app *BaseApp) GRPCQueryRouter() *GRPCQueryRouter
GRPCQueryRouter returns the GRPCQueryRouter of a BaseApp.
GetBlockRetentionHeight returns the height for which all blocks below this height are pruned from Tendermint. Given a commitment height and a non-zero local minRetainBlocks configuration, the retentionHeight is the smallest height that satisfies:
- Unbonding (safety threshold) time: The block interval in which validators can be economically punished for misbehavior. Blocks in this interval must be auditable e.g. by the light client.
- Logical store snapshot interval: The block interval at which the underlying logical store database is persisted to disk, e.g. every 10000 heights. Blocks since the last IAVL snapshot must be available for replay on application restart.
- State sync snapshots: Blocks since the oldest available snapshot must be available for state sync nodes to catch up (oldest because a node may be restoring an old snapshot while a new snapshot was taken).
- Local (minRetainBlocks) config: Archive nodes may want to retain more or all blocks, e.g. via a local config option min-retain-blocks. There may also be a need to vary retention for other nodes, e.g. sentry nodes which do not need historical blocks.
GetConsensusParams returns the current consensus parameters from the BaseApp's ParamStore. If the BaseApp has no ParamStore defined, nil is returned.
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) ListSnapshots(req abci.RequestListSnapshots) abci.ResponseListSnapshots
ListSnapshots implements the ABCI interface. It delegates to app.snapshotManager if set.
LoadLatestVersion loads the latest application version. It will panic if called more than once on a running BaseApp.
func (app *BaseApp) LoadSnapshotChunk(req abci.RequestLoadSnapshotChunk) abci.ResponseLoadSnapshotChunk
LoadSnapshotChunk implements the ABCI interface. It delegates to app.snapshotManager if set.
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)
MountKVStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.
func (app *BaseApp) MountMemoryStores(keys map[string]*sdk.MemoryStoreKey)
MountMemoryStores mounts all in-memory KVStores with the BaseApp's internal commit multi-store.
MountStore mounts a store to the provided key in the BaseApp multistore, using the default 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)
MountTransientStores mounts all transient 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) OfferSnapshot(req abci.RequestOfferSnapshot) abci.ResponseOfferSnapshot
OfferSnapshot implements the ABCI interface. It delegates to app.snapshotManager if set.
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.
RegisterGRPCServer registers gRPC services directly with the gRPC server.
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.
func (app *BaseApp) SetParamStore(ps ParamStore)
SetParamStore sets a parameter store on the BaseApp.
SetRouter allows us to customize the router.
SetSnapshotInterval sets the snapshot interval.
SetSnapshotKeepRecent sets the number of recent snapshots to keep.
SetSnapshotStore sets the snapshot store.
func (app *BaseApp) SetStoreLoader(loader StoreLoader)
SetStoreLoader allows us to customize the rootMultiStore initialization.
StoreConsensusParams sets the consensus parameters to the baseapp's param store.
type GRPCQueryHandler = func(ctx sdk.Context, req abci.RequestQuery) (abci.ResponseQuery, error)
GRPCQueryHandler defines a function type which handles ABCI Query requests using gRPC
type GRPCQueryRouter struct {
// contains filtered or unexported fields
}GRPCQueryRouter routes ABCI Query requests to GRPC handlers
func NewGRPCQueryRouter() *GRPCQueryRouter
NewGRPCQueryRouter creates a new GRPCQueryRouter
func (qrt *GRPCQueryRouter) RegisterService(sd *grpc.ServiceDesc, handler interface{})
RegisterService implements the gRPC Server.RegisterService method. sd is a gRPC service description, handler is an object which implements that gRPC service
func (qrt *GRPCQueryRouter) RegisterSimulateService( simulateFn simulate.BaseAppSimulateFn, interfaceRegistry codectypes.InterfaceRegistry, )
RegisterSimulateService registers the simulate service on the gRPC router.
func (qrt *GRPCQueryRouter) Route(path string) GRPCQueryHandler
Route returns the GRPCQueryHandler for a given query route path or nil if not found
func (qrt *GRPCQueryRouter) SetInterfaceRegistry(interfaceRegistry codectypes.InterfaceRegistry)
SetInterfaceRegistry sets the interface registry for the router. This will also register the interface reflection gRPC service.
type ParamStore interface {
Get(ctx sdk.Context, key []byte, ptr interface{})
Has(ctx sdk.Context, key []byte) bool
Set(ctx sdk.Context, key []byte, param interface{})
}ParamStore defines the interface the parameter store used by the BaseApp must fulfill.
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 QueryServiceTestHelper struct {
*GRPCQueryRouter
// contains filtered or unexported fields
}QueryServiceTestHelper provides a helper for making grpc query service rpc calls in unit tests. It implements both the grpc Server and ClientConn interfaces needed to register a query service server and create a query service client.
func NewQueryServerTestHelper(ctx sdk.Context, interfaceRegistry types.InterfaceRegistry) *QueryServiceTestHelper
NewQueryServerTestHelper creates a new QueryServiceTestHelper that wraps the provided sdk.Context
func (q *QueryServiceTestHelper) Invoke(_ gocontext.Context, method string, args, reply interface{}, _ ...grpc.CallOption) error
Invoke implements the grpc ClientConn.Invoke method
func (q *QueryServiceTestHelper) NewStream(gocontext.Context, *grpc.StreamDesc, string, ...grpc.CallOption) (grpc.ClientStream, error)
NewStream implements the grpc ClientConn.NewStream method
RecoveryHandler handles recovery() object. Return a non-nil error if recoveryObj was processed. Return nil if recoveryObj was not processed.
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.
Package baseapp imports 38 packages (graph) and is imported by 110 packages. Updated 2020-09-21. Refresh now. Tools for package owners.