feat: Create a dedicated command for compaction in the State Operator (#21327)

Signed-off-by: Nikita Lebedev <[email protected]>

Author: thenswan

hedera-state-validator/README.md

@@ -32,7 +32,6 @@ of a corrupted state.
 - [`account`](/src/main/java/com/hedera/statevalidation/validators/servicesstate/AccountValidator.java) - Ensures all accounts have a positive balance, calculates the total HBAR supply,
   and verifies it totals exactly 50 billion HBAR.
 - [`tokenRelations`](/src/main/java/com/hedera/statevalidation/validators/servicesstate/TokenRelationsIntegrity.java) - Verifies that the accounts and tokens for every token relationship exist.
-- [`compaction`](/src/main/java/com/hedera/statevalidation/validators/merkledb/Compaction.java) - Not a validation per se, but it allows for the compaction of state files.
 
 ## Introspect
 
@@ -149,6 +148,19 @@ Notes:
 - Order of entries is consistent across runs and ordered by path, unless `-Dsorted=true` is specified.
 - In case of `-Dsorted=true`, the data is sorted by the **byte representation of the key**, which doesn't always map to natural ordering. For example, varint encoding does not preserve numerical ordering under lexicographical byte comparison, particularly when values cross boundaries that affect the number of bytes or the leading byte values. However, it will produce a stable ordering across different versions of the state, which is critically important for differential testing.
 
+## Compact
+
+[CompactionCommand](src/main/java/com/hedera/statevalidation/CompactionCommand.java) allows you to perform compaction of state files.
+
+### Usage
+
+1. Download the state files.
+2. Run the following command to execute the compaction:
+
+   ```shell
+   java -jar ./validator-<version>.jar {path-to-state-round} compact
+   ```
+
 ## Updating State with a Block Stream
 
 The `apply-blocks` command uses a set of block files to advance a given state from the current state to the target state.

hedera-state-validator/src/main/java/com/hedera/statevalidation/CompactionCommand.java

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: Apache-2.0
+package com.hedera.statevalidation;
+
+import static com.hedera.statevalidation.compaction.Compaction.runCompaction;
+
+import com.hedera.statevalidation.parameterresolver.StateResolver;
+import com.swirlds.platform.state.MerkleNodeState;
+import com.swirlds.platform.state.snapshot.DeserializedSignedState;
+import picocli.CommandLine;
+
+@CommandLine.Command(name = "compact", description = "Performs compaction of state files.")
+public class CompactionCommand implements Runnable {
+
+    @CommandLine.ParentCommand
+    private StateOperatorCommand parent;
+
+    private CompactionCommand() {}
+
+    @Override
+    public void run() {
+        System.setProperty("state.dir", parent.getStateDir().getAbsolutePath());
+
+        try {
+            final DeserializedSignedState deserializedSignedState = StateResolver.initState();
+            final MerkleNodeState merkleNodeState =
+                    deserializedSignedState.reservedSignedState().get().getState();
+            runCompaction(merkleNodeState);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+}

hedera-state-validator/src/main/java/com/hedera/statevalidation/StateOperatorCommand.java

@@ -10,7 +10,13 @@
 @CommandLine.Command(
         name = "operator",
         mixinStandardHelpOptions = true,
-        subcommands = {ValidateCommand.class, IntrospectCommand.class, ExportCommand.class, ApplyBlocksCommand.class},
+        subcommands = {
+            ValidateCommand.class,
+            IntrospectCommand.class,
+            ExportCommand.class,
+            CompactionCommand.class,
+            ApplyBlocksCommand.class
+        },
         description = "CLI tool with validation and introspection modes")
 public class StateOperatorCommand implements Runnable {
 
@@ -26,7 +32,7 @@ File getStateDir() {
     @Override
     public void run() {
         // This runs if no subcommand is provided
-        System.out.println("Specify a subcommand (validate/introspect/export/apply-blocks).");
+        System.out.println("Specify a subcommand (validate/introspect/export/compact/apply-blocks).");
         CommandLine.usage(this, System.out);
     }
 

hedera-state-validator/src/main/java/com/hedera/statevalidation/ValidateCommand.java

@@ -37,18 +37,9 @@ public class ValidateCommand implements Callable<Integer> {
     @CommandLine.Parameters(
             arity = "1..*",
             description =
-                    "Tag to run: [stateAnalyzer, internal, leaf, hdhm, account, tokenRelations, rehash, files, compaction, entityIds]")
+                    "Tag to run: [stateAnalyzer, internal, leaf, hdhm, account, tokenRelations, rehash, files, entityIds]")
     private String[] tags = {
-        "stateAnalyzer",
-        "internal",
-        "leaf",
-        "hdhm",
-        "account",
-        "tokenRelations",
-        "rehash",
-        "files",
-        "compaction",
-        "entityIds"
+        "stateAnalyzer", "internal", "leaf", "hdhm", "account", "tokenRelations", "rehash", "files", "entityIds"
     };
 
     @Override

hedera-state-validator/src/main/java/com/hedera/statevalidation/compaction/Compaction.java

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+package com.hedera.statevalidation.compaction;
+
+import static java.util.Objects.requireNonNull;
+
+import com.swirlds.merkledb.MerkleDbDataSource;
+import com.swirlds.platform.state.MerkleNodeState;
+import com.swirlds.virtualmap.VirtualMap;
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+public final class Compaction {
+
+    private Compaction() {}
+
+    public static void runCompaction(@NonNull final MerkleNodeState merkleNodeState) {
+        final VirtualMap virtualMap = (VirtualMap) merkleNodeState.getRoot();
+        requireNonNull(virtualMap);
+        MerkleDbDataSource vds = (MerkleDbDataSource) virtualMap.getDataSource();
+        requireNonNull(vds);
+
+        vds.enableBackgroundCompaction();
+
+        vds.runKeyToPathStoreCompaction();
+        vds.runPathToKeyStoreCompaction();
+        vds.runHashStoreCompaction();
+
+        vds.awaitForCurrentCompactionsToComplete(0);
+    }
+}