blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adds doc comments for Bank fns that get accounts/snapshot hashes (#32716)

This commit is contained in:
Brooks 2023-08-04 13:56:15 -04:00 committed by GitHub
parent ca7a7ad2f3
commit 04e25ff3ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/src/bank.rs
View File

@ -7333,6 +7333,10 @@ impl Bank {
old
}
/// Returns the `AccountsHash` that was calculated for this bank's slot
///
/// This fn is used when creating a snapshot with ledger-tool, or when
/// packaging a snapshot into an archive (used to get the `SnapshotHash`).
pub fn get_accounts_hash(&self) -> Option<AccountsHash> {
self.rc
.accounts
@ -7341,6 +7345,10 @@ impl Bank {
.map(|(accounts_hash, _)| accounts_hash)
}
/// Returns the `IncrementalAccountsHash` that was calculated for this bank's slot
///
/// This fn is used when creating an incremental snapshot with ledger-tool, or when
/// packaging a snapshot into an archive (used to get the `SnapshotHash`).
pub fn get_incremental_accounts_hash(&self) -> Option<IncrementalAccountsHash> {
self.rc
.accounts
@ -7349,6 +7357,14 @@ impl Bank {
.map(|(incremental_accounts_hash, _)| incremental_accounts_hash)
}
/// Returns the `SnapshotHash` for this bank's slot
///
/// This fn is used at startup to verify the bank was rebuilt correctly.
///
/// # Panics
///
/// Panics if there is both-or-neither of an `AccountsHash` and an `IncrementalAccountsHash`
/// for this bank's slot. There may only be one or the other.
pub fn get_snapshot_hash(&self) -> SnapshotHash {
let accounts_hash = self.get_accounts_hash();
let incremental_accounts_hash = self.get_incremental_accounts_hash();