Refactoring Peer CLI commands

convex-cli/README.md

@@ -4,9 +4,16 @@
 
 The `convex-cli` module provides a CLI interface to Convex, including the ability to operate as either a client or peer on the Convex Network
 
+## Usage Examples
+
+### List available commands and options
+
+```
+convex --help
+```
 
 ## License
 
-Copyright 2021-2023 The Convex Foundation and Contributors
+Copyright 2021-2024 The Convex Foundation and Contributors
 
 Code in `convex-cli` is provided under the Convex Public License

convex-cli/src/main/java/convex/cli/Main.java

@@ -62,22 +62,10 @@
 	description="Convex Command Line Interface")
 
 public class Main implements Runnable {
-
 	private static Logger log = LoggerFactory.getLogger(Main.class);
 
 	public CommandLine commandLine=new CommandLine(this);
 
-	@Option(names={ "-c", "--config"},
-		scope = ScopeType.INHERIT,
-		description="Use the specified config file. If not specified, will check ~/.convex/convex.config")
-	private String configFilename;
-
-    @Option(names={"-e", "--etch"},
-		scope = ScopeType.INHERIT,
-		defaultValue="${env:CONVEX_ETCH_FILE}",
-		description="Convex Etch database filename. A temporary storage file will be created if required.")
-	private String etchStoreFilename;
-
 	@Option(names={"-k", "--keystore"},
 		defaultValue="${env:CONVEX_KEYSTORE_PASSWORD:-" +Constants.KEYSTORE_FILENAME+"}",
 		scope = ScopeType.INHERIT,
@@ -262,12 +250,7 @@ public String getKeyStoreFilename() {
 		return null;
 	}
 
-	public String getEtchStoreFilename() {
-		if ( etchStoreFilename != null) {
-			return Helpers.expandTilde(etchStoreFilename).strip();
-		}
-		return null;
-	}
+
 
 	private boolean keyStoreLoaded=false;
 	private KeyStore keyStore=null;

convex-cli/src/main/java/convex/cli/peer/APeerCommand.java

@@ -1,5 +1,22 @@
 package convex.cli.peer;
 
+import convex.cli.Helpers;
+import convex.cli.Main;
+import picocli.CommandLine.ParentCommand;
+
 public abstract class APeerCommand implements Runnable {
 
+	@ParentCommand
+	private Peer peerParent;
+
+	public String getEtchStoreFilename() {
+		if ( peerParent.etchStoreFilename != null) {
+			return Helpers.expandTilde(peerParent.etchStoreFilename).strip();
+		}
+		return null;
+	}
+
+	protected Main cli() {
+		return peerParent.cli();
+	}
 }

convex-cli/src/main/java/convex/cli/peer/Peer.java

@@ -1,9 +1,12 @@
 package convex.cli.peer;
 
+import convex.cli.ATopCommand;
 import convex.cli.Main;
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
+import picocli.CommandLine.Option;
 import picocli.CommandLine.ParentCommand;
+import picocli.CommandLine.ScopeType;
 
 
 /**
@@ -21,7 +24,18 @@
 	},
 	mixinStandardHelpOptions=true,
 	description="Operates a local peer.")
-public class Peer implements Runnable {
+public class Peer extends ATopCommand {
+
+	@Option(names={ "-c", "--config"},
+			scope = ScopeType.INHERIT,
+			description="Use the specified config file. If not specified, will check ~/.convex/convex.config")
+	private String configFilename;
+
+	@Option(names={"-e", "--etch"},
+			scope = ScopeType.INHERIT,
+			defaultValue="${env:CONVEX_ETCH_FILE}",
+			description="Convex Etch database filename. A temporary storage file will be created if required.")
+	String etchStoreFilename;
 
 	// private static final Logger log = Logger.getLogger(Peer.class.getName());
 

convex-cli/src/main/java/convex/cli/peer/PeerCreate.java

@@ -3,26 +3,25 @@
 import java.io.File;
 import java.security.KeyStore;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import convex.api.Convex;
 import convex.cli.CLIError;
 import convex.cli.Constants;
 import convex.cli.Main;
 import convex.cli.output.RecordOutput;
+import convex.core.Result;
 import convex.core.crypto.AKeyPair;
 import convex.core.crypto.PFXTools;
-import convex.core.data.Address;
 import convex.core.data.ACell;
+import convex.core.data.Address;
 import convex.core.lang.Reader;
 import convex.core.transactions.ATransaction;
 import convex.core.transactions.Invoke;
-import convex.core.Result;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Model.CommandSpec;
 import picocli.CommandLine.Option;
-import picocli.CommandLine.ParentCommand;
 import picocli.CommandLine.Spec;
 
 /**
@@ -43,9 +42,6 @@ public class PeerCreate extends APeerCommand {
 
 	private static final Logger log = LoggerFactory.getLogger(PeerCreate.class);
 
-	@ParentCommand
-	private Peer peerParent;
-
 	@Spec CommandSpec spec;
 
 	@Option(names={"--public-key"},
@@ -72,7 +68,7 @@ public class PeerCreate extends APeerCommand {
 	@Override
 	public void run() {
 
-		Main mainParent = peerParent.mainParent;
+		Main mainParent = cli();
 
 		long peerStake = convex.core.Constants.MINIMUM_EFFECTIVE_STAKE;
 
@@ -142,4 +138,5 @@ public void run() {
 			throw new CLIError("Error creating Peer",t);
 		}
 	}
+
 }