344d6f95cf
This PR groups all built-in network flags together and list them in the command as a whole. And all database path flags(datadir, ancient) are also grouped, since usually these two are used together.
235 lines
7.5 KiB
Go
235 lines
7.5 KiB
Go
// Copyright 2016 The go-ethereum Authors
|
|
// This file is part of go-ethereum.
|
|
//
|
|
// go-ethereum is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// go-ethereum is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/ethereum/go-ethereum/cmd/utils"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/console"
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
"gopkg.in/urfave/cli.v1"
|
|
)
|
|
|
|
var (
|
|
consoleFlags = []cli.Flag{utils.JSpathFlag, utils.ExecFlag, utils.PreloadJSFlag}
|
|
|
|
consoleCommand = cli.Command{
|
|
Action: utils.MigrateFlags(localConsole),
|
|
Name: "console",
|
|
Usage: "Start an interactive JavaScript environment",
|
|
Flags: utils.GroupFlags(nodeFlags, rpcFlags, consoleFlags),
|
|
Category: "CONSOLE COMMANDS",
|
|
Description: `
|
|
The Geth console is an interactive shell for the JavaScript runtime environment
|
|
which exposes a node admin interface as well as the Ðapp JavaScript API.
|
|
See https://geth.ethereum.org/docs/interface/javascript-console.`,
|
|
}
|
|
|
|
attachCommand = cli.Command{
|
|
Action: utils.MigrateFlags(remoteConsole),
|
|
Name: "attach",
|
|
Usage: "Start an interactive JavaScript environment (connect to node)",
|
|
ArgsUsage: "[endpoint]",
|
|
Flags: utils.GroupFlags([]cli.Flag{utils.DataDirFlag}, consoleFlags),
|
|
Category: "CONSOLE COMMANDS",
|
|
Description: `
|
|
The Geth console is an interactive shell for the JavaScript runtime environment
|
|
which exposes a node admin interface as well as the Ðapp JavaScript API.
|
|
See https://geth.ethereum.org/docs/interface/javascript-console.
|
|
This command allows to open a console on a running geth node.`,
|
|
}
|
|
|
|
javascriptCommand = cli.Command{
|
|
Action: utils.MigrateFlags(ephemeralConsole),
|
|
Name: "js",
|
|
Usage: "Execute the specified JavaScript files",
|
|
ArgsUsage: "<jsfile> [jsfile...]",
|
|
Flags: utils.GroupFlags(nodeFlags, consoleFlags),
|
|
Category: "CONSOLE COMMANDS",
|
|
Description: `
|
|
The JavaScript VM exposes a node admin interface as well as the Ðapp
|
|
JavaScript API. See https://geth.ethereum.org/docs/interface/javascript-console`,
|
|
}
|
|
)
|
|
|
|
// localConsole starts a new geth node, attaching a JavaScript console to it at the
|
|
// same time.
|
|
func localConsole(ctx *cli.Context) error {
|
|
// Create and start the node based on the CLI flags
|
|
prepare(ctx)
|
|
stack, backend := makeFullNode(ctx)
|
|
startNode(ctx, stack, backend, true)
|
|
defer stack.Close()
|
|
|
|
// Attach to the newly started node and create the JavaScript console.
|
|
client, err := stack.Attach()
|
|
if err != nil {
|
|
return fmt.Errorf("Failed to attach to the inproc geth: %v", err)
|
|
}
|
|
config := console.Config{
|
|
DataDir: utils.MakeDataDir(ctx),
|
|
DocRoot: ctx.GlobalString(utils.JSpathFlag.Name),
|
|
Client: client,
|
|
Preload: utils.MakeConsolePreloads(ctx),
|
|
}
|
|
console, err := console.New(config)
|
|
if err != nil {
|
|
return fmt.Errorf("Failed to start the JavaScript console: %v", err)
|
|
}
|
|
defer console.Stop(false)
|
|
|
|
// If only a short execution was requested, evaluate and return.
|
|
if script := ctx.GlobalString(utils.ExecFlag.Name); script != "" {
|
|
console.Evaluate(script)
|
|
return nil
|
|
}
|
|
|
|
// Track node shutdown and stop the console when it goes down.
|
|
// This happens when SIGTERM is sent to the process.
|
|
go func() {
|
|
stack.Wait()
|
|
console.StopInteractive()
|
|
}()
|
|
|
|
// Print the welcome screen and enter interactive mode.
|
|
console.Welcome()
|
|
console.Interactive()
|
|
return nil
|
|
}
|
|
|
|
// remoteConsole will connect to a remote geth instance, attaching a JavaScript
|
|
// console to it.
|
|
func remoteConsole(ctx *cli.Context) error {
|
|
endpoint := ctx.Args().First()
|
|
if endpoint == "" {
|
|
path := node.DefaultDataDir()
|
|
if ctx.GlobalIsSet(utils.DataDirFlag.Name) {
|
|
path = ctx.GlobalString(utils.DataDirFlag.Name)
|
|
}
|
|
if path != "" {
|
|
if ctx.GlobalBool(utils.RopstenFlag.Name) {
|
|
// Maintain compatibility with older Geth configurations storing the
|
|
// Ropsten database in `testnet` instead of `ropsten`.
|
|
legacyPath := filepath.Join(path, "testnet")
|
|
if common.FileExist(legacyPath) {
|
|
path = legacyPath
|
|
} else {
|
|
path = filepath.Join(path, "ropsten")
|
|
}
|
|
} else if ctx.GlobalBool(utils.RinkebyFlag.Name) {
|
|
path = filepath.Join(path, "rinkeby")
|
|
} else if ctx.GlobalBool(utils.GoerliFlag.Name) {
|
|
path = filepath.Join(path, "goerli")
|
|
} else if ctx.GlobalBool(utils.SepoliaFlag.Name) {
|
|
path = filepath.Join(path, "sepolia")
|
|
} else if ctx.GlobalBool(utils.KilnFlag.Name) {
|
|
path = filepath.Join(path, "kiln")
|
|
}
|
|
}
|
|
endpoint = fmt.Sprintf("%s/geth.ipc", path)
|
|
}
|
|
client, err := dialRPC(endpoint)
|
|
if err != nil {
|
|
utils.Fatalf("Unable to attach to remote geth: %v", err)
|
|
}
|
|
config := console.Config{
|
|
DataDir: utils.MakeDataDir(ctx),
|
|
DocRoot: ctx.GlobalString(utils.JSpathFlag.Name),
|
|
Client: client,
|
|
Preload: utils.MakeConsolePreloads(ctx),
|
|
}
|
|
console, err := console.New(config)
|
|
if err != nil {
|
|
utils.Fatalf("Failed to start the JavaScript console: %v", err)
|
|
}
|
|
defer console.Stop(false)
|
|
|
|
if script := ctx.GlobalString(utils.ExecFlag.Name); script != "" {
|
|
console.Evaluate(script)
|
|
return nil
|
|
}
|
|
|
|
// Otherwise print the welcome screen and enter interactive mode
|
|
console.Welcome()
|
|
console.Interactive()
|
|
return nil
|
|
}
|
|
|
|
// dialRPC returns a RPC client which connects to the given endpoint.
|
|
// The check for empty endpoint implements the defaulting logic
|
|
// for "geth attach" with no argument.
|
|
func dialRPC(endpoint string) (*rpc.Client, error) {
|
|
if endpoint == "" {
|
|
endpoint = node.DefaultIPCEndpoint(clientIdentifier)
|
|
} else if strings.HasPrefix(endpoint, "rpc:") || strings.HasPrefix(endpoint, "ipc:") {
|
|
// Backwards compatibility with geth < 1.5 which required
|
|
// these prefixes.
|
|
endpoint = endpoint[4:]
|
|
}
|
|
return rpc.Dial(endpoint)
|
|
}
|
|
|
|
// ephemeralConsole starts a new geth node, attaches an ephemeral JavaScript
|
|
// console to it, executes each of the files specified as arguments and tears
|
|
// everything down.
|
|
func ephemeralConsole(ctx *cli.Context) error {
|
|
// Create and start the node based on the CLI flags
|
|
stack, backend := makeFullNode(ctx)
|
|
startNode(ctx, stack, backend, false)
|
|
defer stack.Close()
|
|
|
|
// Attach to the newly started node and start the JavaScript console
|
|
client, err := stack.Attach()
|
|
if err != nil {
|
|
return fmt.Errorf("Failed to attach to the inproc geth: %v", err)
|
|
}
|
|
config := console.Config{
|
|
DataDir: utils.MakeDataDir(ctx),
|
|
DocRoot: ctx.GlobalString(utils.JSpathFlag.Name),
|
|
Client: client,
|
|
Preload: utils.MakeConsolePreloads(ctx),
|
|
}
|
|
|
|
console, err := console.New(config)
|
|
if err != nil {
|
|
return fmt.Errorf("Failed to start the JavaScript console: %v", err)
|
|
}
|
|
defer console.Stop(false)
|
|
|
|
// Interrupt the JS interpreter when node is stopped.
|
|
go func() {
|
|
stack.Wait()
|
|
console.Stop(false)
|
|
}()
|
|
|
|
// Evaluate each of the specified JavaScript files.
|
|
for _, file := range ctx.Args() {
|
|
if err = console.Execute(file); err != nil {
|
|
return fmt.Errorf("Failed to execute %s: %v", file, err)
|
|
}
|
|
}
|
|
|
|
// The main script is now done, but keep running timers/callbacks.
|
|
console.Stop(true)
|
|
return nil
|
|
}
|