cosmos-sdk/store/v2/multi/sub_store.go

118 lines
2.6 KiB
Go
Raw Normal View History

feat: ADR-040: Add `RootStore` implementation (#10430) ## Description Part of: https://github.com/cosmos/cosmos-sdk/issues/10192 Introduces a new `RootStore` type in the `store/v2` package and an implementation, without yet replacing the `MultiStore` or refactoring its use within the SDK (which will happen in the follow up: https://github.com/cosmos/cosmos-sdk/pull/10174). Specified by [ADR-040](https://github.com/cosmos/cosmos-sdk/blob/1326fa2a7dfc3d83cf23dc1c1f33ff131152ad60/docs/architecture/adr-040-storage-and-smt-state-commitments.md). Fixes https://github.com/cosmos/cosmos-sdk/issues/10651 Fixes https://github.com/cosmos/cosmos-sdk/issues/10263 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
2021-12-16 05:09:57 -08:00
package root
import (
"crypto/sha256"
"io"
"sync"
dbm "github.com/cosmos/cosmos-sdk/db"
dbutil "github.com/cosmos/cosmos-sdk/internal/db"
"github.com/cosmos/cosmos-sdk/store/cachekv"
"github.com/cosmos/cosmos-sdk/store/listenkv"
"github.com/cosmos/cosmos-sdk/store/tracekv"
"github.com/cosmos/cosmos-sdk/store/types"
)
// Get implements KVStore.
func (s *substore) Get(key []byte) []byte {
s.root.mtx.RLock()
defer s.root.mtx.RUnlock()
val, err := s.dataBucket.Get(key)
if err != nil {
panic(err)
}
return val
}
// Has implements KVStore.
func (s *substore) Has(key []byte) bool {
s.root.mtx.RLock()
defer s.root.mtx.RUnlock()
has, err := s.dataBucket.Has(key)
if err != nil {
panic(err)
}
return has
}
// Set implements KVStore.
func (s *substore) Set(key, value []byte) {
s.root.mtx.Lock()
defer s.root.mtx.Unlock()
err := s.dataBucket.Set(key, value)
if err != nil {
panic(err)
}
s.stateCommitmentStore.Set(key, value)
khash := sha256.Sum256(key)
err = s.indexBucket.Set(khash[:], key)
if err != nil {
panic(err)
}
}
// Delete implements KVStore.
func (s *substore) Delete(key []byte) {
khash := sha256.Sum256(key)
s.root.mtx.Lock()
defer s.root.mtx.Unlock()
s.stateCommitmentStore.Delete(key)
_ = s.indexBucket.Delete(khash[:])
_ = s.dataBucket.Delete(key)
}
type contentsIterator struct {
types.Iterator
locker sync.Locker
}
func (s *substore) newSubstoreIterator(source dbm.Iterator) *contentsIterator {
locker := s.root.mtx.RLocker()
locker.Lock()
return &contentsIterator{dbutil.DBToStoreIterator(source), locker}
}
func (it *contentsIterator) Close() error {
defer it.locker.Unlock()
return it.Iterator.Close()
}
// Iterator implements KVStore.
func (s *substore) Iterator(start, end []byte) types.Iterator {
iter, err := s.dataBucket.Iterator(start, end)
if err != nil {
panic(err)
}
return s.newSubstoreIterator(iter)
}
// ReverseIterator implements KVStore.
func (s *substore) ReverseIterator(start, end []byte) types.Iterator {
iter, err := s.dataBucket.ReverseIterator(start, end)
if err != nil {
panic(err)
}
return s.newSubstoreIterator(iter)
}
// GetStoreType implements Store.
func (s *substore) GetStoreType() types.StoreType {
return types.StoreTypePersistent
}
func (s *substore) CacheWrap() types.CacheWrap {
return cachekv.NewStore(s)
}
func (s *substore) CacheWrapWithTrace(w io.Writer, tc types.TraceContext) types.CacheWrap {
return cachekv.NewStore(tracekv.NewStore(s, w, tc))
}
func (s *substore) CacheWrapWithListeners(storeKey types.StoreKey, listeners []types.WriteListener) types.CacheWrap {
return cachekv.NewStore(listenkv.NewStore(s, storeKey, listeners))
}