feat(x/params): add lru caching

contribs/gnodev/go.mod

@@ -54,6 +54,7 @@ require (
 	github.com/go-logfmt/logfmt v0.6.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect

contribs/gnogenesis/go.mod

@@ -21,6 +21,7 @@ require (
 	github.com/gnolang/overflow v0.0.0-20170615021017-4d914c927216 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect

contribs/gnokeykc/go.mod

@@ -25,6 +25,7 @@ require (
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/godbus/dbus/v5 v5.1.0 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect

contribs/gnomigrate/go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/gnolang/overflow v0.0.0-20170615021017-4d914c927216 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/gorilla/websocket v1.5.3 // indirect

gno.land/pkg/gnoland/app.go

@@ -34,11 +34,12 @@ import (
 
 // AppOptions contains the options to create the gno.land ABCI application.
 type AppOptions struct {
-	DB                dbm.DB             // required
-	Logger            *slog.Logger       // required
-	EventSwitch       events.EventSwitch // required
-	VMOutput          io.Writer          // optional
-	InitChainerConfig                    // options related to InitChainer
+	DB                 dbm.DB             // required
+	Logger             *slog.Logger       // required
+	EventSwitch        events.EventSwitch // required
+	VMOutput           io.Writer          // optional
+	InitChainerConfig                     // options related to InitChainer
+	ParamsMaxCacheSize int                // optional
 }
 
 // TestAppOptions provides a "ready" default [AppOptions] for use with
@@ -53,6 +54,7 @@ func TestAppOptions(db dbm.DB) *AppOptions {
 			StdlibDir:              filepath.Join(gnoenv.RootDir(), "gnovm", "stdlibs"),
 			CacheStdlibLoad:        true,
 		},
+		ParamsMaxCacheSize: 100,
 	}
 }
 
@@ -91,7 +93,7 @@ func NewAppWithOptions(cfg *AppOptions) (abci.Application, error) {
 	// Construct keepers.
 	acctKpr := auth.NewAccountKeeper(mainKey, ProtoGnoAccount)
 	bankKpr := bank.NewBankKeeper(acctKpr)
-	paramsKpr := params.NewParamsKeeper(mainKey, "vm")
+	paramsKpr := params.NewParamsKeeper(mainKey, "vm", cfg.ParamsMaxCacheSize)
 	vmk := vm.NewVMKeeper(baseKey, mainKey, acctKpr, bankKpr, paramsKpr)
 	vmk.Output = cfg.VMOutput
 
@@ -185,6 +187,7 @@ func NewApp(
 			GenesisTxResultHandler: PanicOnFailingTxResultHandler,
 			StdlibDir:              filepath.Join(gnoenv.RootDir(), "gnovm", "stdlibs"),
 		},
+		ParamsMaxCacheSize: 100,
 	}
 	if skipFailingGenesisTxs {
 		cfg.GenesisTxResultHandler = NoopGenesisTxResultHandler

gno.land/pkg/gnoland/node_inmemory.go

@@ -105,11 +105,12 @@ func NewInMemoryNode(logger *slog.Logger, cfg *InMemoryNodeConfig) (*node.Node,
 
 	// Initialize the application with the provided options
 	gnoApp, err := NewAppWithOptions(&AppOptions{
-		Logger:            logger,
-		DB:                cfg.DB,
-		EventSwitch:       evsw,
-		InitChainerConfig: cfg.InitChainerConfig,
-		VMOutput:          cfg.VMOutput,
+		Logger:             logger,
+		DB:                 cfg.DB,
+		EventSwitch:        evsw,
+		InitChainerConfig:  cfg.InitChainerConfig,
+		VMOutput:           cfg.VMOutput,
+		ParamsMaxCacheSize: 100,
 	})
 	if err != nil {
 		return nil, fmt.Errorf("error initializing new app: %w", err)

gno.land/pkg/sdk/vm/common_test.go

@@ -49,7 +49,8 @@ func _setupTestEnv(cacheStdlibs bool) testEnv {
 	ctx := sdk.NewContext(sdk.RunTxModeDeliver, ms, &bft.Header{ChainID: "test-chain-id"}, log.NewNoopLogger())
 	acck := authm.NewAccountKeeper(iavlCapKey, std.ProtoBaseAccount)
 	bank := bankm.NewBankKeeper(acck)
-	prmk := paramsm.NewParamsKeeper(iavlCapKey, "params")
+	maxCacheSize := 100
+	prmk := paramsm.NewParamsKeeper(iavlCapKey, "params", maxCacheSize)
 	vmk := NewVMKeeper(baseCapKey, iavlCapKey, acck, bank, prmk)
 
 	mcw := ms.MultiCacheWrap()

go.mod

@@ -14,6 +14,7 @@ require (
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.3.0
 	github.com/fortytw2/leaktest v1.3.0
 	github.com/gnolang/overflow v0.0.0-20170615021017-4d914c927216
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da
 	github.com/google/gofuzz v1.2.0
 	github.com/gorilla/mux v1.8.1
 	github.com/gorilla/websocket v1.5.3

misc/autocounterd/go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/gnolang/overflow v0.0.0-20170615021017-4d914c927216 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect

misc/loop/go.mod

@@ -33,6 +33,7 @@ require (
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect

tm2/pkg/sdk/params/keeper.go

@@ -7,6 +7,7 @@
 	"github.com/gnolang/gno/tm2/pkg/amino"
 	"github.com/gnolang/gno/tm2/pkg/sdk"
 	"github.com/gnolang/gno/tm2/pkg/store"
+	"github.com/golang/groupcache/lru"
 )
 
 const (
@@ -39,13 +40,15 @@
 type ParamsKeeper struct {
 	key    store.StoreKey
 	prefix string
+	cache  *lru.Cache
 }
 
 // NewParamsKeeper returns a new ParamsKeeper.
-func NewParamsKeeper(key store.StoreKey, prefix string) ParamsKeeper {
+func NewParamsKeeper(key store.StoreKey, prefix string, maxCacheSize int) ParamsKeeper {
 	return ParamsKeeper{
 		key:    key,
 		prefix: prefix,
+		cache:  lru.New(maxCacheSize),
 	}
 }
 
@@ -116,6 +119,14 @@
 }
 
 func (pk ParamsKeeper) getIfExists(ctx sdk.Context, key string, ptr interface{}) {
+	if bz, ok := pk.cache.Get(key); ok {
+		if bz == nil {
+			return
+		}
+		amino.UnmarshalJSON(bz.([]byte), ptr)
+		return
+	}
+
 	stor := ctx.Store(pk.key)
 	bz := stor.Get([]byte(key))
 	if bz == nil {
@@ -125,15 +136,25 @@
 	if err != nil {
 		panic(err)
 	}
+	pk.cache.Add(key, bz)
 }
 
 func (pk ParamsKeeper) get(ctx sdk.Context, key string, ptr interface{}) {
+	if bz, ok := pk.cache.Get(key); ok {
+		err := amino.UnmarshalJSON(bz.([]byte), ptr)
+		if err != nil {
+			panic(err)
+		}
+		return
+	}
+
 	stor := ctx.Store(pk.key)
 	bz := stor.Get([]byte(key))
 	err := amino.UnmarshalJSON(bz, ptr)
 	if err != nil {
 		panic(err)
 	}
+	pk.cache.Add(key, bz)
 }
 
 func (pk ParamsKeeper) set(ctx sdk.Context, key string, value interface{}) {
@@ -143,6 +164,7 @@
 		panic(err)
 	}
 	stor.Set([]byte(key), bz)
+	pk.cache.Remove(key)
 }
 
 func checkSuffix(key, expectedSuffix string) {

tm2/pkg/sdk/params/keeper_test.go

@@ -1,6 +1,7 @@
 package params
 
 import (
+	"fmt"
 	"reflect"
 	"testing"
 
@@ -137,6 +138,65 @@ func TestKeeper_internal(t *testing.T) {
 	}
 }
 
+func TestKeeper_cache(t *testing.T) {
+	env := setupTestEnv() // maxCacheSize=10 by default
+	ctx, keeper := env.ctx, env.keeper
+
+	// fill store with 20 items
+	for i := 0; i < 20; i++ {
+		key := fmt.Sprintf("k%d", i)
+		param := fmt.Sprintf("v%d", i)
+		require.NotPanics(t, func() { keeper.set(ctx, key, param) }, "keeper.Set panics, tc #%d", i)
+	}
+
+	// test cache miss
+	_, ok := keeper.cache.Get("k0")
+	require.False(t, ok)
+
+	// get + test value is valid
+	var target string
+	require.NotPanics(t, func() { keeper.getIfExists(ctx, "k0", &target) })
+	require.Equal(t, target, "v0")
+
+	// test cache hit + value is valid
+	ret, ok := keeper.cache.Get("k0")
+	require.True(t, ok)
+	require.Equal(t, ret.([]byte), []byte(`"v0"`))
+
+	// get again (from cache) + test value is valid
+	require.NotPanics(t, func() { keeper.getIfExists(ctx, "k0", &target) })
+	require.Equal(t, target, "v0")
+
+	// get 9 items to fill the lru cache
+	for i := 1; i < 10; i++ {
+		key := fmt.Sprintf("k%d", i)
+		val := fmt.Sprintf("v%d", i)
+		require.NotPanics(t, func() { keeper.getIfExists(ctx, key, &target) })
+		require.Equal(t, target, val)
+	}
+
+	// test cache hit for first item
+	ret, ok = keeper.cache.Get("k0")
+	require.True(t, ok)
+	require.Equal(t, ret.([]byte), []byte(`"v0"`))
+
+	// get 1 item
+	require.NotPanics(t, func() { keeper.getIfExists(ctx, "k10", &target) })
+	require.Equal(t, target, "v10")
+
+	// test cache hit for first item (because accessed recently)
+	_, ok = keeper.cache.Get("k0")
+	require.True(t, ok)
+
+	// test cache miss for second item (because oldest and never accessed)
+	_, ok = keeper.cache.Get("k1")
+	require.False(t, ok)
+
+	// get second item + test value is valid
+	require.NotPanics(t, func() { keeper.getIfExists(ctx, "k1", &target) })
+	require.Equal(t, target, "v1")
+}
+
 type s struct{ I int }
 
 func indirect(ptr interface{}) interface{} { return reflect.ValueOf(ptr).Elem().Interface() }

tm2/pkg/sdk/params/test_common.go

@@ -24,7 +24,8 @@ func setupTestEnv() testEnv {
 	ms.LoadLatestVersion()
 
 	prefix := "params_test"
-	keeper := NewParamsKeeper(paramsCapKey, prefix)
+	maxCacheSize := 10
+	keeper := NewParamsKeeper(paramsCapKey, prefix, maxCacheSize)
 
 	ctx := sdk.NewContext(sdk.RunTxModeDeliver, ms, &bft.Header{Height: 1, ChainID: "test-chain-id"}, log.NewNoopLogger())
 	// XXX: context key?