x/capability: Cap Initialization Fix (#9392)

This commit is contained in:
Aditya 2021-07-06 15:12:56 +02:00 committed by GitHub
parent 6c49c4a55c
commit 3776793ce6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 4 deletions

View File

@ -23,7 +23,7 @@ func ParamChanges(r *rand.Rand) []simtypes.ParamChange {
if err != nil { if err != nil {
panic(err) panic(err)
} }
return fmt.Sprintf("%s", paramsBytes) return string(paramsBytes)
}, },
), ),
simulation.NewSimParamChange(types.ModuleName, string(types.KeyDefaultSendEnabled), simulation.NewSimParamChange(types.ModuleName, string(types.KeyDefaultSendEnabled),

View File

@ -13,6 +13,14 @@ import (
"github.com/cosmos/cosmos-sdk/x/capability/types" "github.com/cosmos/cosmos-sdk/x/capability/types"
) )
// initialized is a global variable used by GetCapability to ensure that the memory store
// and capability map are correctly populated. A state-synced node may copy over all the persistent
// state and start running the application without having the in-memory state required for x/capability.
// Thus, we must initialized the memory stores on-the-fly during tx execution once the first GetCapability
// is called.
// This is a temporary fix and should be replaced by a more robust solution in the next breaking release.
var initialized = false
type ( type (
// Keeper defines the capability module's keeper. It is responsible for provisioning, // Keeper defines the capability module's keeper. It is responsible for provisioning,
// tracking, and authenticating capabilities at runtime. During application // tracking, and authenticating capabilities at runtime. During application
@ -342,6 +350,22 @@ func (sk ScopedKeeper) ReleaseCapability(ctx sdk.Context, cap *types.Capability)
// by name. The module is not allowed to retrieve capabilities which it does not // by name. The module is not allowed to retrieve capabilities which it does not
// own. // own.
func (sk ScopedKeeper) GetCapability(ctx sdk.Context, name string) (*types.Capability, bool) { func (sk ScopedKeeper) GetCapability(ctx sdk.Context, name string) (*types.Capability, bool) {
// Create a keeper that will set all in-memory mappings correctly into memstore and capmap if scoped keeper is not initialized yet.
// This ensures that the in-memory mappings are correctly filled in, in case this is a state-synced node.
// This is a temporary non-breaking fix, a future PR should store the reverse mapping in the persistent store and reconstruct forward mapping and capmap on the fly.
if !initialized {
// create context with infinite gas meter to avoid app state mismatch.
initCtx := ctx.WithGasMeter(sdk.NewInfiniteGasMeter())
k := Keeper{
cdc: sk.cdc,
storeKey: sk.storeKey,
memKey: sk.memKey,
capMap: sk.capMap,
}
k.InitializeAndSeal(initCtx)
initialized = true
}
if strings.TrimSpace(name) == "" { if strings.TrimSpace(name) == "" {
return nil, false return nil, false
} }
@ -358,6 +382,7 @@ func (sk ScopedKeeper) GetCapability(ctx sdk.Context, name string) (*types.Capab
// so we delete here to remove unnecessary values in map // so we delete here to remove unnecessary values in map
// TODO: Delete index correctly from capMap by storing some reverse lookup // TODO: Delete index correctly from capMap by storing some reverse lookup
// in-memory map. Issue: https://github.com/cosmos/cosmos-sdk/issues/7805 // in-memory map. Issue: https://github.com/cosmos/cosmos-sdk/issues/7805
return nil, false return nil, false
} }

View File

@ -1,7 +1,6 @@
package simulation package simulation
import ( import (
"fmt"
"math/rand" "math/rand"
gogotypes "github.com/gogo/protobuf/types" gogotypes "github.com/gogo/protobuf/types"
@ -19,13 +18,13 @@ func ParamChanges(r *rand.Rand) []simtypes.ParamChange {
simulation.NewSimParamChange(types.ModuleName, string(types.KeySendEnabled), simulation.NewSimParamChange(types.ModuleName, string(types.KeySendEnabled),
func(r *rand.Rand) string { func(r *rand.Rand) string {
sendEnabled := RadomEnabled(r) sendEnabled := RadomEnabled(r)
return fmt.Sprintf("%s", types.ModuleCdc.MustMarshalJSON(&gogotypes.BoolValue{Value: sendEnabled})) return string(types.ModuleCdc.MustMarshalJSON(&gogotypes.BoolValue{Value: sendEnabled}))
}, },
), ),
simulation.NewSimParamChange(types.ModuleName, string(types.KeyReceiveEnabled), simulation.NewSimParamChange(types.ModuleName, string(types.KeyReceiveEnabled),
func(r *rand.Rand) string { func(r *rand.Rand) string {
receiveEnabled := RadomEnabled(r) receiveEnabled := RadomEnabled(r)
return fmt.Sprintf("%s", types.ModuleCdc.MustMarshalJSON(&gogotypes.BoolValue{Value: receiveEnabled})) return string(types.ModuleCdc.MustMarshalJSON(&gogotypes.BoolValue{Value: receiveEnabled}))
}, },
), ),
} }