refactor: 15413 Split PlatformStateAccessor into two interfaces (#1…

…5544)

Signed-off-by: Ivan Malygin <ivan@swirldslabs.com>

platform-sdk/platform-apps/demos/CryptocurrencyDemo/src/main/java/com/swirlds/demo/crypto/CryptocurrencyDemoState.java

@@ -33,7 +33,7 @@
 import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
 import com.swirlds.common.platform.NodeId;
 import com.swirlds.platform.SwirldsPlatform;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -200,7 +200,7 @@ public synchronized CryptocurrencyDemoState copy() {
     }
 
     @Override
-    public void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         round.forEachEventTransaction((event, transaction) -> handleTransaction(event.getCreatorId(), transaction));
     }

platform-sdk/platform-apps/demos/HelloSwirldDemo/src/main/java/com/swirlds/demo/hello/HelloSwirldDemoState.java

@@ -30,7 +30,7 @@
 import com.swirlds.common.io.streams.SerializableDataOutputStream;
 import com.swirlds.common.merkle.MerkleLeaf;
 import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.Round;
 import com.swirlds.platform.system.SwirldState;
 import com.swirlds.platform.system.transaction.Transaction;
@@ -99,7 +99,7 @@ private HelloSwirldDemoState(final HelloSwirldDemoState sourceState) {
     }
 
     @Override
-    public synchronized void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public synchronized void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         round.forEachTransaction(this::handleTransaction);
     }

platform-sdk/platform-apps/demos/StatsDemo/src/main/java/com/swirlds/demo/stats/StatsDemoState.java

@@ -30,7 +30,7 @@
 import com.swirlds.common.io.streams.SerializableDataOutputStream;
 import com.swirlds.common.merkle.MerkleLeaf;
 import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.Round;
 import com.swirlds.platform.system.SwirldState;
 
@@ -69,7 +69,7 @@ private StatsDemoState(final StatsDemoState sourceState) {
     }
 
     @Override
-    public void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {}
+    public void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {}
 
     /**
      * {@inheritDoc}

platform-sdk/platform-apps/tests/AddressBookTestingTool/src/main/java/com/swirlds/demo/addressbook/AddressBookTestingToolState.java

@@ -45,6 +45,7 @@
 import com.swirlds.common.utility.StackTrace;
 import com.swirlds.platform.config.AddressBookConfig;
 import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -182,7 +183,7 @@ public void init(
      * {@inheritDoc}
      */
     @Override
-    public void handleConsensusRound(@NonNull final Round round, @NonNull final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(@NonNull final Round round, @NonNull final PlatformStateModifier platformState) {
         Objects.requireNonNull(round, "the round cannot be null");
         Objects.requireNonNull(platformState, "the platform state cannot be null");
         throwIfImmutable();

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

@@ -27,6 +27,7 @@
 import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
 import com.swirlds.common.utility.NonCryptographicHashing;
 import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -249,7 +250,7 @@ public void preHandle(@NonNull final Event event) {
      * Writes the round and its contents to a log on disk
      */
     @Override
-    public void handleConsensusRound(final @NonNull Round round, final @NonNull PlatformStateAccessor platformState) {
+    public void handleConsensusRound(final @NonNull Round round, final @NonNull PlatformStateModifier platformState) {
         Objects.requireNonNull(round);
         Objects.requireNonNull(platformState);
 

platform-sdk/platform-apps/tests/ISSTestingTool/src/main/java/com/swirlds/demo/iss/ISSTestingToolState.java

@@ -40,7 +40,7 @@
 import com.swirlds.common.platform.NodeId;
 import com.swirlds.common.utility.ByteUtils;
 import com.swirlds.platform.scratchpad.Scratchpad;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -172,7 +172,7 @@ public void init(
      * {@inheritDoc}
      */
     @Override
-    public void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         final Iterator<ConsensusEvent> eventIterator = round.iterator();
 

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

@@ -32,7 +32,7 @@
 import com.swirlds.merkledb.MerkleDb;
 import com.swirlds.merkledb.MerkleDbDataSourceBuilder;
 import com.swirlds.merkledb.MerkleDbTableConfig;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -249,7 +249,7 @@ public void init(
      * {@inheritDoc}
      */
     @Override
-    public void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         for (final Iterator<ConsensusEvent> eventIt = round.iterator(); eventIt.hasNext(); ) {
             final ConsensusEvent event = eventIt.next();

platform-sdk/platform-apps/tests/PlatformTestingTool/src/main/java/com/swirlds/demo/platform/PlatformTestingToolState.java

@@ -83,7 +83,7 @@
 import com.swirlds.merkle.test.fixtures.map.pta.MapKey;
 import com.swirlds.platform.ParameterProvider;
 import com.swirlds.platform.Utilities;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -1071,7 +1071,7 @@ private void handleControlTransaction(
      * Handle the freeze transaction type.
      */
     private void handleFreezeTransaction(
-            final TestTransaction testTransaction, final PlatformStateAccessor platformState) {
+            final TestTransaction testTransaction, final PlatformStateModifier platformState) {
         final FreezeTransaction freezeTx = testTransaction.getFreezeTransaction();
         FreezeTransactionHandler.freeze(freezeTx, platformState);
     }
@@ -1093,7 +1093,7 @@ protected void preHandleTransaction(final Transaction transaction) {
     }
 
     @Override
-    public synchronized void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public synchronized void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         if (!initialized.get()) {
             throw new IllegalStateException("handleConsensusRound() called before init()");
@@ -1125,7 +1125,7 @@ private void updateTransactionCounters() {
     private void handleConsensusTransaction(
             final ConsensusEvent event,
             final ConsensusTransaction trans,
-            final PlatformStateAccessor platformState,
+            final PlatformStateModifier platformState,
             final long roundNum) {
         if (trans.isSystem()) {
             return;
@@ -1164,7 +1164,7 @@ private void handleTransaction(
             @NonNull final Instant timeCreated,
             @NonNull final Instant timestamp,
             @NonNull final ConsensusTransaction trans,
-            @NonNull final PlatformStateAccessor platformState) {
+            @NonNull final PlatformStateModifier platformState) {
         if (getConfig().isAppendSig()) {
             try {
                 final TestTransactionWrapper testTransactionWrapper = TestTransactionWrapper.parseFrom(

platform-sdk/platform-apps/tests/PlatformTestingTool/src/main/java/com/swirlds/demo/platform/freeze/FreezeTransactionHandler.java

@@ -17,7 +17,7 @@
 package com.swirlds.demo.platform.freeze;
 
 import com.swirlds.demo.platform.fs.stresstest.proto.FreezeTransaction;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import java.time.Instant;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -28,7 +28,7 @@ public class FreezeTransactionHandler {
     private static final Logger logger = LogManager.getLogger(FreezeTransactionHandler.class);
     private static final Marker LOGM_FREEZE = MarkerManager.getMarker("FREEZE");
 
-    public static boolean freeze(final FreezeTransaction transaction, final PlatformStateAccessor platformState) {
+    public static boolean freeze(final FreezeTransaction transaction, final PlatformStateModifier platformState) {
         logger.debug(LOGM_FREEZE, "Handling FreezeTransaction: " + transaction);
         try {
             platformState.setFreezeTime(Instant.ofEpochSecond(transaction.getStartTimeEpochSecond()));

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

@@ -37,7 +37,7 @@
 import com.swirlds.common.io.streams.SerializableDataOutputStream;
 import com.swirlds.common.merkle.MerkleLeaf;
 import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.Round;
 import com.swirlds.platform.system.SwirldState;
 import com.swirlds.platform.system.events.Event;
@@ -129,7 +129,7 @@ public void preHandle(final Event event) {
      * {@inheritDoc}
      */
     @Override
-    public void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         round.forEachTransaction(this::handleTransaction);
     }

platform-sdk/platform-apps/tests/StressTestingTool/src/main/java/com/swirlds/demo/stress/StressTestingToolState.java

@@ -31,7 +31,7 @@
 import com.swirlds.common.merkle.MerkleLeaf;
 import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
 import com.swirlds.common.utility.ByteUtils;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
@@ -99,7 +99,7 @@ public void preHandle(final Event event) {
      * {@inheritDoc}
      */
     @Override
-    public void handleConsensusRound(final Round round, final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(final Round round, final PlatformStateModifier platformState) {
         throwIfImmutable();
         round.forEachTransaction(this::handleTransaction);
     }

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/cli/GenesisPlatformStateCommand.java

@@ -29,6 +29,7 @@
 import com.swirlds.platform.config.DefaultConfiguration;
 import com.swirlds.platform.consensus.SyntheticSnapshot;
 import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.state.signed.ReservedSignedState;
 import com.swirlds.platform.state.snapshot.DeserializedSignedState;
 import com.swirlds.platform.state.snapshot.SignedStateFileReader;
@@ -75,7 +76,7 @@ public Integer call() throws IOException, ExecutionException, InterruptedExcepti
         final DeserializedSignedState deserializedSignedState =
                 SignedStateFileReader.readStateFile(platformContext, statePath, SignedStateFileUtils::readState);
         try (final ReservedSignedState reservedSignedState = deserializedSignedState.reservedSignedState()) {
-            final PlatformStateAccessor platformState =
+            final PlatformStateModifier platformState =
                     reservedSignedState.get().getState().getWritablePlatformState();
             platformState.bulkUpdate(v -> {
                 System.out.printf("Replacing platform data %n");

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/eventhandling/DefaultTransactionHandler.java

@@ -37,7 +37,7 @@
 import com.swirlds.platform.internal.ConsensusRound;
 import com.swirlds.platform.metrics.RoundHandlingMetrics;
 import com.swirlds.platform.state.MerkleRoot;
-import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.state.SwirldStateManager;
 import com.swirlds.platform.state.signed.ReservedSignedState;
 import com.swirlds.platform.state.signed.SignedState;
@@ -215,12 +215,12 @@ public StateAndRound handleConsensusRound(@NonNull final ConsensusRound consensu
     }
 
     /**
-     * Populate the {@link PlatformStateAccessor} with all needed data for this round.
+     * Populate the {@link PlatformStateModifier} with all needed data for this round.
      *
      * @param round the consensus round
      */
     private void updatePlatformState(@NonNull final ConsensusRound round) {
-        final PlatformStateAccessor platformState =
+        final PlatformStateModifier platformState =
                 swirldStateManager.getConsensusState().getWritablePlatformState();
         platformState.bulkUpdate(v -> {
             v.setRound(round.getRoundNum());
@@ -238,7 +238,7 @@ private void updatePlatformState(@NonNull final ConsensusRound round) {
      * @throws InterruptedException if this thread is interrupted
      */
     private void updateRunningEventHash(@NonNull final ConsensusRound round) throws InterruptedException {
-        final PlatformStateAccessor platformState =
+        final PlatformStateModifier platformState =
                 swirldStateManager.getConsensusState().getWritablePlatformState();
 
         if (writeLegacyRunningEventHash) {

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/recovery/EventRecoveryWorkflow.java

@@ -53,6 +53,7 @@
 import com.swirlds.platform.recovery.internal.StreamedRound;
 import com.swirlds.platform.state.MerkleRoot;
 import com.swirlds.platform.state.PlatformStateAccessor;
+import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.state.signed.ReservedSignedState;
 import com.swirlds.platform.state.signed.SignedState;
 import com.swirlds.platform.state.snapshot.SignedStateFileReader;
@@ -380,7 +381,7 @@ private static ReservedSignedState handleNextRound(
         new DefaultEventHasher().hashEvent(lastEvent);
 
         final PlatformStateAccessor newReadablePlatformState = newState.getReadablePlatformState();
-        final PlatformStateAccessor newWritablePlatformState = newState.getWritablePlatformState();
+        final PlatformStateModifier newWritablePlatformState = newState.getWritablePlatformState();
         final PlatformStateAccessor previousReadablePlatformState =
                 previousState.get().getState().getReadablePlatformState();
 
@@ -478,7 +479,7 @@ static ConsensusEvent getLastEvent(final Round round) {
     static void applyTransactions(
             final SwirldState immutableState,
             final SwirldState mutableState,
-            final PlatformStateAccessor platformState,
+            final PlatformStateModifier platformState,
             final Round round) {
 
         mutableState.throwIfImmutable();

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

@@ -64,7 +64,7 @@ public static void modifyStateForBirthRoundMigration(
         }
 
         final MerkleRoot state = initialState.getState();
-        final PlatformStateAccessor writablePlatformState = state.getWritablePlatformState();
+        final PlatformStateModifier writablePlatformState = state.getWritablePlatformState();
 
         final boolean alreadyMigrated = writablePlatformState.getFirstVersionInBirthRoundMode() != null;
         if (alreadyMigrated) {

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

@@ -39,7 +39,7 @@ private GenesisStateBuilder() {}
      */
     public static void initGenesisPlatformState(
             final PlatformContext platformContext,
-            final PlatformStateAccessor platformState,
+            final PlatformStateModifier platformState,
             final AddressBook addressBook,
             final SoftwareVersion appVersion) {
         platformState.bulkUpdate(v -> {

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

@@ -32,6 +32,12 @@ public interface MerkleRoot extends MerkleInternal {
     @NonNull
     SwirldState getSwirldState();
 
+    /**
+     * This method makes sure that the platform state is initialized.
+     * If it's already initialized, it does nothing.
+     */
+    void initPlatformState();
+
     /**
      * Get readable platform state.
      * Works on both - mutable and immutable {@link MerkleRoot} and, therefore, this method should be preferred.
@@ -48,14 +54,14 @@ public interface MerkleRoot extends MerkleInternal {
      * @return mutable platform state
      */
     @NonNull
-    PlatformStateAccessor getWritablePlatformState();
+    PlatformStateModifier getWritablePlatformState();
 
     /**
      * Set the platform state.
      *
      * @param platformState the platform state
      */
-    void updatePlatformState(@NonNull final PlatformStateAccessor platformState);
+    void updatePlatformState(@NonNull final PlatformStateModifier platformState);
 
     /**
      * Generate a string that describes this state.

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

@@ -37,7 +37,7 @@
  */
 public interface MerkleStateLifecycles {
     /**
-     * Called when a {@link MerkleStateRoot} needs to ensure its {@link PlatformStateAccessor} implementation
+     * Called when a {@link MerkleStateRoot} needs to ensure its {@link PlatformStateModifier} implementation
      * is initialized.
      *
      * @param state the root of the state to be initialized

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

@@ -390,7 +390,7 @@ public MerkleStateRoot copy() {
      * {@inheritDoc}
      */
     @Override
-    public void handleConsensusRound(@NonNull final Round round, @NonNull final PlatformStateAccessor platformState) {
+    public void handleConsensusRound(@NonNull final Round round, @NonNull final PlatformStateModifier platformState) {
         throwIfImmutable();
         lifecycles.onHandleConsensusRound(round, this);
     }
@@ -1014,20 +1014,30 @@ public PlatformStateAccessor getReadablePlatformState() {
      */
     @NonNull
     @Override
-    public PlatformStateAccessor getWritablePlatformState() {
+    public PlatformStateModifier getWritablePlatformState() {
         if (isImmutable()) {
             throw new IllegalStateException("Cannot get writable platform state when state is immutable");
         }
         return writablePlatformStateStore();
     }
 
     /**
-     * Updates the platform state with the values from the provided instance of {@link PlatformStateAccessor}
+     * {@inheritDoc}
+     */
+    @Override
+    public void initPlatformState() {
+        if (!services.containsKey(PlatformStateService.NAME)) {
+            platformStateInitChanges = lifecycles.initPlatformState(this);
+        }
+    }
+
+    /**
+     * Updates the platform state with the values from the provided instance of {@link PlatformStateModifier}
      *
      * @param accessor a source of values
      */
     @Override
-    public void updatePlatformState(@NonNull final PlatformStateAccessor accessor) {
+    public void updatePlatformState(@NonNull final PlatformStateModifier accessor) {
         writablePlatformStateStore().setAllFrom(accessor);
     }