github.com/letterj/go-ethereum@v1.8.22-0.20190204142846-520024dfd689/eth/config.go (about)

     1  // Copyright 2017 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser 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  // The go-ethereum library 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 Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package eth
    18  
    19  import (
    20  	"math/big"
    21  	"os"
    22  	"os/user"
    23  	"path/filepath"
    24  	"runtime"
    25  	"time"
    26  
    27  	"github.com/ethereum/go-ethereum/common"
    28  	"github.com/ethereum/go-ethereum/common/hexutil"
    29  	"github.com/ethereum/go-ethereum/consensus/ethash"
    30  	"github.com/ethereum/go-ethereum/core"
    31  	"github.com/ethereum/go-ethereum/eth/downloader"
    32  	"github.com/ethereum/go-ethereum/eth/gasprice"
    33  	"github.com/ethereum/go-ethereum/params"
    34  )
    35  
    36  // DefaultConfig contains default settings for use on the Ethereum main net.
    37  var DefaultConfig = Config{
    38  	SyncMode: downloader.FastSync,
    39  	Ethash: ethash.Config{
    40  		CacheDir:       "ethash",
    41  		CachesInMem:    2,
    42  		CachesOnDisk:   3,
    43  		DatasetsInMem:  1,
    44  		DatasetsOnDisk: 2,
    45  	},
    46  	NetworkId:      1,
    47  	LightPeers:     100,
    48  	DatabaseCache:  512,
    49  	TrieCleanCache: 256,
    50  	TrieDirtyCache: 256,
    51  	TrieTimeout:    60 * time.Minute,
    52  	MinerGasFloor:  8000000,
    53  	MinerGasCeil:   8000000,
    54  	MinerGasPrice:  big.NewInt(params.GWei),
    55  	MinerRecommit:  3 * time.Second,
    56  
    57  	TxPool: core.DefaultTxPoolConfig,
    58  	GPO: gasprice.Config{
    59  		Blocks:     20,
    60  		Percentile: 60,
    61  	},
    62  }
    63  
    64  func init() {
    65  	home := os.Getenv("HOME")
    66  	if home == "" {
    67  		if user, err := user.Current(); err == nil {
    68  			home = user.HomeDir
    69  		}
    70  	}
    71  	if runtime.GOOS == "windows" {
    72  		DefaultConfig.Ethash.DatasetDir = filepath.Join(home, "AppData", "Ethash")
    73  	} else {
    74  		DefaultConfig.Ethash.DatasetDir = filepath.Join(home, ".ethash")
    75  	}
    76  }
    77  
    78  //go:generate gencodec -type Config -field-override configMarshaling -formats toml -out gen_config.go
    79  
    80  type Config struct {
    81  	// The genesis block, which is inserted if the database is empty.
    82  	// If nil, the Ethereum main net block is used.
    83  	Genesis *core.Genesis `toml:",omitempty"`
    84  
    85  	// Protocol options
    86  	NetworkId uint64 // Network ID to use for selecting peers to connect to
    87  	SyncMode  downloader.SyncMode
    88  	NoPruning bool
    89  
    90  	// Whitelist of required block number -> hash values to accept
    91  	Whitelist map[uint64]common.Hash `toml:"-"`
    92  
    93  	// Light client options
    94  	LightServ    int  `toml:",omitempty"` // Maximum percentage of time allowed for serving LES requests
    95  	LightPeers   int  `toml:",omitempty"` // Maximum number of LES client peers
    96  	OnlyAnnounce bool // Maximum number of LES client peers
    97  
    98  	// Ultra Light client options
    99  	ULC *ULCConfig `toml:",omitempty"`
   100  
   101  	// Database options
   102  	SkipBcVersionCheck bool `toml:"-"`
   103  	DatabaseHandles    int  `toml:"-"`
   104  	DatabaseCache      int
   105  	TrieCleanCache     int
   106  	TrieDirtyCache     int
   107  	TrieTimeout        time.Duration
   108  
   109  	// Mining-related options
   110  	Etherbase      common.Address `toml:",omitempty"`
   111  	MinerNotify    []string       `toml:",omitempty"`
   112  	MinerExtraData []byte         `toml:",omitempty"`
   113  	MinerGasFloor  uint64
   114  	MinerGasCeil   uint64
   115  	MinerGasPrice  *big.Int
   116  	MinerRecommit  time.Duration
   117  	MinerNoverify  bool
   118  
   119  	// Ethash options
   120  	Ethash ethash.Config
   121  
   122  	// Transaction pool options
   123  	TxPool core.TxPoolConfig
   124  
   125  	// Gas Price Oracle options
   126  	GPO gasprice.Config
   127  
   128  	// Enables tracking of SHA3 preimages in the VM
   129  	EnablePreimageRecording bool
   130  
   131  	// Miscellaneous options
   132  	DocRoot string `toml:"-"`
   133  
   134  	// Type of the EWASM interpreter ("" for default)
   135  	EWASMInterpreter string
   136  
   137  	// Type of the EVM interpreter ("" for default)
   138  	EVMInterpreter string
   139  
   140  	// Constantinople block override (TODO: remove after the fork)
   141  	ConstantinopleOverride *big.Int
   142  }
   143  
   144  type configMarshaling struct {
   145  	MinerExtraData hexutil.Bytes
   146  }