app

README

App file structure

1. app.go: this is the final place for all integration
2. modules.go: this is where modules are registered
3. keepers: this is where keepers related logic is registered
4. params: this is where encoding and some app values is registered
5. upgrades: this is where upgrade is registered

Documentation

Index

• Variables
• func BeginBlockForks(ctx sdk.Context, app *TerraApp)
• func GetMaccPerms() map[string][]string
• func MakeEncodingConfig() params.EncodingConfig
• func RegisterSwaggerAPI(rtr *mux.Router)
• type GenesisState
  • func NewDefaultGenesisState() GenesisState
• type TerraApp
  • func NewTerraApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bool, ...) *TerraApp
  • func (app *TerraApp) AppCodec() codec.Codec
  • func (app *TerraApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (app *TerraApp) BlacklistedAccAddrs() map[string]bool
  • func (app *TerraApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
  • func (app *TerraApp) ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs []string) (servertypes.ExportedApp, error)
  • func (app *TerraApp) GetSubspace(moduleName string) paramstypes.Subspace
  • func (app *TerraApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
  • func (app *TerraApp) InterfaceRegistry() codectypes.InterfaceRegistry
  • func (app *TerraApp) LegacyAmino() *codec.LegacyAmino
  • func (app *TerraApp) LoadHeight(height int64) error
  • func (app *TerraApp) ModuleAccountAddrs() map[string]bool
  • func (app *TerraApp) Name() string
  • func (app *TerraApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)
  • func (app *TerraApp) RegisterTendermintService(clientCtx client.Context)
  • func (app *TerraApp) RegisterTxService(clientCtx client.Context)
  • func (app *TerraApp) SimulationManager() *module.SimulationManager

Variables

var (
	// DefaultNodeHome defines default home directories for terrad
	DefaultNodeHome string

	// Upgrades defines upgrades to be applied to the network
	Upgrades = []upgrades.Upgrade{v2.Upgrade, v3.Upgrade, v4.Upgrade, v5.Upgrade}

	// Forks defines forks to be applied to the network
	Forks = []upgrades.Fork{}
)

var (
	// ModuleBasics = The ModuleBasicManager is in charge of setting up basic,
	// non-dependant module elements, such as codec registration
	// and genesis verification.
	ModuleBasics = module.NewBasicManager(
		customauth.AppModuleBasic{},
		customauthz.AppModuleBasic{},
		genutil.AppModuleBasic{},
		custombank.AppModuleBasic{},
		capability.AppModuleBasic{},
		customstaking.AppModuleBasic{},
		custommint.AppModuleBasic{},
		customdistr.AppModuleBasic{},
		customgov.NewAppModuleBasic(
			append(
				wasmclient.ProposalHandlers,
				paramsclient.ProposalHandler,
				distrclient.ProposalHandler,
				upgradeclient.LegacyProposalHandler,
				upgradeclient.LegacyCancelProposalHandler,
				ibcclientclient.UpdateClientProposalHandler,
				ibcclientclient.UpgradeProposalHandler,
				treasuryclient.ProposalAddBurnTaxExemptionAddressHandler,
				treasuryclient.ProposalRemoveBurnTaxExemptionAddressHandler,
			),
		),
		customparams.AppModuleBasic{},
		customcrisis.AppModuleBasic{},
		customslashing.AppModuleBasic{},
		customfeegrant.AppModuleBasic{},
		ibc.AppModuleBasic{},
		ica.AppModuleBasic{},
		customupgrade.AppModuleBasic{},
		customevidence.AppModuleBasic{},
		transfer.AppModuleBasic{},
		vesting.AppModuleBasic{},
		oracle.AppModuleBasic{},
		market.AppModuleBasic{},
		treasury.AppModuleBasic{},
		customwasm.AppModuleBasic{},
		ibcfee.AppModuleBasic{},
	)
)

Functions

func BeginBlockForks

func BeginBlockForks(ctx sdk.Context, app *TerraApp)

BeginBlockForks is intended to be ran in a chain upgrade.

func GetMaccPerms

func GetMaccPerms() map[string][]string

GetMaccPerms returns a copy of the module account permissions

func MakeEncodingConfig

func MakeEncodingConfig() params.EncodingConfig

MakeEncodingConfig creates an EncodingConfig for testing

func RegisterSwaggerAPI

func RegisterSwaggerAPI(rtr *mux.Router)

RegisterSwaggerAPI registers swagger route with API Server

Types

type GenesisState

type GenesisState map[string]json.RawMessage

GenesisState The genesis state of the blockchain is represented here as a map of raw json messages key'd by a identifier string. The identifier is used to determine which module genesis information belongs to so it may be appropriately routed during init chain. Within this application default genesis information is retrieved from the ModuleBasicManager which populates json from each BasicModule object provided to it during init.

func NewDefaultGenesisState

func NewDefaultGenesisState() GenesisState

NewDefaultGenesisState generates the default state for the application.

type TerraApp

type TerraApp struct {
	*baseapp.BaseApp
	*keepers.AppKeepers
	// contains filtered or unexported fields
}

TerraApp extends an ABCI application, but with most of its parameters exported. They are exported for convenience in creating helper functions, as object capabilities aren't needed for testing.

func NewTerraApp

func NewTerraApp(
	logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bool, skipUpgradeHeights map[int64]bool,
	homePath string, invCheckPeriod uint, encodingConfig terraappparams.EncodingConfig, appOpts servertypes.AppOptions,
	wasmOpts []wasm.Option, baseAppOptions ...func(*baseapp.BaseApp),
) *TerraApp

NewTerraApp returns a reference to an initialized TerraApp.

func (*TerraApp) AppCodec

func (app *TerraApp) AppCodec() codec.Codec

AppCodec returns Gaia's app codec.

NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.

func (*TerraApp) BeginBlocker

func (app *TerraApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

BeginBlocker application updates every begin block

func (*TerraApp) BlacklistedAccAddrs

func (app *TerraApp) BlacklistedAccAddrs() map[string]bool

BlacklistedAccAddrs returns all the app's module account addresses black listed for receiving tokens.

func (*TerraApp) EndBlocker

func (app *TerraApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock

EndBlocker application updates every end block

func (*TerraApp) ExportAppStateAndValidators

func (app *TerraApp) ExportAppStateAndValidators(
	forZeroHeight bool, jailAllowedAddrs []string,
) (servertypes.ExportedApp, error)

ExportAppStateAndValidators exports the state of the application for a genesis file.

func (*TerraApp) GetSubspace

func (app *TerraApp) GetSubspace(moduleName string) paramstypes.Subspace

GetSubspace returns a param subspace for a given module name.

NOTE: This is solely to be used for testing purposes.

func (*TerraApp) InitChainer

func (app *TerraApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain

InitChainer application update at chain initialization

func (*TerraApp) InterfaceRegistry

func (app *TerraApp) InterfaceRegistry() codectypes.InterfaceRegistry

InterfaceRegistry returns Gaia's InterfaceRegistry

func (*TerraApp) LegacyAmino

func (app *TerraApp) LegacyAmino() *codec.LegacyAmino

LegacyAmino returns TerraApp's amino codec.

NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.

func (*TerraApp) LoadHeight

func (app *TerraApp) LoadHeight(height int64) error

LoadHeight loads a particular height

func (*TerraApp) ModuleAccountAddrs

func (app *TerraApp) ModuleAccountAddrs() map[string]bool

ModuleAccountAddrs returns all the app's module account addresses.

func (*TerraApp) Name

func (app *TerraApp) Name() string

Name returns the name of the App

func (*TerraApp) RegisterAPIRoutes

func (app *TerraApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)

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

func (*TerraApp) RegisterTendermintService

func (app *TerraApp) RegisterTendermintService(clientCtx client.Context)

RegisterTendermintService implements the Application.RegisterTendermintService method.

func (*TerraApp) RegisterTxService

func (app *TerraApp) RegisterTxService(clientCtx client.Context)

RegisterTxService implements the Application.RegisterTxService method.

func (*TerraApp) SimulationManager

func (app *TerraApp) SimulationManager() *module.SimulationManager

SimulationManager implements the SimulationApp interface