Added help for setting up Stratum mining (hyperledger#7584)

* Added help for setting up Stratum mining Signed-off-by: ITStarMan100 <[email protected]> * removed duplication from help message; fixed spotless Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: ITStarMan100 <[email protected]> Signed-off-by: Sally MacFarlane <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]>
daniellehrner · Sep 10, 2024 · 36454b4 · 36454b4
1 parent 9a570d4
commit 36454b4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java b/besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java
@@ -805,7 +805,7 @@ public Runner build() {
     if (miningParameters.isStratumMiningEnabled()) {
       if (!(miningCoordinator instanceof PoWMiningCoordinator powMiningCoordinator)) {
         throw new IllegalArgumentException(
-            "Stratum server requires an PoWMiningCoordinator not "
+            "Stratum mining requires the network option(--network) to be set to CLASSIC. Stratum server requires a PoWMiningCoordinator not "
                 + ((miningCoordinator == null) ? "null" : miningCoordinator.getClass().getName()));
       }
       stratumServer =

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/options/MiningOptions.java b/besu/src/main/java/org/hyperledger/besu/cli/options/MiningOptions.java
@@ -59,7 +59,10 @@ public class MiningOptions implements CLIOptions<MiningParameters> {
 
   @Option(
       names = {"--miner-stratum-enabled"},
-      description = "Set if node will perform Stratum mining (default: ${DEFAULT-VALUE})")
+      description =
+          "Set if node will perform Stratum mining (default: ${DEFAULT-VALUE})."
+              + " Compatible with Proof of Work (PoW) only."
+              + " Requires the network option (--network) to be set to CLASSIC.")
   private Boolean iStratumMiningEnabled = false;
 
   @Option(