Skip to content

Commit

Permalink
Fix some documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
acoglio committed Dec 8, 2023
1 parent b7c5f49 commit 8a99c17
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion ledger/narwhal/batch-header/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ pub struct BatchHeader<N: Network> {
/// TODO (howardwu): For mainnet - Remove this version from the struct, we only use it here for backwards compatibility.
/// NOTE: You must keep the version encoding in the byte serialization, just remove it from the struct in memory.
version: u8,
/// The batch ID, defined as the hash of the round number, timestamp, transmission IDs, and previous batch certificate IDs.
/// The batch ID, defined as the hash of the version, author, round number, timestamp, transmission IDs,
/// previous batch certificate IDs, and last election certificate IDs (the latter only if the version is not 1,
/// for pre-mainnet backward compatibility.
batch_id: Field<N>,
/// The author of the batch.
author: Address<N>,
Expand Down

0 comments on commit 8a99c17

Please sign in to comment.