Crates.io | sov-db |
lib.rs | sov-db |
version | 0.3.0 |
source | src |
created_at | 2023-05-31 15:54:46.32197 |
updated_at | 2023-10-20 16:58:07.889468 |
description | A high-level DB interface for the Sovereign SDK |
homepage | https://www.sovereign.xyz |
repository | https://github.com/sovereign-labs/sovereign-sdk |
max_upload_size | |
id | 878916 |
size | 74,473 |
This package provides a high-level interface to a Schema DB designed specifically for use with the Sovereign SDK.
It exposes two db types: LedgerDB
, and StateDB
.
As the name implies, the LedgerDB
is designed to store ledger history. It has tables for slots, batches, transactions, and events.
The LedgerDB
also implements the LedgerRpcProvider
trait, allowing it to easily serve chain history over RPC.
The StateDB is intended to be used with the Jellyfish Merkle Tree provided by the Module System. If you aren't using the Module System, chances are that you'll want to implement your own State Database.
StateDB is designed to store Jellyfish Merkle Tree data efficiently. It maintains a flat store mapping (Key, Version)
tuples
to values, as well as a mapping from JMT NodeKey
s to JMT Nodes
.
In the Module System, StateDB is abstracted behind the Storage interface, so you won't interact with it directly.