feat: migrate x/capability to app wiring #12058
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package cosmos.capability.module.v1; | ||
|
|
||
| import "cosmos/app/v1alpha1/module.proto"; | ||
|
|
||
| // Module is the config object of the capability module. | ||
| message Module { | ||
| option (cosmos.app.v1alpha1.module) = { | ||
| go_import: "github.com/cosmos/cosmos-sdk/x/capability" | ||
| }; | ||
|
|
||
| // seal_keeper defines if keeper.Seal() will run on BeginBlock() to prevent further modules from creating a scoped | ||
| // keeper. For more details check x/capability/keeper.go. | ||
| bool seal_keeper = 1; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -208,102 +208,81 @@ func NewSimApp( | |
| homePath string, invCheckPeriod uint, encodingConfig simappparams.EncodingConfig, | ||
| appOpts servertypes.AppOptions, baseAppOptions ...func(*baseapp.BaseApp), | ||
| ) *SimApp { | ||
| app := &SimApp{ | ||
| invCheckPeriod: invCheckPeriod, | ||
| } | ||
|
|
||
| var appBuilder *runtime.AppBuilder | ||
|
|
||
| err := depinject.Inject(AppConfig, | ||
| &appBuilder, | ||
| &app.ParamsKeeper, | ||
| &app.CapabilityKeeper, | ||
| &app.appCodec, | ||
| &app.legacyAmino, | ||
| &app.interfaceRegistry, | ||
| &app.AccountKeeper, | ||
| &app.BankKeeper, | ||
| ) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| app.App = appBuilder.Build(logger, db, traceStore, baseAppOptions...) | ||
|
|
||
| app.keys = sdk.NewKVStoreKeys( | ||
| stakingtypes.StoreKey, minttypes.StoreKey, distrtypes.StoreKey, | ||
| slashingtypes.StoreKey, govtypes.StoreKey, upgradetypes.StoreKey, | ||
| feegrant.StoreKey, evidencetypes.StoreKey, authzkeeper.StoreKey, | ||
| nftkeeper.StoreKey, group.StoreKey, | ||
| ) | ||
| // NOTE: The testingkey is just mounted for testing purposes. Actual applications should | ||
| // not include this key. | ||
| app.memKeys = sdk.NewMemoryStoreKeys("testingkey") | ||
|
|
||
| // configure state listening capabilities using AppOptions | ||
| // we are doing nothing with the returned streamingServices and waitGroup in this case | ||
| if _, _, err := streaming.LoadStreamingServices(app.App.BaseApp, appOpts, app.appCodec, app.keys); err != nil { | ||
| tmos.Exit(err.Error()) | ||
| } | ||
|
|
||
| initParamsKeeper(app.ParamsKeeper) | ||
|
|
||
| // add keepers | ||
| stakingKeeper := stakingkeeper.NewKeeper( | ||
| app.appCodec, app.keys[stakingtypes.StoreKey], app.AccountKeeper, app.BankKeeper, app.GetSubspace(stakingtypes.ModuleName), | ||
| ) | ||
| app.MintKeeper = mintkeeper.NewKeeper( | ||
| app.appCodec, app.keys[minttypes.StoreKey], app.GetSubspace(minttypes.ModuleName), &stakingKeeper, | ||
| app.AccountKeeper, app.BankKeeper, authtypes.FeeCollectorName, | ||
| ) | ||
| app.DistrKeeper = distrkeeper.NewKeeper( | ||
| app.appCodec, app.keys[distrtypes.StoreKey], app.GetSubspace(distrtypes.ModuleName), app.AccountKeeper, app.BankKeeper, | ||
| &stakingKeeper, authtypes.FeeCollectorName, | ||
| ) | ||
| app.SlashingKeeper = slashingkeeper.NewKeeper( | ||
| app.appCodec, app.keys[slashingtypes.StoreKey], &stakingKeeper, app.GetSubspace(slashingtypes.ModuleName), | ||
| ) | ||
| app.CrisisKeeper = crisiskeeper.NewKeeper( | ||
| app.GetSubspace(crisistypes.ModuleName), invCheckPeriod, app.BankKeeper, authtypes.FeeCollectorName, | ||
| ) | ||
|
|
||
| app.FeeGrantKeeper = feegrantkeeper.NewKeeper(app.appCodec, app.keys[feegrant.StoreKey], app.AccountKeeper) | ||
|
|
||
| // register the staking hooks | ||
| // NOTE: stakingKeeper above is passed by reference, so that it will contain these hooks | ||
| app.StakingKeeper = *stakingKeeper.SetHooks( | ||
| stakingtypes.NewMultiStakingHooks(app.DistrKeeper.Hooks(), app.SlashingKeeper.Hooks()), | ||
| ) | ||
|
|
||
| app.AuthzKeeper = authzkeeper.NewKeeper(app.keys[authzkeeper.StoreKey], app.appCodec, app.MsgServiceRouter(), app.AccountKeeper) | ||
|
|
||
| groupConfig := group.DefaultConfig() | ||
| /* | ||
| Example of setting group params: | ||
| groupConfig.MaxMetadataLen = 1000 | ||
| */ | ||
| app.GroupKeeper = groupkeeper.NewKeeper(app.keys[group.StoreKey], app.appCodec, app.MsgServiceRouter(), app.AccountKeeper, groupConfig) | ||
|
|
||
| // register the proposal types | ||
| govRouter := govv1beta1.NewRouter() | ||
|
|
@@ -317,7 +296,7 @@ func NewSimApp( | |
| govConfig.MaxMetadataLen = 10000 | ||
| */ | ||
| govKeeper := govkeeper.NewKeeper( | ||
| app.appCodec, app.keys[govtypes.StoreKey], app.GetSubspace(govtypes.ModuleName), app.AccountKeeper, app.BankKeeper, | ||
| &stakingKeeper, govRouter, app.MsgServiceRouter(), govConfig, | ||
| ) | ||
|
|
||
|
|
@@ -327,13 +306,13 @@ func NewSimApp( | |
| ), | ||
| ) | ||
| // set the governance module account as the authority for conducting upgrades | ||
| app.UpgradeKeeper = upgradekeeper.NewKeeper(skipUpgradeHeights, app.keys[upgradetypes.StoreKey], app.appCodec, homePath, app.BaseApp, authtypes.NewModuleAddress(govtypes.ModuleName).String()) | ||
|
|
||
| app.NFTKeeper = nftkeeper.NewKeeper(app.keys[nftkeeper.StoreKey], app.appCodec, app.AccountKeeper, app.BankKeeper) | ||
|
|
||
| // create evidence keeper with router | ||
| evidenceKeeper := evidencekeeper.NewKeeper( | ||
| app.appCodec, app.keys[evidencetypes.StoreKey], &app.StakingKeeper, app.SlashingKeeper, | ||
| ) | ||
| // If evidence needs to be handled for the app, set routes in router here and seal | ||
| app.EvidenceKeeper = *evidenceKeeper | ||
|
|
@@ -352,19 +331,18 @@ func NewSimApp( | |
| encodingConfig.TxConfig, | ||
| ), | ||
| vesting.NewAppModule(app.AccountKeeper, app.BankKeeper), | ||
| crisis.NewAppModule(&app.CrisisKeeper, skipGenesisInvariants), | ||
| feegrantmodule.NewAppModule(app.appCodec, app.AccountKeeper, app.BankKeeper, app.FeeGrantKeeper, app.interfaceRegistry), | ||
| gov.NewAppModule(app.appCodec, app.GovKeeper, app.AccountKeeper, app.BankKeeper), | ||
| mint.NewAppModule(app.appCodec, app.MintKeeper, app.AccountKeeper, nil), | ||
| slashing.NewAppModule(app.appCodec, app.SlashingKeeper, app.AccountKeeper, app.BankKeeper, app.StakingKeeper), | ||
| distr.NewAppModule(app.appCodec, app.DistrKeeper, app.AccountKeeper, app.BankKeeper, app.StakingKeeper), | ||
| staking.NewAppModule(app.appCodec, app.StakingKeeper, app.AccountKeeper, app.BankKeeper), | ||
| upgrade.NewAppModule(app.UpgradeKeeper), | ||
| evidence.NewAppModule(app.EvidenceKeeper), | ||
| authzmodule.NewAppModule(app.appCodec, app.AuthzKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry), | ||
| groupmodule.NewAppModule(app.appCodec, app.GroupKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry), | ||
| nftmodule.NewAppModule(app.appCodec, app.NFTKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry), | ||
| ) | ||
| if err != nil { | ||
| panic(err) | ||
|
|
@@ -402,27 +380,26 @@ func NewSimApp( | |
| // NOTE: this is not required apps that don't use the simulator for fuzz testing | ||
| // transactions | ||
| app.sm = module.NewSimulationManager( | ||
| auth.NewAppModule(app.appCodec, app.AccountKeeper, authsims.RandomGenesisAccounts), | ||
| bank.NewAppModule(app.appCodec, app.BankKeeper, app.AccountKeeper), | ||
| feegrantmodule.NewAppModule(app.appCodec, app.AccountKeeper, app.BankKeeper, app.FeeGrantKeeper, app.interfaceRegistry), | ||
| gov.NewAppModule(app.appCodec, app.GovKeeper, app.AccountKeeper, app.BankKeeper), | ||
| mint.NewAppModule(app.appCodec, app.MintKeeper, app.AccountKeeper, nil), | ||
| staking.NewAppModule(app.appCodec, app.StakingKeeper, app.AccountKeeper, app.BankKeeper), | ||
| distr.NewAppModule(app.appCodec, app.DistrKeeper, app.AccountKeeper, app.BankKeeper, app.StakingKeeper), | ||
| slashing.NewAppModule(app.appCodec, app.SlashingKeeper, app.AccountKeeper, app.BankKeeper, app.StakingKeeper), | ||
| params.NewAppModule(app.ParamsKeeper), | ||
| evidence.NewAppModule(app.EvidenceKeeper), | ||
| authzmodule.NewAppModule(app.appCodec, app.AuthzKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry), | ||
| groupmodule.NewAppModule(app.appCodec, app.GroupKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry), | ||
| nftmodule.NewAppModule(app.appCodec, app.NFTKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry), | ||
| ) | ||
|
|
||
| app.sm.RegisterStoreDecoders() | ||
|
|
||
| // initialize stores | ||
| app.MountKVStores(app.keys) | ||
| app.MountMemoryStores(app.memKeys) | ||
|
|
||
| // initialize BaseApp | ||
| app.SetTxDecoder(encodingConfig.TxConfig.TxDecoder()) | ||
|
|
@@ -547,7 +524,18 @@ func (app *SimApp) GetTKey(storeKey string) *storetypes.TransientStoreKey { | |
| // | ||
| // NOTE: This is solely used for testing purposes. | ||
| func (app *SimApp) GetMemKey(storeKey string) *storetypes.MemoryStoreKey { | ||
| msk := app.memKeys[storeKey] | ||
| if msk != nil { | ||
| return msk | ||
| } | ||
|
|
||
| sk := app.UnsafeFindStoreKey(storeKey) | ||
|
There was a problem hiding this comment. When would a mem key be found in the list of real store keys? There was a problem hiding this comment.
Lines 115 to 119 in 8eaff8f |
||
| memStoreKey, ok := sk.(*storetypes.MemoryStoreKey) | ||
| if !ok { | ||
| return nil | ||
| } | ||
|
|
||
| return memStoreKey | ||
| } | ||
|
|
||
| // GetSubspace returns a param subspace for a given module name. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if adding this to baseapp is the way to go
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the context here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
runtime/builder uses baseApps'
MountStores. Without this addition we get this errorUnrecognized store key type :*types.MemoryStoreKey.I think that if we filter out any
MemoryStoreKeys before calling this everything works just fine... I don't know enough about these things to know exactly what's up 😅cosmos-sdk/runtime/builder.go
Lines 27 to 41 in 8eaff8f
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nvm tried again removing it and it doesn't work
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not really sure about this code. I'd have to delegate to @aaronc here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this addition is correct. IMHO the fact that the multi-store doesn't know how to map store keys -> store types is a really strange and error prone. So this patch is sort of needed, but really the multi-store design should be cleaned up a bit