R4R: Store Refactor 1

PENDING.md

@@ -43,8 +43,9 @@ IMPROVEMENTS
 * Gaia
 
 * SDK
-  * \#1277 Complete bank module specification
-  * \#2914 No longer withdraw validator rewards on bond/unbond, but rather move
+ - \#1277 Complete bank module specification
+ - \#2986 Store Refactor
+ - \#2914 No longer withdraw validator rewards on bond/unbond, but rather move
   the rewards to the respective validator's pools.
 
 * Tendermint

client/context/query.go

@@ -10,7 +10,7 @@ import (
 
 	"strings"
 
-	"github.com/cosmos/cosmos-sdk/store"
+	"github.com/cosmos/cosmos-sdk/store/rootmulti"
 	abci "github.com/tendermint/tendermint/abci/types"
 	"github.com/tendermint/tendermint/crypto/merkle"
 	cmn "github.com/tendermint/tendermint/libs/common"
@@ -210,7 +210,7 @@ func (ctx CLIContext) verifyProof(queryPath string, resp abci.ResponseQuery) err
 	}
 
 	// TODO: Instead of reconstructing, stash on CLIContext field?
-	prt := store.DefaultProofRuntime()
+	prt := rootmulti.DefaultProofRuntime()
 
 	// TODO: Better convention for path?
 	storeName, err := parseQueryStorePath(queryPath)
@@ -250,7 +250,7 @@ func isQueryStoreWithProof(path string) bool {
 		return false
 	case paths[0] != "store":
 		return false
-	case store.RequireProof("/" + paths[2]):
+	case rootmulti.RequireProof("/" + paths[2]):
 		return true
 	}
 

docs/examples/democoin/x/assoc/validator_set_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/docs/examples/democoin/mock"
 	"github.com/cosmos/cosmos-sdk/store"
+	"github.com/cosmos/cosmos-sdk/store/prefix"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
@@ -36,7 +37,7 @@ func TestValidatorSet(t *testing.T) {
 		{addr2, sdk.NewDec(2)},
 	}}
 
-	valset := NewValidatorSet(codec.New(), ctx.KVStore(key).Prefix([]byte("assoc")), base, 1, 5)
+	valset := NewValidatorSet(codec.New(), prefix.NewStore(ctx.KVStore(key), []byte("assoc")), base, 1, 5)
 
 	require.Equal(t, base.Validator(ctx, addr1), valset.Validator(ctx, addr1))
 	require.Equal(t, base.Validator(ctx, addr2), valset.Validator(ctx, addr2))

store/memiterator.go → store/cachekv/memiterator.go

@@ -1,4 +1,4 @@
-package store
+package cachekv
 
 import (
 	"bytes"

store/cachemergeiterator.go → store/cachekv/mergeiterator.go

@@ -1,7 +1,9 @@
-package store
+package cachekv
 
 import (
 	"bytes"
+
+	"github.com/cosmos/cosmos-sdk/store/types"
 )
 
 // cacheMergeIterator merges a parent Iterator and a cache Iterator.
@@ -12,14 +14,14 @@ import (
 //
 // TODO: Optimize by memoizing.
 type cacheMergeIterator struct {
-	parent    Iterator
-	cache     Iterator
+	parent    types.Iterator
+	cache     types.Iterator
 	ascending bool
 }
 
-var _ Iterator = (*cacheMergeIterator)(nil)
+var _ types.Iterator = (*cacheMergeIterator)(nil)
 
-func newCacheMergeIterator(parent, cache Iterator, ascending bool) *cacheMergeIterator {
+func newCacheMergeIterator(parent, cache types.Iterator, ascending bool) *cacheMergeIterator {
 	iter := &cacheMergeIterator{
 		parent:    parent,
 		cache:     cache,

store/cachekvstore.go → store/cachekv/store.go

@@ -1,4 +1,4 @@
-package store
+package cachekv
 
 import (
 	"bytes"
@@ -8,6 +8,10 @@ import (
 
 	cmn "github.com/tendermint/tendermint/libs/common"
 	dbm "github.com/tendermint/tendermint/libs/db"
+
+	"github.com/cosmos/cosmos-sdk/store/types"
+
+	"github.com/cosmos/cosmos-sdk/store/tracekv"
 )
 
 // If value is nil but deleted is false, it means the parent doesn't have the
@@ -18,30 +22,30 @@ type cValue struct {
 	dirty   bool
 }
 
-// cacheKVStore wraps an in-memory cache around an underlying KVStore.
-type cacheKVStore struct {
+// Store wraps an in-memory cache around an underlying types.KVStore.
+type Store struct {
 	mtx    sync.Mutex
 	cache  map[string]cValue
-	parent KVStore
+	parent types.KVStore
 }
 
-var _ CacheKVStore = (*cacheKVStore)(nil)
+var _ types.CacheKVStore = (*Store)(nil)
 
 // nolint
-func NewCacheKVStore(parent KVStore) *cacheKVStore {
-	return &cacheKVStore{
+func NewStore(parent types.KVStore) *Store {
+	return &Store{
 		cache:  make(map[string]cValue),
 		parent: parent,
 	}
 }
 
 // Implements Store.
-func (ci *cacheKVStore) GetStoreType() StoreType {
+func (ci *Store) GetStoreType() types.StoreType {
 	return ci.parent.GetStoreType()
 }
 
-// Implements KVStore.
-func (ci *cacheKVStore) Get(key []byte) (value []byte) {
+// Implements types.KVStore.
+func (ci *Store) Get(key []byte) (value []byte) {
 	ci.mtx.Lock()
 	defer ci.mtx.Unlock()
 	ci.assertValidKey(key)
@@ -57,8 +61,8 @@ func (ci *cacheKVStore) Get(key []byte) (value []byte) {
 	return value
 }
 
-// Implements KVStore.
-func (ci *cacheKVStore) Set(key []byte, value []byte) {
+// Implements types.KVStore.
+func (ci *Store) Set(key []byte, value []byte) {
 	ci.mtx.Lock()
 	defer ci.mtx.Unlock()
 	ci.assertValidKey(key)
@@ -67,33 +71,23 @@ func (ci *cacheKVStore) Set(key []byte, value []byte) {
 	ci.setCacheValue(key, value, false, true)
 }
 
-// Implements KVStore.
-func (ci *cacheKVStore) Has(key []byte) bool {
+// Implements types.KVStore.
+func (ci *Store) Has(key []byte) bool {
 	value := ci.Get(key)
 	return value != nil
 }
 
-// Implements KVStore.
-func (ci *cacheKVStore) Delete(key []byte) {
+// Implements types.KVStore.
+func (ci *Store) Delete(key []byte) {
 	ci.mtx.Lock()
 	defer ci.mtx.Unlock()
 	ci.assertValidKey(key)
 
 	ci.setCacheValue(key, nil, true, true)
 }
 
-// Implements KVStore
-func (ci *cacheKVStore) Prefix(prefix []byte) KVStore {
-	return prefixStore{ci, prefix}
-}
-
-// Implements KVStore
-func (ci *cacheKVStore) Gas(meter GasMeter, config GasConfig) KVStore {
-	return NewGasKVStore(meter, config, ci)
-}
-
-// Implements CacheKVStore.
-func (ci *cacheKVStore) Write() {
+// Implements Cachetypes.KVStore.
+func (ci *Store) Write() {
 	ci.mtx.Lock()
 	defer ci.mtx.Unlock()
 
@@ -126,33 +120,33 @@ func (ci *cacheKVStore) Write() {
 }
 
 //----------------------------------------
-// To cache-wrap this cacheKVStore further.
+// To cache-wrap this Store further.
 
 // Implements CacheWrapper.
-func (ci *cacheKVStore) CacheWrap() CacheWrap {
-	return NewCacheKVStore(ci)
+func (ci *Store) CacheWrap() types.CacheWrap {
+	return NewStore(ci)
 }
 
 // CacheWrapWithTrace implements the CacheWrapper interface.
-func (ci *cacheKVStore) CacheWrapWithTrace(w io.Writer, tc TraceContext) CacheWrap {
-	return NewCacheKVStore(NewTraceKVStore(ci, w, tc))
+func (ci *Store) CacheWrapWithTrace(w io.Writer, tc types.TraceContext) types.CacheWrap {
+	return NewStore(tracekv.NewStore(ci, w, tc))
 }
 
 //----------------------------------------
 // Iteration
 
-// Implements KVStore.
-func (ci *cacheKVStore) Iterator(start, end []byte) Iterator {
+// Implements types.KVStore.
+func (ci *Store) Iterator(start, end []byte) types.Iterator {
 	return ci.iterator(start, end, true)
 }
 
-// Implements KVStore.
-func (ci *cacheKVStore) ReverseIterator(start, end []byte) Iterator {
+// Implements types.KVStore.
+func (ci *Store) ReverseIterator(start, end []byte) types.Iterator {
 	return ci.iterator(start, end, false)
 }
 
-func (ci *cacheKVStore) iterator(start, end []byte, ascending bool) Iterator {
-	var parent, cache Iterator
+func (ci *Store) iterator(start, end []byte, ascending bool) types.Iterator {
+	var parent, cache types.Iterator
 
 	if ascending {
 		parent = ci.parent.Iterator(start, end)
@@ -167,7 +161,7 @@ func (ci *cacheKVStore) iterator(start, end []byte, ascending bool) Iterator {
 }
 
 // Constructs a slice of dirty items, to use w/ memIterator.
-func (ci *cacheKVStore) dirtyItems(start, end []byte, ascending bool) []cmn.KVPair {
+func (ci *Store) dirtyItems(start, end []byte, ascending bool) []cmn.KVPair {
 	items := make([]cmn.KVPair, 0)
 
 	for key, cacheValue := range ci.cache {
@@ -192,20 +186,20 @@ func (ci *cacheKVStore) dirtyItems(start, end []byte, ascending bool) []cmn.KVPa
 //----------------------------------------
 // etc
 
-func (ci *cacheKVStore) assertValidKey(key []byte) {
+func (ci *Store) assertValidKey(key []byte) {
 	if key == nil {
 		panic("key is nil")
 	}
 }
 
-func (ci *cacheKVStore) assertValidValue(value []byte) {
+func (ci *Store) assertValidValue(value []byte) {
 	if value == nil {
 		panic("value is nil")
 	}
 }
 
 // Only entrypoint to mutate ci.cache.
-func (ci *cacheKVStore) setCacheValue(key, value []byte, deleted bool, dirty bool) {
+func (ci *Store) setCacheValue(key, value []byte, deleted bool, dirty bool) {
 	ci.cache[string(key)] = cValue{
 		value:   value,
 		deleted: deleted,