Merge pull request #148 from OpenElements/network-provider

Provide Settings for Hiero Networks by "Plug and Play"

Author: hendrikebbers

.github/workflows/maven.yml

@@ -41,6 +41,6 @@ jobs:
           spring_profiles_active: solo
           HEDERA_ACCOUNT_ID: ${{ steps.solo.outputs.accountId }}
           HEDERA_PRIVATE_KEY: ${{ steps.solo.outputs.privateKey }}
-          HEDERA_NETWORK: solo
+          HEDERA_NETWORK: hiero-solo-action
         run: ./mvnw verify
 

hiero-enterprise-base/pom.xml

@@ -37,16 +37,21 @@
       <artifactId>jspecify</artifactId>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>com.google.auto.service</groupId>
+      <artifactId>auto-service-annotations</artifactId>
+      <scope>compile</scope>
+    </dependency>
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>
-  <groupId>org.mockito</groupId>
-  <artifactId>mockito-core</artifactId>
-  <scope>test</scope>
-</dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>io.grpc</groupId>
       <artifactId>grpc-okhttp</artifactId>

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/HieroConfig.java

@@ -4,7 +4,6 @@
 import com.hedera.hashgraph.sdk.Client;
 import com.openelements.hiero.base.HieroContext;
 import com.openelements.hiero.base.data.Account;
-import com.openelements.hiero.base.implementation.HieroNetwork;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -43,7 +42,7 @@ public interface HieroConfig {
      * @return the mirror node addresses
      */
     @NonNull
-    List<String> getMirrorNodeAddresses();
+    Set<String> getMirrorNodeAddresses();
 
     /**
      * Returns the consensus nodes.
@@ -53,13 +52,11 @@ public interface HieroConfig {
     @NonNull
     Set<ConsensusNode> getConsensusNodes();
 
-    /**
-     * Returns the network.
-     *
-     * @return
-     */
     @NonNull
-    HieroNetwork getNetwork();
+    Optional<Long> chainId();
+
+    @NonNull
+    Optional<String> relayUrl();
 
     /**
      * Creates a Hiero context. Calling this method multiple times will return a new instance each time.
@@ -90,31 +87,16 @@ default HieroContext createHieroContext() {
      */
     @NonNull
     default Client createClient() {
-        final HieroNetwork hieroNetwork = getNetwork();
-        if (hieroNetwork != HieroNetwork.CUSTOM) {
-            try {
-                log.debug("Hiero network '{}' will be used", hieroNetwork.getName());
-
-                //TODO: Hack since the Client is still Hedera specific and not migrated to Hiero
-                Client client = Client.forName(hieroNetwork.getName().substring("hedera-".length()));
-                client.setOperator(getOperatorAccount().accountId(), getOperatorAccount().privateKey());
-                return client;
-            } catch (Exception e) {
-                throw new IllegalArgumentException("Can not create client for network " + hieroNetwork.getName(),
-                        e);
-            }
-        } else {
-            try {
-                final Map<String, AccountId> nodes = getConsensusNodes().stream()
-                        .collect(Collectors.toMap(n -> n.getAddress(), n -> n.getAccountId()));
-                final Client client = Client.forNetwork(nodes);
-                client.setMirrorNetwork(getMirrorNodeAddresses());
-                client.setOperator(getOperatorAccount().accountId(), getOperatorAccount().privateKey());
-                return client;
-            } catch (Exception e) {
-                throw new IllegalArgumentException("Can not create client for custom network", e);
-            }
+        try {
+            final Map<String, AccountId> nodes = getConsensusNodes().stream()
+                    .collect(Collectors.toMap(n -> n.getAddress(), n -> n.getAccountId()));
+            final Client client = Client.forNetwork(nodes);
+            final List<String> mirrorNodeAddresses = getMirrorNodeAddresses().stream().collect(Collectors.toList());
+            client.setMirrorNetwork(mirrorNodeAddresses);
+            client.setOperator(getOperatorAccount().accountId(), getOperatorAccount().privateKey());
+            return client;
+        } catch (Exception e) {
+            throw new IllegalArgumentException("Can not create client for custom network", e);
         }
     }
-
 }

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/NetworkSettings.java

@@ -0,0 +1,84 @@
+package com.openelements.hiero.base.config;
+
+import com.openelements.hiero.base.config.implementation.NetworkSettingsProviderLoader;
+import java.util.Optional;
+import java.util.Set;
+import org.jspecify.annotations.NonNull;
+
+/**
+ * Interface that provides all needed configuration settings for a network. Operator of a Hiero based network should
+ * implement this interface to provide the necessary configuration settings. Implementations can be provided via Java
+ * SPI as defined in {@link NetworkSettingsProvider}.
+ *
+ * @see NetworkSettingsProvider
+ * @see java.util.ServiceLoader
+ */
+public interface NetworkSettings {
+
+    /**
+     * Returns the network identifier.
+     *
+     * @return the network identifier
+     */
+    @NonNull
+    String getNetworkIdentifier();
+
+    /**
+     * Returns the network name.
+     *
+     * @return the network name
+     */
+    @NonNull
+    Optional<String> getNetworkName();
+
+    /**
+     * Returns the mirror node addresses.
+     *
+     * @return the mirror node addresses
+     */
+    @NonNull
+    Set<String> getMirrorNodeAddresses();
+
+    /**
+     * Returns the consensus nodes.
+     *
+     * @return the consensus nodes
+     */
+    @NonNull
+    Set<ConsensusNode> getConsensusNodes();
+
+    /**
+     * Returns the chain ID of the network.
+     *
+     * @return the chain ID of the network
+     */
+    @NonNull
+    Optional<Long> chainId();
+
+    /**
+     * Returns the relay URL of the network.
+     *
+     * @return the relay URL of the network.
+     */
+    @NonNull
+    Optional<String> relayUrl();
+
+    /**
+     * Returns all available network settings.
+     *
+     * @return all available network settings
+     */
+    static Set<NetworkSettings> all() {
+        return NetworkSettingsProviderLoader.getInstance().all();
+    }
+
+    /**
+     * Returns the network settings for the given identifier.
+     *
+     * @param identifier the identifier of the network
+     * @return the network settings for the given identifier
+     */
+    static Optional<NetworkSettings> forIdentifier(String identifier) {
+        return NetworkSettingsProviderLoader.getInstance().forIdentifier(identifier);
+    }
+}

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/NetworkSettingsProvider.java

@@ -0,0 +1,24 @@
+package com.openelements.hiero.base.config;
+
+import java.util.Set;
+
+/**
+ * SPI interface to provide predefined {@link NetworkSettings} instances. Java SPI functionality is documented at
+ * {@link java.util.ServiceLoader}.
+ */
+public interface NetworkSettingsProvider {
+
+    /**
+     * Returns the name of the provider.
+     *
+     * @return the name of the provider
+     */
+    String getName();
+
+    /**
+     * Return a set of {@link NetworkSettings} instances provided by this provider.
+     *
+     * @return a set of {@link NetworkSettings} instances
+     */
+    Set<NetworkSettings> createNetworkSettings();
+}

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/hedera/HederMainnetSettings.java

@@ -0,0 +1,42 @@
+package com.openelements.hiero.base.config.hedera;
+
+import com.openelements.hiero.base.config.ConsensusNode;
+import com.openelements.hiero.base.config.NetworkSettings;
+import java.util.Optional;
+import java.util.Set;
+import org.jspecify.annotations.NonNull;
+
+public final class HederMainnetSettings implements NetworkSettings {
+
+    public static final String NETWORK_IDENTIFIER = "hedera-mainnet";
+
+    @Override
+    public @NonNull String getNetworkIdentifier() {
+        return NETWORK_IDENTIFIER;
+    }
+
+    @Override
+    public @NonNull Optional<String> getNetworkName() {
+        return Optional.of("Hedera Mainnet");
+    }
+
+    @Override
+    public @NonNull Set<String> getMirrorNodeAddresses() {
+        return Set.of("https://mainnet.mirrornode.hedera.com:443");
+    }
+
+    @Override
+    public @NonNull Set<ConsensusNode> getConsensusNodes() {
+        return Set.of(new ConsensusNode("35.186.191.247", "50211", "0.0.4"));
+    }
+
+    @Override
+    public @NonNull Optional<Long> chainId() {
+        return Optional.of(295L);
+    }
+
+    @Override
+    public @NonNull Optional<String> relayUrl() {
+        return Optional.of("https://mainnet.hashio.io/api");
+    }
+}

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/hedera/HederTestnetSettings.java

@@ -0,0 +1,42 @@
+package com.openelements.hiero.base.config.hedera;
+
+import com.openelements.hiero.base.config.ConsensusNode;
+import com.openelements.hiero.base.config.NetworkSettings;
+import java.util.Optional;
+import java.util.Set;
+import org.jspecify.annotations.NonNull;
+
+public final class HederTestnetSettings implements NetworkSettings {
+
+    public static final String NETWORK_IDENTIFIER = "hedera-testnet";
+
+    @Override
+    public @NonNull String getNetworkIdentifier() {
+        return NETWORK_IDENTIFIER;
+    }
+
+    @Override
+    public @NonNull Optional<String> getNetworkName() {
+        return Optional.of("Hedera Testnet");
+    }
+
+    @Override
+    public @NonNull Set<String> getMirrorNodeAddresses() {
+        return Set.of("https://testnet.mirrornode.hedera.com:443");
+    }
+
+    @Override
+    public @NonNull Set<ConsensusNode> getConsensusNodes() {
+        return Set.of(new ConsensusNode("0.testnet.hedera.com", "50211", "0.0.3"));
+    }
+
+    @Override
+    public @NonNull Optional<Long> chainId() {
+        return Optional.of(296L);
+    }
+
+    @Override
+    public @NonNull Optional<String> relayUrl() {
+        return Optional.of("https://testnet.hashio.io/api");
+    }
+}

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/hedera/HederaNetworkSettingsProvider.java

@@ -0,0 +1,20 @@
+package com.openelements.hiero.base.config.hedera;
+
+import com.google.auto.service.AutoService;
+import com.openelements.hiero.base.config.NetworkSettings;
+import com.openelements.hiero.base.config.NetworkSettingsProvider;
+import java.util.Set;
+
+@AutoService(NetworkSettingsProvider.class)
+public final class HederaNetworkSettingsProvider implements NetworkSettingsProvider {
+
+    @Override
+    public String getName() {
+        return "Hedera";
+    }
+
+    @Override
+    public Set<NetworkSettings> createNetworkSettings() {
+        return Set.of(new HederMainnetSettings(), new HederTestnetSettings());
+    }
+}

hiero-enterprise-base/src/main/java/com/openelements/hiero/base/config/implementation/NetworkSettingsProviderLoader.java

@@ -0,0 +1,56 @@
+package com.openelements.hiero.base.config.implementation;
+
+import com.openelements.hiero.base.config.NetworkSettings;
+import com.openelements.hiero.base.config.NetworkSettingsProvider;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.ServiceLoader;
+import java.util.Set;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public final class NetworkSettingsProviderLoader {
+
+    private final static Logger logger = LoggerFactory.getLogger(NetworkSettingsProviderLoader.class);
+
+    private final static NetworkSettingsProviderLoader instance = new NetworkSettingsProviderLoader();
+
+    private final Set<NetworkSettings> settings;
+
+    private NetworkSettingsProviderLoader() {
+        final Set<NetworkSettings> loaded = new HashSet<>();
+        ServiceLoader<NetworkSettingsProvider> loader = ServiceLoader.load(NetworkSettingsProvider.class);
+        loader.stream().forEach(provider -> {
+            final NetworkSettingsProvider networkSettingsProvider = provider.get();
+            logger.info("Loading network settings from provider: {}", networkSettingsProvider.getName());
+            final Set<NetworkSettings> networkSettingsFromProvider = networkSettingsProvider.createNetworkSettings();
+            logger.debug("Loaded {} network settings from provider {}", networkSettingsFromProvider.size(),
+                    networkSettingsProvider.getName());
+            networkSettingsFromProvider.forEach(setting -> {
+                if (loaded.stream().anyMatch(
+                        existing -> Objects.equals(existing.getNetworkIdentifier(), setting.getNetworkIdentifier()))) {
+                    throw new IllegalStateException(
+                            "Network settings with identifier " + setting.getNetworkIdentifier() + " already loaded");
+                } else {
+                    loaded.add(setting);
+                }
+            });
+        });
+        this.settings = Collections.unmodifiableSet(loaded);
+    }
+
+    public Set<NetworkSettings> all() {
+        return settings;
+    }
+
+    public Optional<NetworkSettings> forIdentifier(String identifier) {
+        return all().stream().filter(settings -> Objects.equals(settings.getNetworkIdentifier(), identifier))
+                .findFirst();
+    }
+
+    public static NetworkSettingsProviderLoader getInstance() {
+        return instance;
+    }
+}