feat(tools/benchmark): introduce benchmark module (backport #22778)

.github/dependabot.yml

@@ -314,6 +314,24 @@ updates:
     labels:
       - "A:automerge"
       - dependencies
+  - package-ecosystem: gomod
+    directory: "/x/bank"
+    schedule:
+      interval: weekly
+      day: wednesday
+      time: "03:20"
+    labels:
+      - "A:automerge"
+      - dependencies
+  - package-ecosystem: gomod
+    directory: "/tools/benchmark"
+    schedule:
+      interval: weekly
+      day: wednesday
+      time: "03:25"
+    labels:
+      - "A:automerge"
+      - dependencies
 
   # Dependencies should be up to date on release branch
   - package-ecosystem: gomod

.github/pr_labeler.yml

@@ -14,6 +14,7 @@
   - x/simulation/**/*
   - x/*/simulation/**/*
   - simsx/**/*
+  - tools/benchmark/**/*
 "C:Store":
   - store/**/*
 "C:collections":

.github/workflows/test.yml

@@ -1517,3 +1517,34 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         with:
           projectBaseDir: x/consensus/
+
+  test-tools-benchmark:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.23.2"
+          check-latest: true
+          cache: true
+          cache-dependency-path: tools/benchmark/go.sum
+      - uses: technote-space/[email protected]
+        id: git_diff
+        with:
+          PATTERNS: |
+            tools/benchmark/**/*.go
+            tools/benchmark/go.mod
+            tools/benchmark/go.sum
+      - name: tests
+        if: env.GIT_DIFF
+        run: |
+          cd tools/benchmark
+          go test -mod=readonly -timeout 30m -coverprofile=coverage.out -covermode=atomic -tags='norace' ./...
+      - name: sonarcloud
+        if: ${{ env.GIT_DIFF && !github.event.pull_request.draft && env.SONAR_TOKEN != null }}
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: tools/benchmark/

go.work.example

@@ -7,6 +7,7 @@ use (
 	./tests
 	./tests/systemtests
 	./tools/confix
+	./tools/benchmark
 	./x/accounts
 	./x/accounts/defaults/base
 	./x/accounts/defaults/lockup

runtime/module.go

@@ -96,6 +96,7 @@ func init() {
 			codec.ProvideProtoCodec,
 			codec.ProvideAddressCodec,
 			ProvideKVStoreKey,
+			ProvideKVStoreFactory,
 			ProvideTransientStoreKey,
 			ProvideMemoryStoreKey,
 			ProvideGenesisTxHandler,
@@ -296,3 +297,11 @@ func ProvideTransientStoreService(
 func ProvideCometService() comet.Service {
 	return NewContextAwareCometInfoService()
 }
+
+func ProvideKVStoreFactory(app *AppBuilder) store.KVStoreServiceFactory {
+	return func(key []byte) store.KVStoreService {
+		sk := storetypes.NewKVStoreKey(string(key))
+		registerStoreKey(app, sk)
+		return kvStoreService{key: sk}
+	}
+}

scripts/build/build.mk

@@ -74,6 +74,11 @@ ifeq (bls12381,$(findstring bls12381,$(COSMOS_BUILD_OPTIONS)))
   build_tags += bls12381
 endif
 
+# benchmark module
+ifeq (benchmark,$(findstring benchmark,$(COSMOS_BUILD_OPTIONS)))
+  build_tags += benchmark
+endif
+
 whitespace :=
 whitespace += $(whitespace)
 comma := ,

scripts/init-simapp-v2.sh

@@ -10,6 +10,7 @@ $SIMD_BIN config set client chain-id simapp-v2-chain
 $SIMD_BIN config set client keyring-backend test
 $SIMD_BIN config set client keyring-default-keyname alice
 $SIMD_BIN config set app rest.enable true
+$SIMD_BIN config set app telemetry.prometheus-retention-time 600
 $SIMD_BIN keys add alice --indiscreet
 $SIMD_BIN keys add bob --indiscreet
 $SIMD_BIN init simapp-v2-node --chain-id simapp-v2-chain

server/v2/cometbft/grpc.go

@@ -8,6 +8,7 @@ import (
 
 	abci "github.com/cometbft/cometbft/abci/types"
 	abciproto "github.com/cometbft/cometbft/api/cometbft/abci/v1"
+	rpchttp "github.com/cometbft/cometbft/rpc/client/http"
 	"github.com/cosmos/gogoproto/proto"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
@@ -21,7 +22,6 @@ import (
 	"cosmossdk.io/log"
 	storeserver "cosmossdk.io/server/v2/store"
 
-	rpchttp "github.com/cometbft/cometbft/rpc/client/http"
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/grpc/cmtservice"
 	nodeservice "github.com/cosmos/cosmos-sdk/client/grpc/node"

simapp/app_config.go

@@ -105,7 +105,7 @@ var (
 	}
 
 	// application configuration (used by depinject)
-	appConfig = appconfig.Compose(&appv1alpha1.Config{
+	appConfig = &appv1alpha1.Config{
 		Modules: []*appv1alpha1.ModuleConfig{
 			{
 				Name: runtime.ModuleName,
@@ -295,5 +295,5 @@ var (
 				Config: appconfig.WrapAny(&countertypes.Module{}),
 			},
 		},
-	})
+	}
 )

simapp/app_di.go

@@ -15,6 +15,7 @@ import (
 	"cosmossdk.io/core/registry"
 	corestore "cosmossdk.io/core/store"
 	"cosmossdk.io/depinject"
+	"cosmossdk.io/depinject/appconfig"
 	_ "cosmossdk.io/indexer/postgres" // register the postgres indexer
 	"cosmossdk.io/log"
 	"cosmossdk.io/x/accounts"
@@ -98,7 +99,7 @@ func init() {
 // AppConfig returns the default app config.
 func AppConfig() depinject.Config {
 	return depinject.Configs(
-		appConfig, // Alternatively use appconfig.LoadYAML(AppConfigYAML)
+		appconfig.Compose(appConfig), // Alternatively use appconfig.LoadYAML(AppConfigYAML)
 		depinject.Provide(
 			ProvideExampleMintFn, // optional: override the mint module's mint function with epoched minting
 		),
@@ -126,7 +127,6 @@ func NewSimApp(
 				appOpts,
 				// supply the logger
 				logger,
-
 				// ADVANCED CONFIGURATION
 
 				//

simapp/app_test.go

@@ -193,6 +193,16 @@ func TestRunMigrations(t *testing.T) {
 				}
 			}
 
+			orderMigrations := module.DefaultMigrationsOrder(app.ModuleManager.ModuleNames())
+			// Filter out benchmark module from migrations list
+			filteredMigrations := make([]string, 0, len(app.ModuleManager.OrderMigrations))
+			for _, name := range orderMigrations {
+				if name != "benchmark" {
+					filteredMigrations = append(filteredMigrations, name)
+				}
+			}
+			app.ModuleManager.OrderMigrations = filteredMigrations
+
 			// Run migrations only for bank. That's why we put the initial
 			// version for bank as 1, and for all other modules, we put as
 			// their latest ConsensusVersion.

simapp/benchmark.go

@@ -0,0 +1,39 @@
+//go:build benchmark
+
+package simapp
+
+import (
+	runtimev1alpha1 "cosmossdk.io/api/cosmos/app/runtime/v1alpha1"
+	appv1alpha1 "cosmossdk.io/api/cosmos/app/v1alpha1"
+	benchmarkmodulev1 "cosmossdk.io/api/cosmos/benchmark/module/v1"
+	"cosmossdk.io/depinject/appconfig"
+	benchmark "cosmossdk.io/tools/benchmark/module"
+	"fmt"
+)
+
+func init() {
+	// WARNING!
+	// Enabling this module will produce 3M keys in the genesis state for the benchmark module.
+	// Will also enable processing of benchmark transactions which can easily overwhelm the system.
+	appConfig.Modules = append(appConfig.Modules, &appv1alpha1.ModuleConfig{
+		Name: benchmark.ModuleName,
+		Config: appconfig.WrapAny(&benchmarkmodulev1.Module{
+			GenesisParams: &benchmarkmodulev1.GeneratorParams{
+				Seed:         34,
+				BucketCount:  3,
+				GenesisCount: 3_000_000,
+				KeyMean:      64,
+				KeyStdDev:    12,
+				ValueMean:    1024,
+				ValueStdDev:  256,
+			},
+		}),
+	})
+	runtimeConfig := &runtimev1alpha1.Module{}
+	err := appConfig.Modules[0].Config.UnmarshalTo(runtimeConfig)
+	if err != nil {
+		panic(fmt.Errorf("benchmark init: failed to unmarshal runtime module config: %w", err))
+	}
+	runtimeConfig.InitGenesis = append(runtimeConfig.InitGenesis, benchmark.ModuleName)
+	appConfig.Modules[0].Config = appconfig.WrapAny(runtimeConfig)
+}

simapp/go.mod

@@ -51,6 +51,8 @@ require (
 	google.golang.org/protobuf v1.35.2
 )
 
+require cosmossdk.io/tools/benchmark v0.0.0-00010101000000-000000000000
+
 require (
 	buf.build/gen/go/cometbft/cometbft/protocolbuffers/go v1.35.2-20241120201313-68e42a58b301.1 // indirect
 	buf.build/gen/go/cosmos/gogo-proto/protocolbuffers/go v1.35.2-20240130113600-88ef6483f90f.1 // indirect
@@ -215,7 +217,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.27.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/arch v0.12.0 // indirect
-	golang.org/x/crypto v0.30.0 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
 	golang.org/x/exp v0.0.0-20241108190413-2d47ceb2692f // indirect
 	golang.org/x/mod v0.22.0 // indirect
 	golang.org/x/net v0.32.0 // indirect
@@ -247,10 +249,11 @@ require (
 // SimApp on main always tests the latest extracted SDK modules importing the sdk
 replace (
 	// pseudo version lower than the latest tag
-	cosmossdk.io/api => cosmossdk.io/api v0.7.3-0.20241127063259-f296a5005ce8 // main
+	cosmossdk.io/api => cosmossdk.io/api v0.8.0-rc.2 // main
 	cosmossdk.io/client/v2 => ../client/v2
 	// pseudo version lower than the latest tag
 	cosmossdk.io/store => cosmossdk.io/store v1.0.0-rc.0.0.20241204123127-eb3bf8b0469d // main
+	cosmossdk.io/tools/benchmark => ../tools/benchmark
 	cosmossdk.io/tools/confix => ../tools/confix
 	cosmossdk.io/x/accounts => ../x/accounts
 	cosmossdk.io/x/accounts/defaults/base => ../x/accounts/defaults/base

simapp/go.sum

@@ -192,8 +192,8 @@ cloud.google.com/go/webrisk v1.4.0/go.mod h1:Hn8X6Zr+ziE2aNd8SliSDWpEnSS1u4R9+xX
 cloud.google.com/go/webrisk v1.5.0/go.mod h1:iPG6fr52Tv7sGk0H6qUFzmL3HHZev1htXuWDEEsqMTg=
 cloud.google.com/go/workflows v1.6.0/go.mod h1:6t9F5h/unJz41YqfBmqSASJSXccBLtD1Vwf+KmJENM0=
 cloud.google.com/go/workflows v1.7.0/go.mod h1:JhSrZuVZWuiDfKEFxU0/F1PQjmpnpcoISEXH2bcHC3M=
-cosmossdk.io/api v0.7.3-0.20241127063259-f296a5005ce8 h1:KCi0Wq5M0JST0I01HebEDHt7//tZMx2bW4tmlc4IRnI=
-cosmossdk.io/api v0.7.3-0.20241127063259-f296a5005ce8/go.mod h1:vZy0Ev95gwANXt5ssiDui4L5nlMYO5bzqR77hCjIz9s=
+cosmossdk.io/api v0.8.0-rc.2 h1:7DQjVnYz7sTy47bZMzahfOANbhxLmPtgQvvru9kA2R0=
+cosmossdk.io/api v0.8.0-rc.2/go.mod h1:edvI8tMINqCH75EgkOEMnCZEQ3iKJgOlZ+ZxOu4gmXU=
 cosmossdk.io/collections v0.4.1-0.20241209183624-332d0b106d1b h1:smupoVhpdK+5pztIylyIGkCc+0QaAaGLEvnM7Wnrq18=
 cosmossdk.io/collections v0.4.1-0.20241209183624-332d0b106d1b/go.mod h1:uf12i1yKvzEIHt2ok7poNqFDQTb71O00RQLitSynmrg=
 cosmossdk.io/core v1.0.0-alpha.6 h1:5ukC4JcQKmemLQXcAgu/QoOvJI50hpBkIIg4ZT2EN8E=
@@ -890,8 +890,8 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/crypto v0.30.0 h1:RwoQn3GkWiMkzlX562cLB7OxWvjH1L8xutO2WoJcRoY=
-golang.org/x/crypto v0.30.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
+golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U=
+golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=

simapp/v2/app_config.go

@@ -104,7 +104,7 @@ var (
 	}
 
 	// ModuleConfig is the application module configuration used by depinject
-	ModuleConfig = appconfig.Compose(&appv1alpha1.Config{
+	ModuleConfig = &appv1alpha1.Config{
 		Modules: []*appv1alpha1.ModuleConfig{
 			{
 				Name: runtime.ModuleName,
@@ -177,7 +177,7 @@ var (
 					// OrderMigrations: []string{},
 					// TODO GasConfig was added to the config in runtimev2.  Where/how was it set in v1?
 					GasConfig: &runtimev2.GasConfig{
-						ValidateTxGasLimit: 100_000,
+						ValidateTxGasLimit: 10_000_000,
 						QueryGasLimit:      100_000,
 						SimulationGasLimit: 100_000,
 					},
@@ -294,5 +294,5 @@ var (
 				Config: appconfig.WrapAny(&epochsmodulev1.Module{}),
 			},
 		},
-	})
+	}
 )

simapp/v2/app_di.go

@@ -10,6 +10,7 @@ import (
 	"cosmossdk.io/core/server"
 	"cosmossdk.io/core/transaction"
 	"cosmossdk.io/depinject"
+	"cosmossdk.io/depinject/appconfig"
 	_ "cosmossdk.io/indexer/postgres" // register the postgres indexer
 	"cosmossdk.io/log"
 	"cosmossdk.io/runtime/v2"
@@ -49,7 +50,7 @@ type SimApp[T transaction.Tx] struct {
 // AppConfig returns the default app config.
 func AppConfig() depinject.Config {
 	return depinject.Configs(
-		ModuleConfig, // Alternatively use appconfig.LoadYAML(AppConfigYAML)
+		appconfig.Compose(ModuleConfig), // Alternatively use appconfig.LoadYAML(AppConfigYAML)
 		runtime.DefaultServiceBindings(),
 		codec.DefaultProviders,
 		depinject.Provide(
@@ -167,11 +168,19 @@ func NewSimApp[T transaction.Tx](
 		return nil, fmt.Errorf("store builder did not return a db")
 	}
 
+	/****  Store Metrics ****/
+	/*
+		// In order to set store metrics uncomment the below
+		storeMetrics, err := metrics.NewMetrics([][]string{{"module", "store"}})
+		if err != nil {
+			return nil, err
+		}
+		app.store.SetMetrics(storeMetrics)
+	*/
 	/****  Module Options ****/
 
 	// RegisterUpgradeHandlers is used for registering any on-chain upgrades.
 	app.RegisterUpgradeHandlers()
-
 	if err = app.LoadLatest(); err != nil {
 		return nil, err
 	}

simapp/v2/benchmark.go

@@ -0,0 +1,39 @@
+//go:build benchmark
+
+package simapp
+
+import (
+	runtimev2 "cosmossdk.io/api/cosmos/app/runtime/v2"
+	appv1alpha1 "cosmossdk.io/api/cosmos/app/v1alpha1"
+	benchmarkmodulev1 "cosmossdk.io/api/cosmos/benchmark/module/v1"
+	"cosmossdk.io/depinject/appconfig"
+	benchmark "cosmossdk.io/tools/benchmark/module"
+	"fmt"
+)
+
+func init() {
+	// WARNING!
+	// Enabling this module will produce 3M keys in the genesis state for the benchmark module.
+	// Will also enable processing of benchmark transactions which can easily overwhelm the system.
+	ModuleConfig.Modules = append(ModuleConfig.Modules, &appv1alpha1.ModuleConfig{
+		Name: benchmark.ModuleName,
+		Config: appconfig.WrapAny(&benchmarkmodulev1.Module{
+			GenesisParams: &benchmarkmodulev1.GeneratorParams{
+				Seed:         34,
+				BucketCount:  3,
+				GenesisCount: 3_000_000,
+				KeyMean:      64,
+				KeyStdDev:    12,
+				ValueMean:    1024,
+				ValueStdDev:  256,
+			},
+		}),
+	})
+	runtimeConfig := &runtimev2.Module{}
+	err := ModuleConfig.Modules[0].Config.UnmarshalTo(runtimeConfig)
+	if err != nil {
+		panic(fmt.Errorf("benchmark init: failed to unmarshal runtime module config: %w", err))
+	}
+	runtimeConfig.InitGenesis = append(runtimeConfig.InitGenesis, benchmark.ModuleName)
+	ModuleConfig.Modules[0].Config = appconfig.WrapAny(runtimeConfig)
+}