Skip to content

Commit

Permalink
docs(archival_state): Clarify that store_block doesn't write to DB
Browse files Browse the repository at this point in the history
  • Loading branch information
Sword-Smith committed Jan 22, 2025
1 parent 315ec44 commit 144af4f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/models/state/archival_state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,9 @@ impl ArchivalState {
&self.genesis_block
}

/// Write a block to database and disk, without setting it as tip.
/// Write a block disk, without setting it as tip. The returned (key, value)
/// pairs must be stored to the block-index database for this block to be
/// retrievable.
///
/// The caller should verify that the block is not already stored, otherwise
/// the block will be stored twice which will lead to inconsistencies.
Expand Down

0 comments on commit 144af4f

Please sign in to comment.