runtime

Documentation

Index

• func ProvideDeliverTx(appBuilder *AppBuilder) func(abci.RequestDeliverTx) abci.ResponseDeliverTx
• func ProvideKVStoreKey(config *runtimev1alpha1.Module, key depinject.ModuleKey, app *AppBuilder) *storetypes.KVStoreKey
• func ProvideMemoryStoreKey(key depinject.ModuleKey, app *AppBuilder) *storetypes.MemoryStoreKey
• func ProvideTransientStoreKey(key depinject.ModuleKey, app *AppBuilder) *storetypes.TransientStoreKey
• func SetupAppBuilder(inputs AppInputs)
• type App
  • func (a *App) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (a *App) Configurator() module.Configurator
  • func (a *App) DefaultGenesis() map[string]json.RawMessage
  • func (a *App) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
  • func (a *App) GetStoreKeys() []storetypes.StoreKey
  • func (a *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
  • func (a *App) Load(loadLatest bool) error
  • func (a *App) LoadHeight(height int64) error
  • func (a *App) RegisterAPIRoutes(apiSvr *api.Server, _ config.APIConfig)
  • func (a *App) RegisterModules(modules ...module.AppModule) error
  • func (a *App) RegisterNodeService(clientCtx client.Context)
  • func (a *App) RegisterStores(keys ...storetypes.StoreKey) error
  • func (a *App) RegisterTendermintService(clientCtx client.Context)
  • func (a *App) RegisterTxService(clientCtx client.Context)
  • func (a *App) SetInitChainer(initChainer sdk.InitChainer)
  • func (a *App) UnsafeFindStoreKey(storeKey string) storetypes.StoreKey
• type AppBuilder
  • func ProvideApp() (codectypes.InterfaceRegistry, codec.Codec, *codec.LegacyAmino, *AppBuilder, ...)
  • func (a *AppBuilder) Build(logger log.Logger, db dbm.DB, traceStore io.Writer, ...) *App
  • func (a *AppBuilder) DefaultGenesis() map[string]json.RawMessage
• type AppI
• type AppInputs
• type BaseAppOption
  • func (b BaseAppOption) IsManyPerContainerType()

Functions

func ProvideDeliverTx

func ProvideDeliverTx(appBuilder *AppBuilder) func(abci.RequestDeliverTx) abci.ResponseDeliverTx

func ProvideKVStoreKey

func ProvideKVStoreKey(config *runtimev1alpha1.Module, key depinject.ModuleKey, app *AppBuilder) *storetypes.KVStoreKey

func ProvideMemoryStoreKey

func ProvideMemoryStoreKey(key depinject.ModuleKey, app *AppBuilder) *storetypes.MemoryStoreKey

func ProvideTransientStoreKey

func ProvideTransientStoreKey(key depinject.ModuleKey, app *AppBuilder) *storetypes.TransientStoreKey

func SetupAppBuilder

func SetupAppBuilder(inputs AppInputs)

Types

type App

type App struct {
	*baseapp.BaseApp

	ModuleManager *module.Manager
	// contains filtered or unexported fields
}

App is a wrapper around BaseApp and ModuleManager that can be used in hybrid app.go/app config scenarios or directly as a servertypes.Application instance. To get an instance of *App, *AppBuilder must be requested as a dependency in a container which declares the runtime module and the AppBuilder.Build() method must be called.

App can be used to create a hybrid app.go setup where some configuration is done declaratively with an app config and the rest of it is done the old way. See simapp/app.go for an example of this setup.

func (*App) BeginBlocker

func (a *App) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

BeginBlocker application updates every begin block

func (*App) Configurator

func (a *App) Configurator() module.Configurator

Configurator returns the app's configurator.

func (*App) DefaultGenesis

func (a *App) DefaultGenesis() map[string]json.RawMessage

DefaultGenesis returns a default genesis from the registered AppModuleBasic's.

func (*App) EndBlocker

func (a *App) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock

EndBlocker application updates every end block

func (*App) GetStoreKeys

func (a *App) GetStoreKeys() []storetypes.StoreKey

GetStoreKeys returns all the stored store keys.

func (*App) InitChainer

func (a *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain

InitChainer initializes the chain.

func (*App) Load

func (a *App) Load(loadLatest bool) error

Load finishes all initialization operations and loads the app.

func (*App) LoadHeight

func (a *App) LoadHeight(height int64) error

LoadHeight loads a particular height

func (*App) RegisterAPIRoutes

func (a *App) RegisterAPIRoutes(apiSvr *api.Server, _ config.APIConfig)

RegisterAPIRoutes registers all application module routes with the provided API server.

func (*App) RegisterModules

func (a *App) RegisterModules(modules ...module.AppModule) error

RegisterModules registers the provided modules with the module manager and the basic module manager. This is the primary hook for integrating with modules which are not registered using the app config.

func (*App) RegisterNodeService

func (a *App) RegisterNodeService(clientCtx client.Context)

RegisterNodeService registers the node gRPC service on the app gRPC router.

func (*App) RegisterStores

func (a *App) RegisterStores(keys ...storetypes.StoreKey) error

RegisterStores registers the provided store keys. This method should only be used for registering extra stores wiich is necessary for modules that not registered using the app config. To be used in combination of RegisterModules.

func (*App) RegisterTendermintService

func (a *App) RegisterTendermintService(clientCtx client.Context)

RegisterTendermintService implements the Application.RegisterTendermintService method.

func (*App) RegisterTxService

func (a *App) RegisterTxService(clientCtx client.Context)

RegisterTxService implements the Application.RegisterTxService method.

func (*App) SetInitChainer

func (a *App) SetInitChainer(initChainer sdk.InitChainer)

SetInitChainer sets the init chainer function It wraps `BaseApp.SetInitChainer` to allow setting a custom init chainer from an app.

func (*App) UnsafeFindStoreKey

func (a *App) UnsafeFindStoreKey(storeKey string) storetypes.StoreKey

UnsafeFindStoreKey fetches a registered StoreKey from the App in linear time.

NOTE: This should only be used in testing.

type AppBuilder

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

AppBuilder is a type that is injected into a container by the runtime module (as *AppBuilder) which can be used to create an app which is compatible with the existing app.go initialization conventions.

func ProvideApp

func ProvideApp() (
	codectypes.InterfaceRegistry,
	codec.Codec,
	*codec.LegacyAmino,
	*AppBuilder,
	codec.ProtoCodecMarshaler,
	*baseapp.MsgServiceRouter,
)

func (*AppBuilder) Build

func (a *AppBuilder) Build(
	logger log.Logger,
	db dbm.DB,
	traceStore io.Writer,
	baseAppOptions ...func(*baseapp.BaseApp),
) *App

Build builds an *App instance.

func (*AppBuilder) DefaultGenesis

func (a *AppBuilder) DefaultGenesis() map[string]json.RawMessage

DefaultGenesis returns a default genesis from the registered AppModuleBasic's.

type AppI

type AppI interface {
	// The assigned name of the app.
	Name() string

	// The application types codec.
	// NOTE: This shoult be sealed before being returned.
	LegacyAmino() *codec.LegacyAmino

	// Application updates every begin block.
	BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

	// Application updates every end block.
	EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock

	// Application update at chain (i.e app) initialization.
	InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain

	// Loads the app at a given height.
	LoadHeight(height int64) error

	// Exports the state of the application for a genesis file.
	ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs []string, modulesToExport []string) (types.ExportedApp, error)

	// Helper for the simulation framework.
	SimulationManager() *module.SimulationManager
}

App implements the common methods for a Cosmos SDK-based application specific blockchain.

type AppInputs

type AppInputs struct {
	depinject.In

	AppConfig         *appv1alpha1.Config
	Config            *runtimev1alpha1.Module
	AppBuilder        *AppBuilder
	Modules           map[string]appmodule.AppModule
	BaseAppOptions    []BaseAppOption
	InterfaceRegistry codectypes.InterfaceRegistry
	LegacyAmino       *codec.LegacyAmino
}

type BaseAppOption

type BaseAppOption func(*baseapp.BaseApp)

BaseAppOption is a depinject.AutoGroupType which can be used to pass BaseApp options into the depinject. It should be used carefully.

func (BaseAppOption) IsManyPerContainerType

func (b BaseAppOption) IsManyPerContainerType()

IsManyPerContainerType indicates that this is a depinject.ManyPerContainerType.