github.com/cheng762/platon-go@v1.8.17-0.20190529111256-7deff2d7be26/cmd/platon/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  	"io"
    24  	"os"
    25  	"reflect"
    26  	"unicode"
    27  
    28  	cli "gopkg.in/urfave/cli.v1"
    29  
    30  	"github.com/PlatONnetwork/PlatON-Go/cmd/utils"
    31  	"github.com/PlatONnetwork/PlatON-Go/dashboard"
    32  	"github.com/PlatONnetwork/PlatON-Go/eth"
    33  	"github.com/PlatONnetwork/PlatON-Go/node"
    34  	"github.com/PlatONnetwork/PlatON-Go/params"
    35  	whisper "github.com/PlatONnetwork/PlatON-Go/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 = "platon.ipc"
   107  	return cfg
   108  }
   109  
   110  func makeConfigNode(ctx *cli.Context) (*node.Node, gethConfig) {
   111  
   112  	// Load defaults.
   113  	cfg := gethConfig{
   114  		Eth:       eth.DefaultConfig,
   115  		Shh:       whisper.DefaultConfig,
   116  		Node:      defaultNodeConfig(),
   117  		Dashboard: dashboard.DefaultConfig,
   118  	}
   119  
   120  	// Load config file.
   121  	if file := ctx.GlobalString(configFileFlag.Name); file != "" {
   122  		if err := loadConfig(file, &cfg); err != nil {
   123  			utils.Fatalf("%v", err)
   124  		}
   125  	}
   126  
   127  	// Current version only supports full syncmode
   128  	//ctx.GlobalSet(utils.SyncModeFlag.Name, cfg.Eth.SyncMode.String())
   129  
   130  	// Apply flags.
   131  	utils.SetNodeConfig(ctx, &cfg.Node)
   132  
   133  	stack, err := node.New(&cfg.Node)
   134  	if err != nil {
   135  		utils.Fatalf("Failed to create the protocol stack: %v", err)
   136  	}
   137  
   138  	utils.SetEthConfig(ctx, stack, &cfg.Eth)
   139  
   140  	// pass on the rpc port to mpc pool conf.
   141  	cfg.Eth.MPCPool.LocalRpcPort = cfg.Node.HTTPPort
   142  
   143  	// pass on the rpc port to vc pool conf.
   144  	cfg.Eth.VCPool.LocalRpcPort = cfg.Node.HTTPPort
   145  
   146  	// load cbft config file.
   147  	if cbftConfig := cfg.Eth.LoadCbftConfig(cfg.Node); cbftConfig != nil {
   148  		cfg.Eth.CbftConfig = *cbftConfig
   149  	}
   150  
   151  	if ctx.GlobalIsSet(utils.EthStatsURLFlag.Name) {
   152  		cfg.Ethstats.URL = ctx.GlobalString(utils.EthStatsURLFlag.Name)
   153  	}
   154  
   155  	utils.SetShhConfig(ctx, stack, &cfg.Shh)
   156  	utils.SetDashboardConfig(ctx, &cfg.Dashboard)
   157  
   158  	return stack, cfg
   159  }
   160  
   161  // enableWhisper returns true in case one of the whisper flags is set.
   162  func enableWhisper(ctx *cli.Context) bool {
   163  	for _, flag := range whisperFlags {
   164  		if ctx.GlobalIsSet(flag.GetName()) {
   165  			return true
   166  		}
   167  	}
   168  	return false
   169  }
   170  
   171  func makeFullNode(ctx *cli.Context) *node.Node {
   172  
   173  	stack, cfg := makeConfigNode(ctx)
   174  
   175  	utils.RegisterEthService(stack, &cfg.Eth)
   176  
   177  	if ctx.GlobalBool(utils.DashboardEnabledFlag.Name) {
   178  		utils.RegisterDashboardService(stack, &cfg.Dashboard, gitCommit)
   179  	}
   180  	// Whisper must be explicitly enabled by specifying at least 1 whisper flag or in dev mode
   181  	shhEnabled := enableWhisper(ctx)
   182  	shhAutoEnabled := !ctx.GlobalIsSet(utils.WhisperEnabledFlag.Name) && ctx.GlobalIsSet(utils.DeveloperFlag.Name)
   183  	if shhEnabled || shhAutoEnabled {
   184  		if ctx.GlobalIsSet(utils.WhisperMaxMessageSizeFlag.Name) {
   185  			cfg.Shh.MaxMessageSize = uint32(ctx.Int(utils.WhisperMaxMessageSizeFlag.Name))
   186  		}
   187  		if ctx.GlobalIsSet(utils.WhisperMinPOWFlag.Name) {
   188  			cfg.Shh.MinimumAcceptedPOW = ctx.Float64(utils.WhisperMinPOWFlag.Name)
   189  		}
   190  		if ctx.GlobalIsSet(utils.WhisperRestrictConnectionBetweenLightClientsFlag.Name) {
   191  			cfg.Shh.RestrictConnectionBetweenLightClients = true
   192  		}
   193  		utils.RegisterShhService(stack, &cfg.Shh)
   194  	}
   195  
   196  	// Add the Ethereum Stats daemon if requested.
   197  	if cfg.Ethstats.URL != "" {
   198  		utils.RegisterEthStatsService(stack, cfg.Ethstats.URL)
   199  	}
   200  	return stack
   201  }
   202  
   203  // dumpConfig is the dumpconfig command.
   204  func dumpConfig(ctx *cli.Context) error {
   205  	_, cfg := makeConfigNode(ctx)
   206  	comment := ""
   207  
   208  	if cfg.Eth.Genesis != nil {
   209  		cfg.Eth.Genesis = nil
   210  		comment += "# Note: this config doesn't contain the genesis block.\n\n"
   211  	}
   212  
   213  	out, err := tomlSettings.Marshal(&cfg)
   214  	if err != nil {
   215  		return err
   216  	}
   217  	io.WriteString(os.Stdout, comment)
   218  	os.Stdout.Write(out)
   219  	return nil
   220  }