GH-1523 GH-1631 Transition from dpos to hotstuff

Add comment to schedule_lib_num. Do not want to rename as to not break clients that expect schedule_lib_num name.
AntelopeIO · Sep 14, 2023 · 718e17d · 718e17d
1 parent bf3b284
commit 718e17d
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/libraries/chain/include/eosio/chain/block_header_state.hpp b/libraries/chain/include/eosio/chain/block_header_state.hpp
@@ -67,7 +67,10 @@ namespace detail {
    };
 
    struct schedule_info {
-      uint32_t                          schedule_lib_num = 0; /// last irr block num
+      // schedule_lib_num is compared with dpos lib, but the value is actually current block at time of pending
+      // After hotstuff is activated, schedule_lib_num is compared to next().next() round for determination of
+      // changing from pending to active.
+      uint32_t                          schedule_lib_num = 0; /// block_num of pending
       digest_type                       schedule_hash;
       producer_authority_schedule       schedule;
    };
@@ -133,7 +136,7 @@ struct pending_block_header_state : public detail::block_header_state_common {
  *        block_header.new_producers                      = producers
  *
  *     create_block_state ->
- *        block_state.schedule_lib_num          = current_block_num
+ *        block_state.schedule_lib_num          = current_block_num (note this should be named schedule_block_num)
  *        block_state.pending_schedule.schedule = producers
  *
  *     start_block ->