app

Documentation

Index

• Constants
• Variables
• func GenerateValidBlockData(t *testing.T, txConfig client.TxConfig, signer *types.KeyringSigner, ...) (coretypes.Data, error)
• func GetMaccPerms() map[string][]string
• type App
  • func New(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bool, ...) *App
  • func (app *App) AppCodec() codec.Codec
  • func (app *App) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (app *App) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
  • func (app *App) ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs []string) (servertypes.ExportedApp, error)
  • func (app *App) GetKey(storeKey string) *storetypes.KVStoreKey
  • func (app *App) GetMemKey(storeKey string) *storetypes.MemoryStoreKey
  • func (app *App) GetSubspace(moduleName string) paramstypes.Subspace
  • func (app *App) GetTKey(storeKey string) *storetypes.TransientStoreKey
  • func (app *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
  • func (app *App) InterfaceRegistry() types.InterfaceRegistry
  • func (app *App) LegacyAmino() *codec.LegacyAmino
  • func (app *App) LoadHeight(height int64) error
  • func (app *App) ModuleAccountAddrs() map[string]bool
  • func (app *App) Name() string
  • func (app *App) PrepareProposal(req abci.RequestPrepareProposal) abci.ResponsePrepareProposal
  • func (app *App) ProcessProposal(req abci.RequestProcessProposal) abci.ResponseProcessProposal
  • func (app *App) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)
  • func (app *App) RegisterTendermintService(clientCtx client.Context)
  • func (app *App) RegisterTxService(clientCtx client.Context)
• type GenesisState

Constants

const (
	AccountAddressPrefix = "celestia"
	Name                 = "celestia-app"
	// BondDenom defines the native staking token denomination.
	BondDenom = "utia"
	// BondDenomAlias defines an alias for BondDenom.
	BondDenomAlias = "microtia"
	// DisplayDenom defines the name, symbol, and display value of the Celestia token.
	DisplayDenom = "TIA"
)

const (
	TestAccountName = "test-account"
)

Variables

var (
	// Bech32PrefixAccAddr defines the Bech32 prefix of an account's address.
	Bech32PrefixAccAddr = AccountAddressPrefix
	// Bech32PrefixAccPub defines the Bech32 prefix of an account's public key.
	Bech32PrefixAccPub = AccountAddressPrefix + sdk.PrefixPublic
	// Bech32PrefixValAddr defines the Bech32 prefix of a validator's operator address.
	Bech32PrefixValAddr = AccountAddressPrefix + sdk.PrefixValidator + sdk.PrefixOperator
	// Bech32PrefixValPub defines the Bech32 prefix of a validator's operator public key.
	Bech32PrefixValPub = AccountAddressPrefix + sdk.PrefixValidator + sdk.PrefixOperator + sdk.PrefixPublic
	// Bech32PrefixConsAddr defines the Bech32 prefix of a consensus node address.
	Bech32PrefixConsAddr = AccountAddressPrefix + sdk.PrefixValidator + sdk.PrefixConsensus
	// Bech32PrefixConsPub defines the Bech32 prefix of a consensus node public key.
	Bech32PrefixConsPub = AccountAddressPrefix + sdk.PrefixValidator + sdk.PrefixConsensus + sdk.PrefixPublic
)

These constants are derived from the above variables. These are the ones we will want to use in the code, based on any overrides above.

var (
	// DefaultNodeHome default home directories for the application daemon
	DefaultNodeHome string

	// ModuleBasics defines the module BasicManager is in charge of setting up basic,
	// non-dependant module elements, such as codec registration
	// and genesis verification.
	ModuleBasics = module.NewBasicManager(
		auth.AppModuleBasic{},
		genutil.AppModuleBasic{},
		bankModule{},
		capability.AppModuleBasic{},
		stakingModule{},
		mintModule{},
		distr.AppModuleBasic{},
		gov.NewAppModuleBasic(getGovProposalHandlers()),
		params.AppModuleBasic{},
		crisisModule{},
		slashing.AppModuleBasic{},
		feegrantmodule.AppModuleBasic{},

		upgrade.AppModuleBasic{},
		evidence.AppModuleBasic{},

		vesting.AppModuleBasic{},
		paymentmodule.AppModuleBasic{},
		qgbmodule.AppModuleBasic{},
	)

	// ModuleEncodingRegisters keeps track of all the module methods needed to
	// register interfaces and specific type to encoding config
	ModuleEncodingRegisters = moduleMapToSlice(ModuleBasics)
)

Functions

func GenerateValidBlockData

func GenerateValidBlockData(
	t *testing.T,
	txConfig client.TxConfig,
	signer *types.KeyringSigner,
	pfdCount,
	normalTxCount,
	size int,
) (coretypes.Data, error)

func GetMaccPerms

func GetMaccPerms() map[string][]string

GetMaccPerms returns a copy of the module account permissions

Types

type App

type App struct {
	*baseapp.BaseApp

	// keepers
	AccountKeeper    authkeeper.AccountKeeper
	BankKeeper       bankkeeper.Keeper
	CapabilityKeeper *capabilitykeeper.Keeper
	StakingKeeper    stakingkeeper.Keeper
	SlashingKeeper   slashingkeeper.Keeper
	MintKeeper       mintkeeper.Keeper
	DistrKeeper      distrkeeper.Keeper
	GovKeeper        govkeeper.Keeper
	CrisisKeeper     crisiskeeper.Keeper
	UpgradeKeeper    upgradekeeper.Keeper
	ParamsKeeper     paramskeeper.Keeper
	// IBCKeeper        *ibckeeper.Keeper // IBC Keeper must be a pointer in the app, so we can SetRouter on it correctly
	EvidenceKeeper evidencekeeper.Keeper
	// TransferKeeper   ibctransferkeeper.Keeper
	FeeGrantKeeper feegrantkeeper.Keeper

	// make scoped keepers public for test purposes
	ScopedIBCKeeper      capabilitykeeper.ScopedKeeper
	ScopedTransferKeeper capabilitykeeper.ScopedKeeper

	PaymentKeeper paymentmodulekeeper.Keeper
	QgbKeeper     qgbmodulekeeper.Keeper
	// contains filtered or unexported fields
}

App 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 New

func New(
	logger log.Logger,
	db dbm.DB,
	traceStore io.Writer,
	loadLatest bool,
	skipUpgradeHeights map[int64]bool,
	homePath string,
	invCheckPeriod uint,
	encodingConfig encoding.Config,
	appOpts servertypes.AppOptions,
	baseAppOptions ...func(*baseapp.BaseApp),
) *App

New returns a reference to an initialized celestia app.

func (*App) AppCodec

func (app *App) 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 (*App) BeginBlocker

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

BeginBlocker application updates every begin block

func (*App) EndBlocker

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

EndBlocker application updates every end block

func (*App) ExportAppStateAndValidators

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

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

func (*App) GetKey

func (app *App) GetKey(storeKey string) *storetypes.KVStoreKey

GetKey returns the KVStoreKey for the provided store key.

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

func (*App) GetMemKey

func (app *App) GetMemKey(storeKey string) *storetypes.MemoryStoreKey

GetMemKey returns the MemStoreKey for the provided mem key.

NOTE: This is solely used for testing purposes.

func (*App) GetSubspace

func (app *App) 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 (*App) GetTKey

func (app *App) GetTKey(storeKey string) *storetypes.TransientStoreKey

GetTKey returns the TransientStoreKey for the provided store key.

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

func (*App) InitChainer

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

InitChainer application update at chain initialization

func (*App) InterfaceRegistry

func (app *App) InterfaceRegistry() types.InterfaceRegistry

InterfaceRegistry returns Gaia's InterfaceRegistry

func (*App) LegacyAmino

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

LegacyAmino returns SimApp'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 (*App) LoadHeight

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

LoadHeight loads a particular height

func (*App) ModuleAccountAddrs

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

ModuleAccountAddrs returns all the app's module account addresses.

func (*App) Name

func (app *App) Name() string

Name returns the name of the App

func (*App) PrepareProposal

func (app *App) PrepareProposal(req abci.RequestPrepareProposal) abci.ResponsePrepareProposal

PrepareProposal fullfills the celestia-core version of the ABCI interface by preparing the proposal block data. The square size is determined by first estimating it via the size of the passed block data. Then the included MsgWirePayForData messages are malleated into MsgPayForData messages by separating the message and transaction that pays for that message. Lastly, this method generates the data root for the proposal block and passes it back to tendermint via the blockdata.

func (*App) ProcessProposal

func (app *App) ProcessProposal(req abci.RequestProcessProposal) abci.ResponseProcessProposal

func (*App) RegisterAPIRoutes

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

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

func (*App) RegisterTendermintService

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

RegisterTendermintService implements the Application.RegisterTendermintService method.

func (*App) RegisterTxService

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

RegisterTxService implements the Application.RegisterTxService method.

type GenesisState

type GenesisState map[string]json.RawMessage

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.