refactor: remove store kv dependency

proto/cosmos/base/kv/v1beta1/kv.proto → proto/cosmos/base/store/internal/kv/v1beta1/kv.proto

@@ -1,9 +1,11 @@
 syntax = "proto3";
-package cosmos.base.kv.v1beta1;
+package cosmos.base.store.internal.kv.v1beta1;
 
 import "gogoproto/gogo.proto";
 
-option go_package = "github.com/cosmos/cosmos-sdk/types/kv";
+option go_package = "github.com/cosmos/cosmos-sdk/store/internal/kv";
+
+// This is duplicated from the base kv directory to avoid a circular dependency with the cosmos-sdk
 
 // Pairs defines a repeated slice of Pair objects.
 message Pairs {

simapp/sim_test.go

@@ -17,12 +17,12 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/server"
-	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/store"
+	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
-	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/kv"
 	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
@@ -218,11 +218,21 @@ func TestAppImportExport(t *testing.T) {
 		storeA := ctxA.KVStore(skp.A)
 		storeB := ctxB.KVStore(skp.B)
 
-		failedKVAs, failedKVBs := sdk.DiffKVStores(storeA, storeB, skp.Prefixes)
+		failedKVAs, failedKVBs := storetypes.DiffKVStores(storeA, storeB, skp.Prefixes)
 		require.Equal(t, len(failedKVAs), len(failedKVBs), "unequal sets of key-values to compare")
 
 		fmt.Printf("compared %d different key/value pairs between %s and %s\n", len(failedKVAs), skp.A, skp.B)
-		require.Equal(t, 0, len(failedKVAs), simtestutil.GetSimulationLog(skp.A.Name(), app.SimulationManager().StoreDecoders, failedKVAs, failedKVBs))
+
+		kva := kv.Pairs{}
+		kvb := kv.Pairs{}
+		for i, a := range failedKVAs {
+			kva.Pairs[i] = kv.Pair(a)
+		}
+		for i, a := range failedKVBs {
+			kvb.Pairs[i] = kv.Pair(a)
+		}
+
+		require.Equal(t, 0, len(failedKVAs), simtestutil.GetSimulationLog(skp.A.Name(), app.SimulationManager().StoreDecoders, kva.Pairs, kvb.Pairs))
 	}
 }
 

store/cachekv/store.go

@@ -10,9 +10,9 @@ import (
 	dbm "github.com/tendermint/tm-db"
 
 	"github.com/cosmos/cosmos-sdk/internal/conv"
+	"github.com/cosmos/cosmos-sdk/store/internal/kv"
 	"github.com/cosmos/cosmos-sdk/store/tracekv"
 	"github.com/cosmos/cosmos-sdk/store/types"
-	"github.com/cosmos/cosmos-sdk/types/kv"
 )
 
 // cValue represents a cached value.

store/iavl/store.go

@@ -15,11 +15,11 @@ import (
 
 	sdkerrors "cosmossdk.io/errors"
 	"github.com/cosmos/cosmos-sdk/store/cachekv"
+	"github.com/cosmos/cosmos-sdk/store/internal/kv"
 	pruningtypes "github.com/cosmos/cosmos-sdk/store/pruning/types"
 	"github.com/cosmos/cosmos-sdk/store/tracekv"
 	"github.com/cosmos/cosmos-sdk/store/types"
 	"github.com/cosmos/cosmos-sdk/telemetry"
-	"github.com/cosmos/cosmos-sdk/types/kv"
 )
 
 const (

store/iavl/store_test.go

@@ -5,16 +5,15 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/cosmos/cosmos-sdk/store/cachekv"
-
 	"github.com/cosmos/iavl"
 	"github.com/stretchr/testify/require"
 	abci "github.com/tendermint/tendermint/abci/types"
 	"github.com/tendermint/tendermint/libs/log"
 	dbm "github.com/tendermint/tm-db"
 
+	"github.com/cosmos/cosmos-sdk/store/cachekv"
+	"github.com/cosmos/cosmos-sdk/store/internal/kv"
 	"github.com/cosmos/cosmos-sdk/store/types"
-	"github.com/cosmos/cosmos-sdk/types/kv"
 )
 
 var (

store/internal/kv/helpers.go

@@ -0,0 +1,17 @@
+package kv
+
+import "fmt"
+
+// AssertKeyAtLeastLength panics when store key length is less than the given length.
+func AssertKeyAtLeastLength(bz []byte, length int) {
+	if len(bz) < length {
+		panic(fmt.Sprintf("expected key of length at least %d, got %d", length, len(bz)))
+	}
+}
+
+// AssertKeyLength panics when store key length is not equal to the given length.
+func AssertKeyLength(bz []byte, length int) {
+	if len(bz) != length {
+		panic(fmt.Sprintf("unexpected key length; got: %d, expected: %d", len(bz), length))
+	}
+}

store/internal/kv/kv.go

@@ -0,0 +1,28 @@
+package kv
+
+import (
+	"bytes"
+	"sort"
+)
+
+func (kvs Pairs) Len() int { return len(kvs.Pairs) }
+func (kvs Pairs) Less(i, j int) bool {
+	switch bytes.Compare(kvs.Pairs[i].Key, kvs.Pairs[j].Key) {
+	case -1:
+		return true
+
+	case 0:
+		return bytes.Compare(kvs.Pairs[i].Value, kvs.Pairs[j].Value) < 0
+
+	case 1:
+		return false
+
+	default:
+		panic("invalid comparison result")
+	}
+}
+
+func (kvs Pairs) Swap(i, j int) { kvs.Pairs[i], kvs.Pairs[j] = kvs.Pairs[j], kvs.Pairs[i] }
+
+// Sort invokes sort.Sort on kvs.
+func (kvs Pairs) Sort() { sort.Sort(kvs) }

store/internal/maps/maps.go

@@ -7,7 +7,7 @@ import (
 	"github.com/tendermint/tendermint/crypto/tmhash"
 	tmcrypto "github.com/tendermint/tendermint/proto/tendermint/crypto"
 
-	"github.com/cosmos/cosmos-sdk/types/kv"
+	"github.com/cosmos/cosmos-sdk/store/internal/kv"
 )
 
 // merkleMap defines a merkle-ized tree from a map. Leave values are treated as

store/types/utils.go

@@ -6,7 +6,7 @@ import (
 	"sort"
 	"strings"
 
-	"github.com/cosmos/cosmos-sdk/types/kv"
+	"github.com/cosmos/cosmos-sdk/store/internal/kv"
 )
 
 // KVStorePrefixIterator iterates over all the keys with a certain prefix in ascending order

types/kv/kv.go

@@ -1,28 +1,10 @@
 package kv
 
-import (
-	"bytes"
-	"sort"
-)
-
-func (kvs Pairs) Len() int { return len(kvs.Pairs) }
-func (kvs Pairs) Less(i, j int) bool {
-	switch bytes.Compare(kvs.Pairs[i].Key, kvs.Pairs[j].Key) {
-	case -1:
-		return true
-
-	case 0:
-		return bytes.Compare(kvs.Pairs[i].Value, kvs.Pairs[j].Value) < 0
-
-	case 1:
-		return false
-
-	default:
-		panic("invalid comparison result")
-	}
+type Pair struct {
+	Key   []byte
+	Value []byte
 }
 
-func (kvs Pairs) Swap(i, j int) { kvs.Pairs[i], kvs.Pairs[j] = kvs.Pairs[j], kvs.Pairs[i] }
-
-// Sort invokes sort.Sort on kvs.
-func (kvs Pairs) Sort() { sort.Sort(kvs) }
+type Pairs struct {
+	Pairs []Pair
+}

types/store.go

@@ -48,12 +48,6 @@ func KVStoreReversePrefixIteratorPaginated(kvs KVStore, prefix []byte, page, lim
 	return types.KVStoreReversePrefixIteratorPaginated(kvs, prefix, page, limit)
 }
 
-// DiffKVStores compares two KVstores and returns all the key/value pairs
-// that differ from one another. It also skips value comparison for a set of provided prefixes
-func DiffKVStores(a KVStore, b KVStore, prefixesToSkip [][]byte) (kvAs, kvBs []kv.Pair) {
-	return types.DiffKVStores(a, b, prefixesToSkip)
-}
-
 // assertNoCommonPrefix will panic if there are two keys: k1 and k2 in keys, such that
 // k1 is a prefix of k2
 func assertNoPrefix(keys []string) {