baseapp

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2021 License: Apache-2.0 Imports: 23 Imported by: 12

Documentation

Index

Constants

View Source 
const (

	// MainStoreKey is the string representation of the main store
	MainStoreKey = "main"
)
View Source 
const (
	// MetricsSubsystem is a subsystem shared by all metrics exposed by this
	// package.
	MetricsSubsystem = "baseapp"
)

Variables

This section is empty.

Functions

func DefaultStoreLoader added in v0.2.1 

func DefaultStoreLoader(ms sdk.CommitMultiStore) error

DefaultStoreLoader will be used by default and loads the latest version

func SetHaltHeight added in v0.2.1 

func SetHaltHeight(blockHeight uint64) func(*BaseApp)

SetHaltHeight returns a BaseApp option function that sets the halt block height.

func SetHaltTime added in v0.2.1 

func SetHaltTime(haltTime uint64) func(*BaseApp)

SetHaltTime returns a BaseApp option function that sets the halt block time.

func SetIAVLCacheSize added in v0.2.1 

func SetIAVLCacheSize(cacheSize int) func(*BaseApp)

SetIAVLCacheSize sets the maximum number of entries in the all iavl node caches

func SetInterBlockCache added in v0.2.1 

func SetInterBlockCache(cache sdk.MultiStorePersistentCache) func(*BaseApp)

SetInterBlockCache provides a BaseApp option function that sets the inter-block cache.

func SetLazyLoading added in v0.2.1 

func SetLazyLoading(lazyLoading bool) func(*BaseApp)

SetLazyLoading sets a lazyLoading option to load a version lazily

func SetMetrics added in v0.2.1 

func SetMetrics(bappMetrics *Metrics, storeMetrics *storetypes.Metrics, iavlMetricsProvider iavl.MetricsProvider) func(*BaseApp)

SetMetrics sets prometheus metrics

func SetMinGasPrices added in v0.2.1 

func SetMinGasPrices(gasPricesStr string) func(*BaseApp)

SetMinGasPrices returns an option that sets the minimum gas prices on the app.

func SetPruning added in v0.2.1 

func SetPruning(opts sdk.PruningOptions) func(*BaseApp)

SetPruning sets a pruning option on the multistore associated with the app

func SetTrace added in v0.2.1 

func SetTrace(trace bool) func(*BaseApp)

SetTrace will turn on or off trace flag

Types

type BaseApp 

type BaseApp struct {
	// contains filtered or unexported fields
}

BaseApp reflects the ABCI application implementation.

func NewBaseApp 

func NewBaseApp(
	name string, logger log.Logger, db dbm.DB, txDecoder sdk.TxDecoder, options ...func(*BaseApp),
) *BaseApp

NewBaseApp 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 (*BaseApp) AppVersion added in v0.2.1 

func (app *BaseApp) AppVersion() string

AppVersion returns the application's version string.

func (*BaseApp) BeginBlock 

func (app *BaseApp) BeginBlock(req abci.RequestBeginBlock) (res abci.ResponseBeginBlock)

BeginBlock implements the ABCI application interface.

func (*BaseApp) Check 

func (app *BaseApp) Check(tx sdk.Tx) (sdk.GasInfo, *sdk.Result, error)

func (*BaseApp) CheckTx 

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 (*BaseApp) Commit 

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 (*BaseApp) Deliver 

func (app *BaseApp) Deliver(tx sdk.Tx) (sdk.GasInfo, *sdk.Result, error)

func (*BaseApp) DeliverTx 

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 (*BaseApp) EndBlock 

func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBlock)

EndBlock implements the ABCI interface.

func (*BaseApp) FilterPeerByAddrPort added in v0.2.1 

func (app *BaseApp) FilterPeerByAddrPort(info string) abci.ResponseQuery

FilterPeerByAddrPort filters peers by address/port.

func (*BaseApp) FilterPeerByID added in v0.2.1 

func (app *BaseApp) FilterPeerByID(info string) abci.ResponseQuery

FilterPeerByIDfilters peers by node ID.

func (*BaseApp) Info 

func (app *BaseApp) Info(req abci.RequestInfo) abci.ResponseInfo

Info implements the ABCI interface.

func (*BaseApp) InitChain 

func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitChain)

InitChain implements the ABCI interface. It runs the initialization logic directly on the CommitMultiStore.

func (*BaseApp) IsSealed added in v0.2.1 

func (app *BaseApp) IsSealed() bool

IsSealed returns true if the BaseApp is sealed and false otherwise.

func (*BaseApp) LastBlockHeight 

func (app *BaseApp) LastBlockHeight() int64

LastBlockHeight returns the last committed block height.

func (*BaseApp) LastCommitID 

func (app *BaseApp) LastCommitID() sdk.CommitID

LastCommitID returns the last CommitID of the multistore.

func (*BaseApp) LoadLatestVersion 

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.

func (*BaseApp) LoadVersion 

func (app *BaseApp) LoadVersion(version int64, baseKey *sdk.KVStoreKey) error

LoadVersion loads the BaseApp application version. It will panic if called more than once on a running baseapp.

func (*BaseApp) Logger 

func (app *BaseApp) Logger() log.Logger

Logger returns the logger of the BaseApp.

func (*BaseApp) MountKVStores added in v0.2.1 

func (app *BaseApp) MountKVStores(keys map[string]*sdk.KVStoreKey)

MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.

func (*BaseApp) MountStore 

func (app *BaseApp) MountStore(key sdk.StoreKey, typ sdk.StoreType)

MountStore mounts a store to the provided key in the BaseApp multistore, using the default DB.

func (*BaseApp) MountStoreWithDB 

func (app *BaseApp) MountStoreWithDB(key sdk.StoreKey, typ sdk.StoreType, db dbm.DB)

MountStoreWithDB mounts a store to the provided key in the BaseApp multistore, using a specified DB.

func (*BaseApp) MountStores added in v0.2.1 

func (app *BaseApp) MountStores(keys ...sdk.StoreKey)

MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.

func (*BaseApp) MountTransientStores added in v0.2.1 

func (app *BaseApp) MountTransientStores(keys map[string]*sdk.TransientStoreKey)

MountStores mounts all IAVL or DB stores to the provided keys in the BaseApp multistore.

func (*BaseApp) Name 

func (app *BaseApp) Name() string

Name returns the name of the BaseApp.

func (*BaseApp) NewContext 

func (app *BaseApp) NewContext(isCheckTx bool, header abci.Header) sdk.Context

Context with current {check, deliver}State of the app used by tests.

func (*BaseApp) Query 

func (app *BaseApp) Query(req abci.RequestQuery) abci.ResponseQuery

Query implements the ABCI interface. It delegates to CommitMultiStore if it implements Queryable.

func (*BaseApp) QueryRouter added in v0.2.1 

func (app *BaseApp) QueryRouter() sdk.QueryRouter

QueryRouter returns the QueryRouter of a BaseApp.

func (*BaseApp) Router 

func (app *BaseApp) Router() sdk.Router

Router returns the router of the BaseApp.

func (*BaseApp) Seal added in v0.2.1 

func (app *BaseApp) Seal()

Seal seals a BaseApp. It prohibits any further modifications to a BaseApp.

func (*BaseApp) SetAddrPeerFilter added in v0.2.1 

func (app *BaseApp) SetAddrPeerFilter(pf sdk.PeerFilter)

func (*BaseApp) SetAnteHandler 

func (app *BaseApp) SetAnteHandler(ah sdk.AnteHandler)

func (*BaseApp) SetAppVersion added in v0.2.1 

func (app *BaseApp) SetAppVersion(v string)

SetAppVersion sets the application's version string.

func (*BaseApp) SetBeginBlocker 

func (app *BaseApp) SetBeginBlocker(beginBlocker sdk.BeginBlocker)

func (*BaseApp) SetCMS added in v0.2.1 

func (app *BaseApp) SetCMS(cms store.CommitMultiStore)

func (*BaseApp) SetCommitMultiStoreTracer added in v0.2.1 

func (app *BaseApp) SetCommitMultiStoreTracer(w io.Writer)

SetCommitMultiStoreTracer sets the store tracer on the BaseApp's underlying CommitMultiStore.

func (*BaseApp) SetDB added in v0.2.1 

func (app *BaseApp) SetDB(db dbm.DB)

func (*BaseApp) SetEndBlocker 

func (app *BaseApp) SetEndBlocker(endBlocker sdk.EndBlocker)

func (*BaseApp) SetFauxMerkleMode added in v0.2.1 

func (app *BaseApp) SetFauxMerkleMode()

func (*BaseApp) SetIDPeerFilter added in v0.2.1 

func (app *BaseApp) SetIDPeerFilter(pf sdk.PeerFilter)

func (*BaseApp) SetInitChainer 

func (app *BaseApp) SetInitChainer(initChainer sdk.InitChainer)

func (*BaseApp) SetName added in v0.2.1 

func (app *BaseApp) SetName(name string)

func (*BaseApp) SetOption 

func (app *BaseApp) SetOption(req abci.RequestSetOption) (res abci.ResponseSetOption)

SetOption implements the ABCI interface.

func (*BaseApp) SetRouter added in v0.2.1 

func (app *BaseApp) SetRouter(router sdk.Router)

SetRouter allows us to customize the router.

func (*BaseApp) SetStoreLoader added in v0.2.1 

func (app *BaseApp) SetStoreLoader(loader StoreLoader)

SetStoreLoader allows us to customize the rootMultiStore initialization.

func (*BaseApp) Simulate added in v0.2.1 

func (app *BaseApp) Simulate(txBytes []byte, tx sdk.Tx) (sdk.GasInfo, *sdk.Result, error)

type Metrics added in v0.2.1 

type Metrics struct {
}

Metrics contains metrics exposed by this package.

func GeneratePrometheusMetrics added in v0.2.1 

func GeneratePrometheusMetrics(prometheus bool) *Metrics

func NopMetrics added in v0.2.1 

func NopMetrics() *Metrics

NopMetrics returns no-op Metrics.

func PrometheusMetrics added in v0.2.1 

func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics

PrometheusMetrics returns Metrics build using Prometheus client library. Optionally, labels can be provided along with their values ("foo", "fooValue").

type QueryRouter added in v0.2.1 

type QueryRouter struct {
	// contains filtered or unexported fields
}

func NewQueryRouter added in v0.2.1 

func NewQueryRouter() *QueryRouter

NewQueryRouter returns a reference to a new QueryRouter.

func (*QueryRouter) AddRoute added in v0.2.1 

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 (*QueryRouter) Route added in v0.2.1 

func (qrt *QueryRouter) Route(path string) sdk.Querier

Route returns the Querier for a given query route path.

type Router 

type Router struct {
	// contains filtered or unexported fields
}

func NewRouter 

func NewRouter() *Router

NewRouter returns a reference to a new router.

func (*Router) AddRoute 

func (rtr *Router) AddRoute(path string, h sdk.Handler) sdk.Router

AddRoute adds a route path to the router with a given handler. The route must be alphanumeric.

func (*Router) Route 

func (rtr *Router) Route(_ sdk.Context, path string) sdk.Handler

Route returns a handler for a given route path.

TODO: Handle expressive matches.

type StoreLoader added in v0.2.1 

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 added in v0.2.1 

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 added in v0.2.1 

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)

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.