Struct Db 

pub struct Db { /* private fields */ }

The Store’s database.

Extends the underlying miden_node_db::Db type with functionality specific to the Store.

Implementations

impl Db

pub fn bootstrap( database_filepath: PathBuf, genesis: GenesisBlock, ) -> Result<()>

Creates a new database and inserts the genesis block.

pub async fn load(database_filepath: PathBuf) -> Result<Self, DatabaseError>

Open a connection to the DB after verifying that it is at the latest schema version.

pub async fn load_with_pool_size( database_filepath: PathBuf, connection_pool_size: NonZeroUsize, ) -> Result<Self, DatabaseError>

Open a connection to the DB with a specific pool size after verifying that it is at the latest schema version.

pub fn migrate(database_filepath: impl AsRef<Path>) -> Result<(), DatabaseError>

Applies all pending migrations to an existing DB.

pub async fn select_nullifiers_paged( &self, page_size: NonZeroUsize, after_nullifier: Option<Nullifier>, ) -> Result<NullifiersPage, DatabaseError>

Returns a page of nullifiers for tree rebuilding.

pub async fn select_nullifiers_by_prefix( &self, prefix_len: u32, nullifier_prefixes: Vec<u32>, block_range: RangeInclusive<BlockNumber>, ) -> Result<(Vec<NullifierInfo>, BlockNumber), DatabaseError>

Loads the nullifiers that match the prefixes from the DB.

pub async fn select_block_header_by_block_num( &self, maybe_block_number: Option<BlockNumber>, ) -> Result<Option<BlockHeader>, DatabaseError>

Search for a BlockHeader from the database by its block_num.

When block_number is None, the latest block header is returned.

pub async fn select_block_header_and_signature_by_block_num( &self, block_number: BlockNumber, ) -> Result<Option<(BlockHeader, Signature)>, DatabaseError>

Search for a BlockHeader and its Signature from the database by its block_num.

pub async fn select_block_headers( &self, blocks: impl Iterator<Item = BlockNumber> + Send + 'static, ) -> Result<Vec<BlockHeader>, DatabaseError>

Loads multiple block headers from the DB.

pub async fn select_all_block_header_commitments( &self, ) -> Result<Vec<BlockHeaderCommitment>, DatabaseError>

Loads all the block headers from the DB.

pub async fn select_account_commitments_paged( &self, page_size: NonZeroUsize, after_account_id: Option<AccountId>, ) -> Result<AccountCommitmentsPage, DatabaseError>

Returns a page of account commitments for tree rebuilding.

pub async fn select_public_account_ids_paged( &self, page_size: NonZeroUsize, after_account_id: Option<AccountId>, ) -> Result<PublicAccountIdsPage, DatabaseError>

Returns a page of public account IDs for forest rebuilding.

pub async fn select_public_account_state_roots_paged( &self, page_size: NonZeroUsize, after_account_id: Option<AccountId>, ) -> Result<PublicAccountStateRootsPage, DatabaseError>

Returns a page of public account state roots for forest consistency verification.

pub async fn select_account( &self, id: AccountId, ) -> Result<AccountInfo, DatabaseError>

Loads public account details from the DB.

pub async fn select_network_accounts_subset( &self, account_ids: Vec<AccountId>, ) -> Result<HashSet<AccountId>, DatabaseError>

Returns the subset of the provided account IDs that classify as network accounts.

pub async fn select_account_code_by_commitment( &self, code_commitment: Word, ) -> Result<Option<Vec<u8>>, DatabaseError>

Queries the account code by its commitment hash.

Returns None if no code exists with that commitment.

pub async fn select_account_header_with_storage_header_at_block( &self, account_id: AccountId, block_num: BlockNumber, ) -> Result<Option<(AccountHeader, AccountStorageHeader)>, DatabaseError>

Queries the account header and storage header for a specific account at a block.

Returns both in a single query to avoid querying the database twice. Returns None if the account doesn’t exist at that block.

pub async fn get_note_sync_multi( &self, block_range: RangeInclusive<BlockNumber>, note_tags: Arc<[u32]>, ) -> Result<Vec<NoteSyncUpdate>, NoteSyncError>

pub async fn select_notes_by_id( &self, note_ids: Vec<NoteId>, ) -> Result<Vec<NoteRecord>, DatabaseError>

Loads all the miden_protocol::note::Notes matching a certain NoteId from the database.

pub async fn select_existing_note_commitments( &self, note_commitments: Vec<Word>, ) -> Result<HashSet<Word>, DatabaseError>

Returns all note commitments from the DB that match the provided ones.

pub async fn select_note_inclusion_proofs( &self, note_commitments: BTreeSet<Word>, ) -> Result<BTreeMap<NoteId, NoteInclusionProof>, DatabaseError>

Loads inclusion proofs for notes matching the given note commitments.

pub async fn apply_block( &self, allow_acquire: Sender<()>, acquire_done: Receiver<()>, signed_block: SignedBlock, notes: Vec<(NoteRecord, Option<Nullifier>)>, ) -> Result<(), DatabaseError>

Inserts the data of a new block into the DB.

allow_acquire and acquire_done are used to synchronize writes to the DB with writes to the in-memory trees. Further details available on super::state::State::apply_block.

pub async fn get_account_vault_sync( &self, account_id: AccountId, block_range: RangeInclusive<BlockNumber>, ) -> Result<(BlockNumber, Vec<AccountVaultValue>), DatabaseError>

pub async fn select_note_script_by_root( &self, root: Word, ) -> Result<Option<NoteScript>, DatabaseError>

Returns the script for a note by its root.

pub async fn select_transactions_records( &self, account_ids: Vec<AccountId>, block_range: RangeInclusive<BlockNumber>, ) -> Result<(BlockNumber, Vec<TransactionRecord>), DatabaseError>

Returns the complete transaction records for the specified accounts within the specified block range, including state commitments and note IDs.

Note: This method is size-limited (~5MB) and may not return all matching transactions if the limit is exceeded. Transactions from partial blocks are excluded to maintain consistency.

Methods from Deref<Target = Db>

pub async fn pinned_connection(&self) -> Result<PinnedConnection, DatabaseError>

Checks out a connection from the pool and pins it for the caller’s exclusive, long-lived use. See PinnedConnection.

This removes one connection from the shared pool for the lifetime of the returned handle, so the pool must be sized to leave at least one connection for other users.

pub async fn transact<R, E, Q, M>(&self, msg: M, query: Q) -> Result<R, E>

where Q: Send + for<'a, 't> FnOnce(&'a mut SqliteConnection) -> Result<R, E> + 'static, R: Send + 'static, M: Send + ToString, E: From<Error> + From<DatabaseError> + Error + Send + Sync + 'static,

Create and commit a transaction with the queries added in the provided closure

pub async fn query<R, E, Q, M>(&self, msg: M, query: Q) -> Result<R, E>

where Q: Send + FnOnce(&mut SqliteConnection) -> Result<R, E> + 'static, R: Send + 'static, M: Send + ToString, E: From<DatabaseError> + Error + Send + Sync + 'static,

Run the query without a transaction

Trait Implementations

impl Deref for Db

type Target = Db

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Db

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.