github.com/MaynardMiner/ethereumprogpow@v1.8.23/cmd/geth/consolecmd.go (about)

     1  // Copyright 2016 The go-ethereum Authors
     2  // This file is part of go-ethereum.
     3  //
     4  // go-ethereum is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // go-ethereum is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU General Public License
    15  // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package main
    18  
    19  import (
    20  	"fmt"
    21  	"os"
    22  	"os/signal"
    23  	"path/filepath"
    24  	"strings"
    25  	"syscall"
    26  
    27  	"github.com/ethereumprogpow/ethereumprogpow/cmd/utils"
    28  	"github.com/ethereumprogpow/ethereumprogpow/console"
    29  	"github.com/ethereumprogpow/ethereumprogpow/node"
    30  	"github.com/ethereumprogpow/ethereumprogpow/rpc"
    31  	"gopkg.in/urfave/cli.v1"
    32  )
    33  
    34  var (
    35  	consoleFlags = []cli.Flag{utils.JSpathFlag, utils.ExecFlag, utils.PreloadJSFlag}
    36  
    37  	consoleCommand = cli.Command{
    38  		Action:   utils.MigrateFlags(localConsole),
    39  		Name:     "console",
    40  		Usage:    "Start an interactive JavaScript environment",
    41  		Flags:    append(append(append(nodeFlags, rpcFlags...), consoleFlags...), whisperFlags...),
    42  		Category: "CONSOLE COMMANDS",
    43  		Description: `
    44  The Geth console is an interactive shell for the JavaScript runtime environment
    45  which exposes a node admin interface as well as the Ðapp JavaScript API.
    46  See https://github.com/ethereum/go-ethereum/wiki/JavaScript-Console.`,
    47  	}
    48  
    49  	attachCommand = cli.Command{
    50  		Action:    utils.MigrateFlags(remoteConsole),
    51  		Name:      "attach",
    52  		Usage:     "Start an interactive JavaScript environment (connect to node)",
    53  		ArgsUsage: "[endpoint]",
    54  		Flags:     append(consoleFlags, utils.DataDirFlag),
    55  		Category:  "CONSOLE COMMANDS",
    56  		Description: `
    57  The Geth console is an interactive shell for the JavaScript runtime environment
    58  which exposes a node admin interface as well as the Ðapp JavaScript API.
    59  See https://github.com/ethereum/go-ethereum/wiki/JavaScript-Console.
    60  This command allows to open a console on a running geth node.`,
    61  	}
    62  
    63  	javascriptCommand = cli.Command{
    64  		Action:    utils.MigrateFlags(ephemeralConsole),
    65  		Name:      "js",
    66  		Usage:     "Execute the specified JavaScript files",
    67  		ArgsUsage: "<jsfile> [jsfile...]",
    68  		Flags:     append(nodeFlags, consoleFlags...),
    69  		Category:  "CONSOLE COMMANDS",
    70  		Description: `
    71  The JavaScript VM exposes a node admin interface as well as the Ðapp
    72  JavaScript API. See https://github.com/ethereum/go-ethereum/wiki/JavaScript-Console`,
    73  	}
    74  )
    75  
    76  // localConsole starts a new geth node, attaching a JavaScript console to it at the
    77  // same time.
    78  func localConsole(ctx *cli.Context) error {
    79  	// Create and start the node based on the CLI flags
    80  	node := makeFullNode(ctx)
    81  	startNode(ctx, node)
    82  	defer node.Stop()
    83  
    84  	// Attach to the newly started node and start the JavaScript console
    85  	client, err := node.Attach()
    86  	if err != nil {
    87  		utils.Fatalf("Failed to attach to the inproc geth: %v", err)
    88  	}
    89  	config := console.Config{
    90  		DataDir: utils.MakeDataDir(ctx),
    91  		DocRoot: ctx.GlobalString(utils.JSpathFlag.Name),
    92  		Client:  client,
    93  		Preload: utils.MakeConsolePreloads(ctx),
    94  	}
    95  
    96  	console, err := console.New(config)
    97  	if err != nil {
    98  		utils.Fatalf("Failed to start the JavaScript console: %v", err)
    99  	}
   100  	defer console.Stop(false)
   101  
   102  	// If only a short execution was requested, evaluate and return
   103  	if script := ctx.GlobalString(utils.ExecFlag.Name); script != "" {
   104  		console.Evaluate(script)
   105  		return nil
   106  	}
   107  	// Otherwise print the welcome screen and enter interactive mode
   108  	console.Welcome()
   109  	console.Interactive()
   110  
   111  	return nil
   112  }
   113  
   114  // remoteConsole will connect to a remote geth instance, attaching a JavaScript
   115  // console to it.
   116  func remoteConsole(ctx *cli.Context) error {
   117  	// Attach to a remotely running geth instance and start the JavaScript console
   118  	endpoint := ctx.Args().First()
   119  	if endpoint == "" {
   120  		path := node.DefaultDataDir()
   121  		if ctx.GlobalIsSet(utils.DataDirFlag.Name) {
   122  			path = ctx.GlobalString(utils.DataDirFlag.Name)
   123  		}
   124  		if path != "" {
   125  			if ctx.GlobalBool(utils.TestnetFlag.Name) {
   126  				path = filepath.Join(path, "testnet")
   127  			} else if ctx.GlobalBool(utils.RinkebyFlag.Name) {
   128  				path = filepath.Join(path, "rinkeby")
   129  			} else if ctx.GlobalBool(utils.GangnamFlag.Name) {
   130  				path = filepath.Join(path, "gangnam")
   131  			}
   132  		}
   133  		endpoint = fmt.Sprintf("%s/geth.ipc", path)
   134  	}
   135  	client, err := dialRPC(endpoint)
   136  	if err != nil {
   137  		utils.Fatalf("Unable to attach to remote geth: %v", err)
   138  	}
   139  	config := console.Config{
   140  		DataDir: utils.MakeDataDir(ctx),
   141  		DocRoot: ctx.GlobalString(utils.JSpathFlag.Name),
   142  		Client:  client,
   143  		Preload: utils.MakeConsolePreloads(ctx),
   144  	}
   145  
   146  	console, err := console.New(config)
   147  	if err != nil {
   148  		utils.Fatalf("Failed to start the JavaScript console: %v", err)
   149  	}
   150  	defer console.Stop(false)
   151  
   152  	if script := ctx.GlobalString(utils.ExecFlag.Name); script != "" {
   153  		console.Evaluate(script)
   154  		return nil
   155  	}
   156  
   157  	// Otherwise print the welcome screen and enter interactive mode
   158  	console.Welcome()
   159  	console.Interactive()
   160  
   161  	return nil
   162  }
   163  
   164  // dialRPC returns a RPC client which connects to the given endpoint.
   165  // The check for empty endpoint implements the defaulting logic
   166  // for "geth attach" and "geth monitor" with no argument.
   167  func dialRPC(endpoint string) (*rpc.Client, error) {
   168  	if endpoint == "" {
   169  		endpoint = node.DefaultIPCEndpoint(clientIdentifier)
   170  	} else if strings.HasPrefix(endpoint, "rpc:") || strings.HasPrefix(endpoint, "ipc:") {
   171  		// Backwards compatibility with geth < 1.5 which required
   172  		// these prefixes.
   173  		endpoint = endpoint[4:]
   174  	}
   175  	return rpc.Dial(endpoint)
   176  }
   177  
   178  // ephemeralConsole starts a new geth node, attaches an ephemeral JavaScript
   179  // console to it, executes each of the files specified as arguments and tears
   180  // everything down.
   181  func ephemeralConsole(ctx *cli.Context) error {
   182  	// Create and start the node based on the CLI flags
   183  	node := makeFullNode(ctx)
   184  	startNode(ctx, node)
   185  	defer node.Stop()
   186  
   187  	// Attach to the newly started node and start the JavaScript console
   188  	client, err := node.Attach()
   189  	if err != nil {
   190  		utils.Fatalf("Failed to attach to the inproc geth: %v", err)
   191  	}
   192  	config := console.Config{
   193  		DataDir: utils.MakeDataDir(ctx),
   194  		DocRoot: ctx.GlobalString(utils.JSpathFlag.Name),
   195  		Client:  client,
   196  		Preload: utils.MakeConsolePreloads(ctx),
   197  	}
   198  
   199  	console, err := console.New(config)
   200  	if err != nil {
   201  		utils.Fatalf("Failed to start the JavaScript console: %v", err)
   202  	}
   203  	defer console.Stop(false)
   204  
   205  	// Evaluate each of the specified JavaScript files
   206  	for _, file := range ctx.Args() {
   207  		if err = console.Execute(file); err != nil {
   208  			utils.Fatalf("Failed to execute %s: %v", file, err)
   209  		}
   210  	}
   211  	// Wait for pending callbacks, but stop for Ctrl-C.
   212  	abort := make(chan os.Signal, 1)
   213  	signal.Notify(abort, syscall.SIGINT, syscall.SIGTERM)
   214  
   215  	go func() {
   216  		<-abort
   217  		os.Exit(0)
   218  	}()
   219  	console.Stop(true)
   220  
   221  	return nil
   222  }