aboutsummaryrefslogtreecommitdiffstats
path: root/eth/config.go
blob: 5094a533bf4b6170613ebfe7aceca98598ccced8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
// 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/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/miner"
    "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,
    UltraLightFraction: 75,
    DatabaseCache:      512,
    TrieCleanCache:     256,
    TrieDirtyCache:     256,
    TrieTimeout:        60 * time.Minute,
    Miner: miner.Config{
        GasFloor: 8000000,
        GasCeil:  8000000,
        GasPrice: big.NewInt(params.GWei),
        Recommit: 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 -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 // Whether to disable pruning and flush everything to disk
    NoPrefetch bool // Whether to disable prefetching and only load state on demand

    // 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
    LightIngress int `toml:",omitempty"` // Incoming bandwidth limit for light servers
    LightEgress  int `toml:",omitempty"` // Outgoing bandwidth limit for light servers
    LightPeers   int `toml:",omitempty"` // Maximum number of LES client peers

    // Ultra Light client options
    UltraLightServers      []string `toml:",omitempty"` // List of trusted ultra light servers
    UltraLightFraction     int      `toml:",omitempty"` // Percentage of trusted servers to accept an announcement
    UltraLightOnlyAnnounce bool     `toml:",omitempty"` // Whether to only announce headers, or also serve them

    // Database options
    SkipBcVersionCheck bool `toml:"-"`
    DatabaseHandles    int  `toml:"-"`
    DatabaseCache      int
    DatabaseFreezer    string

    TrieCleanCache int
    TrieDirtyCache int
    TrieTimeout    time.Duration

    // Mining options
    Miner miner.Config

    // 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

    // RPCGasCap is the global gas cap for eth-call variants.
    RPCGasCap *big.Int `toml:",omitempty"`

    // Checkpoint is a hardcoded checkpoint which can be nil.
    Checkpoint *params.TrustedCheckpoint `toml:",omitempty"`

    // CheckpointOracle is the configuration for checkpoint oracle.
    CheckpointOracle *params.CheckpointOracleConfig `toml:",omitempty"`

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