path: root/eth/config.go

// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package eth

import (
    "math/big"
    "os"
    "os/user"
    "path/filepath"
    "runtime"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/hexutil"
    "github.com/ethereum/go-ethereum/consensus/ethash"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/eth/downloader"
    "github.com/ethereum/go-ethereum/eth/gasprice"
    "github.com/ethereum/go-ethereum/params"
)

// DefaultConfig contains default settings for use on the Ethereum main net.
var DefaultConfig = Config{
    SyncMode: downloader.FastSync,
    Ethash: ethash.Config{
        CacheDir:       "ethash",
        CachesInMem:    2,
        CachesOnDisk:   3,
        DatasetsInMem:  1,
        DatasetsOnDisk: 2,
    },
    NetworkId:      1,
    LightPeers:     100,
    DatabaseCache:  512,
    TrieCleanCache: 256,
    TrieDirtyCache: 256,
    TrieTimeout:    60 * time.Minute,
    MinerGasFloor:  8000000,
    MinerGasCeil:   8000000,
    MinerGasPrice:  big.NewInt(params.GWei),
    MinerRecommit:  3 * time.Second,

    TxPool: core.DefaultTxPoolConfig,
    GPO: gasprice.Config{
        Blocks:     20,
        Percentile: 60,
    },
}

func init() {
    home := os.Getenv("HOME")
    if home == "" {
        if user, err := user.Current(); err == nil {
            home = user.HomeDir
        }
    }
    if runtime.GOOS == "darwin" {
        DefaultConfig.Ethash.DatasetDir = filepath.Join(home, "Library", "Ethash")
    } else if runtime.GOOS == "windows" {
        localappdata := os.Getenv("LOCALAPPDATA")
        if localappdata != "" {
            DefaultConfig.Ethash.DatasetDir = filepath.Join(localappdata, "Ethash")
        } else {
            DefaultConfig.Ethash.DatasetDir = filepath.Join(home, "AppData", "Local", "Ethash")
        }
    } else {
        DefaultConfig.Ethash.DatasetDir = filepath.Join(home, ".ethash")
    }
}

//go:generate gencodec -type Config -field-override configMarshaling -formats toml -out gen_config.go

type Config struct {
    // The genesis block, which is inserted if the database is empty.
    // If nil, the Ethereum main net block is used.
    Genesis *core.Genesis `toml:",omitempty"`

    // Protocol options
    NetworkId uint64 // Network ID to use for selecting peers to connect to
    SyncMode  downloader.SyncMode
    NoPruning bool

    // Whitelist of required block number -> hash values to accept
    Whitelist map[uint64]common.Hash `toml:"-"`

    // Light client options
    LightServ         int  `toml:",omitempty"` // Maximum percentage of time allowed for serving LES requests
    LightBandwidthIn  int  `toml:",omitempty"` // Incoming bandwidth limit for light servers
    LightBandwidthOut int  `toml:",omitempty"` // Outgoing bandwidth limit for light servers
    LightPeers        int  `toml:",omitempty"` // Maximum number of LES client peers
    OnlyAnnounce      bool // Maximum number of LES client peers

    // Ultra Light client options
    ULC *ULCConfig `toml:",omitempty"`

    // Database options
    SkipBcVersionCheck bool `toml:"-"`
    DatabaseHandles    int  `toml:"-"`
    DatabaseCache      int
    TrieCleanCache     int
    TrieDirtyCache     int
    TrieTimeout        time.Duration

    // Mining-related options
    Etherbase      common.Address `toml:",omitempty"`
    MinerNotify    []string       `toml:",omitempty"`
    MinerExtraData []byte         `toml:",omitempty"`
    MinerGasFloor  uint64
    MinerGasCeil   uint64
    MinerGasPrice  *big.Int
    MinerRecommit  time.Duration
    MinerNoverify  bool

    // Ethash options
    Ethash ethash.Config

    // Transaction pool options
    TxPool core.TxPoolConfig

    // Gas Price Oracle options
    GPO gasprice.Config

    // Enables tracking of SHA3 preimages in the VM
    EnablePreimageRecording bool

    // Miscellaneous options
    DocRoot string `toml:"-"`

    // Type of the EWASM interpreter ("" for default)
    EWASMInterpreter string

    // Type of the EVM interpreter ("" for default)
    EVMInterpreter string

    // Constantinople block override (TODO: remove after the fork)
    ConstantinopleOverride *big.Int
}

type configMarshaling struct {
    MinerExtraData hexutil.Bytes
}