cmd/ethereum: improve command line interface

The ethereum command line interface is now structured using subcommands.
These separate the different tasks it can perform.

Almost all flag names are backwards compatible.

The key tasks have not been ported to subcommands since they will be
replaced by the new accounts infrastructure very soon.

1 files changed, 148 insertions, 90 deletions

diff --git a/cmd/ethereum/main.go b/cmd/ethereum/main.go
index b9e69f700..a38e012c2 100644
--- a/cmd/ethereum/main.go
+++ b/cmd/ethereum/main.go
@@ -24,15 +24,16 @@ import (
 	"fmt"
 	"os"
 	"runtime"
+	"strconv"
 	"time"
 
+	"github.com/codegangsta/cli"
 	"github.com/ethereum/go-ethereum/cmd/ethereum/repl"
 	"github.com/ethereum/go-ethereum/cmd/utils"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/eth"
 	"github.com/ethereum/go-ethereum/ethutil"
 	"github.com/ethereum/go-ethereum/logger"
-	"github.com/ethereum/go-ethereum/p2p"
 	"github.com/ethereum/go-ethereum/state"
 )
 
@@ -41,117 +42,174 @@ const (
 	Version          = "0.8.6"
 )
 
-var clilogger = logger.NewLogger("CLI")
+var (
+	clilogger = logger.NewLogger("CLI")
+	app       = cli.NewApp()
+)
 
-func main() {
-	runtime.GOMAXPROCS(runtime.NumCPU())
+func init() {
+	app.Version = Version
+	app.Usage = "the go-ethereum command-line client"
+	app.Action = run
+	app.HideVersion = true // we have a command to print the version
+	app.Commands = []cli.Command{
+		{
+			Action: version,
+			Name:   "version",
+			Usage:  "print ethereum version numbers",
+			Description: `
+The output of this command is supposed to be machine-readable.
+`,
+		},
+		{
+			Action: dump,
+			Name:   "dump",
+			Usage:  `dump a specific block from storage`,
+			Description: `
+The arguments are interpreted as block numbers or hashes.
+Use "ethereum dump 0" to dump the genesis block.
+`,
+		},
+		{
+			Action: runjs,
+			Name:   "js",
+			Usage:  `interactive JavaScript console`,
+			Description: `
+In the console, you can use the eth object to interact
+with the running ethereum stack. The API does not match
+ethereum.js.
+
+A JavaScript file can be provided as the argument. The
+runtime will execute the file and exit.
+`,
+		},
+		{
+			Action: importchain,
+			Name:   "import",
+			Usage:  `import a blockchain file`,
+		},
+	}
+	app.Author = ""
+	app.Email = ""
+	app.Flags = []cli.Flag{
+		utils.BootnodesFlag,
+		utils.DataDirFlag,
+		utils.KeyRingFlag,
+		utils.KeyStoreFlag,
+		utils.ListenPortFlag,
+		utils.LogFileFlag,
+		utils.LogFormatFlag,
+		utils.LogLevelFlag,
+		utils.MaxPeersFlag,
+		utils.MinerThreadsFlag,
+		utils.MiningEnabledFlag,
+		utils.NATFlag,
+		utils.NodeKeyFileFlag,
+		utils.NodeKeyHexFlag,
+		utils.RPCEnabledFlag,
+		utils.RPCListenAddrFlag,
+		utils.RPCPortFlag,
+		utils.VMTypeFlag,
+	}
+
+	// missing:
+	// flag.StringVar(&ConfigFile, "conf", defaultConfigFile, "config file")
+	// flag.BoolVar(&DiffTool, "difftool", false, "creates output for diff'ing. Sets LogLevel=0")
+	// flag.StringVar(&DiffType, "diff", "all", "sets the level of diff output [vm, all]. Has no effect if difftool=false")
 
-	defer func() {
-		logger.Flush()
-	}()
+	// potential subcommands:
+	// flag.StringVar(&SecretFile, "import", "", "imports the file given (hex or mnemonic formats)")
+	// flag.StringVar(&ExportDir, "export", "", "exports the session keyring to files in the directory given")
+	// flag.BoolVar(&GenAddr, "genaddr", false, "create a new priv/pub key")
+}
 
+func main() {
+	runtime.GOMAXPROCS(runtime.NumCPU())
+	defer logger.Flush()
 	utils.HandleInterrupt()
+	if err := app.Run(os.Args); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+		os.Exit(1)
+	}
+}
 
-	// precedence: code-internal flag default < config file < environment variables < command line
-	Init() // parsing command line
+func run(ctx *cli.Context) {
+	fmt.Printf("Welcome to the FRONTIER\n")
+	eth := utils.GetEthereum(ClientIdentifier, Version, ctx)
+	startEth(ctx, eth)
+	// this blocks the thread
+	eth.WaitForShutdown()
+}
 
-	if PrintVersion {
-		printVersion()
-		return
+func runjs(ctx *cli.Context) {
+	eth := utils.GetEthereum(ClientIdentifier, Version, ctx)
+	startEth(ctx, eth)
+	if len(ctx.Args()) == 0 {
+		repl := ethrepl.NewJSRepl(eth)
+		repl.Start()
+		utils.RegisterInterrupt(func(os.Signal) { repl.Stop() })
+		eth.WaitForShutdown()
+	} else if len(ctx.Args()) == 1 {
+		execJsFile(eth, ctx.Args()[0])
+	} else {
+		utils.Fatalf("This command can handle at most one argument.")
 	}
+}
 
-	utils.InitConfig(VmType, ConfigFile, Datadir, "ETH")
-
-	ethereum, err := eth.New(&eth.Config{
-		Name:         p2p.MakeName(ClientIdentifier, Version),
-		KeyStore:     KeyStore,
-		DataDir:      Datadir,
-		LogFile:      LogFile,
-		LogLevel:     LogLevel,
-		LogFormat:    LogFormat,
-		MaxPeers:     MaxPeer,
-		Port:         OutboundPort,
-		NAT:          NAT,
-		KeyRing:      KeyRing,
-		Shh:          true,
-		Dial:         Dial,
-		BootNodes:    BootNodes,
-		NodeKey:      NodeKey,
-		MinerThreads: MinerThreads,
-	})
+func startEth(ctx *cli.Context, eth *eth.Ethereum) {
+	utils.StartEthereum(eth)
+	if ctx.GlobalBool(utils.RPCEnabledFlag.Name) {
+		addr := ctx.GlobalString(utils.RPCListenAddrFlag.Name)
+		port := ctx.GlobalInt(utils.RPCPortFlag.Name)
+		utils.StartRpc(eth, addr, port)
+	}
+	if ctx.GlobalBool(utils.MiningEnabledFlag.Name) {
+		eth.Miner().Start()
+	}
+}
 
+func importchain(ctx *cli.Context) {
+	if len(ctx.Args()) != 1 {
+		utils.Fatalf("This command requires an argument.")
+	}
+	chain, _ := utils.GetChain(ctx)
+	start := time.Now()
+	err := utils.ImportChain(chain, ctx.Args().First())
 	if err != nil {
-		clilogger.Fatalln(err)
+		utils.Fatalf("Import error: %v\n", err)
 	}
+	fmt.Printf("Import done in", time.Since(start))
+	return
+}
 
-	utils.KeyTasks(ethereum.KeyManager(), KeyRing, GenAddr, SecretFile, ExportDir, NonInteractive)
-
-	if Dump {
+func dump(ctx *cli.Context) {
+	chain, db := utils.GetChain(ctx)
+	for _, arg := range ctx.Args() {
 		var block *types.Block
-
-		if len(DumpHash) == 0 && DumpNumber == -1 {
-			block = ethereum.ChainManager().CurrentBlock()
-		} else if len(DumpHash) > 0 {
-			block = ethereum.ChainManager().GetBlock(ethutil.Hex2Bytes(DumpHash))
+		if hashish(arg) {
+			block = chain.GetBlock(ethutil.Hex2Bytes(arg))
 		} else {
-			block = ethereum.ChainManager().GetBlockByNumber(uint64(DumpNumber))
+			num, _ := strconv.Atoi(arg)
+			block = chain.GetBlockByNumber(uint64(num))
 		}
-
 		if block == nil {
-			fmt.Fprintln(os.Stderr, "block not found")
-
-			// We want to output valid JSON
 			fmt.Println("{}")
-
-			os.Exit(1)
-		}
-
-		// Leave the Println. This needs clean output for piping
-		statedb := state.New(block.Root(), ethereum.Db())
-		fmt.Printf("%s\n", statedb.Dump())
-
-		fmt.Println(block)
-
-		return
-	}
-
-	if len(ImportChain) > 0 {
-		start := time.Now()
-		err := utils.ImportChain(ethereum, ImportChain)
-		if err != nil {
-			clilogger.Infoln(err)
+			utils.Fatalf("block not found")
+		} else {
+			statedb := state.New(block.Root(), db)
+			fmt.Printf("%s\n", statedb.Dump())
+			// fmt.Println(block)
 		}
-		clilogger.Infoln("import done in", time.Since(start))
-		return
-	}
-
-	if StartRpc {
-		utils.StartRpc(ethereum, RpcListenAddress, RpcPort)
-	}
-
-	utils.StartEthereum(ethereum)
-
-	fmt.Printf("Welcome to the FRONTIER\n")
-
-	if StartMining {
-		ethereum.Miner().Start()
 	}
+}
 
-	if StartJsConsole {
-		repl := ethrepl.NewJSRepl(ethereum)
-		repl.Start()
-		utils.RegisterInterrupt(func(os.Signal) {
-			repl.Stop()
-		})
-
-	} else if len(InputFile) > 0 {
-		ExecJsFile(ethereum, InputFile)
-	}
-	// this blocks the thread
-	ethereum.WaitForShutdown()
+// hashish returns true for strings that look like hashes.
+func hashish(x string) bool {
+	_, err := strconv.Atoi(x)
+	return err != nil
 }
 
-func printVersion() {
+func version(c *cli.Context) {
 	fmt.Printf(`%v %v
 PV=%d
 GOOS=%s