Struct StateView 

pub struct StateView { /* private fields */ }

A consistent read view of the store, pinned at its snapshot’s block height.

Obtained from State::view; create one per request and drop it when the request completes. Holding a view pins a snapshot generation (and thereby the RocksDB snapshots backing the trees), so it must not be stored in long-lived structs; leaked or slow readers are reported by the store’s snapshot-lifetime warnings.

Reads that are technically not block-scoped (for example, immutable content-addressed data) also live here so that every read path flows through one type.

Implementations

impl StateView

pub async fn get_account( &self, account_request: AccountRequest, ) -> Result<AccountResponse, GetAccountError>

Returns an account witness and optionally account details at a specific block.

The witness is a Merkle proof of inclusion in the account tree, proving the account’s state commitment. If details is requested, the method also returns the account’s code, vault assets, and storage data. Account details are only available for public accounts.

If block_num is provided, returns the state at that historical block; otherwise, returns the latest state. Note that historical states are only available for recent blocks close to the chain tip.

impl StateView

pub async fn filter_network_accounts( &self, account_ids: &[AccountId], ) -> Result<HashSet<AccountId>, DatabaseError>

Filters account_ids down to the subset classified as network accounts.

impl StateView

pub async fn get_block_header( &self, block_num: Option<BlockNumber>, include_mmr_proof: bool, ) -> Result<(Option<BlockHeader>, Option<MmrProof>), GetBlockHeaderError>

Queries a BlockHeader from the database, and returns it alongside its inclusion proof.

If None is given as the value of block_num, the data for the latest BlockHeader is returned. Returns (None, None) for blocks beyond this view’s chain tip.

impl StateView

pub async fn get_note_inclusion_proofs( &self, reference_block: BlockNumber, note_ids: BTreeSet<NoteId>, ) -> Result<BTreeMap<NoteId, NoteInclusionProof>, GetNoteInclusionProofsError>

Fetches inclusion proofs for notes included at or before the reference block.

pub async fn get_block_inclusion_proofs( &self, reference_block: BlockNumber, block_numbers: BTreeSet<BlockNumber>, ) -> Result<PartialBlockchain, GetBlockInclusionProofsError>

Fetches inclusion proofs for blocks relative to the reference block.

The returned partial blockchain contains all requested blocks before the reference block.

impl StateView

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

Queries a list of notes from the database.

If the provided list of NoteIds is empty or no note matches, an empty list is returned. This lookup is deliberately not bounded by this view’s tip (latest-wins): a note committed while a block is being applied may be returned before the snapshot advances.

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

Returns the script for a note by its root.

impl StateView

pub async fn get_protocol_config_commitment_at( &self, block_number: BlockNumber, ) -> Result<Option<Word>, DatabaseError>

Returns the configuration commitment active at the specified block.

Returns an error if the block exceeds this view’s tip.

pub async fn get_protocol_config( &self, commitment: Word, ) -> Result<Option<ProtocolConfig>, DatabaseError>

Returns the protocol configuration with the specified commitment.

impl StateView

pub fn get_state_witnesses( &self, account_ids: &[AccountId], nullifiers: &[Nullifier], ) -> StateWitnesses

Returns state witnesses for the requested accounts and nullifiers.

impl StateView

pub async fn sync_transactions( &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.

Returns RangeBeyondTip if the range extends beyond this view’s chain tip.

pub async fn sync_chain_mmr( &self, block_range: RangeInclusive<BlockNumber>, ) -> Result<(MmrDelta, BlockHeader, BlockSignatures), StateSyncError>

Returns the chain MMR delta and the block header at the range’s end for the specified block range.

Returns RangeBeyondTip if the range extends beyond this view’s chain tip.

pub async fn sync_notes( &self, note_tags: Vec<u32>, block_range: RangeInclusive<BlockNumber>, ) -> Result<(Vec<(NoteSyncUpdate, MmrProof)>, BlockNumber), NoteSyncError>

Loads data to synchronize a client’s notes.

Returns as many blocks with matching notes as fit within the response payload limit (MAX_RESPONSE_PAYLOAD_BYTES). Each block includes its header and MMR proof at forest block_range.end() + 1.

Also returns the last block number checked. If this equals block_range.end(), the sync is complete.

Returns RangeBeyondTip if the range extends beyond this view’s chain tip.

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

Returns nullifiers matching the given prefixes that were created within a block range.

Returns RangeBeyondTip if the range extends beyond this view’s chain tip.

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

Returns account vault updates for specified account within a block range.

Returns RangeBeyondTip if the range extends beyond this view’s chain tip.

pub async fn sync_account_storage_maps( &self, account_id: AccountId, block_range: RangeInclusive<BlockNumber>, ) -> Result<StorageMapValuesPage, DatabaseError>

Returns storage map values for syncing within a block range.

Returns RangeBeyondTip if the range extends beyond this view’s chain tip.

impl StateView

pub async fn get_transaction_inputs( &self, account_id: AccountId, nullifiers: &[Nullifier], unauthenticated_note_ids: Vec<NoteId>, ) -> Result<TransactionInputs, DatabaseError>

Returns data needed by the block producer to verify transaction validity.

impl StateView

pub fn tip(&self) -> ScopedBlockNum

Returns this view’s tip as a scoped block number for tip-bounded database queries.