refactor: adapt StatsSigningTestingTool to work with Bytes wrapper for transactions

platform-sdk/platform-apps/tests/StatsSigningTestingTool/build.gradle.kts

@@ -1,8 +1,30 @@
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright (C) 2024-2025 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 plugins { id("org.hiero.gradle.module.application") }
 
 // Remove the following line to enable all 'javac' lint checks that we have turned on by default
 // and then fix the reported issues.
 tasks.withType<JavaCompile>().configureEach { options.compilerArgs.add("-Xlint:-cast") }
 
 application.mainClass = "com.swirlds.demo.stats.signing.StatsSigningTestingToolMain"
+
+testModuleInfo {
+    requires("org.assertj.core")
+    requires("org.junit.jupiter.api")
+    requires("org.mockito")
+    requires("org.junit.jupiter.params")
+}

platform-sdk/platform-apps/tests/StatsSigningTestingTool/src/main/java/com/swirlds/demo/stats/signing/StatsSigningTestingToolMain.java

@@ -34,6 +34,8 @@
 import static com.swirlds.platform.test.fixtures.state.FakeStateLifecycles.FAKE_MERKLE_STATE_LIFECYCLES;
 import static com.swirlds.platform.test.fixtures.state.FakeStateLifecycles.registerMerkleStateRootClassIds;
 
+import com.hedera.hapi.platform.event.StateSignatureTransaction;
+import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.common.constructable.ClassConstructorPair;
 import com.swirlds.common.constructable.ConstructableRegistry;
 import com.swirlds.common.constructable.ConstructableRegistryException;
@@ -52,6 +54,7 @@
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.SwirldMain;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.nio.ByteBuffer;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -63,23 +66,25 @@
 public class StatsSigningTestingToolMain implements SwirldMain {
     // the first four come from the parameters in the config.txt file
 
+    public static final String STATE_SIGNATURE_MARKER = "STATE_SIGNATURE_MARKER";
     private static final Logger logger = LogManager.getLogger(StatsSigningTestingToolMain.class);
 
     static {
         try {
             logger.info(STARTUP.getMarker(), "Registering StatsSigningTestingToolState with ConstructableRegistry");
-            ConstructableRegistry constructableRegistry = ConstructableRegistry.getInstance();
+            final ConstructableRegistry constructableRegistry = ConstructableRegistry.getInstance();
             constructableRegistry.registerConstructable(
                     new ClassConstructorPair(StatsSigningTestingToolState.class, () -> {
-                        StatsSigningTestingToolState statsSigningTestingToolState = new StatsSigningTestingToolState(
-                                FAKE_MERKLE_STATE_LIFECYCLES,
-                                version -> new BasicSoftwareVersion(version.major()),
-                                () -> null);
+                        final StatsSigningTestingToolState statsSigningTestingToolState =
+                                new StatsSigningTestingToolState(
+                                        FAKE_MERKLE_STATE_LIFECYCLES,
+                                        version -> new BasicSoftwareVersion(version.major()),
+                                        () -> null);
                         return statsSigningTestingToolState;
                     }));
             registerMerkleStateRootClassIds();
             logger.info(STARTUP.getMarker(), "StatsSigningTestingToolState is registered with ConstructableRegistry");
-        } catch (ConstructableRegistryException e) {
+        } catch (final ConstructableRegistryException e) {
             logger.error(STARTUP.getMarker(), "Failed to register StatsSigningTestingToolState", e);
             throw new RuntimeException(e);
         }
@@ -257,7 +262,7 @@
 
         if (transPerSecToCreate > -1) { // if not unlimited (-1 means unlimited)
             // ramp up the TPS to the expected value
-            long elapsedTime = now / MILLISECONDS_TO_NANOSECONDS - rampUpStartTimeMilliSeconds;
+            final long elapsedTime = now / MILLISECONDS_TO_NANOSECONDS - rampUpStartTimeMilliSeconds;
             double rampUpTPS = 0;
             if (elapsedTime < TPS_RAMP_UP_WINDOW_MILLISECONDS) {
                 rampUpTPS = expectedTPS * elapsedTime / ((double) (TPS_RAMP_UP_WINDOW_MILLISECONDS));
@@ -313,4 +318,21 @@
     public BasicSoftwareVersion getSoftwareVersion() {
         return softwareVersion;
     }
+
+    @Override
+    @NonNull
+    public Bytes encodeSystemTransaction(@NonNull final StateSignatureTransaction transaction) {
+        final String stateSignatureMarker = STATE_SIGNATURE_MARKER;
+        final int markerSize = stateSignatureMarker.length();
+        final byte[] parsedStateSignatureTransaction =
+                StateSignatureTransaction.PROTOBUF.toBytes(transaction).toByteArray();
+        final int bufferCapacity = Integer.BYTES + markerSize + parsedStateSignatureTransaction.length;
+
+        final ByteBuffer buffer = ByteBuffer.allocate(bufferCapacity);
+        buffer.putInt(markerSize);
+        buffer.put(stateSignatureMarker.getBytes());
+        buffer.put(parsedStateSignatureTransaction);
+
+        return Bytes.wrap(buffer.array());
+    }
 }

platform-sdk/platform-apps/tests/StatsSigningTestingTool/src/main/java/com/swirlds/demo/stats/signing/StatsSigningTestingToolState.java

@@ -32,6 +32,8 @@
 
 import com.hedera.hapi.node.base.SemanticVersion;
 import com.hedera.hapi.platform.event.StateSignatureTransaction;
+import com.hedera.pbj.runtime.ParseException;
+import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.common.constructable.ConstructableIgnored;
 import com.swirlds.common.crypto.CryptographyHolder;
 import com.swirlds.common.crypto.TransactionSignature;
@@ -46,6 +48,7 @@
 import com.swirlds.platform.system.transaction.ConsensusTransaction;
 import com.swirlds.platform.system.transaction.Transaction;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.nio.ByteBuffer;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
@@ -115,13 +118,29 @@
     @Override
     public void preHandle(
             @NonNull final Event event,
-            @NonNull final Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransaction) {
+            @NonNull
+                    final Consumer<ScopedSystemTransaction<StateSignatureTransaction>>
+                            stateSignatureTransactionCallback) {
         final SttTransactionPool sttTransactionPool = transactionPoolSupplier.get();
         if (sttTransactionPool != null) {
             event.forEachTransaction(transaction -> {
+                // We are not interested in pre-handling any system transactions, as they are
+                // specific for the platform only.We also don't want to consume deprecated
+                // EventTransaction.STATE_SIGNATURE_TRANSACTION system transactions in the
+                // callback,since it's intended to be used only for the new form of encoded system
+                // transactions in Bytes.Thus, we can directly skip the current
+                // iteration, if it processes a deprecated system transaction with the
+                // EventTransaction.STATE_SIGNATURE_TRANSACTION type.
                 if (transaction.isSystem()) {
                     return;
                 }
+
+                // We should consume in the callback the new form of system transactions in Bytes
+                if (areTransactionBytesSystemOnes(transaction)) {
+                    consumeSystemTransaction(transaction, event, stateSignatureTransactionCallback);
+                    return;
+                }
+
                 final TransactionSignature transactionSignature =
                         sttTransactionPool.expandSignatures(transaction.getApplicationTransaction());
                 if (transactionSignature != null) {
@@ -139,15 +158,33 @@
     public void handleConsensusRound(
             @NonNull final Round round,
             @NonNull final PlatformStateModifier platformState,
-            @NonNull final Consumer<ScopedSystemTransaction<StateSignatureTransaction>> stateSignatureTransaction) {
+            @NonNull
+                    final Consumer<ScopedSystemTransaction<StateSignatureTransaction>>
+                            stateSignatureTransactionCallback) {
         throwIfImmutable();
-        round.forEachTransaction(this::handleTransaction);
+
+        round.forEachEventTransaction((event, transaction) -> {
+            // We are not interested in handling any system transactions, as they are
+            // specific for the platform only.We also don't want to consume deprecated
+            // EventTransaction.STATE_SIGNATURE_TRANSACTION system transactions in the
+            // callback,since it's intended to be used only for the new form of encoded system
+            // transactions in Bytes.Thus, we can directly skip the current
+            // iteration, if it processes a deprecated system transaction with the
+            // EventTransaction.STATE_SIGNATURE_TRANSACTION type.
+            if (transaction.isSystem()) {
+                return;
+            }
+
+            // We should consume in the callback the new form of system transactions in Bytes
+            if (areTransactionBytesSystemOnes(transaction)) {
+                consumeSystemTransaction(transaction, event, stateSignatureTransactionCallback);
+            } else {
+                handleTransaction(transaction);
+            }
+        });
     }
 
     private void handleTransaction(final ConsensusTransaction trans) {
-        if (trans.isSystem()) {
-            return;
-        }
         final TransactionSignature s = trans.getMetadata();
 
         if (s != null && validateSignature(s, trans) && s.getSignatureStatus() != VerificationStatus.VALID) {
@@ -175,6 +212,62 @@
         maybeDelay();
     }
 
+    /**
+     * Checks if the transaction bytes are system ones.
+     *
+     * @param transaction the transaction to check
+     * @return true if the transaction bytes are system ones, false otherwise
+     */
+    private boolean areTransactionBytesSystemOnes(@NonNull final Transaction transaction) {
+        final var transactionBytes = transaction.getApplicationTransaction();
+
+        if (transactionBytes.length() == 0) {
+            return false;
+        }
+
+        final ByteBuffer wrapper = ByteBuffer.wrap(transactionBytes.toByteArray());
+        final var markerSize = wrapper.getInt();
+
+        final var marker = new byte[markerSize];
+        wrapper.get(marker);
+
+        return StatsSigningTestingToolMain.STATE_SIGNATURE_MARKER.equals(new String(marker));
+    }
+
+    private void consumeSystemTransaction(
+            @NonNull final Transaction transaction,
+            @NonNull final Event event,
+            @NonNull
+                    final Consumer<ScopedSystemTransaction<StateSignatureTransaction>>
+                            stateSignatureTransactionCallback) {
+        try {
+            final var stateSignatureTransaction = StateSignatureTransaction.PROTOBUF.parse(
+                    stripSystemTransactionBytes(transaction.getApplicationTransaction()));
+            stateSignatureTransactionCallback.accept(new ScopedSystemTransaction<>(
+                    event.getCreatorId(), event.getSoftwareVersion(), stateSignatureTransaction));
+        } catch (final ParseException e) {
+            logger.error("Failed to parse StateSignatureTransaction", e);
+        }
+    }
+
+    private Bytes stripSystemTransactionBytes(final Bytes transactionBytes) {
+        final byte[] transactionBytesArray = transactionBytes.toByteArray();
+        final ByteBuffer wrapper = ByteBuffer.wrap(transactionBytesArray);
+        final int transactionSize = transactionBytesArray.length;
+
+        // Get the size of the marker string
+        final int markerSize = wrapper.getInt();
+
+        // Get the marker itself
+        final var marker = new byte[markerSize];
+        wrapper.get(marker);
+
+        // Get the StateSignatureTransaction we are interested in
+        final var stateSignatureTransaction = new byte[transactionSize - (markerSize + Integer.BYTES)];
+        wrapper.get(stateSignatureTransaction);
+        return Bytes.wrap(stateSignatureTransaction);
+    }
+
     private void maybeDelay() {
         if (SYNTHETIC_HANDLE_TIME) {
             final long start = System.nanoTime();

platform-sdk/platform-apps/tests/StatsSigningTestingTool/src/main/java/com/swirlds/demo/stats/signing/SttTransactionPool.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2025 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -212,4 +212,8 @@
             }
         }
     }
+
+    public int getTransactionSize() {
+        return transactionSize;
+    }
 }