From 8a99c17ea0f912c9b43371ede27bffb840047b33 Mon Sep 17 00:00:00 2001 From: Alessandro Coglio Date: Fri, 8 Dec 2023 15:23:09 -0800 Subject: [PATCH] Fix some documentation. --- ledger/narwhal/batch-header/src/lib.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ledger/narwhal/batch-header/src/lib.rs b/ledger/narwhal/batch-header/src/lib.rs index 03465d1eab..1d833fca7a 100644 --- a/ledger/narwhal/batch-header/src/lib.rs +++ b/ledger/narwhal/batch-header/src/lib.rs @@ -35,7 +35,9 @@ pub struct BatchHeader { /// 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, /// The author of the batch. author: Address,