app

package
v4.2.9 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 151 Imported by: 0

Documentation

Overview

Copyright 2016 All in Bits, Inc (licensed under the Apache License, Version 2.0) Modifications Copyright (c) 2021-present Crypto.org (licensed under the Apache License, Version 2.0)

Index

Constants

View Source 
const (
	// values chosen arbitrarily
	MaxClassIDLength      = 2048
	MaxTokenIds           = 256
	MaxTokenIDLength      = 2048
	MaximumReceiverLength = 2048
)

Variables

View Source 
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{},
		bank.AppModuleBasic{},
		capability.AppModuleBasic{},
		staking.AppModuleBasic{},
		mint.AppModuleBasic{},
		distr.AppModuleBasic{},
		gov.NewAppModuleBasic([]govclient.ProposalHandler{
			paramsclient.ProposalHandler,
			distrclient.ProposalHandler,
			upgradeclient.LegacyProposalHandler,
			upgradeclient.LegacyCancelProposalHandler,
			ibcclientclient.UpdateClientProposalHandler,
			ibcclientclient.UpgradeProposalHandler,
		}),
		params.AppModuleBasic{},
		slashing.AppModuleBasic{},
		feegrantmodule.AppModuleBasic{},
		ibc.AppModuleBasic{},
		upgrade.AppModuleBasic{},
		evidence.AppModuleBasic{},
		transfer.AppModuleBasic{},
		nfttransfer.AppModuleBasic{},
		authzmodule.AppModuleBasic{},
		groupmodule.AppModuleBasic{},
		vesting.AppModuleBasic{},
		ica.AppModuleBasic{},
		icaauthmodule.AppModuleBasic{},
		ibcfee.AppModuleBasic{},
		supply.AppModuleBasic{},
		chainmain.AppModuleBasic{},
		nft.AppModuleBasic{},
	)
)
View Source 
var DefaultConsensusParams = &abci.ConsensusParams{
	Block: &abci.BlockParams{
		MaxBytes: 200000,
		MaxGas:   2000000,
	},
	Evidence: &tmproto.EvidenceParams{
		MaxAgeNumBlocks: 302400,
		MaxAgeDuration:  504 * time.Hour,
		MaxBytes:        10000,
	},
	Validator: &tmproto.ValidatorParams{
		PubKeyTypes: []string{
			tmtypes.ABCIPubKeyTypeEd25519,
		},
	},
}

DefaultConsensusParams defines the default Tendermint consensus params used in ChainApp testing.

View Source 
var SlashingForkHeights = map[string]int64{
	"testnet-croeseid-4":                    14857500,
	"tempcrypto-org-chain-mainnet-dryrun-1": 6782000,
	"crypto-org-chain-mainnet-1":            16978800,
}

Functions

func AddTestAddrs 

func AddTestAddrs(app *ChainApp, ctx sdk.Context, accNum int, accAmt sdkmath.Int) []sdk.AccAddress

AddTestAddrs constructs and returns accNum amount of accounts with an initial balance of accAmt in random order

func AddTestAddrsFromPubKeys 

func AddTestAddrsFromPubKeys(app *ChainApp, ctx sdk.Context, pubKeys []cryptotypes.PubKey, accAmt sdkmath.Int)

AddTestAddrsFromPubKeys adds the addresses into the ChainApp providing only the public keys.

func AddTestAddrsIncremental 

func AddTestAddrsIncremental(app *ChainApp, ctx sdk.Context, accNum int, accAmt sdkmath.Int) []sdk.AccAddress

AddTestAddrs constructs and returns accNum amount of accounts with an initial balance of accAmt in random order

func AppStateFn 

func AppStateFn(cdc codec.JSONCodec, simManager *module.SimulationManager) simtypes.AppStateFn

AppStateFn returns the initial application state using a genesis or the simulation parameters. It panics if the user provides files for both of them. If a file is not given for the genesis or the sim params, it creates a randomized one. nolint:revive

func CheckBalance 

func CheckBalance(t *testing.T, app *ChainApp, addr sdk.AccAddress, balances sdk.Coins)

CheckBalance checks the balance of an account.

func ConvertAddrsToValAddrs 

func ConvertAddrsToValAddrs(addrs []sdk.AccAddress) []sdk.ValAddress

ConvertAddrsToValAddrs converts the provided addresses to ValAddress.

func CreateTestPubKeys 

func CreateTestPubKeys(numPubKeys int) []cryptotypes.PubKey

CreateTestPubKeys returns a total of numPubKeys public keys in ascending order.

func FundAccount 

func FundAccount(app *ChainApp, ctx sdk.Context, addr sdk.AccAddress, amounts sdk.Coins) error

FundAccount is a utility function that funds an account by minting and sending the coins to the address. This should be used for testing purposes only!

TODO: Instead of using the mint module account, which has the permission of minting, create a "faucet" account. (@fdymylja)

func FundModuleAccount 

func FundModuleAccount(app *ChainApp, ctx sdk.Context, recipientMod string, amounts sdk.Coins) error

FundModuleAccount is a utility function that funds a module account by minting and sending the coins to the address. This should be used for testing purposes only!

TODO: Instead of using the mint module account, which has the permission of minting, create a "faucet" account. (@fdymylja)

func GenSequenceOfTxs 

func GenSequenceOfTxs(txGen client.TxConfig, msgs []sdk.Msg, accNums []uint64, initSeqNums []uint64, numToGenerate int, priv ...cryptotypes.PrivKey) ([]sdk.Tx, error)

GenSequenceOfTxs generates a set of signed transactions of messages, such that they differ only by having the sequence numbers incremented between every transaction.

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 NewAnteHandler 

func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error)

func NewPubKeyFromHex 

func NewPubKeyFromHex(pk string) (res cryptotypes.PubKey)

NewPubKeyFromHex returns a PubKey from a hex string.

func RegisterSwaggerAPI 

func RegisterSwaggerAPI(ctx client.Context, rtr *mux.Router)

RegisterSwaggerAPI registers swagger route with API Server

func SignCheckDeliver 

func SignCheckDeliver(
	t *testing.T, txCfg client.TxConfig, app *bam.BaseApp, header tmproto.Header, msgs []sdk.Msg,
	chainID string, accNums, accSeqs []uint64, expSimPass, expPass bool, priv ...cryptotypes.PrivKey,
) (sdk.GasInfo, *sdk.Result, error)

SignCheckDeliver checks a generated signed transaction and simulates a block commitment with the given transaction. A test assertion is made using the parameter 'expPass' against the result. A corresponding result is returned.

func SlashingForkEnabled added in v4.2.9 

func SlashingForkEnabled(ctx sdk.Context) bool

func StoreKeys added in v4.2.4 

func StoreKeys() (
	map[string]*storetypes.KVStoreKey,
	map[string]*storetypes.MemoryStoreKey,
	map[string]*storetypes.TransientStoreKey,
)

StoreKeys returns all the store keys to register in current app

func TestAddr 

func TestAddr(addr string, bech string) (sdk.AccAddress, error)

Types

type App 

type App 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,
	) (servertypes.ExportedApp, error)

	// All the registered module account addreses.
	ModuleAccountAddrs() map[string]bool
}

App implements the common methods for a Cosmos SDK-based application specific blockchain. (Amino is still needed for Ledger at the moment) nolint: staticcheck

type ChainApp 

type ChainApp 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
	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
	IBCFeeKeeper        ibcfeekeeper.Keeper
	ICAControllerKeeper icacontrollerkeeper.Keeper
	ICAHostKeeper       icahostkeeper.Keeper
	ICAAuthKeeper       icaauthmodulekeeper.Keeper
	AuthzKeeper         authzkeeper.Keeper
	EvidenceKeeper      evidencekeeper.Keeper
	FeeGrantKeeper      feegrantkeeper.Keeper
	GroupKeeper         groupkeeper.Keeper
	TransferKeeper      ibctransferkeeper.Keeper
	NFTTransferKeeper   nfttransferkeeper.Keeper

	SupplyKeeper supplykeeper.Keeper
	NFTKeeper    nftkeeper.Keeper

	// make scoped keepers public for test purposes
	ScopedIBCKeeper           capabilitykeeper.ScopedKeeper
	ScopedTransferKeeper      capabilitykeeper.ScopedKeeper
	ScopedNFTTransferKeeper   capabilitykeeper.ScopedKeeper
	ScopedIBCFeeKeeper        capabilitykeeper.ScopedKeeper
	ScopedICAControllerKeeper capabilitykeeper.ScopedKeeper
	ScopedICAHostKeeper       capabilitykeeper.ScopedKeeper
	ScopedICAAuthKeeper       capabilitykeeper.ScopedKeeper
	// contains filtered or unexported fields
}

ChainApp 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. (Amino is still needed for Ledger at the moment) nolint: staticcheck

func New 

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

New returns a reference to an initialized Chain.

func Setup 

func Setup(t *testing.T, isCheckTx bool) *ChainApp

Setup initializes a new ChainApp. A Nop logger is set in ChainApp.

func SetupWithGenesisAccounts 

func SetupWithGenesisAccounts(genAccs []authtypes.GenesisAccount, balances ...banktypes.Balance) *ChainApp

SetupWithGenesisAccounts initializes a new ChainApp with the provided genesis accounts and possible balances.

func SetupWithGenesisValSet 

func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount, balances ...banktypes.Balance) *ChainApp

SetupWithGenesisValSet initializes a new ChainApp with a validator set and genesis accounts that also act as delegators. For simplicity, each validator is bonded with a delegation of one consensus engine unit (10^6) in the default token of the simapp from first genesis account. A Nop logger is set in ChainApp.

func (*ChainApp) AppCodec 

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

AppCodec returns Chain'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 (*ChainApp) BeginBlocker 

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

BeginBlocker application updates every begin block

func (*ChainApp) Close added in v4.2.8 

func (app *ChainApp) Close() error

Close will be called in graceful shutdown in start cmd

func (*ChainApp) EndBlocker 

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

EndBlocker application updates every end block

func (*ChainApp) ExportAppStateAndValidators 

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

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

func (*ChainApp) GetKey 

func (app *ChainApp) 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 (*ChainApp) GetMemKey 

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

GetMemKey returns the MemStoreKey for the provided mem key.

NOTE: This is solely used for testing purposes.

func (*ChainApp) GetSubspace 

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

func (app *ChainApp) 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 (*ChainApp) InitChainer 

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

InitChainer application update at chain initialization

func (*ChainApp) InterfaceRegistry 

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

InterfaceRegistry returns Chain's InterfaceRegistry

func (*ChainApp) LegacyAmino 

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

LegacyAmino returns ChainApp'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. (Amino is still needed for Ledger at the moment) nolint: staticcheck

func (*ChainApp) LoadHeight 

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

LoadHeight loads a particular height

func (*ChainApp) ModuleAccountAddrs 

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

ModuleAccountAddrs returns all the app's module account addresses.

func (*ChainApp) Name 

func (app *ChainApp) Name() string

Name returns the name of the App

func (*ChainApp) RegisterAPIRoutes 

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

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

func (*ChainApp) RegisterNodeService 

func (app *ChainApp) RegisterNodeService(clientCtx client.Context)

func (*ChainApp) RegisterTendermintService 

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

RegisterTendermintService implements the Application.RegisterTendermintService method.

func (*ChainApp) RegisterTxService 

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

RegisterTxService implements the Application.RegisterTxService method.

func (*ChainApp) RegisterUpgradeHandlers added in v4.2.7 

func (app *ChainApp) RegisterUpgradeHandlers()

func (*ChainApp) SimulationManager 

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

SimulationManager implements the SimulationApp interface

type EmptyAppOptions 

type EmptyAppOptions struct{}

EmptyAppOptions is a stub implementing AppOptions

func (EmptyAppOptions) Get 

func (ao EmptyAppOptions) Get(o string) interface{}

Get implements AppOptions

type GenerateAccountStrategy 

type GenerateAccountStrategy func(int) []sdk.AccAddress

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.

func NewDefaultGenesisState 

func NewDefaultGenesisState(cdc codec.JSONCodec) GenesisState

NewDefaultGenesisState generates the default state for the application.

type HandlerOptions 

type HandlerOptions struct {
	ante.HandlerOptions

	IBCKeeper *keeper.Keeper
}

HandlerOptions extend the SDK's AnteHandler options by requiring the IBC channel keeper.

type ValidateMsgTransferDecorator added in v4.2.8 

type ValidateMsgTransferDecorator struct{}

ValidateMsgTransferDecorator is a temporary decorator that limit the field length of MsgTransfer message.

func NewValidateMsgTransferDecorator added in v4.2.8 

func NewValidateMsgTransferDecorator() ValidateMsgTransferDecorator

func (ValidateMsgTransferDecorator) AnteHandle added in v4.2.8 

func (vtd ValidateMsgTransferDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error)

Source Files

View all Source files

Directories

Path Synopsis
docs
statik

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.