readmes

Author: aljo242

README.md

@@ -7,3 +7,10 @@ Utilities for testing Cosmos SDK chains
 go get github.com/skip-mev/chaintestutil
 ```
 
+## Structure
+
+    .
+    ├── encoding                    # Utilities for creating test encoding configurations
+    ├── keeper                      # Utilities for creating a set of test keepers for integration tests
+    ├── network                     # Utilities for creating a local test network for integration tests
+    └── sample                      # Functions for generating randomized Cosmos SDK types such as Coins, sdk.Ints, etc.

keeper/README.md

@@ -0,0 +1,108 @@
+# Keeper Testing
+
+The keeper package exposes an easy API for generating a set of "test keepers" and "test message
+servers" for performing integration testing on your application at the keeper level.  Typical Cosmos
+SDK unit tests may use mocked keepers, or not use a full set that is representative of the full application. 
+
+This setup allows developers to test all keepers in coordination without having to spin up a local network 
+or full application.  
+
+The framework initializes and returns keepers for the following modules:
+- `x/bank`
+- `x/auth`
+- `x/staking`
+- `x/distribution`
+- `x/feegrant`
+- `x/mint`
+
+and is easily extendable to add any other keepers that you may with to test upon setup.
+
+A typical testing flow that extends adds the Skip FeeMarket module might look like the following:
+
+```go
+import (
+	"testing"
+
+	"github.com/cometbft/cometbft/libs/log"
+	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
+	storetypes "github.com/cosmos/cosmos-sdk/store/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"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	testkeeper "github.com/skip-mev/chaintestutil/keeper"
+	"github.com/stretchr/testify/require"
+
+	feemarketkeeper "github.com/skip-mev/feemarket/x/feemarket/keeper"
+	feemarkettypes "github.com/skip-mev/feemarket/x/feemarket/types"
+)
+
+// TestKeepers holds all keepers used during keeper tests for all modules
+type TestKeepers struct {
+	testkeeper.TestKeepers
+	FeeMarketKeeper *feemarketkeeper.Keeper
+}
+
+// TestMsgServers holds all message servers used during keeper tests for all modules
+type TestMsgServers struct {
+	testkeeper.TestMsgServers
+	FeeMarketMsgServer feemarkettypes.MsgServer
+}
+
+var additionalMaccPerms = map[string][]string{
+	feemarkettypes.ModuleName:       nil,
+	feemarkettypes.FeeCollectorName: {authtypes.Burner},
+}
+
+// NewTestSetup returns initialized instances of all the keepers and message servers of the modules
+func NewTestSetup(t testing.TB, options ...testkeeper.SetupOption) (sdk.Context, TestKeepers, TestMsgServers) {
+	options = append(options, testkeeper.WithAdditionalModuleAccounts(additionalMaccPerms))
+
+	_, tk, tms := testkeeper.NewTestSetup(t, options...)
+
+	// initialize extra keeper
+	feeMarketKeeper := FeeMarket(tk.Initializer, tk.AccountKeeper)
+	require.NoError(t, tk.Initializer.LoadLatest())
+
+	// initialize msg servers
+	feeMarketMsgSrv := feemarketkeeper.NewMsgServer(*feeMarketKeeper)
+
+	ctx := sdk.NewContext(tk.Initializer.StateStore, tmproto.Header{
+		Time:   testkeeper.ExampleTimestamp,
+		Height: testkeeper.ExampleHeight,
+	}, false, log.NewNopLogger())
+
+	err := feeMarketKeeper.SetState(ctx, feemarkettypes.DefaultState())
+	require.NoError(t, err)
+	err = feeMarketKeeper.SetParams(ctx, feemarkettypes.DefaultParams())
+	require.NoError(t, err)
+
+	testKeepers := TestKeepers{
+		TestKeepers:     tk,
+		FeeMarketKeeper: feeMarketKeeper,
+	}
+
+	testMsgServers := TestMsgServers{
+		TestMsgServers:     tms,
+		FeeMarketMsgServer: feeMarketMsgSrv,
+	}
+
+	return ctx, testKeepers, testMsgServers
+}
+
+// FeeMarket initializes the fee market module using the testkeepers intializer.
+func FeeMarket(
+	initializer *testkeeper.Initializer,
+	authKeeper authkeeper.AccountKeeper,
+) *feemarketkeeper.Keeper {
+	storeKey := sdk.NewKVStoreKey(feemarkettypes.StoreKey)
+	initializer.StateStore.MountStoreWithDB(storeKey, storetypes.StoreTypeIAVL, initializer.DB)
+
+	return feemarketkeeper.NewKeeper(
+		initializer.Codec,
+		storeKey,
+		authKeeper,
+		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+	)
+}
+```

network/README.md

@@ -1,7 +1,6 @@
 # Network Testing
 
-
-Package network implements and exposes a fully operational in-process CometBFT
+The network package implements and exposes a fully operational in-process CometBFT
 test network that consists of at least one or potentially many validators. This
 test network can be used primarily for integration tests or unit test suites.
 
@@ -43,7 +42,7 @@ A typical testing flow that extends the bank genesis state might look like the f
         "github.com/stretchr/testify/require"   
         "github.com/stretchr/testify/suite"
 
-        "github.com/test-repo/app" // example test repository 		
+        "github.com/test-repo/app" // example test repository. Replace with your own 		
     )
 
     var (