Categorycosmossdk.io/store/v2commitment
package
2.0.0-beta.1
Repository: https://github.com/cosmos/cosmos-sdk.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
21
Dependents
6
Files
1.2k SLOC

# README

State Commitment (SC)

The commitment package contains the state commitment (SC) implementation. Specifically, it contains an IAVL v1 implementation of SC and the necessary types and abstractions to support other SC backends, as well as supporting general integration into store/v2, specifically the RootStore type.

A foremost design goal is that SC backends should be easily swappable, i.e. not necessarily IAVL. To this end, the scope of SC has been reduced, it must only:

  • Provide a stateful root app hash for height h resulting from applying a batch of key-value set/deletes to height h-1.
  • Fulfill (though not necessarily provide) historical proofs for all heights < h.
  • Provide an API for snapshot create/restore to fulfill state sync requests.

Notably, SC is not required to provide key iteration or value retrieval for either queries or state machine execution, this now being the responsibility of state storage.

An SC implementation may choose not to provide historical proofs past height h - n (n can be 0) due to the time and space constraints, but since store/v2 defines an API for historical proofs there should be at least one configuration of a given SC backend which supports this.

Benchmarks

See this section for specifics on SC benchmarks on various implementations.

Pruning

Pruning is the process of efficiently managing and removing outdated data from the State Commitment (SC). To facilitate this, the SC backend must implement the Pruner interface, allowing the PruningManager to execute data pruning operations according to the specified PruningOption. Optionally, the SC backend can implement the PausablePruner interface to pause pruning during a commit.

State Sync

State commitment (SC) does not have a direct notion of state sync. Rather, snapshots.Manager is responsible for creating and restoring snapshots of the entire state. The snapshots.Manager has a CommitSnapshotter field which is fulfilled by the CommitStore type, specifically it implements the Snapshot and Restore methods.

Usage

Similar to the storage package, the commitment package is designed to be used in a broader store implementation, i.e. it fulfills the role of the SC backend. Specifically, it provides a CommitStore type which accepts a corestore.KVStore and a mapping from store key, a string meant to represent a single module, to a Tree, which reflects the commitment structure.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewCommitStore creates a new CommitStore instance.
NewMetadataStore creates a new MetadataStore.

# Variables

ErrorExportDone is returned by Exporter.Next() when all items have been exported.

# Structs

CommitStore is a wrapper around multiple Tree objects mapped by a unique store key.
CommitStoreTestSuite is a test suite to be used for all tree backends.
MetadataStore is a store for metadata related to the commitment store.

# Interfaces

Exporter is the interface that wraps the basic Export methods.
Importer is the interface that wraps the basic Import methods.
Reader is the optional interface that is only used to read data from the tree during the migration process.
Tree is the interface that wraps the basic Tree methods.

# Type aliases

MountTreeFn is a function that mounts a tree given a store key.