nits

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

Author: thenswan

hedera-node/hedera-app/src/main/java/com/hedera/node/app/blocks/impl/BlockStreamManagerImpl.java

@@ -376,7 +376,7 @@ public boolean endRound(@NonNull final State state, final long roundNum) {
         if (closesBlock) {
             lifecycle.onCloseBlock(state);
             if (state instanceof HederaNewStateRoot hederaNewStateRoot) {
-                hederaNewStateRoot.commitAllSingletons();
+                hederaNewStateRoot.commitSingletons();
             }
             // Flush all boundary state changes besides the BlockStreamInfo
             worker.addItem(boundaryStateChangeListener.flushChanges());

hedera-node/hedera-app/src/main/java/com/hedera/node/app/state/ReadonlyQueueStateWrapper.java

@@ -27,6 +27,7 @@ public ReadonlyQueueStateWrapper(@NonNull final WritableQueueState<E> delegate)
         this.delegate = requireNonNull(delegate, "delegate must not be null");
     }
 
+    @NonNull
     @Override
     public String getServiceName() {
         return delegate.getServiceName();

hedera-node/hedera-app/src/main/java/com/hedera/node/app/state/ReadonlySingletonStateWrapper.java

@@ -27,6 +27,7 @@ public ReadonlySingletonStateWrapper(@NonNull final WritableSingletonState<T> de
         this.delegate = requireNonNull(delegate, "delegate must not be null");
     }
 
+    @NonNull
     @Override
     public String getServiceName() {
         return delegate.getServiceName();

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/stack/WritableKVStateStack.java

@@ -59,6 +59,7 @@ private WritableKVState<K, V> getCurrent() {
      * {@inheritDoc}
      */
     @Override
+    @NonNull
     public String getServiceName() {
         return serviceName;
     }

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/stack/WritableQueueStateStack.java

@@ -56,6 +56,7 @@ private WritableQueueState<E> getCurrent() {
         return writableStatesStack.getCurrent().getQueue(stateKey);
     }
 
+    @NonNull
     @Override
     public String getServiceName() {
         return serviceName;

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/stack/WritableSingletonStateStack.java

@@ -54,6 +54,7 @@ private WritableSingletonState<T> getCurrent() {
     }
 
     @Override
+    @NonNull
     public String getServiceName() {
         return serviceName;
     }

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/standalone/TransactionExecutors.java

@@ -331,5 +331,5 @@ public List<OperationTracer> get() {
         }
     }
 
-    static final Metrics NO_OP_METRICS = new NoOpMetrics();
+    private static final Metrics NO_OP_METRICS = new NoOpMetrics();
 }

hedera-node/hedera-app/src/test/java/com/hedera/node/app/workflows/handle/stack/SavepointStackImplTest.java

@@ -25,7 +25,7 @@
 import com.hedera.node.config.data.BlockStreamConfig;
 import com.hedera.node.config.testfixtures.HederaTestConfigBuilder;
 import com.hedera.node.config.types.StreamMode;
-import com.swirlds.platform.state.MerkleNodeState;
+import com.swirlds.state.State;
 import com.swirlds.state.spi.ReadableStates;
 import com.swirlds.state.test.fixtures.MapWritableKVState;
 import com.swirlds.state.test.fixtures.MapWritableStates;
@@ -60,7 +60,7 @@ class SavepointStackImplTest extends StateTestBase {
             G_KEY, GRAPE);
 
     @Mock(strictness = LENIENT)
-    private MerkleNodeState baseState;
+    private State baseState;
 
     @Mock
     private SavepointStackImpl parent;

platform-sdk/platform-apps/tests/ConsistencyTestingTool/src/main/java/com/swirlds/demo/consistency/ConsistencyTestingToolState.java

@@ -266,7 +266,7 @@ protected ConsistencyTestingToolState copyingConstructor() {
     }
 
     @Override
-    public MerkleNode migrate(@NonNull Configuration configuration, int version) {
+    public MerkleNode migrate(@NonNull final Configuration configuration, int version) {
         return this;
     }
 }

platform-sdk/platform-apps/tests/MigrationTestingTool/src/main/java/com/swirlds/demo/migration/MigrationTestingToolState.java

@@ -117,7 +117,7 @@ public boolean childHasExpectedType(final int index, final long childClassId) {
     }
 
     @Override
-    public MerkleNode migrate(@NonNull Configuration configuration, int version) {
+    public MerkleNode migrate(@NonNull final Configuration configuration, int version) {
         if (version == ClassVersion.VIRTUAL_MAP) {
             TestingAppStateInitializer.DEFAULT.initRosterState(this);
             return this;

platform-sdk/swirlds-benchmarks/src/jmh/java/com/swirlds/benchmark/reconnect/BenchmarkMerkleInternal.java

@@ -120,7 +120,7 @@ public BenchmarkMerkleInternal copy() {
      * in position 0, and that leaf will equal this node.
      */
     @Override
-    public MerkleNode migrate(@NonNull Configuration configuration, final int version) {
+    public MerkleNode migrate(@NonNull final Configuration configuration, final int version) {
         return migrationMapper.apply(this, version);
     }
 }

platform-sdk/swirlds-common/src/testFixtures/java/com/swirlds/common/test/fixtures/merkle/dummy/DummyMerkleInternal.java

@@ -149,7 +149,7 @@ public DummyMerkleInternal copy() {
      * in position 0, and that leaf will equal this node.
      */
     @Override
-    public MerkleNode migrate(@NonNull Configuration configuration, final int version) {
+    public MerkleNode migrate(@NonNull final Configuration configuration, final int version) {
         return migrationMapper.apply(this, version);
     }
 }

platform-sdk/swirlds-common/src/testFixtures/java/com/swirlds/common/test/fixtures/merkle/dummy/DummyMerkleLeaf.java

@@ -188,7 +188,7 @@ public boolean equals(final Object obj) {
      * in position 0, and that leaf will equal this node.
      */
     @Override
-    public MerkleNode migrate(@NonNull Configuration configuration, final int version) {
+    public MerkleNode migrate(@NonNull final Configuration configuration, final int version) {
         return migrationMapper.apply(this, version);
     }
 }

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/StateInitializer.java

@@ -106,11 +106,13 @@ public static void initializeState(
      * to {@code MerkleNodeState}.
      * </p>
      *
+     * @deprecated This method should be removed together with {@code MerkleStateRoot}. Only state root function should be used then.
      * @param stateRootFunction a function to instantiate the state root object from a Virtual Map
      * @param stateRoot         the root of the state to initialize
      * @param metrics           the metrics
      * @return the initialized {@code MerkleNodeState}
      */
+    @Deprecated
     public static MerkleNodeState initializeMerkleNodeState(
             @NonNull final Function<VirtualMap, MerkleNodeState> stateRootFunction,
             @NonNull final MerkleNode stateRoot,

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/state/MerkleNodeState.java

@@ -52,7 +52,7 @@ default void initializeState(@NonNull final StateMetadata<?, ?> md) {
      * MUST have a correct label applied. If the node is already present, then this method does nothing
      * else.
      *
-     * @deprecated This method is only required for the MerkleStateRoot class and will be removed together with that class.
+     * @deprecated This method is only required for the {@code MerkleStateRoot} class and will be removed together with that class.
      * @param md The metadata associated with the state
      * @param nodeSupplier Returns the node to add. Cannot be null. Can be used to create the node on-the-fly.
      * @throws IllegalArgumentException if the node is neither a merkle map nor virtual map, or if
@@ -70,7 +70,7 @@ default void putServiceStateIfAbsent(
      * MUST have a correct label applied. No matter if the resulting node is newly created or already
      * present, calls the provided initialization consumer with the node.
      *
-     * @deprecated This method is only required for the MerkleStateRoot class and will be removed together with that class.
+     * @deprecated This method is only required for the {@code MerkleStateRoot} class and will be removed together with that class.
      * @param md The metadata associated with the state
      * @param nodeSupplier Returns the node to add. Cannot be null. Can be used to create the node on-the-fly.
      * @param nodeInitializer The node's initialization logic.

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/reconnect/DefaultSignedStateValidatorTests.java

@@ -334,7 +334,7 @@ private SignedState stateSignedByNodes(final List<Node> signingNodes) {
         };
 
         return new RandomSignedStateGenerator()
-                .setState(new TestMerkleStateRoot())
+                .setState(new TestMerkleStateRoot()) // FUTURE WORK: remove this line to use TestNewMerkleStateRoot
                 .setRound(ROUND)
                 .setRoster(roster)
                 .setStateHash(stateHash)

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/reconnect/ReconnectTest.java

@@ -117,7 +117,7 @@ private void executeReconnect(final ReconnectMetrics reconnectMetrics) throws In
                     .setRoster(roster)
                     .setSigningNodeIds(nodeIds)
                     .setCalculateHash(true)
-                    .setState(new TestMerkleStateRoot())
+                    .setState(new TestMerkleStateRoot()) // FUTURE WORK: remove this line to use TestNewMerkleStateRoot
                     .buildWithFacade();
             final SignedState signedState = signedStateFacadePair.left();
             final PlatformStateFacade platformStateFacade = signedStateFacadePair.right();

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/state/StateSigningTests.java

@@ -367,7 +367,7 @@ void allSignaturesBecomeInvalidTest(final boolean evenWeighting) {
                 .setCalculateHash(true)
                 .setSignatures(new HashMap<>())
                 .setCalculateHash(true)
-                .setState(new TestMerkleStateRoot())
+                .setState(new TestMerkleStateRoot()) // FUTURE WORK: remove this line to use TestNewMerkleStateRoot
                 .build();
 
         final SigSet sigSet = signedState.getSigSet();

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/state/manager/AddIncompleteStateTest.java

@@ -106,7 +106,7 @@ void addIncompleteStateTest() {
                 .setRoster(roster)
                 .setRound(firstRound)
                 .setSignatures(signatures)
-                .setState(new TestMerkleStateRoot())
+                .setState(new TestMerkleStateRoot()) // FUTURE WORK: remove this line to use TestNewMerkleStateRoot
                 .build();
 
         // This is intentionally a different hash than the signed hash!

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/state/manager/OldCompleteStateEventuallyReleasedTest.java

@@ -99,7 +99,7 @@ void oldCompleteStateEventuallyReleased() throws InterruptedException {
                 .setRoster(roster)
                 .setRound(0)
                 .setSignatures(signatures)
-                .setState(new TestMerkleStateRoot())
+                .setState(new TestMerkleStateRoot()) // FUTURE WORK: remove this line to use TestNewMerkleStateRoot
                 .build();
         stateFromDisk.getState().setHash(stateHash);
 

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/state/manager/SequentialSignaturesRestartTest.java

@@ -110,7 +110,7 @@ void sequentialSignaturesAfterRestartTest() throws InterruptedException {
                 .setRound(firstRound)
                 .setSignatures(signatures)
                 .setCalculateHash(true)
-                .setState(new TestMerkleStateRoot())
+                .setState(new TestMerkleStateRoot()) // FUTURE WORK: remove this line to use TestNewMerkleStateRoot
                 .build();
         stateFromDisk.getState().setHash(stateHash);
 

platform-sdk/swirlds-platform-core/src/testFixtures/java/com/swirlds/platform/test/fixtures/state/RandomSignedStateGenerator.java

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 package com.swirlds.platform.test.fixtures.state;
 
-import static com.swirlds.platform.state.service.schemas.V0540PlatformStateSchema.PLATFORM_STATE_KEY;
 import static com.swirlds.platform.test.fixtures.state.TestingAppStateInitializer.CONFIGURATION;
 import static com.swirlds.platform.test.fixtures.state.TestingAppStateInitializer.registerMerkleStateRootClassIds;
 import static org.hiero.base.crypto.test.fixtures.CryptoRandomUtils.randomHash;
@@ -28,12 +27,10 @@
 import com.swirlds.platform.config.StateConfig;
 import com.swirlds.platform.crypto.SignatureVerifier;
 import com.swirlds.platform.state.MerkleNodeState;
-import com.swirlds.platform.state.service.PlatformStateService;
 import com.swirlds.platform.state.signed.SignedState;
 import com.swirlds.platform.test.fixtures.addressbook.RandomRosterBuilder;
 import com.swirlds.platform.test.fixtures.state.manager.SignatureVerificationTestUtils;
 import com.swirlds.state.merkle.MerkleStateRoot;
-import com.swirlds.state.spi.WritableSingletonStateBase;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.time.Instant;
 import java.util.ArrayList;
@@ -222,11 +219,6 @@ public Pair<SignedState, TestPlatformStateFacade> buildWithFacade() {
             v.setConsensusTimestamp(consensusTimestampInstance);
         });
 
-        ((WritableSingletonStateBase<?>) stateInstance
-                        .getWritableStates(PlatformStateService.NAME)
-                        .getSingleton(PLATFORM_STATE_KEY))
-                .commit();
-
         TestingAppStateInitializer.DEFAULT.initRosterState(stateInstance);
         RosterUtils.setActiveRoster(stateInstance, rosterInstance, roundInstance);
 

platform-sdk/swirlds-platform-core/src/testFixtures/java/com/swirlds/platform/test/fixtures/state/SignedStateUtils.java

@@ -16,10 +16,9 @@ public static SignedState randomSignedState(long seed) {
         return randomSignedState(new Random(seed));
     }
 
-    // FUTURE WORK: use TestNewMerkleStateRoot
     public static SignedState randomSignedState(Random random) {
         TestPlatformStateFacade platformStateFacade = new TestPlatformStateFacade();
-        MerkleNodeState root = new TestMerkleStateRoot();
+        MerkleNodeState root = new TestMerkleStateRoot(); // FUTURE WORK: use TestNewMerkleStateRoot
         TestingAppStateInitializer.DEFAULT.initPlatformState(root);
         randomPlatformState(random, root, platformStateFacade);
         boolean shouldSaveToDisk = random.nextBoolean();

platform-sdk/swirlds-platform-core/src/testFixtures/java/com/swirlds/platform/test/fixtures/state/TestingAppStateInitializer.java

@@ -213,8 +213,8 @@ public List<Builder> initRosterState(@NonNull final MerkleNodeState state) {
     private static void initializeServiceState(
             MerkleNodeState state, StateMetadata<?, ?> md, Supplier<? extends MerkleNode> nodeSupplier) {
         switch (state) {
-            case MerkleStateRoot<?> merkle -> state.putServiceStateIfAbsent(md, nodeSupplier);
-            case NewStateRoot<?> newRoot -> state.initializeState(md);
+            case MerkleStateRoot<?> ignored -> state.putServiceStateIfAbsent(md, nodeSupplier);
+            case NewStateRoot<?> ignored -> state.initializeState(md);
             default ->
                 throw new IllegalStateException(
                         "Expecting MerkleStateRoot or NewStateRoot instance to be used for state initialization");

platform-sdk/swirlds-state-api/src/main/java/com/swirlds/state/spi/ReadableKVStateBase.java

@@ -54,7 +54,7 @@ protected ReadableKVStateBase(@NonNull final String serviceName, @NonNull final
      */
     // This constructor is used by some consumers of the API that are outside of this repository.
     protected ReadableKVStateBase(
-            @NonNull final String serviceName, @NonNull String stateKey, @NonNull ConcurrentMap<K, V> readCache) {
+            @NonNull final String serviceName, @NonNull final String stateKey, @NonNull ConcurrentMap<K, V> readCache) {
         this.serviceName = Objects.requireNonNull(serviceName);
         this.stateKey = Objects.requireNonNull(stateKey);
         this.readCache = Objects.requireNonNull(readCache);

platform-sdk/swirlds-state-api/src/main/java/com/swirlds/state/spi/ReadableState.java

@@ -14,6 +14,7 @@ public interface ReadableState {
      * @return The name of the service. This will never be null, and will always be the same value for an
      *     instance of {@link ReadableState}.
      */
+    @NonNull
     String getServiceName();
 
     /**

platform-sdk/swirlds-state-impl/src/main/java/com/swirlds/state/merkle/MerkleStateRoot.java

@@ -903,23 +903,6 @@ private static String extractStateKey(@NonNull final StateMetadata<?, ?> md) {
         return md.stateDefinition().stateKey();
     }
 
-    /**
-     * Commit all singleton states for every registered service.
-     */
-    public void commitSingletons() {
-        for (String serviceKey : services.keySet()) {
-            final var service = services.get(serviceKey);
-            for (String stateKey : service.keySet()) {
-                StateMetadata<?, ?> stateMetadata = service.get(stateKey);
-                if (stateMetadata.stateDefinition().singleton()) {
-                    WritableStates writableStates = getWritableStates(serviceKey);
-                    final var writableSingleton = (WritableSingletonStateBase<?>) writableStates.getSingleton(stateKey);
-                    writableSingleton.commit();
-                }
-            }
-        }
-    }
-
     /**
      * {@inheritDoc}
      */

platform-sdk/swirlds-state-impl/src/main/java/com/swirlds/state/merkle/NewStateRoot.java

@@ -795,7 +795,10 @@ public void mapDeleteChange(@NonNull final K key) {
         }
     }
 
-    public void commitAllSingletons() {
+    /**
+     * Commit all singleton states for every registered service.
+     */
+    public void commitSingletons() {
         for (String serviceKey : services.keySet()) {
             final var service = services.get(serviceKey);
             for (String stateKey : service.keySet()) {
@@ -809,6 +812,9 @@ public void commitAllSingletons() {
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public boolean isHashed() {
         return virtualMap.isHashed();

platform-sdk/swirlds-virtualmap/src/main/java/com/swirlds/virtualmap/VirtualMap.java

@@ -1606,7 +1606,7 @@ public VirtualMap copy() {
     }
 
     @Override
-    public MerkleNode migrate(@NonNull Configuration configuration, int version) {
+    public MerkleNode migrate(@NonNull final Configuration configuration, int version) {
         if (version < ClassVersion.NO_VIRTUAL_ROOT_NODE) {
             // removing VirtualMapState
             super.setChild(0, null);