# ADR 040: Storage and SMT State Commitments
- 2020-01-15: Draft
DRAFT Not Implemented
Sparse Merkle Tree (SMT (opens new window)) is a version of a Merkle Tree with various storage and performance optimizations. This ADR defines a separation of state commitments from data storage and the Cosmos SDK transition from IAVL to SMT.
Currently, Cosmos SDK uses IAVL for both state commitments (opens new window) and data storage.
IAVL has effectively become an orphaned project within the Cosmos ecosystem and it's proven to be an inefficient state commitment data structure. In the current design, IAVL is used for both data storage and as a Merkle Tree for state commitments. IAVL is meant to be a standalone Merkelized key/value database, however it's using a KV DB engine to store all tree nodes. So, each node is stored in a separate record in the KV DB. This causes many inefficiencies and problems:
- Each object query requires a tree traversal from the root. Subsequent queries for the same object are cached on the Cosmos SDK level.
- Each edge traversal requires a DB query.
- Creating snapshots is expensive (opens new window). It takes about 30 seconds to export less than 100 MB of state (as of March 2020).
- Updates in IAVL may trigger tree reorganization and possible O(log(n)) hashes re-computation, which can become a CPU bottleneck.
- The node structure is pretty expensive - it contains a standard tree node elements (key, value, left and right element) and additional metadata such as height, version (which is not required by the Cosmos SDK). The entire node is hashed, and that hash is used as the key in the underlying database, ref (opens new window).
Moreover, the IAVL project lacks support and a maintainer and we already see better and well-established alternatives. Instead of optimizing the IAVL, we are looking into other solutions for both storage and state commitments.
We propose to separate the concerns of state commitment (SC), needed for consensus, and state storage (SS), needed for state machine. Finally we replace IAVL with Celestia's SMT (opens new window). Celestia SMT is based on Diem (called jellyfish) design [*] - it uses a compute-optimised SMT by replacing subtrees with only default values with a single node (same approach is used by Ethereum2) and implements compact proofs.
The storage model presented here doesn't deal with data structure nor serialization. It's a Key-Value database, where both key and value are binaries. The storage user is responsible for data serialization.
# Decouple state commitment from storage
Separation of storage and commitment (by the SMT) will allow the optimization of different components according to their usage and access patterns.
SC (SMT) is used to commit to a data and compute Merkle proofs.
SS is used to directly access data. To avoid collisions, both
SC will use a separate storage namespace (they could use the same database underneath).
SS will store each record directly (mapping
(key, value) as
key → value).
SMT is a merkle tree structure: we don't store keys directly. For every
(key, value) pair,
hash(key) is used as leaf path (we hash a key to uniformly distribute leaves in the tree) and
hash(value) as the leaf contents. The tree structure is specified in more depth below.
For data access we propose 2 additional KV buckets (implemented as namespaces for the key-value pairs, sometimes called column family (opens new window)):
key → value: the principal object storage, used by a state machine, behind the Cosmos SDK
KVStoreinterface: provides direct access by key and allows prefix iteration (KV DB backend must support it).
hash(key) → key: a reverse index to get a key from an SMT path. Internally the SMT will store
prefix || hash(key) || hash(value). So, we can get an object value by composing
hash(key) → B2 → B1.
- We could use more buckets to optimize the app usage if needed.
We propose to use a KV database for both
SC. The store interface will allow to use the same physical DB backend for both
SC as well two separate DBs. The latter option allows for the separation of
SC into different hardware units, providing support for more complex setup scenarios and improving overall performance: one can use different backends (eg RocksDB and Badger) as well as independently tuning the underlying DB configuration.
State Storage requirements:
- range queries
- quick (key, value) access
- creating a snapshot
- historical versioning
- pruning (garbage collection)
State Commitment requirements:
- fast updates
- tree path should be short
- query historical commitment proofs using ICS-23 standard
- pruning (garbage collection)
# SMT for State Commitment
A Sparse Merkle tree is based on the idea of a complete Merkle tree of an intractable size. The assumption here is that as the size of the tree is intractable, there would only be a few leaf nodes with valid data blocks relative to the tree size, rendering a sparse tree.
The full specification can be found at Celestia (opens new window). In summary:
- The SMT consists of a binary Merkle tree, constructed in the same fashion as described in Certificate Transparency (RFC-6962) (opens new window), but using as the hashing function SHA-2-256 as defined in FIPS 180-4 (opens new window).
- Leaves and internal nodes are hashed differently: the one-byte
0x00is prepended for leaf nodes while
0x01is prepended for internal nodes.
- Default values are given to leaf nodes with empty leaves.
- While the above rule is sufficient to pre-compute the values of intermediate nodes that are roots of empty subtrees, a further simplification is to extend this default value to all nodes that are roots of empty subtrees. The 32-byte zero is used as the default value. This rule takes precedence over the above one.
- An internal node that is the root of a subtree that contains exactly one non-empty leaf is replaced by that leaf's leaf node.
# Snapshots for storage sync and state versioning
Below, with simple snapshot we refer to a database snapshot mechanism, not to a ABCI snapshot sync. The latter will be referred as snapshot sync (which will directly use DB snapshot as described below).
Database snapshot is a view of DB state at a certain time or transaction. It's not a full copy of a database (it would be too big). Usually a snapshot mechanism is based on a copy on write and it allows DB state to be efficiently delivered at a certain stage. Some DB engines support snapshotting. Hence, we propose to reuse that functionality for the state sync and versioning (described below). We limit the supported DB engines to ones which efficiently implement snapshots. In a final section we discuss the evaluated DBs.
One of the Stargate core features is a snapshot sync delivered in the
/snapshot package. It provides a way to trustlessly sync a blockchain without repeating all transactions from the genesis. This feature is implemented in Cosmos SDK and requires storage support. Currently IAVL is the only supported backend. It works by streaming to a client a snapshot of a
SS at a certain version together with a header chain.
A new database snapshot will be created in every
EndBlocker and identified by a block height. The
root store keeps track of the available snapshots to offer
SS at a certain version. The
root store implements the
RootStore interface described below. In essence,
RootStore encapsulates a
Committer has a
GetPruning functions which will be used for creating and removing snapshots. The
rootStore.Commit function creates a new snapshot and increments the version on each call, and checks if it needs to remove old versions. We will need to update the SMT interface to implement the
Commit must be called exactly once per block. Otherwise we risk going out of sync for the version number and block height.
NOTE: For the Cosmos SDK storage, we may consider splitting that interface into
PruningCommitter - only the multiroot should implement
PruningCommitter (cache and prefix store don't need pruning).
Number of historical versions for
abci.RequestQuery and state sync snapshots is part of a node configuration, not a chain configuration (configuration implied by the blockchain consensus). A configuration should allow to specify number of past blocks and number of past blocks modulo some number (eg: 100 past blocks and one snapshot every 100 blocks for past 2000 blocks). Archival nodes can keep all past versions.
Pruning old snapshots is effectively done by a database. Whenever we update a record in
SC, SMT won't update nodes - instead it creates new nodes on the update path, without removing the old one. Since we are snapshotting each block, we need to change that mechanism to immediately remove orphaned nodes from the database. This is a safe operation - snapshots will keep track of the records and make it available when accessing past versions.
To manage the active snapshots we will either use a DB max number of snapshots option (if available), or we will remove DB snapshots in the
EndBlocker. The latter option can be done efficiently by identifying snapshots with block height and calling a store function to remove past versions.
# Accessing old state versions
One of the functional requirements is to access old state. This is done through
abci.RequestQuery structure. The version is specified by a block height (so we query for an object by a key
K at block height
H). The number of old versions supported for
abci.RequestQuery is configurable. Accessing an old state is done by using available snapshots.
abci.RequestQuery doesn't need old state of
SC unless the
prove=true parameter is set. The SMT merkle proof must be included in the
abci.ResponseQuery only if both
SS have a snapshot for requested version.
Moreover, Cosmos SDK could provide a way to directly access a historical state. However, a state machine shouldn't do that - since the number of snapshots is configurable, it would lead to nondeterministic execution.
We positively validated (opens new window) a versioning and snapshot mechanism for querying old state with regards to the database we evaluated.
# State Proofs
For any object stored in State Store (SS), we have corresponding object in
SC. A proof for object
V identified by a key
K is a branch of
SC, where the path corresponds to the key
hash(K), and the leaf is
We need to be able to process transactions and roll-back state updates if a transaction fails. This can be done in the following way: during transaction processing, we keep all state change requests (writes) in a
CacheWrapper abstraction (as it's done today). Once we finish the block processing, in the
Endblocker, we commit a root store - at that time, all changes are written to the SMT and to the
SS and a snapshot is created.
# Committing to an object without saving it
We identified use-cases, where modules will need to save an object commitment without storing an object itself. Sometimes clients are receiving complex objects, and they have no way to prove a correctness of that object without knowing the storage layout. For those use cases it would be easier to commit to the object without storing it directly.
# Refactor MultiStore
/store implementation (store/v1) adds an additional layer in the SDK store construction - the
MultiStore structure. The multistore exists to support the modularity of the Cosmos SDK - each module is using its own instance of IAVL, but in the current implementation, all instances share the same database. The latter indicates, however, that the implementation doesn't provide true modularity. Instead it causes problems related to race condition and atomic DB commits (see: #6370 (opens new window) and discussion (opens new window)).
We propose to reduce the multistore concept from the SDK, and to use a single instance of
SS in a
RootStore object. To avoid confusion, we should rename the
MultiStore interface to
RootStore will have the following interface; the methods for configuring tracing and listeners are omitted for brevity.
In contrast to
RootStore doesn't allow to dynamically mount sub-stores or provide an arbitrary backing DB for individual sub-stores.
NOTE: modules will be able to use a special commitment and their own DBs. For example: a module which will use ZK proofs for state can store and commit this proof in the
RootStore (usually as a single record) and manage the specialized store privately or using the
SC low level interface.
# Compatibility support
To ease the transition to this new interface for users, we can create a shim which wraps a
CommitMultiStore but provides a
CommitRootStore interface, and expose functions to safely create and access the underlying
RootStore and supporting types can be implemented in a
store/v2alpha1 package to avoid breaking existing code.
# Merkle Proofs and IBC
Currently, an IBC (v1.0) Merkle proof path consists of two elements (
["<store-key>", "<record-key>"]), with each key corresponding to a separate proof. These are each verified according to individual ICS-23 specs (opens new window), and the result hash of each step is used as the committed value of the next step, until a root commitment hash is obtained.
The root hash of the proof for
"<record-key>" is hashed with the
"<store-key>" to validate against the App Hash.
This is not compatible with the
RootStore, which stores all records in a single Merkle tree structure, and won't produce separate proofs for the store- and record-key. Ideally, the store-key component of the proof could just be omitted, and updated to use a "no-op" spec, so only the record-key is used. However, because the IBC verification code hardcodes the
"ibc" prefix and applies it to the SDK proof as a separate element of the proof path, this isn't possible without a breaking change. Breaking this behavior would severely impact the Cosmos ecosystem which already widely adopts the IBC module. Requesting an update of the IBC module across the chains is a time consuming effort and not easily feasible.
As a workaround, the
RootStore will have to use two separate SMTs (they could use the same underlying DB): one for IBC state and one for everything else. A simple Merkle map that reference these SMTs will act as a Merkle Tree to create a final App hash. The Merkle map is not stored in a DBs - it's constructed in the runtime. The IBC substore key must be
The workaround can still guarantee atomic syncs: the proposed DB backends support atomic transactions and efficient rollbacks, which will be used in the commit phase.
The presented workaround can be used until the IBC module is fully upgraded to supports single-element commitment proofs.
# Optimization: compress module key prefixes
We consider a compression of prefix keys by creating a mapping from module key to an integer, and serializing the integer using varint coding. Varint coding assures that different values don't have common byte prefix. For Merkle Proofs we can't use prefix compression - so it should only apply for the
SS keys. Moreover, the prefix compression should be only applied for the module namespace. More precisely:
- each module has it's own namespace;
- when accessing a module namespace we create a KVStore with embedded prefix;
- that prefix will be compressed only when accessing and managing
We need to assure that the codes won't change. We can fix the mapping in a static variable (provided by an app) or SS state under a special key.
TODO: need to make decision about the key compression.
# Optimization: SS key compression
Some objects may be saved with key, which contains a Protobuf message type. Such keys are long. We could save a lot of space if we can map Protobuf message types in varints.
TODO: finalize this or move to another ADR.
Using the new store will require a migration. 2 Migrations are proposed:
- Genesis export -- it will reset the blockchain history.
- In place migration: we can reuse
UpgradeKeeper.SetUpgradeHandlerto provide the migration logic:
Migrate function will read all entries from a store/v1 DB and save them to the AD-40 combined KV store.
Cache layer should not be used and the operation must finish with a single Commit call.
Inserting records to the
SC (SMT) component is the bottleneck. Unfortunately SMT doesn't support batch transactions.
Adding batch transactions to
SC layer is considered as a feature after the main release.
# Backwards Compatibility
This ADR doesn't introduce any Cosmos SDK level API changes.
We change the storage layout of the state machine, a storage hard fork and network upgrade is required to incorporate these changes. SMT provides a merkle proof functionality, however it is not compatible with ICS23. Updating the proofs for ICS23 compatibility is required.
- Decoupling state from state commitment introduce better engineering opportunities for further optimizations and better storage patterns.
- Performance improvements.
- Joining SMT based camp which has wider and proven adoption than IAVL. Example projects which decided on SMT: Ethereum2, Diem (Libra), Trillan, Tezos, Celestia.
- Multistore removal fixes a longstanding issue with the current MultiStore design.
- Simplifies merkle proofs - all modules, except IBC, have only one pass for merkle proof.
- Storage migration
- LL SMT doesn't support pruning - we will need to add and test that functionality.
SSkeys will have an overhead of a key prefix. This doesn't impact
SCbecause all keys in
SChave same size (they are hashed).
- Deprecating IAVL, which is one of the core proposals of Cosmos Whitepaper.
# Alternative designs
Most of the alternative designs were evaluated in state commitments and storage report (opens new window).
Ethereum research published Verkle Trie (opens new window) - an idea of combining polynomial commitments with merkle tree in order to reduce the tree height. This concept has a very good potential, but we think it's too early to implement it. The current, SMT based design could be easily updated to the Verkle Trie once other research implement all necessary libraries. The main advantage of the design described in this ADR is the separation of state commitments from the data storage and designing a more powerful interface.
# Further Discussions
# Evaluated KV Databases
We verified existing databases KV databases for evaluating snapshot support. The following databases provide efficient snapshot mechanism: Badger, RocksDB, Pebble (opens new window). Databases which don't provide such support or are not production ready: boltdb, leveldb, goleveldb, membdb, lmdb.
Use of RDBMS instead of simple KV store for state. Use of RDBMS will require a Cosmos SDK API breaking change (
KVStore interface) and will allow better data extraction and indexing solutions. Instead of saving an object as a single blob of bytes, we could save it as record in a table in the state storage layer, and as a
hash(key, protobuf(object)) in the SMT as outlined above. To verify that an object registered in RDBMS is same as the one committed to SMT, one will need to load it from RDBMS, marshal using protobuf, hash and do SMT search.
# Off Chain Store
We were discussing use case where modules can use a support database, which is not automatically committed. Module will responsible for having a sound storage model and can optionally use the feature discussed in _Committing to an object without saving it section.
- IAVL What's Next? (opens new window)
- IAVL overview (opens new window) of it's state v0.15
- State commitments and storage report (opens new window)
- Celestia (LazyLedger) SMT (opens new window)
- Facebook Diem (Libra) SMT design (opens new window)
- Trillian Revocation Transparency (opens new window), Trillian Verifiable Data Structures (opens new window).
- Design and implementation discussion (opens new window).
- How to Upgrade IBC Chains and their Clients (opens new window)
- ADR-40 Effect on IBC (opens new window)