Struct LedgerDB

pub struct LedgerDB { /* private fields */ }

A database which stores the ledger history (slots, transactions, events, etc). Ledger data is first ingested into an in-memory map before being fed to the state-transition function. Once the state-transition function has been executed and finalized, the results are committed to the final db

Implementations

impl LedgerDB

pub fn with_path(path: impl AsRef<Path>) -> Result<Self, Error>

Open a LedgerDB (backed by RocksDB) at the specified path. The returned instance will be at the path {path}/ledger-db.

pub fn get_next_items_numbers(&self) -> ItemNumbers

Get the next slot, block, transaction, and event numbers

pub fn commit_slot<S: SlotData, B: Serialize, T: Serialize>( &self, data_to_commit: SlotCommit<S, B, T>, ) -> Result<(), Error>

Commits a slot to the database by inserting its events, transactions, and batches before inserting the slot metadata.

pub fn get_head_slot(&self) -> Result<Option<(SlotNumber, StoredSlot)>>

Get the most recent committed slot, if any

Trait Implementations

impl Clone for LedgerDB

fn clone(&self) -> LedgerDB

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LedgerDB

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl LedgerRpcProvider for LedgerDB

fn get_slots<B: DeserializeOwned, T: DeserializeOwned>( &self, slot_ids: &[SlotIdentifier], query_mode: QueryMode, ) -> Result<Vec<Option<SlotResponse<B, T>>>, Error>

Get a list of slots by id. The IDs need not be ordered.

fn get_batches<B: DeserializeOwned, T: DeserializeOwned>( &self, batch_ids: &[BatchIdentifier], query_mode: QueryMode, ) -> Result<Vec<Option<BatchResponse<B, T>>>, Error>

Get a list of batches by id. The IDs need not be ordered.

fn get_transactions<T: DeserializeOwned>( &self, tx_ids: &[TxIdentifier], _query_mode: QueryMode, ) -> Result<Vec<Option<TxResponse<T>>>, Error>

Get a list of transactions by id. The IDs need not be ordered.

fn get_events( &self, event_ids: &[EventIdentifier], ) -> Result<Vec<Option<Event>>, Error>

Get events by id. The IDs need not be ordered.

fn get_head<B: DeserializeOwned, T: DeserializeOwned>( &self, query_mode: QueryMode, ) -> Result<Option<SlotResponse<B, T>>, Error>

Get the latest slot in the ledger.

fn get_slot_by_hash<B: DeserializeOwned, T: DeserializeOwned>( &self, hash: &[u8; 32], query_mode: QueryMode, ) -> Result<Option<SlotResponse<B, T>>, Error>

Get a single slot by hash.

fn get_batch_by_hash<B: DeserializeOwned, T: DeserializeOwned>( &self, hash: &[u8; 32], query_mode: QueryMode, ) -> Result<Option<BatchResponse<B, T>>, Error>

Get a single batch by hash.

fn get_tx_by_hash<T: DeserializeOwned>( &self, hash: &[u8; 32], query_mode: QueryMode, ) -> Result<Option<TxResponse<T>>, Error>

Get a single transaction by hash.

fn get_slot_by_number<B: DeserializeOwned, T: DeserializeOwned>( &self, number: u64, query_mode: QueryMode, ) -> Result<Option<SlotResponse<B, T>>, Error>

Get a single slot by number.

fn get_batch_by_number<B: DeserializeOwned, T: DeserializeOwned>( &self, number: u64, query_mode: QueryMode, ) -> Result<Option<BatchResponse<B, T>>, Error>

Get a single batch by number.

fn get_tx_by_number<T: DeserializeOwned>( &self, number: u64, query_mode: QueryMode, ) -> Result<Option<TxResponse<T>>, Error>

Get a single tx by number.

fn get_event_by_number(&self, number: u64) -> Result<Option<Event>, Error>

Get a single event by number.

fn get_slots_range<B: DeserializeOwned, T: DeserializeOwned>( &self, start: u64, end: u64, query_mode: QueryMode, ) -> Result<Vec<Option<SlotResponse<B, T>>>, Error>

Get a range of slots. This query is the most efficient way to fetch large numbers of slots, since it allows for easy batching of db queries for adjacent items.

fn get_batches_range<B: DeserializeOwned, T: DeserializeOwned>( &self, start: u64, end: u64, query_mode: QueryMode, ) -> Result<Vec<Option<BatchResponse<B, T>>>, Error>

Get a range of batches. This query is the most efficient way to fetch large numbers of batches, since it allows for easy batching of db queries for adjacent items.

fn get_transactions_range<T: DeserializeOwned>( &self, start: u64, end: u64, query_mode: QueryMode, ) -> Result<Vec<Option<TxResponse<T>>>, Error>

Get a range of batches. This query is the most efficient way to fetch large numbers of transactions, since it allows for easy batching of db queries for adjacent items.

fn subscribe_slots(&self) -> Result<Receiver<u64>, Error>

Get a notification each time a slot is processed