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

     1  // Copyright 2017 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  	"bufio"
    21  	"errors"
    22  	"fmt"
    23  	"math/big"
    24  	"os"
    25  	"reflect"
    26  	"unicode"
    27  
    28  	cli "gopkg.in/urfave/cli.v1"
    29  
    30  	"github.com/ethereumprogpow/ethereumprogpow/cmd/utils"
    31  	"github.com/ethereumprogpow/ethereumprogpow/dashboard"
    32  	"github.com/ethereumprogpow/ethereumprogpow/eth"
    33  	"github.com/ethereumprogpow/ethereumprogpow/node"
    34  	"github.com/ethereumprogpow/ethereumprogpow/params"
    35  	whisper "github.com/ethereumprogpow/ethereumprogpow/whisper/whisperv6"
    36  	"github.com/naoina/toml"
    37  )
    38  
    39  var (
    40  	dumpConfigCommand = cli.Command{
    41  		Action:      utils.MigrateFlags(dumpConfig),
    42  		Name:        "dumpconfig",
    43  		Usage:       "Show configuration values",
    44  		ArgsUsage:   "",
    45  		Flags:       append(append(nodeFlags, rpcFlags...), whisperFlags...),
    46  		Category:    "MISCELLANEOUS COMMANDS",
    47  		Description: `The dumpconfig command shows configuration values.`,
    48  	}
    49  
    50  	configFileFlag = cli.StringFlag{
    51  		Name:  "config",
    52  		Usage: "TOML configuration file",
    53  	}
    54  )
    55  
    56  // These settings ensure that TOML keys use the same names as Go struct fields.
    57  var tomlSettings = toml.Config{
    58  	NormFieldName: func(rt reflect.Type, key string) string {
    59  		return key
    60  	},
    61  	FieldToKey: func(rt reflect.Type, field string) string {
    62  		return field
    63  	},
    64  	MissingField: func(rt reflect.Type, field string) error {
    65  		link := ""
    66  		if unicode.IsUpper(rune(rt.Name()[0])) && rt.PkgPath() != "main" {
    67  			link = fmt.Sprintf(", see https://godoc.org/%s#%s for available fields", rt.PkgPath(), rt.Name())
    68  		}
    69  		return fmt.Errorf("field '%s' is not defined in %s%s", field, rt.String(), link)
    70  	},
    71  }
    72  
    73  type ethstatsConfig struct {
    74  	URL string `toml:",omitempty"`
    75  }
    76  
    77  type gethConfig struct {
    78  	Eth       eth.Config
    79  	Shh       whisper.Config
    80  	Node      node.Config
    81  	Ethstats  ethstatsConfig
    82  	Dashboard dashboard.Config
    83  }
    84  
    85  func loadConfig(file string, cfg *gethConfig) error {
    86  	f, err := os.Open(file)
    87  	if err != nil {
    88  		return err
    89  	}
    90  	defer f.Close()
    91  
    92  	err = tomlSettings.NewDecoder(bufio.NewReader(f)).Decode(cfg)
    93  	// Add file name to errors that have a line number.
    94  	if _, ok := err.(*toml.LineError); ok {
    95  		err = errors.New(file + ", " + err.Error())
    96  	}
    97  	return err
    98  }
    99  
   100  func defaultNodeConfig() node.Config {
   101  	cfg := node.DefaultConfig
   102  	cfg.Name = clientIdentifier
   103  	cfg.Version = params.VersionWithCommit(gitCommit)
   104  	cfg.HTTPModules = append(cfg.HTTPModules, "eth", "shh")
   105  	cfg.WSModules = append(cfg.WSModules, "eth", "shh")
   106  	cfg.IPCPath = "geth.ipc"
   107  	return cfg
   108  }
   109  
   110  func makeConfigNode(ctx *cli.Context) (*node.Node, gethConfig) {
   111  	// Load defaults.
   112  	cfg := gethConfig{
   113  		Eth:       eth.DefaultConfig,
   114  		Shh:       whisper.DefaultConfig,
   115  		Node:      defaultNodeConfig(),
   116  		Dashboard: dashboard.DefaultConfig,
   117  	}
   118  
   119  	// Load config file.
   120  	if file := ctx.GlobalString(configFileFlag.Name); file != "" {
   121  		if err := loadConfig(file, &cfg); err != nil {
   122  			utils.Fatalf("%v", err)
   123  		}
   124  	}
   125  
   126  	// Apply flags.
   127  	utils.SetNodeConfig(ctx, &cfg.Node)
   128  	stack, err := node.New(&cfg.Node)
   129  	if err != nil {
   130  		utils.Fatalf("Failed to create the protocol stack: %v", err)
   131  	}
   132  	utils.SetEthConfig(ctx, stack, &cfg.Eth)
   133  	if ctx.GlobalIsSet(utils.EthStatsURLFlag.Name) {
   134  		cfg.Ethstats.URL = ctx.GlobalString(utils.EthStatsURLFlag.Name)
   135  	}
   136  
   137  	utils.SetShhConfig(ctx, stack, &cfg.Shh)
   138  	utils.SetDashboardConfig(ctx, &cfg.Dashboard)
   139  
   140  	return stack, cfg
   141  }
   142  
   143  // enableWhisper returns true in case one of the whisper flags is set.
   144  func enableWhisper(ctx *cli.Context) bool {
   145  	for _, flag := range whisperFlags {
   146  		if ctx.GlobalIsSet(flag.GetName()) {
   147  			return true
   148  		}
   149  	}
   150  	return false
   151  }
   152  
   153  func makeFullNode(ctx *cli.Context) *node.Node {
   154  	stack, cfg := makeConfigNode(ctx)
   155  	if ctx.GlobalIsSet(utils.ConstantinopleOverrideFlag.Name) {
   156  		cfg.Eth.ConstantinopleOverride = new(big.Int).SetUint64(ctx.GlobalUint64(utils.ConstantinopleOverrideFlag.Name))
   157  	}
   158  	utils.RegisterEthService(stack, &cfg.Eth)
   159  
   160  	if ctx.GlobalBool(utils.DashboardEnabledFlag.Name) {
   161  		utils.RegisterDashboardService(stack, &cfg.Dashboard, gitCommit)
   162  	}
   163  	// Whisper must be explicitly enabled by specifying at least 1 whisper flag or in dev mode
   164  	shhEnabled := enableWhisper(ctx)
   165  	shhAutoEnabled := !ctx.GlobalIsSet(utils.WhisperEnabledFlag.Name) && ctx.GlobalIsSet(utils.DeveloperFlag.Name)
   166  	if shhEnabled || shhAutoEnabled {
   167  		if ctx.GlobalIsSet(utils.WhisperMaxMessageSizeFlag.Name) {
   168  			cfg.Shh.MaxMessageSize = uint32(ctx.Int(utils.WhisperMaxMessageSizeFlag.Name))
   169  		}
   170  		if ctx.GlobalIsSet(utils.WhisperMinPOWFlag.Name) {
   171  			cfg.Shh.MinimumAcceptedPOW = ctx.Float64(utils.WhisperMinPOWFlag.Name)
   172  		}
   173  		if ctx.GlobalIsSet(utils.WhisperRestrictConnectionBetweenLightClientsFlag.Name) {
   174  			cfg.Shh.RestrictConnectionBetweenLightClients = true
   175  		}
   176  		utils.RegisterShhService(stack, &cfg.Shh)
   177  	}
   178  
   179  	// Add the Ethereum Stats daemon if requested.
   180  	if cfg.Ethstats.URL != "" {
   181  		utils.RegisterEthStatsService(stack, cfg.Ethstats.URL)
   182  	}
   183  	return stack
   184  }
   185  
   186  // dumpConfig is the dumpconfig command.
   187  func dumpConfig(ctx *cli.Context) error {
   188  	_, cfg := makeConfigNode(ctx)
   189  	comment := ""
   190  
   191  	if cfg.Eth.Genesis != nil {
   192  		cfg.Eth.Genesis = nil
   193  		comment += "# Note: this config doesn't contain the genesis block.\n\n"
   194  	}
   195  
   196  	out, err := tomlSettings.Marshal(&cfg)
   197  	if err != nil {
   198  		return err
   199  	}
   200  
   201  	dump := os.Stdout
   202  	if ctx.NArg() > 0 {
   203  		dump, err = os.OpenFile(ctx.Args().Get(0), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
   204  		if err != nil {
   205  			return err
   206  		}
   207  		defer dump.Close()
   208  	}
   209  	dump.WriteString(comment)
   210  	dump.Write(out)
   211  
   212  	return nil
   213  }