refactor: remove State class

hedera-node/hedera-app/src/main/java/com/hedera/node/app/state/merkle/MerkleSchemaRegistry.java

@@ -22,6 +22,7 @@
 import static com.hedera.node.app.state.merkle.VersionUtils.alreadyIncludesStateDefs;
 import static com.hedera.node.app.state.merkle.VersionUtils.isSoOrdered;
 import static com.hedera.node.app.workflows.handle.metric.UnavailableMetrics.UNAVAILABLE_METRICS;
+import static com.swirlds.state.merkle.StateUtils.registerWithSystem;
 import static java.util.Objects.requireNonNull;
 
 import com.hedera.hapi.node.base.SemanticVersion;
@@ -31,9 +32,7 @@
 import com.hedera.node.app.services.MigrationStateChanges;
 import com.hedera.node.app.spi.state.FilteredReadableStates;
 import com.hedera.node.app.spi.state.FilteredWritableStates;
-import com.swirlds.common.constructable.ClassConstructorPair;
 import com.swirlds.common.constructable.ConstructableRegistry;
-import com.swirlds.common.constructable.ConstructableRegistryException;
 import com.swirlds.common.crypto.DigestType;
 import com.swirlds.config.api.Configuration;
 import com.swirlds.merkle.map.MerkleMap;
@@ -51,16 +50,10 @@
 import com.swirlds.state.lifecycle.info.NetworkInfo;
 import com.swirlds.state.merkle.StateMetadata;
 import com.swirlds.state.merkle.StateUtils;
-import com.swirlds.state.merkle.disk.OnDiskKey;
 import com.swirlds.state.merkle.disk.OnDiskKeySerializer;
-import com.swirlds.state.merkle.disk.OnDiskValue;
 import com.swirlds.state.merkle.disk.OnDiskValueSerializer;
-import com.swirlds.state.merkle.memory.InMemoryValue;
-import com.swirlds.state.merkle.memory.InMemoryWritableKVState;
 import com.swirlds.state.merkle.queue.QueueNode;
 import com.swirlds.state.merkle.singleton.SingletonNode;
-import com.swirlds.state.merkle.singleton.StringLeaf;
-import com.swirlds.state.merkle.singleton.ValueLeaf;
 import com.swirlds.state.spi.WritableStates;
 import com.swirlds.virtualmap.VirtualMap;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -151,7 +144,7 @@ public SchemaRegistry register(@NonNull Schema schema) {
         schema.statesToCreate(bootstrapConfig).forEach(def -> {
             //noinspection rawtypes,unchecked
             final var md = new StateMetadata<>(serviceName, schema, def);
-            registerWithSystem(md);
+            registerWithSystem(md, constructableRegistry);
         });
 
         return this;
@@ -380,81 +373,4 @@ private RedefinedWritableStates applyStateDefinitions(
         final var newStates = new FilteredWritableStates(writableStates, remainingStates);
         return new RedefinedWritableStates(writableStates, newStates);
     }
-
-    /**
-     * Registers with the {@link ConstructableRegistry} system a class ID and a class. While this
-     * will only be used for in-memory states, it is safe to register for on-disk ones as well.
-     *
-     * <p>The implementation will take the service name and the state key and compute a hash for it.
-     * It will then convert the hash to a long, and use that as the class ID. It will then register
-     * an {@link InMemoryWritableKVState}'s value merkle type to be deserialized, answering with the
-     * generated class ID.
-     *
-     * @param md The state metadata
-     */
-    @SuppressWarnings({"rawtypes", "unchecked"})
-    private void registerWithSystem(@NonNull final StateMetadata md) {
-        // Register with the system the uniqueId as the "classId" of an InMemoryValue. There can be
-        // multiple id's associated with InMemoryValue. The secret is that the supplier captures the
-        // various delegate writers and parsers, and so can parse/write different types of data
-        // based on the id.
-        try {
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    InMemoryValue.class,
-                    () -> new InMemoryValue(
-                            md.inMemoryValueClassId(),
-                            md.stateDefinition().keyCodec(),
-                            md.stateDefinition().valueCodec())));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    OnDiskKey.class,
-                    () -> new OnDiskKey<>(
-                            md.onDiskKeyClassId(), md.stateDefinition().keyCodec())));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    OnDiskKeySerializer.class,
-                    () -> new OnDiskKeySerializer<>(
-                            md.onDiskKeySerializerClassId(),
-                            md.onDiskKeyClassId(),
-                            md.stateDefinition().keyCodec())));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    OnDiskValue.class,
-                    () -> new OnDiskValue<>(
-                            md.onDiskValueClassId(), md.stateDefinition().valueCodec())));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    OnDiskValueSerializer.class,
-                    () -> new OnDiskValueSerializer<>(
-                            md.onDiskValueSerializerClassId(),
-                            md.onDiskValueClassId(),
-                            md.stateDefinition().valueCodec())));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    SingletonNode.class,
-                    () -> new SingletonNode<>(
-                            md.serviceName(),
-                            md.stateDefinition().stateKey(),
-                            md.singletonClassId(),
-                            md.stateDefinition().valueCodec(),
-                            null)));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    QueueNode.class,
-                    () -> new QueueNode<>(
-                            md.serviceName(),
-                            md.stateDefinition().stateKey(),
-                            md.queueNodeClassId(),
-                            md.singletonClassId(),
-                            md.stateDefinition().valueCodec())));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(StringLeaf.class, StringLeaf::new));
-            constructableRegistry.registerConstructable(new ClassConstructorPair(
-                    ValueLeaf.class,
-                    () -> new ValueLeaf<>(
-                            md.singletonClassId(), md.stateDefinition().valueCodec())));
-        } catch (ConstructableRegistryException e) {
-            // This is a fatal error.
-            throw new IllegalStateException(
-                    "Failed to register with the system '"
-                            + serviceName
-                            + ":"
-                            + md.stateDefinition().stateKey()
-                            + "'",
-                    e);
-        }
-    }
 }

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

@@ -36,11 +36,11 @@
 import com.swirlds.common.utility.AutoCloseableWrapper;
 import com.swirlds.metrics.api.Metrics;
 import com.swirlds.platform.Browser;
-import com.swirlds.platform.state.MerkleRoot;
-import com.swirlds.platform.state.State;
+import com.swirlds.platform.state.MerkleStateRoot;
 import com.swirlds.platform.system.BasicSoftwareVersion;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.SwirldMain;
+import com.swirlds.platform.util.NoOpMerkleStateLifecycles;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
@@ -182,9 +182,11 @@ public void run() {
 
     @Override
     @NonNull
-    public MerkleRoot newMerkleStateRoot() {
-        final State state = new State();
-        state.setSwirldState(new CryptocurrencyDemoState());
+    public MerkleStateRoot newMerkleStateRoot() {
+        final MerkleStateRoot state = new CryptocurrencyDemoState(
+                NoOpMerkleStateLifecycles.NO_OP_MERKLE_STATE_LIFECYCLES,
+                version -> new BasicSoftwareVersion(softwareVersion.getSoftwareVersion()));
+        NoOpMerkleStateLifecycles.NO_OP_MERKLE_STATE_LIFECYCLES.initPlatformState(state);
         return state;
     }
 

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

@@ -26,32 +26,31 @@
  * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
  */
 
+import com.hedera.hapi.node.base.SemanticVersion;
 import com.hedera.pbj.runtime.io.buffer.Bytes;
-import com.swirlds.common.io.streams.SerializableDataInputStream;
-import com.swirlds.common.io.streams.SerializableDataOutputStream;
-import com.swirlds.common.merkle.MerkleLeaf;
-import com.swirlds.common.merkle.impl.PartialMerkleLeaf;
+import com.swirlds.common.constructable.ConstructableIgnored;
 import com.swirlds.common.platform.NodeId;
 import com.swirlds.platform.SwirldsPlatform;
+import com.swirlds.platform.state.MerkleStateLifecycles;
+import com.swirlds.platform.state.MerkleStateRoot;
 import com.swirlds.platform.state.PlatformStateModifier;
 import com.swirlds.platform.system.InitTrigger;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.Round;
 import com.swirlds.platform.system.SoftwareVersion;
-import com.swirlds.platform.system.SwirldState;
 import com.swirlds.platform.system.address.Address;
 import com.swirlds.platform.system.address.AddressBook;
 import com.swirlds.platform.system.transaction.Transaction;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Random;
 import java.util.concurrent.atomic.AtomicLong;
+import java.util.function.Function;
 
 /**
  * This holds the current state of a swirld representing both a cryptocurrency and a stock market.
@@ -62,7 +61,8 @@
  * entirely new cryptocurrency is created every time all the computers start the program over again, so
  * these cryptocurrencies won't have any actual value.
  */
-public class CryptocurrencyDemoState extends PartialMerkleLeaf implements SwirldState, MerkleLeaf {
+@ConstructableIgnored
+public class CryptocurrencyDemoState extends MerkleStateRoot {
 
     /**
      * The version history of this class.
@@ -134,7 +134,11 @@ public static enum TransType {
 
     ////////////////////////////////////////////////////
 
-    public CryptocurrencyDemoState() {}
+    public CryptocurrencyDemoState(
+            @NonNull final MerkleStateLifecycles lifecycles,
+            @NonNull final Function<SemanticVersion, SoftwareVersion> versionFactory) {
+        super(lifecycles, versionFactory);
+    }
 
     private CryptocurrencyDemoState(final CryptocurrencyDemoState sourceState) {
         super(sourceState);
@@ -196,6 +200,7 @@ public synchronized long getNumTrades() {
     @Override
     public synchronized CryptocurrencyDemoState copy() {
         throwIfImmutable();
+        setImmutable(true);
         return new CryptocurrencyDemoState(this);
     }
 
@@ -380,76 +385,14 @@ public void init(
             @NonNull final Platform platform,
             @NonNull final InitTrigger trigger,
             @Nullable final SoftwareVersion previousSoftwareVersion) {
-        this.platform = (SwirldsPlatform) platform;
+        super.init(platform, trigger, previousSoftwareVersion);
 
+        this.platform = (SwirldsPlatform) platform;
         if (trigger == InitTrigger.GENESIS) {
             genesisInit();
         }
     }
 
-    @Override
-    public void serialize(final SerializableDataOutputStream out) throws IOException {
-        out.writeStringArray(tickerSymbol);
-
-        out.writeInt(wallet.size());
-        for (Map.Entry<NodeId, AtomicLong> entry : wallet.entrySet()) {
-            out.writeSerializable(entry.getKey(), false);
-            out.writeLong(entry.getValue().get());
-        }
-
-        out.writeInt(shares.size());
-        for (Map.Entry<NodeId, List<AtomicLong>> entry : shares.entrySet()) {
-            out.writeSerializable(entry.getKey(), false);
-            out.writeInt(entry.getValue().size());
-            for (int i = 0; i < entry.getValue().size(); i++) {
-                out.writeLong(entry.getValue().get(i).get());
-            }
-        }
-
-        out.writeStringArray(trades);
-        out.writeInt(numTradesStored);
-        out.writeInt(lastTradeIndex);
-        out.writeLong(numTrades);
-        out.writeByteArray(ask);
-        out.writeByteArray(bid);
-        out.writeSerializableArray(askId, false, true);
-        out.writeSerializableArray(bidId, false, true);
-        out.writeByteArray(price);
-    }
-
-    @Override
-    public void deserialize(final SerializableDataInputStream in, final int version) throws IOException {
-        tickerSymbol = in.readStringArray(DEFAULT_MAX_ARRAY_SIZE, DEFAULT_MAX_STRING_SIZE);
-
-        int walletSize = in.readInt();
-        for (int i = 0; i < walletSize; i++) {
-            final NodeId id = in.readSerializable(false, NodeId::new);
-            final AtomicLong amount = new AtomicLong(in.readLong());
-            wallet.put(id, amount);
-        }
-
-        final int sharesSize = in.readInt();
-        for (int i = 0; i < sharesSize; i++) {
-            final NodeId id = in.readSerializable(false, NodeId::new);
-            final int numShares = in.readInt();
-            final List<AtomicLong> sharesForID = new ArrayList<>(numShares);
-            for (int j = 0; j < numShares; j++) {
-                sharesForID.add(new AtomicLong(in.readLong()));
-            }
-            shares.put(id, sharesForID);
-        }
-
-        trades = in.readStringArray(DEFAULT_MAX_ARRAY_SIZE, DEFAULT_MAX_STRING_SIZE);
-        numTradesStored = in.readInt();
-        lastTradeIndex = in.readInt();
-        numTrades = in.readLong();
-        ask = in.readByteArray(DEFAULT_MAX_ARRAY_SIZE);
-        bid = in.readByteArray(DEFAULT_MAX_ARRAY_SIZE);
-        askId = in.readSerializableArray(NodeId[]::new, DEFAULT_MAX_ARRAY_SIZE, false, NodeId::new);
-        bidId = in.readSerializableArray(NodeId[]::new, DEFAULT_MAX_ARRAY_SIZE, false, NodeId::new);
-        price = in.readByteArray(DEFAULT_MAX_ARRAY_SIZE);
-    }
-
     @Override
     public long getClassId() {
         return CLASS_ID;

platform-sdk/platform-apps/demos/CryptocurrencyDemo/src/main/java/module-info.java

@@ -1,7 +1,9 @@
 module com.swirlds.demo.crypto {
+    requires com.hedera.node.hapi;
     requires com.swirlds.common;
     requires com.swirlds.metrics.api;
     requires com.swirlds.platform.core;
+    requires com.swirlds.state.api;
     requires com.hedera.pbj.runtime;
     requires java.desktop;
     requires static com.github.spotbugs.annotations;

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

@@ -35,12 +35,12 @@
 import com.swirlds.platform.SwirldsPlatform;
 import com.swirlds.platform.listeners.PlatformStatusChangeListener;
 import com.swirlds.platform.listeners.PlatformStatusChangeNotification;
-import com.swirlds.platform.state.MerkleRoot;
-import com.swirlds.platform.state.State;
+import com.swirlds.platform.state.MerkleStateRoot;
 import com.swirlds.platform.system.BasicSoftwareVersion;
 import com.swirlds.platform.system.Platform;
 import com.swirlds.platform.system.SwirldMain;
 import com.swirlds.platform.system.status.PlatformStatus;
+import com.swirlds.platform.util.NoOpMerkleStateLifecycles;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.nio.charset.StandardCharsets;
 
@@ -109,9 +109,11 @@ public void run() {
 
     @NonNull
     @Override
-    public MerkleRoot newMerkleStateRoot() {
-        final State state = new State();
-        state.setSwirldState(new HelloSwirldDemoState());
+    public MerkleStateRoot newMerkleStateRoot() {
+        final MerkleStateRoot state = new HelloSwirldDemoState(
+                NoOpMerkleStateLifecycles.NO_OP_MERKLE_STATE_LIFECYCLES,
+                version -> new BasicSoftwareVersion(softwareVersion.getSoftwareVersion()));
+        NoOpMerkleStateLifecycles.NO_OP_MERKLE_STATE_LIFECYCLES.initPlatformState(state);
         return state;
     }