4081bc3d00
## Description Closes: #11378 --- ### 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... - [ ] 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 - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] 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) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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)
20 lines
1.4 KiB
Go
20 lines
1.4 KiB
Go
// This package provides concrete implementations of the store/v2alpha1 "MultiStore" types, including
|
|
// CommitMultiStore, CacheMultiStore, and BasicMultiStore (as read-only stores at past versions).
|
|
//
|
|
// Substores are declared as part of a schema within StoreOptions.
|
|
// The schema cannot be changed once a CommitMultiStore is initialized, and changes to the schema must be done
|
|
// by migrating via StoreOptions.Upgrades. If a past version is accessed, it will be loaded with the past schema.
|
|
// Stores may be declared as StoreTypePersistent, StoreTypeMemory (not persisted after close), or
|
|
// StoreTypeTransient (not persisted across commits). Non-persistent substores cannot be migrated or accessed
|
|
// in past versions.
|
|
//
|
|
// A declared persistent substore is initially empty and stores nothing in the backing DB until a value is set.
|
|
// A non-empty store is stored within a prefixed subdomain of the backing DB (using db/prefix).
|
|
// If the MultiStore is configured to use a separate DBConnection for StateCommitmentDB, it will store the
|
|
// state commitment (SC) store (as an SMT) in subdomains there, and the "flat" state is stored in the main DB.
|
|
// Each substore's SC is allocated as an independent SMT, and query proofs contain two components: a proof
|
|
// of a key's (non)existence within the substore SMT, and a proof of the substore's existence within the
|
|
// MultiStore (using the Merkle map proof spec (TendermintSpec)).
|
|
|
|
package multi
|