refactor app folder and add 'make lint-strict' (classic-terra#168)

Makefile

@@ -204,7 +204,11 @@ lint:
 
 lint-fix:
 	sudo golangci-lint run --fix --out-format=tab --issues-exit-code=0
-.PHONY: lint lint-fix
+
+lint-strict:
+	find . -path './_build' -prune -o -type f -name '*.go' -exec gofumpt -w -l {} +
+
+.PHONY: lint lint-fix lint-strict
 
 format:
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/docs/statik/statik.go" -not -path "./tests/mocks/*" -not -name '*.pb.go' | xargs gofmt -w -s

app/README.md

@@ -0,0 +1,7 @@
+# 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

app/export.go

@@ -48,7 +48,8 @@ func (app *TerraApp) ExportAppStateAndValidators(
 
 // prepare for fresh start at zero height
 // NOTE zero height genesis is a temporary feature which will be deprecated
-//      in favour of export at a block height
+//
+//	in favour of export at a block height
 func (app *TerraApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []string) {
 	applyAllowedAddrs := false
 
@@ -154,7 +155,7 @@ func (app *TerraApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs
 
 	// Iterate through validators by power descending, reset bond heights, and
 	// update bond intra-tx counters.
-	store := ctx.KVStore(app.keys[stakingtypes.StoreKey])
+	store := ctx.KVStore(app.GetKVStoreKey()[stakingtypes.StoreKey])
 	iter := sdk.KVStoreReversePrefixIterator(store, stakingtypes.ValidatorsKey)
 	counter := int16(0)
 

app/keepers/keepers.go

@@ -0,0 +1,284 @@
+package keepers
+
+import (
+	ibctransferkeeper "github.com/cosmos/ibc-go/modules/apps/transfer/keeper"
+	ibctransfertypes "github.com/cosmos/ibc-go/modules/apps/transfer/types"
+	ibchost "github.com/cosmos/ibc-go/modules/core/24-host"
+	ibckeeper "github.com/cosmos/ibc-go/modules/core/keeper"
+
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	"github.com/cosmos/cosmos-sdk/codec"
+	servertypes "github.com/cosmos/cosmos-sdk/server/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	capabilitykeeper "github.com/cosmos/cosmos-sdk/x/capability/keeper"
+	capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types"
+	crisiskeeper "github.com/cosmos/cosmos-sdk/x/crisis/keeper"
+	crisistypes "github.com/cosmos/cosmos-sdk/x/crisis/types"
+	distrkeeper "github.com/cosmos/cosmos-sdk/x/distribution/keeper"
+	distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
+	evidencekeeper "github.com/cosmos/cosmos-sdk/x/evidence/keeper"
+	evidencetypes "github.com/cosmos/cosmos-sdk/x/evidence/types"
+	"github.com/cosmos/cosmos-sdk/x/feegrant"
+	feegrantkeeper "github.com/cosmos/cosmos-sdk/x/feegrant/keeper"
+	govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	mintkeeper "github.com/cosmos/cosmos-sdk/x/mint/keeper"
+	minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
+	paramskeeper "github.com/cosmos/cosmos-sdk/x/params/keeper"
+	paramstypes "github.com/cosmos/cosmos-sdk/x/params/types"
+	slashingkeeper "github.com/cosmos/cosmos-sdk/x/slashing/keeper"
+	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
+	stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
+	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	upgradekeeper "github.com/cosmos/cosmos-sdk/x/upgrade/keeper"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+
+	marketkeeper "github.com/classic-terra/core/x/market/keeper"
+	markettypes "github.com/classic-terra/core/x/market/types"
+	oraclekeeper "github.com/classic-terra/core/x/oracle/keeper"
+	oracletypes "github.com/classic-terra/core/x/oracle/types"
+	treasurykeeper "github.com/classic-terra/core/x/treasury/keeper"
+	treasurytypes "github.com/classic-terra/core/x/treasury/types"
+	wasmconfig "github.com/classic-terra/core/x/wasm/config"
+	wasmkeeper "github.com/classic-terra/core/x/wasm/keeper"
+	wasmtypes "github.com/classic-terra/core/x/wasm/types"
+
+	bankwasm "github.com/classic-terra/core/custom/bank/wasm"
+	distrwasm "github.com/classic-terra/core/custom/distribution/wasm"
+	govwasm "github.com/classic-terra/core/custom/gov/wasm"
+	stakingwasm "github.com/classic-terra/core/custom/staking/wasm"
+	marketwasm "github.com/classic-terra/core/x/market/wasm"
+	oraclewasm "github.com/classic-terra/core/x/oracle/wasm"
+	treasurywasm "github.com/classic-terra/core/x/treasury/wasm"
+
+	// unnamed import of statik for swagger UI support
+	_ "github.com/classic-terra/core/client/docs/statik"
+)
+
+type AppKeepers struct {
+	// appKeepers.keys to access the substores
+	keys    map[string]*sdk.KVStoreKey
+	tkeys   map[string]*sdk.TransientStoreKey
+	memKeys map[string]*sdk.MemoryStoreKey
+
+	// keepers
+	AccountKeeper    authkeeper.AccountKeeper
+	AuthzKeeper      authzkeeper.Keeper
+	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 appKeepers, so we can SetRouter on it correctly
+	EvidenceKeeper   evidencekeeper.Keeper
+	FeeGrantKeeper   feegrantkeeper.Keeper
+	TransferKeeper   ibctransferkeeper.Keeper
+	OracleKeeper     oraclekeeper.Keeper
+	MarketKeeper     marketkeeper.Keeper
+	TreasuryKeeper   treasurykeeper.Keeper
+	WasmKeeper       wasmkeeper.Keeper
+
+	// make scoped keepers public for test purposes
+	ScopedIBCKeeper      capabilitykeeper.ScopedKeeper
+	ScopedTransferKeeper capabilitykeeper.ScopedKeeper
+}
+
+func NewAppKeepers(
+	appCodec codec.Codec,
+	bApp *baseapp.BaseApp,
+	cdc *codec.LegacyAmino,
+	maccPerms map[string][]string,
+	allowedReceivingModAcc map[string]bool,
+	blockedAddress map[string]bool,
+	skipUpgradeHeights map[int64]bool,
+	homePath string,
+	invCheckPeriod uint,
+	wasmConfig *wasmconfig.Config,
+	appOpts servertypes.AppOptions,
+) AppKeepers {
+	appKeepers := AppKeepers{}
+
+	appKeepers.GenerateKeys()
+
+	// init params keeper and subspaces
+	appKeepers.ParamsKeeper = initParamsKeeper(appCodec, cdc, appKeepers.keys[paramstypes.StoreKey], appKeepers.tkeys[paramstypes.TStoreKey])
+	// set the BaseApp's parameter store
+	bApp.SetParamStore(appKeepers.ParamsKeeper.Subspace(baseapp.Paramspace).WithKeyTable(paramskeeper.ConsensusParamsKeyTable()))
+
+	// add capability keeper and ScopeToModule for ibc module
+	appKeepers.CapabilityKeeper = capabilitykeeper.NewKeeper(appCodec, appKeepers.keys[capabilitytypes.StoreKey], appKeepers.memKeys[capabilitytypes.MemStoreKey])
+	scopedIBCKeeper := appKeepers.CapabilityKeeper.ScopeToModule(ibchost.ModuleName)
+	scopedTransferKeeper := appKeepers.CapabilityKeeper.ScopeToModule(ibctransfertypes.ModuleName)
+
+	// Applications that wish to enforce statically created ScopedKeepers should call `Seal` after creating
+	// their scoped modules in `NewApp` with `ScopeToModule`
+	appKeepers.CapabilityKeeper.Seal()
+
+	// add keepers
+	appKeepers.AccountKeeper = authkeeper.NewAccountKeeper(
+		appCodec, appKeepers.keys[authtypes.StoreKey], appKeepers.GetSubspace(authtypes.ModuleName), authtypes.ProtoBaseAccount, maccPerms,
+	)
+	appKeepers.BankKeeper = bankkeeper.NewBaseKeeper(
+		appCodec, appKeepers.keys[banktypes.StoreKey], appKeepers.AccountKeeper, appKeepers.GetSubspace(banktypes.ModuleName), appKeepers.BlacklistedAccAddrs(maccPerms, allowedReceivingModAcc),
+	)
+	stakingKeeper := stakingkeeper.NewKeeper(
+		appCodec, appKeepers.keys[stakingtypes.StoreKey], appKeepers.AccountKeeper, appKeepers.BankKeeper, appKeepers.GetSubspace(stakingtypes.ModuleName),
+	)
+	appKeepers.MintKeeper = mintkeeper.NewKeeper(
+		appCodec, appKeepers.keys[minttypes.StoreKey], appKeepers.GetSubspace(minttypes.ModuleName), &stakingKeeper,
+		appKeepers.AccountKeeper, appKeepers.BankKeeper, authtypes.FeeCollectorName,
+	)
+	appKeepers.DistrKeeper = distrkeeper.NewKeeper(
+		appCodec, appKeepers.keys[distrtypes.StoreKey], appKeepers.GetSubspace(distrtypes.ModuleName), appKeepers.AccountKeeper, appKeepers.BankKeeper,
+		&stakingKeeper, authtypes.FeeCollectorName, appKeepers.BlacklistedAccAddrs(maccPerms, allowedReceivingModAcc),
+	)
+	appKeepers.SlashingKeeper = slashingkeeper.NewKeeper(
+		appCodec, appKeepers.keys[slashingtypes.StoreKey], &stakingKeeper, appKeepers.GetSubspace(slashingtypes.ModuleName),
+	)
+	appKeepers.CrisisKeeper = crisiskeeper.NewKeeper(
+		appKeepers.GetSubspace(crisistypes.ModuleName), invCheckPeriod, appKeepers.BankKeeper, authtypes.FeeCollectorName,
+	)
+
+	appKeepers.FeeGrantKeeper = feegrantkeeper.NewKeeper(appCodec, appKeepers.keys[feegrant.StoreKey], appKeepers.AccountKeeper)
+	appKeepers.UpgradeKeeper = upgradekeeper.NewKeeper(skipUpgradeHeights, appKeepers.keys[upgradetypes.StoreKey], appCodec, homePath, bApp)
+
+	// register the staking hooks
+	// NOTE: stakingKeeper above is passed by reference, so that it will contain these hooks
+	appKeepers.StakingKeeper = *stakingKeeper.SetHooks(
+		stakingtypes.NewMultiStakingHooks(appKeepers.DistrKeeper.Hooks(), appKeepers.SlashingKeeper.Hooks()),
+	)
+
+	appKeepers.AuthzKeeper = authzkeeper.NewKeeper(appKeepers.keys[authzkeeper.StoreKey], appCodec, bApp.MsgServiceRouter())
+
+	// Create IBC Keeper
+	appKeepers.IBCKeeper = ibckeeper.NewKeeper(
+		appCodec, appKeepers.keys[ibchost.StoreKey], appKeepers.GetSubspace(ibchost.ModuleName), appKeepers.StakingKeeper, appKeepers.UpgradeKeeper, scopedIBCKeeper,
+	)
+
+	// Create Transfer Keepers
+	appKeepers.TransferKeeper = ibctransferkeeper.NewKeeper(
+		appCodec, appKeepers.keys[ibctransfertypes.StoreKey], appKeepers.GetSubspace(ibctransfertypes.ModuleName),
+		appKeepers.IBCKeeper.ChannelKeeper, &appKeepers.IBCKeeper.PortKeeper,
+		appKeepers.AccountKeeper, appKeepers.BankKeeper, scopedTransferKeeper,
+	)
+
+	// Create static IBC router, add transfer route, then set and seal it
+	appKeepers.setIBCRouter()
+
+	// create evidence keeper with router
+	evidenceKeeper := evidencekeeper.NewKeeper(
+		appCodec, appKeepers.keys[evidencetypes.StoreKey], &appKeepers.StakingKeeper, appKeepers.SlashingKeeper,
+	)
+	// If evidence needs to be handled for the appKeepers, set routes in router here and seal
+	appKeepers.EvidenceKeeper = *evidenceKeeper
+
+	// Initialize terra module keepers
+	appKeepers.OracleKeeper = oraclekeeper.NewKeeper(
+		appCodec, appKeepers.keys[oracletypes.StoreKey], appKeepers.GetSubspace(oracletypes.ModuleName),
+		appKeepers.AccountKeeper, appKeepers.BankKeeper, appKeepers.DistrKeeper, &stakingKeeper, distrtypes.ModuleName,
+	)
+	appKeepers.MarketKeeper = marketkeeper.NewKeeper(
+		appCodec, appKeepers.keys[markettypes.StoreKey],
+		appKeepers.GetSubspace(markettypes.ModuleName),
+		appKeepers.AccountKeeper, appKeepers.BankKeeper, appKeepers.OracleKeeper,
+	)
+	appKeepers.TreasuryKeeper = treasurykeeper.NewKeeper(
+		appCodec, appKeepers.keys[treasurytypes.StoreKey],
+		appKeepers.GetSubspace(treasurytypes.ModuleName),
+		appKeepers.AccountKeeper, appKeepers.BankKeeper,
+		appKeepers.MarketKeeper, appKeepers.OracleKeeper,
+		appKeepers.StakingKeeper, appKeepers.DistrKeeper,
+		distrtypes.ModuleName)
+
+	appKeepers.WasmKeeper = wasmkeeper.NewKeeper(
+		appCodec,
+		appKeepers.keys[wasmtypes.StoreKey],
+		appKeepers.GetSubspace(wasmtypes.ModuleName),
+		appKeepers.AccountKeeper,
+		appKeepers.BankKeeper,
+		appKeepers.TreasuryKeeper,
+		bApp.MsgServiceRouter(),
+		bApp.GRPCQueryRouter(),
+		wasmtypes.DefaultFeatures,
+		homePath,
+		wasmConfig,
+	)
+
+	// register wasm msg parser & querier
+	appKeepers.WasmKeeper.RegisterMsgParsers(map[string]wasmtypes.WasmMsgParserInterface{
+		wasmtypes.WasmMsgParserRouteBank:         bankwasm.NewWasmMsgParser(),
+		wasmtypes.WasmMsgParserRouteStaking:      stakingwasm.NewWasmMsgParser(),
+		wasmtypes.WasmMsgParserRouteMarket:       marketwasm.NewWasmMsgParser(),
+		wasmtypes.WasmMsgParserRouteWasm:         wasmkeeper.NewWasmMsgParser(),
+		wasmtypes.WasmMsgParserRouteDistribution: distrwasm.NewWasmMsgParser(),
+		wasmtypes.WasmMsgParserRouteGov:          govwasm.NewWasmMsgParser(),
+	}, wasmkeeper.NewStargateWasmMsgParser(appCodec))
+	appKeepers.WasmKeeper.RegisterQueriers(map[string]wasmtypes.WasmQuerierInterface{
+		wasmtypes.WasmQueryRouteBank:     bankwasm.NewWasmQuerier(appKeepers.BankKeeper),
+		wasmtypes.WasmQueryRouteStaking:  stakingwasm.NewWasmQuerier(appKeepers.StakingKeeper, appKeepers.DistrKeeper),
+		wasmtypes.WasmQueryRouteMarket:   marketwasm.NewWasmQuerier(appKeepers.MarketKeeper),
+		wasmtypes.WasmQueryRouteOracle:   oraclewasm.NewWasmQuerier(appKeepers.OracleKeeper),
+		wasmtypes.WasmQueryRouteTreasury: treasurywasm.NewWasmQuerier(appKeepers.TreasuryKeeper),
+		wasmtypes.WasmQueryRouteWasm:     wasmkeeper.NewWasmQuerier(appKeepers.WasmKeeper),
+	}, wasmkeeper.NewStargateWasmQuerier(appKeepers.WasmKeeper))
+
+	// register the proposal types
+	govRouter := appKeepers.getGovRouter()
+	appKeepers.GovKeeper = govkeeper.NewKeeper(
+		appCodec, appKeepers.keys[govtypes.StoreKey], appKeepers.GetSubspace(govtypes.ModuleName), appKeepers.AccountKeeper, appKeepers.BankKeeper,
+		&stakingKeeper, govRouter,
+	)
+
+	appKeepers.ScopedIBCKeeper = scopedIBCKeeper
+	appKeepers.ScopedTransferKeeper = scopedTransferKeeper
+
+	return appKeepers
+}
+
+// initParamsKeeper init params keeper and its subspaces
+func initParamsKeeper(appCodec codec.BinaryCodec, legacyAmino *codec.LegacyAmino, key, tkey sdk.StoreKey) paramskeeper.Keeper {
+	paramsKeeper := paramskeeper.NewKeeper(appCodec, legacyAmino, key, tkey)
+
+	paramsKeeper.Subspace(authtypes.ModuleName)
+	paramsKeeper.Subspace(banktypes.ModuleName)
+	paramsKeeper.Subspace(stakingtypes.ModuleName)
+	paramsKeeper.Subspace(minttypes.ModuleName)
+	paramsKeeper.Subspace(distrtypes.ModuleName)
+	paramsKeeper.Subspace(slashingtypes.ModuleName)
+	paramsKeeper.Subspace(govtypes.ModuleName).WithKeyTable(govtypes.ParamKeyTable())
+	paramsKeeper.Subspace(crisistypes.ModuleName)
+	paramsKeeper.Subspace(ibctransfertypes.ModuleName)
+	paramsKeeper.Subspace(ibchost.ModuleName)
+	paramsKeeper.Subspace(markettypes.ModuleName)
+	paramsKeeper.Subspace(oracletypes.ModuleName)
+	paramsKeeper.Subspace(treasurytypes.ModuleName)
+	paramsKeeper.Subspace(wasmtypes.ModuleName)
+
+	return paramsKeeper
+}
+
+// GetSubspace returns a param subspace for a given module name.
+func (appKeepers *AppKeepers) GetSubspace(moduleName string) paramstypes.Subspace {
+	subspace, _ := appKeepers.ParamsKeeper.GetSubspace(moduleName)
+	return subspace
+}
+
+// BlacklistedAccAddrs returns all the app's module account addresses black listed for receiving tokens.
+func (appKeepers *AppKeepers) BlacklistedAccAddrs(maccPerms map[string][]string, allowedReceivingModAcc map[string]bool) map[string]bool {
+	blacklistedAddrs := make(map[string]bool)
+	for acc := range maccPerms {
+		blacklistedAddrs[authtypes.NewModuleAddress(acc).String()] = !allowedReceivingModAcc[acc]
+	}
+
+	return blacklistedAddrs
+}