Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use the database for the validity store
Mantain the txns in the validity store in database tables.
- Loading branch information
1 parent
b7c31bf
commit 3f82095
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GitHub Actions
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,118 +1,151 @@ | ||
| use std::collections::{HashMap, HashSet}; | ||
|
Check warning on line 1 in blockchain/src/history/validity_store.rs
|
||
|
|
||
| use nimiq_database::{ | ||
| traits::{Database, ReadCursor, ReadTransaction, WriteTransaction}, | ||
| DatabaseProxy, TableFlags, TableProxy, TransactionProxy, WriteTransactionProxy, | ||
| }; | ||
| use nimiq_hash::Blake2bHash; | ||
| use nimiq_primitives::policy::Policy; | ||
|
|
||
| /// The validity store is used by full nodes to keep track of which | ||
| /// transactions have occurred within the validity window without | ||
| /// having to store the full transactions | ||
| pub struct ValidityStore { | ||
| // A database table with all the txn hashes | ||
| pub(crate) txn_hashes: TableProxy, | ||
|
|
||
| // A database table from block number to txn hashes | ||
| pub(crate) block_txns: TableProxy, | ||
| } | ||
|
|
||
| impl ValidityStore { | ||
| const TXN_HASHES_DB_NAME: &'static str = "ValidityTxnHashes"; | ||
| const BLOCK_TXNS_DB_NAME: &'static str = "ValidityBlockTxnHashes"; | ||
|
|
||
| /// Creates a new validity store initializing database tables | ||
| pub(crate) fn new(db: DatabaseProxy) -> Self { | ||
| let txn_hashes_table = db.open_table(Self::TXN_HASHES_DB_NAME.to_string()); | ||
| let block_txns_table = db.open_table_with_flags( | ||
| Self::BLOCK_TXNS_DB_NAME.to_string(), | ||
| TableFlags::DUPLICATE_KEYS | TableFlags::DUP_FIXED_SIZE_VALUES | TableFlags::UINT_KEYS, | ||
| ); | ||
|
|
||
| Self { | ||
| txn_hashes: txn_hashes_table, | ||
| block_txns: block_txns_table, | ||
| } | ||
| } | ||
|
|
||
| /// Returns true if the validity store has the given transaction hash. | ||
| pub(crate) fn has_transaction( | ||
| &self, | ||
| db_tx: &TransactionProxy, | ||
| raw_tx_hash: Blake2bHash, | ||
| ) -> bool { | ||
| db_tx | ||
| .get::<Blake2bHash, u32>(&self.txn_hashes, &raw_tx_hash) | ||
| .is_some() | ||
| } | ||
|
|
||
| /// Returns the first block number stored in the validity store | ||
| pub(crate) fn first_bn(&self, db_tx: &TransactionProxy) -> u32 { | ||
| // Initialize the cursor for the database. | ||
| let mut cursor = db_tx.cursor(&self.block_txns); | ||
|
|
||
| if let Some((key, _)) = cursor.first::<u32, Blake2bHash>() { | ||
| key | ||
| } else { | ||
| 0 | ||
| } | ||
| } | ||
|
|
||
| /// Obtains the last block number stored in the validity store. | ||
| pub(crate) fn last_bn(&self, db_tx: &TransactionProxy) -> u32 { | ||
| // Initialize the cursor for the database. | ||
| let mut cursor = db_tx.cursor(&self.block_txns); | ||
|
|
||
| if let Some((key, _)) = cursor.last::<u32, Blake2bHash>() { | ||
| key | ||
| } else { | ||
| 0 | ||
| } | ||
| } | ||
|
|
||
| /// Adds a transaction hash to the validity store | ||
| pub(crate) fn add_transaction( | ||
| &mut self, | ||
| db_txn: &mut WriteTransactionProxy, | ||
| block_number: u32, | ||
| transaction: Blake2bHash, | ||
| ) { | ||
| db_txn.put(&self.txn_hashes, &transaction, &transaction); | ||
|
|
||
| db_txn.put(&self.block_txns, &block_number, &transaction); | ||
| } | ||
|
|
||
| /// Delete the transactions associated to the given block number | ||
| pub(crate) fn delete_block_transactions( | ||
| &mut self, | ||
| db_txn: &mut WriteTransactionProxy, | ||
| block_number: u32, | ||
| ) { | ||
| if self.first_bn(db_txn) == self.last_bn(db_txn) { | ||
| return; | ||
| } | ||
|
|
||
| log::trace!(bn = block_number, "Deleting block from validity store"); | ||
|
|
||
| let cursor = WriteTransaction::cursor(db_txn, &self.block_txns); | ||
|
|
||
| let block_txns: Vec<Blake2bHash> = cursor | ||
| .into_iter_dup_of::<_, Blake2bHash>(&block_number) | ||
| .map(|(_, hash)| hash) | ||
| .collect(); | ||
|
|
||
| for txn_hash in block_txns { | ||
| db_txn.remove(&self.txn_hashes, &txn_hash); | ||
| } | ||
|
|
||
| db_txn.remove(&self.block_txns, &block_number); | ||
| } | ||
|
|
||
| /// Prunes the validity store keeping only 'validity_window_blocks' | ||
| pub(crate) fn prune_validity_store(&mut self, db_txn: &mut WriteTransactionProxy) { | ||
| // Compute the number of blocks we currently have in the store | ||
| let first_bn = self.first_bn(db_txn); | ||
| let last_bn = self.last_bn(db_txn); | ||
| let num_blocks = last_bn - first_bn; | ||
|
|
||
| log::trace!( | ||
| first = first_bn, | ||
| latest = last_bn, | ||
| blocks = num_blocks, | ||
| "Number of blocks in the validity store" | ||
| ); | ||
|
|
||
| if num_blocks > Policy::transaction_validity_window_blocks() { | ||
| // We need to prune the validity store | ||
| let count = num_blocks - Policy::transaction_validity_window_blocks(); | ||
|
|
||
| for bn in [first_bn, first_bn + count] { | ||
| self.delete_block_transactions(db_txn, bn); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Updates the validity store with the latest block number in the history store | ||
| /// Note: Sometimes we have blocks that do not include transactions | ||
| /// but we still need to track them in the validity store to mantain up to | ||
| /// 'validity_window_blocks' inside the validity store | ||
| pub(crate) fn update_validity_store( | ||
| &mut self, | ||
| db_txn: &mut WriteTransactionProxy, | ||
| latest_bn: u32, | ||
| ) { | ||
| if latest_bn > self.last_bn(db_txn) { | ||
| db_txn.put(&self.block_txns, &latest_bn, &Blake2bHash::default()); | ||
| } | ||
|
|
||
| self.prune_validity_store(db_txn) | ||
| } | ||
| } | ||