Struct zebra_state::service::finalized_state::disk_db::DiskWriteBatch

pub struct DiskWriteBatch {
    batch: WriteBatch,
}

Wrapper struct to ensure low-level database writes go through the correct API.

[rocksdb::WriteBatch] is a batched set of database updates, which must be written to the database using DiskDb::write(batch).

Fields

batch: WriteBatch

The inner RocksDB write batch.

Implementations

impl DiskWriteBatch

pub fn new() -> Self

Creates and returns a new transactional batch write.

Correctness

Each block must be written to the state inside a batch, so that:

• concurrent ReadStateService queries don’t see half-written blocks, and
• if Zebra calls exit, panics, or crashes, half-written blocks are rolled back.

impl DiskWriteBatch

pub fn prepare_block_batch( &mut self, zebra_db: &ZebraDb, network: &Network, finalized: &FinalizedBlock, new_outputs_by_out_loc: BTreeMap<OutputLocation, Utxo>, spent_utxos_by_outpoint: HashMap<OutPoint, Utxo>, spent_utxos_by_out_loc: BTreeMap<OutputLocation, Utxo>, address_balances: HashMap<Address, AddressBalanceLocation>, value_pool: ValueBalance<NonNegative>, prev_note_commitment_trees: Option<NoteCommitmentTrees>, ) -> Result<(), BoxError>

Prepare a database batch containing finalized.block, and return it (without actually writing anything).

If this method returns an error, it will be propagated, and the batch should not be written to the database.

Errors

• Propagates any errors from updating history tree, note commitment trees, or value pools

pub fn prepare_block_header_and_transaction_data_batch( &mut self, db: &DiskDb, finalized: &FinalizedBlock, ) -> Result<(), BoxError>

Prepare a database batch containing the block header and transaction data from finalized.block, and return it (without actually writing anything).

Errors

• This method does not currently return any errors.

impl DiskWriteBatch

pub fn update_history_tree(&mut self, db: &ZebraDb, tree: &HistoryTree)

Updates the history tree for the tip, if it is not empty.

The batch must be written to the database by the caller.

pub fn delete_range_history_tree( &mut self, db: &ZebraDb, from: &Height, until_strictly_before: &Height, )

Legacy method: Deletes the range of history trees at the given Heights. Doesn’t delete the upper bound.

From state format 25.3.0 onwards, the history trees are indexed by an empty key, so this method does nothing.

The batch must be written to the database by the caller.

pub fn prepare_chain_value_pools_batch( &mut self, db: &ZebraDb, finalized: &FinalizedBlock, utxos_spent_by_block: HashMap<OutPoint, Utxo>, value_pool: ValueBalance<NonNegative>, ) -> Result<(), BoxError>

Prepares a database batch containing the chain value pool update from finalized.block, and returns it without actually writing anything.

The batch is modified by this method and written by the caller. The caller should not write the batch if this method returns an error.

The parameter utxos_spent_by_block must contain the transparent::Utxos of every input in this block, including UTXOs created by earlier transactions in this block.

Note that the chain value pool has the opposite sign to the transaction value pool. See the chain_value_pool_change and add_chain_value_pool_change methods for more details.

Errors

• Propagates any errors from updating value pools

impl DiskWriteBatch

pub fn prepare_shielded_transaction_batch( &mut self, db: &DiskDb, finalized: &FinalizedBlock, ) -> Result<(), BoxError>

Prepare a database batch containing finalized.block’s shielded transaction indexes, and return it (without actually writing anything).

If this method returns an error, it will be propagated, and the batch should not be written to the database.

Errors

• Propagates any errors from updating note commitment trees

pub fn prepare_nullifier_batch( &mut self, db: &DiskDb, transaction: &Transaction, ) -> Result<(), BoxError>

Prepare a database batch containing finalized.block’s nullifiers, and return it (without actually writing anything).

Errors

• This method doesn’t currently return any errors, but it might in future

pub fn prepare_trees_batch( &mut self, zebra_db: &ZebraDb, finalized: &FinalizedBlock, prev_note_commitment_trees: Option<NoteCommitmentTrees>, ) -> Result<(), BoxError>

Prepare a database batch containing the note commitment and history tree updates from finalized.block, and return it (without actually writing anything).

If this method returns an error, it will be propagated, and the batch should not be written to the database.

Errors

• Propagates any errors from updating the history tree

pub fn update_sprout_tree( &mut self, zebra_db: &ZebraDb, tree: &NoteCommitmentTree, )

Updates the Sprout note commitment tree for the tip, and the Sprout anchors.

pub fn delete_range_sprout_tree( &mut self, zebra_db: &ZebraDb, from: &Height, to: &Height, )

Legacy method: Deletes the range of Sprout note commitment trees at the given Heights. Doesn’t delete anchors from the anchor index. Doesn’t delete the upper bound.

From state format 25.3.0 onwards, the Sprout trees are indexed by an empty key, so this method does nothing.

pub fn delete_sprout_anchor(&mut self, zebra_db: &ZebraDb, anchor: &Root)

Deletes the given Sprout note commitment tree anchor.

pub fn create_sapling_tree( &mut self, zebra_db: &ZebraDb, height: &Height, tree: &NoteCommitmentTree, )

Inserts or overwrites the Sapling note commitment tree at the given Height, and the Sapling anchors.

pub fn insert_sapling_subtree( &mut self, zebra_db: &ZebraDb, subtree: &NoteCommitmentSubtree<Node>, )

Inserts the Sapling note commitment subtree into the batch.

pub fn delete_sapling_tree(&mut self, zebra_db: &ZebraDb, height: &Height)

Deletes the Sapling note commitment tree at the given Height.

pub fn delete_range_sapling_tree( &mut self, zebra_db: &ZebraDb, from: &Height, to: &Height, )

Deletes the range of Sapling note commitment trees at the given Heights. Doesn’t delete anchors from the anchor index. Doesn’t delete the upper bound.

pub fn delete_sapling_anchor(&mut self, zebra_db: &ZebraDb, anchor: &Root)

Deletes the given Sapling note commitment tree anchor.

pub fn delete_range_sapling_subtree( &mut self, zebra_db: &ZebraDb, from: NoteCommitmentSubtreeIndex, to: NoteCommitmentSubtreeIndex, )

Deletes the range of Sapling subtrees at the given NoteCommitmentSubtreeIndexes. Doesn’t delete the upper bound.

pub fn create_orchard_tree( &mut self, zebra_db: &ZebraDb, height: &Height, tree: &NoteCommitmentTree, )

Inserts or overwrites the Orchard note commitment tree at the given Height, and the Orchard anchors.

pub fn insert_orchard_subtree( &mut self, zebra_db: &ZebraDb, subtree: &NoteCommitmentSubtree<Node>, )

Inserts the Orchard note commitment subtree into the batch.

pub fn delete_orchard_tree(&mut self, zebra_db: &ZebraDb, height: &Height)

Deletes the Orchard note commitment tree at the given Height.

pub fn delete_range_orchard_tree( &mut self, zebra_db: &ZebraDb, from: &Height, to: &Height, )

Deletes the range of Orchard note commitment trees at the given Heights. Doesn’t delete anchors from the anchor index. Doesn’t delete the upper bound.

pub fn delete_orchard_anchor(&mut self, zebra_db: &ZebraDb, anchor: &Root)

Deletes the given Orchard note commitment tree anchor.

pub fn delete_range_orchard_subtree( &mut self, zebra_db: &ZebraDb, from: NoteCommitmentSubtreeIndex, to: NoteCommitmentSubtreeIndex, )

Deletes the range of Orchard subtrees at the given NoteCommitmentSubtreeIndexes. Doesn’t delete the upper bound.

impl DiskWriteBatch

pub fn prepare_transparent_transaction_batch( &mut self, db: &DiskDb, network: &Network, finalized: &FinalizedBlock, new_outputs_by_out_loc: &BTreeMap<OutputLocation, Utxo>, spent_utxos_by_outpoint: &HashMap<OutPoint, Utxo>, spent_utxos_by_out_loc: &BTreeMap<OutputLocation, Utxo>, address_balances: HashMap<Address, AddressBalanceLocation>, ) -> Result<(), BoxError>

Prepare a database batch containing finalized.block’s transparent transaction indexes, and return it (without actually writing anything).

If this method returns an error, it will be propagated, and the batch should not be written to the database.

Errors

• Propagates any errors from updating note commitment trees

pub fn prepare_new_transparent_outputs_batch( &mut self, db: &DiskDb, network: &Network, new_outputs_by_out_loc: &BTreeMap<OutputLocation, Utxo>, address_balances: &mut HashMap<Address, AddressBalanceLocation>, ) -> Result<(), BoxError>

Prepare a database batch for the new UTXOs in new_outputs_by_out_loc.

Adds the following changes to this batch:

• insert created UTXOs,
• insert transparent address UTXO index entries, and
• insert transparent address transaction entries,

without actually writing anything.

Also modifies the address_balances for these new UTXOs.

Errors

• This method doesn’t currently return any errors, but it might in future

pub fn prepare_spent_transparent_outputs_batch( &mut self, db: &DiskDb, network: &Network, spent_utxos_by_out_loc: &BTreeMap<OutputLocation, Utxo>, address_balances: &mut HashMap<Address, AddressBalanceLocation>, ) -> Result<(), BoxError>

Prepare a database batch for the spent outputs in spent_utxos_by_out_loc.

Adds the following changes to this batch:

• delete spent UTXOs, and
• delete transparent address UTXO index entries,

without actually writing anything.

Also modifies the address_balances for these new UTXOs.

Errors

• This method doesn’t currently return any errors, but it might in future

pub fn prepare_spending_transparent_tx_ids_batch( &mut self, db: &DiskDb, network: &Network, spending_tx_location: TransactionLocation, transaction: &Transaction, spent_utxos_by_outpoint: &HashMap<OutPoint, Utxo>, address_balances: &HashMap<Address, AddressBalanceLocation>, ) -> Result<(), BoxError>

Prepare a database batch indexing the transparent addresses that spent in this transaction.

Adds the following changes to this batch:

• index spending transactions for each spent transparent output (this is different from the transaction that created the output),

without actually writing anything.

Errors

• This method doesn’t currently return any errors, but it might in future

pub fn prepare_transparent_balances_batch( &mut self, db: &DiskDb, address_balances: HashMap<Address, AddressBalanceLocation>, ) -> Result<(), BoxError>

Prepare a database batch containing finalized.block’s:

• transparent address balance changes,

and return it (without actually writing anything).

Errors

• This method doesn’t currently return any errors, but it might in future

Trait Implementations

impl Debug for DiskWriteBatch

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

Formats the value using the given formatter.

impl Default for DiskWriteBatch

fn default() -> DiskWriteBatch

Returns the “default value” for a type.

impl PartialEq for DiskWriteBatch

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WriteDisk for DiskWriteBatch

Deprecation

These impls should not be used in new code, use WriteTypedBatch instead.

fn zs_insert<C, K, V>(&mut self, cf: &C, key: K, value: V)

where C: AsColumnFamilyRef, K: IntoDisk + Debug, V: IntoDisk,

Serialize and insert the given key and value into a rocksdb column family, overwriting any existing value for key.

fn zs_delete<C, K>(&mut self, cf: &C, key: K)

where C: AsColumnFamilyRef, K: IntoDisk + Debug,

Remove the given key from a rocksdb column family, if it exists.

fn zs_delete_range<C, K>(&mut self, cf: &C, from: K, until_strictly_before: K)

where C: AsColumnFamilyRef, K: IntoDisk + Debug,

Delete the given key range from a rocksdb column family, if it exists, including from and excluding until_strictly_before.

impl Eq for DiskWriteBatch