feat: Updated handleConsensusRound to return a boolean (#17481)

Signed-off-by: Lazar Petrovic <lpetrovic05@gmail.com>
hashgraph · Jan 23, 2025 · 053a5c1 · 053a5c1
1 parent 829e18c
commit 053a5c1
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 14 deletions.
diff --git a/hedera-node/hedera-app/src/main/java/com/hedera/node/app/state/StateLifecyclesImpl.java b/hedera-node/hedera-app/src/main/java/com/hedera/node/app/state/StateLifecyclesImpl.java
@@ -53,11 +53,12 @@ public void onPreHandle(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull final Round round,
             @NonNull final PlatformMerkleStateRoot state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTxnCallback) {
         hedera.onHandleConsensusRound(round, state, stateSignatureTxnCallback);
+        return true;
     }
 
     @Override

diff --git a/...currencyDemo/src/main/java/com/swirlds/demo/crypto/CryptocurrencyDemoStateLifecycles.java b/...currencyDemo/src/main/java/com/swirlds/demo/crypto/CryptocurrencyDemoStateLifecycles.java
@@ -51,13 +51,14 @@ public void onStateInitialized(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull CryptocurrencyDemoState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
         state.throwIfImmutable();
         round.forEachEventTransaction(
                 (event, transaction) -> handleTransaction(event.getCreatorId(), transaction, state));
+        return true;
     }
 
     /**

diff --git a/.../HelloSwirldDemo/src/main/java/com/swirlds/demo/hello/HelloSwirldDemoStateLifecycles.java b/.../HelloSwirldDemo/src/main/java/com/swirlds/demo/hello/HelloSwirldDemoStateLifecycles.java
@@ -38,12 +38,13 @@
 public class HelloSwirldDemoStateLifecycles implements StateLifecycles<HelloSwirldDemoState> {
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull HelloSwirldDemoState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
         state.throwIfImmutable();
         round.forEachTransaction(v -> handleTransaction(v, state));
+        return true;
     }
 
     private void handleTransaction(final Transaction transaction, HelloSwirldDemoState state) {

diff --git a/...ool/src/main/java/com/swirlds/demo/addressbook/AddressBookTestingToolStateLifecycles.java b/...ool/src/main/java/com/swirlds/demo/addressbook/AddressBookTestingToolStateLifecycles.java
@@ -130,7 +130,7 @@ public void onStateInitialized(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull AddressBookTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -181,6 +181,7 @@ public void onHandleConsensusRound(
                 logger.error(EXCEPTION.getMarker(), "Test scenario {}: validation failed with errors.", testScenario);
             }
         }
+        return true;
     }
 
     /**

diff --git a/...ool/src/main/java/com/swirlds/demo/consistency/ConsistencyTestingToolStateLifecycles.java b/...ool/src/main/java/com/swirlds/demo/consistency/ConsistencyTestingToolStateLifecycles.java
@@ -96,7 +96,7 @@ public void onStateInitialized(
      * Writes the round and its contents to a log on disk
      */
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull ConsistencyTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -115,6 +115,7 @@ public void onHandleConsensusRound(
         }
 
         state.processTransactions(round, stateSignatureTransactionCallback);
+        return true;
     }
 
     /**

diff --git a/...ests/ISSTestingTool/src/main/java/com/swirlds/demo/iss/ISSTestingToolStateLifecycles.java b/...ests/ISSTestingTool/src/main/java/com/swirlds/demo/iss/ISSTestingToolStateLifecycles.java
@@ -103,7 +103,7 @@ private void handleTransaction(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull ISSTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -154,6 +154,7 @@ public void onHandleConsensusRound(
                 }
             }
         }
+        return true;
     }
 
     /**

diff --git a/...estingTool/src/main/java/com/swirlds/demo/migration/MigrationTestToolStateLifecycles.java b/...estingTool/src/main/java/com/swirlds/demo/migration/MigrationTestToolStateLifecycles.java
@@ -88,7 +88,7 @@ public void onStateInitialized(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull MigrationTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -111,6 +111,7 @@ public void onHandleConsensusRound(
                 mTrans.applyTo(state);
             }
         }
+        return true;
     }
 
     @Override

diff --git a/...stingTool/src/main/java/com/swirlds/demo/platform/PlatformTestingToolStateLifecycles.java b/...stingTool/src/main/java/com/swirlds/demo/platform/PlatformTestingToolStateLifecycles.java
@@ -748,7 +748,7 @@ private void preHandleTransaction(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull PlatformTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -760,6 +760,7 @@ public void onHandleConsensusRound(
         updateTransactionCounters(state);
         round.forEachEventTransaction((event, transaction) -> handleConsensusTransaction(
                 event, transaction, round.getRoundNum(), state, stateSignatureTransactionCallback));
+        return true;
     }
 
     /**

diff --git a/.../src/main/java/com/swirlds/demo/stats/signing/StatsSigningTestingToolStateLifecycles.java b/.../src/main/java/com/swirlds/demo/stats/signing/StatsSigningTestingToolStateLifecycles.java
@@ -112,7 +112,7 @@ public void onPreHandle(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull StatsSigningTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -137,6 +137,7 @@ public void onHandleConsensusRound(
                 handleTransaction(transaction, state);
             }
         });
+        return true;
     }
 
     private void handleTransaction(final ConsensusTransaction trans, final StatsSigningTestingToolState state) {

diff --git a/...ssTestingTool/src/main/java/com/swirlds/demo/stress/StressTestingToolStateLifecycles.java b/...ssTestingTool/src/main/java/com/swirlds/demo/stress/StressTestingToolStateLifecycles.java
@@ -90,7 +90,7 @@ private void busyWait(@NonNull final Duration duration) {
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull StressTestingToolState state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -115,6 +115,7 @@ public void onHandleConsensusRound(
                 }
             });
         }
+        return true;
     }
 
     private void handleTransaction(@NonNull final ConsensusTransaction trans, StressTestingToolState state) {

diff --git a/...k/swirlds-platform-core/src/main/java/com/swirlds/platform/state/NoOpStateLifecycles.java b/...k/swirlds-platform-core/src/main/java/com/swirlds/platform/state/NoOpStateLifecycles.java
@@ -45,11 +45,12 @@ public void onPreHandle(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull PlatformMerkleStateRoot state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
         // no-op
+        return true;
     }
 
     @Override

diff --git a/...m-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/state/StateLifecycles.java b/...m-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/state/StateLifecycles.java
@@ -56,8 +56,9 @@ void onPreHandle(
      * @param round the round that has just reached consensus
      * @param state the working state of the network
      * @param stateSignatureTransactionCallback a consumer that will be used for callbacks
+     * @return true if the state should be hashed and signed after this round, false otherwise
      */
-    void onHandleConsensusRound(
+    boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull T state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback);

diff --git a/...platform-core/src/test/java/com/swirlds/platform/turtle/runner/TurtleStateLifecycles.java b/...platform-core/src/test/java/com/swirlds/platform/turtle/runner/TurtleStateLifecycles.java
@@ -46,7 +46,7 @@ public void onPreHandle(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull TurtleTestingToolState turtleTestingToolState,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
@@ -55,6 +55,7 @@ public void onHandleConsensusRound(
                 round.getRoundNum(),
                 round.getConsensusTimestamp().getNano(),
                 round.getConsensusTimestamp().getEpochSecond());
+        return true;
     }
 
     @Override

diff --git a/...e/src/testFixtures/java/com/swirlds/platform/test/fixtures/state/FakeStateLifecycles.java b/...e/src/testFixtures/java/com/swirlds/platform/test/fixtures/state/FakeStateLifecycles.java
@@ -215,11 +215,12 @@ public void onPreHandle(
     }
 
     @Override
-    public void onHandleConsensusRound(
+    public boolean onHandleConsensusRound(
             @NonNull Round round,
             @NonNull PlatformMerkleStateRoot state,
             @NonNull Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransactionCallback) {
         // no-op
+        return true;
     }
 
     @Override